providing url field while adding slice
[sfa.git] / geni / util / api.py
index 14008da..6bc82a6 100644 (file)
@@ -12,6 +12,9 @@ from geni.util.auth import Auth
 from geni.util.config import *
 from geni.util.faults import *
 from geni.util.debug import *
+from geni.util.rights import *
+from geni.util.credential import *
+from geni.util.misc import *
 
 # See "2.2 Characters" in the XML specification:
 #
@@ -80,7 +83,6 @@ try:
 except ImportError:
     SOAPpy = None
 
-import geni.methods
 
 def import_deep(name):
     mod = __import__(name)
@@ -92,9 +94,10 @@ def import_deep(name):
 class GeniAPI:
 
     # flat list of method names
-    methods = geni.methods.methods
+    import geni.methods
+    methods = geni.methods.all
     
-    def __init__(self, config = "/usr/share/geniwrapper/geni/util/geni_config", encoding = "utf-8", peer_cert = None, interface = None):
+    def __init__(self, config = "/etc/geni/geni_config", encoding = "utf-8", peer_cert = None, interface = None, key_file = None, cert_file = None):
         self.encoding = encoding
 
         # Better just be documenting the API
@@ -105,16 +108,21 @@ class GeniAPI:
         self.config = Config(config)
         self.auth = Auth(peer_cert)
         self.interface = interface
+        self.key_file = key_file
+        self.cert_file = cert_file
+        self.credential = None
         self.plshell = self.getPLCShell()
+        self.plshell_version = self.getPLCShellVersion()
         self.basedir = self.config.GENI_BASE_DIR + os.sep
         self.server_basedir = self.basedir + os.sep + "geni" + os.sep
         self.hrn = self.config.GENI_INTERFACE_HRN
+        self.time_format = "%Y-%m-%d %H:%M:%S"
 
 
     def getPLCShell(self):
         self.plauth = {'Username': self.config.GENI_PLC_USER,
-                         'AuthMethod': 'password',
-                         'AuthString': self.config.GENI_PLC_PASSWORD} 
+                       'AuthMethod': 'password',
+                       'AuthString': self.config.GENI_PLC_PASSWORD}
         try:
             import PLC.Shell
             shell = PLC.Shell.Shell(globals = globals())
@@ -125,56 +133,227 @@ class GeniAPI:
             plc_host = self.config.GENI_PLC_HOST
             plc_port = self.config.GENI_PLC_PORT
             plc_api_path = self.config.GENI_PLC_API_PATH
-            url = "https://%(plc_host)s:%(plc_port)s/%(plc_api_path)s/" % \
-                   locals()
+            url = "https://%(plc_host)s:%(plc_port)s/%(plc_api_path)s/" % locals()
              
             shell = xmlrpclib.Server(url, verbose = 0, allow_none = True)
             shell.AuthCheck(self.plauth)
-            return shell         
+            return shell
+
+    def getPLCShellVersion(self):
+        # We need to figure out what version of PLCAPI we are talking to.
+        # Some calls we need to make later will be different depending on
+        # the api version. 
+        try:
+            # This is probably a bad way to determine api versions
+            # but its easy and will work for now. Lets try to make 
+            # a call that only exists is PLCAPI.4.3. If it fails, we
+            # can assume the api version is 4.2
+            self.plshell.GetTagTypes(self.plauth)
+            return '4.3'
+        except:
+            return '4.2'
+            
+
+    def getCredential(self):
+        if self.interface in ['registry']:
+            return self.getCredentialFromLocalRegistry()
+        else:
+            return self.getCredentialFromRegistry()
+    
+
+    def getCredentialFromRegistry(self):
+        """ 
+        Get our credential from a remote registry using a geniclient connection
+        """
+        type = 'authority'
+        path = self.config.basepath
+        filename = ".".join([self.interface, self.hrn, type, "cred"])
+        cred_filename = path + os.sep + filename
+        try:
+            credential = Credential(filename = cred_filename)
+            return credential
+        except IOError:
+            from geni.registry import Registries
+            registries = Registries(self)
+            registry = registries[self.hrn]
+            self_cred = registry.get_credential(None, type, self.hrn)
+            cred = registry.get_credential(self_cred, type, self.hrn)
+            cred.save_to_file(cred_filename, save_parents=True)
+            return cred
+
+    def getCredentialFromLocalRegistry(self):
+        """
+        Get our current credential directly from the local registry.
+        """
+
+        hrn = self.hrn
+        auth_hrn = self.auth.get_authority(hrn)
+        if not auth_hrn:
+            auth_hrn = hrn
+        auth_info = self.auth.get_auth_info(auth_hrn)
+        table = self.auth.get_auth_table(auth_hrn)
+        records = table.resolve('*', hrn)
+        if not records:
+            raise RecordNotFound
+        record = records[0]
+        type = record.get_type()
+        object_gid = record.get_gid_object()
+        new_cred = Credential(subject = object_gid.get_subject())
+        new_cred.set_gid_caller(object_gid)
+        new_cred.set_gid_object(object_gid)
+        new_cred.set_issuer(key=auth_info.get_pkey_object(), subject=auth_hrn)
+        new_cred.set_pubkey(object_gid.get_pubkey())
+        r1 = determine_rights(type, hrn)
+        new_cred.set_privileges(r1)
+
+        auth_kind = "authority,ma,sa"
+
+        new_cred.set_parent(self.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
+
+        new_cred.encode()
+        new_cred.sign()
+
+        return new_cred
    
+
+    def loadCredential(self):
+        """
+        Attempt to load credential from file if it exists. If it doesnt get
+        credential from registry.
+        """
+
+        # see if this file exists
+        # XX This is really the aggregate's credential. Using this is easier than getting
+        # the registry's credential from iteslf (ssl errors).   
+        ma_cred_filename = self.server_basedir + os.sep + self.interface + self.hrn + ".ma.cred"
+        try:
+            self.credential = Credential(filename = ma_cred_filename)
+        except IOError:
+            self.credential = self.getCredentialFromRegistry()
+
+    ##
+    # Convert geni fields to PLC fields for use when registering up updating
+    # registry record in the PLC database
+    #
+    # @param type type of record (user, slice, ...)
+    # @param hrn human readable name
+    # @param geni_fields dictionary of geni fields
+    # @param pl_fields dictionary of PLC fields (output)
+
+    def geni_fields_to_pl_fields(self, type, hrn, record):
+
+        def convert_ints(tmpdict, int_fields):
+            for field in int_fields:
+                if field in tmpdict:
+                    tmpdict[field] = int(tmpdict[field])
+
+        pl_record = {}
+        #for field in record:
+        #    pl_record[field] = record[field]
+        if type == "slice":
+            if not "instantiation" in pl_record:
+                pl_record["instantiation"] = "plc-instantiated"
+            pl_record["name"] = hrn_to_pl_slicename(hrn)
+           if "url" in record:
+               pl_record["url"] = record["url"]
+
+        elif type == "node":
+            if not "hostname" in pl_record:
+                if not "dns" in record:
+                    raise MissingGeniInfo("dns")
+                pl_record["hostname"] = record["dns"]
+            if not "model" in pl_record:
+                pl_record["model"] = "geni"
+
+        elif type == "authority":
+            pl_record["login_base"] = hrn_to_pl_login_base(hrn)
+
+            if not "name" in pl_record:
+                pl_record["name"] = hrn
+
+            if not "abbreviated_name" in pl_record:
+                pl_record["abbreviated_name"] = hrn
+
+            if not "enabled" in pl_record:
+                pl_record["enabled"] = True
+
+            if not "is_public" in pl_record:
+                pl_record["is_public"] = True
+
+        return pl_record
+
     def fill_record_pl_info(self, record):
         """
         Fill in the planetlab specific fields of a Geni record. This
-        involves calling the appropraite PLC method to retrie the 
-        dtabase record for the object.
+        involves calling the appropriate PLC method to retrieve the 
+        database record for the object.
         
-        PLC data is filled into the pl_fino field of the record.
+        PLC data is filled into the pl_info field of the record.
     
-        @param record record to fill in field (in/out param)     
+        @param record: record to fill in field (in/out param)     
         """
         type = record.get_type()
         pointer = record.get_pointer()
-
+        auth_hrn = self.hrn
+        login_base = ''
         # records with pointer==-1 do not have plc info associated with them.
         # for example, the top level authority records which are
         # authorities, but not PL "sites"
         if pointer == -1:
-            record.set_pl_info({})
+            record.update({})
             return
 
-        if (type == "sa") or (type == "ma"):
+        if (type in ["authority", "sa", "ma"]):
             pl_res = self.plshell.GetSites(self.plauth, [pointer])
         elif (type == "slice"):
             pl_res = self.plshell.GetSlices(self.plauth, [pointer])
         elif (type == "user"):
             pl_res = self.plshell.GetPersons(self.plauth, [pointer])
-            key_ids = pl_res[0]['key_ids']
-            keys = self.plshell.GetKeys(self.plauth, key_ids)
-            pubkeys = []
-            if keys:
-                pubkeys = [key['key'] for key in keys]
-            pl_res[0]['keys'] = pubkeys
         elif (type == "node"):
             pl_res = self.plshell.GetNodes(self.plauth, [pointer])
         else:
             raise UnknownGeniType(type)
-
+        
         if not pl_res:
-            # the planetlab record no longer exists
-            # TODO: delete the geni record ?
             raise PlanetLabRecordDoesNotExist(record.get_name())
 
-        record.set_pl_info(pl_res[0])
+        # convert ids to hrns
+        pl_record = pl_res[0]
+        if 'site_id' in pl_record:
+            sites = self.plshell.GetSites(self.plauth, pl_record['site_id'], ['login_base'])
+            site = sites[0]
+            login_base = site['login_base']
+            pl_record['site'] = ".".join([auth_hrn, login_base])
+        if 'person_ids' in pl_record:
+            persons =  self.plshell.GetPersons(self.plauth, pl_record['person_ids'], ['email'])
+            emails = [person['email'] for person in persons]
+            usernames = [email.split('@')[0] for email in emails]
+            person_hrns = [".".join([auth_hrn, login_base, username]) for username in usernames]
+            pl_record['persons'] = person_hrns 
+        if 'slice_ids' in pl_record:
+            slices = self.plshell.GetSlices(self.plauth, pl_record['slice_ids'], ['name'])
+            slicenames = [slice['name'] for slice in slices]
+            slice_hrns = [slicename_to_hrn(auth_hrn, slicename) for slicename in slicenames]
+            pl_record['slices'] = slice_hrns
+        if 'node_ids' in pl_record:
+            nodes = self.plshell.GetNodes(self.plauth, pl_record['node_ids'], ['hostname'])
+            hostnames = [node['hostname'] for node in nodes]
+            node_hrns = [hostname_to_hrn(auth_hrn, login_base, hostname) for hostname in hostnames]
+            pl_record['nodes'] = node_hrns
+        if 'site_ids' in pl_record:
+            sites = self.plshell.GetSites(self.plauth, pl_record['site_ids'], ['login_base'])
+            login_bases = [site['login_base'] for site in sites]
+            site_hrns = [".".join([auth_hrn, lbase]) for lbase in login_bases]
+            pl_record['sites'] = site_hrns
+        if 'key_ids' in pl_record:
+            keys = self.plshell.GetKeys(self.plauth, pl_record['key_ids'])
+            pubkeys = []
+            if keys:
+                pubkeys = [key['key'] for key in keys]
+            pl_record['keys'] = pubkeys     
+
+        record.update(pl_record)
 
 
     def lookup_users(self, auth_table, user_id_list, role="*"):
@@ -183,8 +362,7 @@ class GeniAPI:
             user_records = auth_table.find("user", person_id, "pointer")
             for user_record in user_records:
                 self.fill_record_info(user_record)
-
-                user_roles = user_record.get_pl_info().get("roles")
+                user_roles = user_record.get("roles")
                 if (role=="*") or (role in user_roles):
                     record_list.append(user_record.get_name())
         return record_list
@@ -192,41 +370,32 @@ class GeniAPI:
     def fill_record_geni_info(self, record):
         geni_info = {}
         type = record.get_type()
-
         if (type == "slice"):
             auth_table = self.auth.get_auth_table(self.auth.get_authority(record.get_name()))
-            person_ids = record.pl_info.get("person_ids", [])
+            person_ids = record.get("person_ids", [])
             researchers = self.lookup_users(auth_table, person_ids)
             geni_info['researcher'] = researchers
 
-        elif (type == "sa"):
+        elif (type == "authority"):
             auth_table = self.auth.get_auth_table(record.get_name())
-            person_ids = record.pl_info.get("person_ids", [])
+            person_ids = record.get("person_ids", [])
             pis = self.lookup_users(auth_table, person_ids, "pi")
-            geni_info['pi'] = pis
-            # TODO: OrganizationName
-
-        elif (type == "ma"):
-            auth_table = self.auth.get_auth_table(record.get_name())
-            person_ids = record.pl_info.get("person_ids", [])
             operators = self.lookup_users(auth_table, person_ids, "tech")
-            geni_info['operator'] = operators
-            # TODO: OrganizationName
-
-            auth_table = self.auth.get_auth_table(record.get_name())
-            person_ids = record.pl_info.get("person_ids", [])
             owners = self.lookup_users(auth_table, person_ids, "admin")
+            geni_info['pi'] = pis
+            geni_info['operator'] = operators
             geni_info['owner'] = owners
+            # xxx TODO: OrganizationName
 
         elif (type == "node"):
-            geni_info['dns'] = record.pl_info.get("hostname", "")
-            # TODO: URI, LatLong, IP, DNS
+            geni_info['dns'] = record.get("hostname", "")
+            # xxx TODO: URI, LatLong, IP, DNS
     
         elif (type == "user"):
-            geni_info['email'] = record.pl_info.get("email", "")
-            # TODO: PostalAddress, Phone
+            geni_info['email'] = record.get("email", "")
+            # xxx TODO: PostalAddress, Phone
 
-        record.set_geni_info(geni_info)
+        record.update(geni_info)
 
     def fill_record_info(self, record):
         """
@@ -237,14 +406,12 @@ class GeniAPI:
         self.fill_record_geni_info(record)
 
     def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
-        # get a list of the HRNs tht are members of the old and new records^M
+        # get a list of the HRNs tht are members of the old and new records
         if oldRecord:
-            if oldRecord.pl_info == None:
-                oldRecord.pl_info = {}
-            oldList = oldRecord.get_geni_info().get(listName, [])
+            oldList = oldRecord.get(listName, [])
         else:
-            oldList = []
-        newList = record.get_geni_info().get(listName, [])
+            oldList = []     
+        newList = record.get(listName, [])
 
         # if the lists are the same, then we don't have to update anything
         if (oldList == newList):
@@ -254,13 +421,19 @@ class GeniAPI:
         # their pointer
         newIdList = []
         for hrn in newList:
-            userRecord = self.resolve_raw("user", hrn)[0]
-            newIdList.append(userRecord.get_pointer())
-
-        # build a list of the old person ids from the person_ids field of the
-        # pl_info
+            auth_hrn = self.auth.get_authority(hrn)
+            if not auth_hrn:
+                auth_hrn = hrn
+            auth_info = self.auth.get_auth_info(auth_hrn)
+            table = self.auth.get_auth_table(auth_hrn)
+            records = table.resolve('user', hrn)
+            if records:
+                userRecord = records[0]    
+                newIdList.append(userRecord.get_pointer())
+
+        # build a list of the old person ids from the person_ids field 
         if oldRecord:
-            oldIdList = oldRecord.plinfo.get("person_ids", [])
+            oldIdList = oldRecord.get("person_ids", [])
             containerId = oldRecord.get_pointer()
         else:
             # if oldRecord==None, then we are doing a Register, instead of an
@@ -285,13 +458,10 @@ class GeniAPI:
             self.update_membership_list(oldRecord, record, 'researcher',
                                         self.plshell.AddPersonToSlice,
                                         self.plshell.DeletePersonFromSlice)
-        elif record.type == "sa":
-            # TODO
+        elif record.type == "authority":
+            # xxx TODO
             pass
-        elif record.type == "ma":
-            # TODO
-            pass
+
 
     def callable(self, method):
         """
@@ -308,6 +478,7 @@ class GeniAPI:
             callablemethod = getattr(module, classname)(self)
             return getattr(module, classname)(self)
         except ImportError, AttributeError:
+            raise
             raise GeniInvalidAPIMethod, method
 
     def call(self, source, method, *args):