#!/usr/bin/env python # coding=utf-8 from __future__ import unicode_literals, absolute_import, print_function, division # sopel imports import sopel.module from sopel.tools import Identifier import sopel.db from sopel.db import SopelDB, NickValues, ChannelValues, _deserialize from sqlalchemy import Column, String from sqlalchemy.exc import SQLAlchemyError from sqlalchemy.ext.declarative import declarative_base import json import sopel_modules.SpiceBot as SpiceBot BASE = declarative_base() def setup(bot): # Inject Database Functions SpiceBot.logs.log('SpiceBot_Databaseaddons', "Implanting Database functions into bot") sopel.db.PluginValues = PluginValues SopelDB.delete_nick_value = SopelDBAddon.delete_nick_value SopelDB.adjust_nick_value = SopelDBAddon.adjust_nick_value SopelDB.delete_channel_value = SopelDBAddon.delete_channel_value SopelDB.adjust_channel_value = SopelDBAddon.adjust_channel_value SopelDB.get_plugin_value = SopelDBAddon.get_plugin_value SopelDB.set_plugin_value = SopelDBAddon.set_plugin_value SopelDB.delete_plugin_value = SopelDBAddon.delete_plugin_value SopelDB.adjust_plugin_value = SopelDBAddon.adjust_plugin_value class PluginValues(BASE): """ PluginValues SQLAlchemy Class """ __tablename__ = 'plugin_values' plugin = Column(String(255), primary_key=True) key = Column(String(255), primary_key=True) value = Column(String(255)) class SopelDBAddon: """Nicks""" def delete_nick_value(self, nick, key): """Deletes the value for a given key to be associated with the nick.""" nick = Identifier(nick) nick_id = self.get_nick_id(nick) session = self.ssession() try: result = session.query(NickValues) \ .filter(NickValues.nick_id == nick_id) \ .filter(NickValues.key == key) \ .one_or_none() # NickValue exists, delete if result: session.delete(result) session.commit() except SQLAlchemyError: session.rollback() raise finally: session.close() def adjust_nick_value(self, nick, key, value): """Sets the value for a given key to be associated with the nick.""" nick = Identifier(nick) value = json.dumps(value, ensure_ascii=False) nick_id = self.get_nick_id(nick) session = self.ssession() try: result = session.query(NickValues) \ .filter(NickValues.nick_id == nick_id) \ .filter(NickValues.key == key) \ .one_or_none() # NickValue exists, update if result: result.value = result.value + value session.commit() # DNE - Insert else: new_nickvalue = NickValues(nick_id=nick_id, key=key, value=value) session.add(new_nickvalue) session.commit() except SQLAlchemyError: session.rollback() raise finally: session.close() """Channels""" def delete_channel_value(self, channel, key): """Sets the value for a given key to be associated with the channel.""" channel = Identifier(channel).lower() session = self.ssession() try: result = session.query(ChannelValues) \ .filter(ChannelValues.channel == channel)\ .filter(ChannelValues.key == key) \ .one_or_none() # ChannelValue exists, delete if result: session.delete(result) session.commit() except SQLAlchemyError: session.rollback() raise finally: session.close() def adjust_channel_value(self, channel, key, value): """Sets the value for a given key to be associated with the channel.""" channel = Identifier(channel).lower() value = json.dumps(value, ensure_ascii=False) session = self.ssession() try: result = session.query(ChannelValues) \ .filter(ChannelValues.channel == channel)\ .filter(ChannelValues.key == key) \ .one_or_none() # ChannelValue exists, update if result: result.value = result.value + value session.commit() # DNE - Insert else: new_channelvalue = ChannelValues(channel=channel, key=key, value=value) session.add(new_channelvalue) session.commit() except SQLAlchemyError: session.rollback() raise finally: session.close() # PLUGIN FUNCTIONS def set_plugin_value(self, plugin, key, value): """Sets the value for a given key to be associated with the plugin.""" plugin = Identifier(plugin).lower() value = json.dumps(value, ensure_ascii=False) session = self.ssession() try: result = session.query(PluginValues) \ .filter(PluginValues.plugin == plugin)\ .filter(PluginValues.key == key) \ .one_or_none() # PluginValues exists, update if result: result.value = value session.commit() # DNE - Insert else: new_pluginvalue = PluginValues(plugin=plugin, key=key, value=value) session.add(new_pluginvalue) session.commit() except SQLAlchemyError: session.rollback() raise finally: session.close() def get_plugin_value(self, plugin, key): """Retrieves the value for a given key associated with a plugin.""" plugin = Identifier(plugin).lower() session = self.ssession() try: result = session.query(PluginValues) \ .filter(PluginValues.plugin == plugin)\ .filter(PluginValues.key == key) \ .one_or_none() if result is not None: result = result.value return _deserialize(result) except SQLAlchemyError: session.rollback() raise finally: session.close() def adjust_plugin_value(self, plugin, key, value): """Sets the value for a given key to be associated with the plugin.""" plugin = Identifier(plugin).lower() value = json.dumps(value, ensure_ascii=False) session = self.ssession() try: result = session.query(PluginValues) \ .filter(PluginValues.plugin == plugin)\ .filter(PluginValues.key == key) \ .one_or_none() # ChannelValue exists, update if result: result.value = result.value + value session.commit() # DNE - Insert else: new_pluginvalue = PluginValues(plugin=plugin, key=key, value=value) session.add(new_pluginvalue) session.commit() except SQLAlchemyError: session.rollback() raise finally: session.close() def delete_plugin_value(self, plugin, key): """Deletes the value for a given key to be associated with the plugin.""" plugin = Identifier(plugin).lower() session = self.ssession() try: result = session.query(PluginValues) \ .filter(PluginValues.plugin == plugin)\ .filter(PluginValues.key == key) \ .one_or_none() # PluginValues exists, delete if result: session.delete(result) session.commit() except SQLAlchemyError: session.rollback() raise finally: session.close()