mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-03-11 09:04:54 +00:00
8a7e70aab2
Fixes: #2563. Also see https://salsa.debian.org/freedombox-team/freedombox/-/merge_requests/2740 Test: - Functional tests for gitweb pass. - Without the patch, install gitweb and enable it. Restart FreedomBox service. The error message in #2563 is reproduced. With the patch, the error disappears. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
256 lines
8.8 KiB
Python
256 lines
8.8 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""FreedomBox app to configure Gitweb."""
|
|
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
from plinth import app as app_module
|
|
from plinth import frontpage, menu
|
|
from plinth.config import DropinConfigs
|
|
from plinth.modules.apache.components import Webserver
|
|
from plinth.modules.backups.components import BackupRestore
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.modules.users.components import UsersAndGroups
|
|
from plinth.package import Packages
|
|
|
|
from . import manifest, privileged
|
|
from .forms import is_repo_url
|
|
from .manifest import GIT_REPO_PATH
|
|
|
|
_description = [
|
|
_('Git is a distributed version-control system for tracking changes in '
|
|
'source code during software development. Gitweb provides a web '
|
|
'interface to Git repositories. You can browse history and content of '
|
|
'source code, use search to find relevant commits and code. '
|
|
'You can also clone repositories and upload code changes with a '
|
|
'command-line Git client or with multiple available graphical clients. '
|
|
'And you can share your code with people around the world.'),
|
|
_('To learn more on how to use Git visit '
|
|
'<a href="https://git-scm.com/docs/gittutorial">Git tutorial</a>.')
|
|
]
|
|
|
|
|
|
class GitwebApp(app_module.App):
|
|
"""FreedomBox app for Gitweb."""
|
|
|
|
app_id = 'gitweb'
|
|
|
|
_version = 4
|
|
|
|
def __init__(self) -> None:
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
groups = {'git-access': _('Read-write access to Git repositories')}
|
|
|
|
info = app_module.Info(app_id=self.app_id, version=self._version,
|
|
name=_('Gitweb'), icon_filename='gitweb',
|
|
description=_description, manual_page='GitWeb',
|
|
clients=manifest.clients, tags=manifest.tags)
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-gitweb', info.name, info.icon_filename,
|
|
info.tags, 'gitweb:index',
|
|
parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut('shortcut-gitweb', info.name,
|
|
icon=info.icon_filename, url='/gitweb/',
|
|
clients=info.clients, tags=info.tags,
|
|
login_required=True,
|
|
allowed_groups=list(groups))
|
|
self.add(shortcut)
|
|
|
|
packages = Packages('packages-gitweb', ['gitweb', 'highlight'])
|
|
self.add(packages)
|
|
|
|
dropin_configs = DropinConfigs('dropin-configs-gitweb', [
|
|
'/etc/gitweb-freedombox.conf',
|
|
'/etc/apache2/conf-available/gitweb-freedombox.conf',
|
|
'/etc/apache2/conf-available/gitweb-freedombox-auth.conf'
|
|
])
|
|
self.add(dropin_configs)
|
|
|
|
firewall = Firewall('firewall-gitweb', info.name,
|
|
ports=['http', 'https'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
webserver = Webserver('webserver-gitweb', 'gitweb-freedombox',
|
|
urls=['https://{host}/gitweb/'])
|
|
self.add(webserver)
|
|
|
|
self.auth_webserver = GitwebWebserverAuth('webserver-gitweb-auth',
|
|
'gitweb-freedombox-auth')
|
|
self.add(self.auth_webserver)
|
|
|
|
users_and_groups = UsersAndGroups('users-and-groups-gitweb',
|
|
groups=groups)
|
|
self.add(users_and_groups)
|
|
|
|
backup_restore = GitwebBackupRestore('backup-restore-gitweb',
|
|
**manifest.backup)
|
|
self.add(backup_restore)
|
|
|
|
def post_init(self):
|
|
"""Perform post initialization operations."""
|
|
if not self.needs_setup():
|
|
self.update_service_access()
|
|
|
|
def set_shortcut_login_required(self, login_required):
|
|
"""Change the login_required property of shortcut."""
|
|
self.get_component('shortcut-gitweb').login_required = login_required
|
|
|
|
def update_service_access(self):
|
|
"""Update the frontpage shortcut and webserver auth requirement."""
|
|
repos = get_repo_list()
|
|
if have_public_repos(repos):
|
|
self._enable_public_access()
|
|
else:
|
|
self._disable_public_access()
|
|
|
|
def _enable_public_access(self):
|
|
"""Allow Gitweb app to be accessed by anyone with access."""
|
|
if self.is_enabled():
|
|
self.auth_webserver.disable()
|
|
|
|
self.set_shortcut_login_required(False)
|
|
|
|
def _disable_public_access(self):
|
|
"""Allow Gitweb app to be accessed by logged-in users only."""
|
|
if self.is_enabled():
|
|
self.auth_webserver.enable()
|
|
|
|
self.set_shortcut_login_required(True)
|
|
|
|
def setup(self, old_version):
|
|
"""Install and configure the app."""
|
|
super().setup(old_version)
|
|
privileged.setup()
|
|
if not old_version:
|
|
self.enable()
|
|
|
|
def uninstall(self):
|
|
"""De-configure and uninstall the app."""
|
|
super().uninstall()
|
|
privileged.uninstall()
|
|
|
|
|
|
class GitwebWebserverAuth(Webserver):
|
|
"""Component to handle Gitweb authentication webserver configuration."""
|
|
|
|
is_leader = False
|
|
|
|
def enable(self):
|
|
"""Enable apache configuration only if no public repository exists."""
|
|
repos = get_repo_list()
|
|
if not have_public_repos(repos):
|
|
super().enable()
|
|
|
|
def set_enabled(self, enabled):
|
|
"""Update the internal enabled state of the component.
|
|
|
|
Actually do nothing. This method is called when is_leader = False to
|
|
notify the enabled/disabled state of the app. Enabled/disabled state of
|
|
this component is actually decided by the webserver configuration. It
|
|
is expected that is_enabled is not called on this component to
|
|
determine if app is enabled or not.
|
|
"""
|
|
pass
|
|
|
|
|
|
class GitwebBackupRestore(BackupRestore):
|
|
"""Component to handle backup/restore for Gitweb."""
|
|
|
|
def restore_post(self, packet):
|
|
"""Update access after restoration of backups."""
|
|
super().restore_post(packet)
|
|
self.app.update_service_access()
|
|
|
|
|
|
def have_public_repos(repos):
|
|
"""Check for public repositories."""
|
|
return any((repo['access'] == 'public' for repo in repos))
|
|
|
|
|
|
def create_repo(repo, repo_description, owner, is_private):
|
|
"""Create a new repository or clone a remote repository."""
|
|
kwargs = {
|
|
'url': None,
|
|
'name': None,
|
|
'description': repo_description,
|
|
'owner': owner,
|
|
'is_private': is_private
|
|
}
|
|
|
|
if is_repo_url(repo):
|
|
kwargs['url'] = repo
|
|
# create a repo directory and set correct access rights
|
|
privileged.create_repo(prepare_only=True, **kwargs)
|
|
# start cloning in background
|
|
privileged.create_repo(skip_prepare=True, _run_in_background=True,
|
|
**kwargs)
|
|
else:
|
|
kwargs['name'] = repo
|
|
privileged.create_repo(**kwargs)
|
|
|
|
|
|
def get_repo_list():
|
|
"""List all git repositories."""
|
|
repos = []
|
|
if GIT_REPO_PATH.exists():
|
|
for repo in GIT_REPO_PATH.iterdir():
|
|
if not repo.name.endswith('.git') or repo.name.startswith('.'):
|
|
continue
|
|
|
|
repo_info = {}
|
|
repo_info['name'] = repo.name[:-4]
|
|
|
|
private_file = repo / 'private'
|
|
if private_file.exists():
|
|
repo_info['access'] = 'private'
|
|
else:
|
|
repo_info['access'] = 'public'
|
|
|
|
progress_file = repo / 'clone_progress'
|
|
if progress_file.exists():
|
|
repo_info['clone_progress'] = progress_file.read_text()
|
|
|
|
repos.append(repo_info)
|
|
|
|
return sorted(repos, key=lambda repo: repo['name'])
|
|
|
|
|
|
def repo_info(repo):
|
|
"""Get information about repository."""
|
|
info = privileged.repo_info(repo)
|
|
if info['access'] == 'private':
|
|
info['is_private'] = True
|
|
else:
|
|
info['is_private'] = False
|
|
del info['access']
|
|
|
|
return info
|
|
|
|
|
|
def edit_repo(form_initial, form_cleaned):
|
|
"""Edit repository data."""
|
|
repo = form_initial['name']
|
|
|
|
if form_cleaned['name'] != repo:
|
|
privileged.rename_repo(repo, form_cleaned['name'])
|
|
repo = form_cleaned['name']
|
|
|
|
if form_cleaned['description'] != form_initial['description']:
|
|
privileged.set_repo_description(repo, form_cleaned['description'])
|
|
|
|
if form_cleaned['owner'] != form_initial['owner']:
|
|
privileged.set_repo_owner(repo, form_cleaned['owner'])
|
|
|
|
if form_cleaned['is_private'] != form_initial['is_private']:
|
|
if form_cleaned['is_private']:
|
|
privileged.set_repo_access(repo, 'private')
|
|
else:
|
|
privileged.set_repo_access(repo, 'public')
|
|
|
|
if form_cleaned['default_branch'] != form_initial['default_branch']:
|
|
privileged.set_default_branch(repo, form_cleaned['default_branch'])
|