# # 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 . # """ FreedomBox app for Minetest server. """ import augeas from django.urls import reverse_lazy from django.utils.translation import ugettext_lazy as _ from plinth import action_utils 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 .manifest import backup, clients # noqa, pylint: disable=unused-import version = 2 managed_services = ['minetest-server'] mods = [ '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-player-3d-armor', 'minetest-mod-protector', 'minetest-mod-quartz', 'minetest-mod-skyblock', 'minetest-mod-throwing', 'minetest-mod-unified-inventory', 'minetest-mod-unifieddyes', 'minetest-mod-worldedit' ] managed_packages = ['minetest-server'] + mods name = _('Minetest') icon_filename = 'minetest' short_description = _('Block Sandbox') 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)), ] clients = clients manual_page = 'Minetest' port_forwarding_info = [('UDP', 30000)] reserved_usernames = ['Debian-minetest'] CONFIG_FILE = '/etc/minetest/minetest.conf' AUG_PATH = '/files' + CONFIG_FILE + '/.anon' app = None class MinetestApp(app_module.App): """FreedomBox app for Minetest.""" app_id = 'minetest' def __init__(self): """Create components for the app.""" super().__init__() menu_item = menu.Menu('menu-minetest', name, short_description, 'minetest', 'minetest:index', parent_url_name='apps') self.add(menu_item) shortcut = frontpage.Shortcut( 'shortcut-minetest', name, short_description=short_description, icon=icon_filename, description=description, configure_url=reverse_lazy('minetest:index'), clients=clients, login_required=False) self.add(shortcut) firewall = Firewall('firewall-minetest', name, ports=['minetest-plinth'], is_external=True) self.add(firewall) daemon = Daemon('daemon-minetest', managed_services[0]) self.add(daemon) def init(): """Initialize the module.""" global app app = MinetestApp() 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', app.enable) def diagnose(): """Run diagnostics and return the results.""" results = [] results.append(action_utils.diagnose_port_listening(30000, 'udp4')) return results 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