Sunil Mohan Adapa 75f6abac1e
*: Make setup method part of App class for all apps
- Primary purpose is to complete the App API and allow for multiple apps to be
present in a module without a single clashing setup() method. Secondary
objective is to get rid of SetupHelper instance simple use App instance instead.

- This brings us closer to not needing to implement setup() method for some of
the typical apps.

- Remove default value None for old_version parameter.

  - A valid integer value is always passed to this call.

  - The value of None is undefined.

  - Simplifies the App API slightly.

- Drop setting 'pre', 'post' values to indicate the stage of setup for the App.

  - Simplifies the setup methods significantly. Eliminates a class of
  bugs (some of them seen earlier).

  - The UI can show a simple 'installing...' or progress spinner instead of
  individual stages.

  - There are currently many inconsistencies where many operations are not
  wrapped in helper.call() calls.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2022-08-15 10:36:16 -04:00

151 lines
4.9 KiB
Python

# 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
from plinth.utils import format_lazy
from . import manifest
_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 <a href="http://www.minetest.net/downloads/">Minetest client</a> '
'is needed.'), box_name=_(cfg.box_name)),
]
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'
_version = 2
def __init__(self):
"""Create components for the app."""
super().__init__()
info = app_module.Info(
app_id=self.app_id, version=self._version, name=_('Minetest'),
icon_filename='minetest', short_description=_('Block Sandbox'),
description=_description, manual_page='Minetest',
clients=manifest.clients,
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)
self.enable()
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