- implement AddressType and Address manipulation
[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 PasswordAuth
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         PasswordAuth(),
20         Address.fields['address_id'],
21         ]
22
23     returns = Parameter(int, '1 if successful')
24
25     def call(self, auth, address_id):
26         # Get associated address details
27         addresses = Addresses(self.api, [address_id]).values()
28         if not addresses:
29             raise PLCInvalidArgument, "No such address"
30         address = addresses[0]
31
32         if 'admin' not in self.caller['roles']:
33             if address['site_id'] not in self.caller['site_ids']:
34                 raise PLCPermissionDenied, "Address must be associated with one of your sites"
35
36         address.delete()
37
38         return 1