mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
147 lines
4.5 KiB
Python
147 lines
4.5 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 Privoxy.
|
|
"""
|
|
|
|
from django.urls import reverse_lazy
|
|
from django.utils.translation import ugettext_lazy as _
|
|
|
|
from plinth import action_utils, actions
|
|
from plinth import app as app_module
|
|
from plinth import cfg, frontpage, menu
|
|
from plinth.daemon import Daemon
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.utils import format_lazy
|
|
from plinth.views import AppView
|
|
|
|
from .manifest import backup # noqa, pylint: disable=unused-import
|
|
|
|
version = 1
|
|
|
|
is_essential = False
|
|
|
|
managed_services = ['privoxy']
|
|
|
|
managed_packages = ['privoxy']
|
|
|
|
name = _('Privoxy')
|
|
|
|
short_description = _('Web Proxy')
|
|
|
|
description = [
|
|
_('Privoxy is a non-caching web proxy with advanced filtering '
|
|
'capabilities for enhancing privacy, modifying web page data and '
|
|
'HTTP headers, controlling access, and removing ads and other '
|
|
'obnoxious Internet junk. '),
|
|
format_lazy(
|
|
_('You can use Privoxy by modifying your browser proxy settings to '
|
|
'your {box_name} hostname (or IP address) with port 8118. '
|
|
'While using Privoxy, you can see its configuration details and '
|
|
'documentation at '
|
|
'<a href="http://config.privoxy.org">http://config.privoxy.org/</a> '
|
|
'or <a href="http://p.p">http://p.p</a>.'),
|
|
box_name=_(cfg.box_name)),
|
|
]
|
|
|
|
reserved_usernames = ['privoxy']
|
|
|
|
manual_page = 'Privoxy'
|
|
|
|
app = None
|
|
|
|
|
|
class PrivoxyApp(app_module.App):
|
|
"""FreedomBox app for Privoxy."""
|
|
|
|
app_id = 'privoxy'
|
|
|
|
def __init__(self):
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
menu_item = menu.Menu('menu-privoxy', name, short_description,
|
|
'privoxy', 'privoxy:index',
|
|
parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut(
|
|
'shortcut-privoxy', name, short_description=short_description,
|
|
icon='privoxy', description=description,
|
|
configure_url=reverse_lazy('privoxy:index'), login_required=True)
|
|
self.add(shortcut)
|
|
|
|
firewall = Firewall('firewall-privoxy', name, ports=['privoxy'],
|
|
is_external=False)
|
|
self.add(firewall)
|
|
|
|
daemon = Daemon('daemon-privoxy', managed_services[0])
|
|
self.add(daemon)
|
|
|
|
|
|
def init():
|
|
"""Initialize the module."""
|
|
global app
|
|
app = PrivoxyApp()
|
|
|
|
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.call('pre', actions.superuser_run, 'privoxy', ['pre-install'])
|
|
helper.install(managed_packages)
|
|
helper.call('post', app.enable)
|
|
|
|
|
|
class PrivoxyAppView(AppView):
|
|
app_id = 'privoxy'
|
|
diagnostics_module_name = 'privoxy'
|
|
name = name
|
|
description = description
|
|
manual_page = manual_page
|
|
|
|
|
|
def diagnose():
|
|
"""Run diagnostics and return the results."""
|
|
results = []
|
|
|
|
results.append(action_utils.diagnose_port_listening(8118, 'tcp4'))
|
|
results.append(action_utils.diagnose_port_listening(8118, 'tcp6'))
|
|
results.append(action_utils.diagnose_url('https://www.debian.org'))
|
|
results.extend(diagnose_url_with_proxy())
|
|
|
|
return results
|
|
|
|
|
|
def diagnose_url_with_proxy():
|
|
"""Run a diagnostic on a URL with a proxy."""
|
|
url = 'https://debian.org/' # Gives a simple redirect to www.
|
|
|
|
results = []
|
|
for address in action_utils.get_addresses():
|
|
proxy = 'http://{host}:8118/'.format(host=address['url_address'])
|
|
env = {'https_proxy': proxy}
|
|
|
|
result = action_utils.diagnose_url(url, kind=address['kind'], env=env)
|
|
result[0] = _('Access {url} with proxy {proxy} on tcp{kind}') \
|
|
.format(url=url, proxy=proxy, kind=address['kind'])
|
|
results.append(result)
|
|
|
|
return results
|