Joseph Nuthalapati 4064d6e231
manual: Link to manual from each service
Closes #930

- Make targets to download wiki pages of each service

- Add post-processor script for DocBook file processing

Signed-off-by: Joseph Nuthalapati <njoseph@thoughtworks.com>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2018-03-22 19:49:14 -04:00

142 lines
4.0 KiB
Python

#
# 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/>.
#
"""
FreedomBox app for radicale.
"""
import augeas
from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from plinth import service as service_module
from plinth import action_utils, actions, cfg, frontpage
from plinth.menu import main_menu
from plinth.utils import format_lazy
from .manifest import clients
version = 1
service = None
managed_services = ['radicale']
managed_packages = ['radicale']
name = _('Radicale')
short_description = _('Calendar and Addressbook')
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="http://radicale.org/clients/">supported client '
'application</a> is needed. Radicale can be accessed by any user '
'with a {box_name} login.'), box_name=_(cfg.box_name)),
]
clients = clients
reserved_usernames = ['radicale']
manual_page = 'Radicale'
CONFIG_FILE = '/etc/radicale/config'
def init():
"""Initialize the radicale module."""
menu = main_menu.get('apps')
menu.add_urlname(name, 'glyphicon-calendar', 'radicale:index',
short_description)
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(managed_services[0], name, ports=[
'http', 'https'
], is_external=True, enable=enable, disable=disable)
if service.is_enabled():
add_shortcut()
def setup(helper, old_version=None):
"""Install and configure the module."""
helper.install(managed_packages)
helper.call('post', actions.superuser_run, 'radicale', ['setup'])
global service
if service is None:
service = service_module.Service(managed_services[0], name, ports=[
'http', 'https'
], is_external=True, enable=enable, disable=disable)
helper.call('post', service.notify_enabled, None, True)
helper.call('post', add_shortcut)
def add_shortcut():
frontpage.add_shortcut(
'radicale', name, short_description=short_description,
details=description, configure_url=reverse_lazy('radicale:index'),
login_required=True)
def enable():
"""Enable the module."""
actions.superuser_run('radicale', ['enable'])
add_shortcut()
def disable():
"""Disable the module."""
actions.superuser_run('radicale', ['disable'])
frontpage.remove_shortcut('radicale')
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')
return value
def diagnose():
"""Run diagnostics and return the results."""
results = []
results.append(action_utils.diagnose_port_listening(5232, 'tcp4'))
results.append(action_utils.diagnose_port_listening(5232, 'tcp6'))
results.extend(
action_utils.diagnose_url_on_all('https://{host}/radicale',
check_certificate=False))
return results