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     ####################
 113     # the local fields that are kept consistent
 114     # self.urn
 115     # self.hrn
 116     # self.type
 117     # self.path
 118     # provide either urn, or (hrn + type)
 119     def __init__ (self, xrn, type=None, id=None):
 120         if not xrn: xrn = ""
 121         # user has specified xrn : guess if urn or hrn
 122         self.id = id
 123         if Xrn.is_urn(xrn):
 124             self.hrn=None
 125             self.urn=xrn
 126             if type:
 127                 self.type=type
 128             if id:
 129                 self.urn = "%s-%s" % (self.urn, str(id))
 130             self.urn_to_hrn()
 131         else:
 132             self.urn=None
 133             self.hrn=xrn
 134             self.type=type
 135             self.hrn_to_urn()
 136         self._normalize()
 137 # happens all the time ..
 138 #        if not type:
 139 #            debug_logger.debug("type-less Xrn's are not safe")
 140
 141     def __repr__ (self):
 142         result="<XRN u=%s h=%s"%(self.urn,self.hrn)
 143         if hasattr(self,'leaf'): result += " leaf=%s"%self.leaf
 144         if hasattr(self,'authority'): result += " auth=%s"%self.authority
 145         result += ">"
 146         return result
 147
 148     def get_urn(self): return self.urn
 149     def get_hrn(self): return self.hrn
 150     def get_type(self): return self.type
 151     def get_hrn_type(self): return (self.hrn, self.type)
 152
 153     def _normalize(self):
 154         if self.hrn is None: raise SfaAPIError, "Xrn._normalize"
 155         if not hasattr(self,'leaf'):
 156             self.leaf=Xrn.hrn_split(self.hrn)[-1]
 157         # self.authority keeps a list
 158         if not hasattr(self,'authority'):
 159             self.authority=Xrn.hrn_auth_list(self.hrn)
 160
 161     def get_leaf(self):
 162         self._normalize()
 163         return self.leaf
 164
 165     def get_authority_hrn(self):
 166         self._normalize()
 167         return '.'.join( self.authority )
 168
 169     def get_authority_urn(self):
 170         self._normalize()
 171         return ':'.join( [Xrn.unescape(x) for x in self.authority] )
 172
 173     def set_authority(self, authority):
 174         """
 175         update the authority section of an existing urn
 176         """
 177         authority_hrn = self.get_authority_hrn()
 178         hrn = ".".join([authority, self.get_leaf()])
 179         self.hrn = hrn
 180         self.hrn_to_urn()
 181         self._normalize()
 182
 183     def urn_to_hrn(self):
 184         """
 185         compute tuple (hrn, type) from urn
 186         """
 187
 188 #        if not self.urn or not self.urn.startswith(Xrn.URN_PREFIX):
 189         if not Xrn.is_urn(self.urn):
 190             raise SfaAPIError, "Xrn.urn_to_hrn"
 191
 192         parts = Xrn.urn_split(self.urn)
 193         type=parts.pop(2)
 194         # Remove the authority name (e.g. '.sa')
 195         if type == 'authority':
 196             name = parts.pop()
 197             # Drop the sa. This is a bad hack, but its either this
 198             # or completely change how record types are generated/stored
 199             if name != 'sa':
 200                 type = type + "+" + name
 201             name =""
 202         else:
 203             name = parts.pop(len(parts)-1)
 204         # convert parts (list) into hrn (str) by doing the following
 205         # 1. remove blank parts
 206         # 2. escape dots inside parts
 207         # 3. replace ':' with '.' inside parts
 208         # 3. join parts using '.'
 209         hrn = '.'.join([Xrn.escape(part).replace(':','.') for part in parts if part])
 210         # dont replace ':' in the name section
 211         if name:
 212             parts = name.split(':')
 213             if len(parts) > 1:
 214                 self.id = ":".join(parts[1:])
 215                 name = parts[0]
 216             hrn += '.%s' % Xrn.escape(name)
 217
 218         self.hrn=str(hrn)
 219         self.type=str(type)
 220
 221     def hrn_to_urn(self):
 222         """
 223         compute urn from (hrn, type)
 224         """
 225
 226 #        if not self.hrn or self.hrn.startswith(Xrn.URN_PREFIX):
 227         if Xrn.is_urn(self.hrn):
 228             raise SfaAPIError, "Xrn.hrn_to_urn, hrn=%s"%self.hrn
 229
 230         if self.type and self.type.startswith('authority'):
 231             self.authority = Xrn.hrn_auth_list(self.hrn)
 232             leaf = self.get_leaf()
 233             #if not self.authority:
 234             #    self.authority = [self.hrn]
 235             type_parts = self.type.split("+")
 236             self.type = type_parts[0]
 237             name = 'sa'
 238             if len(type_parts) > 1:
 239                 name = type_parts[1]
 240             auth_parts = [part for part in [self.get_authority_urn(), leaf] if part]
 241             authority_string = ":".join(auth_parts)
 242         else:
 243             self.authority = Xrn.hrn_auth_list(self.hrn)
 244             name = Xrn.hrn_leaf(self.hrn)
 245             authority_string = self.get_authority_urn()
 246
 247         if self.type == None:
 248             urn = "+".join(['',authority_string,Xrn.unescape(name)])
 249         else:
 250             urn = "+".join(['',authority_string,self.type,Xrn.unescape(name)])
 251
 252         if hasattr(self, 'id') and self.id:
 253             urn = "%s:%s" % (urn, self.id)
 254
 255         self.urn = Xrn.URN_PREFIX + urn
 256
 257     def dump_string(self):
 258         result="-------------------- XRN\n"
 259         result += "URN=%s\n"%self.urn
 260         result += "HRN=%s\n"%self.hrn
 261         result += "TYPE=%s\n"%self.type
 262         result += "LEAF=%s\n"%self.get_leaf()
 263         result += "AUTH(hrn format)=%s\n"%self.get_authority_hrn()
 264         result += "AUTH(urn format)=%s\n"%self.get_authority_urn()
 265         return result
 266