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     object_type = 'Site'
  30
  31     def call(self, auth, person_id_or_email, site_id_or_login_base):
  32         # Get account information
  33         persons = Persons(self.api, [person_id_or_email])
  34         if not persons:
  35             raise PLCInvalidArgument, "No such account"
  36         person = persons[0]
  37
  38         if person['peer_id'] is not None:
  39             raise PLCInvalidArgument, "Not a local account"
  40
  41         # Get site information
  42         sites = Sites(self.api, [site_id_or_login_base])
  43         if not sites:
  44             raise PLCInvalidArgument, "No such site"
  45         site = sites[0]
  46
  47         if site['peer_id'] is not None:
  48             raise PLCInvalidArgument, "Not a local site"
  49
  50         if site['site_id'] not in person['site_ids']:
  51             site.add_person(person)
  52
  53         # Logging variables
  54         self.object_ids = [site['site_id']]
  55         self.message = 'Person %d added to site %d' % \
  56                 (person['person_id'], site['site_id'])
  57         return 1