mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-02-04 08:13:38 +00:00
058702f2b8
Tests performed: - When app is not setup, app toggle button is not shown. Running status of the app is also not present in the page. Profile download is not shown. Setup button is shown. - When app is being setup, app toggle button is not shown. Running status of the app is also not present in the page. Page keeps refreshing every 3 seconds during setup. Profile download is not shown. A progress spinner is shown that setup is currently running. - When app setup has completed, app toggle button is shown. Running status is shown. When daemon is stopped, a message that daemon is not running is show. Profile download is shown. - Transition from being setup into setup completed is done with a single page refresh. Message that setup is completed is shown. - Port forwarding information is always shown (before, during and after setup). - Run functional tests for OpenVPN. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: Joseph Nuthalapati <njoseph@riseup.net>
92 lines
2.6 KiB
Python
92 lines
2.6 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
FreedomBox app for configuring OpenVPN server.
|
|
"""
|
|
|
|
import logging
|
|
|
|
from django.contrib import messages
|
|
from django.http import HttpResponse
|
|
from django.shortcuts import redirect
|
|
from django.utils.translation import ugettext as _
|
|
from django.views.decorators.http import require_POST
|
|
|
|
from plinth import actions
|
|
from plinth.modules import config, openvpn
|
|
from plinth.views import AppView
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class OpenVPNAppView(AppView):
|
|
"""Show OpenVPN app main page."""
|
|
app_id = 'openvpn'
|
|
template_name = 'openvpn.html'
|
|
port_forwarding_info = openvpn.port_forwarding_info
|
|
|
|
def dispatch(self, request, *args, **kwargs):
|
|
"""Collect the result of running setup process."""
|
|
if bool(openvpn.setup_process):
|
|
_collect_setup_result(request)
|
|
|
|
return super().dispatch(request, *args, **kwargs)
|
|
|
|
def get_context_data(self, *args, **kwargs):
|
|
"""Add additional context data for template."""
|
|
context = super().get_context_data(*args, **kwargs)
|
|
context['status'] = {
|
|
'is_setup': openvpn.is_setup(),
|
|
'setup_running': bool(openvpn.setup_process),
|
|
}
|
|
return context
|
|
|
|
|
|
@require_POST
|
|
def setup(request):
|
|
"""Start the setup process."""
|
|
if not openvpn.is_setup() and not openvpn.setup_process:
|
|
openvpn.setup_process = actions.superuser_run('openvpn', ['setup'],
|
|
run_in_background=True)
|
|
|
|
openvpn.app.enable()
|
|
|
|
return redirect('openvpn:index')
|
|
|
|
|
|
def profile(request):
|
|
"""Provide the user's profile for download."""
|
|
username = request.user.username
|
|
domainname = config.get_domainname()
|
|
|
|
if not config.get_domainname():
|
|
domainname = config.get_hostname()
|
|
|
|
profile_string = actions.superuser_run(
|
|
'openvpn', ['get-profile', username, domainname])
|
|
|
|
response = HttpResponse(profile_string,
|
|
content_type='application/x-openvpn-profile')
|
|
response['Content-Disposition'] = \
|
|
'attachment; filename={username}.ovpn'.format(username=username)
|
|
|
|
return response
|
|
|
|
|
|
def _collect_setup_result(request):
|
|
"""Handle setup process is completion."""
|
|
if not openvpn.setup_process:
|
|
return
|
|
|
|
return_code = openvpn.setup_process.poll()
|
|
|
|
# Setup process is not complete yet
|
|
if return_code is None:
|
|
return
|
|
|
|
if not return_code:
|
|
messages.success(request, _('Setup completed.'))
|
|
else:
|
|
messages.info(request, _('Setup failed.'))
|
|
|
|
openvpn.setup_process = None
|