PLC/Methods/GetPeerData.py

   1 #
   2 # Thierry Parmentelat - INRIA
   3 #
   4
   5 import time
   6
   7 from PLC.Faults import *
   8 from PLC.Method import Method
   9 from PLC.Parameter import Parameter, Mixed
  10 from PLC.Auth import Auth
  11
  12 from PLC.Peers import Peer, Peers
  13
  14 from PLC.Sites import Site, Sites
  15 from PLC.Keys import Key, Keys
  16 from PLC.Nodes import Node, Nodes
  17 from PLC.Persons import Person, Persons
  18 from PLC.Slices import Slice, Slices
  19 from PLC.SliceTags import SliceTags
  20
  21 class GetPeerData(Method):
  22     """
  23     Returns lists of local objects that a peer should cache in its
  24     database as foreign objects. Also returns the list of foreign
  25     nodes in this database, for which the calling peer is
  26     authoritative, to assist in synchronization of slivers.
  27
  28     See the implementation of RefreshPeer for how this data is used.
  29     """
  30
  31     roles = ['admin', 'peer']
  32
  33     accepts = [Auth()]
  34
  35     returns = {
  36         'Sites': Parameter([dict], "List of local sites"),
  37         'Keys': Parameter([dict], "List of local keys"),
  38         'Nodes': Parameter([dict], "List of local nodes"),
  39         'Persons': Parameter([dict], "List of local users"),
  40         'Slices': Parameter([dict], "List of local slices"),
  41         'db_time': Parameter(float, "(Debug) Database fetch time"),
  42         }
  43
  44     def call (self, auth):
  45         start = time.time()
  46
  47         # Filter out various secrets
  48         node_fields = [ field for field in Node.fields if field \
  49                             not in ['boot_nonce', 'key', 'session', 'root_person_ids']]
  50         try:
  51             node_fields += ['hrn']
  52             nodes = Nodes(self.api, {'peer_id': None}, node_fields)
  53         except:
  54             nodes = Nodes(self.api, {'peer_id': None}, node_fields)
  55         # filter out whitelisted nodes
  56         nodes = [ n for n in nodes if not n['slice_ids_whitelist']]
  57
  58
  59         person_fields = [ field for field in Person.fields if field \
  60                               not in ['password', 'verification_key', 'verification_expires']]
  61
  62         site_fields = Site.fields
  63         slice_fields = Slice.fields
  64         try:
  65             person_fields += ['sfa_created','hrn']
  66             site_fields += ['sfa_created','hrn']
  67             slice_fields +=['sfa_created','hrn']
  68
  69             # XXX Optimize to return only those Persons, Keys, and Slices
  70             # necessary for slice creation on the calling peer's nodes.
  71
  72             # filter out special person
  73
  74             persons = Persons(self.api, {'~email':[self.api.config.PLC_API_MAINTENANCE_USER, self.api.config.PLC_ROOT_USER], 'peer_id': None}, person_fields)
  75
  76             # filter out system slices
  77             system_slice_ids = SliceTags(self.api, {'name': 'system', 'value': '1'}).dict('slice_id')
  78             slices = Slices(self.api, {'peer_id': None,'~slice_id':system_slice_ids.keys()}, slice_fields)
  79
  80             sites = Sites(self.api, {'peer_id': None}, site_fields)
  81
  82             # filter out objects with  sfa_created=True
  83             filtered_sites = [site for site in sites if site.get('sfa_created', None) != 'True']
  84             filtered_slices = [slice for slice in slices if slice.get('sfa_created', None) != 'True']
  85             filtered_persons = [person for person in persons if person.get('sfa_created', None) != 'True']
  86
  87         except:
  88             # handle peers with old version of MyPLC that does not support 'sfa_created' and 'hrn' fields for Site/Slice/Person
  89
  90             # XXX Optimize to return only those Persons, Keys, and Slices
  91             # necessary for slice creation on the calling peer's nodes.
  92
  93             # filter out special person
  94
  95             filtered_persons = Persons(self.api, {'~email':[self.api.config.PLC_API_MAINTENANCE_USER, self.api.config.PLC_ROOT_USER], 'peer_id': None}, person_fields)
  96
  97             # filter out system slices
  98             system_slice_ids = SliceTags(self.api, {'name': 'system', 'value': '1'}).dict('slice_id')
  99             filtered_slices = Slices(self.api, {'peer_id': None,
 100                                    '~slice_id':system_slice_ids.keys()}, slice_fields)
 101
 102             filtered_sites = Sites(self.api, {'peer_id': None}, site_fields)
 103
 104
 105         result = {
 106             'Sites': filtered_sites,
 107             'Keys': Keys(self.api, {'peer_id': None}),
 108             'Nodes': nodes,
 109             'Persons': filtered_persons,
 110             'Slices': filtered_slices,
 111             }
 112
 113
 114         if isinstance(self.caller, Peer):
 115             result['PeerNodes'] = Nodes(self.api, {'peer_id': self.caller['peer_id']})
 116
 117         result['db_time'] = time.time() - start
 118
 119         return result