2023-04-08 17:55:33 +00:00
|
|
|
|
|
|
|
import sqlite3
|
|
|
|
# =================================== Database ==================================================================
|
2023-04-10 08:27:25 +00:00
|
|
|
class DiscussionsDB:
|
2023-04-10 14:14:39 +00:00
|
|
|
MSG_TYPE_NORMAL = 0
|
|
|
|
MSG_TYPE_CONDITIONNING = 1
|
|
|
|
|
2023-04-10 08:27:25 +00:00
|
|
|
def __init__(self, db_path="database.db"):
|
2023-04-08 17:55:33 +00:00
|
|
|
self.db_path = db_path
|
|
|
|
|
2023-04-10 08:27:25 +00:00
|
|
|
def populate(self):
|
|
|
|
"""
|
|
|
|
create database schema
|
|
|
|
"""
|
2023-04-13 15:24:52 +00:00
|
|
|
db_version = 2
|
|
|
|
|
2023-04-10 08:27:25 +00:00
|
|
|
print("Checking discussions database...")
|
2023-04-08 17:55:33 +00:00
|
|
|
with sqlite3.connect(self.db_path) as conn:
|
2023-04-10 08:27:25 +00:00
|
|
|
cursor = conn.cursor()
|
2023-04-10 14:14:39 +00:00
|
|
|
|
|
|
|
discussion_table_exist=False
|
|
|
|
message_table_exist=False
|
2023-04-13 15:24:52 +00:00
|
|
|
schema_table_exist=False
|
|
|
|
|
|
|
|
# Check if the 'schema_version' table exists
|
|
|
|
try:
|
|
|
|
cursor.execute("""
|
|
|
|
CREATE TABLE schema_version (
|
|
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
|
|
version INTEGER NOT NULL
|
|
|
|
)
|
|
|
|
""")
|
|
|
|
except:
|
|
|
|
schema_table_exist = True
|
2023-04-10 14:14:39 +00:00
|
|
|
try:
|
|
|
|
cursor.execute("""
|
|
|
|
CREATE TABLE discussion (
|
|
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
|
|
title TEXT
|
|
|
|
)
|
|
|
|
""")
|
2023-04-13 15:24:52 +00:00
|
|
|
except Exception:
|
2023-04-10 14:14:39 +00:00
|
|
|
discussion_table_exist=True
|
|
|
|
try:
|
|
|
|
cursor.execute("""
|
2023-04-13 15:24:52 +00:00
|
|
|
CREATE TABLE message (
|
2023-04-10 14:14:39 +00:00
|
|
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
|
|
sender TEXT NOT NULL,
|
|
|
|
content TEXT NOT NULL,
|
|
|
|
type INT NOT NULL,
|
|
|
|
rank INT NOT NULL,
|
2023-04-13 15:24:52 +00:00
|
|
|
parent INT,
|
2023-04-10 14:14:39 +00:00
|
|
|
discussion_id INTEGER NOT NULL,
|
|
|
|
FOREIGN KEY (discussion_id) REFERENCES discussion(id)
|
|
|
|
)
|
|
|
|
"""
|
|
|
|
)
|
|
|
|
except :
|
|
|
|
message_table_exist=True
|
|
|
|
|
|
|
|
# Get the current version from the schema_version table
|
|
|
|
cursor.execute("SELECT version FROM schema_version WHERE id = 1")
|
|
|
|
row = cursor.fetchone()
|
|
|
|
if row is None:
|
|
|
|
# If the table is empty, assume version 0
|
|
|
|
version = 0
|
|
|
|
else:
|
|
|
|
# Otherwise, use the version from the table
|
|
|
|
version = row[0]
|
|
|
|
|
|
|
|
# Upgrade the schema to version 1
|
|
|
|
if version < 1:
|
2023-04-13 15:24:52 +00:00
|
|
|
print(f"Upgrading schema to version {db_version}...")
|
2023-04-10 14:14:39 +00:00
|
|
|
# Add the 'created_at' column to the 'message' table
|
|
|
|
if message_table_exist:
|
2023-04-13 15:24:52 +00:00
|
|
|
cursor.execute("ALTER TABLE message ADD COLUMN type INT DEFAULT 0") # Added in V1
|
|
|
|
cursor.execute("ALTER TABLE message ADD COLUMN rank INT DEFAULT 0") # Added in V1
|
|
|
|
cursor.execute("ALTER TABLE message ADD COLUMN parent INT DEFAULT 0") # Added in V2
|
|
|
|
# Upgrade the schema to version 1
|
|
|
|
elif version < 2:
|
|
|
|
print(f"Upgrading schema to version {db_version}...")
|
|
|
|
# Add the 'created_at' column to the 'message' table
|
|
|
|
if message_table_exist:
|
|
|
|
try:
|
|
|
|
cursor.execute("ALTER TABLE message ADD COLUMN parent INT DEFAULT 0") # Added in V2
|
|
|
|
except :
|
|
|
|
pass
|
|
|
|
# Update the schema version
|
|
|
|
if not schema_table_exist:
|
|
|
|
cursor.execute(f"INSERT INTO schema_version (id, version) VALUES (1, {db_version})")
|
|
|
|
else:
|
|
|
|
cursor.execute(f"UPDATE schema_version SET version=? WHERE id=?",(db_version,1))
|
|
|
|
|
2023-04-08 17:55:33 +00:00
|
|
|
conn.commit()
|
|
|
|
|
2023-04-10 14:14:39 +00:00
|
|
|
def select(self, query, params=None, fetch_all=True):
|
2023-04-10 08:27:25 +00:00
|
|
|
"""
|
|
|
|
Execute the specified SQL select query on the database,
|
|
|
|
with optional parameters.
|
|
|
|
Returns the cursor object for further processing.
|
|
|
|
"""
|
|
|
|
with sqlite3.connect(self.db_path) as conn:
|
2023-04-10 14:14:39 +00:00
|
|
|
if params is None:
|
|
|
|
cursor = conn.execute(query)
|
|
|
|
else:
|
|
|
|
cursor = conn.execute(query, params)
|
2023-04-10 08:27:25 +00:00
|
|
|
if fetch_all:
|
|
|
|
return cursor.fetchall()
|
|
|
|
else:
|
|
|
|
return cursor.fetchone()
|
|
|
|
|
|
|
|
|
2023-04-13 10:31:48 +00:00
|
|
|
def delete(self, query, params=None):
|
2023-04-10 08:27:25 +00:00
|
|
|
"""
|
|
|
|
Execute the specified SQL delete query on the database,
|
|
|
|
with optional parameters.
|
|
|
|
Returns the cursor object for further processing.
|
|
|
|
"""
|
|
|
|
with sqlite3.connect(self.db_path) as conn:
|
2023-04-08 17:55:33 +00:00
|
|
|
cursor = conn.cursor()
|
2023-04-13 10:31:48 +00:00
|
|
|
if params is None:
|
|
|
|
cursor.execute(query)
|
|
|
|
else:
|
|
|
|
cursor.execute(query, params)
|
2023-04-08 17:55:33 +00:00
|
|
|
conn.commit()
|
2023-04-10 08:27:25 +00:00
|
|
|
|
|
|
|
def insert(self, query, params=None):
|
|
|
|
"""
|
|
|
|
Execute the specified INSERT SQL query on the database,
|
|
|
|
with optional parameters.
|
|
|
|
Returns the ID of the newly inserted row.
|
|
|
|
"""
|
|
|
|
|
2023-04-08 17:55:33 +00:00
|
|
|
with sqlite3.connect(self.db_path) as conn:
|
2023-04-10 09:02:00 +00:00
|
|
|
cursor = conn.execute(query, params)
|
2023-04-10 08:27:25 +00:00
|
|
|
rowid = cursor.lastrowid
|
2023-04-08 17:55:33 +00:00
|
|
|
conn.commit()
|
2023-04-10 08:27:25 +00:00
|
|
|
self.conn = None
|
|
|
|
return rowid
|
2023-04-08 17:55:33 +00:00
|
|
|
|
2023-04-10 09:02:00 +00:00
|
|
|
def update(self, query, params=None):
|
|
|
|
"""
|
|
|
|
Execute the specified Update SQL query on the database,
|
|
|
|
with optional parameters.
|
|
|
|
Returns the ID of the newly inserted row.
|
|
|
|
"""
|
|
|
|
|
|
|
|
with sqlite3.connect(self.db_path) as conn:
|
|
|
|
conn.execute(query, params)
|
|
|
|
conn.commit()
|
2023-04-10 15:36:26 +00:00
|
|
|
|
|
|
|
def load_last_discussion(self):
|
2023-04-10 19:17:09 +00:00
|
|
|
last_discussion_id = self.select("SELECT id FROM discussion ORDER BY id DESC LIMIT 1", fetch_all=False)
|
2023-04-10 18:58:53 +00:00
|
|
|
if last_discussion_id is None:
|
|
|
|
last_discussion_id = self.create_discussion()
|
|
|
|
else:
|
|
|
|
last_discussion_id=last_discussion_id[0]
|
2023-04-10 15:36:26 +00:00
|
|
|
return Discussion(last_discussion_id, self)
|
|
|
|
|
2023-04-10 08:27:25 +00:00
|
|
|
def create_discussion(self, title="untitled"):
|
|
|
|
"""Creates a new discussion
|
2023-04-08 17:55:33 +00:00
|
|
|
|
2023-04-10 08:27:25 +00:00
|
|
|
Args:
|
|
|
|
title (str, optional): The title of the discussion. Defaults to "untitled".
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
Discussion: A Discussion instance
|
|
|
|
"""
|
2023-04-10 09:02:00 +00:00
|
|
|
discussion_id = self.insert(f"INSERT INTO discussion (title) VALUES (?)",(title,))
|
2023-04-10 08:27:25 +00:00
|
|
|
return Discussion(discussion_id, self)
|
|
|
|
|
|
|
|
def build_discussion(self, discussion_id=0):
|
|
|
|
return Discussion(discussion_id, self)
|
2023-04-08 17:55:33 +00:00
|
|
|
|
2023-04-10 08:27:25 +00:00
|
|
|
def get_discussions(self):
|
2023-04-10 14:14:39 +00:00
|
|
|
rows = self.select("SELECT * FROM discussion")
|
2023-04-10 08:27:25 +00:00
|
|
|
return [{"id": row[0], "title": row[1]} for row in rows]
|
2023-04-08 17:55:33 +00:00
|
|
|
|
2023-04-10 08:27:25 +00:00
|
|
|
def does_last_discussion_have_messages(self):
|
2023-04-10 19:17:09 +00:00
|
|
|
last_discussion_id = self.select("SELECT id FROM discussion ORDER BY id DESC LIMIT 1", fetch_all=False)
|
|
|
|
if last_discussion_id is None:
|
|
|
|
last_discussion_id = self.create_discussion()
|
|
|
|
else:
|
|
|
|
last_discussion_id=last_discussion_id[0]
|
2023-04-10 15:36:26 +00:00
|
|
|
last_message = self.select("SELECT * FROM message WHERE discussion_id=?", (last_discussion_id,), fetch_all=False)
|
2023-04-10 08:27:25 +00:00
|
|
|
return last_message is not None
|
|
|
|
|
|
|
|
def remove_discussions(self):
|
|
|
|
self.delete("DELETE FROM message")
|
|
|
|
self.delete("DELETE FROM discussion")
|
2023-04-08 17:55:33 +00:00
|
|
|
|
|
|
|
|
2023-04-10 08:27:25 +00:00
|
|
|
def export_to_json(self):
|
2023-04-10 09:02:00 +00:00
|
|
|
db_discussions = self.select("SELECT * FROM discussion")
|
2023-04-08 17:55:33 +00:00
|
|
|
discussions = []
|
2023-04-10 09:02:00 +00:00
|
|
|
for row in db_discussions:
|
2023-04-08 17:55:33 +00:00
|
|
|
discussion_id = row[0]
|
|
|
|
discussion = {"id": discussion_id, "messages": []}
|
2023-04-10 19:17:09 +00:00
|
|
|
rows = self.select(f"SELECT * FROM message WHERE discussion_id=?",(discussion_id))
|
2023-04-10 09:02:00 +00:00
|
|
|
for message_row in rows:
|
2023-04-08 17:55:33 +00:00
|
|
|
discussion["messages"].append(
|
|
|
|
{"sender": message_row[1], "content": message_row[2]}
|
|
|
|
)
|
|
|
|
discussions.append(discussion)
|
|
|
|
return discussions
|
|
|
|
|
|
|
|
|
2023-04-10 08:27:25 +00:00
|
|
|
class Discussion:
|
|
|
|
def __init__(self, discussion_id, discussions_db:DiscussionsDB):
|
|
|
|
self.discussion_id = discussion_id
|
|
|
|
self.discussions_db = discussions_db
|
|
|
|
|
2023-04-13 15:55:15 +00:00
|
|
|
def add_message(self, sender, content, message_type=0, rank=0, parent=0):
|
2023-04-10 08:27:25 +00:00
|
|
|
"""Adds a new message to the discussion
|
|
|
|
|
|
|
|
Args:
|
|
|
|
sender (str): The sender name
|
|
|
|
content (str): The text sent by the sender
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
int: The added message id
|
2023-04-08 17:55:33 +00:00
|
|
|
"""
|
2023-04-10 09:02:00 +00:00
|
|
|
message_id = self.discussions_db.insert(
|
2023-04-13 15:55:15 +00:00
|
|
|
"INSERT INTO message (sender, content, type, rank, parent, discussion_id) VALUES (?, ?, ?, ?, ?, ?)",
|
|
|
|
(sender, content, message_type, rank, parent, self.discussion_id)
|
2023-04-08 17:55:33 +00:00
|
|
|
)
|
2023-04-10 08:27:25 +00:00
|
|
|
return message_id
|
|
|
|
|
|
|
|
def rename(self, new_title):
|
|
|
|
"""Renames the discussion
|
|
|
|
|
|
|
|
Args:
|
|
|
|
new_title (str): The nex discussion name
|
2023-04-08 17:55:33 +00:00
|
|
|
"""
|
2023-04-10 09:02:00 +00:00
|
|
|
self.discussions_db.update(
|
2023-04-10 14:18:01 +00:00
|
|
|
f"UPDATE discussion SET title=? WHERE id=?",(new_title,self.discussion_id)
|
2023-04-08 17:55:33 +00:00
|
|
|
)
|
|
|
|
|
2023-04-10 08:27:25 +00:00
|
|
|
def delete_discussion(self):
|
|
|
|
"""Deletes the discussion
|
|
|
|
"""
|
2023-04-10 09:02:00 +00:00
|
|
|
self.discussions_db.delete(
|
2023-04-10 08:27:25 +00:00
|
|
|
f"DELETE FROM message WHERE discussion_id={self.discussion_id}"
|
|
|
|
)
|
2023-04-10 09:02:00 +00:00
|
|
|
self.discussions_db.delete(
|
2023-04-10 08:27:25 +00:00
|
|
|
f"DELETE FROM discussion WHERE id={self.discussion_id}"
|
|
|
|
)
|
|
|
|
|
|
|
|
def get_messages(self):
|
|
|
|
"""Gets a list of messages information
|
|
|
|
|
|
|
|
Returns:
|
2023-04-10 14:14:39 +00:00
|
|
|
list: List of entries in the format {"id":message id, "sender":sender name, "content":message content, "type":message type, "rank": message rank}
|
2023-04-10 08:27:25 +00:00
|
|
|
"""
|
|
|
|
rows = self.discussions_db.select(
|
|
|
|
f"SELECT * FROM message WHERE discussion_id={self.discussion_id}"
|
|
|
|
)
|
2023-04-10 14:14:39 +00:00
|
|
|
return [{"id": row[0], "sender": row[1], "content": row[2], "type": row[3], "rank": row[4]} for row in rows]
|
2023-04-10 08:27:25 +00:00
|
|
|
|
|
|
|
def update_message(self, message_id, new_content):
|
|
|
|
"""Updates the content of a message
|
|
|
|
|
|
|
|
Args:
|
|
|
|
message_id (int): The id of the message to be changed
|
|
|
|
new_content (str): The nex message content
|
|
|
|
"""
|
2023-04-10 09:02:00 +00:00
|
|
|
self.discussions_db.update(
|
2023-04-10 09:14:10 +00:00
|
|
|
f"UPDATE message SET content = ? WHERE id = ?",(new_content,message_id)
|
2023-04-10 08:27:25 +00:00
|
|
|
)
|
2023-04-10 14:14:39 +00:00
|
|
|
|
|
|
|
def message_rank_up(self, message_id):
|
|
|
|
"""Increments the rank of the message
|
2023-04-08 17:55:33 +00:00
|
|
|
|
2023-04-10 14:14:39 +00:00
|
|
|
Args:
|
|
|
|
message_id (int): The id of the message to be changed
|
|
|
|
"""
|
|
|
|
# Retrieve current rank value for message_id
|
|
|
|
current_rank = self.discussions_db.select("SELECT rank FROM message WHERE id=?", (message_id,),False)[0]
|
|
|
|
|
|
|
|
# Increment current rank value by 1
|
|
|
|
new_rank = current_rank + 1
|
|
|
|
self.discussions_db.update(
|
|
|
|
f"UPDATE message SET rank = ? WHERE id = ?",(new_rank,message_id)
|
|
|
|
)
|
|
|
|
return new_rank
|
|
|
|
|
|
|
|
def message_rank_down(self, message_id):
|
|
|
|
"""Increments the rank of the message
|
|
|
|
|
|
|
|
Args:
|
|
|
|
message_id (int): The id of the message to be changed
|
|
|
|
"""
|
|
|
|
# Retrieve current rank value for message_id
|
|
|
|
current_rank = self.discussions_db.select("SELECT rank FROM message WHERE id=?", (message_id,),False)[0]
|
|
|
|
|
|
|
|
# Increment current rank value by 1
|
|
|
|
new_rank = current_rank - 1
|
|
|
|
self.discussions_db.update(
|
|
|
|
f"UPDATE message SET rank = ? WHERE id = ?",(new_rank,message_id)
|
|
|
|
)
|
|
|
|
return new_rank
|
2023-04-13 10:31:48 +00:00
|
|
|
|
|
|
|
def delete_message(self, message_id):
|
|
|
|
"""Delete the message
|
|
|
|
|
|
|
|
Args:
|
|
|
|
message_id (int): The id of the message to be deleted
|
|
|
|
"""
|
|
|
|
# Retrieve current rank value for message_id
|
|
|
|
self.discussions_db.delete("DELETE FROM message WHERE id=?", (message_id,))
|
2023-04-08 17:55:33 +00:00
|
|
|
|
|
|
|
# ========================================================================================================================
|