# SPDX-License-Identifier: AGPL-3.0-or-later """FreedomBox app for Minetest server.""" import augeas from django.urls import reverse_lazy from django.utils.translation import gettext_lazy as _ from plinth import app as app_module from plinth import cfg, frontpage, menu from plinth.daemon import Daemon 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 Package, Packages, install from plinth.utils import Version, format_lazy from . import manifest, privileged _mods = [ Package('minetest-mod-3d-armor') | Package('minetest-mod-player-3d-armor'), 'minetest-mod-character-creator', 'minetest-mod-craftguide', 'minetest-mod-infinite-chest', 'minetest-mod-lucky-block', 'minetest-mod-maidroid', 'minetest-mod-mesecons', 'minetest-mod-moreblocks', 'minetest-mod-moreores', 'minetest-mod-nether', 'minetest-mod-pipeworks', 'minetest-mod-protector', 'minetest-mod-quartz', 'minetest-mod-skyblock', 'minetest-mod-throwing', 'minetest-mod-unified-inventory', 'minetest-mod-unifieddyes', 'minetest-mod-worldedit' ] _description = [ format_lazy( _('Minetest is a multiplayer infinite-world block sandbox. This ' 'module enables the Minetest server to be run on this ' '{box_name}, on the default port (30000). To connect to the server, ' 'a Minetest client ' 'is needed.'), box_name=_(cfg.box_name)), ] CONFIG_FILE = '/etc/minetest/minetest.conf' AUG_PATH = '/files' + CONFIG_FILE + '/.anon' class MinetestApp(app_module.App): """FreedomBox app for Minetest.""" app_id = 'minetest' _version = 2 def __init__(self) -> None: """Create components for the app.""" super().__init__() info = app_module.Info( app_id=self.app_id, version=self._version, name=_('Minetest'), icon_filename='minetest', description=_description, manual_page='Minetest', clients=manifest.clients, tags=manifest.tags, donation_url='https://www.minetest.net/get-involved/#donate') self.add(info) menu_item = menu.Menu('menu-minetest', info.name, info.short_description, info.icon_filename, 'minetest:index', parent_url_name='apps') self.add(menu_item) shortcut = frontpage.Shortcut( 'shortcut-minetest', info.name, short_description=info.short_description, icon=info.icon_filename, description=info.description, manual_page=info.manual_page, configure_url=reverse_lazy('minetest:index'), clients=info.clients, login_required=False) self.add(shortcut) packages = Packages('packages-minetest', ['minetest-server'] + _mods) self.add(packages) firewall = Firewall('firewall-minetest', info.name, ports=['minetest-plinth'], is_external=True) self.add(firewall) daemon = Daemon('daemon-minetest', 'minetest-server', listen_ports=[(30000, 'udp4')]) self.add(daemon) users_and_groups = UsersAndGroups( 'users-and-groups-minetest', reserved_usernames=['Debian-minetest']) self.add(users_and_groups) backup_restore = BackupRestore('backup-restore-minetest', **manifest.backup) self.add(backup_restore) def setup(self, old_version): """Install and configure the app.""" super().setup(old_version) if not old_version: self.enable() def force_upgrade(self, packages): """Force upgrade minetest to resolve conffile prompt.""" if 'minetest-server' not in packages: return False # Allow upgrade from 5.3.0 to 5.6.1 package = packages['minetest-server'] if Version(package['new_version']) > Version('5.7~'): return False config = get_configuration() install(['minetest-server'], force_configuration='new') privileged.configure(**config) return True def load_augeas(): """Initialize Augeas.""" aug = augeas.Augeas(flags=augeas.Augeas.NO_LOAD + augeas.Augeas.NO_MODL_AUTOLOAD) aug.set('/augeas/load/Php/lens', 'Php.lns') aug.set('/augeas/load/Php/incl[last() + 1]', CONFIG_FILE) aug.load() return aug def get_max_players(aug): """Return the maximum players allowed on the server at one time.""" value = aug.get(AUG_PATH + '/max_users') if value: return int(value) def is_creative_mode_enabled(aug): """Return whether creative mode is enabled.""" value = aug.get(AUG_PATH + '/creative_mode') return value == 'true' def is_pvp_enabled(aug): """Return whether PVP is enabled.""" value = aug.get(AUG_PATH + '/enable_pvp') return value == 'true' def is_damage_enabled(aug): """Return whether damage is enabled.""" value = aug.get(AUG_PATH + '/enable_damage') return value == 'true' def get_configuration(): """Return the current configuration.""" aug = load_augeas() conf = { 'max_players': get_max_players(aug), 'creative_mode': is_creative_mode_enabled(aug), 'enable_pvp': is_pvp_enabled(aug), 'enable_damage': is_damage_enabled(aug), } return conf