3 # Copyright (C) 2013 Simo Sorce <simo@redhat.com>
5 # see file 'COPYING' for use and warranty information
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 from ipsilon.util.log import Log
22 from sqlalchemy import create_engine
23 from sqlalchemy import MetaData, Table, Column, Text
24 from sqlalchemy.sql import select
28 OPTIONS_COLUMNS = ['name', 'option', 'value']
29 UNIQUE_DATA_COLUMNS = ['uuid', 'name', 'value']
34 def __init__(self, name):
35 if name not in cherrypy.config:
36 raise NameError('Unknown database %s' % name)
37 engine_name = cherrypy.config[name]
38 if '://' not in engine_name:
39 engine_name = 'sqlite:///' + engine_name
40 self._dbengine = create_engine(engine_name)
46 return self._dbengine.connect()
50 def at(self, *args, **kwargs):
52 return f(self, *args, **kwargs)
58 def __init__(self, db_obj, table, columns, trans=True):
60 self._con = self._db.connection()
61 self._trans = self._con.begin() if trans else None
62 self._table = self._get_table(table, columns)
64 def _get_table(self, name, columns):
65 table = Table(name, MetaData(self._db.engine()))
67 table.append_column(Column(c, Text()))
70 def _where(self, kvfilter):
72 if kvfilter is not None:
74 w = self._table.columns[k] == kvfilter[k]
81 def _columns(self, columns=None):
83 if columns is not None:
86 cols.append(self._table.columns[c])
88 cols = self._table.columns
92 self._trans.rollback()
98 self._table.create(checkfirst=True)
101 self._table.drop(checkfirst=True)
104 def select(self, kvfilter=None, columns=None):
105 return self._con.execute(select(self._columns(columns),
106 self._where(kvfilter)))
109 def insert(self, values):
110 self._con.execute(self._table.insert(values))
113 def update(self, values, kvfilter):
114 self._con.execute(self._table.update(self._where(kvfilter), values))
117 def delete(self, kvfilter):
118 self._con.execute(self._table.delete(self._where(kvfilter)))
123 def __init__(self, config_name):
124 self._db = SqlStore(config_name)
125 self._query = SqlQuery
127 def _row_to_dict_tree(self, data, row):
133 self._row_to_dict_tree(d2, row[1:])
137 if data[name] is list:
138 data[name].append(value)
141 data[name] = [v, value]
145 def _rows_to_dict_tree(self, rows):
148 self._row_to_dict_tree(data, r)
151 def _load_data(self, table, columns, kvfilter=None):
154 q = self._query(self._db, table, columns, trans=False)
155 rows = q.select(kvfilter)
156 except Exception, e: # pylint: disable=broad-except
157 self.error("Failed to load data for table %s: [%s]" % (table, e))
158 return self._rows_to_dict_tree(rows)
160 def load_config(self):
162 columns = ['name', 'value']
163 return self._load_data(table, columns)
165 def load_options(self, table, name=None):
168 kvfilter['name'] = name
169 options = self._load_data(table, OPTIONS_COLUMNS, kvfilter)
170 if name and name in options:
174 def save_options(self, table, name, options):
178 q = self._query(self._db, table, OPTIONS_COLUMNS)
179 rows = q.select({'name': name}, ['option', 'value'])
181 curvals[row[0]] = row[1]
185 q.update({'value': options[opt]},
186 {'name': name, 'option': opt})
188 q.insert((name, opt, options[opt]))
191 except Exception, e: # pylint: disable=broad-except
194 self.error("Failed to save options: [%s]" % e)
197 def delete_options(self, table, name, options=None):
198 kvfilter = {'name': name}
201 q = self._query(self._db, table, OPTIONS_COLUMNS)
206 kvfilter['option'] = opt
209 except Exception, e: # pylint: disable=broad-except
212 self.error("Failed to delete from %s: [%s]" % (table, e))
215 def new_unique_data(self, table, data):
216 newid = str(uuid.uuid4())
219 q = self._query(self._db, table, UNIQUE_DATA_COLUMNS)
221 q.insert((newid, name, data[name]))
223 except Exception, e: # pylint: disable=broad-except
226 self.error("Failed to store %s data: [%s]" % (table, e))
230 def get_unique_data(self, table, uuidval=None, name=None, value=None):
233 kvfilter['uuid'] = uuidval
235 kvfilter['name'] = name
237 kvfilter['value'] = value
238 return self._load_data(table, UNIQUE_DATA_COLUMNS, kvfilter)
240 def save_unique_data(self, table, data):
243 q = self._query(self._db, table, UNIQUE_DATA_COLUMNS)
246 rows = q.select({'uuid': uid}, ['name', 'value'])
253 q.update({'value': datum[name]},
254 {'uuid': uid, 'name': name})
256 q.insert((uid, name, datum[name]))
259 except Exception, e: # pylint: disable=broad-except
262 self.error("Failed to store data in %s: [%s]" % (table, e))
265 def del_unique_data(self, table, uuidval):
266 kvfilter = {'uuid': uuidval}
268 q = self._query(self._db, table, UNIQUE_DATA_COLUMNS, trans=False)
270 except Exception, e: # pylint: disable=broad-except
271 self.error("Failed to delete data from %s: [%s]" % (table, e))
273 def _reset_data(self, table):
275 q = self._query(self._db, table, UNIQUE_DATA_COLUMNS)
279 except Exception, e: # pylint: disable=broad-except
282 self.error("Failed to erase all data from %s: [%s]" % (table, e))
285 class AdminStore(Store):
288 super(AdminStore, self).__init__('admin.config.db')
290 def get_data(self, plugin, idval=None, name=None, value=None):
291 return self.get_unique_data(plugin+"_data", idval, name, value)
293 def save_data(self, plugin, data):
294 return self.save_unique_data(plugin+"_data", data)
296 def new_datum(self, plugin, datum):
297 table = plugin+"_data"
298 return self.new_unique_data(table, datum)
300 def del_datum(self, plugin, idval):
301 table = plugin+"_data"
302 return self.del_unique_data(table, idval)
304 def wipe_data(self, plugin):
305 table = plugin+"_data"
306 self._reset_data(table)
309 class UserStore(Store):
311 def __init__(self, path=None):
312 super(UserStore, self).__init__('user.prefs.db')
314 def save_user_preferences(self, user, options):
315 self.save_options('users', user, options)
317 def load_user_preferences(self, user):
318 return self.load_options('users', user)
320 def save_plugin_data(self, plugin, user, options):
321 self.save_options(plugin+"_data", user, options)
323 def load_plugin_data(self, plugin, user):
324 return self.load_options(plugin+"_data", user)
327 class TranStore(Store):
329 def __init__(self, path=None):
330 super(TranStore, self).__init__('transactions.db')