Merge branch 'master' into senslab2
[sfa.git] / 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     # xxx fixme
18     # turns out the date_created field is received by the client as a 'created' int
19     # (and 'last_updated' does not make it at all)
20     # let's be flexible
21     def date_repr (self,fields):
22         if not isinstance(fields,list): fields=[fields]
23         for field in fields:
24             value=getattr(self,field,None)
25             if isinstance (value,datetime):
26                 return datetime_to_string (value)
27             elif isinstance (value,(int,float)):
28                 return datetime_to_string(utcparse(value))
29         # fallback
30         return "** undef_datetime **"
31     
32     def todict (self):
33         d=self.__dict__
34         keys=[k for k in d.keys() if not k.startswith('_')]
35         return dict ( [ (k,d[k]) for k in keys ] )
36
37     def load_from_dict (self, d):
38         for (k,v) in d.iteritems():
39             # experimental
40             if isinstance(v, StringTypes) and v.lower() in ['true']: v=True
41             if isinstance(v, StringTypes) and v.lower() in ['false']: v=False
42             setattr(self,k,v)
43
44     # in addition we provide convenience for converting to and from xml records
45     # for this purpose only, we need the subclasses to define 'fields' as either
46     # a list or a dictionary
47     def xml_fields (self):
48         fields=self.fields
49         if isinstance(fields,dict): fields=fields.keys()
50         return fields
51
52     def save_as_xml (self):
53         # xxx not sure about the scope here
54         input_dict = dict( [ (key, getattr(self.key), ) for key in self.xml_fields() if getattr(self,key,None) ] )
55         xml_record=XML("<record />")
56         xml_record.parse_dict (input_dict)
57         return xml_record.toxml()
58
59     def dump(self, format=None, dump_parents=False):
60         if not format:
61             format = 'text'
62         else:
63             format = format.lower()
64         if format == 'text':
65             self.dump_text(dump_parents)
66         elif format == 'xml':
67             print self.save_to_string()
68         elif format == 'simple':
69             print self.dump_simple()
70         else:
71             raise Exception, "Invalid format %s" % format
72
73     def dump_text(self, dump_parents=False):
74         # print core fields in this order
75         core_fields = [ 'hrn', 'type', 'authority', 'date_created', 'created', 'last_updated', 'gid',  ]
76         print "".join(['=' for i in range(40)])
77         print "RECORD"
78         print "    hrn:", self.hrn
79         print "    type:", self.type
80         print "    authority:", self.authority
81         print "    date created:", self.date_repr( ['date_created','created'] )
82         print "    last updated:", self.date_repr('last_updated')
83         print "    gid:"
84         if self.gid:
85             print GID(self.gid).dump_string(8, dump_parents)    
86
87         # print remaining fields
88         for attrib_name in dir(self):
89             attrib = getattr(self, attrib_name)
90             # skip internals
91             if attrib_name.startswith('_'):     continue
92             # skip core fields
93             if attrib_name in core_fields:      continue
94             # skip callables
95             if callable (attrib):               continue
96             print "     %s: %s" % (attrib_name, attrib)
97
98     def dump_simple(self):
99         return "%s"%self