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.Sites import Site, Sites
   7 from PLC.Auth import Auth
   8
   9 hidden_fields = ['password', 'verification_key', 'verification_expires']
  10
  11 class GetPersons(Method):
  12     """
  13     Returns an array of structs containing details about users. If
  14     person_filter is specified and is an array of user identifiers or
  15     usernames, or a struct of user attributes, only users matching the
  16     filter will be returned. If return_fields is specified, only the
  17     specified details will be returned.
  18
  19     Users and techs may only retrieve details about themselves. PIs
  20     may retrieve details about themselves and others at their
  21     sites. Admins and nodes may retrieve details about all accounts.
  22     """
  23
  24     roles = ['admin', 'pi', 'user', 'tech', 'node']
  25
  26     accepts = [
  27         Auth(),
  28         Mixed([Mixed(Person.fields['person_id'],
  29                      Person.fields['email'])],
  30               Parameter(str,"email"),
  31               Parameter(int,"person_id"),
  32               Filter(Person.fields)),
  33         Parameter([str], "List of fields to return", nullok = True)
  34         ]
  35
  36     # Filter out password field
  37     return_fields = dict(filter(lambda (field, value): field not in hidden_fields,
  38                                 Person.fields.items()))
  39     returns = [return_fields]
  40
  41     def call(self, auth, person_filter = None, return_fields = None):
  42         # If we are not admin, make sure to only return viewable accounts
  43         if isinstance(self.caller, Person) and \
  44            'admin' not in self.caller['roles']:
  45             # Get accounts that we are able to view
  46             valid_person_ids = [self.caller['person_id']]
  47             if 'pi' in self.caller['roles'] and self.caller['site_ids']:
  48                 sites = Sites(self.api, self.caller['site_ids'])
  49                 for site in sites:
  50                     valid_person_ids += site['person_ids']
  51
  52             if not valid_person_ids:
  53                 return []
  54
  55             if person_filter is None:
  56                 person_filter = valid_person_ids
  57
  58         # Filter out password field
  59         if return_fields:
  60             return_fields = filter(lambda field: field not in hidden_fields,
  61                                    return_fields)
  62         else:
  63             return_fields = self.return_fields.keys()
  64
  65         # Must query at least person_id, site_ids, and role_ids (see
  66         # Person.can_view() and below).
  67         if return_fields is not None:
  68             added_fields = set(['person_id', 'site_ids', 'role_ids']).difference(return_fields)
  69             return_fields += added_fields
  70         else:
  71             added_fields = []
  72
  73         persons = Persons(self.api, person_filter, return_fields)
  74
  75         # Filter out accounts that are not viewable
  76         if isinstance(self.caller, Person) and \
  77            'admin' not in self.caller['roles']:
  78             persons = filter(self.caller.can_view, persons)
  79
  80         # Remove added fields if not specified
  81         if added_fields:
  82             for person in persons:
  83                 for field in added_fields:
  84                     del person[field]
  85
  86         return persons