sfa/storage/record.py

   1 from sfa.util.sfatime import utcparse, datetime_to_string
   2 from types import StringTypes
   3 from datetime import datetime
   4 from sfa.util.xml import XML
   5 from sfa.trust.gid import GID
   6
   7 class Record:
   8
   9     def __init__(self, dict=None, xml=None):
  10         if dict:
  11             self.load_from_dict(dict)
  12         elif xml:
  13             xml_record = XML(xml)
  14             xml_dict = xml_record.todict()
  15             self.load_from_dict(xml_dict)
  16
  17
  18     def get_field(self, field):
  19         return self.__dict__.get(field, None)
  20
  21     # xxx fixme
  22     # turns out the date_created field is received by the client as a 'created' int
  23     # (and 'last_updated' does not make it at all)
  24     # let's be flexible
  25     def date_repr (self,fields):
  26         if not isinstance(fields,list): fields=[fields]
  27         for field in fields:
  28             value=getattr(self,field,None)
  29             if isinstance (value,datetime):
  30                 return datetime_to_string (value)
  31             elif isinstance (value,(int,float)):
  32                 return datetime_to_string(utcparse(value))
  33         # fallback
  34         return "** undef_datetime **"
  35
  36     # it may be important to exclude relationships, which fortunately
  37     #
  38     def todict (self, exclude_types=[]):
  39         d=self.__dict__
  40         def exclude (k,v):
  41             if k.startswith('_'): return True
  42             if exclude_types:
  43                 for exclude_type in exclude_types:
  44                     if isinstance (v,exclude_type): return True
  45             return False
  46         keys=[k for (k,v) in d.items() if not exclude(k,v)]
  47         return dict ( [ (k,d[k]) for k in keys ] )
  48
  49     def toxml(self):
  50         return self.save_as_xml()
  51
  52     def load_from_dict (self, d):
  53         for (k,v) in d.iteritems():
  54             # experimental
  55             if isinstance(v, StringTypes) and v.lower() in ['true']: v=True
  56             if isinstance(v, StringTypes) and v.lower() in ['false']: v=False
  57             setattr(self,k,v)
  58
  59     # in addition we provide convenience for converting to and from xml records
  60     # for this purpose only, we need the subclasses to define 'fields' as either
  61     # a list or a dictionary
  62     def fields (self):
  63         fields = self.__dict__.keys()
  64         return fields
  65
  66     def save_as_xml (self):
  67         # xxx not sure about the scope here
  68         input_dict = dict( [ (key, getattr(self,key)) for key in self.fields() if getattr(self,key,None) ] )
  69         xml_record=XML("<record />")
  70         xml_record.parse_dict (input_dict)
  71         return xml_record.toxml()
  72
  73     def dump(self, format=None, dump_parents=False, sort=False):
  74         if not format:
  75             format = 'text'
  76         else:
  77             format = format.lower()
  78         if format == 'text':
  79             self.dump_text(dump_parents,sort=sort)
  80         elif format == 'xml':
  81             print self.save_as_xml()
  82         elif format == 'simple':
  83             print self.dump_simple()
  84         else:
  85             raise Exception, "Invalid format %s" % format
  86
  87     def dump_text(self, dump_parents=False, sort=False):
  88         print 40*'='
  89         print "RECORD"
  90         # print remaining fields
  91         fields=self.fields()
  92         if sort: fields.sort()
  93         for attrib_name in fields:
  94             attrib = getattr(self, attrib_name)
  95             # skip internals
  96             if attrib_name.startswith('_'):     continue
  97             # skip callables
  98             if callable (attrib):               continue
  99             # handle gid
 100             if attrib_name == 'gid':
 101                 print "    gid:"
 102                 print GID(string=attrib).dump_string(8, dump_parents)
 103             elif attrib_name in ['date created', 'last updated']:
 104                 print "    %s: %s" % (attrib_name, self.date_repr(attrib_name))
 105             else:
 106                 print "    %s: %s" % (attrib_name, attrib)
 107
 108     def dump_simple(self):
 109         return "%s"%self