# SPDX-License-Identifier: AGPL-3.0-or-later """FreedomBox app to configure WordPress.""" from django.utils.translation import gettext_lazy as _ from freedombox import app as app_module from freedombox import cfg, frontpage, menu from freedombox.config import DropinConfigs from freedombox.daemon import Daemon, SharedDaemon from freedombox.modules.apache.components import Webserver from freedombox.modules.backups.components import BackupRestore from freedombox.modules.firewall.components import Firewall from freedombox.package import Packages from freedombox.privileged import service as service_privileged from freedombox.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 admin page 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', 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.icon_filename, info.tags, 'wordpress:index', parent_url_name='apps') self.add(menu_item) shortcut = frontpage.Shortcut('shortcut-wordpress', info.name, icon=info.icon_filename, url='/wordpress/', clients=info.clients, tags=info.tags) 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) daemon1 = SharedDaemon('shared-daemon-wordpress-mysql', 'mysql') self.add(daemon1) daemon2 = Daemon('daemon-wordpress', 'wordpress-freedombox.timer') self.add(daemon2) 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()