mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
ac5f778ae8
Closes: #2493. Tests: - For each of the packages in the list, download the Bookworm version and Trixie version of the packages. See if the files in /etc/ that were modified were also files we also modify. If so, keep it in the list. Otherwise, remove it from the list. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
121 lines
4.7 KiB
Python
121 lines
4.7 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
FreedomBox app to configure Roundcube.
|
|
"""
|
|
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
from plinth import app as app_module
|
|
from plinth import 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.package import Packages, install
|
|
|
|
from . import manifest, privileged
|
|
|
|
_description = [
|
|
_('Roundcube webmail is a browser-based multilingual IMAP '
|
|
'client with an application-like user interface. It provides '
|
|
'full functionality you expect from an email client, including '
|
|
'MIME support, address book, folder manipulation, message '
|
|
'searching and spell checking.'),
|
|
_('You can use it by providing the username and password of the email '
|
|
'account you wish to access followed by the domain name of the '
|
|
'IMAP server for your email provider, like <code>imap.example.com'
|
|
'</code>. For IMAP over SSL (recommended), fill the server field '
|
|
'like <code>imaps://imap.example.com</code>.'),
|
|
_('For Gmail, username will be your Gmail address, password will be '
|
|
'your Google account password and server will be '
|
|
'<code>imaps://imap.gmail.com</code>. Note that you will also need '
|
|
'to enable "Less secure apps" in your Google account settings '
|
|
'(<a href="https://www.google.com/settings/security/lesssecureapps"'
|
|
'>https://www.google.com/settings/security/lesssecureapps</a>).'),
|
|
]
|
|
|
|
|
|
class RoundcubeApp(app_module.App):
|
|
"""FreedomBox app for Roundcube."""
|
|
|
|
app_id = 'roundcube'
|
|
|
|
_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=_('Roundcube'), icon_filename='roundcube',
|
|
description=_description,
|
|
manual_page='Roundcube',
|
|
clients=manifest.clients, tags=manifest.tags)
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-roundcube', info.name, info.icon_filename,
|
|
info.tags, 'roundcube:index',
|
|
parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut('shortcut-roundcube', info.name,
|
|
icon=info.icon_filename,
|
|
url='/roundcube/', clients=info.clients,
|
|
tags=info.tags, login_required=True)
|
|
self.add(shortcut)
|
|
|
|
packages = Packages(
|
|
'packages-roundcube',
|
|
['sqlite3', 'roundcube', 'roundcube-core', 'roundcube-sqlite3'])
|
|
self.add(packages)
|
|
|
|
dropin_configs = DropinConfigs('dropin-configs-roundcube', [
|
|
'/etc/apache2/conf-available/roundcube-freedombox.conf',
|
|
'/etc/fail2ban/jail.d/roundcube-auth-freedombox.conf',
|
|
])
|
|
self.add(dropin_configs)
|
|
|
|
firewall = Firewall('firewall-roundcube', info.name,
|
|
ports=['http', 'https'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
webserver = Webserver('webserver-roundcube', 'roundcube')
|
|
self.add(webserver)
|
|
|
|
webserver = Webserver('webserver-roundcube-freedombox',
|
|
'roundcube-freedombox',
|
|
urls=['https://{host}/roundcube'])
|
|
self.add(webserver)
|
|
|
|
backup_restore = BackupRestore('backup-restore-roundcube',
|
|
**manifest.backup)
|
|
self.add(backup_restore)
|
|
|
|
def setup(self, old_version):
|
|
"""Install and configure the app."""
|
|
privileged.pre_install()
|
|
super().setup(old_version)
|
|
privileged.setup()
|
|
if old_version == 0:
|
|
privileged.set_config(local_only=True)
|
|
self.enable()
|
|
|
|
def uninstall(self):
|
|
"""De-configure and uninstall the app."""
|
|
super().uninstall()
|
|
privileged.uninstall()
|
|
|
|
def force_upgrade(self, packages):
|
|
"""Force upgrade package to resolve conffile prompts."""
|
|
if 'roundcube-core' not in packages:
|
|
return False
|
|
|
|
# Allow roundcube any version to upgrade to any version. This is okay
|
|
# because there will no longer be conflicting file changes after
|
|
# upgrade from bullseye to bookworm.
|
|
install(['roundcube-core'], force_configuration='new')
|
|
if self.get_component('webserver-roundcube').is_enabled():
|
|
self.get_component('webserver-roundcube-freedombox').enable()
|
|
|
|
return True
|