mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
157 lines
5.4 KiB
Python
157 lines
5.4 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
FreedomBox app to configure Tiny Tiny RSS.
|
|
"""
|
|
|
|
from django.urls import reverse_lazy
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
from plinth import actions
|
|
from plinth import app as app_module
|
|
from plinth import cfg, frontpage, menu
|
|
from plinth.daemon import Daemon
|
|
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 Version, format_lazy
|
|
|
|
from . import manifest
|
|
|
|
_description = [
|
|
_('Tiny Tiny RSS is a news feed (RSS/Atom) reader and aggregator, '
|
|
'designed to allow reading news from any location, while feeling as '
|
|
'close to a real desktop application as possible.'),
|
|
format_lazy(
|
|
_('When enabled, Tiny Tiny RSS can be accessed by '
|
|
'<a href="{users_url}">any user</a> belonging to the '
|
|
'feed-reader group.'), box_name=_(cfg.box_name),
|
|
users_url=reverse_lazy('users:index')),
|
|
format_lazy(
|
|
_('When using a mobile or desktop application for Tiny Tiny RSS, use '
|
|
'the URL <a href="/tt-rss-app/">/tt-rss-app</a> for connecting.'))
|
|
]
|
|
|
|
app = None
|
|
|
|
|
|
class TTRSSApp(app_module.App):
|
|
"""FreedomBox app for TT-RSS."""
|
|
|
|
app_id = 'ttrss'
|
|
|
|
_version = 3
|
|
|
|
def __init__(self):
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
groups = {'feed-reader': _('Read and subscribe to news feeds')}
|
|
|
|
info = app_module.Info(app_id=self.app_id, version=self._version,
|
|
name=_('Tiny Tiny RSS'), icon_filename='ttrss',
|
|
short_description=_('News Feed Reader'),
|
|
description=_description,
|
|
manual_page='TinyTinyRSS',
|
|
clients=manifest.clients)
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-ttrss', info.name, info.short_description,
|
|
info.icon_filename, 'ttrss:index',
|
|
parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut('shortcut-ttrss', info.name,
|
|
short_description=info.short_description,
|
|
icon=info.icon_filename, url='/tt-rss',
|
|
clients=info.clients,
|
|
login_required=True,
|
|
allowed_groups=list(groups))
|
|
self.add(shortcut)
|
|
|
|
packages = Packages('packages-ttrss', [
|
|
'tt-rss', 'postgresql', 'dbconfig-pgsql', 'php-pgsql',
|
|
'python3-psycopg2'
|
|
])
|
|
self.add(packages)
|
|
|
|
firewall = Firewall('firewall-ttrss', info.name,
|
|
ports=['http', 'https'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
webserver = Webserver('webserver-ttrss', 'tt-rss-plinth',
|
|
urls=['https://{host}/tt-rss'])
|
|
self.add(webserver)
|
|
|
|
daemon = Daemon('daemon-ttrss', 'tt-rss')
|
|
self.add(daemon)
|
|
|
|
users_and_groups = UsersAndGroups('users-and-groups-ttrss',
|
|
groups=groups)
|
|
self.add(users_and_groups)
|
|
|
|
backup_restore = TTRSSBackupRestore('backup-restore-ttrss',
|
|
**manifest.backup)
|
|
self.add(backup_restore)
|
|
|
|
def enable(self):
|
|
"""Enable components and API access."""
|
|
super().enable()
|
|
actions.superuser_run('ttrss', ['enable-api-access'])
|
|
|
|
# Try to set the domain to one of the available TLS domains
|
|
domain = get_domain()
|
|
if not domain or domain == 'localhost':
|
|
from plinth.modules import names
|
|
domain = next(names.get_available_tls_domains(), None)
|
|
set_domain(domain)
|
|
|
|
|
|
class TTRSSBackupRestore(BackupRestore):
|
|
"""Component to backup/restore TT-RSS"""
|
|
|
|
def backup_pre(self, packet):
|
|
"""Save database contents."""
|
|
super().backup_pre(packet)
|
|
actions.superuser_run('ttrss', ['dump-database'])
|
|
|
|
def restore_post(self, packet):
|
|
"""Restore database contents."""
|
|
super().restore_post(packet)
|
|
actions.superuser_run('ttrss', ['restore-database'])
|
|
|
|
|
|
def setup(helper, old_version=None):
|
|
"""Install and configure the module."""
|
|
helper.call('pre', actions.superuser_run, 'ttrss', ['pre-setup'])
|
|
app.setup(old_version)
|
|
helper.call('post', actions.superuser_run, 'ttrss', ['setup'])
|
|
helper.call('post', app.enable)
|
|
|
|
|
|
def force_upgrade(helper, packages):
|
|
"""Force update package to resolve conffile prompts."""
|
|
if 'tt-rss' not in packages:
|
|
return False
|
|
|
|
# Allow tt-rss any lower version to upgrade to 21.*
|
|
package = packages['tt-rss']
|
|
if Version(package['new_version']) > Version('22~'):
|
|
return False
|
|
|
|
helper.install(['tt-rss'], force_configuration='new')
|
|
actions.superuser_run('ttrss', ['setup'])
|
|
return True
|
|
|
|
|
|
def get_domain():
|
|
"""Read TLS domain from tt-rss config file."""
|
|
return actions.superuser_run('ttrss', ['get-domain']).strip()
|
|
|
|
|
|
def set_domain(domain):
|
|
"""Set the TLS domain in tt-rss configuration file."""
|
|
if domain:
|
|
actions.superuser_run('ttrss', ['set-domain', domain])
|