9e515e176400aa46ec17aa9b989acd8637d4eb4e
[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 from PLC.SiteTags import SiteTags
8 from PLC.Methods.UpdateSiteTag import UpdateSiteTag
9
10 related_fields = Site.related_fields.keys()
11 can_update = lambda (field, value): field in \
12              ['name', 'abbreviated_name', 'login_base',
13               'is_public', 'latitude', 'longitude', 'url',
14               'max_slices', 'max_slivers', 'enabled', 'ext_consortium_id'] + \
15               related_fields
16
17 class UpdateSite(Method):
18     """
19     Updates a site. Only the fields specified in update_fields are
20     updated, all other fields are left untouched.
21
22     PIs can only update sites they are a member of. Only admins can
23     update max_slices, max_slivers, and login_base.
24
25     Returns 1 if successful, faults otherwise.
26     """
27
28     roles = ['admin', 'pi']
29
30     site_fields = dict(filter(can_update, Site.fields.items() + Site.related_fields.items()))
31
32     accepts = [
33         Auth(),
34         Mixed(Site.fields['site_id'],
35               Site.fields['login_base']),
36         site_fields
37         ]
38
39     returns = Parameter(int, '1 if successful')
40
41     def call(self, auth, site_id_or_login_base, site_fields):
42         site_fields = dict(filter(can_update, site_fields.items()))
43
44         # Get site information
45         sites = Sites(self.api, [site_id_or_login_base])
46         if not sites:
47             raise PLCInvalidArgument, "No such site"
48         site = sites[0]
49
50         if site['peer_id'] is not None:
51             raise PLCInvalidArgument, "Not a local site"
52
53         # Authenticated function
54         assert self.caller is not None
55
56         # If we are not an admin, make sure that the caller is a
57         # member of the site.
58         if 'admin' not in self.caller['roles']:
59             if site['site_id'] not in self.caller['site_ids']:
60                 raise PLCPermissionDenied, "Not allowed to modify specified site"
61
62             # Remove admin only fields
63             for key in 'max_slices', 'max_slivers', 'login_base':
64                 if key in site_fields:
65                     del site_fields[key]
66
67         # Make requested associations
68         for field in related_fields:
69             if field in site_fields:
70                 site.associate(auth, field, site_fields[field])
71                 site_fields.pop(field)
72
73         site.update(site_fields)
74         site.update_last_updated(False)
75         site.sync()
76
77         # Logging variables
78         self.event_objects = {'Site': [site['site_id']]}
79         self.message = 'Site %d updated: %s' % \
80                 (site['site_id'], ", ".join(site_fields.keys()))
81
82         # Update Site HRN if login_base changed
83         if 'login_base' in site_fields:
84             root_auth = self.api.config.PLC_HRN_ROOT
85             tagname = 'hrn'
86             tagvalue = '.'.join([root_auth, site['login_base']])
87             site_tags=SiteTags(self.api,{'tagname':tagname,'site_id':site['site_id']})
88             UpdateSiteTag(self.api).__call__(auth,site_tags[0]['site_tag_id'],tagvalue)
89
90         return 1