V0.6 cleanup (#78)

* cleanup structure

* More logging and Error Catching

add `/` to self.snap and self.clip and replace `//api` with `/api` to make sure the fetch url is correct.
Add more logging to the Fetch functions
Standardize Log Output
Stnadardize returns to a dict with values of error, msg, exception
Change camera and frigate instance name to a input/text box instead of hidden.
Change show to a checkbox instead of actually printing True or False in a textbox

* Frigate Setup

Fixed errors while editing frigate instances.

Author: BeardedTek

-d

@@ -0,0 +1,5 @@
+# Netscape HTTP Cookie File
+# https://curl.se/docs/http-cookies.html
+# This file was generated by libcurl! Edit at your own risk.
+
+#HttpOnly_localhost	FALSE	/	FALSE	1657536008	fEVR_Session	eyJfcGVybWFuZW50Ijp0cnVlfQ.Ysv3AA.nb-2fPLFOwCK9MyzB-wiSRfX5Eo

.dockerignore

@@ -0,0 +1,13 @@
+.cache
+.env
+.git
+.gitattributes
+.gitignore
+.github
+docs
+docker-compose.yml
+install.sh
+README.md
+template.env
+test
+venv

.drone.yml

@@ -4,7 +4,7 @@ image_pull_secrets:
   - docker-auth-beardedtek.com
 trigger:
   branch:
-    - main
+    - v0.6-cleanup
   event:
     - push
 steps:
@@ -19,7 +19,7 @@ steps:
       from_secret: docker_password
     repo: docker.beardedtek.com/beardedtek/fevr
     registry: docker.beardedtek.com
-    tags: latest,${DRONE_REPO_BRANCH},0.6
+    tags: dev,${DRONE_REPO_BRANCH}
     experimental: true
     compress: true
     squash: true

app/__init__.py

@@ -16,57 +16,58 @@
 #    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 # External Imports
-from flask import Flask, session, jsonify
-from flask_sqlalchemy import SQLAlchemy, inspect
-from sqlalchemy import desc
+from flask import Flask, session
+from flask_sqlalchemy import SQLAlchemy
 import json
 from flask_login import LoginManager
 from datetime import timedelta
-from datetime import datetime
-from dateutil import tz
 import pytz
-from os import environ,path,access,R_OK
+
+# Config File
+configFile = "data/config"
 
 # Flask app Setup
 app = Flask(__name__)
 app.config.from_file('config.json',load=json.load)
 
-login_mgr = LoginManager(app)
-login_mgr.login_view = 'login'
-login_mgr.refresh_view = 'relogin'
-login_mgr.needs_refresh_message = (u"Session timedout, please re-login")
-login_mgr.needs_refresh_message_category = "info"
+
+
+# Setup Session Timeout
 @app.before_request
 def before_request():
     session.permanent = True
     app.permanent_session_lifetime = timedelta(minutes=30)
 
 # Database Setup
-
 db = SQLAlchemy(app)
 app.SQLALCHEMY_TRACK_MODIFICATIONS=False
 
+from app.models.user import User
+
+# Flask Login Setup
 login_manager = LoginManager()
 login_manager.login_view = 'auth.login'
 login_manager.init_app(app)
 
-from .models.models import User, mqtt
-
 @login_manager.user_loader
 def load_user(user_id):
     return User.query.get(int(user_id))
-from .api import api as api_blueprint
+
+# Import Blueprints
+from app.blueprints.api import api as api_blueprint
 app.register_blueprint(api_blueprint)
 
-from .main import main as main_blueprint
+from app.blueprints.main import main as main_blueprint
 app.register_blueprint(main_blueprint)
 
-from .auth import auth as auth_blueprint
+from app.blueprints.auth import auth as auth_blueprint
 app.register_blueprint(auth_blueprint)
 
-from .setup import setup as setup_blueprint
+from app.blueprints.setup import setup as setup_blueprint
 app.register_blueprint(setup_blueprint)
 
+
+# Define Templates
 @app.template_filter('timezone')
 def convertTZ(time,clockFmt=12,Timezone="America/Anchorage"):
         dt_utc = time
@@ -77,41 +78,4 @@ def convertTZ(time,clockFmt=12,Timezone="America/Anchorage"):
         else:
             outformat = "%-m/%-d/%y %H:%M:%S"
         outTime = dt.strftime(outformat).lower()
-        return outTime
-
-# Setup mqtt_client
-# Gather environment variables in a dict
-# NOTE: Environment Variables are only used if app/data/config.json does not exist.
-
-def writeConfigFile(file,ev):
-    config = {}
-    config["fevr_url"] = f"{ev['FEVR_URL']}:{ev['FEVR_PORT']}"
-    if ev["MQTT_TRANSPORT"] == "https" or ev["MQTT_TRANSPORT"] == "https://":
-        config["fevr_transport"] = "https://"
-    else:
-        config["fevr_transport"] = "http://"
-    config["fevr_apikey"] = ev["MQTT_APIAUTH_KEY"]
-    config["mqtt_broker"] = ev["MQTT_BROKER"]
-    config["mqtt_port"] = ev["MQTT_BROKER_PORT"]
-    config["mqtt_user"] = ev["MQTT_BROKER_USER"]
-    config["mqtt_password"] = ev["MQTT_BROKER_PASSWORD"]
-    config["mqtt_topics"] = ev["MQTT_TOPICS"]
-    config["verbose"] = ev["MQTT_VERBOSE_LOGGING"]
-    with open('/fevr/app/data/config.json', "w") as configFile:
-        json.dump(config,configFile,sort_keys=True,indent=0)
-
-ev = {}
-ev["MQTT_BROKER_PORT"] = environ.get("MQTT_BROKER_PORT")
-ev["MQTT_TOPICS"] = environ.get("MQTT_TOPICS")
-ev["MQTT_BROKER_USER"] = environ.get("MQTT_BROKER_USER")
-ev["MQTT_BROKER_PASSWORD"] = environ.get("MQTT_BROKER_PASSWORD")
-ev["MQTT_TRANSPORT"] = environ.get("MQTT_TRANSPORT")
-ev["MQTT_BROKER"] = environ.get("MQTT_BROKER")
-ev["MQTT_APIAUTH_KEY"] = environ.get("MQTT_APIAUTH_KEY")
-ev["FEVR_URL"] = environ.get('FEVR_URL')
-ev["FEVR_PORT"] = environ.get('FEVR_PORT')
-ev["MQTT_VERBOSE_LOGGING"] = environ.get("MQTT_VERBOSE_LOGGING")
-
-config="/fevr/app/data/config.json"
-if not path.isfile(config) or not access(config, R_OK):
-    writeConfigFile(config,ev)
+        return outTime

app/api.py renamed to app/blueprints/api.py

@@ -24,11 +24,15 @@
 import os
 import shutil
 
-from .models.models import events,frigate,cameras
-from . import db
-from .fetch import Fetch
-from .helpers.cookies import cookies
-from .helpers.iterateQuery import iterateQuery
+from app.models.frigate import frigate
+from app.models.events import events
+from app.models.frigate import frigate
+from app.models.cameras import cameras
+from app import db
+from app.helpers.fetch import Fetch
+from app.helpers.cookies import cookies
+from app.helpers.iterateQuery import iterateQuery
+from app.helpers.logit import logit
 
 # API Routes
 api = Blueprint('api',__name__)
@@ -75,6 +79,7 @@ def apiFrigate():
 @api.route('/api/events/add/<eventid>/<camera>/<object>/<score>')
 @login_required
 def apiAddEvent(eventid,camera,score,object):
+    source = "fEVR | EVENT ADD"
     time = datetime.fromtimestamp(int(eventid.split('.')[0]))
     # Define default JSON return value
     rVal = {'error':0,
@@ -86,36 +91,40 @@ def apiAddEvent(eventid,camera,score,object):
             'score':score}
     db.create_all()
     Cameras = cameras.query.filter_by(camera=camera).first()
-    if not Cameras:
-        rVal["msg"] = "Camera Not Defined"
+    if Cameras:
+        show = True if Cameras.show else False
+        # Check if eventid already exists
+        if events.query.filter_by(eventid=eventid).first():
+            rVal["msg"] = 'Event Already Exists'
+            rVal["error"] = 2
+        else: 
+            try:
+                fetchPath = f"{os.getcwd()}/app/static/events/{eventid}/"
+                logit.execute(f"Fetching event into {fetchPath}",src=source)
+                frigateConfig = apiFrigate()
+                fetched = False
+                for frigate in frigateConfig:
+                    logit.execute(f"Trying to fetch from {frigateConfig[frigate]['url']}",src=source)
+                    frigateURL = frigateConfig[frigate]["url"]
+                    Fetched = Fetch(fetchPath,eventid,frigateURL)
+                    logit.execute(f"Fetched {Fetched.event}", src=source)
+                    fetched = True
+                if not fetched:
+                    rVal["msg"] = "Cannot Fetch"
+                    rVal["error"] = 3
+            except Exception as e:
+                rVal["error"] = 4
+                rVal["msg"] = str(e).replace('"','')
+            try:
+                event = events(eventid=eventid,camera=camera,object=object,score=int(score),ack='',time=time,show=show)
+                db.session.add(event)
+                db.session.commit()
+            except Exception as e:
+                rVal["error"] = 5
+                rVal["msg"] = str(e).replace('"','')
+    else:
+        rVal["msg"] = f"Camera '{camera}' Not Defined"
         rVal["error"] = 1
-    show = True if Cameras.show else False
-    # Check if eventid already exists
-    if events.query.filter_by(eventid=eventid).first():
-        rVal["msg"] = 'Event Already Exists'
-        rVal["error"] = 2
-    else: 
-        try:
-            fetchPath = f"{os.getcwd()}/app/static/events/{eventid}/"
-            frigateConfig = apiFrigate()
-            fetched = False
-            for frigate in frigateConfig:
-                frigateURL = frigateConfig[frigate]["url"]
-                print(Fetch(fetchPath,eventid,frigateURL))
-                fetched = True
-            if not fetched:
-                rVal["msg"] = "Cannot Fetch"
-                rVal["error"] = 3
-        except Exception as e:
-            rVal["error"] = 4
-            rVal["msg"] = str(e).replace('"','')
-        try:
-            event = events(eventid=eventid,camera=camera,object=object,score=int(score),ack='',time=time,show=show)
-            db.session.add(event)
-            db.session.commit()
-        except Exception as e:
-            rVal["error"] = 5
-            rVal["msg"] = str(e).replace('"','')
     return jsonify(rVal)
 
 @api.route('/api/events/ack/<eventid>')
@@ -152,7 +161,7 @@ def apiDelEvent(eventid):
     if os.path.exists(eventPath):
         shutil.rmtree(eventPath)
     db.session.commit()
-    return redirect(url_for('main.index'))
+    return redirect(cookiejar['page'])
 
 @api.route('/api/events/latest')
 @login_required

app/auth.py renamed to app/blueprints/auth.py

@@ -15,16 +15,19 @@
 #    You should have received a copy of the GNU AfferoGeneral Public License
 #    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-import ipaddress
 from flask import Blueprint, render_template, redirect, url_for, request, flash, jsonify, make_response
 from werkzeug.security import generate_password_hash, check_password_hash
 from flask_login import login_user, logout_user, login_required, current_user
 from IPy import IP
+import sqlite3
 
-from .models.models import User, apiAuth, cameras
-from . import db
-from .rndpwd import randpwd
-from  .helpers.cookies import cookies
+from app.models.user import User
+from app.models.apiauth import apiAuth
+from app.models.cameras import cameras
+from app import db
+from app.helpers.rndpwd import randpwd
+from app.helpers.cookies import cookies
+from app.helpers.logit import logit
 
 auth = Blueprint('auth', __name__)
 
@@ -79,6 +82,7 @@ def validIP(ip):
 
 @auth.route('/apiAuth',methods=['POST'])
 def apiAuthenticate():
+    source = "fEVR | AUTH"
     ip = request.remote_addr
     auth = {"auth":False,"name":None,"authIP":ip,"changed":False,"remember":False}
     requestData = request.get_json()
@@ -113,6 +117,9 @@ def apiAuthenticate():
                         # If we changed they key limit or set it to expired, commit it to the database.
                         if auth['changed']:
                             db.session.commit()
+    success = "successful" if auth['auth'] else "failed"
+    keyname = f"{auth['name']} " if auth['name'] else ""
+    logit.execute(f"Authentication {success} by key {keyname}from {auth['authIP']}",src=source)
     return jsonify(auth)
 
 @auth.route('/login',methods=['GET'])
@@ -133,7 +140,7 @@ def login():
 
 @auth.route('/login', methods=['POST'])
 def loginProcessForm():
-    
+    source="fEVR | LOGIN"
     # login code goes here
     email = request.form.get('email')
     password = request.form.get('password')
@@ -142,16 +149,20 @@ def loginProcessForm():
         fwd = request.form.get('fwd')
     else:
         fwd = "/"
-
-    user = User.query.filter_by(email=email).first()
-
-    # check if the user actually exists
-    # take the user-supplied password, hash it, and compare it to the hashed password in the database
-    if not user or not check_password_hash(user.password, password):
-        flash('Please check your login details and try again.')
-        return redirect(url_for('auth.login')) # if the user doesn't exist or password is wrong, reload the page
-    # if the above check passes, then we know the user has the right credentials
-    login_user(user, remember=remember)
+    try:
+        user = User.query.filter_by(email=email).first()
+        # check if the user actually exists
+        # take the user-supplied password, hash it, and compare it to the hashed password in the database
+        if not user or not check_password_hash(user.password, password):
+            flash('Please check your login details and try again.')
+            return redirect(url_for('auth.login')) # if the user doesn't exist or password is wrong, reload the page
+        # if the above check passes, then we know the user has the right credentials
+        login_user(user, remember=remember)
+    except Exception as e:
+        if "no such table" in str(e):
+            logit.execute("Database is missing. Please visit `/setup` to complete setup.",src=source)
+        else:
+            logit.execute(e,src=source)
     return redirect(fwd)
 
 @auth.route('/signup')