James Valleroy 880e3dc10e
radicale: Remove code to handle 1.x
Since radicale 1.x is only in Stretch (oldstable), remove code that
was added to support that version and migration from 1.x to newer
versions.

Keep the fix for missing log path as the fix is not available in Buster yet.

Tests:

- Ran functional tests in testing container. Manually tested logging
  in to web interface and creating a calendar.

Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
[sunil: Add back the fix for missing log path]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2020-08-19 14:03:20 -07:00

139 lines
4.5 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""
FreedomBox app for radicale.
"""
import logging
import augeas
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import app as app_module
from plinth import cfg, frontpage, menu
from plinth.modules.apache.components import Uwsgi, Webserver
from plinth.modules.firewall.components import Firewall
from plinth.modules.users.components import UsersAndGroups
from plinth.utils import Version, format_lazy
from .manifest import backup, clients # noqa, pylint: disable=unused-import
version = 2
managed_packages = ['radicale', 'uwsgi', 'uwsgi-plugin-python3']
_description = [
format_lazy(
_('Radicale is a CalDAV and CardDAV server. It allows synchronization '
'and sharing of scheduling and contact data. To use Radicale, a '
'<a href="https://radicale.org/master.html#documentation/supported-'
'clients">supported client application</a> is needed. Radicale can '
'be accessed by any user with a {box_name} login.'),
box_name=_(cfg.box_name)),
_('Radicale provides a basic web interface, which only supports creating '
'new calendars and addressbooks. It does not support adding events or '
'contacts, which must be done using a separate client.'),
]
logger = logging.getLogger(__name__)
CONFIG_FILE = '/etc/radicale/config'
app = None
class RadicaleApp(app_module.App):
"""FreedomBox app for Radicale."""
app_id = 'radicale'
def __init__(self):
"""Create components for the app."""
super().__init__()
info = app_module.Info(app_id=self.app_id, version=version,
name=_('Radicale'), icon_filename='radicale',
short_description=_('Calendar and Addressbook'),
description=_description,
manual_page='Radicale', clients=clients)
self.add(info)
menu_item = menu.Menu('menu-radicale', info.name,
info.short_description, info.icon_filename,
'radicale:index', parent_url_name='apps')
self.add(menu_item)
shortcut = frontpage.Shortcut('shortcut-radicale', info.name,
short_description=info.short_description,
icon=info.icon_filename,
url='/radicale/', clients=info.clients,
login_required=True)
self.add(shortcut)
firewall = Firewall('firewall-radicale', info.name,
ports=['http', 'https'], is_external=True)
self.add(firewall)
webserver = Webserver('webserver-radicale', 'radicale2-freedombox',
urls=['https://{host}/radicale'])
self.add(webserver)
uwsgi = Uwsgi('uwsgi-radicale', 'radicale')
self.add(uwsgi)
users_and_groups = UsersAndGroups('users-and-groups-radicale',
reserved_usernames=['radicale'])
self.add(users_and_groups)
def enable(self):
"""Fix missing directories before enabling radicale."""
actions.superuser_run('radicale', ['fix-paths'])
super().enable()
def setup(helper, old_version=None):
"""Install and configure the module."""
helper.install(managed_packages)
helper.call('post', app.enable)
def force_upgrade(helper, packages):
"""Force upgrade radicale to resolve conffile prompt."""
if 'radicale' not in packages:
return False
# Allow upgrade from 2.* to newer 2.*
package = packages['radicale']
if Version(package['new_version']) > Version('3~'):
return False
rights = get_rights_value()
helper.install(['radicale'], force_configuration='new')
actions.superuser_run('radicale', ['configure', '--rights_type', rights])
return True
def load_augeas():
"""Prepares the augeas."""
aug = augeas.Augeas(flags=augeas.Augeas.NO_LOAD +
augeas.Augeas.NO_MODL_AUTOLOAD)
# INI file lens
aug.set('/augeas/load/Puppet/lens', 'Puppet.lns')
aug.set('/augeas/load/Puppet/incl[last() + 1]', CONFIG_FILE)
aug.load()
return aug
def get_rights_value():
"""Returns the current Rights value."""
aug = load_augeas()
value = aug.get('/files' + CONFIG_FILE + '/rights/type')
if value == 'from_file':
# Default rights file is equivalent to owner_only.
value = 'owner_only'
return value