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