FreedomBox/actions/radicale

#!/usr/bin/python3
#
# This file is part of FreedomBox.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

"""
Configuration helper for Radicale.
"""

import argparse
import augeas
import os
import subprocess
from distutils.version import LooseVersion as LV

from plinth import action_utils

CONFIG_FILE = '/etc/radicale/config'

DEFAULT_FILE = '/etc/default/radicale'

UWSGI_FILE = '/etc/uwsgi/apps-available/radicale.ini'

UWSGI_LINK = '/etc/uwsgi/apps-enabled/radicale.ini'

VERSION_2 = LV('2')


def parse_arguments():
    """Return parsed command line arguments as dictionary."""
    parser = argparse.ArgumentParser()
    subparsers = parser.add_subparsers(dest='subcommand', help='Sub command')

    subparsers.add_parser('setup', help='Setup Radicale configuration')
    subparsers.add_parser('enable', help='Enable Radicale service')
    subparsers.add_parser('disable', help='Disable Radicale service')
    configure = subparsers.add_parser('configure',
                                      help='Configure various options')
    configure.add_argument('--rights_type',
                           help='Set the rights type for radicale')

    subparsers.required = True
    return parser.parse_args()


def subcommand_setup(_):
    """Setup Radicale configuration."""
    current_version = _get_version()
    if not current_version:
        print('Warning: Unable to get radicale version.')

    aug = load_augeas()

    if current_version and current_version < VERSION_2:
        aug.set('/files' + DEFAULT_FILE + '/ENABLE_RADICALE', 'yes')

    aug.set('/files' + CONFIG_FILE + '/server/hosts',
            '127.0.0.1:5232, [::1]:5232')
    aug.set('/files' + CONFIG_FILE + '/rights/type', 'owner_only')
    if current_version and current_version < VERSION_2:
        aug.set('/files' + CONFIG_FILE + '/server/base_prefix', '/radicale/')
        aug.set('/files' + CONFIG_FILE + '/well-known/caldav',
                '/radicale/%(user)s/caldav/')
        aug.set('/files' + CONFIG_FILE + '/well-known/carddav',
                '/radicale/%(user)s/carddav/')
        aug.set('/files' + CONFIG_FILE + '/auth/type', 'remote_user')
    else:
        aug.set('/files' + CONFIG_FILE + '/auth/type', 'http_x_remote_user')

    aug.save()

    action_utils.service_enable('radicale')
    action_utils.service_restart('radicale')
    action_utils.webserver_enable(_get_web_config(current_version))

    # Enable uwsgi for radicale 2.x. Do this after radicale is
    # started, so it creates the necessary folders.
    if current_version and current_version >= VERSION_2:
        if not os.path.exists(UWSGI_LINK):
            os.symlink(UWSGI_FILE, UWSGI_LINK)
        action_utils.webserver_enable('proxy_uwsgi', kind='module')
        action_utils.service_restart('uwsgi')


def subcommand_configure(arguments):
    """Sets the radicale rights type to a particular value"""
    aug = load_augeas()
    aug.set('/files' + CONFIG_FILE + '/rights/type', arguments.rights_type)
    aug.save()

    action_utils.service_restart('radicale')


def subcommand_enable(_):
    """Start service."""
    action_utils.service_enable('radicale')
    action_utils.webserver_enable(_get_web_config())


def subcommand_disable(_):
    """Stop service."""
    action_utils.webserver_disable(_get_web_config())
    action_utils.service_disable('radicale')


def _get_version():
    try:
        proc = subprocess.run(
            ['radicale', '--version'], stdout=subprocess.PIPE, check=True)
        output = proc.stdout.decode('utf-8')
    except subprocess.CalledProcessError:
        return None

    version = str(output.strip())
    return LV(version)


def _get_web_config(current_version=None):
    """Return the name of the webserver configuration based on version."""
    if current_version is None:
        current_version = _get_version()

    if current_version and current_version < VERSION_2:
        return 'radicale-plinth'

    return 'radicale2-freedombox'


def load_augeas():
    """Initialize Augeas."""
    aug = augeas.Augeas(flags=augeas.Augeas.NO_LOAD +
                        augeas.Augeas.NO_MODL_AUTOLOAD)

    # shell-script config file lens
    aug.set('/augeas/load/Shellvars/lens', 'Shellvars.lns')
    aug.set('/augeas/load/Shellvars/incl[last() + 1]', DEFAULT_FILE)

    # 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 main():
    """Parse arguments and perform all duties."""
    arguments = parse_arguments()

    subcommand = arguments.subcommand.replace('-', '_')
    subcommand_method = globals()['subcommand_' + subcommand]
    subcommand_method(arguments)


if __name__ == '__main__':
    main()