mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
e04ae48637
- Handle groups needed by an app.
- Handle reserved usernames for an app.
- Updated documentation
- Updated unit tests
Tests performed:
- Reserved usernames: ez-ipupd, ejabberd, Debian-minetest, mldonkey,
monkeysphere, mumble-server, privoxy, quasselcore, radicale, debian-tor,
debian-transmission
- Reserved usernames checks should work in the following forms:
- Create user
- Update user
- First boot user creation
- Full list of available groups should appear in following cases:
- Create user form
- Update user form
- Full list of groups should get created in Django DB during:
- Update user form display
- First boot form save
- When updating the last admin user, the 'admin' group choice is checked
and disabled.
- Following groups show up (sorted by group name):
- bit-torrent: Download files using BitTorrent applications
- git-access: Read-write access to Git repositories
- i2p: Manage I2P application
- wiki: View and edit wiki applications
- minidlna: Media streaming server
- ed2k: Download files using eDonkey applications
- freedombox-share: Access to the private shares
- web-search: Search the web
- syncthing: Administer Syncthing application
- feed-reader: Read and subscribe to news feeds
- admin: Access to all services and system settings
- Directory validation form checks for write permissions for following apps:
- deluge with debian-deluged user
- transmission with debian-transmission user
- Sharing app should show all the groups in add/edit share forms
- The following apps should get added to share group during setup:
debian-transmission
debian-deluged
- Unit tests pass
- Functional tests for users and groups pass
- Test that an app (example syncthing) provides the necessary
permissions to users in that group (but not in admin group).
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
[sunil: Fix i18n of group descriptions]
[sunil: Update developer documentation]
[sunil: Separate out cosmetic changes]
[sunil: Fix component ID for mumble]
[sunil: sharing: Remove unneeded dependency on users app]
[sunil: Implement better API for getting groups in component]
[sunil: Fix incorrect regression change ttrss app]
[sunil: Make iterating over gourps more readable]
[sunil: Improve tests, drop single use fixtures]
[sunil: Simplify test_view.py fixture]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Tested-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
107 lines
3.6 KiB
Python
107 lines
3.6 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
FreedomBox app to configure a Deluge web client.
|
|
"""
|
|
|
|
from django.utils.translation import ugettext_lazy as _
|
|
|
|
from plinth import actions
|
|
from plinth import app as app_module
|
|
from plinth import frontpage, menu
|
|
from plinth.daemon import Daemon
|
|
from plinth.modules.apache.components import Webserver
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.modules.users import add_user_to_share_group
|
|
from plinth.modules.users.components import UsersAndGroups
|
|
|
|
from .manifest import backup, clients # noqa, pylint: disable=unused-import
|
|
|
|
version = 6
|
|
|
|
managed_services = ['deluged', 'deluge-web']
|
|
|
|
managed_packages = ['deluged', 'deluge-web']
|
|
|
|
_description = [
|
|
_('Deluge is a BitTorrent client that features a Web UI.'),
|
|
_('The default password is \'deluge\', but you should log in and '
|
|
'change it immediately after enabling this service.')
|
|
]
|
|
|
|
app = None
|
|
|
|
SYSTEM_USER = 'debian-deluged'
|
|
|
|
|
|
class DelugeApp(app_module.App):
|
|
"""FreedomBox app for Deluge."""
|
|
|
|
app_id = 'deluge'
|
|
|
|
def __init__(self):
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
groups = {
|
|
'bit-torrent': _('Download files using BitTorrent applications')
|
|
}
|
|
|
|
info = app_module.Info(app_id=self.app_id, version=version,
|
|
name=_('Deluge'), icon_filename='deluge',
|
|
short_description=_('BitTorrent Web Client'),
|
|
description=_description, manual_page='Deluge',
|
|
clients=clients)
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-deluge', info.name, info.short_description,
|
|
info.icon_filename, 'deluge:index',
|
|
parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut('shortcut-deluge', info.name,
|
|
short_description=info.short_description,
|
|
url='/deluge', icon=info.icon_filename,
|
|
clients=info.clients,
|
|
login_required=True,
|
|
allowed_groups=list(groups))
|
|
self.add(shortcut)
|
|
|
|
firewall = Firewall('firewall-deluge', info.name,
|
|
ports=['http', 'https'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
webserver = Webserver('webserver-deluge', 'deluge-plinth',
|
|
urls=['https://{host}/deluge'])
|
|
self.add(webserver)
|
|
|
|
daemon = Daemon('daemon-deluged', managed_services[0],
|
|
listen_ports=[(58846, 'tcp4')])
|
|
self.add(daemon)
|
|
|
|
daemon_web = Daemon('daemon-deluge-web', managed_services[1],
|
|
listen_ports=[(8112, 'tcp4')])
|
|
self.add(daemon_web)
|
|
|
|
users_and_groups = UsersAndGroups('users-and-groups-deluge',
|
|
reserved_usernames=[SYSTEM_USER],
|
|
groups=groups)
|
|
self.add(users_and_groups)
|
|
|
|
|
|
def init():
|
|
"""Initialize the Deluge module."""
|
|
global app
|
|
app = DelugeApp()
|
|
|
|
setup_helper = globals()['setup_helper']
|
|
if setup_helper.get_state() != 'needs-setup' and app.is_enabled():
|
|
app.set_enabled(True)
|
|
|
|
|
|
def setup(helper, old_version=None):
|
|
"""Install and configure the module."""
|
|
helper.install(managed_packages)
|
|
helper.call('post', actions.superuser_run, 'deluge', ['setup'])
|
|
add_user_to_share_group(SYSTEM_USER)
|
|
helper.call('post', app.enable)
|