1 #----------------------------------------------------------------------
2 # Copyright (c) 2008 Board of Trustees, Princeton University
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:
11 # The above copyright notice and this permission notice shall be
12 # included in all copies or substantial portions of the Work.
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
22 #----------------------------------------------------------------------
26 from sfa.util.faults import SfaAPIError
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)
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)
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']
46 return [ x.replace('--sep--','\\.') for x in hrn.replace('\\.','--sep--').split('.') ]
48 # e.g. hrn_leaf ('a\.b.c.d') -> 'd'
50 def hrn_leaf(hrn): return Xrn.hrn_split(hrn)[-1]
52 # e.g. hrn_auth_list ('a\.b.c.d') -> ['a\.b', 'c']
54 def hrn_auth_list(hrn): return Xrn.hrn_split(hrn)[0:-1]
56 # e.g. hrn_auth ('a\.b.c.d') -> 'a\.b.c'
58 def hrn_auth(hrn): return '.'.join(Xrn.hrn_auth_list(hrn))
60 # e.g. escape ('a.b') -> 'a\.b'
62 def escape(token): return re.sub(r'([^\\])\.', r'\1\.', token)
64 # e.g. unescape ('a\.b') -> 'a.b'
66 def unescape(token): return token.replace('\\.','.')
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']
71 def hrn_auth_chain(hrn):
72 parts = Xrn.hrn_auth_list(hrn)
74 for i in range(len(parts)):
75 chain.append('.'.join(parts[:i+1]))
76 # Include the HRN itself?
80 # Is the given HRN a true authority over the namespace of the other
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
87 def hrn_is_auth_for_hrn(parenthrn, hrn):
90 for auth in Xrn.hrn_auth_chain(hrn):
95 URN_PREFIX = "urn:publicid:IDN"
97 ########## basic tools on URNs
100 if urn.startswith(Xrn.URN_PREFIX): return urn
101 else: return Xrn.URN_PREFIX+urn
103 def urn_meaningful (urn):
104 if urn.startswith(Xrn.URN_PREFIX): return urn[len(Xrn.URN_PREFIX):]
108 return Xrn.urn_meaningful(urn).split('+')
111 # the local fields that are kept consistent
116 # provide either urn, or (hrn + type)
117 def __init__ (self, xrn, type=None):
120 # user has specified xrn : guess if urn or hrn
121 if xrn.startswith(Xrn.URN_PREFIX):
125 #print>>sys.stderr, " \r\n \r\n \t XRN.PY init xrn.startswith(Xrn.URN_PREFIX) hrn %s urn %s type %s" %( self.hrn, self.urn, self.type)
131 #print>>sys.stderr, " \r\n \r\n \t XRN.PY init ELSE hrn %s urn %s type %s" %( self.hrn, self.urn, self.type)
132 # happens all the time ..
134 # debug_logger.debug("type-less Xrn's are not safe")
137 result="<XRN u=%s h=%s"%(self.urn,self.hrn)
138 if hasattr(self,'leaf'): result += " leaf=%s"%self.leaf
139 if hasattr(self,'authority'): result += " auth=%s"%self.authority
143 def get_urn(self): return self.urn
144 def get_hrn(self): return self.hrn
145 def get_type(self): return self.type
146 def get_hrn_type(self): return (self.hrn, self.type)
148 def _normalize(self):
149 #print>>sys.stderr, " \r\n \r\n \t XRN.PY _normalize self.hrn %s ",self.hrn
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 #print>>sys.stderr, " \r\n \r\n \t XRN.PY _normalize self.hrn %s leaf %s authority %s"%(self.hrn, self.leaf, self.authority)
163 def get_authority_hrn(self):
165 return '.'.join( self.authority )
167 def get_authority_urn(self):
169 return ':'.join( [Xrn.unescape(x) for x in self.authority] )
171 def get_sliver_id(self, slice_id, node_id, index=0, authority=None):
175 authority_hrn = self.get_authority_hrn()
176 if not authority_hrn.startswith(authority):
177 hrn = ".".join([authority,self.get_authority_hrn(), self.get_leaf()])
179 hrn = ".".join([self.get_authority_hrn(), self.get_leaf()])
180 urn = Xrn(hrn, self.get_type()).get_urn()
181 return ":".join(map(str, [urn, slice_id, node_id, index]))
183 def urn_to_hrn(self):
185 compute tuple (hrn, type) from urn
188 # if not self.urn or not self.urn.startswith(Xrn.URN_PREFIX):
189 if not self.urn.startswith(Xrn.URN_PREFIX):
190 raise SfaAPIError, "Xrn.urn_to_hrn"
192 parts = Xrn.urn_split(self.urn)
194 # Remove the authority name (e.g. '.sa')
195 if type == 'authority':
197 # Drop the sa. This is a bad hack, but its either this
198 # or completely change how record types are generated/stored
200 type = type + "+" + name
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
212 hrn += '.%s' % Xrn.escape(name)
217 def hrn_to_urn(self):
219 compute urn from (hrn, type)
222 # if not self.hrn or self.hrn.startswith(Xrn.URN_PREFIX):
223 if self.hrn.startswith(Xrn.URN_PREFIX):
224 raise SfaAPIError, "Xrn.hrn_to_urn, hrn=%s"%self.hrn
226 if self.type and self.type.startswith('authority'):
227 self.authority = Xrn.hrn_split(self.hrn)
228 type_parts = self.type.split("+")
229 self.type = type_parts[0]
231 if len(type_parts) > 1:
234 self.authority = Xrn.hrn_auth_list(self.hrn)
235 name = Xrn.hrn_leaf(self.hrn)
237 authority_string = self.get_authority_urn()
239 if self.type == None:
240 urn = "+".join(['',authority_string,Xrn.unescape(name)])
242 urn = "+".join(['',authority_string,self.type,Xrn.unescape(name)])
244 self.urn = Xrn.URN_PREFIX + urn
246 def dump_string(self):
247 result="-------------------- XRN\n"
248 result += "URN=%s\n"%self.urn
249 result += "HRN=%s\n"%self.hrn
250 result += "TYPE=%s\n"%self.type
251 result += "LEAF=%s\n"%self.get_leaf()
252 result += "AUTH(hrn format)=%s\n"%self.get_authority_hrn()
253 result += "AUTH(urn format)=%s\n"%self.get_authority_urn()