mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-02-04 08:13:38 +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>
100 lines
3.4 KiB
Python
100 lines
3.4 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
FreedomBox app for wireguard.
|
|
"""
|
|
|
|
from django.urls import reverse_lazy
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
from plinth import app as app_module
|
|
from plinth import cfg, frontpage, menu
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.package import Packages
|
|
from plinth.utils import format_lazy, import_from_gi
|
|
|
|
from . import manifest, utils
|
|
|
|
nm = import_from_gi('NM', '1.0')
|
|
|
|
_description = [
|
|
_('WireGuard is a fast, modern, secure VPN tunnel.'),
|
|
format_lazy(
|
|
_('It can be used to connect to a VPN provider which supports '
|
|
'WireGuard, and to route all outgoing traffic from {box_name} '
|
|
'through the VPN.'), box_name=_(cfg.box_name)),
|
|
format_lazy(
|
|
_('A second use case is to connect a mobile device to {box_name} '
|
|
'while travelling. While connected to a public Wi-Fi network, all '
|
|
'traffic can be securely relayed through {box_name}.'),
|
|
box_name=_(cfg.box_name))
|
|
]
|
|
|
|
SERVER_INTERFACE = 'wg0'
|
|
|
|
|
|
class WireguardApp(app_module.App):
|
|
"""FreedomBox app for wireguard."""
|
|
|
|
app_id = 'wireguard'
|
|
|
|
_version = 1
|
|
|
|
def __init__(self) -> None:
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
info = app_module.Info(
|
|
app_id=self.app_id, version=self._version, name=_('WireGuard'),
|
|
icon_filename='wireguard',
|
|
short_description=_('Virtual Private Network'),
|
|
description=_description, manual_page='WireGuard',
|
|
clients=manifest.clients, tags=manifest.tags,
|
|
donation_url='https://www.wireguard.com/donations/')
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-wireguard', info.name,
|
|
info.short_description, info.icon_filename,
|
|
'wireguard:index', parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut(
|
|
'shortcut-wireguard', info.name,
|
|
short_description=info.short_description, icon=info.icon_filename,
|
|
description=info.description, manual_page=info.manual_page,
|
|
configure_url=reverse_lazy('wireguard:index'), login_required=True,
|
|
clients=info.clients)
|
|
self.add(shortcut)
|
|
|
|
packages = Packages('packages-wireguard', ['wireguard'])
|
|
self.add(packages)
|
|
|
|
firewall = Firewall('firewall-wireguard', info.name,
|
|
ports=['wireguard-freedombox'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
def enable(self):
|
|
"""Enable the app by simply storing a flag in key/value store."""
|
|
from plinth import kvstore
|
|
super().enable()
|
|
kvstore.set('wireguard-enabled', True)
|
|
utils.enable_connections(True)
|
|
|
|
def disable(self):
|
|
"""Disable the app by simply storing a flag in key/value store."""
|
|
from plinth import kvstore
|
|
super().disable()
|
|
kvstore.set('wireguard-enabled', False)
|
|
utils.enable_connections(False)
|
|
|
|
def is_enabled(self):
|
|
"""Return whether all leader components are enabled and flag is set."""
|
|
from plinth import kvstore
|
|
enabled = super().is_enabled()
|
|
return enabled and kvstore.get_default('wireguard-enabled', False)
|
|
|
|
def setup(self, old_version):
|
|
"""Install and configure the app."""
|
|
super().setup(old_version)
|
|
if not old_version:
|
|
self.enable()
|