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