Merge pull request #13 from DarkflameUniverse/logging

Logging

.gitignore

@@ -14,3 +14,4 @@ locale.xml
 app/luclient/*
 app/cache/*
 property_files/*
+*.log

app/__init__.py

@@ -1,5 +1,5 @@
 import os
-from flask import Flask, url_for, g, redirect
+from flask import Flask, url_for, g, redirect, render_template
 from functools import wraps
 from flask_assets import Environment
 from webassets import Bundle
@@ -7,7 +7,7 @@ import time
 from app.models import db, migrate, PlayKey
 from app.schemas import ma
 from app.forms import CustomUserManager
-from flask_user import user_registered, current_user
+from flask_user import user_registered, current_user, user_logged_in
 from flask_wtf.csrf import CSRFProtect
 from flask_apscheduler import APScheduler
 from app.luclient import query_cdclient, register_luclient_jinja_helpers
@@ -15,6 +15,11 @@ from app.luclient import query_cdclient, register_luclient_jinja_helpers
 from app.commands import init_db, init_accounts, load_property, gen_image_cache, gen_model_cache
 from app.models import Account, AccountInvitation
 
+import logging
+from logging.handlers import RotatingFileHandler
+
+from werkzeug.exceptions import HTTPException
+
 # Instantiate Flask extensions
 csrf_protect = CSRFProtect()
 scheduler = APScheduler()
@@ -22,7 +27,6 @@ scheduler = APScheduler()
 
 
 def create_app():
-
     app = Flask(__name__, instance_relative_config=True)
 
     # decrement uses on a play key after a successful registration
@@ -33,8 +37,19 @@ def create_app():
             play_key_used = PlayKey.query.filter(PlayKey.id == user.play_key_id).first()
             play_key_used.key_uses = play_key_used.key_uses - 1
             play_key_used.times_used = play_key_used.times_used + 1
+            app.logger.info(
+                f"USERS::REGISTRATION User with ID {user.id} and name {user.username} Registered \
+                using Play Key ID {play_key_used.id} : {play_key_used.key_string}"
+                )
             db.session.add(play_key_used)
             db.session.commit()
+        else:
+            app.logger.info(f"USERS::REGISTRATION User with ID {user.id} and name {user.username} Registered")
+
+
+    @user_logged_in.connect_via(app)
+    def _after_login_hook(sender, user, **extra):
+        app.logger.info(f"{user.username} Logged in")
 
     # A bunch of jinja filters to make things easiers
     @app.template_filter('ctime')
@@ -51,15 +66,24 @@ def create_app():
         else:
             return 0 & (1 << bit)
 
+    @app.template_filter('debug')
+    def debug(text):
+        print(text)
+
     @app.teardown_appcontext
     def close_connection(exception):
         cdclient = getattr(g, '_cdclient', None)
         if cdclient is not None:
             cdclient.close()
 
-    @app.template_filter('debug')
-    def debug(text):
-        print(text)
+    @app.errorhandler(Exception)
+    def handle_exception(e):
+        app.logger.error(e)
+        # pass through HTTP errors
+        if isinstance(e, HTTPException):
+            return e
+        # now you're handling non-HTTP exceptions only
+        return render_template("status_codes/500.html.j2", exception=e), 500
 
     # add the commands to flask cli
     app.cli.add_command(init_db)
@@ -68,6 +92,7 @@ def create_app():
     app.cli.add_command(gen_image_cache)
     app.cli.add_command(gen_model_cache)
 
+    register_logging(app)
     register_settings(app)
     register_extensions(app)
     register_blueprints(app)
@@ -132,6 +157,14 @@ def register_blueprints(app):
     app.register_blueprint(reports_blueprint, url_prefix='/reports')
 
 
+def register_logging(app):
+    # file logger
+    file_handler = RotatingFileHandler('nexus_dashboard.log', maxBytes=1024 * 1024 * 100, backupCount=20)
+    file_handler.setLevel(logging.INFO)
+    formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+    file_handler.setFormatter(formatter)
+    app.logger.addHandler(file_handler)
+
 
 def register_settings(app):
     """Register setting from setting and env

app/accounts.py

@@ -1,4 +1,4 @@
-from flask import render_template, Blueprint, redirect, url_for, request, abort, current_app, flash
+from flask import render_template, Blueprint, redirect, url_for, request, abort, current_app, flash, current_app
 from flask_user import login_required, current_user
 import json
 from datatables import ColumnDT, DataTables

app/main.py

@@ -6,6 +6,7 @@ from wand import image
 from app.models import Account, AccountInvitation, CharacterInfo
 from app.schemas import AccountSchema, CharacterInfoSchema
 from app.luclient import query_cdclient
+from app import gm_level
 
 main_blueprint = Blueprint('main', __name__)
 
@@ -40,3 +41,37 @@ def favicon():
         'favicon.ico',
         mimetype='image/vnd.microsoft.icon'
     )
+
+@main_blueprint.route('/logs')
+@gm_level(9)
+def logs():
+    with open('nexus_dashboard.log', 'r') as file:
+        logs = tail(file, 100)
+    return render_template('main/logs.html.j2', logs=logs)
+
+def tail( f, lines=20 ):
+    total_lines_wanted = lines
+
+    BLOCK_SIZE = 1024
+    f.seek(0, 2)
+    block_end_byte = f.tell()
+    lines_to_go = total_lines_wanted
+    block_number = -1
+    blocks = [] # blocks of size BLOCK_SIZE, in reverse order starting
+                # from the end of the file
+    while lines_to_go > 0 and block_end_byte > 0:
+        if (block_end_byte - BLOCK_SIZE > 0):
+            # read the last block we haven't yet read
+            f.seek(block_number*BLOCK_SIZE, 2)
+            blocks.append(f.read(BLOCK_SIZE))
+        else:
+            # file too small, start from begining
+            f.seek(0,0)
+            # only read what was not read
+            blocks.append(f.read(block_end_byte))
+        lines_found = blocks[-1].count('\n')
+        lines_to_go -= lines_found
+        block_end_byte -= BLOCK_SIZE
+        block_number -= 1
+    all_read_text = ''.join(reversed(blocks))
+    return '</br>'.join(all_read_text.splitlines()[-total_lines_wanted:])

app/reports.py

@@ -1,4 +1,4 @@
-from flask import render_template, Blueprint, redirect, url_for, request, abort, flash, request
+from flask import render_template, Blueprint, redirect, url_for, request, abort, flash, request, current_app
 from flask_user import login_required, current_user
 from app.models import db, CharacterInfo, Account, CharacterXML, Reports
 from app import gm_level, scheduler
@@ -37,13 +37,15 @@ def uscore_by_date(date):
 
 @scheduler.task("cron", id="gen_item_report", hour=23)
 def gen_item_report():
+    try:
+        current_app.logger.info("Start Item Report Generation")
         with scheduler.app.app_context():
             date = datetime.date.today().strftime('%Y-%m-%d')
             report = Reports.query.filter(Reports.date==date).filter(Reports.report_type=="items").first()
 
             # Only one report per day
             if report != None:
-            return f"Item Report Already Generated for {date}"
+                current_app.logger.info(f"Item Report Already Generated for {date}")
 
             char_xmls = CharacterXML.query.join(
                             CharacterInfo,
@@ -75,19 +77,23 @@ def gen_item_report():
             )
 
             new_report.save()
-
-        return f"Generated Item Report for {date}"
+        current_app.logger.info(f"Generated Item Report for {date}")
+    except Exception as e:
+        current_app.logger.critical(f"REPORT::ITEMS - {e}")
+    return
 
 
 @scheduler.task("cron", id="gen_currency_report", hour=23)
 def gen_currency_report():
+    try:
+        current_app.logger.info("Start Currency Report Generation")
         with scheduler.app.app_context():
             date = datetime.date.today().strftime('%Y-%m-%d')
             report = Reports.query.filter(Reports.date==date).filter(Reports.report_type=="currency").first()
 
             # Only one report per day
             if report != None:
-            return f"Currency Report Already Generated for {date}"
+                current_app.logger.info(f"Currency Report Already Generated for {date}")
 
             characters = CharacterXML.query.join(
                             CharacterInfo,
@@ -113,19 +119,23 @@ def gen_currency_report():
             )
 
             new_report.save()
-
-        return f"Generated Currency Report for {date}"
+        current_app.logger.info(f"Generated Currency Report for {date}")
+    except Exception as e:
+        current_app.logger.critical(f"REPORT::CURRENCY - {e}")
+    return
 
 
 @scheduler.task("cron", id="gen_uscore_report", hour=23)
 def gen_uscore_report():
+    try:
+        current_app.logger.info("Start U-Score Report Generation")
         with scheduler.app.app_context():
             date = datetime.date.today().strftime('%Y-%m-%d')
             report = Reports.query.filter(Reports.date==date).filter(Reports.report_type=="uscore").first()
 
             # Only one report per day
             if report != None:
-            return f"U-Score Report Already Generated for {date}"
+                current_app.logger.info(f"U-Score Report Already Generated for {date}")
 
             characters = CharacterXML.query.join(
                             CharacterInfo,
@@ -151,5 +161,7 @@ def gen_uscore_report():
             )
 
             new_report.save()
-
-        return f"Generated U-Score Report for {date}"
+        current_app.logger.info(f"Generated U-Score Report for {date}")
+    except Exception as e:
+        current_app.logger.critical(f"REPORT::U-SCORE - {e}")
+    return

app/templates/main/logs.html.j2

@@ -0,0 +1,13 @@
+{% extends 'base.html.j2' %}
+
+{% block title %}LOGS{% endblock %}
+
+{% block content_before %}
+ LOGS - {{ config.APP_NAME }}
+{% endblock %}
+
+{% block content_override %}
+  <code>
+    {{ logs }}
+  </code>
+{% endblock %}

app/templates/status_codes/500.html.j2

@@ -0,0 +1,18 @@
+{% extends 'base.html.j2' %}
+
+{% block title %}ERROR{% endblock %}
+
+{% block content_before %}
+ ERROR - {{ config.APP_NAME }}
+{% endblock %}
+
+{% block content %}
+  {% if current_user.gm_level == 9 %}
+    <code>
+      {{ exception }}
+    </code>
+  {% else %}
+    <h2 class="text-center">An Error has Occurred!!!</h2>
+    <div>Please Report this to an Admin</div>
+  {% endif %}
+{% endblock %}