PLC/Methods/UpdateAddress.py

   1 # $Id$
   2 from PLC.Faults import *
   3 from PLC.Method import Method
   4 from PLC.Parameter import Parameter, Mixed
   5 from PLC.Addresses import Address, Addresses
   6 from PLC.Auth import Auth
   7
   8 can_update = lambda (field, value): field in \
   9              ['line1', 'line2', 'line3',
  10               'city', 'state', 'postalcode', 'country']
  11
  12 class UpdateAddress(Method):
  13     """
  14     Updates the parameters of an existing address with the values in
  15     address_fields.
  16
  17     PIs may only update addresses of their own sites.
  18
  19     Returns 1 if successful, faults otherwise.
  20     """
  21
  22     roles = ['admin', 'pi']
  23
  24     address_fields = dict(filter(can_update, Address.fields.items()))
  25
  26     accepts = [
  27         Auth(),
  28         Address.fields['address_id'],
  29         address_fields
  30         ]
  31
  32     returns = Parameter(int, '1 if successful')
  33
  34     def call(self, auth, address_id, address_fields):
  35         address_fields = dict(filter(can_update, address_fields.items()))
  36
  37         # Get associated address details
  38         addresses = Addresses(self.api, [address_id])
  39         if not addresses:
  40             raise PLCInvalidArgument, "No such address"
  41         address = addresses[0]
  42
  43         if 'admin' not in self.caller['roles']:
  44             if address['site_id'] not in self.caller['site_ids']:
  45                 raise PLCPermissionDenied, "Address must be associated with one of your sites"
  46
  47         address.update(address_fields)
  48         address.sync()
  49
  50         # Logging variables
  51         self.event_objects = {'Address': [address['address_id']]}
  52         self.message = 'Address %d updated: %s' % \
  53                 (address['address_id'], ", ".join(address_fields.keys()))
  54
  55         return 1