ProtoGeni slices may have special characters that need to be filtered out
[sfa.git] / sfa / util / namespace.py
1 ### $Id$
2 ### $URL$
3 import re
4 from sfa.util.faults import *
5 URN_PREFIX = "urn:publicid:IDN"
6
7 def get_leaf(hrn):
8     parts = hrn.split(".")
9     return ".".join(parts[-1:])
10
11 def get_authority(xrn):
12     hrn, type = urn_to_hrn(xrn)
13     if type and type == 'authority':
14         return hrn
15     
16     parts = hrn.split(".")
17     return ".".join(parts[:-1])
18
19 def hrn_to_pl_slicename(hrn):
20     parts = hrn.split(".")
21     return parts[-2] + "_" + parts[-1]
22
23 # assuming hrn is the hrn of an authority, return the plc authority name
24 def hrn_to_pl_authname(hrn):
25     parts = hrn.split(".")
26     return parts[-1]
27
28 # assuming hrn is the hrn of an authority, return the plc login_base
29 def hrn_to_pl_login_base(hrn):
30     return hrn_to_pl_authname(hrn)
31
32 def hostname_to_hrn(auth_hrn, login_base, hostname):
33     """
34     Convert hrn to plantelab name.
35     """
36     sfa_hostname = ".".join([auth_hrn, login_base, hostname.split(".")[0]])
37     return sfa_hostname
38
39 def slicename_to_hrn(auth_hrn, slicename):
40     """
41     Convert hrn to planetlab name.
42     """
43     parts = slicename.split("_")
44     slice_hrn = ".".join([auth_hrn, parts[0]]) + "." + "_".join(parts[1:])
45
46     return slice_hrn
47
48 def email_to_hrn(auth_hrn, email):
49     parts = email.split("@")
50     username = parts[0]
51     username = username.replace(".", "_").replace("+", "_") 
52     person_hrn = ".".join([auth_hrn, username])
53     
54     return person_hrn 
55
56 def urn_to_hrn(urn):
57     """
58     convert a urn to hrn
59     return a tuple (hrn, type)
60     Warning: urn_to_hrn() replces some special characters that 
61     are not replaced in hrn_to_urn(). Due to this, 
62     urn_to_hrn() -> hrn_to_urn() may not return the original urn
63     """
64
65     # if this is already a hrn dont do anything
66     if not urn or not urn.startswith(URN_PREFIX):
67         return urn, None
68
69     name = urn[len(URN_PREFIX):]
70     hrn_parts = name.split("+")
71     type = hrn_parts.pop(2)
72     
73          
74     # Remove the authority name (e.g. '.sa')
75     if type == 'authority':
76         hrn_parts = hrn_parts[:-1]
77
78     # convert hrn_parts (list) into hrn (str) by doing the following    
79     # dont allow special characters (except ':') in the site login base
80     # remove blank elements
81     # replace ':' with '.'
82     # join list elements using '.'
83     only_alphanum = re.compile('[^a-zA-Z0-9:]+')
84     valid_chars = lambda x: only_alphanum.sub('', x).replace(':', '.')
85     hrn = '.'.join([valid_chars(part) for part in hrn_parts if part]) 
86     
87     return str(hrn), str(type) 
88     
89     
90 def hrn_to_urn(hrn, type=None):
91     """
92     convert an hrn and type to a urn string
93     """
94     # if  this is already a urn dont do anything 
95     if not hrn or hrn.startswith(URN_PREFIX):
96         return hrn
97
98     authority = get_authority(hrn)
99     name = get_leaf(hrn)
100      
101     if type == 'authority':
102         authority = hrn
103         name = 'sa'   
104     
105     if authority.startswith("plc"):
106         if type == None:
107             urn = "+".join(['',authority.replace('.',':'),name])
108         else:
109             urn = "+".join(['',authority.replace('.',':'),type,name])
110
111     else:
112         urn = "+".join(['',authority,type,name])
113         
114     return URN_PREFIX + urn