sfa/util/xrn.py

   1 #----------------------------------------------------------------------\r
   2 # Copyright (c) 2008 Board of Trustees, Princeton University\r
   3 #\r
   4 # Permission is hereby granted, free of charge, to any person obtaining\r
   5 # a copy of this software and/or hardware specification (the "Work") to\r
   6 # deal in the Work without restriction, including without limitation the\r
   7 # rights to use, copy, modify, merge, publish, distribute, sublicense,\r
   8 # and/or sell copies of the Work, and to permit persons to whom the Work\r
   9 # is furnished to do so, subject to the following conditions:\r
  10 #\r
  11 # The above copyright notice and this permission notice shall be\r
  12 # included in all copies or substantial portions of the Work.\r
  13 #\r
  14 # THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS \r
  15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF \r
  16 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND \r
  17 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT \r
  18 # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, \r
  19 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, \r
  20 # OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS \r
  21 # IN THE WORK.\r
  22 #----------------------------------------------------------------------\r
  23 \r
  24 import re\r
  25 \r
  26 from sfa.util.faults import *\r
  27 \r
  28 # for convenience and smoother translation - we should get rid of these functions eventually \r
  29 def get_leaf(hrn): return Xrn(hrn).get_leaf()\r
  30 def get_authority(hrn): return Xrn(hrn).get_authority_hrn()\r
  31 def urn_to_hrn(urn): xrn=Xrn(urn); return (xrn.hrn, xrn.type)\r
  32 def hrn_to_urn(hrn,type): return Xrn(hrn, type=type).urn\r
  33 def hrn_authfor_hrn(parenthrn, hrn): return Xrn.hrn_is_auth_for_hrn(parenthrn, hrn)\r
  34 \r
  35 def urn_to_sliver_id(urn, slice_id, node_id, index=0):\r
  36     return ":".join([urn, slice_id, node_id, index])\r
  37 \r
  38 class Xrn:\r
  39 \r
  40     ########## basic tools on HRNs\r
  41     # split a HRN-like string into pieces\r
  42     # this is like split('.') except for escaped (backslashed) dots\r
  43     # e.g. hrn_split ('a\.b.c.d') -> [ 'a\.b','c','d']\r
  44     @staticmethod\r
  45     def hrn_split(hrn):\r
  46         return [ x.replace('--sep--','\\.') for x in hrn.replace('\\.','--sep--').split('.') ]\r
  47 \r
  48     # e.g. hrn_leaf ('a\.b.c.d') -> 'd'\r
  49     @staticmethod\r
  50     def hrn_leaf(hrn): return Xrn.hrn_split(hrn)[-1]\r
  51 \r
  52     # e.g. hrn_auth_list ('a\.b.c.d') -> ['a\.b', 'c']\r
  53     @staticmethod\r
  54     def hrn_auth_list(hrn): return Xrn.hrn_split(hrn)[0:-1]\r
  55     \r
  56     # e.g. hrn_auth ('a\.b.c.d') -> 'a\.b.c'\r
  57     @staticmethod\r
  58     def hrn_auth(hrn): return '.'.join(Xrn.hrn_auth_list(hrn))\r
  59     \r
  60     # e.g. escape ('a.b') -> 'a\.b'\r
  61     @staticmethod\r
  62     def escape(token): return re.sub(r'([^\\])\.', r'\1\.', token)\r
  63 \r
  64     # e.g. unescape ('a\.b') -> 'a.b'\r
  65     @staticmethod\r
  66     def unescape(token): return token.replace('\\.','.')\r
  67 \r
  68     # Return the HRN authority chain from top to bottom.\r
  69     # e.g. hrn_auth_chain('a\.b.c.d') -> ['a\.b', 'a\.b.c']\r
  70     @staticmethod\r
  71     def hrn_auth_chain(hrn):\r
  72         parts = Xrn.hrn_auth_list(hrn)\r
  73         chain = []\r
  74         for i in range(len(parts)):\r
  75             chain.append('.'.join(parts[:i+1]))\r
  76         # Include the HRN itself?\r
  77         #chain.append(hrn)\r
  78         return chain\r
  79 \r
  80     # Is the given HRN a true authority over the namespace of the other\r
  81     # child HRN?\r
  82     # A better alternative than childHRN.startswith(parentHRN)\r
  83     # e.g. hrn_is_auth_for_hrn('a\.b', 'a\.b.c.d') -> True,\r
  84     # but hrn_is_auth_for_hrn('a', 'a\.b.c.d') -> False\r
  85     # Also hrn_is_uauth_for_hrn('a\.b.c.d', 'a\.b.c.d') -> True\r
  86     @staticmethod\r
  87     def hrn_is_auth_for_hrn(parenthrn, hrn):\r
  88         if parenthrn == hrn:\r
  89             return True\r
  90         for auth in Xrn.hrn_auth_chain(hrn):\r
  91             if parenthrn == auth:\r
  92                 return True\r
  93         return False\r
  94 \r
  95     URN_PREFIX = "urn:publicid:IDN"\r
  96 \r
  97     ########## basic tools on URNs\r
  98     @staticmethod\r
  99     def urn_full (urn):\r
 100         if urn.startswith(Xrn.URN_PREFIX): return urn\r
 101         else: return Xrn.URN_PREFIX+URN\r
 102     @staticmethod\r
 103     def urn_meaningful (urn):\r
 104         if urn.startswith(Xrn.URN_PREFIX): return urn[len(Xrn.URN_PREFIX):]\r
 105         else: return urn\r
 106     @staticmethod\r
 107     def urn_split (urn):\r
 108         return Xrn.urn_meaningful(urn).split('+')\r
 109 \r
 110     ####################\r
 111     # the local fields that are kept consistent\r
 112     # self.urn\r
 113     # self.hrn\r
 114     # self.type\r
 115     # self.path\r
 116     # provide either urn, or (hrn + type)\r
 117     def __init__ (self, xrn, type=None):\r
 118         if not xrn: xrn = ""\r
 119         # user has specified xrn : guess if urn or hrn\r
 120         if xrn.startswith(Xrn.URN_PREFIX):\r
 121             self.hrn=None\r
 122             self.urn=xrn\r
 123             self.urn_to_hrn()\r
 124         else:\r
 125             self.urn=None\r
 126             self.hrn=xrn\r
 127             self.type=type\r
 128             self.hrn_to_urn()\r
 129 # happens all the time ..\r
 130 #        if not type:\r
 131 #            debug_logger.debug("type-less Xrn's are not safe")\r
 132 \r
 133     def get_urn(self): return self.urn\r
 134     def get_hrn(self): return self.hrn\r
 135     def get_type(self): return self.type\r
 136     def get_hrn_type(self): return (self.hrn, self.type)\r
 137 \r
 138     def _normalize(self):\r
 139         if self.hrn is None: raise SfaAPIError, "Xrn._normalize"\r
 140         if not hasattr(self,'leaf'): \r
 141             self.leaf=Xrn.hrn_split(self.hrn)[-1]\r
 142         # self.authority keeps a list\r
 143         if not hasattr(self,'authority'): \r
 144             self.authority=Xrn.hrn_auth_list(self.hrn)\r
 145 \r
 146     def get_leaf(self):\r
 147         self._normalize()\r
 148         return self.leaf\r
 149 \r
 150     def get_authority_hrn(self): \r
 151         self._normalize()\r
 152         return '.'.join( self.authority )\r
 153     \r
 154     def get_authority_urn(self): \r
 155         self._normalize()\r
 156         return ':'.join( [Xrn.unescape(x) for x in self.authority] )\r
 157     \r
 158     def urn_to_hrn(self):\r
 159         """\r
 160         compute tuple (hrn, type) from urn\r
 161         """\r
 162         \r
 163 #        if not self.urn or not self.urn.startswith(Xrn.URN_PREFIX):\r
 164         if not self.urn.startswith(Xrn.URN_PREFIX):\r
 165             raise SfaAPIError, "Xrn.urn_to_hrn"\r
 166 \r
 167         parts = Xrn.urn_split(self.urn)\r
 168         type=parts.pop(2)\r
 169         # Remove the authority name (e.g. '.sa')\r
 170         if type == 'authority':\r
 171             name = parts.pop()\r
 172             # Drop the sa. This is a bad hack, but its either this\r
 173             # or completely change how record types are generated/stored   \r
 174             if name != 'sa':\r
 175                 type = type + "+" + name\r
 176 \r
 177         # convert parts (list) into hrn (str) by doing the following\r
 178         # 1. remove blank parts\r
 179         # 2. escape dots inside parts\r
 180         # 3. replace ':' with '.' inside parts\r
 181         # 3. join parts using '.' \r
 182         hrn = '.'.join([Xrn.escape(part).replace(':','.') for part in parts if part]) \r
 183 \r
 184         self.hrn=str(hrn)\r
 185         self.type=str(type)\r
 186     \r
 187     def hrn_to_urn(self):\r
 188         """\r
 189         compute urn from (hrn, type)\r
 190         """\r
 191 \r
 192 #        if not self.hrn or self.hrn.startswith(Xrn.URN_PREFIX):\r
 193         if self.hrn.startswith(Xrn.URN_PREFIX):\r
 194             raise SfaAPIError, "Xrn.hrn_to_urn, hrn=%s"%self.hrn\r
 195 \r
 196         if self.type and self.type.startswith('authority'):\r
 197             self.authority = Xrn.hrn_split(self.hrn)\r
 198             type_parts = self.type.split("+")\r
 199             self.type = type_parts[0]\r
 200             name = 'sa'\r
 201             if len(type_parts) > 1:\r
 202                 name = type_parts[1]\r
 203         else:\r
 204             self.authority = Xrn.hrn_auth_list(self.hrn)\r
 205             name = Xrn.hrn_leaf(self.hrn)\r
 206 \r
 207         authority_string = self.get_authority_urn()\r
 208 \r
 209         if self.type == None:\r
 210             urn = "+".join(['',authority_string,Xrn.unescape(name)])\r
 211         else:\r
 212             urn = "+".join(['',authority_string,self.type,Xrn.unescape(name)])\r
 213         \r
 214         self.urn = Xrn.URN_PREFIX + urn\r
 215 \r
 216     def dump_string(self):\r
 217         result="-------------------- XRN\n"\r
 218         result += "URN=%s\n"%self.urn\r
 219         result += "HRN=%s\n"%self.hrn\r
 220         result += "TYPE=%s\n"%self.type\r
 221         result += "LEAF=%s\n"%self.get_leaf()\r
 222         result += "AUTH(hrn format)=%s\n"%self.get_authority_hrn()\r
 223         result += "AUTH(urn format)=%s\n"%self.get_authority_urn()\r
 224         return result\r
 225         \r