Tagging module PLCAPI - PLCAPI-5.0-1
[plcapi.git] / PLC / Methods / AddPersonToSite.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.Sites import Site, Sites
6 from PLC.Auth import Auth
7
8 class AddPersonToSite(Method):
9     """
10     Adds the specified person to the specified site. If the person is
11     already a member of the site, no errors are returned. Does not
12     change the person's primary site.
13
14     Returns 1 if successful, faults otherwise.
15     """
16
17     roles = ['admin']
18
19     accepts = [
20         Auth(),
21         Mixed(Person.fields['person_id'],
22               Person.fields['email']),
23         Mixed(Site.fields['site_id'],
24               Site.fields['login_base'])
25         ]
26
27     returns = Parameter(int, '1 if successful')
28
29     def call(self, auth, person_id_or_email, site_id_or_login_base):
30         # Get account information
31         persons = Persons(self.api, [person_id_or_email])
32         if not persons:
33             raise PLCInvalidArgument, "No such account"
34         person = persons[0]
35
36         if person['peer_id'] is not None:
37             raise PLCInvalidArgument, "Not a local account"
38
39         # Get site information
40         sites = Sites(self.api, [site_id_or_login_base])
41         if not sites:
42             raise PLCInvalidArgument, "No such site"
43         site = sites[0]
44
45         if site['peer_id'] is not None:
46             raise PLCInvalidArgument, "Not a local site"
47
48         if site['site_id'] not in person['site_ids']:
49             site.add_person(person)
50
51         # Logging variables
52         self.event_objects = {'Site': [site['site_id']],
53                               'Person': [person['person_id']]}
54         self.message = 'Person %d added to site %d' % \
55                 (person['person_id'], site['site_id'])
56         return 1