cosmetic
[sfa.git] / sfa / methods / remove.py
1 ### $Id$
2 ### $URL$
3
4 from sfa.util.faults import *
5 from sfa.util.method import Method
6 from sfa.util.parameter import Parameter, Mixed
7 from sfa.trust.auth import Auth
8 from sfa.util.record import GeniRecord
9 from sfa.util.genitable import GeniTable
10 from sfa.util.debug import log
11 from sfa.trust.credential import Credential
12 from sfa.server.registry import Registries
13
14 class remove(Method):
15     """
16     Remove an object from the registry. If the object represents a PLC object,
17     then the PLC records will also be removed.
18     
19     @param cred credential string
20     @param type record type
21     @param hrn human readable name of record to remove
22
23     @return 1 if successful, faults otherwise 
24     """
25
26     interfaces = ['registry']
27     
28     accepts = [
29         Parameter(str, "Credential string"),
30         Parameter(str, "Record type"),
31         Parameter(str, "Human readable name (hrn) of record to be removed"),
32         Mixed(Parameter(str, "Request hash"),
33               Parameter(None, "Request hash not specified"))
34         ]
35
36     returns = Parameter(int, "1 if successful")
37     
38     def call(self, cred, type, hrn, request_hash=None, origin_hrn=None):
39         # This cred will be an authority cred, not a user, so we cant use it to 
40         # authenticate the caller's request_hash. Let just get the caller's gid
41         # from the cred and authenticate using that
42         client_gid = Credential(string=cred).get_gid_caller()
43         client_gid_str = client_gid.save_to_string(save_parents=True)
44         self.api.auth.authenticateGid(client_gid_str, [cred, type, hrn], request_hash)
45         self.api.auth.check(cred, "remove")
46         self.api.auth.verify_object_permission(hrn)
47
48         if origin_hrn==None:
49             origin_hrn=Credential(string=cred).get_gid_caller().get_hrn()
50
51         #log the call
52         self.api.logger.info("interface: %s\tcaller-hrn: %s\ttarget-hrn: %s\tmethod-name: %s"%(self.api.interface, origin_hrn, hrn, self.name))
53         table = GeniTable()
54         filter = {'hrn': hrn}
55         if type not in ['all', '*']:
56             filter['type'] = type
57         records = table.find(filter)
58         if not records:
59             raise RecordNotFound(hrn)
60         record = records[0]
61         type = record['type']
62
63         credential = self.api.getCredential()
64         registries = Registries(self.api) 
65
66         # Try to remove the object from the PLCDB of federated agg.
67         # This is attempted before removing the object from the local agg's PLCDB and sfa table
68         if hrn.startswith(self.api.hrn) and type in ['user', 'slice', 'authority']:
69             for registry in registries:
70                 if registry not in [self.api.hrn]:
71                     try:
72                         request_hash=None
73                         result=registries[registry].remove_peer_object(credential, record, request_hash, origin_hrn)
74                     except:
75                         pass
76         if type == "user":
77             persons = self.api.plshell.GetPersons(self.api.plauth, record['pointer'])
78             # only delete this person if he has site ids. if he doesnt, it probably means 
79             # he was just removed from a site, not actually deleted
80             if persons and persons[0]['site_ids']:
81                 self.api.plshell.DeletePerson(self.api.plauth, record['pointer'])
82         elif type == "slice":
83             if self.api.plshell.GetSlices(self.api.plauth, record['pointer']):
84                 self.api.plshell.DeleteSlice(self.api.plauth, record['pointer'])
85         elif type == "node":
86             if self.api.plshell.GetNodes(self.api.plauth, record['pointer']):
87                 self.api.plshell.DeleteNode(self.api.plauth, record['pointer'])
88         elif type == "authority":
89             if self.api.plshell.GetSites(self.api.plauth, record['pointer']):
90                 self.api.plshell.DeleteSite(self.api.plauth, record['pointer'])
91         else:
92             raise UnknownGeniType(type)
93
94         table.remove(record)
95            
96         # forward the call after replacing the root hrn
97
98         return 1