mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-03-04 08:53:42 +00:00
5944e13cf0
- Handle gzipped example settings files - Fix yaml.load deprecation warnings Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
145 lines
4.8 KiB
Python
145 lines
4.8 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
FreedomBox app to configure Searx.
|
|
"""
|
|
|
|
import os
|
|
|
|
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.modules.apache.components import Uwsgi, Webserver
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.modules.users import register_group
|
|
|
|
from .manifest import (PUBLIC_ACCESS_SETTING_FILE, # noqa, pylint: disable=unused-import
|
|
backup, clients)
|
|
|
|
version = 4
|
|
|
|
managed_packages = ['searx', 'uwsgi', 'uwsgi-plugin-python3']
|
|
|
|
_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'))
|
|
|
|
manual_page = 'Searx'
|
|
|
|
app = None
|
|
|
|
|
|
class SearxApp(app_module.App):
|
|
"""FreedomBox app for Searx."""
|
|
|
|
app_id = 'searx'
|
|
|
|
def __init__(self):
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
info = app_module.Info(app_id=self.app_id, version=version,
|
|
name=_('Searx'), icon_filename='searx',
|
|
short_description=_('Web Search'),
|
|
description=_description, manual_page='Searx',
|
|
clients=clients)
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-searx', info.name, info.short_description,
|
|
info.icon_filename, 'searx:index',
|
|
parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut(
|
|
'shortcut-searx', info.name,
|
|
short_description=info.short_description, icon=info.icon_filename,
|
|
url='/searx/', clients=info.clients,
|
|
login_required=(not is_public_access_enabled()),
|
|
allowed_groups=[group[0]])
|
|
self.add(shortcut)
|
|
|
|
firewall = Firewall('firewall-searx', info.name,
|
|
ports=['http', 'https'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
webserver = Webserver('webserver-searx', 'searx-freedombox',
|
|
urls=['https://{host}/searx/'])
|
|
self.add(webserver)
|
|
|
|
webserver = SearxWebserverAuth('webserver-searx-auth',
|
|
'searx-freedombox-auth')
|
|
self.add(webserver)
|
|
|
|
uwsgi = Uwsgi('uwsgi-searx', 'searx')
|
|
self.add(uwsgi)
|
|
|
|
def set_shortcut_login_required(self, login_required):
|
|
"""Change the login_required property of shortcut."""
|
|
shortcut = self.remove('shortcut-searx')
|
|
shortcut.login_required = login_required
|
|
self.add(shortcut)
|
|
|
|
|
|
class SearxWebserverAuth(Webserver):
|
|
"""Component to handle Searx authentication webserver configuration."""
|
|
def is_enabled(self):
|
|
"""Return if configuration is enabled or public access is enabled."""
|
|
return is_public_access_enabled() or super().is_enabled()
|
|
|
|
def enable(self):
|
|
"""Enable apache configuration only if public access is disabled."""
|
|
if not is_public_access_enabled():
|
|
super().enable()
|
|
|
|
|
|
def init():
|
|
"""Initialize the module."""
|
|
global app
|
|
app = SearxApp()
|
|
register_group(group)
|
|
|
|
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, 'searx', ['setup'])
|
|
if not old_version or old_version < 3:
|
|
helper.call('post', actions.superuser_run, 'searx',
|
|
['disable-public-access'])
|
|
helper.call('post', app.enable)
|
|
app.set_shortcut_login_required(True)
|
|
|
|
|
|
def get_safe_search_setting():
|
|
"""Get the current value of the safe search setting for Searx."""
|
|
value = actions.superuser_run('searx', ['get-safe-search'])
|
|
return int(value.strip())
|
|
|
|
|
|
def is_public_access_enabled():
|
|
"""Check whether public access is enabled for Searx."""
|
|
return os.path.exists(PUBLIC_ACCESS_SETTING_FILE)
|
|
|
|
|
|
def enable_public_access():
|
|
"""Allow Searx app to be accessed by anyone with access."""
|
|
actions.superuser_run('searx', ['enable-public-access'])
|
|
app.get_component('webserver-searx-auth').disable()
|
|
app.set_shortcut_login_required(False)
|
|
|
|
|
|
def disable_public_access():
|
|
"""Allow Searx app to be accessed by logged-in users only."""
|
|
actions.superuser_run('searx', ['disable-public-access'])
|
|
app.get_component('webserver-searx-auth').enable()
|
|
app.set_shortcut_login_required(True)
|