mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
pagekite: Use Daemon component to simplify handling daemon actions
- Turn some methods in action script to private to improve abstraction. - Always enable the predefined services when setting the configuration for the first time. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: Veiko Aasa <veiko17@disroot.org>
This commit is contained in:
Sunil Mohan Adapa
Veiko Aasa
parent
a1c1104a61
commit
98ecb6ea40
@ -37,11 +37,6 @@ def parse_arguments():
|
||||
parser = argparse.ArgumentParser()
|
||||
subparsers = parser.add_subparsers(dest='subcommand', help='Sub command')
|
||||
|
||||
# Enable/disable the pagekite service
|
||||
subparsers.add_parser('start-and-enable', help='Enable PageKite service')
|
||||
subparsers.add_parser('stop-and-disable', help='Disable PageKite service')
|
||||
subparsers.add_parser('restart', help='Restart PageKite service')
|
||||
|
||||
# Configuration
|
||||
subparsers.add_parser('get-config', help='Return current configuration')
|
||||
set_config = subparsers.add_parser(
|
||||
@ -64,23 +59,6 @@ def parse_arguments():
|
||||
return parser.parse_args()
|
||||
|
||||
|
||||
def subcommand_restart(_):
|
||||
"""Restart the pagekite service"""
|
||||
action_utils.service_restart('pagekite')
|
||||
print('restarted')
|
||||
|
||||
|
||||
def subcommand_start_and_enable(_):
|
||||
# 'start' alone sometimes fails, even if the service is not running
|
||||
action_utils.service_restart('pagekite')
|
||||
print('enabled')
|
||||
|
||||
|
||||
def subcommand_stop_and_disable(_):
|
||||
action_utils.service_stop('pagekite')
|
||||
print('disabled')
|
||||
|
||||
|
||||
def subcommand_get_config(_):
|
||||
"""Print the current configuration as JSON dictionary."""
|
||||
if aug.match(PATHS['defaults']):
|
||||
@ -152,16 +130,28 @@ def subcommand_set_config(arguments):
|
||||
|
||||
aug.save()
|
||||
|
||||
for service_name in utils.PREDEFINED_SERVICES.keys():
|
||||
service = utils.PREDEFINED_SERVICES[service_name]['params']
|
||||
try:
|
||||
_add_service(service)
|
||||
except RuntimeError:
|
||||
pass
|
||||
|
||||
# Immediately after install, pagekite is enabled but not running. Restart
|
||||
# based on enabled state instead of try-restart.
|
||||
if action_utils.service_is_enabled('pagekite'):
|
||||
action_utils.service_restart('pagekite')
|
||||
|
||||
|
||||
def subcommand_remove_service(arguments):
|
||||
"""Searches and removes the service(s) that match all given parameters"""
|
||||
service = utils.load_service(arguments.service)
|
||||
paths = get_existing_service_paths(service)
|
||||
paths = _get_existing_service_paths(service)
|
||||
# TODO: theoretically, everything to do here is:
|
||||
# [aug.remove(path) for path in paths]
|
||||
# but augeas won't let you save the changed files and doesn't say why
|
||||
for path in paths:
|
||||
filepath = convert_augeas_path_to_filepath(path)
|
||||
filepath = _convert_augeas_path_to_filepath(path)
|
||||
service_found = False
|
||||
with open(filepath, 'r') as file:
|
||||
lines = file.readlines()
|
||||
@ -179,7 +169,7 @@ def subcommand_remove_service(arguments):
|
||||
action_utils.service_restart('pagekite')
|
||||
|
||||
|
||||
def get_existing_service_paths(service):
|
||||
def _get_existing_service_paths(service):
|
||||
"""Return paths of existing services that match the given service params"""
|
||||
# construct an augeas query path with patterns like:
|
||||
# */service_on/*[protocol='http']
|
||||
@ -189,25 +179,30 @@ def get_existing_service_paths(service):
|
||||
return aug.match(path)
|
||||
|
||||
|
||||
def subcommand_add_service(arguments):
|
||||
"""Add one service"""
|
||||
service = utils.load_service(arguments.service)
|
||||
if get_existing_service_paths(service):
|
||||
def _add_service(service):
|
||||
"""Add a new service into configuration."""
|
||||
if _get_existing_service_paths(service):
|
||||
msg = "Service with the parameters %s already exists"
|
||||
raise RuntimeError(msg % service)
|
||||
|
||||
root = get_new_service_path(service['protocol'])
|
||||
root = _get_new_service_path(service['protocol'])
|
||||
# TODO: after adding a service, augeas fails writing the config;
|
||||
# so add the service_on entry manually instead
|
||||
path = convert_augeas_path_to_filepath(root)
|
||||
path = _convert_augeas_path_to_filepath(root)
|
||||
with open(path, 'a') as servicefile:
|
||||
line = "\nservice_on = %s\n" % utils.convert_service_to_string(service)
|
||||
servicefile.write(line)
|
||||
action_utils.service_restart('pagekite')
|
||||
|
||||
|
||||
def convert_augeas_path_to_filepath(augpath, prefix='/files',
|
||||
suffix='service_on'):
|
||||
def subcommand_add_service(arguments):
|
||||
"""Add one service"""
|
||||
service = utils.load_service(arguments.service)
|
||||
_add_service(service)
|
||||
action_utils.service_try_restart('pagekite')
|
||||
|
||||
|
||||
def _convert_augeas_path_to_filepath(augpath, prefix='/files',
|
||||
suffix='service_on'):
|
||||
"""Convert an augeas service_on path to the actual file path"""
|
||||
if augpath.startswith(prefix):
|
||||
augpath = augpath.replace(prefix, "", 1)
|
||||
@ -218,7 +213,7 @@ def convert_augeas_path_to_filepath(augpath, prefix='/files',
|
||||
return augpath.rstrip('/')
|
||||
|
||||
|
||||
def get_new_service_path(protocol):
|
||||
def _get_new_service_path(protocol):
|
||||
"""Get the augeas path of a new service for a protocol
|
||||
|
||||
This takes care of existing services using a /service_on/*/ query"""
|
||||
|
||||
@ -7,6 +7,7 @@ from django.utils.translation import ugettext_lazy as _
|
||||
|
||||
from plinth import app as app_module
|
||||
from plinth import cfg, menu
|
||||
from plinth.daemon import Daemon
|
||||
from plinth.modules.names.components import DomainType
|
||||
from plinth.utils import format_lazy
|
||||
|
||||
@ -75,7 +76,8 @@ class PagekiteApp(app_module.App):
|
||||
'pagekite:index', can_have_certificate=True)
|
||||
self.add(domain_type)
|
||||
|
||||
# XXX: Add pagekite daemon component and simplify action script
|
||||
daemon = Daemon('daemon-pagekite', managed_services[0])
|
||||
self.add(daemon)
|
||||
|
||||
|
||||
def init():
|
||||
|
||||
@ -2,7 +2,6 @@
|
||||
|
||||
import copy
|
||||
import json
|
||||
import logging
|
||||
|
||||
from django import forms
|
||||
from django.contrib import messages
|
||||
@ -15,8 +14,6 @@ from plinth.forms import AppForm
|
||||
|
||||
from . import utils
|
||||
|
||||
LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class TrimmedCharField(forms.CharField):
|
||||
"""Trim the contents of a CharField"""
|
||||
@ -92,38 +89,6 @@ class ConfigurationForm(AppForm):
|
||||
frontend
|
||||
], input=new['kite_secret'].encode())
|
||||
messages.success(request, _('Configuration updated'))
|
||||
config_changed = True
|
||||
|
||||
if old['is_enabled'] != new['is_enabled']:
|
||||
if new['is_enabled']:
|
||||
utils.run(['start-and-enable'])
|
||||
# Ensure all standard/predefined services are enabled
|
||||
for service_name in utils.PREDEFINED_SERVICES.keys():
|
||||
service = \
|
||||
utils.PREDEFINED_SERVICES[service_name]['params']
|
||||
service = json.dumps(service)
|
||||
|
||||
# Probably should keep track of which services
|
||||
# are enabled since adding the service produces
|
||||
# an error if it is already added. But this works
|
||||
# too.
|
||||
|
||||
try:
|
||||
utils.run(['add-service', '--service', service])
|
||||
except ActionError as exception:
|
||||
if "already exists" in str(exception):
|
||||
pass
|
||||
else:
|
||||
raise
|
||||
messages.success(request, _('PageKite enabled'))
|
||||
else:
|
||||
utils.run(['stop-and-disable'])
|
||||
messages.success(request, _('PageKite disabled'))
|
||||
|
||||
# Restart the service if the config was changed while the service
|
||||
# was running, so changes take effect immediately.
|
||||
elif config_changed and new['is_enabled']:
|
||||
utils.run(['restart'])
|
||||
|
||||
# Update kite name registered with Name Services module.
|
||||
utils.update_names_module(enabled=new['is_enabled'],
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user