mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-09-12 04:52:45 +00:00
75c57d3e00
- Turn frontpage shortcut into an App component. Add tests and full documentation. - Overridden implementations for tahoe, diaspora, mediawiki shortcuts to handle special cases. Special handling for ikiwiki. - Extend App API for removing and retrieving a component. - Add clients information into shortcuts to avoid hacks when presenting shortcuts to Mobile devices via API. - Fixed unnecessary stripping and adding of '/' when setting home page redirect URLs. This fixes problem with setting Cockpit as home page. - Replaced the use of term 'app' in favor of 'shortcut' as the term when setting frontpage shortcuts as home page. - JSXC shortcut does not require login. - Don't show shadowsocks for anonymous users. - Simplify showing selected shortcut details. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
143 lines
4.1 KiB
Python
143 lines
4.1 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 Searx.
|
|
"""
|
|
|
|
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 plinth.modules.users import register_group
|
|
|
|
from .manifest import backup, clients
|
|
|
|
clients = clients
|
|
|
|
version = 2
|
|
|
|
managed_services = ['searx']
|
|
|
|
managed_packages = ['searx', 'uwsgi', 'uwsgi-plugin-python3']
|
|
|
|
name = _('Searx')
|
|
|
|
short_description = _('Web Search')
|
|
|
|
description = [
|
|
_('Searx is a privacy-respecting Internet metasearch engine. '
|
|
'It aggregrates and displays results from multiple search engines.'),
|
|
_('Searx can be used to avoid tracking and profiling by search engines. '
|
|
'It stores no cookies by default.')
|
|
]
|
|
|
|
group = ('web-search', _('Search the web'))
|
|
|
|
service = None
|
|
|
|
manual_page = 'Searx'
|
|
|
|
app = None
|
|
|
|
|
|
class SearxApp(app_module.App):
|
|
"""FreedomBox app for Searx."""
|
|
|
|
def __init__(self):
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
menu_item = menu.Menu('menu-searx', name, short_description, 'searx',
|
|
'searx:index', parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut(
|
|
'shortcut-searx', name, short_description=short_description,
|
|
icon='searx', url='/searx/', clients=clients, login_required=True,
|
|
allowed_groups=[group[0]])
|
|
self.add(shortcut)
|
|
|
|
|
|
def init():
|
|
"""Intialize the module."""
|
|
global app
|
|
app = SearxApp()
|
|
register_group(group)
|
|
|
|
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)
|
|
|
|
if 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, 'searx', ['setup'])
|
|
if not old_version:
|
|
helper.call('post', actions.superuser_run, 'searx', ['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)
|
|
helper.call('post', app.enable)
|
|
|
|
|
|
def get_safe_search_setting():
|
|
"""Get the current value of the safe search setting for Seax."""
|
|
value = actions.superuser_run('searx', ['get-safe-search'])
|
|
return int(value.strip())
|
|
|
|
|
|
def is_enabled():
|
|
"""Return whether the module is enabled."""
|
|
return (action_utils.webserver_is_enabled('searx-freedombox')
|
|
and action_utils.uwsgi_is_enabled('searx'))
|
|
|
|
|
|
def enable():
|
|
"""Enable the module."""
|
|
actions.superuser_run('searx', ['enable'])
|
|
app.enable()
|
|
|
|
|
|
def disable():
|
|
"""Disable the module."""
|
|
actions.superuser_run('searx', ['disable'])
|
|
app.disable()
|
|
|
|
|
|
def diagnose():
|
|
"""Run diagnostics and return the results."""
|
|
results = []
|
|
|
|
results.extend(
|
|
action_utils.diagnose_url_on_all('https://{host}/searx/',
|
|
check_certificate=False))
|
|
|
|
return results
|