Sunil Mohan Adapa f8e78f33d3
radicale: Explicitly set the auth type to accommodate radicale 3.5
Helps: #2501
Helps: Debian #1100995

- With radicale's Debian packaging for version 3.5 (trixie) the auth/type
configuration value is no longer set to remote_user by default[1]. FreedomBox's
setup depends on this. So, set this value explicitly including for bookworm.

Links:

1) https://tracker.debian.org/media/packages/r/radicale/changelog-3.5.0-1

Tests:

- Install on bookworm and testing VMs and run functional tests. Web UI works.

- On bookworm VM, install radicale and perform dist-upgrade. Upgrade succeeds.
Radicale is at version 3.5.0-1. The file /etc/radicale/config *does not*
contains auth/type as 'remote_user'. This is because unattended-upgrades has
unexpectedly upgraded radicale and overwrote the configuration file. This is
being investigated separately.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2025-03-28 21:26:40 -04:00

60 lines
1.5 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""Configure Radicale."""
import os
import augeas
from plinth import action_utils
from plinth.actions import privileged
CONFIG_FILE = '/etc/radicale/config'
LOG_PATH = '/var/log/radicale'
@privileged
def setup():
"""Configure authentication to Apache remote user.
For radicale < 3.5 (bookworm), this was set by configuration shipped with
Debian. For radicale >= 3.5 (trixie), this needs to be explicitly. For
simplicity, set is unconditionally.
"""
aug = load_augeas()
aug.set('auth/type', 'remote_user')
aug.save()
action_utils.service_try_restart('uwsgi')
@privileged
def configure(rights_type: str):
"""Set the radicale rights type to a particular value."""
if rights_type == 'owner_only':
# Default rights file is equivalent to owner_only.
rights_type = 'from_file'
aug = load_augeas()
aug.set('rights/type', rights_type)
aug.save()
action_utils.service_try_restart('uwsgi')
@privileged
def fix_paths():
"""Fix log path to work around a bug."""
# Workaround for bug in radicale's uwsgi script (#931201)
if not os.path.exists(LOG_PATH):
os.makedirs(LOG_PATH)
def load_augeas():
"""Initialize Augeas."""
aug = augeas.Augeas(flags=augeas.Augeas.NO_LOAD +
augeas.Augeas.NO_MODL_AUTOLOAD)
# INI file lens
aug.transform('Puppet', CONFIG_FILE)
aug.set('/augeas/context', '/files' + CONFIG_FILE)
aug.load()
return aug