PLC/Methods/DeleteAddress.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 class DeleteAddress(Method):
   9     """
  10     Deletes an address.
  11
  12     PIs may only delete addresses from their own sites.
  13
  14     Returns 1 if successful, faults otherwise.
  15     """
  16
  17     roles = ['admin', 'pi']
  18
  19     accepts = [
  20         Auth(),
  21         Address.fields['address_id'],
  22         ]
  23
  24     returns = Parameter(int, '1 if successful')
  25
  26
  27     def call(self, auth, address_id):
  28         # Get associated address details
  29         addresses = Addresses(self.api, [address_id])
  30         if not addresses:
  31             raise PLCInvalidArgument, "No such address"
  32         address = addresses[0]
  33
  34         if 'admin' not in self.caller['roles']:
  35             if address['site_id'] not in self.caller['site_ids']:
  36                 raise PLCPermissionDenied, "Address must be associated with one of your sites"
  37
  38         address.delete()
  39
  40         # Logging variables
  41         self.event_objects = {'Address': [address['address_id']]}
  42         self.message = 'Address %d deleted' % address['address_id']
  43
  44         return 1