PLC/Methods/GetSites.py

   1 import os
   2
   3 from PLC.Method import Method
   4 from PLC.Parameter import Parameter, Mixed
   5 from PLC.Auth import PasswordAuth
   6 from PLC.Sites import Site, Sites
   7
   8 class GetSites(Method):
   9     """
  10     Return an array of structs containing details about all sites. If
  11     site_id_list is specified, only the specified sites will be
  12     queried.
  13
  14     If return_fields is specified, only the specified fields will be
  15     returned, if set. Otherwise, the default set of fields returned is:
  16
  17     """
  18
  19     roles = ['admin', 'pi', 'user', 'tech']
  20
  21     accepts = [
  22         PasswordAuth(),
  23         [Mixed(Site.fields['site_id'],
  24                Site.fields['login_base'])],
  25         Parameter([str], 'List of fields to return')
  26         ]
  27
  28     returns = [Site.fields]
  29
  30     def __init__(self, *args, **kwds):
  31         Method.__init__(self, *args, **kwds)
  32         # Update documentation with list of default fields returned
  33         self.__doc__ += os.linesep.join(Site.fields.keys())
  34
  35     def call(self, auth, site_id_or_login_base_list = None, return_fields = None):
  36         # Make sure that only valid fields are specified
  37         if return_fields is None:
  38             return_fields = Site.fields
  39         elif filter(lambda field: field not in Site.fields, return_fields):
  40             raise PLCInvalidArgument, "Invalid return field specified"
  41
  42         # Get site information
  43         sites = Sites(self.api, site_id_or_login_base_list)
  44
  45         # Filter out undesired or None fields (XML-RPC cannot marshal
  46         # None) and turn each site into a real dict.
  47         valid_return_fields_only = lambda (key, value): \
  48                                    key in return_fields and value is not None
  49         sites = [dict(filter(valid_return_fields_only, site.items())) \
  50                  for site in sites.values()]
  51
  52         return sites