[FEATURE] Addition of Update CPU Info to Settings SysInfo Page (automatic-ripping-machine#1330)

* feature add for automatic-ripping-machine#1309

addition of cpu information update to settings

* ARM Wiki update with System Info

* PyLint fixes removing global variables

replaced global url values with flask url_for reference calls

* Version bump - FEATURE

* Logging error status fix

Author: microtechno9000

VERSION

@@ -1 +1 @@
-2.12.2
+2.13.0

arm-dependencies

@@ -1,13 +1,13 @@
 """
 ARM route blueprint for auth pages
 Covers
-- user_loader [..]
+- user_loader [GET, POST]
 - unauthorized_handler [GET]
 - login [GET, POST]
 - logout [GET]
 - update_password [GET, POST]
 """
-
+from sqlite3 import OperationalError
 import bcrypt
 from flask import redirect, render_template, request, Blueprint, flash, app, session
 from flask_login import LoginManager, login_required, \
@@ -26,18 +26,14 @@
 login_manager = LoginManager()
 login_manager.init_app(app)
 
-# Page definitions
-page_support_databaseupdate = "support/databaseupdate.html"
-redirect_settings = "/settings"
-
 
 @route_auth.route('/login', methods=['GET', 'POST'])
 def login():
     """
     Login page if login is enabled
     :return: redirect
     """
-    global page_support_databaseupdate
+    page_support_databaseupdate = "support/databaseupdate.html"
 
     # Check the database is current
     db_update = ui_utils.arm_db_check()
@@ -51,15 +47,17 @@ def login():
         user_list = User.query.all()
         # If we don't raise an exception but the usr table is empty
         if not user_list:
-            app.logger.debug("No admin found")
-    except Exception:
+            app.logger.error("No admin found")
+    except OperationalError as e:
+        # Handle no data found when querying the db
         flash(constants.NO_ADMIN_ACCOUNT, "danger")
-        app.logger.debug(constants.NO_ADMIN_ACCOUNT)
+        app.logger.error(constants.NO_ADMIN_ACCOUNT)
+        app.logger.error(f"ERROR: Missing Data in the ARM User Table: {e}")
         dbform = DBUpdate(request.form)
         db_update = ui_utils.arm_db_check()
         return render_template(page_support_databaseupdate, db_update=db_update, dbform=dbform)
 
-    # if user is logged in
+    # if a user is logged in
     if current_user.is_authenticated:
         return_redirect = redirect(constants.HOME_PAGE)
 
@@ -81,7 +79,7 @@ def login():
         else:
             flash("Something isn't right", "danger")
 
-    # If nothing has gone wrong give them the login page
+    # If nothing has gone wrong, give them the login page
     if request.method == 'GET' or return_redirect is None:
         return_redirect = render_template('login.html', form=form)
 
@@ -103,7 +101,7 @@ def logout():
 @login_required
 def update_password():
     """
-    updating password for the admin account
+    updating the password for the admin account
     """
     # get current user
     user = User.query.first()
@@ -131,10 +129,10 @@ def update_password():
                 return redirect("logout")
             except Exception as error:
                 flash(str(error), "danger")
-                app.logger.debug(f"Error in updating password: {error}")
+                app.logger.error(f"Error in updating password: {error}")
         else:
             flash("Password couldn't be updated. Problem with old password", "danger")
-            app.logger.info("Password not updated, issue with old password")
+            app.logger.error("Password not updated, issue with old password")
 
     return render_template('update_password.html', user=user.email, form=form)
 
@@ -148,15 +146,16 @@ def load_user(user_id):
     """
     try:
         return User.query.get(int(user_id))
-    except Exception:
-        app.logger.debug("Error getting user")
+    except OperationalError as e:
+        app.logger.error("Error getting user")
+        app.logger.error(f"ERROR: {e}")
         return None
 
 
 @login_manager.unauthorized_handler
 def unauthorized():
     """
-    User isn't authorised to view the page
-    :return: Page redirect
+    User isn't authorised to view the requested page
+    :return: redirect to login page
     """
     return redirect('/login')

arm/ui/auth/auth.py

@@ -9,7 +9,6 @@
 Other routes handled in flask blueprints
 - auth, database, history, jobs, logs, sendmovies, settings
 """
-
 import os
 import json
 from pathlib import Path, PurePath
@@ -19,6 +18,7 @@
 from flask.logging import default_handler  # noqa: F401
 from flask_login import LoginManager, login_required, \
     current_user, login_user, logout_user  # noqa: F401
+from sqlalchemy.exc import SQLAlchemyError
 
 import arm.ui.utils as ui_utils
 from arm.ui import app, db, constants
@@ -33,10 +33,6 @@
 # This attaches the armui_cfg globally to let the users use any bootswatch skin from cdn
 armui_cfg = ui_utils.arm_db_cfg()
 
-# Page definitions
-page_support_databaseupdate = "support/databaseupdate.html"
-redirect_settings = "/settings"
-
 # Define the Flask login manager
 login_manager = LoginManager()
 login_manager.init_app(app)
@@ -49,22 +45,20 @@ def home():
     """
     The main homepage showing current rips and server stats
     """
-    global page_support_databaseupdate
-
     # Check the database is current
     db_update = ui_utils.arm_db_check()
-    # Push out HW transcode status for homepage
+    # Push out HW transcode status for the homepage
     stats = {'hw_support': check_hw_transcode_support()}
     if not db_update["db_current"] or not db_update["db_exists"]:
         dbform = DBUpdate(request.form)
         app.logger.debug(f"Error with ARM DB: [{db_update['db_current']}]-[{db_update['db_exists']}]")
-        return render_template(page_support_databaseupdate, db_update=db_update, dbform=dbform)
+        return render_template("support/databaseupdate.html",
+                               db_update=db_update,
+                               dbform=dbform)
 
-    # System details in class server
+    # Get system details from Server Info and Config
     server = SystemInfo.query.filter_by(id="1").first()
     serverutil = ServerUtil()
-
-    # System details in class server
     arm_path = cfg.arm_config['TRANSCODE_PATH']
     media_path = cfg.arm_config['COMPLETED_PATH']
 
@@ -75,8 +69,9 @@ def home():
     if os.path.isfile(cfg.arm_config['DBFILE']):
         try:
             jobs = db.session.query(Job).filter(Job.status.notin_(['fail', 'success'])).all()
-        except Exception:
+        except SQLAlchemyError as e:
             # db isn't setup
+            app.logger.error(f"Error getting jobs from DB: {e}")
             return redirect(url_for('setup'))
     else:
         jobs = {}
@@ -176,7 +171,7 @@ def setup():
         return redirect("/error")
     except Exception as error:
         flash(str(error))
-        app.logger.debug("Setup - " + str(error))
+        app.logger.error("Setup - " + str(error))
         return redirect(constants.HOME_PAGE)
 
 
@@ -189,8 +184,9 @@ def load_user(user_id):
     """
     try:
         return User.query.get(int(user_id))
-    except Exception:
-        app.logger.debug("Error getting user")
+    except SQLAlchemyError as e:
+        app.logger.error("Error getting user")
+        app.logger.error(f"ERROR: {e}")
         return None
 
 

arm/ui/routes.py

@@ -12,6 +12,7 @@
 - drive_eject [GET]
 - drive_remove [GET]
 - testapprise [GET]
+- updateCPU [GET]
 """
 import platform
 import importlib
@@ -22,7 +23,7 @@
 from flask_login import login_required, \
     current_user, login_user, UserMixin, logout_user  # noqa: F401
 from flask import render_template, request, flash, \
-    redirect, Blueprint, session
+    redirect, Blueprint, session, url_for
 
 import arm.ui.utils as ui_utils
 from arm.ui import app, db
@@ -40,10 +41,6 @@
                            template_folder='templates',
                            static_folder='../static')
 
-# Page definitions
-page_settings = "settings/settings.html"
-redirect_settings = "/settings"
-
 
 @route_settings.route('/settings')
 @login_required
@@ -54,7 +51,6 @@ def settings():
     Overview - allows the user to update the all configs of A.R.M without
     needing to open a text editor
     """
-    global page_settings
 
     # stats for info page
     failed_rips = Job.query.filter_by(status="fail").count()
@@ -88,11 +84,9 @@ def settings():
     # ARM UI config
     armui_cfg = ui_utils.arm_db_cfg()
 
-    # System details in class server
+    # Get system details from Server Info and Config
     server = SystemInfo.query.filter_by(id="1").first()
     serverutil = ServerUtil()
-
-    # System details in class server
     arm_path = cfg.arm_config['TRANSCODE_PATH']
     media_path = cfg.arm_config['COMPLETED_PATH']
 
@@ -106,7 +100,7 @@ def settings():
 
     session["page_title"] = "Settings"
 
-    return render_template(page_settings,
+    return render_template("settings/settings.html",
                            settings=cfg.arm_config,
                            ui_settings=armui_cfg,
                            stats=stats,
@@ -222,7 +216,7 @@ def save_abcde():
     """
     Page - save_abcde_settings
     Method - POST
-    Overview - Save 'abcde Config' page settings to database. Not a user page
+    Overview - Save 'abcde Config' page settings to the database. Not a user page
     """
     success = False
     abcde_cfg_str = ""
@@ -241,7 +235,9 @@ def save_abcde():
         cfg.abcde_config = clean_abcde_str
 
     # If we get to here, there was no post-data
-    return {'success': success, 'settings': clean_abcde_str, 'form': 'abcde config'}
+    return {'success': success,
+            'settings': clean_abcde_str,
+            'form': 'abcde config'}
 
 
 @route_settings.route('/save_apprise_cfg', methods=['POST'])
@@ -275,8 +271,6 @@ def server_info():
     Method - POST
     Overview - Save 'System Info' page settings to database. Not a user page
     """
-    global redirect_settings
-
     # System Drives (CD/DVD/Blueray drives)
     form_drive = SystemInfoDrives(request.form)
     if request.method == 'POST' and form_drive.validate():
@@ -291,12 +285,12 @@ def server_info():
         drive.drive_mode = str(form_drive.drive_mode.data).strip()
         db.session.commit()
         flash(f"Updated Drive {drive.mount} details", "success")
-        # Return to systeminfo page (refresh page)
-        return redirect(redirect_settings)
+        # Return to the systeminfo page (refresh page)
+        return redirect(url_for('route_settings.settings'))
     else:
         flash("Error: Unable to update drive details", "error")
         # Return for GET
-        return redirect(redirect_settings)
+        return redirect(url_for('route_settings.settings'))
 
 
 @route_settings.route('/systemdrivescan')
@@ -306,24 +300,22 @@ def system_drive_scan():
     Method - GET
     Overview - Scan for the system drives and update the database.
     """
-    global redirect_settings
     # Update to scan for changes to the ripper system
     new_count = DriveUtils.drives_update()
     flash(f"ARM found {new_count} new drives", "success")
-    return redirect(redirect_settings)
+    return redirect(url_for('route_settings.settings'))
 
 
 @route_settings.route('/drive/eject/<eject_id>')
 @login_required
 def drive_eject(eject_id):
     """
-    Server System - change state of CD/DVD/BluRay drive - toggle eject
+    Server System - change state of CD/DVD/BluRay drive - toggle eject status
     """
-    global redirect_settings
     drive = SystemDrives.query.filter_by(drive_id=eject_id).first()
     drive.open_close()
     db.session.commit()
-    return redirect(redirect_settings)
+    return redirect(url_for('route_settings.settings'))
 
 
 @route_settings.route('/drive/remove/<remove_id>')
@@ -332,7 +324,6 @@ def drive_remove(remove_id):
     """
     Server System - remove a drive from the ARM UI
     """
-    global redirect_settings
     try:
         app.logger.debug(f"Removing drive {remove_id}")
         drive = SystemDrives.query.filter_by(drive_id=remove_id).first()
@@ -343,7 +334,7 @@ def drive_remove(remove_id):
     except Exception as e:
         app.logger.error(f"Drive removal encountered an error: {e}")
         flash("Drive unable to be removed, check logs for error", "error")
-    return redirect(redirect_settings)
+    return redirect(url_for('route_settings.settings'))
 
 
 @route_settings.route('/drive/manual/<manual_id>')
@@ -390,11 +381,41 @@ def testapprise():
     Method - GET
     Overview - Send a test notification to Apprise.
     """
-    global redirect_settings
     # Send a sample notification
     message = "This is a notification by the ARM-Notification Test!"
     if cfg.arm_config["UI_BASE_URL"] and cfg.arm_config["WEBSERVER_PORT"]:
         message = message + f" Server URL: http://{cfg.arm_config['UI_BASE_URL']}:{cfg.arm_config['WEBSERVER_PORT']}"
     ripper_utils.notify(None, "ARM notification", message)
     flash("Test notification sent ", "success")
-    return redirect(redirect_settings)
+    return redirect(url_for('route_settings.settings'))
+
+
+@route_settings.route('/updatecpu')
+def update_cpu():
+    """
+    Update system CPU information
+    """
+    # Get current system information from database
+    current_system = SystemInfo.query.first()
+    # Query system for new information
+    new_system = SystemInfo()
+
+    app.logger.debug("****** System Information ******")
+    if current_system is not None:
+        app.logger.debug(f"Name old [{current_system.name}] new [{new_system.name}]")
+        app.logger.debug(f"Name old [{current_system.cpu}] new [{new_system.cpu}]")
+        current_system.name = new_system.name
+        current_system.cpu = new_system.cpu
+        db.session.add(current_system)
+
+    else:
+        app.logger.debug(f"Name old [] new [{new_system.name}]")
+        app.logger.debug(f"Name old [] new [{new_system.cpu}]")
+        db.session.add(new_system)
+
+    app.logger.debug("****** End System Information ******")
+    app.logger.info(f"Updated CPU Details with new info - {new_system.name} - {new_system.cpu}")
+
+    db.session.commit()
+
+    return redirect(url_for('route_settings.settings'))