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     def todict (self):
  37         d=self.__dict__
  38         keys=[k for k in d.keys() if not k.startswith('_')]
  39         return dict ( [ (k,d[k]) for k in keys ] )
  40
  41     def toxml(self):
  42         return self.save_as_xml()
  43
  44     def load_from_dict (self, d):
  45         for (k,v) in d.iteritems():
  46             # experimental
  47             if isinstance(v, StringTypes) and v.lower() in ['true']: v=True
  48             if isinstance(v, StringTypes) and v.lower() in ['false']: v=False
  49             setattr(self,k,v)
  50
  51     # in addition we provide convenience for converting to and from xml records
  52     # for this purpose only, we need the subclasses to define 'fields' as either
  53     # a list or a dictionary
  54     def xml_fields (self):
  55         fields = self.__dict__.keys()
  56         return fields
  57
  58     def save_as_xml (self):
  59         # xxx not sure about the scope here
  60         input_dict = dict( [ (key, getattr(self,key)) for key in self.xml_fields() if getattr(self,key,None) ] )
  61         xml_record=XML("<record />")
  62         xml_record.parse_dict (input_dict)
  63         return xml_record.toxml()
  64
  65     def dump(self, format=None, dump_parents=False):
  66         if not format:
  67             format = 'text'
  68         else:
  69             format = format.lower()
  70         if format == 'text':
  71             self.dump_text(dump_parents)
  72         elif format == 'xml':
  73             print self.save_to_string()
  74         elif format == 'simple':
  75             print self.dump_simple()
  76         else:
  77             raise Exception, "Invalid format %s" % format
  78
  79     def dump_text(self, dump_parents=False):
  80         # print core fields in this order
  81         core_fields = [ 'hrn', 'type', 'authority', 'date_created', 'created', 'last_updated', 'gid',  ]
  82         print "".join(['=' for i in range(40)])
  83         print "RECORD"
  84         print "    hrn:", self.hrn
  85         print "    type:", self.type
  86         print "    authority:", self.authority
  87         print "    date created:", self.date_repr( ['date_created','created'] )
  88         print "    last updated:", self.date_repr('last_updated')
  89         print "    gid:"
  90         if self.gid:
  91             print GID(self.gid).dump_string(8, dump_parents)
  92
  93         # print remaining fields
  94         for attrib_name in dir(self):
  95             attrib = getattr(self, attrib_name)
  96             # skip internals
  97             if attrib_name.startswith('_'):     continue
  98             # skip core fields
  99             if attrib_name in core_fields:      continue
 100             # skip callables
 101             if callable (attrib):               continue
 102             print "     %s: %s" % (attrib_name, attrib)
 103
 104     def dump_simple(self):
 105         return "%s"%self