mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-04-29 10:10:19 +00:00
b96d901071
- Introduce base class for all apps that will contain components. With
unittests.
- Introduce base classes for components. With unittests.
- Turn Menu class into an app component.
- Further cleanup Menu class.
- Update tests.
- Maintain a global list of menu items and look them up easily. Generalize
such that subsubmenus can later be merged into Menu class.
- Cleanup scope of main menu initialization.
- Use None instead of empty strings for various values. Ensure that
printing short_description does not show 'None' in output.
- Use enable/disable instead of promote/demote.
- Use menu component in all apps.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
154 lines
4.6 KiB
Python
154 lines
4.6 KiB
Python
#
|
||
# This file is part of FreedomBox.
|
||
#
|
||
# This program is free software: you can redistribute it and/or modify
|
||
# it under the terms of the GNU Affero General Public License as
|
||
# published by the Free Software Foundation, either version 3 of the
|
||
# License, or (at your option) any later version.
|
||
#
|
||
# This program is distributed in the hope that it will be useful,
|
||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
# GNU Affero General Public License for more details.
|
||
#
|
||
# You should have received a copy of the GNU Affero General Public License
|
||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
#
|
||
"""
|
||
Plinth module to configure coquelicot.
|
||
"""
|
||
|
||
from django.utils.translation import ugettext_lazy as _
|
||
|
||
from plinth import action_utils, actions
|
||
from plinth import app as app_module
|
||
from plinth import frontpage, menu
|
||
from plinth import service as service_module
|
||
|
||
from .manifest import backup, clients
|
||
|
||
clients = clients
|
||
|
||
version = 1
|
||
|
||
managed_services = ['coquelicot']
|
||
|
||
managed_packages = ['coquelicot']
|
||
|
||
name = _('Coquelicot')
|
||
|
||
short_description = _('File Sharing')
|
||
|
||
description = [
|
||
_('Coquelicot is a “one-click” file sharing web application with a focus '
|
||
'on protecting users’ privacy. It is best used for quickly sharing a '
|
||
'single file. '),
|
||
_('This Coquelicot instance is exposed to the public but requires an '
|
||
'upload password to prevent unauthorized access. You can set a new '
|
||
'upload password in the form that will appear below after installation. '
|
||
'The default upload password is "test".')
|
||
]
|
||
|
||
service = None
|
||
|
||
manual_page = 'Coquelicot'
|
||
|
||
app = None
|
||
|
||
|
||
class CoquelicotApp(app_module.App):
|
||
"""FreedomBox app for Coquelicot."""
|
||
|
||
def __init__(self):
|
||
"""Create components for the app."""
|
||
super().__init__()
|
||
menu_item = menu.Menu('menu-coquelicot', name, short_description,
|
||
'coquelicot', 'coquelicot:index',
|
||
parent_url_name='apps')
|
||
self.add(menu_item)
|
||
|
||
|
||
def init():
|
||
"""Intialize the module."""
|
||
global app
|
||
app = CoquelicotApp()
|
||
|
||
global service
|
||
setup_helper = globals()['setup_helper']
|
||
if setup_helper.get_state() != 'needs-setup':
|
||
service = service_module.Service(managed_services[0], name, ports=[
|
||
'http', 'https'
|
||
], is_external=True, is_enabled=is_enabled, enable=enable,
|
||
disable=disable,
|
||
is_running=is_running)
|
||
|
||
if is_enabled():
|
||
add_shortcut()
|
||
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, 'coquelicot', ['setup'])
|
||
helper.call('post', actions.superuser_run, 'coquelicot', ['enable'])
|
||
global service
|
||
if service is None:
|
||
service = service_module.Service(managed_services[0], name, ports=[
|
||
'http', 'https'
|
||
], is_external=True, is_enabled=is_enabled, enable=enable,
|
||
disable=disable,
|
||
is_running=is_running)
|
||
helper.call('post', service.notify_enabled, None, True)
|
||
helper.call('post', add_shortcut)
|
||
helper.call('post', app.enable)
|
||
|
||
|
||
def add_shortcut():
|
||
"""Helper method to add a shortcut to the frontpage."""
|
||
frontpage.add_shortcut('coquelicot', name,
|
||
short_description=short_description,
|
||
url='/coquelicot', login_required=True)
|
||
|
||
|
||
def is_running():
|
||
"""Return whether the service is running."""
|
||
return action_utils.service_is_running('coquelicot')
|
||
|
||
|
||
def is_enabled():
|
||
"""Return whether the module is enabled."""
|
||
return (action_utils.service_is_enabled('coquelicot')
|
||
and action_utils.webserver_is_enabled('coquelicot-freedombox'))
|
||
|
||
|
||
def enable():
|
||
"""Enable the module."""
|
||
actions.superuser_run('coquelicot', ['enable'])
|
||
add_shortcut()
|
||
app.enable()
|
||
|
||
|
||
def disable():
|
||
"""Disable the module."""
|
||
actions.superuser_run('coquelicot', ['disable'])
|
||
frontpage.remove_shortcut('coquelicot')
|
||
app.disable()
|
||
|
||
|
||
def get_current_max_file_size():
|
||
"""Get the current value of maximum file size."""
|
||
size = actions.superuser_run('coquelicot', ['get-max-file-size'])
|
||
return int(size.strip())
|
||
|
||
|
||
def diagnose():
|
||
"""Run diagnostics and return the results."""
|
||
results = []
|
||
|
||
results.extend(
|
||
action_utils.diagnose_url_on_all('https://{host}/coquelicot',
|
||
check_certificate=False))
|
||
|
||
return results
|