PLC/Methods/AddSiteAddress.py

   1 from PLC.Faults import *
   2 from PLC.Method import Method
   3 from PLC.Parameter import Parameter, Mixed
   4 from PLC.Addresses import Address, Addresses
   5 from PLC.Auth import Auth
   6 from PLC.Sites import Site, Sites
   7
   8 can_update = lambda (field, value): field in \
   9              ['line1', 'line2', 'line3',
  10               'city', 'state', 'postalcode', 'country']
  11
  12 class AddSiteAddress(Method):
  13     """
  14     Adds a new address to a site. Fields specified in
  15     address_fields are used; some are not optional.
  16
  17     PIs may only add addresses to their own sites.
  18
  19     Returns the new address_id (> 0) 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         Mixed(Site.fields['site_id'],
  29               Site.fields['login_base']),
  30         address_fields
  31         ]
  32
  33     returns = Parameter(int, 'New address_id (> 0) if successful')
  34
  35
  36     def call(self, auth, site_id_or_login_base, address_fields):
  37         address_fields = dict(filter(can_update, address_fields.items()))
  38
  39         # Get associated site details
  40         sites = Sites(self.api, [site_id_or_login_base])
  41         if not sites:
  42             raise PLCInvalidArgument, "No such site"
  43         site = sites[0]
  44
  45         if 'admin' not in self.caller['roles']:
  46             if site['site_id'] not in self.caller['site_ids']:
  47                 raise PLCPermissionDenied, "Address must be associated with one of your sites"
  48
  49         address = Address(self.api, address_fields)
  50         address.sync(commit = False)
  51         site.add_address(address, commit = True)
  52
  53         # Logging variables
  54         self.object_ids = [site['site_id'], address['address_id']]
  55         self.message = 'Address %d assigned to Site %d' % \
  56                 (address['address_id'], site['site_id'])
  57
  58         return address['address_id']