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