46e2deed96c0c363b0b76c4d81528231b7576aa9
[sfa.git] / sfa / storage / model.py
1 from types import StringTypes
2 from datetime import datetime
3
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
12
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 
17
18 from sfa.trust.gid import GID
19
20 ##############################
21 Base=declarative_base()
22
23 ####################
24 # dicts vs objects
25 ####################
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
30
31 # here are a few utilities for this 
32
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 
37 #
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:
42 # . dict(obj)
43 # . obj.todict()
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
47 #
48 # (*) finally for converting a dictionary into an sqlalchemy object, we provide
49 # obj.load_from_dict(dict)
50
51 class AlchemyObj(Record):
52     def __iter__(self): 
53         self._i = iter(object_mapper(self).columns)
54         return self 
55     def next(self): 
56         n = self._i.next().name
57         return n, getattr(self, n)
58
59 #    # only intended for debugging 
60 #    def inspect (self, logger, message=""):
61 #        logger.info("%s -- Inspecting AlchemyObj -- attrs"%message)
62 #        for k in dir(self):
63 #            if not k.startswith('_'):
64 #                logger.info ("  %s: %s"%(k,getattr(self,k)))
65 #        logger.info("%s -- Inspecting AlchemyObj -- __dict__"%message)
66 #        d=self.__dict__
67 #        for (k,v) in d.iteritems():
68 #            logger.info("[%s]=%s"%(k,v))
69
70
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
77
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)
86     hrn                 = Column (String)
87     gid                 = 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 }
95
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
100         if hrn:                                 self.hrn=hrn
101         if gid: 
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)
108
109     def __repr__(self):
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"
115         result += ">"
116         return result
117
118     # shortcut - former implem. was record-based
119     def get (self, field, default):
120         return getattr(self,field,default)
121
122     @validates ('gid')
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)
127
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"%\
132                               (key,incoming))
133
134     @validates ('date_created')
135     def validate_date_created (self, key, incoming): return self.validate_datetime (key, incoming)
136
137     @validates ('last_updated')
138     def validate_last_updated (self, key, incoming): return self.validate_datetime (key, incoming)
139
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)
144
145     def just_created (self):
146         now=datetime.now()
147         self.date_created=now
148         self.last_updated=now
149
150     def just_updated (self):
151         now=datetime.now()
152         self.last_updated=now
153
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),
160             )
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),
166             )
167
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
171 ####################
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 \
178         ('RegUser',
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')
183     
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)
189
190     # no proper data yet, just hack the typename
191     def __repr__ (self):
192         return RegRecord.__repr__(self).replace("Record","Authority")
193
194     def update_pis (self, pi_hrns, dbsession):
195         # strip that in case we have <researcher> words </researcher>
196         pi_hrns = [ x.strip() for x in pi_hrns ]
197         request = dbsession.query (RegUser).filter(RegUser.hrn.in_(pi_hrns))
198         logger.info ("RegAuthority.update_pis: %d incoming pis, %d matches found"%(len(pi_hrns),request.count()))
199         pis = dbsession.query (RegUser).filter(RegUser.hrn.in_(pi_hrns)).all()
200         self.reg_pis = pis
201
202 ####################
203 class RegSlice (RegRecord):
204     __tablename__       = 'slices'
205     __mapper_args__     = { 'polymorphic_identity' : 'slice' }
206     record_id           = Column (Integer, ForeignKey ("records.record_id"), primary_key=True)
207     #### extensions come here
208     reg_researchers     = relationship \
209         ('RegUser', 
210          secondary=slice_researcher_table,
211          primaryjoin=RegRecord.record_id==slice_researcher_table.c.slice_id,
212          secondaryjoin=RegRecord.record_id==slice_researcher_table.c.researcher_id,
213          backref='reg_slices_as_researcher')
214
215     def __init__ (self, **kwds):
216         if 'type' not in kwds: kwds['type']='slice'
217         RegRecord.__init__(self, **kwds)
218
219     def __repr__ (self):
220         return RegRecord.__repr__(self).replace("Record","Slice")
221
222     def update_researchers (self, researcher_hrns, dbsession):
223         # strip that in case we have <researcher> words </researcher>
224         researcher_hrns = [ x.strip() for x in researcher_hrns ]
225         request = dbsession.query (RegUser).filter(RegUser.hrn.in_(researcher_hrns))
226         logger.info ("RegSlice.update_researchers: %d incoming researchers, %d matches found"%(len(researcher_hrns),request.count()))
227         researchers = dbsession.query (RegUser).filter(RegUser.hrn.in_(researcher_hrns)).all()
228         self.reg_researchers = researchers
229
230     # when dealing with credentials, we need to retrieve the PIs attached to a slice
231     # WARNING: with the move to passing dbsessions around, we face a glitch here because this
232     # helper function is called from the trust/ area that
233     def get_pis (self):
234         from sqlalchemy.orm import sessionmaker
235         Session=sessionmaker()
236         dbsession=Session.object_session(self)
237         from sfa.util.xrn import get_authority
238         authority_hrn = get_authority(self.hrn)
239         auth_record = dbsession.query(RegAuthority).filter_by(hrn=authority_hrn).first()
240         return auth_record.reg_pis
241         
242     @validates ('expires')
243     def validate_expires (self, key, incoming): return self.validate_datetime (key, incoming)
244
245 ####################
246 class RegNode (RegRecord):
247     __tablename__       = 'nodes'
248     __mapper_args__     = { 'polymorphic_identity' : 'node' }
249     record_id           = Column (Integer, ForeignKey ("records.record_id"), primary_key=True)
250     
251     def __init__ (self, **kwds):
252         if 'type' not in kwds: kwds['type']='node'
253         RegRecord.__init__(self, **kwds)
254
255     def __repr__ (self):
256         return RegRecord.__repr__(self).replace("Record","Node")
257
258 ####################
259 class RegUser (RegRecord):
260     __tablename__       = 'users'
261     # these objects will have type='user' in the records table
262     __mapper_args__     = { 'polymorphic_identity' : 'user' }
263     record_id           = Column (Integer, ForeignKey ("records.record_id"), primary_key=True)
264     #### extensions come here
265     email               = Column ('email', String)
266     # can't use name 'keys' here because when loading from xml we're getting
267     # a 'keys' tag, and assigning a list of strings in a reference column like this crashes
268     reg_keys            = relationship \
269         ('RegKey', backref='reg_user',
270          cascade="all, delete, delete-orphan")
271     
272     # so we can use RegUser (email=.., hrn=..) and the like
273     def __init__ (self, **kwds):
274         # handle local settings
275         if 'email' in kwds: self.email=kwds.pop('email')
276         if 'type' not in kwds: kwds['type']='user'
277         RegRecord.__init__(self, **kwds)
278
279     # append stuff at the end of the record __repr__
280     def __repr__ (self): 
281         result = RegRecord.__repr__(self).replace("Record","User")
282         result.replace (">"," email=%s"%self.email)
283         result += ">"
284         return result
285
286     @validates('email') 
287     def validate_email(self, key, address):
288         assert '@' in address
289         return address
290
291 ####################
292 # xxx tocheck : not sure about eager loading of this one
293 # meaning, when querying the whole records, we expect there should
294 # be a single query to fetch all the keys 
295 # or, is it enough that we issue a single query to retrieve all the keys 
296 class RegKey (Base):
297     __tablename__       = 'keys'
298     key_id              = Column (Integer, primary_key=True)
299     record_id             = Column (Integer, ForeignKey ("records.record_id"))
300     key                 = Column (String)
301     pointer             = Column (Integer, default = -1)
302     
303     def __init__ (self, key, pointer=None):
304         self.key=key
305         if pointer: self.pointer=pointer
306
307     def __repr__ (self):
308         result="<key id=%s key=%s..."%(self.key_id,self.key[8:16],)
309         try:    result += " user=%s"%self.reg_user.record_id
310         except: result += " no-user"
311         result += ">"
312         return result
313
314 class SliverAllocation(Base,AlchemyObj):
315     __tablename__       = 'sliver_allocation'
316     sliver_id           = Column(String, primary_key=True)
317     client_id           = Column(String)
318     component_id        = Column(String)
319     slice_urn           = Column(String)
320     allocation_state    = Column(String)
321
322     def __init__(self, **kwds):
323         if 'sliver_id' in kwds:
324             self.sliver_id = kwds['sliver_id']
325         if 'client_id' in kwds:
326             self.client_id = kwds['client_id']
327         if 'component_id' in kwds:
328             self.component_id = kwds['component_id']
329         if 'slice_urn' in kwds:
330             self.slice_urn = kwds['slice_urn']
331         if 'allocation_state' in kwds:
332             self.allocation_state = kwds['allocation_state']
333
334     def __repr__(self):
335         result = "<sliver_allocation sliver_id=%s allocation_state=%s" % \
336                   (self.sliver_id, self.allocation_state)
337         return result
338
339     @validates('allocation_state')
340     def validate_allocation_state(self, key, state):
341         allocation_states = ['geni_unallocated', 'geni_allocated', 'geni_provisioned']
342         assert state in allocation_states
343         return state
344
345     @staticmethod    
346     def set_allocations(sliver_ids, state, dbsession):
347         if not isinstance(sliver_ids, list):
348             sliver_ids = [sliver_ids]
349         sliver_state_updated = {}
350         constraint = SliverAllocation.sliver_id.in_(sliver_ids)
351         sliver_allocations = dbsession.query (SliverAllocation).filter(constraint)
352         sliver_ids_found = []
353         for sliver_allocation in sliver_allocations:
354             sliver_allocation.allocation_state = state
355             sliver_ids_found.append(sliver_allocation.sliver_id)
356
357         # Some states may not have been updated becuase no sliver allocation state record
358         # exists for the sliver. Insert new allocation records for these slivers and set
359         # it to geni_allocated.
360         sliver_ids_not_found = set(sliver_ids).difference(sliver_ids_found)
361         for sliver_id in sliver_ids_not_found:
362             record = SliverAllocation(sliver_id=sliver_id, allocation_state=state)
363             dbsession.add(record)
364         dbsession.commit()
365
366     @staticmethod
367     def delete_allocations(sliver_ids, dbsession):
368         if not isinstance(sliver_ids, list):
369             sliver_ids = [sliver_ids]
370         constraint = SliverAllocation.sliver_id.in_(sliver_ids)
371         sliver_allocations = dbsession.query(SliverAllocation).filter(constraint)
372         for sliver_allocation in sliver_allocations:
373             dbsession.delete(sliver_allocation)
374         dbsession.commit()
375     
376     def sync(self, dbsession):
377         constraints = [SliverAllocation.sliver_id==self.sliver_id]
378         results = dbsession.query(SliverAllocation).filter(and_(*constraints))
379         records = []
380         for result in results:
381             records.append(result) 
382         
383         if not records:
384             dbsession.add(self)
385         else:
386             record = records[0]
387             record.sliver_id = self.sliver_id
388             record.client_id  = self.client_id
389             record.component_id  = self.component_id
390             record.slice_urn  = self.slice_urn
391             record.allocation_state = self.allocation_state
392         dbsession.commit()    
393         
394
395 ##############################
396 # although the db needs of course to be reachable for the following functions
397 # the schema management functions are here and not in alchemy
398 # because the actual details of the classes need to be known
399 # migrations: this code has no notion of the previous versions
400 # of the data model nor of migrations
401 # sfa.storage.migrations.db_init uses this when starting from
402 # a fresh db only
403 def init_tables(engine):
404     logger.info("Initializing db schema from current/latest model")
405     Base.metadata.create_all(engine)
406
407 def drop_tables(engine):
408     logger.info("Dropping tables from current/latest model")
409     Base.metadata.drop_all(engine)
410
411 ##############################
412 # create a record of the right type from either a dict or an xml string
413 def make_record (dict={}, xml=""):
414     if dict:    return make_record_dict (dict)
415     elif xml:   return make_record_xml (xml)
416     else:       raise Exception("make_record has no input")
417
418 # convert an incoming record - typically from xmlrpc - into an object
419 def make_record_dict (record_dict):
420     assert ('type' in record_dict)
421     type=record_dict['type'].split('+')[0]
422     if type=='authority':
423         result=RegAuthority (dict=record_dict)
424     elif type=='user':
425         result=RegUser (dict=record_dict)
426     elif type=='slice':
427         result=RegSlice (dict=record_dict)
428     elif type=='node':
429         result=RegNode (dict=record_dict)
430     else:
431         logger.debug("Untyped RegRecord instance")
432         result=RegRecord (dict=record_dict)
433     logger.info ("converting dict into Reg* with type=%s"%type)
434     logger.info ("returning=%s"%result)
435     # xxx todo
436     # register non-db attributes in an extensions field
437     return result
438         
439 def make_record_xml (xml):
440     xml_record = XML(xml)
441     xml_dict = xml_record.todict()
442     logger.info("load from xml, keys=%s"%xml_dict.keys())
443     return make_record_dict (xml_dict)
444
445 ####################
446 # augment local records with data from builtin relationships
447 # expose related objects as a list of hrns
448 # we pick names that clearly won't conflict with the ones used in the old approach,
449 # were the relationships data came from the testbed side
450 # for each type, a dict of the form {<field-name-exposed-in-record>:<alchemy_accessor_name>}
451 # so after that, an 'authority' record will e.g. have a 'reg-pis' field with the hrns of its pi-users
452 augment_map={'authority': {'reg-pis':'reg_pis',},
453              'slice': {'reg-researchers':'reg_researchers',},
454              'user': {'reg-pi-authorities':'reg_authorities_as_pi',
455                       'reg-slices':'reg_slices_as_researcher',},
456              }
457
458 def augment_with_sfa_builtins (local_record):
459     # don't ruin the import of that file in a client world
460     from sfa.util.xrn import Xrn
461     # add a 'urn' field
462     setattr(local_record,'reg-urn',Xrn(xrn=local_record.hrn,type=local_record.type).urn)
463     # users have keys and this is needed to synthesize 'users' sent over to CreateSliver
464     if local_record.type=='user':
465         user_keys = [ key.key for key in local_record.reg_keys ]
466         setattr(local_record, 'reg-keys', user_keys)
467     # search in map according to record type
468     type_map=augment_map.get(local_record.type,{})
469     # use type-dep. map to do the job
470     for (field_name,attribute) in type_map.items():
471         # get related objects
472         related_records = getattr(local_record,attribute,[])
473         hrns = [ r.hrn for r in related_records ]
474         setattr (local_record, field_name, hrns)
475     
476