sfa/util/xrn.py

   1 #----------------------------------------------------------------------
   2 # Copyright (c) 2008 Board of Trustees, Princeton University
   3 #
   4 # Permission is hereby granted, free of charge, to any person obtaining
   5 # a copy of this software and/or hardware specification (the "Work") to
   6 # deal in the Work without restriction, including without limitation the
   7 # rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 # and/or sell copies of the Work, and to permit persons to whom the Work
   9 # is furnished to do so, subject to the following conditions:
  10 #
  11 # The above copyright notice and this permission notice shall be
  12 # included in all copies or substantial portions of the Work.
  13 #
  14 # THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  18 # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  19 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS
  21 # IN THE WORK.
  22 #----------------------------------------------------------------------
  23
  24 import re
  25
  26 from sfa.util.faults import SfaAPIError
  27
  28 # for convenience and smoother translation - we should get rid of these functions eventually
  29 def get_leaf(hrn): return Xrn(hrn).get_leaf()
  30 def get_authority(hrn): return Xrn(hrn).get_authority_hrn()
  31 def urn_to_hrn(urn): xrn=Xrn(urn); return (xrn.hrn, xrn.type)
  32 def hrn_to_urn(hrn,type): return Xrn(hrn, type=type).urn
  33 def hrn_authfor_hrn(parenthrn, hrn): return Xrn.hrn_is_auth_for_hrn(parenthrn, hrn)
  34
  35 def urn_to_sliver_id(urn, slice_id, node_id, index=0, authority=None):
  36     return Xrn(urn).get_sliver_id(slice_id, node_id, index, authority)
  37
  38 class Xrn:
  39
  40     ########## basic tools on HRNs
  41     # split a HRN-like string into pieces
  42     # this is like split('.') except for escaped (backslashed) dots
  43     # e.g. hrn_split ('a\.b.c.d') -> [ 'a\.b','c','d']
  44     @staticmethod
  45     def hrn_split(hrn):
  46         return [ x.replace('--sep--','\\.') for x in hrn.replace('\\.','--sep--').split('.') ]
  47
  48     # e.g. hrn_leaf ('a\.b.c.d') -> 'd'
  49     @staticmethod
  50     def hrn_leaf(hrn): return Xrn.hrn_split(hrn)[-1]
  51
  52     # e.g. hrn_auth_list ('a\.b.c.d') -> ['a\.b', 'c']
  53     @staticmethod
  54     def hrn_auth_list(hrn): return Xrn.hrn_split(hrn)[0:-1]
  55
  56     # e.g. hrn_auth ('a\.b.c.d') -> 'a\.b.c'
  57     @staticmethod
  58     def hrn_auth(hrn): return '.'.join(Xrn.hrn_auth_list(hrn))
  59
  60     # e.g. escape ('a.b') -> 'a\.b'
  61     @staticmethod
  62     def escape(token): return re.sub(r'([^\\])\.', r'\1\.', token)
  63
  64     # e.g. unescape ('a\.b') -> 'a.b'
  65     @staticmethod
  66     def unescape(token): return token.replace('\\.','.')
  67
  68     # Return the HRN authority chain from top to bottom.
  69     # e.g. hrn_auth_chain('a\.b.c.d') -> ['a\.b', 'a\.b.c']
  70     @staticmethod
  71     def hrn_auth_chain(hrn):
  72         parts = Xrn.hrn_auth_list(hrn)
  73         chain = []
  74         for i in range(len(parts)):
  75             chain.append('.'.join(parts[:i+1]))
  76         # Include the HRN itself?
  77         #chain.append(hrn)
  78         return chain
  79
  80     # Is the given HRN a true authority over the namespace of the other
  81     # child HRN?
  82     # A better alternative than childHRN.startswith(parentHRN)
  83     # e.g. hrn_is_auth_for_hrn('a\.b', 'a\.b.c.d') -> True,
  84     # but hrn_is_auth_for_hrn('a', 'a\.b.c.d') -> False
  85     # Also hrn_is_uauth_for_hrn('a\.b.c.d', 'a\.b.c.d') -> True
  86     @staticmethod
  87     def hrn_is_auth_for_hrn(parenthrn, hrn):
  88         if parenthrn == hrn:
  89             return True
  90         for auth in Xrn.hrn_auth_chain(hrn):
  91             if parenthrn == auth:
  92                 return True
  93         return False
  94
  95     ########## basic tools on URNs
  96     URN_PREFIX = "urn:publicid:idn"
  97
  98     @staticmethod
  99     def is_urn (text):
 100         return text.lower().startswith(Xrn.URN_PREFIX)
 101
 102     @staticmethod
 103     def urn_full (urn):
 104         if Xrn.is_urn(urn): return urn
 105         else: return Xrn.URN_PREFIX+urn
 106     @staticmethod
 107     def urn_meaningful (urn):
 108         if Xrn.is_urn(urn): return urn[len(Xrn.URN_PREFIX):]
 109         else: return urn
 110     @staticmethod
 111     def urn_split (urn):
 112         return Xrn.urn_meaningful(urn).split('+')
 113
 114     ####################
 115     # the local fields that are kept consistent
 116     # self.urn
 117     # self.hrn
 118     # self.type
 119     # self.path
 120     # provide either urn, or (hrn + type)
 121     def __init__ (self, xrn, type=None):
 122         if not xrn: xrn = ""
 123         # user has specified xrn : guess if urn or hrn
 124         if Xrn.is_urn(xrn):
 125             self.hrn=None
 126             self.urn=xrn
 127             self.urn_to_hrn()
 128         else:
 129             self.urn=None
 130             self.hrn=xrn
 131             self.type=type
 132             self.hrn_to_urn()
 133 # happens all the time ..
 134 #        if not type:
 135 #            debug_logger.debug("type-less Xrn's are not safe")
 136
 137     def __repr__ (self):
 138         result="<XRN u=%s h=%s"%(self.urn,self.hrn)
 139         if hasattr(self,'leaf'): result += " leaf=%s"%self.leaf
 140         if hasattr(self,'authority'): result += " auth=%s"%self.authority
 141         result += ">"
 142         return result
 143
 144     def get_urn(self): return self.urn
 145     def get_hrn(self): return self.hrn
 146     def get_type(self): return self.type
 147     def get_hrn_type(self): return (self.hrn, self.type)
 148
 149     def _normalize(self):
 150         if self.hrn is None: raise SfaAPIError, "Xrn._normalize"
 151         if not hasattr(self,'leaf'):
 152             self.leaf=Xrn.hrn_split(self.hrn)[-1]
 153         # self.authority keeps a list
 154         if not hasattr(self,'authority'):
 155             self.authority=Xrn.hrn_auth_list(self.hrn)
 156
 157     def get_leaf(self):
 158         self._normalize()
 159         return self.leaf
 160
 161     def get_authority_hrn(self):
 162         self._normalize()
 163         return '.'.join( self.authority )
 164
 165     def get_authority_urn(self):
 166         self._normalize()
 167         return ':'.join( [Xrn.unescape(x) for x in self.authority] )
 168
 169     def get_sliver_id(self, slice_id, node_id, index=0, authority=None):
 170         self._normalize()
 171         urn = self.get_urn()
 172         if authority:
 173             authority_hrn = self.get_authority_hrn()
 174             if not authority_hrn.startswith(authority):
 175                 hrn = ".".join([authority,self.get_authority_hrn(), self.get_leaf()])
 176             else:
 177                 hrn = ".".join([self.get_authority_hrn(), self.get_leaf()])
 178             urn = Xrn(hrn, self.get_type()).get_urn()
 179         return ":".join(map(str, [urn, slice_id, node_id, index]))
 180
 181     def urn_to_hrn(self):
 182         """
 183         compute tuple (hrn, type) from urn
 184         """
 185
 186 #        if not self.urn or not self.urn.startswith(Xrn.URN_PREFIX):
 187         if not Xrn.is_urn(self.urn):
 188             raise SfaAPIError, "Xrn.urn_to_hrn"
 189
 190         parts = Xrn.urn_split(self.urn)
 191         type=parts.pop(2)
 192         # Remove the authority name (e.g. '.sa')
 193         if type == 'authority':
 194             name = parts.pop()
 195             # Drop the sa. This is a bad hack, but its either this
 196             # or completely change how record types are generated/stored
 197             if name != 'sa':
 198                 type = type + "+" + name
 199             name =""
 200         else:
 201             name = parts.pop(len(parts)-1)
 202         # convert parts (list) into hrn (str) by doing the following
 203         # 1. remove blank parts
 204         # 2. escape dots inside parts
 205         # 3. replace ':' with '.' inside parts
 206         # 3. join parts using '.'
 207         hrn = '.'.join([Xrn.escape(part).replace(':','.') for part in parts if part])
 208         # dont replace ':' in the name section
 209         if name:
 210             hrn += '.%s' % Xrn.escape(name)
 211
 212         self.hrn=str(hrn)
 213         self.type=str(type)
 214
 215     def hrn_to_urn(self):
 216         """
 217         compute urn from (hrn, type)
 218         """
 219
 220 #        if not self.hrn or self.hrn.startswith(Xrn.URN_PREFIX):
 221         if Xrn.is_urn(self.hrn):
 222             raise SfaAPIError, "Xrn.hrn_to_urn, hrn=%s"%self.hrn
 223
 224         if self.type and self.type.startswith('authority'):
 225             self.authority = Xrn.hrn_split(self.hrn)
 226             type_parts = self.type.split("+")
 227             self.type = type_parts[0]
 228             name = 'sa'
 229             if len(type_parts) > 1:
 230                 name = type_parts[1]
 231         else:
 232             self.authority = Xrn.hrn_auth_list(self.hrn)
 233             name = Xrn.hrn_leaf(self.hrn)
 234
 235         authority_string = self.get_authority_urn()
 236
 237         if self.type == None:
 238             urn = "+".join(['',authority_string,Xrn.unescape(name)])
 239         else:
 240             urn = "+".join(['',authority_string,self.type,Xrn.unescape(name)])
 241
 242         self.urn = Xrn.URN_PREFIX + urn
 243
 244     def dump_string(self):
 245         result="-------------------- XRN\n"
 246         result += "URN=%s\n"%self.urn
 247         result += "HRN=%s\n"%self.hrn
 248         result += "TYPE=%s\n"%self.type
 249         result += "LEAF=%s\n"%self.get_leaf()
 250         result += "AUTH(hrn format)=%s\n"%self.get_authority_hrn()
 251         result += "AUTH(urn format)=%s\n"%self.get_authority_urn()
 252         return result
 253