mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
e5b7ed4faf
- Add tags to Info component of apps. Use only English tags for all operations. Localized tags are used for presentation to the user only. Add tags to all the apps. Conventions (English): 1. Tags describing use cases should be in kebab case. 2. Protocols in tag names should be in their canonical format. 3. Tags needn't be 100% technically correct. This can get in the way of comparing apps using a tag. Words that describe use cases that users can easily understand should be preferred over being pedantic. 4. Tags should be short, ideally not more than 2 words. Avoid conjunctions like "and", "or" in tags. 5. Avoid redundant words like "server", or "web-clients". Most apps on FreedomBox are either servers or web clients. 6. Keep your nouns singular in tags. - Use query params to filter the Apps page by tags. When all tags are removed, redirect to /apps. - Add UI elements to add and remove tag filters in the Apps page. Make the UI similar to GitLab issue tags. Since there are 40 apps, there will be at least 40 tags. Selecting a tag from a dropdown will be difficult on mobile devices. A fuzzy search is useful to find tags to add to the filter. Allow user to find the best match for the search term and highlight it visually. The user can then press Enter to select the highlighted tag. Make tag search case-insensitive. Make the dropdown menu scrollable with a fixed size. User input is debounced by 300 ms during search. - tests: Add missing mock in test_module_loader.py - Add functional tests [sunil] - 'list' can be used instead of 'List' for typing in recent Python versions. - Reserve tripe-quoted strings for docstrings. - Undo some changes in module initialization, use module_name for logging errors. - isort and yapf changes. - Encode parameters before adding them to the URL. Tests: - Tested the functionality of filtering by tag with one tag and two tags. Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net> Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
144 lines
5.6 KiB
Python
144 lines
5.6 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""FreedomBox app to configure WordPress."""
|
|
|
|
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, SharedDaemon
|
|
from plinth.modules.apache.components import Webserver
|
|
from plinth.modules.backups.components import BackupRestore
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.package import Packages
|
|
from plinth.privileged import service as service_privileged
|
|
from plinth.utils import format_lazy
|
|
|
|
from . import manifest, privileged
|
|
|
|
_description = [
|
|
_('WordPress is a popular way to create and manage websites and blogs. '
|
|
'Content can be managed using a visual interface. Layout and '
|
|
'functionality of the web pages can be customized. Appearance can be '
|
|
'chosen using themes. Administration interface and produced web pages '
|
|
'are suitable for mobile devices.'),
|
|
format_lazy(
|
|
_('You need to run WordPress setup by visiting the app before making '
|
|
'the site publicly available below. Setup must be run when '
|
|
'accessing {box_name} with the correct domain name. Enable '
|
|
'permalinks in administrator interface for better URLs to your '
|
|
'pages and posts.'), box_name=_(cfg.box_name)),
|
|
_('WordPress has its own user accounts. First administrator account is '
|
|
'created during setup. Bookmark the <a '
|
|
'href="/wordpress/wp-admin/">admin page</a> to reach administration '
|
|
'interface in the future.'),
|
|
_('After a major version upgrade, you need to manually run database '
|
|
'upgrade from administrator interface. Additional plugins or themes may '
|
|
'be installed and upgraded at your own risk.'),
|
|
]
|
|
|
|
|
|
class WordPressApp(app_module.App):
|
|
"""FreedomBox app for WordPress."""
|
|
|
|
app_id = 'wordpress'
|
|
|
|
_version = 4
|
|
|
|
def __init__(self) -> None:
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
info = app_module.Info(
|
|
app_id=self.app_id, version=self._version, name=_('WordPress'),
|
|
icon_filename='wordpress', short_description=_('Website and Blog'),
|
|
description=_description, manual_page='WordPress',
|
|
clients=manifest.clients, tags=manifest.tags,
|
|
donation_url='https://wordpressfoundation.org/donate/')
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-wordpress', info.name,
|
|
info.short_description, info.icon_filename,
|
|
'wordpress:index', parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut('shortcut-wordpress', info.name,
|
|
short_description=info.short_description,
|
|
icon=info.icon_filename,
|
|
url='/wordpress/', clients=info.clients)
|
|
self.add(shortcut)
|
|
|
|
# Add php to avoid wordpress package bringing in lib-apache2-mod-php.
|
|
# WordPress only supports MySQL/MariaDB as database server.
|
|
packages = Packages(
|
|
'packages-wordpress',
|
|
[
|
|
'wordpress',
|
|
# Avoid WordPress package bringing in libapache2-mod-php
|
|
'php',
|
|
# Optional, for performance
|
|
'php-imagick',
|
|
# Optional, for performance
|
|
'php-zip',
|
|
# WordPress only supports MySQL/MariaDB as DB
|
|
'default-mysql-server',
|
|
],
|
|
conflicts=['libpam-tmpdir'],
|
|
conflicts_action=Packages.ConflictsAction.REMOVE)
|
|
self.add(packages)
|
|
|
|
dropin_configs = DropinConfigs('dropin-configs-wordpress', [
|
|
'/etc/apache2/conf-available/wordpress-freedombox.conf',
|
|
'/etc/fail2ban/jail.d/wordpress-freedombox.conf',
|
|
'/etc/fail2ban/filter.d/wordpress-freedombox.conf',
|
|
'/etc/wordpress/freedombox-static.php',
|
|
])
|
|
self.add(dropin_configs)
|
|
|
|
firewall = Firewall('firewall-wordpress', info.name,
|
|
ports=['http', 'https'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
webserver = Webserver('webserver-wordpress', 'wordpress-freedombox',
|
|
urls=['https://{host}/wordpress/'])
|
|
self.add(webserver)
|
|
|
|
daemon = Daemon('daemon-wordpress', 'wordpress-freedombox.timer')
|
|
self.add(daemon)
|
|
|
|
daemon = SharedDaemon('shared-daemon-wordpress-mysql', 'mysql')
|
|
self.add(daemon)
|
|
|
|
backup_restore = WordPressBackupRestore('backup-restore-wordpress',
|
|
**manifest.backup)
|
|
self.add(backup_restore)
|
|
|
|
def setup(self, old_version):
|
|
"""Install and configure the app."""
|
|
super().setup(old_version)
|
|
privileged.setup()
|
|
if not old_version:
|
|
self.enable()
|
|
elif old_version < 3:
|
|
# Apply changes to Apache configuration from v2 to v3.
|
|
service_privileged.reload('apache2')
|
|
|
|
def uninstall(self):
|
|
"""De-configure and uninstall the app."""
|
|
super().uninstall()
|
|
privileged.uninstall()
|
|
|
|
|
|
class WordPressBackupRestore(BackupRestore):
|
|
"""Component to backup/restore WordPress."""
|
|
|
|
def backup_pre(self, packet):
|
|
"""Save database contents."""
|
|
super().backup_pre(packet)
|
|
privileged.dump_database()
|
|
|
|
def restore_post(self, packet):
|
|
"""Restore database contents."""
|
|
super().restore_post(packet)
|
|
privileged.restore_database()
|