Merge branch 'legacy_feature_transferred_tagging' into legacy

.gitignore

@@ -135,3 +135,6 @@ data/
 # Node Modules
 
 node_modules/
+
+# Version identification file
+.version

.vscode/launch.json

@@ -4,14 +4,11 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
-
-
-
-        {"name":"Python: Flask","type":"python","request":"launch","module":"flask","env":{"FLASK_APP":"backend/app/main.py","FLASK_ENV":"development","FLASK_DEBUG":"1"},"args":["run","--no-debugger","--no-reload"],"jinja":true},
-        {"name":"Python: Flask (with reload)","type":"python","request":"launch","module":"flask","env":{"FLASK_APP":"backend/app/main.py","FLASK_ENV":"development","FLASK_DEBUG":"1"},"args":["run","--no-debugger"],"jinja":true},
         {
-            "name": "Python: Flask (with reload, externally reachable)",
+            "preLaunchTask": "versiondump",
+            "name": "Python: Flask",
             "type": "python",
+            "cwd": "${workspaceFolder}/backend/app",
             "request": "launch",
             "module": "flask",
             "env": {
@@ -22,13 +19,52 @@
             "args": [
                 "run",
                 "--no-debugger",
-                "--host='0.0.0.0'"
+                "--no-reload"
             ],
             "jinja": true
         },
         {
+            "preLaunchTask": "versiondump",
+            "name": "Python: Flask (with reload)",
+            "type": "python",
+            "cwd": "${workspaceFolder}/backend/app",
+            "request": "launch",
+            "module": "flask",
+            "env": {
+                "FLASK_APP": "backend/app/main.py",
+                "FLASK_ENV": "development",
+                "FLASK_DEBUG": "1"
+            },
+            "args": [
+                "run",
+                "--no-debugger"
+            ],
+            "jinja": true
+        },
+        {
+            "preLaunchTask": "versiondump",
+            "name": "Python: Flask (with reload, externally reachable)",
+            "type": "python",
+            "cwd": "${workspaceFolder}/backend/app",
+            "request": "launch",
+            "module": "flask",
+            "env": {
+                "FLASK_APP": "backend/app/main.py",
+                "FLASK_ENV": "development",
+                "FLASK_DEBUG": "1"
+            },
+            "args": [
+                "run",
+                "--no-debugger",
+                "--host=0.0.0.0"
+            ],
+            "jinja": true
+        },
+        {
+            "preLaunchTask": "versiondump",
             "name": "Python: Flask (externally reachable)",
             "type": "python",
+            "cwd": "${workspaceFolder}/backend/app",
             "request": "launch",
             "module": "flask",
             "env": {
@@ -40,7 +76,7 @@
                 "run",
                 "--no-debugger",
                 "--no-reload",
-                "--host='0.0.0.0'"
+                "--host=0.0.0.0"
             ],
             "jinja": true
         },

.vscode/tasks.json

@@ -0,0 +1,13 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "versiondump",
+            "type": "shell",
+            "command": "echo \"$(git rev-parse --abbrev-ref HEAD)-$(git describe)\"> ${workspaceFolder}/backend/app/.version",
+            "problemMatcher": []
+        }
+    ]
+}

backend/app/database.py

@@ -33,7 +33,7 @@ def import_songs(song_csv):
 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), Client_Id VARCHAR(36))')
+                 ' (ID INTEGER PRIMARY KEY NOT NULL, Song_Id INTEGER NOT NULL, Name VARCHAR(255), Client_Id VARCHAR(36), Transferred INTEGER DEFAULT 0)')
     conn.close()
 
 
@@ -63,7 +63,7 @@ def create_song_table():
 def create_list_view():
     conn = open_db()
     conn.execute("""CREATE VIEW IF NOT EXISTS [Liste] AS
-                 SELECT Name, Title, Artist, entries.Id, songs.Id
+                 SELECT Name, Title, Artist, entries.Id, songs.Id, entries.Transferred
                  FROM entries, songs
                  WHERE entries.Song_Id=songs.Id""")
     conn.close()
@@ -139,18 +139,37 @@ def add_sung_song(entry_id):
     return True
 
 
+def toggle_transferred(entry_id):
+    conn = open_db()
+    cur = conn.cursor()
+    cur.execute("SELECT Transferred FROM entries WHERE ID =?", (entry_id,))
+    marked = cur.fetchall()[0][0]
+    if(marked == 0):
+        cur.execute(
+            "UPDATE entries SET Transferred = 1 WHERE ID =?", (entry_id,))
+    else:
+        cur.execute(
+            "UPDATE entries SET Transferred = 0 WHERE ID =?", (entry_id,))
+    conn.commit()
+    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,))
+    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()

backend/app/helpers.py

@@ -3,6 +3,9 @@ from bs4 import BeautifulSoup
 import json
 import os
 import uuid
+from flask import make_response
+from functools import wraps, update_wrapper
+from datetime import datetime
 
 data_directory = "data"
 config_file = data_directory+"/config.json"
@@ -32,6 +35,17 @@ def is_valid_uuid(val):
 def check_config_exists():
     return os.path.isfile(config_file)
 
+def load_version(app):
+    if os.path.isfile(".version"):
+        with open('.version', 'r') as file:
+            data = file.read().replace('\n', '')
+            if data:
+                app.config['VERSION'] = data
+            else:
+                app.config['VERSION'] = ""
+    else:
+        app.config['VERSION'] = ""
+
 def setup_config(app):
     if check_config_exists():
         config = json.load(open(config_file))
@@ -47,3 +61,17 @@ def setup_config(app):
     app.config['BASIC_AUTH_PASSWORD'] = config['password']
     app.config['ENTRY_QUOTA'] = config['entryquota']
     app.config['MAX_QUEUE'] = config['maxqueue']
+
+
+
+def nocache(view):
+    @wraps(view)
+    def no_cache(*args, **kwargs):
+        response = make_response(view(*args, **kwargs))
+        response.headers['Last-Modified'] = datetime.now()
+        response.headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, post-check=0, pre-check=0, max-age=0'
+        response.headers['Pragma'] = 'no-cache'
+        response.headers['Expires'] = '-1'
+        return response
+        
+    return update_wrapper(no_cache, view)

backend/app/main.py

@@ -1,17 +1,16 @@
-from flask import Flask, render_template, Response, abort, request, redirect
+from flask import Flask, render_template, Response, abort, request, redirect, send_from_directory
 import helpers
 import database
 import data_adapters
 import os
-import errno
 import json
 from flask_basicauth import BasicAuth
+from helpers import nocache
 app = Flask(__name__, static_url_path='/static')
 
 basic_auth = BasicAuth(app)
 accept_entries = False
 
-
 @app.route("/")
 def home():
     if basic_auth.authenticate():
@@ -20,7 +19,14 @@ def home():
         return render_template('main.html', list=database.get_list(), auth=basic_auth.authenticate())
 
 
+@app.route("/favicon.ico")
+def favicon():
+    return send_from_directory(os.path.join(app.root_path, 'static'),
+                               'favicon.ico', mimetype='image/vnd.microsoft.icon')
+
+
 @app.route('/api/enqueue', methods=['POST'])
+@nocache
 def enqueue():
     if not request.json:
         print(request.data)
@@ -63,12 +69,14 @@ def songlist():
 
 
 @app.route("/settings")
+@nocache
 @basic_auth.required
 def settings():
     return render_template('settings.html', app=app, auth=basic_auth.authenticate())
 
 
 @app.route("/settings", methods=['POST'])
+@nocache
 @basic_auth.required
 def settings_post():
     entryquota = request.form.get("entryquota")
@@ -86,24 +94,28 @@ def settings_post():
 
 
 @app.route("/api/queue")
+@nocache
 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")
+@nocache
 @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")
+@nocache
 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")
+@nocache
 @basic_auth.required
 def update_songs():
     database.delete_all_entries()
@@ -114,6 +126,7 @@ def update_songs():
 
 
 @app.route("/api/songs/compl")
+@nocache
 def get_song_completions(input_string=""):
     input_string = request.args.get('search', input_string)
     if input_string != "":
@@ -126,6 +139,7 @@ def get_song_completions(input_string=""):
 
 
 @app.route("/api/entries/delete/<entry_id>")
+@nocache
 @basic_auth.required
 def delete_entry(entry_id):
     if database.delete_entry(entry_id):
@@ -135,6 +149,7 @@ def delete_entry(entry_id):
 
 
 @app.route("/api/entries/delete", methods=['POST'])
+@nocache
 @basic_auth.required
 def delete_entries():
     if not request.json:
@@ -149,6 +164,7 @@ def delete_entries():
 
 
 @app.route("/api/entries/mark_sung/<entry_id>")
+@nocache
 @basic_auth.required
 def mark_sung(entry_id):
     if database.add_sung_song(entry_id):
@@ -156,8 +172,18 @@ def mark_sung(entry_id):
     else:
         return Response('{"status": "FAIL"}', mimetype='text/json')
 
+@app.route("/api/entries/mark_transferred/<entry_id>")
+@nocache
+@basic_auth.required
+def mark_transferred(entry_id):
+    if database.toggle_transferred(entry_id):
+        return Response('{"status": "OK"}', mimetype='text/json')
+    else:
+        return Response('{"status": "FAIL"}', mimetype='text/json')
+
 
 @app.route("/api/entries/accept/<value>")
+@nocache
 @basic_auth.required
 def set_accept_entries(value):
     global accept_entries
@@ -169,12 +195,14 @@ def set_accept_entries(value):
 
 
 @app.route("/api/entries/accept")
+@nocache
 def get_accept_entries():
     global accept_entries
     return Response('{"status": "OK", "value": '+str(int(accept_entries))+'}', mimetype='text/json')
 
 
 @app.route("/api/played/clear")
+@nocache
 @basic_auth.required
 def clear_played_songs():
     if database.clear_played_songs():
@@ -184,6 +212,7 @@ def clear_played_songs():
 
 
 @app.route("/api/entries/delete_all")
+@nocache
 @basic_auth.required
 def delete_all_entries():
     if database.delete_all_entries():
@@ -200,6 +229,7 @@ def admin():
 
 @app.before_first_request
 def activate_job():
+    helpers.load_version(app)
     helpers.create_data_directory()
     database.create_entry_table()
     database.create_song_table()
@@ -209,5 +239,21 @@ def activate_job():
     helpers.setup_config(app)
 
 
+
+@app.after_request
+def add_header(response):
+    """
+    Add headers to both force latest IE rendering engine or Chrome Frame,
+    and also to cache the rendered page for 10 minutes.
+    """
+    if not 'Cache-Control' in response.headers:
+        response.headers['Cache-Control'] = 'private, max-age=600'
+    return response
+
+@app.context_processor
+def inject_version():
+    return dict(karaoqueue_version=app.config['VERSION'])
+
+
 if __name__ == "__main__":
     app.run(host='127.0.0.1', port=8080, debug=True)

backend/app/static/manifest.webmanifest

@@ -2,12 +2,13 @@
     "name": "KaraoQueue",
     "short_name": "KaraoQueue",
     "start_url": "/",
+    "url": "https://karaoqueue-323511.appspot.com/",
     "display": "standalone",
     "background_color": "#343a40",
     "description": "Eine Karaokewarteliste.",
     "icons": [{
-        "src": "images/touch/homescreen192.png",
-        "sizes": "192x192",
+        "src": "images/touch/homescreen512.png",
+        "sizes": "512x512",
         "type": "image/png"
     }],
     "related_applications": [{

backend/app/templates/base.html

@@ -75,7 +75,7 @@
             {% 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>-->
-            <span class="text-muted">KaraoQueue (stale branch) -&nbsp;<span>&copy</span>&nbsp;2019-2021 - Phillip
+            <span class="text-muted">KaraoQueue {{karaoqueue_version}} -&nbsp;<span>&copy</span>&nbsp;2019-21 - Phillip
                 Kühne</span>
         </div>
     </footer>

backend/app/templates/main_admin.html

@@ -146,6 +146,19 @@ table td:nth-child(2) {
        $("#entrytable").bootstrapTable('refresh')
     
     }
+
+    function markEntryAsTransferred(entry_id) {
+        $.ajax({
+         type: 'GET',
+         url: '/api/entries/mark_transferred/'+entry_id,
+         contentType: "application/json",
+         dataType: 'json',
+         async: false
+        });
+        $("#entrytable").bootstrapTable('refresh')
+     
+     }
+
     function DeleteSelectedEntries(ids) {
         $.ajax({
             type: 'POST',
@@ -182,7 +195,13 @@ table td:nth-child(2) {
         });
     }
     function TableActions (value, row, index) {
-        return "<button type=\"button\" class=\"btn btn-success\" data-toggle=\"tooltip\" data-placement=\"top\" title=\"Als gesungen markieren\" onclick=\"markEntryAsSung("+row.ID+")\"><i class=\"fas fa-check\"></i></button>&nbsp;<button type=\"button\" class=\"btn btn-danger\" data-toggle=\"tooltip\" data-placement=\"top\" title=\"Eintrag löschen\" onclick=\"confirmDeleteEntry('"+row.Name+"',"+row.ID+")\"><i class=\"fas fa-trash\"></i></button>";
+        let outerHTML = ""
+        if (row.Transferred==1) {
+            outerHTML = "<button type=\"button\" class=\"btn btn-default\" onclick=\"markEntryAsTransferred("+row.ID+")\"><i class=\"fas fa-backward\"></i></button>&nbsp;<button type=\"button\" class=\"btn btn-success\" data-toggle=\"tooltip\" data-placement=\"top\" title=\"Als gesungen markieren\" onclick=\"markEntryAsSung("+row.ID+")\"><i class=\"fas fa-check\"></i></button>&nbsp;<button type=\"button\" class=\"btn btn-danger\" data-toggle=\"tooltip\" data-placement=\"top\" title=\"Eintrag löschen\" onclick=\"confirmDeleteEntry('"+row.Name+"',"+row.ID+")\"><i class=\"fas fa-trash\"></i></button>";
+        } else {
+            outerHTML = "<button type=\"button\" class=\"btn btn-info\" onclick=\"markEntryAsTransferred("+row.ID+")\"><i class=\"fas fa-exchange-alt\"></i></button>&nbsp;<button type=\"button\" class=\"btn btn-success\" data-toggle=\"tooltip\" data-placement=\"top\" title=\"Als gesungen markieren\" onclick=\"markEntryAsSung("+row.ID+")\"><i class=\"fas fa-check\"></i></button>&nbsp;<button type=\"button\" class=\"btn btn-danger\" data-toggle=\"tooltip\" data-placement=\"top\" title=\"Eintrag löschen\" onclick=\"confirmDeleteEntry('"+row.Name+"',"+row.ID+")\"><i class=\"fas fa-trash\"></i></button>";
+        }
+        return outerHTML;
     }
     function getIdSelections() {
         return $.map($("#entrytable").bootstrapTable('getSelections'), function (row) {

backend/app/templates/songlist.html

@@ -111,6 +111,7 @@
 
     }
 
+    {% if not auth %}
     function entriesAccepted() {
         $.getJSON("/api/entries/accept", (data, out) => {
             if (data["value"] == 0) {
@@ -125,6 +126,11 @@
 
         })
     }
+    {% else %}
+    function entriesAccepted() {
+        $(".enqueueButton").prop("disabled", false)
+    }
+    {% endif %}
 
 </script>
 {% endblock %}