mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-02-18 08:33:41 +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>
113 lines
4.2 KiB
Python
113 lines
4.2 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""FreedomBox app for Miniflux."""
|
|
|
|
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.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.package import Packages
|
|
|
|
from . import manifest, privileged
|
|
|
|
_description = [
|
|
_('Miniflux is a web-based tool that aggregates news and blog updates from'
|
|
' various websites into one centralized, easy-to-read format. It has a '
|
|
'simple interface and focuses on a distraction-free reading experience. '
|
|
'You can can subscribe to your favorite sites and access full article '
|
|
'contents within the reader itself.'),
|
|
_('Key features include keyboard shortcuts for quick navigation, full-text'
|
|
' search, filtering articles, categories and favorites. Miniflux '
|
|
'preserves user privacy by removing trackers. The primary interface is '
|
|
'web-based. There are several third-party '
|
|
'<a href="https://miniflux.app/docs/apps.html">clients</a> as well.'),
|
|
]
|
|
|
|
|
|
class MinifluxApp(app_module.App):
|
|
"""FreedomBox app for Miniflux."""
|
|
|
|
app_id = 'miniflux'
|
|
|
|
_version = 2
|
|
|
|
def __init__(self):
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
info = app_module.Info(self.app_id, self._version, name=_('Miniflux'),
|
|
icon_filename='miniflux',
|
|
short_description=_('News Feed Reader'),
|
|
description=_description,
|
|
manual_page='miniflux',
|
|
clients=manifest.clients, tags=manifest.tags,
|
|
donation_url='https://miniflux.app/#donations')
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-miniflux', info.name,
|
|
info.short_description, info.icon_filename,
|
|
'miniflux:index', parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut('shortcut-miniflux', info.name,
|
|
info.short_description,
|
|
info.icon_filename, url='/miniflux',
|
|
clients=manifest.clients,
|
|
login_required=True)
|
|
self.add(shortcut)
|
|
|
|
packages = Packages('packages-miniflux', ['miniflux', 'postgresql'])
|
|
self.add(packages)
|
|
|
|
drop_in_configs = DropinConfigs(
|
|
'dropin-configs-miniflux',
|
|
['/etc/apache2/conf-available/miniflux-freedombox.conf'])
|
|
self.add(drop_in_configs)
|
|
|
|
firewall = Firewall('firewall-miniflux', info.name,
|
|
ports=['http', 'https'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
webserver = Webserver('webserver-miniflux', 'miniflux-freedombox',
|
|
urls=['https://{host}/miniflux/'])
|
|
self.add(webserver)
|
|
|
|
daemon = Daemon('daemon-miniflux', 'miniflux',
|
|
listen_ports=[(8788, 'tcp4'), (8788, 'tcp6')])
|
|
self.add(daemon)
|
|
|
|
backup_restore = MinifluxBackupRestore('backup-restore-miniflux',
|
|
**manifest.backup)
|
|
self.add(backup_restore)
|
|
|
|
def setup(self, old_version=None):
|
|
"""Install and configure the app."""
|
|
privileged.pre_setup()
|
|
super().setup(old_version)
|
|
privileged.setup(old_version)
|
|
if not old_version:
|
|
self.enable()
|
|
|
|
def uninstall(self):
|
|
"""De-configure and uninstall the app."""
|
|
privileged.uninstall()
|
|
super().uninstall()
|
|
|
|
|
|
class MinifluxBackupRestore(BackupRestore):
|
|
"""Component to backup/restore Miniflux."""
|
|
|
|
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()
|