bitbot-3.11-fork/src/Database.py

430 lines
19 KiB
Python
Raw Normal View History

import json, os, sqlite3, threading, time, typing
from src import Logging, utils
2016-03-29 11:56:58 +00:00
sqlite3.register_converter("BOOLEAN", lambda v: bool(int(v)))
class Table(object):
def __init__(self, database):
self.database = database
2016-03-29 11:56:58 +00:00
class Servers(Table):
def add(self, alias: str, hostname: str, port: int, password: str,
tls: bool, bindhost: str, nickname: str, username: str=None,
realname: str=None):
username = username or nickname
realname = realname or nickname
self.database.execute(
"""INSERT INTO servers (alias, hostname, port, password, tls,
bindhost, nickname, username, realname) VALUES (
?, ?, ?, ?, ?, ?, ?, ?, ?)""",
[alias, hostname, port, password, tls, bindhost, nickname, username,
realname])
return self.database.execute_fetchone(
"SELECT server_id FROM servers ORDER BY server_id DESC LIMIT 1")[0]
2019-07-12 08:30:22 +00:00
def by_alias(self, alias: str) -> typing.Optional[int]:
ids = self.database.execute_fetchone(
"SELECT server_id FROM servers WHERE alias=?", [alias])
return ids[0] if ids else None
def get_all(self):
return self.database.execute_fetchall(
"SELECT server_id, alias FROM servers")
def get(self, id: int)-> typing.Tuple[int, typing.Optional[str], str,
int, typing.Optional[str], bool, bool, typing.Optional[str], str,
typing.Optional[str], typing.Optional[str]]:
return self.database.execute_fetchone(
"""SELECT server_id, alias, hostname, port, password, tls,
bindhost, nickname, username, realname FROM servers WHERE
server_id=?""",
[id])
def get_by_alias(self, alias: str) -> typing.Optional[int]:
value = self.database.execute_fetchone(
"SELECT server_id FROM servers WHERE alias=? COLLATE NOCASE",
[alias])
if value:
return value[0]
return value
2019-07-04 12:15:51 +00:00
def edit(self, id: int, column: str, value: typing.Any):
if not column in ["alias", "hostname", "port", "password", "tls",
"bindhost", "nickname", "username", "realname"]:
raise ValueError("Unknown column on servers table '%s'" % column)
self.database.execute(
"UPDATE servers SET %s=? WHERE server_id=?" % column, [value, id])
2019-07-12 08:30:22 +00:00
def delete(self, id: int):
self.database.execute("DELETE FROM servers WHERE server_id=?", [id])
2016-03-29 11:56:58 +00:00
class Channels(Table):
def add(self, server_id: int, name: str):
self.database.execute("""INSERT OR IGNORE INTO channels
(server_id, name) VALUES (?, ?)""",
[server_id, name.lower()])
return self.database.execute_fetchone(
"SELECT channel_id FROM channels ORDER BY channel_id DESC LIMIT 1")[0]
def delete(self, channel_id: int):
self.database.execute("DELETE FROM channels WHERE channel_id=?",
[channel_id])
def get_id(self, server_id: int, name: str):
value = self.database.execute_fetchone("""SELECT channel_id FROM
channels WHERE server_id=? AND name=?""",
[server_id, name.lower()])
return value if value == None else value[0]
def rename(self, channel_id: int, new_name: str):
self.database.execute("UPDATE channels SET name=? where channel_id=?",
[new_name.lower(), channel_id])
class Users(Table):
def add(self, server_id: int, nickname: str):
self.database.execute("""INSERT OR IGNORE INTO users
(server_id, nickname) VALUES (?, ?)""",
[server_id, nickname])
def delete(self, user_id: int):
self.database.execute("DELETE FROM users WHERE user_id=?",
[user_id])
def get_id(self, server_id: int, nickname: str):
value = self.database.execute_fetchone("""SELECT user_id FROM
users WHERE server_id=? and nickname=?""",
[server_id, nickname])
return value if value == None else value[0]
class BotSettings(Table):
def set(self, setting: str, value: typing.Any):
self.database.execute(
"INSERT OR REPLACE INTO bot_settings VALUES (?, ?)",
[setting.lower(), json.dumps(value)])
def get(self, setting: str, default: typing.Any=None):
value = self.database.execute_fetchone(
"SELECT value FROM bot_settings WHERE setting=?",
[setting.lower()])
if value:
return json.loads(value[0])
return default
def find(self, pattern: str, default: typing.Any=[]):
values = self.database.execute_fetchall(
"SELECT setting, value FROM bot_settings WHERE setting LIKE ?",
[pattern.lower()])
if values:
for i, value in enumerate(values):
values[i] = value[0], json.loads(value[1])
return values
return default
def find_prefix(self, prefix: str, default: typing.Any=[]):
return self.find("%s%%" % prefix, default)
def delete(self, setting: str):
self.database.execute(
"DELETE FROM bot_settings WHERE setting=?",
[setting.lower()])
class ServerSettings(Table):
def set(self, server_id: int, setting: str, value: typing.Any):
self.database.execute(
"INSERT OR REPLACE INTO server_settings VALUES (?, ?, ?)",
[server_id, setting.lower(), json.dumps(value)])
def get(self, server_id: int, setting: str, default: typing.Any=None):
value = self.database.execute_fetchone(
"""SELECT value FROM server_settings WHERE
server_id=? AND setting=?""",
[server_id,setting.lower()])
2016-03-29 11:56:58 +00:00
if value:
return json.loads(value[0])
return default
def find(self, server_id: int, pattern: str, default: typing.Any=[]):
values = self.database.execute_fetchall(
"""SELECT setting, value FROM server_settings WHERE
server_id=? AND setting LIKE ?""",
[server_id, pattern.lower()])
2016-03-29 11:56:58 +00:00
if values:
for i, value in enumerate(values):
values[i] = value[0], json.loads(value[1])
return values
return default
def find_prefix(self, server_id: int, prefix: str, default: typing.Any=[]):
return self.find(server_id, "%s%%" % prefix, default)
def delete(self, server_id: int, setting: str):
self.database.execute(
"DELETE FROM server_settings WHERE server_id=? AND setting=?",
[server_id, setting.lower()])
2016-03-29 11:56:58 +00:00
class ChannelSettings(Table):
def set(self, channel_id: int, setting: str, value: typing.Any):
self.database.execute(
"INSERT OR REPLACE INTO channel_settings VALUES (?, ?, ?)",
[channel_id, setting.lower(), json.dumps(value)])
def get(self, channel_id: int, setting: str, default: typing.Any=None):
value = self.database.execute_fetchone(
"""SELECT value FROM channel_settings WHERE
channel_id=? AND setting=?""", [channel_id, setting.lower()])
2016-03-29 11:56:58 +00:00
if value:
return json.loads(value[0])
return default
def find(self, channel_id: int, pattern: str, default: typing.Any=[]):
values = self.database.execute_fetchall(
"""SELECT setting, value FROM channel_settings WHERE
2019-06-17 16:51:27 +00:00
channel_id=? AND setting LIKE ?""", [channel_id, pattern.lower()])
2016-03-29 11:56:58 +00:00
if values:
for i, value in enumerate(values):
values[i] = value[0], json.loads(value[1])
2016-03-29 11:56:58 +00:00
return values
return default
def find_prefix(self, channel_id: int, prefix: str, default: typing.Any=[]):
return self.find(channel_id, "%s%%" % prefix,
default)
def delete(self, channel_id: int, setting: str):
self.database.execute(
"""DELETE FROM channel_settings WHERE channel_id=?
AND setting=?""", [channel_id, setting.lower()])
2016-03-29 11:56:58 +00:00
def find_by_setting(self, setting: str, default: typing.Any=[]):
values = self.database.execute_fetchall(
"""SELECT channels.server_id, channels.name,
channel_settings.value FROM channel_settings
INNER JOIN channels ON
channel_settings.channel_id=channels.channel_id
WHERE channel_settings.setting=?""", [setting])
if values:
for i, value in enumerate(values):
values[i] = value[0], value[1], json.loads(value[2])
return values
return default
class UserSettings(Table):
def set(self, user_id: int, setting: str, value: typing.Any):
self.database.execute(
"INSERT OR REPLACE INTO user_settings VALUES (?, ?, ?)",
[user_id, setting.lower(), json.dumps(value)])
def get(self, user_id: int, setting: str, default: typing.Any=None):
value = self.database.execute_fetchone(
"""SELECT value FROM user_settings WHERE
user_id=? and setting=?""", [user_id, setting.lower()])
2016-03-29 11:56:58 +00:00
if value:
return json.loads(value[0])
return default
def find_all_by_setting(self, server_id: int, setting: str,
default: typing.Any=[]):
values = self.database.execute_fetchall(
"""SELECT users.nickname, user_settings.value FROM
user_settings INNER JOIN users ON
user_settings.user_id=users.user_id WHERE
users.server_id=? AND user_settings.setting=?""",
[server_id, setting])
if values:
for i, value in enumerate(values):
values[i] = value[0], json.loads(value[1])
return values
return default
def find(self, user_id: int, pattern: str, default: typing.Any=[]):
values = self.database.execute(
"""SELECT setting, value FROM user_settings WHERE
user_id=? AND setting LIKE '?'""", [user_id, pattern.lower()])
2016-03-29 11:56:58 +00:00
if values:
for i, value in enumerate(values):
values[i] = value[0], json.loads(value[1])
2016-03-29 11:56:58 +00:00
return values
return default
def find_prefix(self, user_id: int, prefix: str, default: typing.Any=[]):
return self.find(user_id, "%s%%" % prefix, default)
def delete(self, user_id: int, setting: str):
self.database.execute(
"""DELETE FROM user_settings WHERE
user_id=? AND setting=?""", [user_id, setting.lower()])
2016-03-29 11:56:58 +00:00
class UserChannelSettings(Table):
def set(self, user_id: int, channel_id: int, setting: str,
value: typing.Any):
self.database.execute(
"""INSERT OR REPLACE INTO user_channel_settings VALUES
(?, ?, ?, ?)""",
[user_id, channel_id, setting.lower(), json.dumps(value)])
def get(self, user_id: int, channel_id: int, setting: str,
default: typing.Any=None):
value = self.database.execute_fetchone(
"""SELECT value FROM user_channel_settings WHERE
user_id=? AND channel_id=? AND setting=?""",
[user_id, channel_id, setting.lower()])
if value:
return json.loads(value[0])
return default
def find(self, user_id: int, channel_id: int, pattern: str,
default: typing.Any=[]):
values = self.database.execute_fetchall(
"""SELECT setting, value FROM user_channel_settings WHERE
user_id=? AND channel_id=? AND setting LIKE '?'""",
[user_id, channel_id, pattern.lower()])
if values:
for i, value in enumerate(values):
values[i] = value[0], json.loads(value[1])
return values
return default
def find_prefix(self, user_id: int, channel_id: int, prefix: str,
default: typing.Any=[]):
return self.find(user_id, channel_id, "%s%%" % prefix,
default)
def find_by_setting(self, user_id: int, setting: str,
default: typing.Any=[]):
values = self.database.execute_fetchall(
"""SELECT channels.name, user_channel_settings.value FROM
user_channel_settings INNER JOIN channels ON
user_channel_settings.channel_id=channels.channel_id
WHERE user_channel_settings.setting=?
AND user_channel_settings.user_id=?""", [setting, user_id])
if values:
for i, value in enumerate(values):
values[i] = value[0], json.loads(value[1])
return values
return default
def find_all_by_setting(self, server_id: int, setting: str,
default: typing.Any=[]):
values = self.database.execute_fetchall(
"""SELECT channels.name, users.nickname,
user_channel_settings.value FROM
user_channel_settings INNER JOIN channels ON
user_channel_settings.channel_id=channels.channel_id
2018-08-31 15:02:48 +00:00
INNER JOIN users on user_channel_settings.user_id=users.user_id
WHERE user_channel_settings.setting=? AND
users.server_id=?""", [setting, server_id])
if values:
for i, value in enumerate(values):
values[i] = value[0], value[1], json.loads(value[2])
return values
return default
def delete(self, user_id: int, channel_id: int, setting: str):
self.database.execute(
"""DELETE FROM user_channel_settings WHERE
user_id=? AND channel_id=? AND setting=?""",
[user_id, channel_id, setting.lower()])
class Database(object):
def __init__(self, log: "Logging.Log", location: str):
self.log = log
self.location = location
self.database = sqlite3.connect(self.location,
check_same_thread=False, isolation_level=None,
detect_types=sqlite3.PARSE_DECLTYPES)
self.database.execute("PRAGMA foreign_keys = ON")
self._cursor = None
self._lock = threading.Lock()
self.make_servers_table()
self.make_channels_table()
self.make_users_table()
self.make_bot_settings_table()
self.make_server_settings_table()
self.make_channel_settings_table()
self.make_user_settings_table()
self.make_user_channel_settings_table()
self.servers = Servers(self)
self.channels = Channels(self)
self.users = Users(self)
self.bot_settings = BotSettings(self)
self.server_settings = ServerSettings(self)
self.channel_settings = ChannelSettings(self)
self.user_settings = UserSettings(self)
self.user_channel_settings = UserChannelSettings(self)
def cursor(self):
if self._cursor == None:
self._cursor = self.database.cursor()
return self._cursor
def _execute_fetch(self, query: str,
fetch_func: typing.Callable[[sqlite3.Cursor], typing.Any],
params: typing.List=[]):
if not utils.is_main_thread():
raise RuntimeError("Can't access Database outside of main thread")
printable_query = " ".join(query.split())
start = time.monotonic()
cursor = self.cursor()
with self._lock:
cursor.execute(query, params)
value = fetch_func(cursor)
end = time.monotonic()
total_milliseconds = (end - start) * 1000
self.log.trace("executed query in %fms: \"%s\" (params: %s)",
[total_milliseconds, printable_query, params])
return value
def execute_fetchall(self, query: str, params: typing.List=[]):
return self._execute_fetch(query,
lambda cursor: cursor.fetchall(), params)
def execute_fetchone(self, query: str, params: typing.List=[]):
return self._execute_fetch(query,
lambda cursor: cursor.fetchone(), params)
def execute(self, query: str, params: typing.List=[]):
return self._execute_fetch(query, lambda cursor: None, params)
def has_table(self, table_name: str):
result = self.execute_fetchone("""SELECT COUNT(*) FROM
sqlite_master WHERE type='table' AND name=?""",
[table_name])
return result[0] == 1
def make_servers_table(self):
if not self.has_table("servers"):
self.execute("""CREATE TABLE servers
(server_id INTEGER PRIMARY KEY, alias TEXT, hostname TEXT,
port INTEGER, password TEXT, tls BOOLEAN,
bindhost TEXT, nickname TEXT, username TEXT, realname TEXT,
UNIQUE (alias))""")
def make_channels_table(self):
if not self.has_table("channels"):
self.execute("""CREATE TABLE channels
(channel_id INTEGER PRIMARY KEY, server_id INTEGER,
name TEXT, FOREIGN KEY (server_id) REFERENCES
servers (server_id) ON DELETE CASCADE,
UNIQUE (server_id, name))""")
self.execute("""CREATE INDEX channels_index
on channels (server_id, name)""")
def make_users_table(self):
if not self.has_table("users"):
self.execute("""CREATE TABLE users
(user_id INTEGER PRIMARY KEY, server_id INTEGER,
nickname TEXT, FOREIGN KEY (server_id) REFERENCES
servers (server_id) ON DELETE CASCADE,
UNIQUE (server_id, nickname))""")
self.execute("""CREATE INDEX users_index
on users (server_id, nickname)""")
def make_bot_settings_table(self):
if not self.has_table("bot_settings"):
self.execute("""CREATE TABLE bot_settings
(setting TEXT PRIMARY KEY, value TEXT)""")
self.execute("""CREATE INDEX bot_settings_index
ON bot_settings (setting)""")
def make_server_settings_table(self):
if not self.has_table("server_settings"):
self.execute("""CREATE TABLE server_settings
(server_id INTEGER, setting TEXT, value TEXT,
FOREIGN KEY(server_id) REFERENCES
servers(server_id) ON DELETE CASCADE,
PRIMARY KEY (server_id, setting))""")
self.execute("""CREATE INDEX server_settings_index
ON server_settings (server_id, setting)""")
def make_channel_settings_table(self):
if not self.has_table("channel_settings"):
self.execute("""CREATE TABLE channel_settings
(channel_id INTEGER, setting TEXT, value TEXT,
FOREIGN KEY (channel_id) REFERENCES channels(channel_id)
ON DELETE CASCADE, PRIMARY KEY (channel_id, setting))""")
self.execute("""CREATE INDEX channel_settings_index
ON channel_settings (channel_id, setting)""")
def make_user_settings_table(self):
if not self.has_table("user_settings"):
self.execute("""CREATE TABLE user_settings
(user_id INTEGER, setting TEXT, value TEXT,
FOREIGN KEY (user_id) REFERENCES users(user_id)
ON DELETE CASCADE, PRIMARY KEY (user_id, setting))""")
self.execute("""CREATE INDEX user_settings_index ON
user_settings (user_id, setting)""")
def make_user_channel_settings_table(self):
if not self.has_table("user_channel_settings"):
self.execute("""CREATE TABLE user_channel_settings
(user_id INTEGER, channel_id INTEGER, setting TEXT,
value TEXT, FOREIGN KEY (user_id) REFERENCES
users(user_id) ON DELETE CASCADE, FOREIGN KEY
(channel_id) REFERENCES channels(channel_id) ON
DELETE CASCADE, PRIMARY KEY (user_id, channel_id,
setting))""")
self.execute("""CREATE INDEX user_channel_settings_index
ON user_channel_settings (user_id, channel_id, setting)""")