sfa/util/xrn.py

   1 import re
   2
   3 from sfa.util.faults import *
   4 from sfa.util.sfalogging import sfa_logger
   5
   6 # for convenience and smoother translation - we should get rid of these functions eventually
   7 def get_leaf(hrn): return Xrn(xrn=hrn).get_leaf()
   8 def get_authority(hrn): return Xrn(xrn=hrn).get_authority_hrn()
   9 def urn_to_hrn(urn): xrn=Xrn(xrn=urn); return (xrn.hrn, xrn.type)
  10 def hrn_to_urn(hrn,type): return Xrn(hrn=hrn, type=type).urn
  11
  12 class Xrn:
  13
  14     ########## basic tools on HRNs
  15     # split a HRN-like string into pieces
  16     # this is like split('.') except for escaped (backslashed) dots
  17     # e.g. hrn_split ('a\.b.c.d') -> [ 'a\.b','c','d']
  18     @staticmethod
  19     def hrn_split(hrn):
  20         return [ x.replace('--sep--','\\.') for x in hrn.replace('\\.','--sep--').split('.') ]
  21
  22     # e.g. hrn_leaf ('a\.b.c.d') -> 'd'
  23     @staticmethod
  24     def hrn_leaf(hrn): return Xrn.hrn_split(hrn)[-1]
  25
  26     # e.g. hrn_auth_list ('a\.b.c.d') -> ['a\.b', 'c']
  27     @staticmethod
  28     def hrn_auth_list(hrn): return Xrn.hrn_split(hrn)[0:-1]
  29
  30     # e.g. hrn_auth ('a\.b.c.d') -> 'a\.b.c'
  31     @staticmethod
  32     def hrn_auth(hrn): return '.'.join(Xrn.hrn_auth_list(hrn))
  33
  34     # e.g. escape ('a.b') -> 'a\.b'
  35     @staticmethod
  36     def escape(token): return re.sub(r'([^\\])\.', r'\1\.', token)
  37     # e.g. unescape ('a\.b') -> 'a.b'
  38     @staticmethod
  39     def unescape(token): return token.replace('\\.','.')
  40
  41     URN_PREFIX = "urn:publicid:IDN"
  42
  43     ########## basic tools on URNs
  44     @staticmethod
  45     def urn_full (urn):
  46         if urn.startswith(Xrn.URN_PREFIX): return urn
  47         else: return Xrn.URN_PREFIX+URN
  48     @staticmethod
  49     def urn_meaningful (urn):
  50         if urn.startswith(Xrn.URN_PREFIX): return urn[len(Xrn.URN_PREFIX):]
  51         else: return urn
  52     @staticmethod
  53     def urn_split (urn):
  54         return Xrn.urn_meaningful(urn).split('+')
  55
  56     ####################
  57     # the local fields that are kept consistent
  58     # self.urn
  59     # self.hrn
  60     # self.type
  61     # self.path
  62     # provide either urn, or (hrn + type)
  63     def __init__ (self, xrn=None, urn=None, hrn=None, type=None):
  64         # user has specified xrn : guess if urn or hrn
  65         if xrn is not None:
  66             if xrn.startswith(Xrn.URN_PREFIX):
  67                 self.urn=xrn
  68                 self.urn_to_hrn()
  69             else:
  70                 self.hrn=xrn
  71                 self.type=type
  72                 self.hrn_to_urn()
  73         # user has specified urn, let's use it
  74         elif urn is not None:
  75             self.urn=urn
  76             self.urn_to_hrn()
  77         # user has specified hrn and type
  78         elif hrn is not None and type is not None:
  79             self.hrn=hrn
  80             self.type=type
  81             self.hrn_to_urn()
  82         # what should we do ?
  83         else:
  84             raise SfaAPIError,"Xrn.__init__"
  85 # happens all the time ..
  86 #        if not type:
  87 #            sfa_logger().debug("type-less Xrn's are not safe")
  88
  89     def get_urn(self): return self.urn
  90     def get_hrn(self): return self.hrn
  91     def get_type(self): return self.type
  92     def get_hrn_type(self): return (self.hrn, self.type)
  93
  94     def _normalize(self):
  95         if self.hrn is None: raise SfaAPIError, "Xrn._normalize"
  96         if not hasattr(self,'leaf'):
  97             self.leaf=Xrn.hrn_split(self.hrn)[-1]
  98         # self.authority keeps a list
  99         if not hasattr(self,'authority'):
 100             self.authority=Xrn.hrn_auth_list(self.hrn)
 101
 102     def get_leaf(self):
 103         self._normalize()
 104         return self.leaf
 105
 106     def get_authority_hrn(self):
 107         self._normalize()
 108         return '.'.join( self.authority )
 109
 110     def get_authority_urn(self):
 111         self._normalize()
 112         return ':'.join( [Xrn.unescape(x) for x in self.authority] )
 113
 114     def urn_to_hrn(self):
 115         """
 116         compute tuple (hrn, type) from urn
 117         """
 118
 119 #        if not self.urn or not self.urn.startswith(Xrn.URN_PREFIX):
 120         if not self.urn.startswith(Xrn.URN_PREFIX):
 121             raise SfaAPIError, "Xrn.urn_to_hrn"
 122
 123         parts = Xrn.urn_split(self.urn)
 124         type=parts.pop(2)
 125         # Remove the authority name (e.g. '.sa')
 126         if type == 'authority': parts.pop()
 127
 128         # convert parts (list) into hrn (str) by doing the following
 129         # 1. remove blank parts
 130         # 2. escape dots inside parts
 131         # 3. replace ':' with '.' inside parts
 132         # 3. join parts using '.'
 133         hrn = '.'.join([Xrn.escape(part).replace(':','.') for part in parts if part])
 134
 135         self.hrn=str(hrn)
 136         self.type=str(type)
 137
 138     def hrn_to_urn(self):
 139         """
 140         compute urn from (hrn, type)
 141         """
 142
 143 #        if not self.hrn or self.hrn.startswith(Xrn.URN_PREFIX):
 144         if self.hrn.startswith(Xrn.URN_PREFIX):
 145             raise SfaAPIError, "Xrn.hrn_to_urn, hrn=%s"%self.hrn
 146
 147         if self.type == 'authority':
 148             self.authority = Xrn.hrn_split(self.hrn)
 149             name = 'sa'
 150         else:
 151             self.authority = Xrn.hrn_auth_list(self.hrn)
 152             name = Xrn.hrn_leaf(self.hrn)
 153
 154         authority_string = self.get_authority_urn()
 155
 156         if self.type == None:
 157             urn = "+".join(['',authority_string,name])
 158         else:
 159             urn = "+".join(['',authority_string,self.type,name])
 160
 161         self.urn = Xrn.URN_PREFIX + urn
 162
 163     def dump_string(self):
 164         result="-------------------- XRN\n"
 165         result += "URN=%s\n"%self.urn
 166         result += "HRN=%s\n"%self.hrn
 167         result += "TYPE=%s\n"%self.type
 168         result += "LEAF=%s\n"%self.get_leaf()
 169         result += "AUTH(hrn format)=%s\n"%self.get_authority_hrn()
 170         result += "AUTH(urn format)=%s\n"%self.get_authority_urn()
 171         return result
 172