Sunil Mohan Adapa f8136e8c8f
sharing: Add installing and enable/disable like other apps
- With the new setup mechanism automatic setup of app is no longer possible.

- Enabling/disabling is desirable by the user.

- During initial setup, ensure that Apache configuration file exists. Upgrade
for existing users to create the file.

- Enabling/disabling the app enables/disables the web server configuration file.

- Diagnostics are not available, disable them explicitly as auto-detect does not
work.

- Use the regular app base template instead of custom one.

- Use framework base classes for view and functional tests.

Tests:

- Run functional tests.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2022-08-15 10:36:49 -04:00

82 lines
2.4 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""
FreedomBox app to configure sharing.
"""
import json
from django.utils.translation import gettext_lazy as _
from plinth import actions
from plinth import app as app_module
from plinth import cfg, menu
from plinth.modules.apache.components import Webserver
from plinth.modules.backups.components import BackupRestore
from plinth.utils import format_lazy
from . import manifest, privileged
_description = [
format_lazy(
_('Sharing allows you to share files and folders on your {box_name} '
'over the web with chosen groups of users.'),
box_name=_(cfg.box_name))
]
class SharingApp(app_module.App):
"""FreedomBox app for sharing files."""
app_id = 'sharing'
_version = 2
def __init__(self):
"""Create components for the app."""
super().__init__()
info = app_module.Info(app_id=self.app_id, version=self._version,
name=_('Sharing'), icon_filename='sharing',
manual_page='Sharing', description=_description)
self.add(info)
menu_item = menu.Menu('menu-sharing', info.name, None,
info.icon_filename, 'sharing:index',
parent_url_name='apps')
self.add(menu_item)
webserver = Webserver('webserver-sharing', 'sharing-freedombox')
self.add(webserver)
backup_restore = BackupRestore('backup-restore-sharing',
**manifest.backup)
self.add(backup_restore)
def has_diagnostics(self):
"""Disable diagnostics button despite having webserver component."""
return False
def setup(self, old_version):
"""Install and configure the app."""
super().setup(old_version)
privileged.setup()
self.enable()
def list_shares():
"""Return a list of shares."""
output = actions.superuser_run('sharing', ['list'])
return json.loads(output)['shares']
def add_share(name, path, groups, is_public):
"""Add a new share by called the action script."""
args = ['add', '--name', name, '--path', path, '--groups'] + groups
if is_public:
args.append('--is-public')
actions.superuser_run('sharing', args)
def remove_share(name):
"""Remove a share by calling the action script."""
actions.superuser_run('sharing', ['remove', '--name', name])