- added logging variable 'object_type'
[plcapi.git] / PLC / Methods / UpdateSite.py
1 from PLC.Faults import *
2 from PLC.Method import Method
3 from PLC.Parameter import Parameter, Mixed
4 from PLC.Sites import Site, Sites
5 from PLC.Auth import Auth
6
7 can_update = lambda (field, value): field in \
8              ['name', 'abbreviated_name', 'login_base',
9               'is_public', 'latitude', 'longitude', 'url',
10               'max_slices', 'max_slivers']
11
12 class UpdateSite(Method):
13     """
14     Updates a site. Only the fields specified in update_fields are
15     updated, all other fields are left untouched.
16
17     PIs can only update sites they are a member of. Only admins can 
18     update max_slices, max_slivers, and login_base.
19
20     Returns 1 if successful, faults otherwise.
21     """
22
23     roles = ['admin', 'pi']
24
25     site_fields = dict(filter(can_update, Site.fields.items()))
26
27     accepts = [
28         Auth(),
29         Mixed(Site.fields['site_id'],
30               Site.fields['login_base']),
31         site_fields
32         ]
33
34     returns = Parameter(int, '1 if successful')
35
36     object_type = 'Site'
37
38     def call(self, auth, site_id_or_login_base, site_fields):
39         site_fields = dict(filter(can_update, site_fields.items()))
40
41         # Get site information
42         sites = Sites(self.api, [site_id_or_login_base])
43         if not sites:
44             raise PLCInvalidArgument, "No such site"
45         site = sites[0]
46
47         if site['peer_id'] is not None:
48             raise PLCInvalidArgument, "Not a local site"
49
50         # Authenticated function
51         assert self.caller is not None
52
53         # If we are not an admin, make sure that the caller is a
54         # member of the site.
55         if 'admin' not in self.caller['roles']:
56             if site['site_id'] not in self.caller['site_ids']:
57                 raise PLCPermissionDenied, "Not allowed to modify specified site"
58
59             # Remove admin only fields
60             for key in 'max_slices', 'max_slivers', 'login_base':
61                 del site_fields[key]
62
63         site.update(site_fields)
64         site.sync()
65         
66         # Logging variables
67         self.object_ids = [site['site_id']]
68         self.message = 'Site %d updated: %s' % \
69                 (site['site_id'], ", ".join(site_fields.keys()))        
70         
71         return 1