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>
138 lines
5.0 KiB
Python
138 lines
5.0 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""FreedomBox app to configure ikiwiki."""
|
|
|
|
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.modules.apache.components import Webserver
|
|
from plinth.modules.backups.components import BackupRestore
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.modules.users.components import UsersAndGroups
|
|
from plinth.package import Packages
|
|
from plinth.utils import format_lazy
|
|
|
|
from . import manifest, privileged
|
|
|
|
_description = [
|
|
_('ikiwiki is a simple wiki and blog application. It supports '
|
|
'several lightweight markup languages, including Markdown, and '
|
|
'common blogging functionality such as comments and RSS feeds.'),
|
|
format_lazy(
|
|
_('Only {box_name} users in the <b>admin</b> group can <i>create</i> '
|
|
'and <i>manage</i> blogs and wikis, but any user in the <b>wiki</b> '
|
|
'group can <i>edit</i> existing ones. In the <a href="{users_url}">'
|
|
'User Configuration</a> you can change these '
|
|
'permissions or add new users.'), box_name=_(cfg.box_name),
|
|
users_url=reverse_lazy('users:index'))
|
|
]
|
|
|
|
|
|
class IkiwikiApp(app_module.App):
|
|
"""FreedomBox app for Ikiwiki."""
|
|
|
|
app_id = 'ikiwiki'
|
|
|
|
_version = 2
|
|
|
|
def __init__(self) -> None:
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
info = app_module.Info(app_id=self.app_id, version=self._version,
|
|
name=_('ikiwiki'), icon_filename='ikiwiki',
|
|
description=_description, manual_page='Ikiwiki',
|
|
clients=manifest.clients, tags=manifest.tags,
|
|
donation_url='https://ikiwiki.info/tipjar/')
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-ikiwiki', info.name, info.icon_filename,
|
|
info.tags, 'ikiwiki:index',
|
|
parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
packages = Packages('packages-ikiwiki', [
|
|
'ikiwiki', 'libdigest-sha-perl', 'libxml-writer-perl',
|
|
'xapian-omega', 'libsearch-xapian-perl', 'libimage-magick-perl',
|
|
'gcc', 'git', 'librpc-xml-perl', 'libcgi-session-perl',
|
|
'libcgi-formbuilder-perl', 'libc6-dev'
|
|
])
|
|
self.add(packages)
|
|
|
|
dropin_configs = DropinConfigs('dropin-configs-ikiwiki', [
|
|
'/etc/ikiwiki/plinth-blog.setup',
|
|
'/etc/ikiwiki/plinth-wiki.setup',
|
|
'/etc/apache2/conf-available/ikiwiki-plinth.conf',
|
|
])
|
|
self.add(dropin_configs)
|
|
|
|
firewall = Firewall('firewall-ikiwiki', info.name,
|
|
ports=['http', 'https'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
webserver = Webserver('webserver-ikiwiki', 'ikiwiki-plinth',
|
|
urls=['https://{host}/ikiwiki'])
|
|
self.add(webserver)
|
|
|
|
groups = {'wiki': _('View and edit wiki applications')}
|
|
users_and_groups = UsersAndGroups('users-and-groups-ikiwiki',
|
|
groups=groups)
|
|
self.add(users_and_groups)
|
|
|
|
backup_restore = IkiwikiBackupRestore('backup-restore-ikiwiki',
|
|
**manifest.backup)
|
|
self.add(backup_restore)
|
|
|
|
def post_init(self):
|
|
"""Perform post initialization operations."""
|
|
self.refresh_sites()
|
|
|
|
def add_shortcut(self, site, title):
|
|
"""Add an ikiwiki shortcut to frontpage."""
|
|
shortcut = frontpage.Shortcut('shortcut-ikiwiki-' + site, title,
|
|
icon=self.info.icon_filename,
|
|
url='/ikiwiki/' + site,
|
|
clients=self.info.clients)
|
|
self.add(shortcut)
|
|
return shortcut
|
|
|
|
def remove_shortcut(self, site):
|
|
"""Remove an ikiwiki shortcut from frontpage."""
|
|
component = self.remove('shortcut-ikiwiki-' + site)
|
|
component.remove() # Remove from global list.
|
|
|
|
def refresh_sites(self):
|
|
"""Refresh blog and wiki list."""
|
|
sites = privileged.get_sites()
|
|
|
|
for site in sites:
|
|
if not 'shortcut-ikiwiki-' + site[0] in self.components:
|
|
self.add_shortcut(site[0], site[1])
|
|
|
|
return sites
|
|
|
|
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()
|
|
|
|
|
|
class IkiwikiBackupRestore(BackupRestore):
|
|
"""Component to handle Ikiwiki restore"""
|
|
|
|
def restore_post(self, packet):
|
|
"""Re-run setup for each wiki after restore."""
|
|
super().restore_post(packet)
|
|
sites = privileged.get_sites()
|
|
for site in sites:
|
|
privileged.setup_site(site[0])
|