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):
53 return f(self, *args, **kwargs)
59 def __init__(self, db_obj, table, columns, autotable=True, trans=True):
61 self.autotable = autotable
62 self._con = self._db.connection()
63 self._trans = self._con.begin() if trans else None
64 self._table = self._get_table(table, columns)
66 def _get_table(self, name, columns):
67 table = Table(name, MetaData(self._db.engine()))
69 table.append_column(Column(c, Text()))
72 def _where(self, kvfilter):
74 if kvfilter is not None:
76 w = self._table.columns[k] == kvfilter[k]
83 def _columns(self, columns=None):
85 if columns is not None:
88 cols.append(self._table.columns[c])
90 cols = self._table.columns
94 self._trans.rollback()
100 self._table.create(checkfirst=True)
103 self._table.drop(checkfirst=True)
106 def select(self, kvfilter=None, columns=None):
107 return self._con.execute(select(self._columns(columns),
108 self._where(kvfilter)))
111 def insert(self, values):
112 self._con.execute(self._table.insert(values))
115 def update(self, values, kvfilter):
116 self._con.execute(self._table.update(self._where(kvfilter), values))
119 def delete(self, kvfilter):
120 self._con.execute(self._table.delete(self._where(kvfilter)))
125 def __init__(self, config_name):
126 self._db = SqlStore(config_name)
127 self._query = SqlQuery
129 def _row_to_dict_tree(self, data, row):
135 self._row_to_dict_tree(d2, row[1:])
139 if data[name] is list:
140 data[name].append(value)
143 data[name] = [v, value]
147 def _rows_to_dict_tree(self, rows):
150 self._row_to_dict_tree(data, r)
153 def _load_data(self, table, columns, kvfilter=None):
156 q = self._query(self._db, table, columns, trans=False)
157 rows = q.select(kvfilter)
158 except Exception, e: # pylint: disable=broad-except
159 self.error("Failed to load data for table %s: [%s]" % (table, e))
160 return self._rows_to_dict_tree(rows)
162 def load_config(self):
164 columns = ['name', 'value']
165 return self._load_data(table, columns)
167 def load_options(self, table, name=None):
170 kvfilter['name'] = name
171 options = self._load_data(table, OPTIONS_COLUMNS, kvfilter)
172 if name and name in options:
176 def save_options(self, table, name, options):
180 q = self._query(self._db, table, OPTIONS_COLUMNS)
181 rows = q.select({'name': name}, ['option', 'value'])
183 curvals[row[0]] = row[1]
187 q.update({'value': options[opt]},
188 {'name': name, 'option': opt})
190 q.insert((name, opt, options[opt]))
193 except Exception, e: # pylint: disable=broad-except
196 self.error("Failed to save options: [%s]" % e)
199 def delete_options(self, table, name, options=None):
200 kvfilter = {'name': name}
203 q = self._query(self._db, table, OPTIONS_COLUMNS)
208 kvfilter['option'] = opt
211 except Exception, e: # pylint: disable=broad-except
214 self.error("Failed to delete from %s: [%s]" % (table, e))
217 def new_unique_data(self, table, data):
218 newid = str(uuid.uuid4())
221 q = self._query(self._db, table, UNIQUE_DATA_COLUMNS)
223 q.insert((newid, name, data[name]))
225 except Exception, e: # pylint: disable=broad-except
228 self.error("Failed to store %s data: [%s]" % (table, e))
232 def get_unique_data(self, table, uuidval=None, name=None, value=None):
235 kvfilter['uuid'] = uuidval
237 kvfilter['name'] = name
239 kvfilter['value'] = value
240 return self._load_data(table, UNIQUE_DATA_COLUMNS, kvfilter)
242 def save_unique_data(self, table, data):
245 q = self._query(self._db, table, UNIQUE_DATA_COLUMNS)
248 rows = q.select({'uuid': uid}, ['name', 'value'])
255 q.update({'value': datum[name]},
256 {'uuid': uid, 'name': name})
258 q.insert((uid, name, datum[name]))
261 except Exception, e: # pylint: disable=broad-except
264 self.error("Failed to store data in %s: [%s]" % (table, e))
267 def del_unique_data(self, table, uuidval):
268 kvfilter = {'uuid': uuidval}
270 q = self._query(self._db, table, UNIQUE_DATA_COLUMNS, trans=False)
272 except Exception, e: # pylint: disable=broad-except
273 self.error("Failed to delete data from %s: [%s]" % (table, e))
275 def _reset_data(self, table):
277 q = self._query(self._db, table, UNIQUE_DATA_COLUMNS)
281 except Exception, e: # pylint: disable=broad-except
284 self.error("Failed to erase all data from %s: [%s]" % (table, e))
287 class AdminStore(Store):
290 super(AdminStore, self).__init__('admin.config.db')
292 def get_data(self, plugin, idval=None, name=None, value=None):
293 return self.get_unique_data(plugin+"_data", idval, name, value)
295 def save_data(self, plugin, data):
296 return self.save_unique_data(plugin+"_data", data)
298 def new_datum(self, plugin, datum):
299 table = plugin+"_data"
300 return self.new_unique_data(table, datum)
302 def del_datum(self, plugin, idval):
303 table = plugin+"_data"
304 return self.del_unique_data(table, idval)
306 def wipe_data(self, plugin):
307 table = plugin+"_data"
308 self._reset_data(table)
311 class UserStore(Store):
313 def __init__(self, path=None):
314 super(UserStore, self).__init__('user.prefs.db')
316 def save_user_preferences(self, user, options):
317 self.save_options('users', user, options)
319 def load_user_preferences(self, user):
320 return self.load_options('users', user)
322 def save_plugin_data(self, plugin, user, options):
323 self.save_options(plugin+"_data", user, options)
325 def load_plugin_data(self, plugin, user):
326 return self.load_options(plugin+"_data", user)
329 class TranStore(Store):
331 def __init__(self, path=None):
332 super(TranStore, self).__init__('transactions.db')