mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +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>
82 lines
2.8 KiB
Python
82 lines
2.8 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""FreedomBox app to configure XMPP web client/jsxc."""
|
|
|
|
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 frontpage, menu
|
|
from plinth.modules.backups.components import BackupRestore
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.package import Packages
|
|
from plinth.web_server import StaticFiles
|
|
|
|
from . import manifest
|
|
|
|
_description = [
|
|
_('JSXC is a web client for XMPP. Typically it is used with an XMPP '
|
|
'server running locally.'),
|
|
]
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class JSXCApp(app_module.App):
|
|
"""FreedomBox app for JSXC."""
|
|
|
|
app_id = 'jsxc'
|
|
|
|
_version = 1
|
|
|
|
def __init__(self) -> None:
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
info = app_module.Info(app_id=self.app_id, version=self._version,
|
|
name=_('JSXC'), icon_filename='jsxc',
|
|
description=_description, manual_page='JSXC',
|
|
clients=manifest.clients, tags=manifest.tags)
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-jsxc', info.name, info.icon_filename,
|
|
info.tags, 'jsxc:index', parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
enable_state = app_module.EnableState('enable-state-jsxc')
|
|
self.add(enable_state)
|
|
|
|
shortcut = frontpage.Shortcut('shortcut-jsxc', name=info.name,
|
|
icon=info.icon_filename,
|
|
url=reverse_lazy('jsxc:jsxc'),
|
|
clients=info.clients, tags=info.tags)
|
|
self.add(shortcut)
|
|
|
|
packages = Packages('packages-jsxc', ['libjs-jsxc'])
|
|
self.add(packages)
|
|
|
|
firewall = Firewall('firewall-jsxc', info.name,
|
|
ports=['http', 'https'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
directory_map = {
|
|
'/static/jsxc/img': '/usr/share/libjs-jsxc/img/',
|
|
'/static/jsxc/libjs-jsxc/lib': '/usr/share/javascript/jsxc/lib/',
|
|
'/static/jsxc/libjs-jsxc/sound': '/usr/share/libjs-jsxc/sound/',
|
|
'/static/jsxc/libjs-jsxc/': '/usr/share/libjs-jsxc/css/',
|
|
}
|
|
static_files = StaticFiles('static-files-jsxc',
|
|
directory_map=directory_map)
|
|
self.add(static_files)
|
|
|
|
backup_restore = BackupRestore('backup-restore-jsxc',
|
|
**manifest.backup)
|
|
self.add(backup_restore)
|
|
|
|
def setup(self, old_version):
|
|
"""Install and configure the app."""
|
|
super().setup(old_version)
|
|
if not old_version:
|
|
self.enable()
|