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