* tried to put some sense in the way things get logged, at least on server-side for now
[sfa.git] / sfa / util / table.py
1 ### $Id$
2 ### $URL$
3 #
4 # implements support for SFA records stored in db tables
5 #
6 # TODO: Use existing PLC database methods? or keep this separate?
7
8 import report
9 import pgdb
10
11 from sfa.util.PostgreSQL import *
12 from sfa.trust.gid import *
13 from sfa.util.record import *
14 from sfa.util.config import *
15 from sfa.util.filter import *
16
17 class SfaTable(list):
18
19     SFA_TABLE_PREFIX = "sfa"
20
21     def __init__(self, record_filter = None):
22
23         # pgsql doesn't like table names with "." in them, to replace it with "$"
24         self.tablename = SfaTable.SFA_TABLE_PREFIX
25         self.config = Config()
26         self.db = PostgreSQL(self.config)
27
28         if record_filter:
29             records = self.find(record_filter)
30             for record in records:
31                 self.append(record)             
32
33     def exists(self):
34         sql = "SELECT * from pg_tables"
35         tables = self.db.selectall(sql)
36         tables = filter(lambda row: row['tablename'].startswith(self.SFA_TABLE_PREFIX), tables)
37         if tables:
38             return True
39         return False
40     def db_fields(self, obj=None):
41         
42         db_fields = self.db.fields(self.SFA_TABLE_PREFIX)
43         return dict( [ (key,value) for (key, value) in obj.items() \
44                         if key in db_fields and
45                         self.is_writable(key, value, SfaRecord.fields)] )      
46
47     @staticmethod
48     def is_writable (key,value,dict):
49         # if not mentioned, assume it's writable (e.g. deleted ...)
50         if key not in dict: return True
51         # if mentioned but not linked to a Parameter object, idem
52         if not isinstance(dict[key], Parameter): return True
53         # if not marked ro, it's writable
54         if not dict[key].ro: return True
55
56         return False
57
58
59     def create(self):
60         
61         querystr = "CREATE TABLE " + self.tablename + " ( \
62                 record_id serial PRIMARY KEY , \
63                 hrn text NOT NULL, \
64                 authority text NOT NULL, \
65                 peer_authority text, \
66                 gid text, \
67                 type text NOT NULL, \
68                 pointer integer, \
69                 date_created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP, \
70                 last_updated timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP);"
71         template = "CREATE INDEX %s_%s_idx ON %s (%s);"
72         indexes = [template % ( self.tablename, field, self.tablename, field) \
73                    for field in ['hrn', 'type', 'authority', 'peer_authority', 'pointer']]
74         # IF EXISTS doenst exist in postgres < 8.2
75         try:
76             self.db.do('DROP TABLE IF EXISTS ' + self.tablename)
77         except:
78             try:
79                 self.db.do('DROP TABLE' + self.tablename)
80             except:
81                 pass
82          
83         self.db.do(querystr)
84         for index in indexes:
85             self.db.do(index)
86         
87         self.db.commit()
88     
89     def remove(self, record):
90         params = {'record_id': record['record_id']}
91         template = "DELETE FROM %s " % self.tablename
92         sql = template + "WHERE record_id = %(record_id)s"
93         self.db.do(sql, params)
94         
95         # if this is a site, remove all records where 'authority' == the 
96         # site's hrn
97         if record['type'] == 'authority':
98             params = {'authority': record['hrn']}
99             sql = template + "WHERE authority = %(authority)s"
100             self.db.do(sql, params)
101         self.db.commit() 
102
103     def insert(self, record):
104         db_fields = self.db_fields(record)
105         keys = db_fields.keys()
106         values = [self.db.param(key, value) for (key, value) in db_fields.items()]
107         query_str = "INSERT INTO " + self.tablename + \
108                        "(" + ",".join(keys) + ") " + \
109                        "VALUES(" + ",".join(values) + ")"
110         self.db.do(query_str, db_fields)
111         self.db.commit()
112         result = self.find({'hrn': record['hrn'], 'type': record['type'], 'peer_authority': record['peer_authority']})
113         if not result:
114             record_id = None
115         elif isinstance(result, list):
116             record_id = result[0]['record_id']
117         else:
118             record_id = result['record_id']
119
120         return record_id
121
122     def update(self, record):
123         db_fields = self.db_fields(record)
124         keys = db_fields.keys()
125         values = [self.db.param(key, value) for (key, value) in db_fields.items()]
126         columns = ["%s = %s" % (key, value) for (key, value) in zip(keys, values)]
127         query_str = "UPDATE %s SET %s WHERE record_id = %s" % \
128                     (self.tablename, ", ".join(columns), record['record_id'])
129         self.db.do(query_str, db_fields)
130         self.db.commit()
131
132     def quote_string(self, value):
133         return str(self.db.quote(value))
134
135     def quote(self, value):
136         return self.db.quote(value)
137
138     def find(self, record_filter = None, columns=None):
139         if not columns:
140             columns = "*"
141         else:
142             columns = ",".join(columns)
143         sql = "SELECT %s FROM %s WHERE True " % (columns, self.tablename)
144         
145         if isinstance(record_filter, (list, tuple, set)):
146             ints = filter(lambda x: isinstance(x, (int, long)), record_filter)
147             strs = filter(lambda x: isinstance(x, StringTypes), record_filter)
148             record_filter = Filter(SfaRecord.all_fields, {'record_id': ints, 'hrn': strs})
149             sql += "AND (%s) %s " % record_filter.sql("OR") 
150         elif isinstance(record_filter, dict):
151             record_filter = Filter(SfaRecord.all_fields, record_filter)        
152             sql += " AND (%s) %s" % record_filter.sql("AND")
153         elif isinstance(record_filter, StringTypes):
154             record_filter = Filter(SfaRecord.all_fields, {'hrn':[record_filter]})    
155             sql += " AND (%s) %s" % record_filter.sql("AND")
156         elif isinstance(record_filter, int):
157             record_filter = Filter(SfaRecord.all_fields, {'record_id':[record_filter]})    
158             sql += " AND (%s) %s" % record_filter.sql("AND")
159
160         results = self.db.selectall(sql)
161         if isinstance(results, dict):
162             results = [results]
163         return results
164
165     def findObjects(self, record_filter = None, columns=None):
166         
167         results = self.find(record_filter, columns) 
168         result_rec_list = []
169         for result in results:
170             if result['type'] in ['authority']:
171                 result_rec_list.append(AuthorityRecord(dict=result))
172             elif result['type'] in ['node']:
173                 result_rec_list.append(NodeRecord(dict=result))
174             elif result['type'] in ['slice']:
175                 result_rec_list.append(SliceRecord(dict=result))
176             elif result['type'] in ['user']:
177                 result_rec_list.append(UserRecord(dict=result))
178             else:
179                 result_rec_list.append(SfaRecord(dict=result))
180         return result_rec_list
181
182
183     def drop(self):
184         try:
185             self.db.do('DROP TABLE IF EXISTS ' + self.tablename)
186             self.db.commit()
187         except:
188             try:
189                 self.db.do('DROP TABLE ' + self.tablename)
190                 self.db.commit()
191             except:
192                 pass
193     
194     def sfa_records_purge(self):
195         self.drop()