mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-02-11 08:23:49 +00:00
67860385d0
- Use AppView for app page.
- Handle post enable/disable activities within the App class.
- Use Operation class to perform configuration instead of custom mechanism. Drop
all the older code for it.
Tests:
- DONE: Run functional tests
- DONE: Enabling Tor
- DONE: Enables the service
- DONE: Updates the firewall ports
- DONE: Adds hidden service domain to names app
- DONE: Shows app enabled
- DONE: Firewall ports are opened
- DONE: Disabling Tor
- DONE: Disables apt transport over Tor
- DONE: Firewall ports are closed
- DONE: Shows app disabled
- DONE: Onion domain is removed from names app
- DONE: App page
- DONE: Running/not-running status is shown properly based on whether tor
daemon is running.
- DONE: Port forwarding information is shown properly.
- DONE: When hidden service is enabled, status of hidden services is shown
- DONE: Configuration update
- DONE: Form shown correct status of the option
- DONE: When configuration is being updated, operation progress is shown
- DONE: Page refreshes once in 3 seconds during operation. Refresh stops after
operation.
- Once the operation is complete, success or error message is shown
- DONE: Javascript to show/hide upstream bridges text box works
- DONE: Javascript to enable/disable relay checkboxes works
- DONE: Operation does not show notification.
- DONE: Enabling apt over Tor does not work when app is disabled
- DONE: When configuration is changed, the message 'Settings unchanged' is not
shown.
- DONE: If an error is thrown during configuration, an error message is shown
properly.
- DONE: Tor is restarted after configuration update and hidden service domains
is updated.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
130 lines
4.2 KiB
Python
130 lines
4.2 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
FreedomBox app for configuring Tor.
|
|
"""
|
|
|
|
import logging
|
|
|
|
from django.utils.translation import gettext_noop
|
|
from django.views.generic.edit import FormView
|
|
|
|
from plinth import actions
|
|
from plinth import app as app_module
|
|
from plinth import operation as operation_module
|
|
from plinth.modules import tor
|
|
from plinth.views import AppView
|
|
|
|
from . import utils as tor_utils
|
|
from .forms import TorForm
|
|
|
|
config_process = None
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class TorAppView(AppView):
|
|
"""Show Tor app main page."""
|
|
|
|
app_id = 'tor'
|
|
template_name = 'tor.html'
|
|
form_class = TorForm
|
|
prefix = 'tor'
|
|
|
|
status = None
|
|
|
|
def get_initial(self):
|
|
"""Return the values to fill in the form."""
|
|
if not self.status:
|
|
self.status = tor_utils.get_status()
|
|
|
|
initial = super().get_initial()
|
|
initial.update(self.status)
|
|
return initial
|
|
|
|
def get_context_data(self, *args, **kwargs):
|
|
"""Add additional context data for template."""
|
|
if not self.status:
|
|
self.status = tor_utils.get_status()
|
|
|
|
context = super().get_context_data(*args, **kwargs)
|
|
context['status'] = self.status
|
|
return context
|
|
|
|
def form_valid(self, form):
|
|
"""Configure tor app on successful form submission."""
|
|
operation_module.manager.new(self.app_id,
|
|
gettext_noop('Updating configuration'),
|
|
_apply_changes,
|
|
[form.initial, form.cleaned_data],
|
|
show_notification=False)
|
|
# Skip check for 'Settings unchanged' message by calling grandparent
|
|
return super(FormView, self).form_valid(form)
|
|
|
|
|
|
def _apply_changes(old_status, new_status):
|
|
"""Try to apply changes and handle errors."""
|
|
logger.info('tor: applying configuration changes')
|
|
exception_to_update = None
|
|
message = None
|
|
try:
|
|
__apply_changes(old_status, new_status)
|
|
except Exception as exception:
|
|
exception_to_update = exception
|
|
message = gettext_noop('Error configuring app: {error}').format(
|
|
error=exception)
|
|
else:
|
|
message = gettext_noop('Configuration updated.')
|
|
|
|
logger.info('tor: configuration changes completed')
|
|
operation = operation_module.Operation.get_operation()
|
|
operation.on_update(message, exception_to_update)
|
|
|
|
|
|
def __apply_changes(old_status, new_status):
|
|
"""Apply the changes."""
|
|
needs_restart = True
|
|
arguments = []
|
|
|
|
app = app_module.App.get('tor')
|
|
is_enabled = app.is_enabled()
|
|
|
|
if old_status['relay_enabled'] != new_status['relay_enabled']:
|
|
arg_value = 'enable' if new_status['relay_enabled'] else 'disable'
|
|
arguments.extend(['--relay', arg_value])
|
|
|
|
if old_status['bridge_relay_enabled'] != \
|
|
new_status['bridge_relay_enabled']:
|
|
arg_value = 'enable'
|
|
if not new_status['bridge_relay_enabled']:
|
|
arg_value = 'disable'
|
|
arguments.extend(['--bridge-relay', arg_value])
|
|
|
|
if old_status['hs_enabled'] != new_status['hs_enabled']:
|
|
arg_value = 'enable' if new_status['hs_enabled'] else 'disable'
|
|
arguments.extend(['--hidden-service', arg_value])
|
|
|
|
if old_status['apt_transport_tor_enabled'] != \
|
|
new_status['apt_transport_tor_enabled']:
|
|
arg_value = 'disable'
|
|
if is_enabled and new_status['apt_transport_tor_enabled']:
|
|
arg_value = 'enable'
|
|
arguments.extend(['--apt-transport-tor', arg_value])
|
|
needs_restart = False
|
|
|
|
if old_status['use_upstream_bridges'] != \
|
|
new_status['use_upstream_bridges']:
|
|
arg_value = 'enable' if new_status[
|
|
'use_upstream_bridges'] else 'disable'
|
|
arguments.extend(['--use-upstream-bridges', arg_value])
|
|
|
|
if old_status['upstream_bridges'] != new_status['upstream_bridges']:
|
|
arguments.extend(
|
|
['--upstream-bridges', new_status['upstream_bridges']])
|
|
|
|
if arguments:
|
|
actions.superuser_run('tor', ['configure'] + arguments)
|
|
|
|
if needs_restart and is_enabled:
|
|
actions.superuser_run('tor', ['restart'])
|
|
status = tor_utils.get_status()
|
|
tor.update_hidden_service_domain(status)
|