mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-02-11 08:23:49 +00:00
150 lines
4.2 KiB
Python
150 lines
4.2 KiB
Python
#
|
|
# This file is part of Plinth.
|
|
#
|
|
# 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/>.
|
|
#
|
|
|
|
"""
|
|
Plinth module to configure matrix-synapse server
|
|
"""
|
|
|
|
import logging
|
|
import os
|
|
|
|
from django.urls import reverse_lazy
|
|
from django.utils.translation import ugettext_lazy as _
|
|
from ruamel.yaml.util import load_yaml_guess_indent
|
|
|
|
from plinth import action_utils
|
|
from plinth import actions
|
|
from plinth import cfg
|
|
from plinth import frontpage
|
|
from plinth import service as service_module
|
|
from plinth.modules import names
|
|
|
|
version = 1
|
|
|
|
depends = ['apps']
|
|
|
|
managed_services = ['matrix-synapse']
|
|
|
|
managed_packages = ['matrix-synapse']
|
|
|
|
title = _('Federated IM, VoIP and Video server \n (matrix-synapse)')
|
|
|
|
description = [
|
|
_('Matrix is an new ecosystem for open federated Instant Messaging '
|
|
'and VoIP. Synapse is a reference Matrix server implementation.'),
|
|
|
|
_('To communicate, you can use the '
|
|
'<a href=\'https://riot.im/\' target=\'_blank\'>Riot</a> client.'),
|
|
|
|
_('Changing the FreedomBox domain name needs a reinstall of '
|
|
'Matrix-Synapse and you WILL LOSE DATA.')
|
|
]
|
|
|
|
service = None
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
SERVER_NAME_PATH = "/etc/matrix-synapse/conf.d/server_name.yaml"
|
|
|
|
|
|
def init():
|
|
"""Initialize the matrix-synapse module"""
|
|
menu = cfg.main_menu.get('apps:index')
|
|
menu.add_urlname(title, 'glyphicon-comment', 'matrixsynapse:index')
|
|
|
|
global service
|
|
setup_helper = globals()['setup_helper']
|
|
if setup_helper.get_state() != 'needs-setup':
|
|
service = service_module.Service(
|
|
'matrix-synapse', title,
|
|
ports=['matrix-synapse'],
|
|
is_external=True, is_enabled=is_enabled, enable=enable,
|
|
disable=disable)
|
|
if is_enabled():
|
|
add_shortcut()
|
|
|
|
|
|
def setup(helper, old_version=None):
|
|
"""Install and configure the module."""
|
|
helper.call('pre', actions.superuser_run, 'matrixsynapse',
|
|
['pre-install'])
|
|
helper.install(managed_packages)
|
|
global service
|
|
if service is None:
|
|
service = service_module.Service(
|
|
'matrix-synapse', title,
|
|
ports=['matrix-synapse'],
|
|
is_external=True, is_enabled=is_enabled, enable=enable,
|
|
disable=disable)
|
|
helper.call('post', service.notify_enabled, None, True)
|
|
helper.call('post', add_shortcut)
|
|
|
|
|
|
def add_shortcut():
|
|
frontpage.add_shortcut('matrix-synapse', title, details=description,
|
|
configure_url=reverse_lazy('matrix-synapse:index'),
|
|
login_required=True)
|
|
|
|
|
|
def is_setup():
|
|
return os.path.exists(SERVER_NAME_PATH)
|
|
|
|
|
|
def is_enabled():
|
|
"""Return whether the module is enabled."""
|
|
return action_utils.service_is_enabled('matrix-synapse')
|
|
|
|
|
|
def get_domain_names():
|
|
"""Return the domain name(s)"""
|
|
results = []
|
|
|
|
for domain_type, domains in names.domains.items():
|
|
if domain_type == 'hiddenservice':
|
|
continue
|
|
for domain in domains:
|
|
results.append((domain, domain))
|
|
|
|
return results
|
|
|
|
|
|
def get_configured_domain_name():
|
|
if not is_setup():
|
|
return ""
|
|
|
|
with open(SERVER_NAME_PATH) as config_file:
|
|
config, _, _ = load_yaml_guess_indent(config_file)
|
|
|
|
return config["server_name"]
|
|
|
|
|
|
def enable():
|
|
"""Enable the module."""
|
|
actions.superuser_run('matrixsynapse', ['enable'])
|
|
add_shortcut()
|
|
|
|
|
|
def disable():
|
|
"""Enable the module."""
|
|
actions.superuser_run('matrixsynapse', ['disable'])
|
|
frontpage.remove_shortcut('matrixsynapse')
|
|
|
|
|
|
def diagnose():
|
|
"""Run diagnostics and return the results."""
|
|
return [action_utils.diagnose_port_listening(8008, 'tcp4')]
|