get rid of svn keywords once and for good
[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 related_fields = Site.related_fields.keys()
8 can_update = lambda (field, value): field in \
9              ['name', 'abbreviated_name', 'login_base',
10               'is_public', 'latitude', 'longitude', 'url',
11               'max_slices', 'max_slivers', 'enabled', 'ext_consortium_id'] + \
12               related_fields
13
14 class UpdateSite(Method):
15     """
16     Updates a site. Only the fields specified in update_fields are
17     updated, all other fields are left untouched.
18
19     PIs can only update sites they are a member of. Only admins can
20     update max_slices, max_slivers, and login_base.
21
22     Returns 1 if successful, faults otherwise.
23     """
24
25     roles = ['admin', 'pi']
26
27     site_fields = dict(filter(can_update, Site.fields.items() + Site.related_fields.items()))
28
29     accepts = [
30         Auth(),
31         Mixed(Site.fields['site_id'],
32               Site.fields['login_base']),
33         site_fields
34         ]
35
36     returns = Parameter(int, '1 if successful')
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                 if key in site_fields:
62                     del site_fields[key]
63
64         # Make requested associations
65         for field in related_fields:
66             if field in site_fields:
67                 site.associate(auth, field, site_fields[field])
68                 site_fields.pop(field)
69
70         site.update(site_fields)
71         site.update_last_updated(False)
72         site.sync()
73
74         # Logging variables
75         self.event_objects = {'Site': [site['site_id']]}
76         self.message = 'Site %d updated: %s' % \
77                 (site['site_id'], ", ".join(site_fields.keys()))
78
79         return 1