mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
7f4c5f7410
- The last part of the module import path is the module name. This also becomes the Django app name. Apps names have to be unique. Hence, there is no scope for two different modules with same name but different load path to exist in the project. - Most uses of list of loaded modules are dealing with app names instead of full module load path. This is due to the fact that Django deals with app names and not module paths. - It is also somewhat clumsy to access a loaded module as we are re-importing every time to get access module. - Simplify all of the above by using app names are module identifiers and maintaing an ordered dictionary of app names to loadded modules. - Remove unused imports. - Minor styling fixes.
120 lines
3.6 KiB
Python
120 lines
3.6 KiB
Python
#
|
|
# This file is part of Plinth.
|
|
#
|
|
# 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, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# 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/>.
|
|
#
|
|
|
|
"""
|
|
Plinth module for running diagnostics
|
|
"""
|
|
|
|
import collections
|
|
from django.http import Http404
|
|
from django.template.response import TemplateResponse
|
|
from django.views.decorators.http import require_POST
|
|
from django.utils.translation import ugettext_lazy as _
|
|
import importlib
|
|
import logging
|
|
import threading
|
|
|
|
from plinth import cfg
|
|
from plinth import module_loader
|
|
|
|
|
|
logger = logging.Logger(__name__)
|
|
|
|
current_results = {}
|
|
|
|
_running_task = None
|
|
|
|
|
|
def init():
|
|
"""Initialize the module"""
|
|
menu = cfg.main_menu.get('system:index')
|
|
menu.add_urlname(_('Diagnostics'), 'glyphicon-screenshot',
|
|
'diagnostics:index', 30)
|
|
|
|
|
|
def index(request):
|
|
"""Serve the index page"""
|
|
if request.method == 'POST' and not _running_task:
|
|
_start_task()
|
|
|
|
return TemplateResponse(request, 'diagnostics.html',
|
|
{'title': _('System Diagnostics'),
|
|
'is_running': _running_task is not None,
|
|
'results': current_results})
|
|
|
|
|
|
@require_POST
|
|
def module(request, module_name):
|
|
"""Return diagnostics for a particular module."""
|
|
try:
|
|
module = module_loader.loaded_modules[module_name]
|
|
except KeyError:
|
|
raise Http404('Module does not exist or not loaded')
|
|
|
|
results = []
|
|
if hasattr(module, 'diagnose'):
|
|
results = module.diagnose()
|
|
|
|
return TemplateResponse(request, 'diagnostics_module.html',
|
|
{'title': _('Diagnostic Test'),
|
|
'module_name': module_name,
|
|
'results': results})
|
|
|
|
|
|
def _start_task():
|
|
"""Start the run task in a separate thread."""
|
|
if _running_task:
|
|
raise Exception('Task already running')
|
|
|
|
global _running_task
|
|
_running_task = threading.Thread(target=_run_on_all_modules_wrapper)
|
|
_running_task.start()
|
|
|
|
|
|
def _run_on_all_modules_wrapper():
|
|
"""Wrapper over actual task to catch exceptions."""
|
|
try:
|
|
run_on_all_modules()
|
|
except Exception as exception:
|
|
logger.exception('Error running diagnostics - %s', exception)
|
|
current_results['error'] = str(exception)
|
|
|
|
global _running_task
|
|
_running_task = None
|
|
|
|
|
|
def run_on_all_modules():
|
|
"""Run diagnostics on all modules and store the result."""
|
|
global current_results
|
|
current_results = {'modules': [],
|
|
'results': collections.OrderedDict(),
|
|
'progress_percentage': 0}
|
|
|
|
modules = []
|
|
for module_name, module in module_loader.loaded_modules.items():
|
|
if not hasattr(module, 'diagnose'):
|
|
continue
|
|
|
|
modules.append((module_name, module))
|
|
current_results['results'][module_name] = None
|
|
|
|
current_results['modules'] = modules
|
|
for current_index, (module_name, module) in enumerate(modules):
|
|
current_results['results'][module_name] = module.diagnose()
|
|
current_results['progress_percentage'] = \
|
|
int((current_index + 1) * 100 / len(modules))
|