3 from sfa.util.faults import *
4 from sfa.util.sfalogging import sfa_logger
6 # for convenience and smoother translation - we should get rid of these functions eventually
7 def get_leaf(hrn): return Xrn(hrn).get_leaf()
8 def get_authority(hrn): return Xrn(hrn).get_authority_hrn()
9 def urn_to_hrn(urn): xrn=Xrn(urn); return (xrn.hrn, xrn.type)
10 def hrn_to_urn(hrn,type): return Xrn(hrn, type=type).urn
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']
20 return [ x.replace('--sep--','\\.') for x in hrn.replace('\\.','--sep--').split('.') ]
22 # e.g. hrn_leaf ('a\.b.c.d') -> 'd'
24 def hrn_leaf(hrn): return Xrn.hrn_split(hrn)[-1]
26 # e.g. hrn_auth_list ('a\.b.c.d') -> ['a\.b', 'c']
28 def hrn_auth_list(hrn): return Xrn.hrn_split(hrn)[0:-1]
30 # e.g. hrn_auth ('a\.b.c.d') -> 'a\.b.c'
32 def hrn_auth(hrn): return '.'.join(Xrn.hrn_auth_list(hrn))
34 # e.g. escape ('a.b') -> 'a\.b'
36 def escape(token): return re.sub(r'([^\\])\.', r'\1\.', token)
37 # e.g. unescape ('a\.b') -> 'a.b'
39 def unescape(token): return token.replace('\\.','.')
41 URN_PREFIX = "urn:publicid:IDN"
43 ########## basic tools on URNs
46 if urn.startswith(Xrn.URN_PREFIX): return urn
47 else: return Xrn.URN_PREFIX+URN
49 def urn_meaningful (urn):
50 if urn.startswith(Xrn.URN_PREFIX): return urn[len(Xrn.URN_PREFIX):]
54 return Xrn.urn_meaningful(urn).split('+')
57 # the local fields that are kept consistent
62 # provide either urn, or (hrn + type)
63 def __init__ (self, xrn, type=None):
64 # user has specified xrn : guess if urn or hrn
66 if xrn.startswith(Xrn.URN_PREFIX):
76 raise SfaAPIError,"Xrn.__init__"
77 # happens all the time ..
79 # sfa_logger().debug("type-less Xrn's are not safe")
81 def get_urn(self): return self.urn
82 def get_hrn(self): return self.hrn
83 def get_type(self): return self.type
84 def get_hrn_type(self): return (self.hrn, self.type)
87 if self.hrn is None: raise SfaAPIError, "Xrn._normalize"
88 if not hasattr(self,'leaf'):
89 self.leaf=Xrn.hrn_split(self.hrn)[-1]
90 # self.authority keeps a list
91 if not hasattr(self,'authority'):
92 self.authority=Xrn.hrn_auth_list(self.hrn)
98 def get_authority_hrn(self):
100 return '.'.join( self.authority )
102 def get_authority_urn(self):
104 return ':'.join( [Xrn.unescape(x) for x in self.authority] )
106 def urn_to_hrn(self):
108 compute tuple (hrn, type) from urn
111 # if not self.urn or not self.urn.startswith(Xrn.URN_PREFIX):
112 if not self.urn.startswith(Xrn.URN_PREFIX):
113 raise SfaAPIError, "Xrn.urn_to_hrn"
115 parts = Xrn.urn_split(self.urn)
117 # Remove the authority name (e.g. '.sa')
118 if type == 'authority': parts.pop()
120 # convert parts (list) into hrn (str) by doing the following
121 # 1. remove blank parts
122 # 2. escape dots inside parts
123 # 3. replace ':' with '.' inside parts
124 # 3. join parts using '.'
125 hrn = '.'.join([Xrn.escape(part).replace(':','.') for part in parts if part])
130 def hrn_to_urn(self):
132 compute urn from (hrn, type)
135 # if not self.hrn or self.hrn.startswith(Xrn.URN_PREFIX):
136 if self.hrn.startswith(Xrn.URN_PREFIX):
137 raise SfaAPIError, "Xrn.hrn_to_urn, hrn=%s"%self.hrn
139 if self.type == 'authority':
140 self.authority = Xrn.hrn_split(self.hrn)
143 self.authority = Xrn.hrn_auth_list(self.hrn)
144 name = Xrn.hrn_leaf(self.hrn)
146 authority_string = self.get_authority_urn()
148 if self.type == None:
149 urn = "+".join(['',authority_string,name])
151 urn = "+".join(['',authority_string,self.type,name])
153 self.urn = Xrn.URN_PREFIX + urn
155 def dump_string(self):
156 result="-------------------- XRN\n"
157 result += "URN=%s\n"%self.urn
158 result += "HRN=%s\n"%self.hrn
159 result += "TYPE=%s\n"%self.type
160 result += "LEAF=%s\n"%self.get_leaf()
161 result += "AUTH(hrn format)=%s\n"%self.get_authority_hrn()
162 result += "AUTH(urn format)=%s\n"%self.get_authority_urn()