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