PLC/Methods/AddPersonToSite.py

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