PLC/Methods/GetPersons.py

   1 from PLC.Faults import *
   2 from PLC.Method import Method
   3 from PLC.Parameter import Parameter, Mixed
   4 from PLC.Filter import Filter
   5 from PLC.Persons import Person, Persons
   6 from PLC.Auth import Auth
   7
   8 class GetPersons(Method):
   9     """
  10     Returns an array of structs containing details about users. If
  11     person_filter is specified and is an array of user identifiers or
  12     usernames, or a struct of user attributes, only users matching the
  13     filter will be returned. If return_fields is specified, only the
  14     specified details will be returned.
  15
  16     Users and techs may only retrieve details about themselves. PIs
  17     may retrieve details about themselves and others at their
  18     sites. Admins may retrieve details about all accounts.
  19     """
  20
  21     roles = ['admin', 'pi', 'user', 'tech']
  22
  23     accepts = [
  24         Auth(),
  25         Mixed([Mixed(Person.fields['person_id'],
  26                      Person.fields['email'])],
  27               Filter(Person.fields)),
  28         Parameter([str], "List of fields to return", nullok = True)
  29         ]
  30
  31     # Filter out password field
  32     can_return = lambda (field, value): field not in ['password']
  33     return_fields = dict(filter(can_return, Person.fields.items()))
  34     returns = [return_fields]
  35
  36
  37     def call(self, auth, person_filter = None, return_fields = None):
  38
  39         # If we are not admin, make sure to only return viewable accounts
  40         if 'admin' not in self.caller['roles']:
  41             # Get accounts that we are able to view
  42             valid_person_ids = [self.caller['person_id']]
  43             if 'pi' in self.caller['roles'] and self.caller['site_ids']:
  44                 sites = Sites(self.api, self.caller['site_ids'])
  45                 for site in sites:
  46                     valid_person_ids += site['person_ids']
  47
  48             if not valid_person_ids:
  49                 return []
  50
  51             if person_filter is None:
  52                 person_filter = valid_person_ids
  53
  54         # Filter out password field
  55         if return_fields:
  56             while 'password' in return_fields:
  57                 return_fields.remove('password')
  58
  59         persons = Persons(self.api, person_filter, return_fields)
  60
  61         # Filter out accounts that are not viewable
  62         if 'admin' not in self.caller['roles']:
  63             persons = filter(self.caller.can_view, persons)
  64
  65         return persons