Sunil Mohan Adapa b96d901071
Introduce component architecture and menu component
- 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>
2019-06-07 11:48:04 -07:00

115 lines
3.0 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/>.
#
"""
FreedomBox app to configure XMPP web client/jsxc.
"""
import logging
from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from plinth import app as app_module
from plinth import frontpage, menu
from plinth import service as service_module
from .manifest import backup, clients
version = 1
managed_packages = ['libjs-jsxc']
name = _('JSXC')
short_description = _('Chat Client')
description = [
_('JSXC is a web client for XMPP. Typically it is used with an XMPP '
'server running locally.'),
]
clients = clients
service = None
logger = logging.getLogger(__name__)
app = None
class JSXCApp(app_module.App):
"""FreedomBox app for JSXC."""
def __init__(self):
"""Create components for the app."""
super().__init__()
menu_item = menu.Menu('menu-jsxc', name, short_description, 'jsxc',
'jsxc:index', parent_url_name='apps')
self.add(menu_item)
def init():
"""Initialize the JSXC module"""
global app
app = JSXCApp()
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(
'jsxc', name, ports=['http', 'https'], is_external=True,
is_enabled=is_enabled, enable=enable, disable=disable)
if is_enabled():
add_shortcut()
app.set_enabled(True)
def setup(helper, old_version=None):
"""Install and configure the module."""
helper.install(managed_packages)
global service
if not service:
service = service_module.Service(
'jsxc', name, ports=['http', 'https'], is_external=True,
is_enabled=is_enabled, enable=enable, disable=disable)
helper.call('post', add_shortcut)
helper.call('post', app.enable)
def add_shortcut():
frontpage.add_shortcut('jsxc', name=name,
short_description=short_description,
url=reverse_lazy('jsxc:jsxc'), login_required=True)
def is_enabled():
"""Return whether the module is enabled."""
setup_helper = globals()['setup_helper']
return setup_helper.get_state() != 'needs-setup'
def enable():
add_shortcut()
app.enable()
def disable():
frontpage.remove_shortcut('jsxc')
app.disable()