Merge from trunk

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

diff --git a/trunk/PLC/Methods/UpdatePerson.py b/trunk/PLC/Methods/UpdatePerson.py
new file mode 100644 (file)
index 0000000..8f74fc0
--- /dev/null
+++ b/trunk/PLC/Methods/UpdatePerson.py
@@ -0,0 +1,77 @@
+from PLC.Faults import *
+from PLC.Method import Method
+from PLC.Parameter import Parameter, Mixed
+from PLC.Persons import Person, Persons
+from PLC.Auth import Auth
+
+related_fields = Person.related_fields.keys()
+can_update = lambda (field, value): field in \
+             ['first_name', 'last_name', 'title', 'email',
+              'password', 'phone', 'url', 'bio', 'accepted_aup',
+              'enabled'] + related_fields
+
+class UpdatePerson(Method):
+    """
+    Updates a person. Only the fields specified in person_fields are
+    updated, all other fields are left untouched.
+    
+    Users and techs can only update themselves. PIs can only update
+    themselves and other non-PIs at their sites.
+
+    Returns 1 if successful, faults otherwise.
+    """
+
+    roles = ['admin', 'pi', 'user', 'tech']
+
+    person_fields = dict(filter(can_update, Person.fields.items() + Person.related_fields.items()))
+
+    accepts = [
+        Auth(),
+        Mixed(Person.fields['person_id'],
+              Person.fields['email']),
+        person_fields
+        ]
+
+    returns = Parameter(int, '1 if successful')
+
+    def call(self, auth, person_id_or_email, person_fields):
+        person_fields = dict(filter(can_update, person_fields.items()))
+
+        # Get account information
+        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"
+
+        # Authenticated function
+        assert self.caller is not None
+
+        # Check if we can update this account
+        if not self.caller.can_update(person):
+            raise PLCPermissionDenied, "Not allowed to update specified account"
+       
+       # Make requested associations
+        for field in related_fields:
+            if field in person_fields:
+                person.associate(auth, field, person_fields[field])
+                person_fields.pop(field)
+
+        person.update(person_fields)
+       person.update_last_updated(False)
+        person.sync()
+       
+       # Logging variables
+       self.event_objects = {'Person': [person['person_id']]}
+
+        # Redact password
+        if 'password' in person_fields:
+            person_fields['password'] = "Removed by API"
+        self.message = 'Person %d updated: %s.' % \
+                       (person['person_id'], person_fields.keys())
+       if 'enabled' in person_fields:
+            self.message += ' Person enabled'  
+
+        return 1