Merge branch 'legacy_feature_client_identification_queue_limit' into stable

backend/app/database.py

@@ -4,16 +4,18 @@ import sqlite3
 import pandas
 from io import StringIO
 
-song_table  = "songs"
+song_table = "songs"
 entry_table = "entries"
 index_label = "Id"
-done_table  = "done_songs"
+done_table = "done_songs"
+
 
 def open_db():
     conn = sqlite3.connect("/tmp/karaoqueue.db")
     conn.execute('PRAGMA encoding = "UTF-8";')
     return conn
 
+
 def import_songs(song_csv):
     print("Start importing Songs...")
     df = pandas.read_csv(StringIO(song_csv), sep=';')
@@ -25,12 +27,13 @@ def import_songs(song_csv):
     num_songs = cur.fetchone()[0]
     conn.close()
     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():
     conn = open_db()
     conn.execute('CREATE TABLE IF NOT EXISTS '+entry_table +
-                 ' (ID INTEGER PRIMARY KEY NOT NULL, Song_Id INTEGER NOT NULL, Name VARCHAR(255))')
+                 ' (ID INTEGER PRIMARY KEY NOT NULL, Song_Id INTEGER NOT NULL, Name VARCHAR(255), Client_Id VARCHAR(36))')
     conn.close()
 
 
@@ -40,6 +43,7 @@ def create_done_song_table():
                  ' (Song_Id INTEGER PRIMARY KEY NOT NULL,  Plays INTEGER)')
     conn.close()
 
+
 def create_song_table():
     conn = open_db()
     conn.execute("CREATE TABLE IF NOT EXISTS \""+song_table+"""\" (
@@ -55,6 +59,7 @@ def create_song_table():
     )""")
     conn.close()
 
+
 def create_list_view():
     conn = open_db()
     conn.execute("""CREATE VIEW IF NOT EXISTS [Liste] AS
@@ -72,6 +77,7 @@ def create_done_song_view():
                  WHERE done_songs.Song_Id=songs.Id""")
     conn.close()
 
+
 def get_list():
     conn = open_db()
     conn.row_factory = sqlite3.Row
@@ -86,35 +92,40 @@ def get_played_list():
     cur.execute("SELECT * FROM Abspielliste")
     return cur.fetchall()
 
+
 def get_song_list():
-    conn =open_db()
+    conn = open_db()
     cur = conn.cursor()
     cur.execute("SELECT Artist || \" - \" || Title AS Song, Id FROM songs;")
     return cur.fetchall()
 
+
 def get_song_completions(input_string):
     conn = open_db()
     cur = conn.cursor()
     # Don't look, it burns...
-    prepared_string = "%{0}%".format(input_string).upper()  # "Test" -> "%TEST%"
+    prepared_string = "%{0}%".format(
+        input_string).upper()  # "Test" -> "%TEST%"
     print(prepared_string)
     cur.execute(
         "SELECT Title || \" - \" || Artist AS Song, Id FROM songs WHERE REPLACE(REPLACE(REPLACE(REPLACE(UPPER( SONG ),'ö','Ö'),'ü','Ü'),'ä','Ä'),'ß','ẞ') LIKE (?) LIMIT 20;", (prepared_string,))
     return cur.fetchall()
 
-def add_entry(name,song_id):
+
+def add_entry(name, song_id, client_id):
     conn = open_db()
     cur = conn.cursor()
     cur.execute(
-        "INSERT INTO entries (Song_Id,Name) VALUES(?,?);", (song_id,name))
+        "INSERT INTO entries (Song_Id,Name,Client_Id) VALUES(?,?,?);", (song_id, name, client_id))
     conn.commit()
     conn.close()
     return
 
+
 def add_sung_song(entry_id):
     conn = open_db()
     cur = conn.cursor()
-    cur.execute("""SELECT Song_Id FROM entries WHERE Id=?""",(entry_id,))
+    cur.execute("""SELECT Song_Id FROM entries WHERE Id=?""", (entry_id,))
     song_id = cur.fetchone()[0]
     cur.execute("""INSERT OR REPLACE INTO done_songs (Song_Id, Plays)
                 VALUES("""+str(song_id)+""",
@@ -127,6 +138,19 @@ def add_sung_song(entry_id):
     conn.close()
     return True
 
+
+def check_entry_quota(client_id):
+    conn = open_db()
+    cur = conn.cursor()
+    cur.execute("SELECT Count(*) FROM entries WHERE entries.Client_Id = ?", (client_id,))
+    return cur.fetchall()[0][0]
+
+def check_queue_length():
+    conn = open_db()
+    cur = conn.cursor()
+    cur.execute("SELECT Count(*) FROM entries")
+    return cur.fetchall()[0][0]
+
 def clear_played_songs():
     conn = open_db()
     cur = conn.cursor()
@@ -135,10 +159,11 @@ def clear_played_songs():
     conn.close()
     return True
 
+
 def delete_entry(id):
     conn = open_db()
     cur = conn.cursor()
-    cur.execute("DELETE FROM entries WHERE id=?",(id,))
+    cur.execute("DELETE FROM entries WHERE id=?", (id,))
     conn.commit()
     conn.close()
     return True
@@ -147,7 +172,7 @@ def delete_entry(id):
 def delete_entries(ids):
     idlist = []
     for x in ids:
-        idlist.append( (x,) )
+        idlist.append((x,))
     try:
         conn = open_db()
         cur = conn.cursor()
@@ -158,6 +183,7 @@ def delete_entries(ids):
     except sqlite3.Error as error:
         return -1
 
+
 def delete_all_entries():
     conn = open_db()
     cur = conn.cursor()

backend/app/helpers.py

@@ -2,6 +2,7 @@ import requests
 from bs4 import BeautifulSoup
 import json
 import os
+import uuid
 
 data_directory = "data"
 config_file = data_directory+"/config.json"
@@ -21,6 +22,13 @@ def get_songs(url):
     r = requests.get(url)
     return r.text
 
+def is_valid_uuid(val):
+    try:
+        uuid.UUID(str(val))
+        return True
+    except ValueError:
+        return False
+
 def check_config_exists():
     return os.path.isfile(config_file)
 
@@ -31,9 +39,11 @@ def setup_config(app):
             config = json.load(handle)
         print("Loaded existing config")
     else:
-        config = {'username': 'admin', 'password': 'changeme'}
+        config = {'username': 'admin', 'password': 'changeme', 'entryquota': 3, 'maxqueue': 20}
         with open(config_file, 'w') as handle:
             json.dump(config, handle, indent=4, sort_keys=True)
         print("Wrote new config")
     app.config['BASIC_AUTH_USERNAME'] = config['username']
-    app.config['BASIC_AUTH_PASSWORD'] = config['password']
+    app.config['BASIC_AUTH_PASSWORD'] = config['password']
+    app.config['ENTRY_QUOTA'] = config['entryquota']
+    app.config['MAX_QUEUE'] = config['maxqueue']

backend/app/main.py

@@ -2,7 +2,8 @@ from flask import Flask, render_template, Response, abort, request, redirect
 import helpers
 import database
 import data_adapters
-import os, errno
+import os
+import errno
 import json
 from flask_basicauth import BasicAuth
 app = Flask(__name__, static_url_path='/static')
@@ -10,6 +11,7 @@ app = Flask(__name__, static_url_path='/static')
 basic_auth = BasicAuth(app)
 accept_entries = False
 
+
 @app.route("/")
 def home():
     if basic_auth.authenticate():
@@ -17,52 +19,104 @@ def home():
     else:
         return render_template('main.html', list=database.get_list(), auth=basic_auth.authenticate())
 
+
 @app.route('/api/enqueue', methods=['POST'])
 def enqueue():
-    if accept_entries:
+    if not request.json:
-        if not request.json:
+        print(request.data)
-            print(request.data)
+        abort(400)
-            abort(400)
+    client_id = request.json['client_id']
-        name = request.json['name']
+    if not helpers.is_valid_uuid(client_id):
-        song_id = request.json['id']
+        print(request.data)
-        database.add_entry(name, song_id)
+        abort(400)
+    name = request.json['name']
+    song_id = request.json['id']
+    if request.authorization:
+        database.add_entry(name, song_id, client_id)
         return Response('{"status":"OK"}', mimetype='text/json')
     else:
-        return Response('{"status":"Currently not accepting entries"}', mimetype='text/json',status=423)
+        if accept_entries:
-    
+            if not request.json:
+                print(request.data)
+                abort(400)
+            client_id = request.json['client_id']
+            if not helpers.is_valid_uuid(client_id):
+                print(request.data)
+                abort(400)
+            name = request.json['name']
+            song_id = request.json['id']
+            if database.check_queue_length() < app.config['MAX_QUEUE']:
+                if database.check_entry_quota(client_id) < app.config['ENTRY_QUOTA']:
+                    database.add_entry(name, song_id, client_id)
+                    return Response('{"status":"OK"}', mimetype='text/json')
+                else:
+                    return Response('{"status":"Du hast bereits ' + str(database.check_entry_quota(client_id)) + ' Songs eingetragen, dies ist das Maximum an Einträgen die du in der Warteliste haben kannst."}', mimetype='text/json', status=423)
+            else:
+                return Response('{"status":"Die Warteschlange enthält momentan ' + str(database.check_queue_length()) + ' Einträge und ist lang genug, bitte versuche es noch einmal wenn ein paar Songs gesungen wurden."}', mimetype='text/json', status=423)
+        else:
+            return Response('{"status":"Currently not accepting entries"}', mimetype='text/json', status=423)
+
 
 @app.route("/list")
 def songlist():
     return render_template('songlist.html', list=database.get_song_list(), auth=basic_auth.authenticate())
 
+
+@app.route("/settings")
+@basic_auth.required
+def settings():
+    return render_template('settings.html', app=app, auth=basic_auth.authenticate())
+
+
+@app.route("/settings", methods=['POST'])
+@basic_auth.required
+def settings_post():
+    entryquota = request.form.get("entryquota")
+    maxqueue = request.form.get("maxqueue")
+    if entryquota.isnumeric() and int(entryquota) > 0:
+        app.config['ENTRY_QUOTA'] = int(entryquota)
+    else:
+        abort(400)
+    if maxqueue.isnumeric and int(maxqueue) > 0:
+        app.config['MAX_QUEUE'] = int(maxqueue)
+    else:
+        abort(400)
+
+    return render_template('settings.html', app=app, auth=basic_auth.authenticate())
+
+
 @app.route("/api/queue")
 def queue_json():
     list = data_adapters.dict_from_rows(database.get_list())
     return Response(json.dumps(list, ensure_ascii=False).encode('utf-8'), mimetype='text/json')
 
+
 @app.route("/plays")
 @basic_auth.required
 def played_list():
     return render_template('played_list.html', list=database.get_played_list(), auth=basic_auth.authenticate())
 
+
 @app.route("/api/songs")
 def songs():
     list = database.get_song_list()
     return Response(json.dumps(list, ensure_ascii=False).encode('utf-8'), mimetype='text/json')
 
+
 @app.route("/api/songs/update")
 @basic_auth.required
 def update_songs():
     database.delete_all_entries()
-    status = database.import_songs(helpers.get_songs(helpers.get_catalog_url()))
+    status = database.import_songs(
+        helpers.get_songs(helpers.get_catalog_url()))
     print(status)
     return Response('{"status": "%s" }' % status, mimetype='text/json')
 
 
 @app.route("/api/songs/compl")
 def get_song_completions(input_string=""):
-    input_string = request.args.get('search',input_string)
+    input_string = request.args.get('search', input_string)
-    if input_string!="":
+    if input_string != "":
         print(input_string)
         list = database.get_song_completions(input_string=input_string)
         return Response(json.dumps(list, ensure_ascii=False).encode('utf-8'), mimetype='text/json')
@@ -102,12 +156,13 @@ def mark_sung(entry_id):
     else:
         return Response('{"status": "FAIL"}', mimetype='text/json')
 
+
 @app.route("/api/entries/accept/<value>")
 @basic_auth.required
 def set_accept_entries(value):
     global accept_entries
-    if (value=='0' or value=='1'):
+    if (value == '0' or value == '1'):
-        accept_entries=bool(int(value))
+        accept_entries = bool(int(value))
         return Response('{"status": "OK"}', mimetype='text/json')
     else:
         return Response('{"status": "FAIL"}', mimetype='text/json', status=400)
@@ -117,7 +172,7 @@ def set_accept_entries(value):
 def get_accept_entries():
     global accept_entries
     return Response('{"status": "OK", "value": '+str(int(accept_entries))+'}', mimetype='text/json')
-    
+
 
 @app.route("/api/played/clear")
 @basic_auth.required
@@ -127,6 +182,7 @@ def clear_played_songs():
     else:
         return Response('{"status": "FAIL"}', mimetype='text/json')
 
+
 @app.route("/api/entries/delete_all")
 @basic_auth.required
 def delete_all_entries():
@@ -135,11 +191,13 @@ def delete_all_entries():
     else:
         return Response('{"status": "FAIL"}', mimetype='text/json')
 
+
 @app.route("/login")
 @basic_auth.required
 def admin():
     return redirect("/", code=303)
 
+
 @app.before_first_request
 def activate_job():
     helpers.create_data_directory()
@@ -151,5 +209,5 @@ def activate_job():
     helpers.setup_config(app)
 
 
-if __name__ == "__main__":    
+if __name__ == "__main__":
     app.run(host='127.0.0.1', port=8080, debug=True)

backend/app/templates/base.html

@@ -10,7 +10,7 @@
     <link rel="manifest" href="/static/manifest.webmanifest">
 
     <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">
 
@@ -51,6 +51,9 @@
                 <li class="nav-item">
                     <a class="nav-link" href="/plays">Abspielliste</a>
                 </li>
+                <li class="nav-item">
+                    <a class="nav-link" href="/settings">Einstellungen</a>
+                </li>
                 {% endif %}
             </ul>
             <!--<form class="form-inline my-2 my-lg-0">
@@ -68,8 +71,7 @@
     <footer class="footer">
         <div class="container text-center py-3">
             {% if not auth %}
-                <a href="/login" class="ml-1 mr-1"><i
+            <a href="/login" class="ml-1 mr-1"><i class="fas fa-sign-in-alt mr-1"></i><span>Login</span></a>
-                        class="fas fa-sign-in-alt mr-1"></i><span>Login</span></a>
             {% endif %}
             <!--<a href="https://github.com/PhoenixTwoFive/karaoqueue"
                 class="ml-1 mr-1"><i class="fab fa-github mr-1"></i><span>Github</span></a>-->
@@ -83,28 +85,46 @@
     <!-- Placed at the end of the document so the pages load faster -->
     <script src="https://code.jquery.com/jquery-3.2.1.min.js"
         integrity="sha384-xBuQ/xzmlsLoJpyjoggmTEz8OWUFM0/RC5BsqQBDX2v5cMvDHcMakNTNrHIW2I5f" crossorigin="anonymous">
-    </script>
+        </script>
-    
+
     <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js"
         integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous">
-    </script>
+        </script>
     <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js"
         integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous">
-    </script>
+        </script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/bootbox.js/4.4.0/bootbox.min.js"
         integrity="sha256-4F7e4JsAJyLUdpP7Q8Sah866jCOhv72zU5E8lIRER4w=" crossorigin="anonymous">
-    </script>
+        </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.15.3/dist/extensions/auto-refresh/bootstrap-table-auto-refresh.min.js"></script>
+    <script
+        src="https://unpkg.com/bootstrap-table@1.15.3/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>
         $(document).ready(function () {
+            loadOrGenerateClientId()
             // get current URL path and assign 'active' class
             var pathname = window.location.pathname;
             $('.navbar-nav > li > a[href="' + pathname + '"]').parent().addClass('active');
             $('[data-toggle="tooltip"]').tooltip()
         })
+
+        function create_UUID() {
+            var dt = new Date().getTime();
+            var uuid = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+                var r = (dt + Math.random() * 16) % 16 | 0;
+                dt = Math.floor(dt / 16);
+                return (c == 'x' ? r : (r & 0x3 | 0x8)).toString(16);
+            });
+            return uuid;
+        }
+
+        function loadOrGenerateClientId() {
+            if (!localStorage.getItem("clientId")) {
+                localStorage.setItem("clientId",create_UUID())
+            }
+        }
     </script>
 </body>
 

backend/app/templates/main_admin.html

@@ -116,10 +116,10 @@ table td:nth-child(2) {
         $.getJSON("/api/entries/accept", (data) => {
             if (data["value"]!=$('#entryToggle').is(":checked")) {
                 if(data["value"]==1) {
-                $('#entryToggle').bootstrapToggle('on')
+                    $('#entryToggle').data('bs.toggle').on('true')
                 }
                 else {
-                    $('#entryToggle').bootstrapToggle('off')
+                    $('#entryToggle').data('bs.toggle').off('true')
                 }
             }
         })

backend/app/templates/settings.html

@@ -0,0 +1,18 @@
+{% extends 'base.html' %}
+{% block title %}Einstellungen{% endblock %}
+{% block content %}
+<form method="post">
+    <p>
+        <label for="entryquota">Maximale Anzahl an Einträgen pro Nutzer</label>
+        <input type="number" class="form-control" id="entryquota" name="entryquota" min=1 value={{app.config['ENTRY_QUOTA']}}>
+    </p>
+    <p>
+        <label for="maxqueue">Maximale Anzahl an Einträgen Insgesamt</label>
+        <input type="number" class="form-control" id="maxqueue" name="maxqueue" min=1 value={{app.config['MAX_QUEUE']}}>
+    </p>
+    <input type="submit" class="btn btn-primary mr-1 mb-2" value="Einstellungen anwenden">
+    <input type="button" class="btn btn-default mr-1 mb-2" onclick="$.get('/writeSettings').done(()=>{alert('Einstellungen gespeichert')}).fail(()=>{alert('Fehler beim Speichern der Einstellungen')})" value="Einstellungen speichern"/>
+</form>
+{% endblock %}
+{% block extrajs %}
+{% endblock %}

backend/app/templates/songlist.html

@@ -17,8 +17,8 @@
                 </button>
             </div>
             <div class="form-group">
-            <form id="nameForm">
+                <form id="nameForm">
-                <div class="modal-body">
+                    <div class="modal-body">
                         <label for="singerNameInput">Sängername</label>
                         <input type="text" class="form-control" id="singerNameInput" placeholder="Max Mustermann"
                             required>
@@ -28,7 +28,7 @@
                         <button type="button" class="btn btn-secondary" data-dismiss="modal">Close</button>
                         <button type="submit" class="btn btn-primary" id="submitSongButton">Anmelden</button>
                     </div>
-            </form>
+                </form>
             </div>
         </div>
     </div>
@@ -38,22 +38,22 @@
 <script>
     $(document).ready(function () {
         $("#filter").focus();
-        $("#filter").keyup( function () {
+        $("#filter").keyup(function () {
             var value = $(this).val().toLowerCase();
             //alert(value);
-            if(value.length >= 1) {
+            if (value.length >= 1) {
                 $.getJSON("/api/songs/compl", { search: value }, function (data) {
                     var items = [];
                     $.each(data, function (key, val) {
-                        items.push("<tr><td>"+val[0]+`</td>
+                        items.push("<tr><td>" + val[0] + `</td>
                             <td><button type='button'
                                     class='btn btn-primary justify-content-center align-content-between enqueueButton'
                                     data-toggle='modal'
-                                    data-target='#enqueueModal' onclick='setSelectedId(`+val[1]+`)'><i
+                                    data-target='#enqueueModal' onclick='setSelectedId(`+ val[1] + `)'><i
                                         class="fas fa-plus"></i></button></td>
                         </tr>`)
                     });
-    
+
                     $("#songtable").html("")
                     $(items.join("")).appendTo("#songtable");
                     entriesAccepted()
@@ -63,17 +63,18 @@
             }
         });
 
-        $("#nameForm").submit( function (e) {
+        $("#nameForm").submit(function (e) {
             e.preventDefault();
             submitModal();
         });
     });
 
-    
+
-    function enqueue(id,name,success_callback, blocked_callback) {
+    function enqueue(client_id, id, name, success_callback, blocked_callback) {
         var data = {
             "name": name,
-            "id": id
+            "id": id,
+            "client_id": client_id
         }
         $.ajax({
             type: 'POST',
@@ -87,41 +88,41 @@
             dataType: 'json'
         });
     }
-    
+
     function setSelectedId(id) {
-        $("#selectedId").attr("value",id);
+        $("#selectedId").attr("value", id);
     }
-    
+
     function submitModal() {
         var name = $("#singerNameInput").val();
         var id = $("#selectedId").attr("value");
-        enqueue(id,name,function () {
+        enqueue(localStorage.getItem("clientId"),id, name, function () {
             $("#enqueueModal").modal('hide');
             window.location.href = '/#end';
-        }, function () {
+        }, function (response) {
             bootbox.alert({
-                    message: "Es werden leider keine neuen Anmeldungen mehr angenommen. Tut mir leid :(",
+                message: "Deine Eintragung konnte leider nicht vorgenommen werden.\nGrund: "+response.responseJSON.status,
-                });
+            });
-            $(".enqueueButton").prop("disabled",true);
+            entriesAccepted();
             $("#enqueueModal").modal('hide');
 
         });
-        
+
 
     }
 
     function entriesAccepted() {
-        $.getJSON("/api/entries/accept", (data,out) => {
+        $.getJSON("/api/entries/accept", (data, out) => {
-            if(data["value"]==0) {
+            if (data["value"] == 0) {
-                $(".enqueueButton").prop("disabled",true)
+                $(".enqueueButton").prop("disabled", true)
-                $(".enqueueButton").prop("style","pointer-events: none;")
+                $(".enqueueButton").prop("style", "pointer-events: none;")
-                $(".enqueueButton").wrap("<span class='tooltip-span' tabindex='0' data-toggle='tooltip' data-placement='top'></span>" );
+                $(".enqueueButton").wrap("<span class='tooltip-span' tabindex='0' data-toggle='tooltip' data-placement='top'></span>");
-                $(".tooltip-span").prop("title","Eintragungen sind leider nicht mehr möglich.")
+                $(".tooltip-span").prop("title", "Eintragungen sind leider nicht mehr möglich.")
                 $('[data-toggle="tooltip"]').tooltip()
             } else {
-                $(".enqueueButton").prop("disabled",false)
+                $(".enqueueButton").prop("disabled", false)
             }
-            
+
         })
     }