-#----------------------------------------------------------------------\r
-# Copyright (c) 2008 Board of Trustees, Princeton University\r
-#\r
-# Permission is hereby granted, free of charge, to any person obtaining\r
-# a copy of this software and/or hardware specification (the "Work") to\r
-# deal in the Work without restriction, including without limitation the\r
-# rights to use, copy, modify, merge, publish, distribute, sublicense,\r
-# and/or sell copies of the Work, and to permit persons to whom the Work\r
-# is furnished to do so, subject to the following conditions:\r
-#\r
-# The above copyright notice and this permission notice shall be\r
-# included in all copies or substantial portions of the Work.\r
-#\r
-# THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS \r
-# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF \r
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND \r
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT \r
-# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, \r
-# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, \r
-# OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS \r
-# IN THE WORK.\r
-#----------------------------------------------------------------------\r
-\r
-import re\r
-\r
-from sfa.util.faults import SfaAPIError\r
-\r
-# for convenience and smoother translation - we should get rid of these functions eventually \r
-def get_leaf(hrn): return Xrn(hrn).get_leaf()\r
-def get_authority(hrn): return Xrn(hrn).get_authority_hrn()\r
-def urn_to_hrn(urn): xrn=Xrn(urn); return (xrn.hrn, xrn.type)\r
-def hrn_to_urn(hrn,type): return Xrn(hrn, type=type).urn\r
-def hrn_authfor_hrn(parenthrn, hrn): return Xrn.hrn_is_auth_for_hrn(parenthrn, hrn)\r
-\r
-def urn_to_sliver_id(urn, slice_id, node_id, index=0, authority=None):\r
- return Xrn(urn).get_sliver_id(slice_id, node_id, index, authority)\r
-\r
-class Xrn:\r
-\r
- ########## basic tools on HRNs\r
- # split a HRN-like string into pieces\r
- # this is like split('.') except for escaped (backslashed) dots\r
- # e.g. hrn_split ('a\.b.c.d') -> [ 'a\.b','c','d']\r
- @staticmethod\r
- def hrn_split(hrn):\r
- return [ x.replace('--sep--','\\.') for x in hrn.replace('\\.','--sep--').split('.') ]\r
-\r
- # e.g. hrn_leaf ('a\.b.c.d') -> 'd'\r
- @staticmethod\r
- def hrn_leaf(hrn): return Xrn.hrn_split(hrn)[-1]\r
-\r
- # e.g. hrn_auth_list ('a\.b.c.d') -> ['a\.b', 'c']\r
- @staticmethod\r
- def hrn_auth_list(hrn): return Xrn.hrn_split(hrn)[0:-1]\r
- \r
- # e.g. hrn_auth ('a\.b.c.d') -> 'a\.b.c'\r
- @staticmethod\r
- def hrn_auth(hrn): return '.'.join(Xrn.hrn_auth_list(hrn))\r
- \r
- # e.g. escape ('a.b') -> 'a\.b'\r
- @staticmethod\r
- def escape(token): return re.sub(r'([^\\])\.', r'\1\.', token)\r
-\r
- # e.g. unescape ('a\.b') -> 'a.b'\r
- @staticmethod\r
- def unescape(token): return token.replace('\\.','.')\r
-\r
- # Return the HRN authority chain from top to bottom.\r
- # e.g. hrn_auth_chain('a\.b.c.d') -> ['a\.b', 'a\.b.c']\r
- @staticmethod\r
- def hrn_auth_chain(hrn):\r
- parts = Xrn.hrn_auth_list(hrn)\r
- chain = []\r
- for i in range(len(parts)):\r
- chain.append('.'.join(parts[:i+1]))\r
- # Include the HRN itself?\r
- #chain.append(hrn)\r
- return chain\r
-\r
- # Is the given HRN a true authority over the namespace of the other\r
- # child HRN?\r
- # A better alternative than childHRN.startswith(parentHRN)\r
- # e.g. hrn_is_auth_for_hrn('a\.b', 'a\.b.c.d') -> True,\r
- # but hrn_is_auth_for_hrn('a', 'a\.b.c.d') -> False\r
- # Also hrn_is_auth_for_hrn('a\.b.c.d', 'a\.b.c.d') -> True\r
- @staticmethod\r
- def hrn_is_auth_for_hrn(parenthrn, hrn):\r
- if parenthrn == hrn:\r
- return True\r
- for auth in Xrn.hrn_auth_chain(hrn):\r
- if parenthrn == auth:\r
- return True\r
- return False\r
-\r
- ########## basic tools on URNs\r
- URN_PREFIX = "urn:publicid:IDN"\r
- URN_PREFIX_lower = "urn:publicid:idn"\r
-\r
- @staticmethod\r
- def is_urn (text):\r
- return text.lower().startswith(Xrn.URN_PREFIX_lower)\r
-\r
- @staticmethod\r
- def urn_full (urn):\r
- if Xrn.is_urn(urn): return urn\r
- else: return Xrn.URN_PREFIX+urn\r
- @staticmethod\r
- def urn_meaningful (urn):\r
- if Xrn.is_urn(urn): return urn[len(Xrn.URN_PREFIX):]\r
- else: return urn\r
- @staticmethod\r
- def urn_split (urn):\r
- return Xrn.urn_meaningful(urn).split('+')\r
-\r
- ####################\r
- # the local fields that are kept consistent\r
- # self.urn\r
- # self.hrn\r
- # self.type\r
- # self.path\r
- # provide either urn, or (hrn + type)\r
- def __init__ (self, xrn, type=None):\r
- if not xrn: xrn = ""\r
- # user has specified xrn : guess if urn or hrn\r
- if Xrn.is_urn(xrn):\r
- self.hrn=None\r
- self.urn=xrn\r
- self.urn_to_hrn()\r
- else:\r
- self.urn=None\r
- self.hrn=xrn\r
- self.type=type\r
- self.hrn_to_urn()\r
- self._normalize()\r
-# happens all the time ..\r
-# if not type:\r
-# debug_logger.debug("type-less Xrn's are not safe")\r
-\r
- def __repr__ (self):\r
- result="<XRN u=%s h=%s"%(self.urn,self.hrn)\r
- if hasattr(self,'leaf'): result += " leaf=%s"%self.leaf\r
- if hasattr(self,'authority'): result += " auth=%s"%self.authority\r
- result += ">"\r
- return result\r
-\r
- def get_urn(self): return self.urn\r
- def get_hrn(self): return self.hrn\r
- def get_type(self): return self.type\r
- def get_hrn_type(self): return (self.hrn, self.type)\r
-\r
- def _normalize(self):\r
- if self.hrn is None: raise SfaAPIError, "Xrn._normalize"\r
- if not hasattr(self,'leaf'): \r
- self.leaf=Xrn.hrn_split(self.hrn)[-1]\r
- # self.authority keeps a list\r
- if not hasattr(self,'authority'): \r
- self.authority=Xrn.hrn_auth_list(self.hrn)\r
-\r
- def get_leaf(self):\r
- self._normalize()\r
- return self.leaf\r
-\r
- def get_authority_hrn(self):\r
- self._normalize()\r
- return '.'.join( self.authority )\r
- \r
- def get_authority_urn(self): \r
- self._normalize()\r
- return ':'.join( [Xrn.unescape(x) for x in self.authority] )\r
-\r
- def get_sliver_id(self, slice_id, node_id=None, index=0, authority=None):\r
- self._normalize()\r
- urn = self.get_urn()\r
- if authority:\r
- authority_hrn = self.get_authority_hrn()\r
- if not authority_hrn.startswith(authority):\r
- hrn = ".".join([authority,authority_hrn, self.get_leaf()])\r
- else:\r
- hrn = ".".join([authority_hrn, self.get_leaf()])\r
- urn = Xrn(hrn, self.get_type()).get_urn()\r
- parts = [part for part in [urn, slice_id, node_id, index] if part is not None]\r
- return ":".join(map(str, [parts]))\r
-\r
- def urn_to_hrn(self):\r
- """\r
- compute tuple (hrn, type) from urn\r
- """\r
- \r
-# if not self.urn or not self.urn.startswith(Xrn.URN_PREFIX):\r
- if not Xrn.is_urn(self.urn):\r
- raise SfaAPIError, "Xrn.urn_to_hrn"\r
-\r
- parts = Xrn.urn_split(self.urn)\r
- type=parts.pop(2)\r
- # Remove the authority name (e.g. '.sa')\r
- if type == 'authority':\r
- name = parts.pop()\r
- # Drop the sa. This is a bad hack, but its either this\r
- # or completely change how record types are generated/stored \r
- if name != 'sa':\r
- type = type + "+" + name\r
- name =""\r
- else:\r
- name = parts.pop(len(parts)-1)\r
- # convert parts (list) into hrn (str) by doing the following\r
- # 1. remove blank parts\r
- # 2. escape dots inside parts\r
- # 3. replace ':' with '.' inside parts\r
- # 3. join parts using '.'\r
- hrn = '.'.join([Xrn.escape(part).replace(':','.') for part in parts if part])\r
- # dont replace ':' in the name section\r
- if name:\r
- hrn += '.%s' % Xrn.escape(name) \r
-\r
- self.hrn=str(hrn)\r
- self.type=str(type)\r
- \r
- def hrn_to_urn(self):\r
- """\r
- compute urn from (hrn, type)\r
- """\r
-\r
-# if not self.hrn or self.hrn.startswith(Xrn.URN_PREFIX):\r
- if Xrn.is_urn(self.hrn):\r
- raise SfaAPIError, "Xrn.hrn_to_urn, hrn=%s"%self.hrn\r
-\r
- if self.type and self.type.startswith('authority'):\r
- self.authority = Xrn.hrn_auth_list(self.hrn)\r
- leaf = self.get_leaf()\r
- #if not self.authority:\r
- # self.authority = [self.hrn]\r
- type_parts = self.type.split("+")\r
- self.type = type_parts[0]\r
- name = 'sa'\r
- if len(type_parts) > 1:\r
- name = type_parts[1]\r
- auth_parts = [part for part in [self.get_authority_urn(), leaf] if part]\r
- authority_string = ":".join(auth_parts)\r
- else:\r
- self.authority = Xrn.hrn_auth_list(self.hrn)\r
- name = Xrn.hrn_leaf(self.hrn)\r
- authority_string = self.get_authority_urn()\r
-\r
- if self.type == None:\r
- urn = "+".join(['',authority_string,Xrn.unescape(name)])\r
- else:\r
- urn = "+".join(['',authority_string,self.type,Xrn.unescape(name)])\r
- \r
- self.urn = Xrn.URN_PREFIX + urn\r
-\r
- def dump_string(self):\r
- result="-------------------- XRN\n"\r
- result += "URN=%s\n"%self.urn\r
- result += "HRN=%s\n"%self.hrn\r
- result += "TYPE=%s\n"%self.type\r
- result += "LEAF=%s\n"%self.get_leaf()\r
- result += "AUTH(hrn format)=%s\n"%self.get_authority_hrn()\r
- result += "AUTH(urn format)=%s\n"%self.get_authority_urn()\r
- return result\r
- \r
+# ----------------------------------------------------------------------
+# Copyright (c) 2008 Board of Trustees, Princeton University
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and/or hardware specification (the "Work") to
+# deal in the Work without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Work, and to permit persons to whom the Work
+# is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Work.
+#
+# THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS
+# IN THE WORK.
+# ----------------------------------------------------------------------
+
+import re
+
+from sfa.util.faults import SfaAPIError
+
+# for convenience and smoother translation - we should get rid of these
+# functions eventually
+
+
+def get_leaf(hrn):
+ return Xrn(hrn).get_leaf()
+
+
+def get_authority(hrn):
+ return Xrn(hrn).get_authority_hrn()
+
+
+def urn_to_hrn(urn):
+ xrn = Xrn(urn)
+ return (xrn.hrn, xrn.type)
+
+
+def hrn_to_urn(hrn, type): return Xrn(hrn, type=type).urn
+
+
+def hrn_authfor_hrn(parenthrn, hrn):
+ return Xrn.hrn_is_auth_for_hrn(parenthrn, hrn)
+
+
+class Xrn:
+
+ # basic tools on HRNs
+ # split a HRN-like string into pieces
+ # this is like split('.') except for escaped (backslashed) dots
+ # e.g. hrn_split ('a\.b.c.d') -> [ 'a\.b','c','d']
+ @staticmethod
+ def hrn_split(hrn):
+ return [x.replace('--sep--', '\\.')
+ for x in hrn.replace('\\.', '--sep--').split('.')]
+
+ # e.g. hrn_leaf ('a\.b.c.d') -> 'd'
+ @staticmethod
+ def hrn_leaf(hrn):
+ return Xrn.hrn_split(hrn)[-1]
+
+ # e.g. hrn_auth_list ('a\.b.c.d') -> ['a\.b', 'c']
+ @staticmethod
+ def hrn_auth_list(hrn):
+ return Xrn.hrn_split(hrn)[0:-1]
+
+ # e.g. hrn_auth ('a\.b.c.d') -> 'a\.b.c'
+ @staticmethod
+ def hrn_auth(hrn):
+ return '.'.join(Xrn.hrn_auth_list(hrn))
+
+ # e.g. escape ('a.b') -> 'a\.b'
+ @staticmethod
+ def escape(token):
+ return re.sub(r'([^\\])\.', r'\1\.', token)
+
+ # e.g. unescape ('a\.b') -> 'a.b'
+ @staticmethod
+ def unescape(token):
+ return token.replace('\\.', '.')
+
+ # Return the HRN authority chain from top to bottom.
+ # e.g. hrn_auth_chain('a\.b.c.d') -> ['a\.b', 'a\.b.c']
+ @staticmethod
+ def hrn_auth_chain(hrn):
+ parts = Xrn.hrn_auth_list(hrn)
+ chain = []
+ for i in range(len(parts)):
+ chain.append('.'.join(parts[:i + 1]))
+ # Include the HRN itself?
+ # chain.append(hrn)
+ return chain
+
+ # Is the given HRN a true authority over the namespace of the other
+ # child HRN?
+ # A better alternative than childHRN.startswith(parentHRN)
+ # e.g. hrn_is_auth_for_hrn('a\.b', 'a\.b.c.d') -> True,
+ # but hrn_is_auth_for_hrn('a', 'a\.b.c.d') -> False
+ # Also hrn_is_auth_for_hrn('a\.b.c.d', 'a\.b.c.d') -> True
+ @staticmethod
+ def hrn_is_auth_for_hrn(parenthrn, hrn):
+ if parenthrn == hrn:
+ return True
+ for auth in Xrn.hrn_auth_chain(hrn):
+ if parenthrn == auth:
+ return True
+ return False
+
+ # basic tools on URNs
+ URN_PREFIX = "urn:publicid:IDN"
+ URN_PREFIX_lower = "urn:publicid:idn"
+
+ @staticmethod
+ def is_urn(text):
+ return text.lower().startswith(Xrn.URN_PREFIX_lower)
+
+ @staticmethod
+ def urn_full(urn):
+ if Xrn.is_urn(urn):
+ return urn
+ else:
+ return Xrn.URN_PREFIX + urn
+
+ @staticmethod
+ def urn_meaningful(urn):
+ if Xrn.is_urn(urn):
+ return urn[len(Xrn.URN_PREFIX):]
+ else:
+ return urn
+
+ @staticmethod
+ def urn_split(urn):
+ return Xrn.urn_meaningful(urn).split('+')
+
+ @staticmethod
+ def filter_type(urns=None, type=None):
+ if urns is None:
+ urns = []
+ urn_list = []
+ if not type:
+ return urns
+
+ for urn in urns:
+ xrn = Xrn(xrn=urn)
+ if (xrn.type == type):
+ # Xrn is probably a urn so we can just compare types
+ urn_list.append(urn)
+ return urn_list
+ ####################
+ # the local fields that are kept consistent
+ # self.urn
+ # self.hrn
+ # self.type
+ # self.path
+ # provide either urn, or (hrn + type)
+
+ def __init__(self, xrn="", type=None, id=None):
+ if not xrn:
+ xrn = ""
+ # user has specified xrn : guess if urn or hrn
+ self.id = id
+ if Xrn.is_urn(xrn):
+ self.hrn = None
+ self.urn = xrn
+ if id:
+ self.urn = "%s:%s" % (self.urn, str(id))
+ self.urn_to_hrn()
+ else:
+ self.urn = None
+ self.hrn = xrn
+ self.type = type
+ self.hrn_to_urn()
+ self._normalize()
+# happens all the time ..
+# if not type:
+# debug_logger.debug("type-less Xrn's are not safe")
+
+ def __repr__(self):
+ result = "<XRN u=%s h=%s" % (self.urn, self.hrn)
+ if hasattr(self, 'leaf'):
+ result += " leaf=%s" % self.leaf
+ if hasattr(self, 'authority'):
+ result += " auth=%s" % self.authority
+ result += ">"
+ return result
+
+ def get_urn(self): return self.urn
+
+ def get_hrn(self): return self.hrn
+
+ def get_type(self): return self.type
+
+ def get_hrn_type(self): return (self.hrn, self.type)
+
+ def _normalize(self):
+ if self.hrn is None:
+ raise SfaAPIError("Xrn._normalize")
+ if not hasattr(self, 'leaf'):
+ self.leaf = Xrn.hrn_split(self.hrn)[-1]
+ # self.authority keeps a list
+ if not hasattr(self, 'authority'):
+ self.authority = Xrn.hrn_auth_list(self.hrn)
+
+ def get_leaf(self):
+ self._normalize()
+ return self.leaf
+
+ def get_authority_hrn(self):
+ self._normalize()
+ return '.'.join(self.authority)
+
+ def get_authority_urn(self):
+ self._normalize()
+ return ':'.join([Xrn.unescape(x) for x in self.authority])
+
+ def set_authority(self, authority):
+ """
+ update the authority section of an existing urn
+ """
+ authority_hrn = self.get_authority_hrn()
+ if not authority_hrn.startswith(authority):
+ hrn = ".".join([authority, authority_hrn, self.get_leaf()])
+ else:
+ hrn = ".".join([authority_hrn, self.get_leaf()])
+
+ self.hrn = hrn
+ self.hrn_to_urn()
+ self._normalize()
+
+ # sliver_id_parts is list that contains the sliver's
+ # slice id and node id
+ def get_sliver_id_parts(self):
+ sliver_id_parts = []
+ if self.type == 'sliver' or '-' in self.leaf:
+ sliver_id_parts = self.leaf.split('-')
+ return sliver_id_parts
+
+ def urn_to_hrn(self):
+ """
+ compute tuple (hrn, type) from urn
+ """
+
+# if not self.urn or not self.urn.startswith(Xrn.URN_PREFIX):
+ if not Xrn.is_urn(self.urn):
+ raise SfaAPIError("Xrn.urn_to_hrn")
+
+ parts = Xrn.urn_split(self.urn)
+ type = parts.pop(2)
+ # Remove the authority name (e.g. '.sa')
+ if type == 'authority':
+ name = parts.pop()
+ # Drop the sa. This is a bad hack, but its either this
+ # or completely change how record types are generated/stored
+ if name != 'sa':
+ type = type + "+" + name
+ name = ""
+ else:
+ name = parts.pop(len(parts) - 1)
+ # convert parts (list) into hrn (str) by doing the following
+ # 1. remove blank parts
+ # 2. escape dots inside parts
+ # 3. replace ':' with '.' inside parts
+ # 3. join parts using '.'
+ hrn = '.'.join([Xrn.escape(part).replace(':', '.')
+ for part in parts if part])
+ # dont replace ':' in the name section
+ if name:
+ parts = name.split(':')
+ if len(parts) > 1:
+ self.id = ":".join(parts[1:])
+ name = parts[0]
+ hrn += '.%s' % Xrn.escape(name)
+
+ self.hrn = str(hrn)
+ self.type = str(type)
+
+ def hrn_to_urn(self):
+ """
+ compute urn from (hrn, type)
+ """
+
+# if not self.hrn or self.hrn.startswith(Xrn.URN_PREFIX):
+ if Xrn.is_urn(self.hrn):
+ raise SfaAPIError("Xrn.hrn_to_urn, hrn=%s" % self.hrn)
+
+ if self.type and self.type.startswith('authority'):
+ self.authority = Xrn.hrn_auth_list(self.hrn)
+ leaf = self.get_leaf()
+ # if not self.authority:
+ # self.authority = [self.hrn]
+ type_parts = self.type.split("+")
+ self.type = type_parts[0]
+ name = 'sa'
+ if len(type_parts) > 1:
+ name = type_parts[1]
+ auth_parts = [part for part in [
+ self.get_authority_urn(), leaf] if part]
+ authority_string = ":".join(auth_parts)
+ else:
+ self.authority = Xrn.hrn_auth_list(self.hrn)
+ name = Xrn.hrn_leaf(self.hrn)
+ authority_string = self.get_authority_urn()
+
+ if self.type is None:
+ urn = "+".join(['', authority_string, Xrn.unescape(name)])
+ else:
+ urn = "+".join(['', authority_string,
+ self.type, Xrn.unescape(name)])
+
+ if hasattr(self, 'id') and self.id:
+ urn = "%s:%s" % (urn, self.id)
+
+ self.urn = Xrn.URN_PREFIX + urn
+
+ def dump_string(self):
+ result = "-------------------- XRN\n"
+ result += "URN=%s\n" % self.urn
+ result += "HRN=%s\n" % self.hrn
+ result += "TYPE=%s\n" % self.type
+ result += "LEAF=%s\n" % self.get_leaf()
+ result += "AUTH(hrn format)=%s\n" % self.get_authority_hrn()
+ result += "AUTH(urn format)=%s\n" % self.get_authority_urn()
+ return result