Merge from trunk

[plcapi.git] / trunk / PLC / Methods / AddSiteAddress.py

diff --git a/trunk/PLC/Methods/AddSiteAddress.py b/trunk/PLC/Methods/AddSiteAddress.py
new file mode 100644 (file)
index 0000000..a3a4eff
--- /dev/null
+++ b/trunk/PLC/Methods/AddSiteAddress.py
@@ -0,0 +1,58 @@
+from PLC.Faults import *
+from PLC.Method import Method
+from PLC.Parameter import Parameter, Mixed
+from PLC.Addresses import Address, Addresses
+from PLC.Auth import Auth
+from PLC.Sites import Site, Sites
+
+can_update = lambda (field, value): field in \
+             ['line1', 'line2', 'line3',
+              'city', 'state', 'postalcode', 'country']
+
+class AddSiteAddress(Method):
+    """
+    Adds a new address to a site. Fields specified in
+    address_fields are used; some are not optional.
+
+    PIs may only add addresses to their own sites.
+
+    Returns the new address_id (> 0) if successful, faults otherwise.
+    """
+
+    roles = ['admin', 'pi']
+
+    address_fields = dict(filter(can_update, Address.fields.items()))
+
+    accepts = [
+        Auth(),
+        Mixed(Site.fields['site_id'],
+              Site.fields['login_base']),
+        address_fields
+        ]
+
+    returns = Parameter(int, 'New address_id (> 0) if successful')
+
+    def call(self, auth, site_id_or_login_base, address_fields):
+        address_fields = dict(filter(can_update, address_fields.items()))
+
+        # Get associated site details
+        sites = Sites(self.api, [site_id_or_login_base])
+        if not sites:
+            raise PLCInvalidArgument, "No such site"
+        site = sites[0]
+
+        if 'admin' not in self.caller['roles']:
+            if site['site_id'] not in self.caller['site_ids']:
+                raise PLCPermissionDenied, "Address must be associated with one of your sites"
+
+        address = Address(self.api, address_fields)
+        address.sync(commit = False)
+        site.add_address(address, commit = True)
+
+       # Logging variables
+       self.event_objects = {'Site': [site['site_id']], 
+                             'Address': [address['address_id']]}
+       self.message = 'Address %d assigned to Site %d' % \
+               (address['address_id'], site['site_id'])
+
+        return address['address_id']