ail-framework/var/www/modules/dashboard/Flask_dashboard.py

#!/usr/bin/env python3
# -*-coding:UTF-8 -*

'''
    Flask functions and routes for the dashboard page
'''
import json
import os
import sys
import datetime
import time
import flask

from flask import Flask, render_template, jsonify, request, Blueprint, url_for, stream_with_context

from Role_Manager import login_admin, login_read_only
from flask_login import login_required

sys.path.append(os.environ['AIL_BIN'])
##################################
# Import Project packages
##################################
from lib import ail_queues
from lib import ail_updates

from packages.Date import Date

# ============ VARIABLES ============
import Flask_config

app = Flask_config.app
config_loader = Flask_config.config_loader
baseUrl = Flask_config.baseUrl
r_serv_log = Flask_config.r_serv_log

max_dashboard_logs = Flask_config.max_dashboard_logs

dashboard = Blueprint('dashboard', __name__, template_folder='templates')

# ============ FUNCTIONS ============
def event_stream():
    pubsub = r_serv_log.pubsub()
    pubsub.psubscribe("Script" + '.*')
    try:
        for msg in pubsub.listen():
            mtype = msg['type']
            pattern = msg['pattern']
            channel = msg['channel']
            data = msg['data']

            msg = {'channel': channel, 'type': mtype, 'pattern': pattern, 'data': data}

            level = (msg['channel']).split('.')[1]
            if msg['type'] == 'pmessage' and level != "DEBUG":
                yield 'data: %s\n\n' % json.dumps(msg)
    except GeneratorExit:
        print("Generator Exited")
        pubsub.unsubscribe()

def event_stream_dashboard():
    try:
        while True:
            data = {'queues': get_queues()}
            yield f'data: {json.dumps(data)}\n\n'
            time.sleep(1)
    except GeneratorExit:
        print("Generator dashboard Exited")
        pass

def get_queues():
    # We may want to put the llen in a pipeline to do only one query.
    return ail_queues.get_modules_queues_stats()

def get_date_range(date_from, num_day):
    date = Date(str(date_from[0:4])+str(date_from[4:6]).zfill(2)+str(date_from[6:8]).zfill(2))
    date_list = []

    for i in range(0, num_day+1):
        new_date = date.substract_day(i)
        date_list.append(f'{new_date[0:4]}-{new_date[4:6]}-{new_date[6:8]}')

    return date_list

def dashboard_alert(log):
    # check if we need to display this log
    if len(log) > 50:
        date = log[1:5]+log[6:8]+log[9:11]
        utc_str = log[1:20]
        log = log[46:].split(';')
        if len(log) == 6:
            date_time = datetime_from_utc_to_local(utc_str)
            path = url_for('investigations_b.get_object_gid', gid=log[5])

            res = {'date': date, 'time': date_time, 'script': log[0], 'domain': log[1], 'date_paste': log[2],
                   'paste': log[3], 'message': log[4], 'path': path}
            return res
        else:
            return False
    else:
        return False

def datetime_from_utc_to_local(utc_str):
    utc_datetime = datetime.datetime.strptime(utc_str, '%Y-%m-%d %H:%M:%S')
    now_timestamp = time.time()
    offset = datetime.datetime.fromtimestamp(now_timestamp) - datetime.datetime.utcfromtimestamp(now_timestamp)
    local_time_str = (utc_datetime + offset).strftime('%H:%M:%S')
    return local_time_str

# ============ ROUTES ============

@dashboard.route("/_logs")
@login_required
@login_read_only
def logs():
    return flask.Response(event_stream(), mimetype="text/event-stream")

@dashboard.route("/_dashboard")
@login_required
@login_read_only
def _dashboard():
    return flask.Response(stream_with_context(event_stream_dashboard()), content_type="text/event-stream")

@dashboard.route("/_get_last_logs_json")
@login_required
@login_read_only
def get_last_logs_json():
    date = datetime.datetime.now().strftime("%Y%m%d")

    max_day_search = 6
    day_search = 0
    warning_found = 0
    warning_to_found = max_dashboard_logs

    last_logs = []

    date_range = get_date_range(date, max_day_search)
    while max_day_search != day_search and warning_found != warning_to_found:

        filename_warning_log = f'logs/Script_warn-{date_range[day_search]}.log'
        filename_log = os.path.join(os.environ['AIL_HOME'], filename_warning_log)

        try:
            with open(filename_log, 'r') as f:
                lines = f.read().splitlines()
                curr_index = -1
                while warning_found != warning_to_found:
                    try:
                        # get lasts warning logs
                        log_warn = dashboard_alert(lines[curr_index])
                        if log_warn != False:
                            last_logs.append(log_warn)
                            warning_found = warning_found + 1
                        curr_index = curr_index - 1

                    except IndexError:
                        # check previous warning log file
                        day_search = day_search + 1
                        break
        except FileNotFoundError:
            # check previous warning log file
            day_search = day_search + 1

    return jsonify(list(reversed(last_logs)))


@dashboard.route("/_stuff", methods=['GET'])
@login_required
@login_read_only
def stuff():
    return jsonify(row1=get_queues())


# TODO: ADD UPDATE NOTE BY USER
@dashboard.route("/")
@login_required
@login_read_only
def index():
    default_minute = config_loader.get_config_str("Flask", "minute_processed_paste")
    threshold_stucked_module = config_loader.get_config_int("Module_ModuleInformation", "threshold_stucked_module")
    log_select = {10, 25, 50, 100}
    log_select.add(max_dashboard_logs)
    log_select = list(log_select)
    log_select.sort()

    # Check if update in progress
    background_update = False
    update_message = ''
    if ail_updates.is_update_background_running():
        background_update = True
        update_message = ail_updates.AILBackgroundUpdate(ail_updates.get_update_background_version()).get_message()

    return render_template("index.html", default_minute = default_minute,
                           threshold_stucked_module=threshold_stucked_module,
                           log_select=log_select, selected=max_dashboard_logs,
                           background_update=background_update, update_message=update_message)


# ========= REGISTRATION =========
app.register_blueprint(dashboard, url_prefix=baseUrl)