Sunil Mohan Adapa 298bb5ae58
config: Allow better Apache default home page
- Don't redirect to '/index.html' when Apache Default is set as the home page.
This allows having other files such as 'index.php' as index file in
/var/www/html/.

- If the home page is currently set to 'Apache Default' upgrade the
configuration.

Tests:

- With Home page set to 'Apache Default' apply the patches. Config setup is
re-run. The configuration file becomes empty but is still present. Correctly
value is shown in the UI. /var/www/html/index.html is still shown as the home
page.

- With Home page set to 'Bepasty' apply the patches. Config setup is re-reun.
The configuration file is not modified. Bepasty is still shown as the home page.
Correctly value is shown in the UI.

- With Home page not modified apply the patches. Config setup is re-reun. The
configuration file is created. FreedomBox is the home page. Correctly value is
shown in the UI.

- On fresh machine with patches applied, perform first run. The configuration
file is not created. FreedomBox is the home page. Correctly value is shown in
the UI.

- Changing home page to Bepasty or 'Apache Default' works. Changing back to
'FreedomBox Service (Plinth)' also works.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2025-05-30 15:14:50 -04:00

80 lines
2.4 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""Configure miscellaneous system settings."""
import os
import pathlib
import augeas
from plinth import action_utils
from plinth.actions import privileged
APACHE_CONF_ENABLED_DIR = '/etc/apache2/conf-enabled'
APACHE_HOMEPAGE_CONF_FILE_NAME = 'freedombox-apache-homepage.conf'
APACHE_HOMEPAGE_CONFIG = os.path.join(APACHE_CONF_ENABLED_DIR,
APACHE_HOMEPAGE_CONF_FILE_NAME)
JOURNALD_FILE = pathlib.Path('/etc/systemd/journald.conf.d/50-freedombox.conf')
def load_augeas():
"""Initialize Augeas."""
aug = augeas.Augeas(flags=augeas.Augeas.NO_LOAD +
augeas.Augeas.NO_MODL_AUTOLOAD)
aug.transform('Puppet', str(JOURNALD_FILE))
aug.set('/augeas/context', '/files' + str(JOURNALD_FILE))
aug.load()
return aug
def get_logging_mode() -> str:
"""Return the logging mode as none, volatile or persistent."""
aug = load_augeas()
storage = aug.get('Journal/Storage')
if storage in ('volatile', 'persistent', 'none'):
return storage
# journald's default is 'auto'. On Debian systems, 'auto' is same
# 'persistent' because /var/log/journal exists by default.
return 'persistent'
@privileged
def set_logging_mode(mode: str):
"""Set the current logging mode."""
if mode not in ('volatile', 'persistent', 'none'):
raise ValueError('Invalid mode')
aug = load_augeas()
aug.set('Journal/Storage', mode)
if mode == 'volatile':
aug.set('Journal/MaxFileSec', '6h')
aug.set('Journal/MaxRetentionSec', '2day')
else:
aug.remove('Journal/MaxFileSec')
aug.remove('Journal/MaxRetentionSec')
aug.remove('Journal/RuntimeMaxUse')
JOURNALD_FILE.parent.mkdir(exist_ok=True)
aug.save()
# systemd-journald is socket activated, it may not be running and it does
# not support reload.
action_utils.service_try_restart('systemd-journald')
@privileged
def set_home_page(homepage: str | None):
"""Set the default app for this FreedomBox."""
conf_file_path = os.path.join('/etc/apache2/conf-available',
APACHE_HOMEPAGE_CONF_FILE_NAME)
redirect_rule = ''
if homepage:
redirect_rule = 'RedirectMatch "^/$" "{}"\n'.format(homepage)
with open(conf_file_path, 'w', encoding='utf-8') as conf_file:
conf_file.write(redirect_rule)
action_utils.webserver_enable('freedombox-apache-homepage')