PLC/Methods/GetPCUs.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.Sites import Site, Sites
   6 from PLC.Persons import Person, Persons
   7 from PLC.Nodes import Node, Nodes
   8 from PLC.PCUs import PCU, PCUs
   9 from PLC.Auth import Auth
  10
  11 class GetPCUs(Method):
  12     """
  13     Returns an array of structs containing details about power control
  14     units (PCUs). If pcu_filter is specified and is an array of PCU
  15     identifiers, or a struct of PCU attributes, only PCUs matching the
  16     filter will be returned. If return_fields is specified, only the
  17     specified details will be returned.
  18
  19     Admin may query all PCUs. Non-admins may only query the PCUs at
  20     their sites.
  21     """
  22
  23     roles = ['admin', 'pi', 'tech', 'node']
  24
  25     accepts = [
  26         Auth(),
  27         Mixed([PCU.fields['pcu_id']],
  28               Filter(PCU.fields)),
  29         Parameter([str], "List of fields to return", nullok = True)
  30         ]
  31
  32     returns = [PCU.fields]
  33
  34     def call(self, auth, pcu_filter = None, return_fields = None):
  35         # If we are not admin
  36         if not (isinstance(self.caller, Person) and 'admin' in self.caller['roles']):
  37             # Return only the PCUs at our site
  38             valid_pcu_ids = []
  39
  40             if isinstance(self.caller, Person):
  41                 site_ids = self.caller['site_ids']
  42             elif isinstance(self.caller, Node):
  43                 site_ids = [self.caller['site_id']]
  44
  45             for site in Sites(self.api, site_ids):
  46                 valid_pcu_ids += site['pcu_ids']
  47
  48             if not valid_pcu_ids:
  49                 return []
  50
  51             if pcu_filter is None:
  52                 pcu_filter = valid_pcu_ids
  53
  54         pcus = PCUs(self.api, pcu_filter, return_fields)
  55
  56         # Filter out PCUs that are not viewable
  57         if not (isinstance(self.caller, Person) and 'admin' in self.caller['roles']):
  58             pcus = filter(lambda pcu: pcu['pcu_id'] in valid_pcu_ids, pcus)
  59
  60         return pcus