3 # Thierry Parmentelat - INRIA
7 from types import StringTypes
8 from urlparse import urlparse
10 from PLC.Faults import *
11 from PLC.Parameter import Parameter, Mixed
12 from PLC.Filter import Filter
13 from PLC.Table import Row, Table
16 from PLC.Sites import Site, Sites
17 from PLC.Persons import Person, Persons
18 from PLC.Keys import Key, Keys
19 from PLC.Nodes import Node, Nodes
20 from PLC.TagTypes import TagType, TagTypes
21 from PLC.SliceTags import SliceTag, SliceTags
22 from PLC.Slices import Slice, Slices
26 Stores the list of peering PLCs in the peers table.
27 See the Row class for more details
31 primary_key = 'peer_id'
32 join_tables = ['peer_site', 'peer_person', 'peer_key', 'peer_node', 'peer_slice']
34 'peer_id': Parameter (int, "Peer identifier"),
35 'peername': Parameter (str, "Peer name"),
36 'peer_url': Parameter (str, "Peer API URL"),
37 'key': Parameter(str, "Peer GPG public key"),
38 'cacert': Parameter(str, "Peer SSL public certificate"),
39 'shortname' : Parameter(str, "Peer short name"),
40 'hrn_root' : Parameter(str, "Root of this peer in a hierarchical naming space"),
42 'site_ids': Parameter([int], "List of sites for which this peer is authoritative"),
43 'person_ids': Parameter([int], "List of users for which this peer is authoritative"),
44 'key_ids': Parameter([int], "List of keys for which this peer is authoritative"),
45 'node_ids': Parameter([int], "List of nodes for which this peer is authoritative"),
46 'slice_ids': Parameter([int], "List of slices for which this peer is authoritative"),
49 def validate_peername(self, peername):
51 raise PLCInvalidArgument, "Peer name must be specified"
53 conflicts = Peers(self.api, [peername])
54 for peer in conflicts:
55 if 'peer_id' not in self or self['peer_id'] != peer['peer_id']:
56 raise PLCInvalidArgument, "Peer name already in use"
60 def validate_peer_url(self, url):
62 Validate URL. Must be HTTPS.
65 (scheme, netloc, path, params, query, fragment) = urlparse(url)
67 raise PLCInvalidArgument, "Peer URL scheme must be https"
71 def delete(self, commit = True):
73 Deletes this peer and all related entities.
76 assert 'peer_id' in self
78 # Remove all related entities
80 Slices(self.api, self['slice_ids']) + \
81 Keys(self.api, self['key_ids']) + \
82 Persons(self.api, self['person_ids']) + \
83 Nodes(self.api, self['node_ids']) + \
84 Sites(self.api, self['site_ids']):
85 assert obj['peer_id'] == self['peer_id']
86 obj.delete(commit = False)
89 self['deleted'] = True
92 def add_site(self, site, peer_site_id, commit = True):
94 Associate a local site entry with this peer.
97 add = Row.add_object(Site, 'peer_site')
99 {'peer_id': self['peer_id'],
100 'site_id': site['site_id'],
101 'peer_site_id': peer_site_id},
104 def add_person(self, person, peer_person_id, commit = True):
106 Associate a local user entry with this peer.
109 add = Row.add_object(Person, 'peer_person')
111 {'peer_id': self['peer_id'],
112 'person_id': person['person_id'],
113 'peer_person_id': peer_person_id},
116 def add_key(self, key, peer_key_id, commit = True):
118 Associate a local key entry with this peer.
121 add = Row.add_object(Key, 'peer_key')
123 {'peer_id': self['peer_id'],
124 'key_id': key['key_id'],
125 'peer_key_id': peer_key_id},
128 def add_node(self, node, peer_node_id, commit = True):
130 Associate a local node entry with this peer.
133 add = Row.add_object(Node, 'peer_node')
135 {'peer_id': self['peer_id'],
136 'node_id': node['node_id'],
137 'peer_node_id': peer_node_id},
140 def add_slice(self, slice, peer_slice_id, commit = True):
142 Associate a local slice entry with this peer.
145 add = Row.add_object(Slice, 'peer_slice')
147 {'peer_id': self['peer_id'],
148 'slice_id': slice['slice_id'],
149 'peer_slice_id': peer_slice_id},
152 def connect(self, **kwds):
154 Connect to this peer via XML-RPC.
158 from PLC.PyCurl import PyCurlTransport
159 self.server = xmlrpclib.ServerProxy(self['peer_url'],
160 PyCurlTransport(self['peer_url'], self['cacert']),
161 allow_none = 1, **kwds)
163 def add_auth(self, function, methodname, **kwds):
165 Sign the specified XML-RPC call and add an auth struct as the
166 first argument of the call.
169 def wrapper(*args, **kwds):
170 from PLC.GPG import gpg_sign
171 signature = gpg_sign(args,
172 self.api.config.PLC_ROOT_GPG_KEY,
173 self.api.config.PLC_ROOT_GPG_KEY_PUB,
176 auth = {'AuthMethod': "gpg",
177 'name': self.api.config.PLC_NAME,
178 'signature': signature}
180 # Automagically add auth struct to every call
181 args = (auth,) + args
183 return function(*args)
187 def __getattr__(self, attr):
189 Returns a callable API function if attr is the name of a
190 PLCAPI function; otherwise, returns the specified attribute.
194 # Figure out if the specified attribute is the name of a
195 # PLCAPI function. If so and the function requires an
196 # authentication structure as its first argument, return a
197 # callable that automagically adds an auth struct to the
200 api_function = self.api.callable(methodname)
201 if api_function.accepts and \
202 (isinstance(api_function.accepts[0], PLC.Auth.Auth) or \
203 (isinstance(api_function.accepts[0], Mixed) and \
204 filter(lambda param: isinstance(param, Auth), api_function.accepts[0]))):
205 function = getattr(self.server, methodname)
206 return self.add_auth(function, methodname)
207 except Exception, err:
210 if hasattr(self, attr):
211 return getattr(self, attr)
213 raise AttributeError, "type object 'Peer' has no attribute '%s'" % attr
217 Maps to the peers table in the database
220 def __init__ (self, api, peer_filter = None, columns = None):
221 Table.__init__(self, api, Peer, columns)
223 sql = "SELECT %s FROM view_peers WHERE deleted IS False" % \
224 ", ".join(self.columns)
226 if peer_filter is not None:
227 if isinstance(peer_filter, (list, tuple, set)):
228 # Separate the list into integers and strings
229 ints = filter(lambda x: isinstance(x, (int, long)), peer_filter)
230 strs = filter(lambda x: isinstance(x, StringTypes), peer_filter)
231 peer_filter = Filter(Peer.fields, {'peer_id': ints, 'peername': strs})
232 sql += " AND (%s) %s" % peer_filter.sql(api, "OR")
233 elif isinstance(peer_filter, dict):
234 peer_filter = Filter(Peer.fields, peer_filter)
235 sql += " AND (%s) %s" % peer_filter.sql(api, "AND")