- silently remove fields that can't be updated from person_fields, for
[plcapi.git] / PLC / Methods / AddPerson.py
1 from PLC.Faults import *
2 from PLC.Method import Method
3 from PLC.Parameter import Parameter, Mixed
4 from PLC.Persons import Person, Persons
5 from PLC.Auth import PasswordAuth
6
7 can_update = lambda (field, value): field in \
8              ['title', 'email', 'password', 'phone', 'url', 'bio']
9
10 class AddPerson(Method):
11     """
12     Adds a new account. Any fields specified in person_fields are
13     used, otherwise defaults are used.
14
15     Accounts are disabled by default. To enable an account, use
16     SetPersonEnabled() or UpdatePerson().
17
18     Returns the new person_id (> 0) if successful, faults otherwise.
19     """
20
21     roles = ['admin', 'pi']
22
23     update_fields = dict(filter(can_update, Person.fields.items()))
24
25     accepts = [
26         PasswordAuth(),
27         Person.fields['first_name'],
28         Person.fields['last_name'],
29         update_fields
30         ]
31
32     returns = Parameter(int, 'New person_id (> 0) if successful')
33
34     def call(self, auth, first_name, last_name, person_fields = {}):
35         person_fields = dict(filter(can_update, person_fields.items()))
36         person = Person(self.api, person_fields)
37         person['first_name'] = first_name
38         person['last_name'] = last_name
39         person['enabled'] = False
40         person.sync()
41
42         return person['person_id']