Merge branch 'legacy' into feature/legacy/mariadb_database

There are now two dockerfiles. One for production, one for development.
All configuration is now also handled through dotenv files,
which these dotenv files, as well as the included VSCode launch tasks
use.

.env.dev

@@ -0,0 +1,14 @@
+# MariaDB
+MARIADB_ROOT_PASSWORD=mariadb_root_password
+MARIADB_ROOT_HOST=localhost
+MARIADB_DATABASE=karaoqueue
+MARIADB_USER=karaoqueue
+MARIADB_PASSWORD=mariadb_karaoqueue_password
+
+# Karaoqueue
+DEPLOYMENT_PLATFORM=Docker
+DBSTRING=mysql://karaoqueue:mariadb_karaoqueue_password@127.0.0.1:3306/karaoqueue
+BASIC_AUTH_USERNAME=admin 
+BASIC_AUTH_PASSWORD=change_me
+ENTRY_QUOTA=3
+MAX_QUEUE=20

.gitignore

@@ -138,3 +138,6 @@ node_modules/
 
 # Version identification file
 .version
+
+# Docker secrets
+secrets.yml

.vscode/launch.json

@@ -15,8 +15,8 @@
                 "FLASK_APP": "backend/app.py",
                 "FLASK_ENV": "development",
                 "FLASK_DEBUG": "1", 
-                "DBSTRING": "mysql://devuser:devpw@127.0.0.1:3306/karaoqueue"
             },
+            "envFile": "${workspaceFolder}/.env.dev",
             "args": [
                 "run",
                 "--no-debugger",
@@ -36,6 +36,7 @@
                 "FLASK_ENV": "development",
                 "FLASK_DEBUG": "1"
             },
+            "envFile": "${workspaceFolder}/.env.dev",
             "args": [
                 "run",
                 "--no-debugger"
@@ -54,6 +55,7 @@
                 "FLASK_ENV": "development",
                 "FLASK_DEBUG": "1"
             },
+            "envFile": "${workspaceFolder}/.env.dev",
             "args": [
                 "run",
                 "--no-debugger",
@@ -73,6 +75,7 @@
                 "FLASK_ENV": "development",
                 "FLASK_DEBUG": "1"
             },
+            "envFile": "${workspaceFolder}/.env.dev",
             "args": [
                 "run",
                 "--no-debugger",

.vscode/tasks.json

@@ -12,7 +12,7 @@
         {
             "label": "mariadb",
             "type": "shell",
-            "command": "docker run --rm --name some-mariadb --env MARIADB_USER=devuser --env MARIADB_PASSWORD=devpw --env MARIADB_ROOT_PASSWORD=devrootpw --env MARIADB_DATABASE=karaoqueue -p 3306:3306 mariadb:latest",
+            "command": "docker-compose -f docker-compose.yml up --remove-orphans",
             "isBackground": true,
             "activeOnStart": false
         }

Dockerfile

@@ -1,11 +1,5 @@
 FROM tiangolo/uwsgi-nginx-flask:python3.7
 
-RUN pip install requests
-
-RUN pip install pandas
-
-RUN pip install Flask-BasicAuth
-
-RUN pip install bs4
-
 COPY ./backend /app
+
+RUN pip install -r /app/requirements.txt

backend/app.py

@@ -52,8 +52,8 @@ def enqueue():
                 abort(400)
             name = request.json['name']
             song_id = request.json['id']
-            if database.check_queue_length() < app.config['MAX_QUEUE']:
+            if database.check_queue_length() < int(app.config['MAX_QUEUE']):
-                if database.check_entry_quota(client_id) < app.config['ENTRY_QUOTA']:
+                if database.check_entry_quota(client_id) < int(app.config['ENTRY_QUOTA']):
                     database.add_entry(name, song_id, client_id)
                     return Response('{"status":"OK"}', mimetype='text/json')
                 else:

backend/database.py

@@ -12,48 +12,43 @@ entry_table = "entries"
 index_label = "Id"
 done_table = "done_songs"
 
-connection = None
+sql_engine = None
 
 
-def open_db() -> engine.base.Connection:
+def get_db_engine() -> engine.base.Engine:
-    global connection
+    global sql_engine
-    if (not connection):
+    if (not sql_engine):
         print(current_app.config.get("DBCONNSTRING"))
-        engine = create_engine(current_app.config.get("DBCONNSTRING"))  # type: ignore
+        sql_engine = create_engine(current_app.config.get("DBCONNSTRING"))  # type: ignore
-        connection = engine.connect()
+    return sql_engine
-    # cur.execute('PRAGMA encoding = "UTF-8";')
-    return connection
 
 
 def import_songs(song_csv):
     print("Start importing Songs...")
     df = pandas.read_csv(StringIO(song_csv), sep=';')
-    conn = open_db()
+    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")
         num_songs = cur.fetchone()[0] # type: ignore
-    # conn.close()
     print("Imported songs ({} in Database)".format(num_songs))
     return("Imported songs ({} in Database)".format(num_songs))
 
 
 def create_entry_table():
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         conn.execute('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.close()
 
 
 def create_done_song_table():
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         conn.execute('CREATE TABLE IF NOT EXISTS '+done_table +
                  ' (Song_Id INTEGER PRIMARY KEY NOT NULL,  Plays INTEGER)')
-    # conn.close()
 
 
 def create_song_table():
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         conn.execute("CREATE TABLE IF NOT EXISTS `"+song_table+"""` (
         `Id` INTEGER,
         `Title` TEXT,
@@ -65,48 +60,45 @@ def create_song_table():
         `Styles` TEXT,
         `Languages` TEXT
     )""")
-    # conn.close()
 
 
 def create_list_view():
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         conn.execute("""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.close()
 
 
 def create_done_song_view():
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         conn.execute("""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.close()
 
 
 def get_list():
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         cur = conn.execute("SELECT * FROM Liste")
     return cur.fetchall()
 
 
 def get_played_list():
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         cur = conn.execute("SELECT * FROM Abspielliste")
     return cur.fetchall()
 
 
 def get_song_list():
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         cur = conn.execute(
         "SELECT Artist || \" - \" || Title AS Song, Id FROM songs;")
     return cur.fetchall()
 
 
 def get_song_completions(input_string):
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         # Don't look, it burns...
         prepared_string = "%{0}%".format(
             input_string).upper()  # "Test" -> "%TEST%"
@@ -117,33 +109,24 @@ def get_song_completions(input_string):
 
 
 def add_entry(name, song_id, client_id):
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         conn.execute(
         "INSERT INTO entries (Song_Id,Name,Client_Id) VALUES(%s,%s,%s);", (song_id, name, client_id))
-    # conn.close()
     return
 
 
 def add_sung_song(entry_id):
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         cur = conn.execute(
             """SELECT Song_Id FROM entries WHERE Id=%s""", (entry_id,))
         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;""")
-# SQLite bullshittery
-#    conn.execute("""REPLACE INTO done_songs (Song_Id, Plays)
-#                VALUES("""+str(song_id)+""",
-#                       COALESCE(
-#                           (SELECT Plays FROM done_songs
-#                            WHERE Song_Id="""+str(song_id)+"), 0) + 1)"
-#                 )
         delete_entry(entry_id)
-    # conn.close()
     return True
 
 
 def toggle_transferred(entry_id):
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         cur = conn.execute(
             "SELECT Transferred FROM entries WHERE ID =%s", (entry_id,))
         marked = cur.fetchall()[0][0]
@@ -153,34 +136,31 @@ def toggle_transferred(entry_id):
         else:
             conn.execute(
                 "UPDATE entries SET Transferred = 0 WHERE ID =%s", (entry_id,))
-    # conn.close()
     return True
 
 
 def check_entry_quota(client_id):
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         cur = conn.execute(
             "SELECT Count(*) FROM entries WHERE entries.Client_Id = %s", (client_id,))
     return cur.fetchall()[0][0]
 
 
 def check_queue_length():
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         cur = conn.execute("SELECT Count(*) FROM entries")
     return cur.fetchall()[0][0]
 
 
 def clear_played_songs():
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         conn.execute("DELETE FROM done_songs")
-    # conn.close()
     return True
 
 
 def delete_entry(id):
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         conn.execute("DELETE FROM entries WHERE id=%s", (id,))
-    # conn.close()
     return True
 
 
@@ -189,16 +169,15 @@ def delete_entries(ids):
     for x in ids:
         idlist.append((x,))
     try:
-        conn = open_db()
+        with get_db_engine().connect() as conn:
             cur = conn.execute("DELETE FROM entries WHERE id=%s", idlist)
-        # conn.close()
+
         return cur.rowcount
     except Exception as error:
         return -1
 
 
 def delete_all_entries():
-    conn = open_db()
+    with get_db_engine().connect() as conn:
         conn.execute("DELETE FROM entries")
-    # conn.close()
     return True

backend/templates/base.html

@@ -12,7 +12,7 @@
     <title>{% block title %}{% endblock %} - KaraoQueue</title>
 
     <!-- Bootstrap-Tables -->
-    <link rel="stylesheet" href="https://unpkg.com/bootstrap-table@1.15.3/dist/bootstrap-table.min.css">
+    <link rel="stylesheet" href="https://unpkg.com/bootstrap-table@1.21.2/dist/bootstrap-table.min.css">
 
     <!-- Bootstrap core CSS -->
     <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css"
@@ -73,9 +73,9 @@
             {% if not auth %}
             <a href="/login" class="ml-1 mr-1"><i class="fas fa-sign-in-alt mr-1"></i><span>Login</span></a>
             {% endif %}
-            <!--<a href="https://github.com/PhoenixTwoFive/karaoqueue"
+            <a href="https://github.com/PhoenixTwoFive/karaoqueue"
-                class="ml-1 mr-1"><i class="fab fa-github mr-1"></i><span>Github</span></a>-->
+                class="ml-1 mr-1"><i class="fab fa-github mr-1"></i><span>Github</span></a>
-            <span class="text-muted"><a class="text-muted" href="https://github.com/PhoenixTwoFive/karaoqueue">KaraoQueue</a> {{karaoqueue_version}} -&nbsp;2019-22 - Phillip
+            <span class="text-muted"> {{karaoqueue_version}} -&nbsp;2019-23 - Phillip
                 Kühne</span>
         </div>
     </footer>
@@ -96,9 +96,9 @@
     <script src="https://cdnjs.cloudflare.com/ajax/libs/bootbox.js/4.4.0/bootbox.min.js"
         integrity="sha256-4F7e4JsAJyLUdpP7Q8Sah866jCOhv72zU5E8lIRER4w=" crossorigin="anonymous">
         </script>
-    <script src="https://unpkg.com/bootstrap-table@1.15.3/dist/bootstrap-table.min.js"></script>
+    <script src="https://unpkg.com/bootstrap-table@1.21.2/dist/bootstrap-table.min.js"></script>
     <script
-        src="https://unpkg.com/bootstrap-table@1.15.3/dist/extensions/auto-refresh/bootstrap-table-auto-refresh.min.js"></script>
+        src="https://unpkg.com/bootstrap-table@1.21.2/dist/extensions/auto-refresh/bootstrap-table-auto-refresh.min.js"></script>
     <script src="https://gitcdn.github.io/bootstrap-toggle/2.2.2/js/bootstrap-toggle.min.js"></script>
     {% block extrajs %}{% endblock %}
     <script>

docker-compose.prod.yml

@@ -1,10 +1,15 @@
 version: "3.9"
+
+secrets:
+  secrets:
+    file: ./secrets.yml
+
 services:
   karaoqueue:
     image: "phillipkhne/karaoqueue:latest"
     restart: always
     ports:
-      - "127.0.0.1:8081:80"
+      - "127.0.0.1:8081:80" # Please put a reverse proxy in front of this
     environment:
       DEPLOYMENT_PLATFORM: Docker
       DBSTRING: mysql://user:pass@host:3306/database
@@ -16,8 +21,8 @@ services:
     image: mariadb
     restart: always
     environment:
-      MARIADB_ROOT_PASSWORD: dpMAZj*Mc4%FZM!V
+      MARIADB_ROOT_PASSWORD: changeme!
       MARIADB_ROOT_HOST: localhost
       MARIADB_DATABASE: karaoqueue
       MARIADB_USER: karaoqueue
-      MARIADB_PASSWORD: a5G@P*^tCW$$w@wE
+      MARIADB_PASSWORD: change

docker-compose.yml

@@ -0,0 +1,15 @@
+# This Compose file is for development only. It is not intended for production use.
+# It only starts auxiliary services, such as a database, that are required for the
+# application to run. The application itself is started separately, using the
+# command "python -m flask run" or your favorite IDE.
+# Useful for attaching a debugger to the application.
+
+version: "3.9"
+
+services:
+  db:
+    image: mariadb
+    restart: always
+    env_file: .env.dev
+    ports:
+      - "3306:3306"