Source code for invenio_sip2.views.rest

# -*- coding: utf-8 -*-
#
# INVENIO-SIP2
# Copyright (C) 2020 UCLouvain
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

"""API blueprint for Invenio-SIP2."""

from __future__ import absolute_import, print_function

from flask import Blueprint, jsonify

from invenio_sip2.decorators import need_permission
from invenio_sip2.records.record import Client, Server

api_blueprint = Blueprint(
    'api_sip2',
    __name__,
    url_prefix='/monitoring/sip2'
)


@api_blueprint.route('/status')
@need_permission('api-monitoring')
def status():
    """Display status for all SIP2 server."""
    return jsonify(Monitoring.status())


@api_blueprint.route('/servers')
@need_permission('api-monitoring')
def get_servers():
    """Display all running SIP2 servers."""
    try:
        return jsonify({'servers': Server.get_all_records()})
    except Exception as error:
        return jsonify({'ERROR': str(error)})


@api_blueprint.route('/servers/<string:server_id>')
@need_permission('api-monitoring')
def get_server(server_id):
    """Display all running SIP2 servers."""
    try:
        server = Server.get_record_by_id(server_id)
        server['clients'] = Monitoring.get_clients_by_server_id(server_id)
        return jsonify({
            'id': server.id,
            'metadata': server,
        })
    except Exception as error:
        return jsonify({'ERROR': str(error)})


@api_blueprint.route('/clients')
@need_permission('api-monitoring')
def get_clients():
    """Display all connected clients to server."""
    try:
        return jsonify({'clients': Client.get_all_records()})
    except Exception as error:
        return jsonify({'ERROR': str(error)})


class Monitoring:
    """Monitoring class."""

    @classmethod
    def status(cls):
        """Check status for all servers."""
        result = {}
        servers = cls.get_servers()
        result['servers'] = len(servers)
        result['clients'] = len(Client.get_all_records())
        result['status'] = 'green'
        if result['servers']:
            info = {}
            for server in servers:
                info[server.id] = {}
                info[server.id]['status'] = server.get('status')
                info[server.id]['nb_client'] = \
                    cls.get_number_client_by_server(server.id)
                if info[server.id]['status'] == 'down':
                    result['status'] = 'red'
                result['servers_info'] = info
        return result

    @classmethod
    def get_number_client_by_server(cls, server_id):
        """Get total number of clients by server."""
        server = Server.get_record_by_id(server_id)
        return server.number_of_clients

    @classmethod
    def get_servers(cls):
        """Get list of servers."""
        servers = Server.get_all_records()
        return servers

    @classmethod
    def get_clients_by_server_id(cls, server_id):
        """Get list of clients by server id."""
        server = Server.get_record_by_id(server_id)
        if server:
            return server.get_clients()