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