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