force import of AuthorizeHelpers
[plcapi.git] / PLC / Methods / UpdatePersonTag.py
1 #
2 # Thierry Parmentelat - INRIA
3 #
4 from PLC.Faults import *
5 from PLC.Method import Method
6 from PLC.Parameter import Parameter, Mixed
7 from PLC.Auth import Auth
8
9 from PLC.PersonTags import PersonTag, PersonTags
10 from PLC.Persons import Person, Persons
11
12 # need to import so the core classes get decorated with caller_may_write_tag
13 from PLC.AuthorizeHelpers import AuthorizeHelpers
14
15 class UpdatePersonTag(Method):
16     """
17     Updates the value of an existing person setting
18
19     Admins have full access.  Non-admins can change their own tags.
20
21     Returns 1 if successful, faults otherwise.
22     """
23
24     roles = ['admin', 'pi', 'tech', 'user']
25
26     accepts = [
27         Auth(),
28         PersonTag.fields['person_tag_id'],
29         PersonTag.fields['value']
30         ]
31
32     returns = Parameter(int, '1 if successful')
33
34     def call(self, auth, person_tag_id, value):
35         person_tags = PersonTags(self.api, [person_tag_id])
36         if not person_tags:
37             raise PLCInvalidArgument, "No such person setting %r"%person_tag_id
38         person_tag = person_tags[0]
39
40         persons = Persons (self.api, person_tag['person_id'])
41         if not persons:
42             raise PLCInvalidArgument, "No such person %d"%person_tag['person_id']
43         person=persons[0]
44
45         # check authorizations
46         person.caller_may_write_tag(self.api,self.caller,tag_type)
47
48         person_tag['value'] = value
49         person_tag.sync()
50
51         self.object_ids = [person_tag['person_tag_id']]
52         return 1