Overhaul database code

backend/database.py

@@ -2,7 +2,7 @@
 
 from email.mime import base
 from MySQLdb import Connection
-from sqlalchemy import create_engine, engine
+from sqlalchemy import create_engine, engine, text
 import pandas
 from io import StringIO
 from flask import current_app
@@ -19,7 +19,8 @@ def get_db_engine() -> engine.base.Engine:
     global sql_engine
     if (not sql_engine):
         print(current_app.config.get("DBCONNSTRING"))
-        sql_engine = create_engine(current_app.config.get("DBCONNSTRING"))  # type: ignore
+        sql_engine = create_engine(
+            current_app.config.get("DBCONNSTRING"))  # type: ignore
     return sql_engine
 
 
@@ -29,146 +30,168 @@ def import_songs(song_csv):
     with get_db_engine().connect() as conn:
         df.to_sql(song_table, conn, if_exists='replace',
                   index=False)
-        cur = conn.execute("SELECT Count(Id) FROM songs")
+        cur = conn.execute(text("SELECT Count(Id) FROM songs"))
         num_songs = cur.fetchone()[0]  # type: ignore
+        conn.commit()
     print("Imported songs ({} in Database)".format(num_songs))
-    return("Imported songs ({} in Database)".format(num_songs))
+    return ("Imported songs ({} in Database)".format(num_songs))
 
 
 def create_entry_table():
     with get_db_engine().connect() as conn:
-        conn.execute('CREATE TABLE IF NOT EXISTS '+entry_table +
+        stmt = text(
-                 ' (ID INTEGER PRIMARY KEY NOT NULL AUTO_INCREMENT, Song_Id INTEGER NOT NULL, Name VARCHAR(255), Client_Id VARCHAR(36), Transferred INTEGER DEFAULT 0)')
+            f'CREATE TABLE IF NOT EXISTS `{entry_table}` (ID INTEGER PRIMARY KEY NOT NULL AUTO_INCREMENT, Song_Id INTEGER NOT NULL, Name VARCHAR(255), Client_Id VARCHAR(36), Transferred INTEGER DEFAULT 0)')
+        conn.execute(stmt)
+        conn.commit()
 
 
 def create_done_song_table():
     with get_db_engine().connect() as conn:
-        conn.execute('CREATE TABLE IF NOT EXISTS '+done_table +
+        stmt = text(
-                 ' (Song_Id INTEGER PRIMARY KEY NOT NULL,  Plays INTEGER)')
+            f'CREATE TABLE IF NOT EXISTS `{done_table}` (Song_Id INTEGER PRIMARY KEY NOT NULL,  Plays INTEGER)')
+        conn.execute(stmt)
+        conn.commit()
 
 
 def create_song_table():
     with get_db_engine().connect() as conn:
-        conn.execute("CREATE TABLE IF NOT EXISTS `"+song_table+"""` (
+        stmt = text(f"""CREATE TABLE IF NOT EXISTS `{song_table}` (
         `Id` INTEGER,
         `Title` TEXT,
         `Artist` TEXT,
-        `Year` INTEGER,
+        `Year` VARCHAR(4),
-        `Duo` INTEGER,
+        `Duo` BOOLEAN,
         `Explicit` INTEGER,
-        `Date Added` TEXT,
+        `Date Added` TIMESTAMP,
         `Styles` TEXT,
         `Languages` TEXT
         )""")
+        conn.execute(stmt)
+        conn.commit()
 
 
 def create_list_view():
     with get_db_engine().connect() as conn:
-        conn.execute("""CREATE OR REPLACE VIEW `Liste` AS
+        stmt = text("""CREATE OR REPLACE VIEW `Liste` AS
                  SELECT Name, Title, Artist, entries.Id AS entry_ID, songs.Id AS song_ID, entries.Transferred
                  FROM entries, songs
                  WHERE entries.Song_Id=songs.Id""")
+        conn.execute(stmt)
+        conn.commit()
 
 
 def create_done_song_view():
     with get_db_engine().connect() as conn:
-        conn.execute("""CREATE OR REPLACE VIEW `Abspielliste` AS
+        stmt = text("""CREATE OR REPLACE VIEW `Abspielliste` AS
                  SELECT CONCAT(Artist," - ", Title) AS Song, Plays AS Wiedergaben
                  FROM songs, done_songs
                  WHERE done_songs.Song_Id=songs.Id""")
+        conn.execute(stmt)
+        conn.commit()
 
 
 def create_config_table():
     with get_db_engine().connect() as conn:
-        conn.execute("""CREATE TABLE IF NOT EXISTS `config` (
+        stmt = text("""CREATE TABLE IF NOT EXISTS `config` (
         `Key` VARCHAR(50) NOT NULL PRIMARY KEY,
         `Value` TEXT
         )""")
+        conn.execute(stmt)
+        conn.commit()
 
 
 def get_list():
     with get_db_engine().connect() as conn:
-        cur = conn.execute("SELECT * FROM Liste")
+        stmt = text("SELECT * FROM Liste")
+        cur = conn.execute(stmt)
     return cur.fetchall()
 
 
 def get_played_list():
     with get_db_engine().connect() as conn:
-        cur = conn.execute("SELECT * FROM Abspielliste")
+        stmt = text("SELECT * FROM Abspielliste")
+        cur = conn.execute(stmt)
     return cur.fetchall()
 
 
 def get_song_list():
     with get_db_engine().connect() as conn:
-        cur = conn.execute(
+        stmt = text("SELECT Artist || \" - \" || Title AS Song, Id FROM songs;")
-        "SELECT Artist || \" - \" || Title AS Song, Id FROM songs;")
+        cur = conn.execute(stmt)
     return cur.fetchall()
 
 
 def get_song_completions(input_string):
     with get_db_engine().connect() as conn:
-        # Don't look, it burns...
+        prepared_string = f"%{input_string.upper()}%"
-        prepared_string = "%{0}%".format(
+        stmt = text(
-            input_string).upper()  # "Test" -> "%TEST%"
+            "SELECT CONCAT(Artist, ' - ', Title) AS Song, Id FROM songs WHERE CONCAT(Artist, ' - ', Title) LIKE :prepared_string LIMIT 20;")
-        print(prepared_string)
         cur = conn.execute(
-            "SELECT CONCAT(Artist,\" - \",Title) AS Song, Id FROM songs WHERE CONCAT(Artist,\" - \",Title) LIKE (%s) LIMIT 20;", [prepared_string])
+            stmt, {"prepared_string": prepared_string})  # type: ignore
         return cur.fetchall()
 
 
 def add_entry(name, song_id, client_id):
     with get_db_engine().connect() as conn:
-        conn.execute(
+        stmt = text(
-        "INSERT INTO entries (Song_Id,Name,Client_Id) VALUES(%s,%s,%s);", (song_id, name, client_id))
+            "INSERT INTO entries (Song_Id,Name,Client_Id) VALUES (:par_song_id,:par_name,:par_client_id);")
-    return
+        conn.execute(stmt, {"par_song_id": song_id, "par_name": name,
+                     "par_client_id": client_id})  # type: ignore
+        conn.commit()
+    return True
 
 
 def add_sung_song(entry_id):
     with get_db_engine().connect() as conn:
-        cur = conn.execute(
+        stmt = text("SELECT Song_Id FROM entries WHERE Id=:par_entry_id")
-            """SELECT Song_Id FROM entries WHERE Id=%s""", (entry_id,))
+        cur = conn.execute(stmt, {"par_entry_id": entry_id})  # type: ignore
         song_id = cur.fetchone()[0]  # type: ignore
-        conn.execute("""INSERT INTO done_songs (Song_Id, Plays) VALUES("""+str(song_id)+""",1) ON DUPLICATE KEY UPDATE Plays=Plays + 1;""")
+        stmt = text(
+            "INSERT INTO done_songs (Song_Id,Plays) VALUES (:par_song_id,1) ON DUPLICATE KEY UPDATE Plays=Plays + 1;")
+        conn.execute(stmt, {"par_song_id": song_id})  # type: ignore
         delete_entry(entry_id)
+        conn.commit()
     return True
 
 
 def toggle_transferred(entry_id):
     with get_db_engine().connect() as conn:
-        cur = conn.execute(
+        cur = conn.execute(text("SELECT Transferred FROM entries WHERE ID = :par_entry_id"),
-            "SELECT Transferred FROM entries WHERE ID =%s", (entry_id,))
+                           {"par_entry_id": entry_id})  # type: ignore
         marked = cur.fetchall()[0][0]
-        if(marked == 0):
+        if (marked == 0):
-            conn.execute(
+            conn.execute(text("UPDATE entries SET Transferred = 1 WHERE ID = :par_entry_id"),
-                "UPDATE entries SET Transferred = 1 WHERE ID =%s", (entry_id,))
+                         {"par_entry_id": entry_id})  # type: ignore
         else:
-            conn.execute(
+            conn.execute(text("UPDATE entries SET Transferred = 0 WHERE ID = :par_entry_id"),
-                "UPDATE entries SET Transferred = 0 WHERE ID =%s", (entry_id,))
+                         {"par_entry_id": entry_id})  # type: ignore
+        conn.commit()
     return True
 
 
 def check_entry_quota(client_id):
     with get_db_engine().connect() as conn:
-        cur = conn.execute(
+        cur = conn.execute(text("SELECT Count(*) FROM entries WHERE entries.Client_Id = :par_client_id"),
-            "SELECT Count(*) FROM entries WHERE entries.Client_Id = %s", (client_id,))
+                           {"par_client_id": client_id})  # type: ignore
     return cur.fetchall()[0][0]
 
 
 def check_queue_length():
     with get_db_engine().connect() as conn:
-        cur = conn.execute("SELECT Count(*) FROM entries")
+        cur = conn.execute(text("SELECT Count(*) FROM entries"))
     return cur.fetchall()[0][0]
 
 
 def clear_played_songs():
     with get_db_engine().connect() as conn:
-        conn.execute("DELETE FROM done_songs")
+        conn.execute(text("DELETE FROM done_songs"))
     return True
 
 
 def delete_entry(id):
     with get_db_engine().connect() as conn:
-        conn.execute("DELETE FROM entries WHERE id=%s", (id,))
+        conn.execute(text("DELETE FROM entries WHERE id= :par_id"), {
+                     "par_id": id})  # type: ignore
     return True
 
 
@@ -178,7 +201,8 @@ def delete_entries(ids):
         idlist.append((x,))
     try:
         with get_db_engine().connect() as conn:
-            cur = conn.execute("DELETE FROM entries WHERE id=%s", idlist)
+            cur = conn.execute(text("DELETE FROM entries WHERE id= :par_id"), {
+                               "par_id": idlist})
 
         return cur.rowcount
     except Exception as error:
@@ -187,23 +211,50 @@ def delete_entries(ids):
 
 def delete_all_entries() -> bool:
     with get_db_engine().connect() as conn:
-        conn.execute("DELETE FROM entries")
+        conn.execute(text("DELETE FROM entries"))
+        conn.commit()
     return True
 
+
 def get_config(key: str) -> str:
+    try:
         with get_db_engine().connect() as conn:
-        cur = conn.execute("SELECT `Value` FROM config WHERE `Key`=%s", (key,))
+            cur = conn.execute(
+                text("SELECT `Value` FROM config WHERE `Key`= :par_key"), {"par_key": key})  # type: ignore
+            conn.commit()
         return cur.fetchall()[0][0]
+    except IndexError as error:
+        return ""
+
 
 def set_config(key: str, value: str) -> bool:
+    print(f"Setting config {key} to {value}")
     with get_db_engine().connect() as conn:
-        conn.execute("INSERT INTO config (`Key`, `Value`) VALUES (%s,%s) ON DUPLICATE KEY UPDATE `Value`=%s", (key, value, value))
+        conn.execute(text(
+            "INSERT INTO config (`Key`, `Value`) VALUES ( :par_key , :par_value) ON DUPLICATE KEY UPDATE `Value`= :par_value"),
+            {"par_key": key, "par_value": value}
+        )  # type: ignore
+        conn.commit()
     return True
 
+
 def get_config_list() -> dict:
     with get_db_engine().connect() as conn:
-        cur = conn.execute("SELECT * FROM config")
+        cur = conn.execute(text("SELECT * FROM config"))
         result_dict = {}
         for row in cur.fetchall():
             result_dict[row[0]] = row[1]
     return result_dict
+
+
+def check_config_table() -> bool:
+    with get_db_engine().connect() as conn:
+        if conn.dialect.has_table(conn, 'config'):
+            # type: ignore
+            # type: ignore
+            if (conn.execute(text("SELECT COUNT(*) FROM config")).fetchone()[0] > 0): # type: ignore
+                return True
+            else:
+                return False
+        else:
+            return False

backend/helpers.py

@@ -34,15 +34,7 @@ def is_valid_uuid(val):
         return False
 
 def check_config_exists():
-    eng = database.get_db_engine()
+    return database.check_config_table()
-    with eng.connect() as conn:
-        if conn.dialect.has_table(conn, 'config'):
-            if (conn.execute("SELECT COUNT(*) FROM config").fetchone()[0] > 0): # type: ignore
-                return True
-            else:
-                return False
-        else:
-            return False
 
 def load_version(app: Flask):
     if os.environ.get("SOURCE_VERSION"):
@@ -87,7 +79,7 @@ def setup_config(app: Flask):
         config = database.get_config_list()
         print("Loaded existing config")
     else:
-        config = {'username': 'admin', 'password': 'changeme', 'entryquota': 3, 'maxqueue': 20, 'entries_allowed': 1, 'theme': 'default'}
+        config = {'username': 'admin', 'password': 'changeme', 'entryquota': 3, 'maxqueue': 20, 'entries_allowed': 1, 'theme': 'default.css'}
         for key, value in config.items():
             database.set_config(key, value)
         print("Created new config")