1 from types import StringTypes
2 from datetime import datetime
4 from sqlalchemy import or_, and_
5 from sqlalchemy import Column, Integer, String, DateTime
6 from sqlalchemy import Table, Column, MetaData, join, ForeignKey
7 from sqlalchemy.orm import relationship, backref
8 from sqlalchemy.orm import column_property
9 from sqlalchemy.orm import object_mapper
10 from sqlalchemy.orm import validates
11 from sqlalchemy.ext.declarative import declarative_base
13 from sfa.storage.record import Record
14 from sfa.util.sfalogging import logger
15 from sfa.util.sfatime import utcparse, datetime_to_string
16 from sfa.util.xml import XML
18 from sfa.trust.gid import GID
20 ##############################
21 Base=declarative_base()
26 # historically the front end to the db dealt with dicts, so the code was only dealing with dicts
27 # sqlalchemy however offers an object interface, meaning that you write obj.id instead of obj['id']
28 # which is admittedly much nicer
29 # however we still need to deal with dictionaries if only for the xmlrpc layer
31 # here are a few utilities for this
33 # (*) first off, when an old pieve of code needs to be used as-is, if only temporarily, the simplest trick
34 # is to use obj.__dict__
35 # this behaves exactly like required, i.e. obj.__dict__['field']='new value' does change obj.field
36 # however this depends on sqlalchemy's implementation so it should be avoided
38 # (*) second, when an object needs to be exposed to the xmlrpc layer, we need to convert it into a dict
39 # remember though that writing the resulting dictionary won't change the object
40 # essentially obj.__dict__ would be fine too, except that we want to discard alchemy private keys starting with '_'
41 # 2 ways are provided for that:
44 # the former dict(obj) relies on __iter__() and next() below, and does not rely on the fields names
45 # although it seems to work fine, I've found cases where it issues a weird python error that I could not get right
46 # so the latter obj.todict() seems more reliable but more hacky as is relies on the form of fields, so this can probably be improved
48 # (*) finally for converting a dictionary into an sqlalchemy object, we provide
49 # obj.load_from_dict(dict)
51 class AlchemyObj(Record):
53 self._i = iter(object_mapper(self).columns)
56 n = self._i.next().name
57 return n, getattr(self, n)
59 # # only intended for debugging
60 # def inspect (self, logger, message=""):
61 # logger.info("%s -- Inspecting AlchemyObj -- attrs"%message)
63 # if not k.startswith('_'):
64 # logger.info (" %s: %s"%(k,getattr(self,k)))
65 # logger.info("%s -- Inspecting AlchemyObj -- __dict__"%message)
67 # for (k,v) in d.iteritems():
68 # logger.info("[%s]=%s"%(k,v))
71 ##############################
72 # various kinds of records are implemented as an inheritance hierarchy
73 # RegRecord is the base class for all actual variants
74 # a first draft was using 'type' as the discriminator for the inheritance
75 # but we had to define another more internal column (classtype) so we
76 # accomodate variants in types like authority+am and the like
78 class RegRecord (Base,AlchemyObj):
79 __tablename__ = 'records'
80 record_id = Column (Integer, primary_key=True)
81 # this is the discriminator that tells which class to use
82 classtype = Column (String)
83 # in a first version type was the discriminator
84 # but that could not accomodate for 'authority+sa' and the like
85 type = Column (String)
88 authority = Column (String)
89 peer_authority = Column (String)
90 pointer = Column (Integer, default=-1)
91 date_created = Column (DateTime)
92 last_updated = Column (DateTime)
93 # use the 'type' column to decide which subclass the object is of
94 __mapper_args__ = { 'polymorphic_on' : classtype }
96 fields = [ 'type', 'hrn', 'gid', 'authority', 'peer_authority' ]
97 def __init__ (self, type=None, hrn=None, gid=None, authority=None, peer_authority=None,
98 pointer=None, dict=None):
99 if type: self.type=type
102 if isinstance(gid, StringTypes): self.gid=gid
103 else: self.gid=gid.save_to_string(save_parents=True)
104 if authority: self.authority=authority
105 if peer_authority: self.peer_authority=peer_authority
106 if pointer: self.pointer=pointer
107 if dict: self.load_from_dict (dict)
110 result="<Record id=%s, type=%s, hrn=%s, authority=%s, pointer=%s" % \
111 (self.record_id, self.type, self.hrn, self.authority, self.pointer)
112 # skip the uniform '--- BEGIN CERTIFICATE --' stuff
113 if self.gid: result+=" gid=%s..."%self.gid[28:36]
114 else: result+=" nogid"
118 # shortcut - former implem. was record-based
119 def get (self, field, default):
120 return getattr(self,field,default)
123 def validate_gid (self, key, gid):
124 if gid is None: return
125 elif isinstance(gid, StringTypes): return gid
126 else: return gid.save_to_string(save_parents=True)
128 def validate_datetime (self, key, incoming):
129 if isinstance (incoming, datetime): return incoming
130 elif isinstance (incoming, (int,float)):return datetime.fromtimestamp (incoming)
131 else: logger.info("Cannot validate datetime for key %s with input %s"%\
134 @validates ('date_created')
135 def validate_date_created (self, key, incoming): return self.validate_datetime (key, incoming)
137 @validates ('last_updated')
138 def validate_last_updated (self, key, incoming): return self.validate_datetime (key, incoming)
140 # xxx - there might be smarter ways to handle get/set'ing gid using validation hooks
141 def get_gid_object (self):
142 if not self.gid: return None
143 else: return GID(string=self.gid)
145 def just_created (self):
147 self.date_created=now
148 self.last_updated=now
150 def just_updated (self):
152 self.last_updated=now
154 #################### cross-relations tables
155 # authority x user (pis) association
156 authority_pi_table = \
157 Table ( 'authority_pi', Base.metadata,
158 Column ('authority_id', Integer, ForeignKey ('records.record_id'), primary_key=True),
159 Column ('pi_id', Integer, ForeignKey ('records.record_id'), primary_key=True),
161 # slice x user (researchers) association
162 slice_researcher_table = \
163 Table ( 'slice_researcher', Base.metadata,
164 Column ('slice_id', Integer, ForeignKey ('records.record_id'), primary_key=True),
165 Column ('researcher_id', Integer, ForeignKey ('records.record_id'), primary_key=True),
168 ##############################
169 # all subclasses define a convenience constructor with a default value for type,
170 # and when applicable a way to define local fields in a kwd=value argument
172 class RegAuthority (RegRecord):
173 __tablename__ = 'authorities'
174 __mapper_args__ = { 'polymorphic_identity' : 'authority' }
175 record_id = Column (Integer, ForeignKey ("records.record_id"), primary_key=True)
176 #### extensions come here
177 reg_pis = relationship \
179 secondary=authority_pi_table,
180 primaryjoin=RegRecord.record_id==authority_pi_table.c.authority_id,
181 secondaryjoin=RegRecord.record_id==authority_pi_table.c.pi_id,
182 backref='reg_authorities_as_pi')
184 def __init__ (self, **kwds):
185 # fill in type if not previously set
186 if 'type' not in kwds: kwds['type']='authority'
187 # base class constructor
188 RegRecord.__init__(self, **kwds)
190 # no proper data yet, just hack the typename
192 return RegRecord.__repr__(self).replace("Record","Authority")
194 def update_pis (self, pi_hrns):
195 # don't ruin the import of that file in a client world
196 from sfa.storage.alchemy import dbsession
197 # strip that in case we have <researcher> words </researcher>
198 pi_hrns = [ x.strip() for x in pi_hrns ]
199 request = dbsession.query (RegUser).filter(RegUser.hrn.in_(pi_hrns))
200 logger.info ("RegAuthority.update_pis: %d incoming pis, %d matches found"%(len(pi_hrns),request.count()))
201 pis = dbsession.query (RegUser).filter(RegUser.hrn.in_(pi_hrns)).all()
205 class RegSlice (RegRecord):
206 __tablename__ = 'slices'
207 __mapper_args__ = { 'polymorphic_identity' : 'slice' }
208 record_id = Column (Integer, ForeignKey ("records.record_id"), primary_key=True)
209 #### extensions come here
210 reg_researchers = relationship \
212 secondary=slice_researcher_table,
213 primaryjoin=RegRecord.record_id==slice_researcher_table.c.slice_id,
214 secondaryjoin=RegRecord.record_id==slice_researcher_table.c.researcher_id,
215 backref='reg_slices_as_researcher')
217 def __init__ (self, **kwds):
218 if 'type' not in kwds: kwds['type']='slice'
219 RegRecord.__init__(self, **kwds)
222 return RegRecord.__repr__(self).replace("Record","Slice")
224 def update_researchers (self, researcher_hrns):
225 # don't ruin the import of that file in a client world
226 from sfa.storage.alchemy import dbsession
227 # strip that in case we have <researcher> words </researcher>
228 researcher_hrns = [ x.strip() for x in researcher_hrns ]
229 request = dbsession.query (RegUser).filter(RegUser.hrn.in_(researcher_hrns))
230 logger.info ("RegSlice.update_researchers: %d incoming researchers, %d matches found"%(len(researcher_hrns),request.count()))
231 researchers = dbsession.query (RegUser).filter(RegUser.hrn.in_(researcher_hrns)).all()
232 self.reg_researchers = researchers
234 # when dealing with credentials, we need to retrieve the PIs attached to a slice
236 # don't ruin the import of that file in a client world
237 from sfa.storage.alchemy import dbsession
238 from sfa.util.xrn import get_authority
239 authority_hrn = get_authority(self.hrn)
240 auth_record = dbsession.query(RegAuthority).filter_by(hrn=authority_hrn).first()
241 return auth_record.reg_pis
243 @validates ('expires')
244 def validate_expires (self, key, incoming): return self.validate_datetime (key, incoming)
247 class RegNode (RegRecord):
248 __tablename__ = 'nodes'
249 __mapper_args__ = { 'polymorphic_identity' : 'node' }
250 record_id = Column (Integer, ForeignKey ("records.record_id"), primary_key=True)
252 def __init__ (self, **kwds):
253 if 'type' not in kwds: kwds['type']='node'
254 RegRecord.__init__(self, **kwds)
257 return RegRecord.__repr__(self).replace("Record","Node")
260 class RegUser (RegRecord):
261 __tablename__ = 'users'
262 # these objects will have type='user' in the records table
263 __mapper_args__ = { 'polymorphic_identity' : 'user' }
264 record_id = Column (Integer, ForeignKey ("records.record_id"), primary_key=True)
265 #### extensions come here
266 email = Column ('email', String)
267 # can't use name 'keys' here because when loading from xml we're getting
268 # a 'keys' tag, and assigning a list of strings in a reference column like this crashes
269 reg_keys = relationship \
270 ('RegKey', backref='reg_user',
271 cascade="all, delete, delete-orphan")
273 # so we can use RegUser (email=.., hrn=..) and the like
274 def __init__ (self, **kwds):
275 # handle local settings
276 if 'email' in kwds: self.email=kwds.pop('email')
277 if 'type' not in kwds: kwds['type']='user'
278 RegRecord.__init__(self, **kwds)
280 # append stuff at the end of the record __repr__
282 result = RegRecord.__repr__(self).replace("Record","User")
283 result.replace (">"," email=%s"%self.email)
288 def validate_email(self, key, address):
289 assert '@' in address
293 # xxx tocheck : not sure about eager loading of this one
294 # meaning, when querying the whole records, we expect there should
295 # be a single query to fetch all the keys
296 # or, is it enough that we issue a single query to retrieve all the keys
298 __tablename__ = 'keys'
299 key_id = Column (Integer, primary_key=True)
300 record_id = Column (Integer, ForeignKey ("records.record_id"))
301 key = Column (String)
302 pointer = Column (Integer, default = -1)
304 def __init__ (self, key, pointer=None):
306 if pointer: self.pointer=pointer
309 result="<key id=%s key=%s..."%(self.key_id,self.key[8:16],)
310 try: result += " user=%s"%self.reg_user.record_id
311 except: result += " no-user"
315 class SliverAllocation(Base,AlchemyObj):
316 __tablename__ = 'sliver_allocation'
317 sliver_id = Column(String, primary_key=True)
318 client_id = Column(String)
319 component_id = Column(String)
320 slice_urn = Column(String)
321 allocation_state = Column(String)
323 def __init__(self, **kwds):
324 if 'sliver_id' in kwds:
325 self.sliver_id = kwds['sliver_id']
326 if 'client_id' in kwds:
327 self.client_id = kwds['client_id']
328 if 'component_id' in kwds:
329 self.component_id = kwds['component_id']
330 if 'slice_urn' in kwds:
331 self.slice_urn = kwds['slice_urn']
332 if 'allocation_state' in kwds:
333 self.allocation_state = kwds['allocation_state']
336 result = "<sliver_allocation sliver_id=%s allocation_state=%s" % \
337 (self.sliver_id, self.allocation_state)
340 @validates('allocation_state')
341 def validate_allocation_state(self, key, state):
342 allocation_states = ['geni_unallocated', 'geni_allocated', 'geni_provisioned']
343 assert state in allocation_states
347 def set_allocations(sliver_ids, state):
348 from sfa.storage.alchemy import dbsession
349 if not isinstance(sliver_ids, list):
350 sliver_ids = [sliver_ids]
351 sliver_state_updated = {}
352 constraint = SliverAllocation.sliver_id.in_(sliver_ids)
353 sliver_allocations = dbsession.query (SliverAllocation).filter(constraint)
354 sliver_ids_found = []
355 for sliver_allocation in sliver_allocations:
356 sliver_allocation.allocation_state = state
357 sliver_ids_found.append(sliver_allocation.sliver_id)
359 # Some states may not have been updated becuase no sliver allocation state record
360 # exists for the sliver. Insert new allocation records for these slivers and set
361 # it to geni_allocated.
362 sliver_ids_not_found = set(sliver_ids).difference(sliver_ids_found)
363 for sliver_id in sliver_ids_not_found:
364 record = SliverAllocation(sliver_id=sliver_id, allocation_state=state)
365 dbsession.add(record)
369 def delete_allocations(sliver_ids):
370 from sfa.storage.alchemy import dbsession
371 if not isinstance(sliver_ids, list):
372 sliver_ids = [sliver_ids]
373 constraint = SliverAllocation.sliver_id.in_(sliver_ids)
374 sliver_allocations = dbsession.query(SliverAllocation).filter(constraint)
375 for sliver_allocation in sliver_allocations:
376 dbsession.delete(sliver_allocation)
380 from sfa.storage.alchemy import dbsession
382 constraints = [SliverAllocation.sliver_id==self.sliver_id]
383 results = dbsession.query(SliverAllocation).filter(and_(*constraints))
385 for result in results:
386 records.append(result)
392 record.sliver_id = self.sliver_id
393 record.client_id = self.client_id
394 record.component_id = self.component_id
395 record.slice_urn = self.slice_urn
396 record.allocation_state = self.allocation_state
400 ##############################
401 # although the db needs of course to be reachable for the following functions
402 # the schema management functions are here and not in alchemy
403 # because the actual details of the classes need to be known
404 # migrations: this code has no notion of the previous versions
405 # of the data model nor of migrations
406 # sfa.storage.migrations.db_init uses this when starting from
408 def init_tables(engine):
409 logger.info("Initializing db schema from current/latest model")
410 Base.metadata.create_all(engine)
412 def drop_tables(engine):
413 logger.info("Dropping tables from current/latest model")
414 Base.metadata.drop_all(engine)
416 ##############################
417 # create a record of the right type from either a dict or an xml string
418 def make_record (dict={}, xml=""):
419 if dict: return make_record_dict (dict)
420 elif xml: return make_record_xml (xml)
421 else: raise Exception("make_record has no input")
423 # convert an incoming record - typically from xmlrpc - into an object
424 def make_record_dict (record_dict):
425 assert ('type' in record_dict)
426 type=record_dict['type'].split('+')[0]
427 if type=='authority':
428 result=RegAuthority (dict=record_dict)
430 result=RegUser (dict=record_dict)
432 result=RegSlice (dict=record_dict)
434 result=RegNode (dict=record_dict)
436 logger.debug("Untyped RegRecord instance")
437 result=RegRecord (dict=record_dict)
438 logger.info ("converting dict into Reg* with type=%s"%type)
439 logger.info ("returning=%s"%result)
441 # register non-db attributes in an extensions field
444 def make_record_xml (xml):
445 xml_record = XML(xml)
446 xml_dict = xml_record.todict()
447 logger.info("load from xml, keys=%s"%xml_dict.keys())
448 return make_record_dict (xml_dict)
451 # augment local records with data from builtin relationships
452 # expose related objects as a list of hrns
453 # we pick names that clearly won't conflict with the ones used in the old approach,
454 # were the relationships data came from the testbed side
455 # for each type, a dict of the form {<field-name-exposed-in-record>:<alchemy_accessor_name>}
456 # so after that, an 'authority' record will e.g. have a 'reg-pis' field with the hrns of its pi-users
457 augment_map={'authority': {'reg-pis':'reg_pis',},
458 'slice': {'reg-researchers':'reg_researchers',},
459 'user': {'reg-pi-authorities':'reg_authorities_as_pi',
460 'reg-slices':'reg_slices_as_researcher',},
463 def augment_with_sfa_builtins (local_record):
464 # don't ruin the import of that file in a client world
465 from sfa.util.xrn import Xrn
467 setattr(local_record,'reg-urn',Xrn(xrn=local_record.hrn,type=local_record.type).urn)
468 # users have keys and this is needed to synthesize 'users' sent over to CreateSliver
469 if local_record.type=='user':
470 user_keys = [ key.key for key in local_record.reg_keys ]
471 setattr(local_record, 'reg-keys', user_keys)
472 # search in map according to record type
473 type_map=augment_map.get(local_record.type,{})
474 # use type-dep. map to do the job
475 for (field_name,attribute) in type_map.items():
476 # get related objects
477 related_records = getattr(local_record,attribute,[])
478 hrns = [ r.hrn for r in related_records ]
479 setattr (local_record, field_name, hrns)