Sunil Mohan Adapa 89bce7a344
app: Add tags to menu and frontpage components
- 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>
2025-01-09 21:08:10 +05:30

71 lines
2.2 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""FreedomBox app to configure sharing."""
from django.utils.translation import gettext_lazy as _
from plinth import app as app_module
from plinth import cfg, menu
from plinth.config import DropinConfigs
from plinth.modules.apache.components import Webserver
from plinth.modules.backups.components import BackupRestore
from plinth.utils import format_lazy
from . import manifest, privileged
_description = [
format_lazy(
_('Sharing allows you to share files and folders on your {box_name} '
'over the web with chosen groups of users.'),
box_name=_(cfg.box_name))
]
class SharingApp(app_module.App):
"""FreedomBox app for sharing files."""
app_id = 'sharing'
_version = 3
def __init__(self) -> None:
"""Create components for the app."""
super().__init__()
info = app_module.Info(app_id=self.app_id, version=self._version,
name=_('Sharing'), icon_filename='sharing',
manual_page='Sharing', description=_description,
tags=manifest.tags)
self.add(info)
menu_item = menu.Menu('menu-sharing', info.name, info.icon_filename,
info.tags, 'sharing:index',
parent_url_name='apps')
self.add(menu_item)
dropin_configs = DropinConfigs('dropin-configs-sharing', [
'/etc/apache2/includes/freedombox-sharing.conf',
])
self.add(dropin_configs)
webserver = Webserver('webserver-sharing', 'sharing-freedombox')
self.add(webserver)
backup_restore = BackupRestore('backup-restore-sharing',
**manifest.backup)
self.add(backup_restore)
def has_diagnostics(self):
"""Disable diagnostics button despite having webserver component."""
return False
def setup(self, old_version):
"""Install and configure the app."""
super().setup(old_version)
privileged.setup()
if not old_version:
self.enable()
def uninstall(self):
"""De-configure and uninstall the app."""
super().uninstall()
privileged.uninstall()