mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-02-18 08:33:41 +00:00
89bce7a344
- Add typing information for init methods Info, Shortcut, and Menu to easily identify problems. - Update docstrings for these components. - Updates test cases to deal with tags instead of short description. - Update custom shortcuts code to read tags and ignore short description. - Update API to send tags instead of custom shortcuts. - OpenVPN special treatment of info.description in Shortcut Tests: - All unit tests pass and type checking succeeds. - All apps show icons with tags in apps and system section. - In help section cards don't show tags. - In front page, enabled apps show shortcuts with tags. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: Joseph Nuthalapati <njoseph@riseup.net>
242 lines
8.9 KiB
Python
242 lines
8.9 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""FreedomBox app to configure ejabberd server."""
|
|
|
|
import json
|
|
import logging
|
|
|
|
from django.urls import reverse_lazy
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
from plinth import app as app_module
|
|
from plinth import cfg, frontpage, menu
|
|
from plinth.config import DropinConfigs
|
|
from plinth.daemon import Daemon
|
|
from plinth.modules import names
|
|
from plinth.modules.apache.components import Webserver
|
|
from plinth.modules.backups.components import BackupRestore
|
|
from plinth.modules.coturn.components import TurnConfiguration, TurnConsumer
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.modules.letsencrypt.components import LetsEncrypt
|
|
from plinth.modules.users.components import UsersAndGroups
|
|
from plinth.package import Packages
|
|
from plinth.signals import (domain_added, post_hostname_change,
|
|
pre_hostname_change)
|
|
from plinth.utils import format_lazy
|
|
|
|
from . import manifest, privileged
|
|
|
|
_description = [
|
|
_('XMPP is an open and standardized communication protocol. Here '
|
|
'you can run and configure your XMPP server, called ejabberd.'),
|
|
format_lazy(
|
|
_('To actually communicate, you can use the <a href="{jsxc_url}">'
|
|
'web client</a> or any other <a href=\'https://xmpp.org/'
|
|
'software/clients\' target=\'_blank\'>XMPP client</a>. '
|
|
'When enabled, ejabberd can be accessed by any '
|
|
'<a href="{users_url}"> user with a {box_name} login</a>.'),
|
|
box_name=_(cfg.box_name), users_url=reverse_lazy('users:index'),
|
|
jsxc_url=reverse_lazy('jsxc:index')),
|
|
format_lazy(
|
|
_('ejabberd needs a STUN/TURN server for audio/video calls. '
|
|
'Install the <a href={coturn_url}>Coturn</a> app or configure '
|
|
'an external server.'), coturn_url=reverse_lazy('coturn:index'))
|
|
]
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class EjabberdApp(app_module.App):
|
|
"""FreedomBox app for ejabberd."""
|
|
|
|
app_id = 'ejabberd'
|
|
|
|
_version = 9
|
|
|
|
def __init__(self) -> None:
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
info = app_module.Info(app_id=self.app_id, version=self._version,
|
|
depends=['coturn'], name=_('ejabberd'),
|
|
icon_filename='ejabberd',
|
|
description=_description,
|
|
manual_page='ejabberd',
|
|
clients=manifest.clients, tags=manifest.tags)
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-ejabberd', info.name, info.icon_filename,
|
|
info.tags, 'ejabberd:index',
|
|
parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut(
|
|
'shortcut-ejabberd', info.name, icon=info.icon_filename,
|
|
description=info.description, manual_page=info.manual_page,
|
|
configure_url=reverse_lazy('ejabberd:index'), clients=info.clients,
|
|
tags=info.tags, login_required=True)
|
|
self.add(shortcut)
|
|
|
|
packages = Packages('packages-ejabberd', ['ejabberd'])
|
|
self.add(packages)
|
|
|
|
dropin_configs = DropinConfigs('dropin-configs-ejabberd', [
|
|
'/etc/apache2/conf-available/jwchat-plinth.conf',
|
|
])
|
|
self.add(dropin_configs)
|
|
|
|
dropin_configs = DropinConfigs('dropin-config-ejabberd-avahi', [
|
|
'/etc/avahi/services/xmpp-server.service',
|
|
], copy_only=True)
|
|
self.add(dropin_configs)
|
|
|
|
firewall = Firewall('firewall-ejabberd', info.name,
|
|
ports=['xmpp-client', 'xmpp-server',
|
|
'xmpp-bosh'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
webserver = Webserver('webserver-ejabberd', 'jwchat-plinth',
|
|
urls=['http://{host}/bosh/'])
|
|
self.add(webserver)
|
|
|
|
letsencrypt = LetsEncrypt(
|
|
'letsencrypt-ejabberd', domains=get_domains, daemons=['ejabberd'],
|
|
should_copy_certificates=True,
|
|
private_key_path='/etc/ejabberd/letsencrypt/{domain}/ejabberd.pem',
|
|
certificate_path='/etc/ejabberd/letsencrypt/{domain}/ejabberd.pem',
|
|
user_owner='ejabberd', group_owner='ejabberd',
|
|
managing_app='ejabberd')
|
|
self.add(letsencrypt)
|
|
|
|
daemon = Daemon(
|
|
'daemon-ejabberd', 'ejabberd', listen_ports=[(5222, 'tcp4'),
|
|
(5222, 'tcp6'),
|
|
(5269, 'tcp4'),
|
|
(5269, 'tcp6'),
|
|
(5443, 'tcp4'),
|
|
(5443, 'tcp6')])
|
|
self.add(daemon)
|
|
|
|
users_and_groups = UsersAndGroups('users-and-groups-ejabberd',
|
|
reserved_usernames=['ejabberd'])
|
|
self.add(users_and_groups)
|
|
|
|
backup_restore = BackupRestore('backup-restore-ejabberd',
|
|
**manifest.backup)
|
|
self.add(backup_restore)
|
|
|
|
turn = EjabberdTurnConsumer('turn-ejabberd')
|
|
self.add(turn)
|
|
|
|
@staticmethod
|
|
def post_init():
|
|
"""Perform post initialization operations."""
|
|
pre_hostname_change.connect(on_pre_hostname_change)
|
|
post_hostname_change.connect(on_post_hostname_change)
|
|
domain_added.connect(on_domain_added)
|
|
|
|
def setup(self, old_version):
|
|
"""Install and configure the app."""
|
|
domain_name = names.get_domain_name()
|
|
logger.info('ejabberd service domain name - %s', domain_name)
|
|
|
|
privileged.pre_install(domain_name)
|
|
# XXX: Configure all other domain names
|
|
super().setup(old_version)
|
|
self.get_component('letsencrypt-ejabberd').setup_certificates(
|
|
[domain_name])
|
|
privileged.setup(domain_name)
|
|
if not old_version:
|
|
self.enable()
|
|
|
|
if not old_version or get_turn_configuration()[1]:
|
|
# Configure STUN/TURN only if there's a valid TLS domain set for
|
|
# Coturn. Do this if app is being freshly installed or if it is
|
|
# previously installed and configured to use STUN/TURN
|
|
# auto-management.
|
|
configuration = self.get_component(
|
|
'turn-ejabberd').get_configuration()
|
|
update_turn_configuration(configuration, force=True)
|
|
|
|
if old_version and old_version < 9 and privileged.mam('status'):
|
|
# Re-enable to change configuration
|
|
privileged.mam('enable')
|
|
|
|
|
|
class EjabberdTurnConsumer(TurnConsumer):
|
|
"""Component to manage Coturn configuration for ejabberd."""
|
|
|
|
def on_config_change(self, config):
|
|
"""Add or update STUN/TURN configuration."""
|
|
update_turn_configuration(config)
|
|
|
|
|
|
def on_pre_hostname_change(sender, old_hostname, new_hostname, **kwargs):
|
|
"""Backup ejabberd database before hostname is changed."""
|
|
del sender # Unused
|
|
del kwargs # Unused
|
|
app = app_module.App.get('ejabberd')
|
|
if app.needs_setup():
|
|
return
|
|
|
|
privileged.pre_change_hostname(old_hostname, new_hostname)
|
|
|
|
|
|
def on_post_hostname_change(sender, old_hostname, new_hostname, **kwargs):
|
|
"""Update ejabberd config after hostname change."""
|
|
del sender # Unused
|
|
del kwargs # Unused
|
|
app = app_module.App.get('ejabberd')
|
|
if app.needs_setup():
|
|
return
|
|
|
|
privileged.change_hostname(_run_in_background=True)
|
|
|
|
|
|
def get_domains():
|
|
"""Return the list of domains configured for ejabberd."""
|
|
app = app_module.App.get('ejabberd')
|
|
if app.needs_setup():
|
|
return []
|
|
|
|
return privileged.get_domains()
|
|
|
|
|
|
def on_domain_added(sender, domain_type, name='', description='',
|
|
services=None, **kwargs):
|
|
"""Update ejabberd config after domain name change."""
|
|
app = app_module.App.get('ejabberd')
|
|
if not name or app.needs_setup():
|
|
return
|
|
|
|
domains = get_domains()
|
|
if name not in domains:
|
|
privileged.add_domain(name)
|
|
app.get_component('letsencrypt-ejabberd').setup_certificates()
|
|
|
|
|
|
def set_domains(domains):
|
|
"""Configure ejabberd to have this list of domains."""
|
|
app = app_module.App.get('ejabberd')
|
|
if not domains or app.needs_setup():
|
|
return
|
|
|
|
privileged.set_domains(domains)
|
|
app.get_component('letsencrypt-ejabberd').setup_certificates()
|
|
|
|
|
|
def update_turn_configuration(config: TurnConfiguration, managed=True,
|
|
force=False):
|
|
"""Update ejabberd's STUN/TURN server configuration."""
|
|
app = app_module.App.get('ejabberd')
|
|
if not force and app.needs_setup():
|
|
return
|
|
|
|
privileged.configure_turn(json.loads(config.to_json()), managed)
|
|
|
|
|
|
def get_turn_configuration() -> tuple[TurnConfiguration, bool]:
|
|
"""Get the latest STUN/TURN configuration."""
|
|
tc, managed = privileged.get_turn_config()
|
|
return TurnConfiguration(tc['domain'], tc['uris'],
|
|
tc['shared_secret']), managed
|