mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
623604649e
- This can have may uses such as: - Waiting properly on the reboot page until the system has been restarted while showing the status. - Or, waiting for first setup to complete before running functional tests. - Or, monitoring for the health status of FreedomBox in general. - The page is public as all the information conveyed there is also already public. Should we introduce any sensitive information there such as 'operations_in_progress', we can provide that information only to administrators. Tests: - Visiting /plinth/status/ shows the status in JSON. Using curl to retrieve the information is also possible. - During the first setup 'is_first_setup_running' is 'true'. After it has completed, it is 'false'. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: Veiko Aasa <veiko17@disroot.org>
72 lines
2.7 KiB
Python
72 lines
2.7 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
Django middleware to redirect to firstboot wizard if it has not be run
|
|
yet.
|
|
"""
|
|
|
|
import logging
|
|
|
|
from django.conf import settings
|
|
from django.http.response import HttpResponseRedirect
|
|
from django.urls import reverse
|
|
from django.utils.deprecation import MiddlewareMixin
|
|
|
|
from plinth import setup
|
|
from plinth.modules import first_boot
|
|
from plinth.utils import is_user_admin
|
|
|
|
LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
class FirstBootMiddleware(MiddlewareMixin):
|
|
"""Forward to firstboot page if firstboot isn't finished yet."""
|
|
|
|
@staticmethod
|
|
def process_request(request):
|
|
"""Handle a request as Django middleware request handler."""
|
|
# Don't interfere with login page
|
|
user_requests_login = request.path.startswith(
|
|
reverse(settings.LOGIN_URL))
|
|
if user_requests_login:
|
|
return
|
|
|
|
# Don't interfere with help or status pages
|
|
user_requests_help = request.path.startswith(reverse('help:index'))
|
|
user_requests_status = request.path.startswith(reverse('status'))
|
|
if user_requests_help or user_requests_status:
|
|
return
|
|
|
|
# Don't interfere with first setup progress page. When first setup is
|
|
# still running, no apps may have provided the first boot steps. This
|
|
# will result in first boot wizard getting marked as completed
|
|
# prematurely.
|
|
if setup.is_first_setup_running:
|
|
return
|
|
|
|
firstboot_completed = first_boot.is_completed()
|
|
user_requests_firstboot = first_boot.is_firstboot_url(request.path)
|
|
|
|
# If user requests a step other than the welcome step, verify that they
|
|
# indeed completed the secret verification by looking at the session.
|
|
if (user_requests_firstboot
|
|
and not request.path.startswith(reverse('first_boot:welcome'))
|
|
and first_boot.firstboot_wizard_secret_exists()
|
|
and not request.session.get('firstboot_secret_provided', False)
|
|
and not is_user_admin(request)):
|
|
return HttpResponseRedirect(reverse('first_boot:welcome'))
|
|
|
|
# Redirect to first boot if requesting normal page and first
|
|
# boot is not complete.
|
|
if not firstboot_completed and not user_requests_firstboot:
|
|
next_step = first_boot.next_step_or_none()
|
|
if next_step:
|
|
return HttpResponseRedirect(reverse(next_step))
|
|
else:
|
|
# No more steps in first boot
|
|
first_boot.set_completed()
|
|
|
|
# Redirect to 'complete' page if user requested firstboot after it is
|
|
# finished.
|
|
if firstboot_completed and user_requests_firstboot:
|
|
return HttpResponseRedirect(reverse('first_boot:complete'))
|