Merge from trunk
[plcapi.git] / trunk / PLC / Methods / AddPersonKey.py
diff --git a/trunk/PLC/Methods/AddPersonKey.py b/trunk/PLC/Methods/AddPersonKey.py
new file mode 100644 (file)
index 0000000..aa4ed00
--- /dev/null
@@ -0,0 +1,59 @@
+from PLC.Faults import *
+from PLC.Method import Method
+from PLC.Parameter import Parameter, Mixed
+from PLC.Keys import Key, Keys
+from PLC.Persons import Person, Persons
+from PLC.Auth import Auth
+
+can_update = lambda (field, value): field in ['key_type','key']
+
+class AddPersonKey(Method):
+    """
+    Adds a new key to the specified account.
+
+    Non-admins can only modify their own keys.
+
+    Returns the new key_id (> 0) if successful, faults otherwise.
+    """
+
+    roles = ['admin', 'pi', 'tech', 'user']
+
+    key_fields = dict(filter(can_update, Key.fields.items()))
+
+    accepts = [
+        Auth(),
+        Mixed(Person.fields['person_id'],
+              Person.fields['email']),
+        key_fields
+        ]
+
+    returns = Parameter(int, 'New key_id (> 0) if successful')
+
+    def call(self, auth, person_id_or_email, key_fields):
+        key_fields = dict(filter(can_update, key_fields.items()))
+
+        # Get account details
+        persons = Persons(self.api, [person_id_or_email])
+        if not persons:
+            raise PLCInvalidArgument, "No such account"
+        person = persons[0]
+
+        if person['peer_id'] is not None:
+            raise PLCInvalidArgument, "Not a local account"
+
+       # If we are not admin, make sure caller is adding a key to their account
+        if 'admin' not in self.caller['roles']:
+            if person['person_id'] != self.caller['person_id']:
+                raise PLCPermissionDenied, "You may only modify your own keys"
+
+        key = Key(self.api, key_fields)
+        key.sync(commit = False)
+        person.add_key(key, commit = True)
+
+        # Logging variables
+       self.event_objects = {'Person': [person['person_id']],
+                             'Key': [key['key_id']]}
+       self.message = 'Key %d added to person %d' % \
+               (key['key_id'], person['person_id'])
+
+        return key['key_id']