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 class Xrn:
  36
  37     ########## basic tools on HRNs
  38     # split a HRN-like string into pieces
  39     # this is like split('.') except for escaped (backslashed) dots
  40     # e.g. hrn_split ('a\.b.c.d') -> [ 'a\.b','c','d']
  41     @staticmethod
  42     def hrn_split(hrn):
  43         return [ x.replace('--sep--','\\.') for x in hrn.replace('\\.','--sep--').split('.') ]
  44
  45     # e.g. hrn_leaf ('a\.b.c.d') -> 'd'
  46     @staticmethod
  47     def hrn_leaf(hrn): return Xrn.hrn_split(hrn)[-1]
  48
  49     # e.g. hrn_auth_list ('a\.b.c.d') -> ['a\.b', 'c']
  50     @staticmethod
  51     def hrn_auth_list(hrn): return Xrn.hrn_split(hrn)[0:-1]
  52
  53     # e.g. hrn_auth ('a\.b.c.d') -> 'a\.b.c'
  54     @staticmethod
  55     def hrn_auth(hrn): return '.'.join(Xrn.hrn_auth_list(hrn))
  56
  57     # e.g. escape ('a.b') -> 'a\.b'
  58     @staticmethod
  59     def escape(token): return re.sub(r'([^\\])\.', r'\1\.', token)
  60
  61     # e.g. unescape ('a\.b') -> 'a.b'
  62     @staticmethod
  63     def unescape(token): return token.replace('\\.','.')
  64
  65     # Return the HRN authority chain from top to bottom.
  66     # e.g. hrn_auth_chain('a\.b.c.d') -> ['a\.b', 'a\.b.c']
  67     @staticmethod
  68     def hrn_auth_chain(hrn):
  69         parts = Xrn.hrn_auth_list(hrn)
  70         chain = []
  71         for i in range(len(parts)):
  72             chain.append('.'.join(parts[:i+1]))
  73         # Include the HRN itself?
  74         #chain.append(hrn)
  75         return chain
  76
  77     # Is the given HRN a true authority over the namespace of the other
  78     # child HRN?
  79     # A better alternative than childHRN.startswith(parentHRN)
  80     # e.g. hrn_is_auth_for_hrn('a\.b', 'a\.b.c.d') -> True,
  81     # but hrn_is_auth_for_hrn('a', 'a\.b.c.d') -> False
  82     # Also hrn_is_auth_for_hrn('a\.b.c.d', 'a\.b.c.d') -> True
  83     @staticmethod
  84     def hrn_is_auth_for_hrn(parenthrn, hrn):
  85         if parenthrn == hrn:
  86             return True
  87         for auth in Xrn.hrn_auth_chain(hrn):
  88             if parenthrn == auth:
  89                 return True
  90         return False
  91
  92     ########## basic tools on URNs
  93     URN_PREFIX = "urn:publicid:IDN"
  94     URN_PREFIX_lower = "urn:publicid:idn"
  95
  96     @staticmethod
  97     def is_urn (text):
  98         return text.lower().startswith(Xrn.URN_PREFIX_lower)
  99
 100     @staticmethod
 101     def urn_full (urn):
 102         if Xrn.is_urn(urn): return urn
 103         else: return Xrn.URN_PREFIX+urn
 104     @staticmethod
 105     def urn_meaningful (urn):
 106         if Xrn.is_urn(urn): return urn[len(Xrn.URN_PREFIX):]
 107         else: return urn
 108     @staticmethod
 109     def urn_split (urn):
 110         return Xrn.urn_meaningful(urn).split('+')
 111
 112     @staticmethod
 113     def filter_type(urns=None, type=None):
 114         if urns is None: urns=[]
 115         urn_list = []
 116         if not type:
 117             return urns
 118
 119         for urn in urns:
 120             xrn = Xrn(xrn=urn)
 121             if (xrn.type == type):
 122                 # Xrn is probably a urn so we can just compare types
 123                 urn_list.append(urn)
 124         return urn_list
 125     ####################
 126     # the local fields that are kept consistent
 127     # self.urn
 128     # self.hrn
 129     # self.type
 130     # self.path
 131     # provide either urn, or (hrn + type)
 132     def __init__ (self, xrn="", type=None, id=None):
 133         if not xrn: xrn = ""
 134         # user has specified xrn : guess if urn or hrn
 135         self.id = id
 136         if Xrn.is_urn(xrn):
 137             self.hrn=None
 138             self.urn=xrn
 139             if id:
 140                 self.urn = "%s:%s" % (self.urn, str(id))
 141             self.urn_to_hrn()
 142         else:
 143             self.urn=None
 144             self.hrn=xrn
 145             self.type=type
 146             self.hrn_to_urn()
 147         self._normalize()
 148 # happens all the time ..
 149 #        if not type:
 150 #            debug_logger.debug("type-less Xrn's are not safe")
 151
 152     def __repr__ (self):
 153         result="<XRN u=%s h=%s"%(self.urn,self.hrn)
 154         if hasattr(self,'leaf'): result += " leaf=%s"%self.leaf
 155         if hasattr(self,'authority'): result += " auth=%s"%self.authority
 156         result += ">"
 157         return result
 158
 159     def get_urn(self): return self.urn
 160     def get_hrn(self): return self.hrn
 161     def get_type(self): return self.type
 162     def get_hrn_type(self): return (self.hrn, self.type)
 163
 164     def _normalize(self):
 165         if self.hrn is None: raise SfaAPIError("Xrn._normalize")
 166         if not hasattr(self,'leaf'):
 167             self.leaf=Xrn.hrn_split(self.hrn)[-1]
 168         # self.authority keeps a list
 169         if not hasattr(self,'authority'):
 170             self.authority=Xrn.hrn_auth_list(self.hrn)
 171
 172     def get_leaf(self):
 173         self._normalize()
 174         return self.leaf
 175
 176     def get_authority_hrn(self):
 177         self._normalize()
 178         return '.'.join( self.authority )
 179
 180     def get_authority_urn(self):
 181         self._normalize()
 182         return ':'.join( [Xrn.unescape(x) for x in self.authority] )
 183
 184     def set_authority(self, authority):
 185         """
 186         update the authority section of an existing urn
 187         """
 188         authority_hrn = self.get_authority_hrn()
 189         if not authority_hrn.startswith(authority):
 190             hrn = ".".join([authority,authority_hrn, self.get_leaf()])
 191         else:
 192             hrn = ".".join([authority_hrn, self.get_leaf()])
 193
 194         self.hrn = hrn
 195         self.hrn_to_urn()
 196         self._normalize()
 197
 198     # sliver_id_parts is list that contains the sliver's
 199     # slice id and node id
 200     def get_sliver_id_parts(self):
 201         sliver_id_parts = []
 202         if self.type == 'sliver' or '-' in self.leaf:
 203             sliver_id_parts = self.leaf.split('-')
 204         return sliver_id_parts
 205
 206
 207     def urn_to_hrn(self):
 208         """
 209         compute tuple (hrn, type) from urn
 210         """
 211
 212 #        if not self.urn or not self.urn.startswith(Xrn.URN_PREFIX):
 213         if not Xrn.is_urn(self.urn):
 214             raise SfaAPIError("Xrn.urn_to_hrn")
 215
 216         parts = Xrn.urn_split(self.urn)
 217         type=parts.pop(2)
 218         # Remove the authority name (e.g. '.sa')
 219         if type == 'authority':
 220             name = parts.pop()
 221             # Drop the sa. This is a bad hack, but its either this
 222             # or completely change how record types are generated/stored
 223             if name != 'sa':
 224                 type = type + "+" + name
 225             name =""
 226         else:
 227             name = parts.pop(len(parts)-1)
 228         # convert parts (list) into hrn (str) by doing the following
 229         # 1. remove blank parts
 230         # 2. escape dots inside parts
 231         # 3. replace ':' with '.' inside parts
 232         # 3. join parts using '.'
 233         hrn = '.'.join([Xrn.escape(part).replace(':','.') for part in parts if part])
 234         # dont replace ':' in the name section
 235         if name:
 236             parts = name.split(':')
 237             if len(parts) > 1:
 238                 self.id = ":".join(parts[1:])
 239                 name = parts[0]
 240             hrn += '.%s' % Xrn.escape(name)
 241
 242         self.hrn=str(hrn)
 243         self.type=str(type)
 244
 245     def hrn_to_urn(self):
 246         """
 247         compute urn from (hrn, type)
 248         """
 249
 250 #        if not self.hrn or self.hrn.startswith(Xrn.URN_PREFIX):
 251         if Xrn.is_urn(self.hrn):
 252             raise SfaAPIError("Xrn.hrn_to_urn, hrn=%s"%self.hrn)
 253
 254         if self.type and self.type.startswith('authority'):
 255             self.authority = Xrn.hrn_auth_list(self.hrn)
 256             leaf = self.get_leaf()
 257             #if not self.authority:
 258             #    self.authority = [self.hrn]
 259             type_parts = self.type.split("+")
 260             self.type = type_parts[0]
 261             name = 'sa'
 262             if len(type_parts) > 1:
 263                 name = type_parts[1]
 264             auth_parts = [part for part in [self.get_authority_urn(), leaf] if part]
 265             authority_string = ":".join(auth_parts)
 266         else:
 267             self.authority = Xrn.hrn_auth_list(self.hrn)
 268             name = Xrn.hrn_leaf(self.hrn)
 269             authority_string = self.get_authority_urn()
 270
 271         if self.type == None:
 272             urn = "+".join(['',authority_string,Xrn.unescape(name)])
 273         else:
 274             urn = "+".join(['',authority_string,self.type,Xrn.unescape(name)])
 275
 276         if hasattr(self, 'id') and self.id:
 277             urn = "%s:%s" % (urn, self.id)
 278
 279         self.urn = Xrn.URN_PREFIX + urn
 280
 281     def dump_string(self):
 282         result="-------------------- XRN\n"
 283         result += "URN=%s\n"%self.urn
 284         result += "HRN=%s\n"%self.hrn
 285         result += "TYPE=%s\n"%self.type
 286         result += "LEAF=%s\n"%self.get_leaf()
 287         result += "AUTH(hrn format)=%s\n"%self.get_authority_hrn()
 288         result += "AUTH(urn format)=%s\n"%self.get_authority_urn()
 289         return result
 290