From 8e63c98fa2f2c807afbd277f962897fad4c962d8 Mon Sep 17 00:00:00 2001 From: Rafi59 Date: Sun, 21 Apr 2019 15:32:30 +0200 Subject: [PATCH 01/29] Complete rework --- README.md | 86 +++- check_process | 71 +++ conf/app.src | 6 + conf/minetest-preferences | 3 - conf/minetest.conf | 10 +- conf/minetest.list | 1 - conf/systemd.service | 12 + manifest.json | 33 +- scripts/_common.sh | 938 ++++++-------------------------------- scripts/backup | 93 ++-- scripts/install | 320 +++++++++---- scripts/remove | 97 +++- scripts/restore | 150 +++--- 13 files changed, 808 insertions(+), 1012 deletions(-) create mode 100644 check_process create mode 100644 conf/app.src delete mode 100644 conf/minetest-preferences delete mode 100644 conf/minetest.list create mode 100644 conf/systemd.service diff --git a/README.md b/README.md index e98baf2..8db1957 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,84 @@ # Minetest app for YunoHost -- [Yunohost project](https://yunohost.org) -- [Minetest website](http://www.minetest.net/) +[![Integration level](https://dash.yunohost.org/integration/minetest.svg)](https://dash.yunohost.org/appci/app/minetest) +[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=minetest) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allow you to install Minetest quickly and simply on a YunoHost server. +If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* + +## Overview +Quick description of this app. + +**Shipped version:** 5.0.1 + +## Screenshots + +![](https://www.minetest.net/media/gallery/1.jpg) + +## Demo + +No demo but you can test with servers in https://servers.minetest.net/ + +## Configuration + +How to configure this app: by SSH + +## Documentation + + * Official documentation: https://wiki.minetest.net/ + * YunoHost documentation: https://yunohost.org/#/minetest + +## YunoHost specific features + +#### Multi-users support + +Are LDAP and HTTP auth supported? No +Can the app be used by multiple users? Yes + +#### Supported architectures + +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/minetest%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/minetest/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/minetest%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/minetest/) +* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/minetest%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/minetest/) + +## Limitations + +* This app is not compatible with LDAP. + +## Additional information + +* Migration from old package +You can't migrate directly with an update. + * Before installing the new package you need to download this folder from your server `/var/games/minetest-server/.minetest/worlds/world` (this folder contains all world data) + * Uninstall the old package `sudo yunohost app remove minetest` + * Install the new one `sudo yunohost app install https://github.com/YunoHost-Apps/minetest_ynh` + * Stop Minetest service `sudo systemctl stop minetest` + * Copy the folder you have copied before in `/home/yunohost.app/minetest/.minetest/worlds` + * Start the Minetest service `sudo systemctl start minetest` + +**More information on the documentation page:** +https://yunohost.org/packaging_apps + +## Links + + * Report a bug: https://github.com/YunoHost-Apps/minetest_ynh/issues + * App website: https://minetest.net/ + * YunoHost website: https://yunohost.org/ + +--- + +Developers info +---------------- + +**Only if you want to use a testing branch for coding, instead of merging directly into master.** +Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/minetest_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/minetest_ynh/tree/testing --debug +or +sudo yunohost app upgrade minetest -u https://github.com/YunoHost-Apps/minetest_ynh/tree/testing --debug +``` -![alt text](http://www.minetest.net/media/icon.svg "Minetest logo") Minetest -=== -Minetest is a free, open source voxel game engine and game. Fully extendable. You are in control. diff --git a/check_process b/check_process new file mode 100644 index 0000000..5002df8 --- /dev/null +++ b/check_process @@ -0,0 +1,71 @@ +# See here for more information +# https://github.com/YunoHost/package_check#syntax-check_process-file + +# Move this file from check_process.default to check_process when you have filled it. + +;; Test complet sans postgresql + ; Manifest + domain="domain.tld" (DOMAIN) + postgresql=0 + pvp=1 + servername="packagecheck" + creative=0 + damage=1 + is_public=0 (PUBLIC|public=1|private=0) + password="pass" + port="30000" (PORT) + ; Checks + pkg_linter=1 + setup_sub_dir=0 + setup_root=0 + setup_nourl=1 + setup_private=0 + setup_public=0 + upgrade=1 + backup_restore=1 + multi_instance=0 + incorrect_path=0 + port_already_use=1 + change_url=1 + +;; Test complet avec postgresql + ; Manifest + domain="domain.tld" (DOMAIN) + postgresql=1 + pvp=1 + servername="packagecheck" + creative=0 + damage=1 + is_public=0 (PUBLIC|public=1|private=0) + password="pass" + port="30000" (PORT) + ; Checks + pkg_linter=1 + setup_sub_dir=0 + setup_root=0 + setup_nourl=1 + setup_private=0 + setup_public=0 + upgrade=1 + backup_restore=1 + multi_instance=0 + incorrect_path=0 + port_already_use=1 + change_url=1 + +;;; Levels + Level 1=auto + Level 2=auto + Level 3=auto +# Level 4: If the app supports LDAP and SSOwat, turn level 4 to '1' and add a link to an issue or a part of your code to show it. +# If the app does not use LDAP nor SSOwat, and can't use them, turn level 4 to 'na' and explain as well. + Level 4=0 + Level 5=auto + Level 6=auto + Level 7=auto + Level 8=0 + Level 9=0 + Level 10=0 +;;; Options +Email= +Notification=none diff --git a/conf/app.src b/conf/app.src new file mode 100644 index 0000000..400dd84 --- /dev/null +++ b/conf/app.src @@ -0,0 +1,6 @@ +SOURCE_URL=https://github.com/minetest/minetest/archive/5.0.1.tar.gz +SOURCE_SUM=aa771cf178ad1b436d5723e5d6dd24e42b5d56f1cfe9c930f6426b7f24bb1635 +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=tar.gz +SOURCE_IN_SUBDIR=true +SOURCE_FILENAME=minetest diff --git a/conf/minetest-preferences b/conf/minetest-preferences deleted file mode 100644 index dadcf06..0000000 --- a/conf/minetest-preferences +++ /dev/null @@ -1,3 +0,0 @@ -Package: minetest-server minetest-data -Pin: release a=__CODENAME__-backports -Pin-Priority: 900 diff --git a/conf/minetest.conf b/conf/minetest.conf index e19a68c..2db8b34 100644 --- a/conf/minetest.conf +++ b/conf/minetest.conf @@ -11,13 +11,13 @@ port = __PORT__ #bind_address = 123.123.123.123 # Name of server -server_name = My Minetest server +server_name = __SERVERNAME__ # Description of server -server_description = Minetest server powered by Debian and YuNoHost +server_description = Set a description in minetest.conf # Domain name of server -#server_address = __DOMAIN__ +server_address = __DOMAIN__ # Homepage of server #server_url = http://example.com @@ -33,7 +33,7 @@ server_announce = __ANNOUNCE__ # restricted to IPv6 clients, depending on system configuration. # Ignored if bind_address is set. # type: bool -# ipv6_server = false +ipv6_server = true serverlist_url = servers.minetest.net @@ -41,7 +41,7 @@ serverlist_url = servers.minetest.net default_game = minetest # World directory (everything in the world is stored here) -#map-dir = /var/games/minetest-server/.minetest/worlds/world +map-dir = /home/yunohost.app/minetest/.minetest/worlds/world # Message of the Day motd = Welcome to Minetest. Enjoy your stay! diff --git a/conf/minetest.list b/conf/minetest.list deleted file mode 100644 index 73dfaf0..0000000 --- a/conf/minetest.list +++ /dev/null @@ -1 +0,0 @@ -deb http://http.debian.net/debian __CODENAME__-backports main diff --git a/conf/systemd.service b/conf/systemd.service new file mode 100644 index 0000000..7d2d9b8 --- /dev/null +++ b/conf/systemd.service @@ -0,0 +1,12 @@ +[Unit] +Description=Minetest multiplayer server minetest.conf server config +Documentation=man:minetestserver(6) +After=network.target +RequiresMountsFor=/home/yunohost.app/minetest +[Service] +Restart=on-failure +User=minetest +Group=minetest +ExecStart=/opt/yunohost/minetest/bin/minetestserver --config /home/yunohost.app/minetest/.minetest/minetest.conf --logfile /var/log/minetest/minetest.log +[Install] +WantedBy=multi-user.target diff --git a/manifest.json b/manifest.json index 2ebfe95..f2acc17 100644 --- a/manifest.json +++ b/manifest.json @@ -10,14 +10,19 @@ "url": "http://www.minetest.net/", "license": "MIT", "maintainer": { - "name": "Luc Didry", - "email": "luc@framasoft.org", - "url": "https://framasoft.org" + "name": "rafi59", + "email": "rafi59_dev@srvmaison.fr.nf", + "url": "" }, + "previous_maintainers": { + "name": "Luc Didry", + "email": "luc@framasoft.org", + "url": "https://framasoft.org" +}, "requirements": { - "yunohost": ">> 2.6.4" + "yunohost": ">= 3.5" }, - "multi_instance": true, + "multi_instance": false, "services": [ "minetest" ], @@ -41,6 +46,24 @@ }, "default": false }, + { + "name": "postgresql", + "type": "boolean", + "ask": { + "en": "Do you want to use PostgreSQL? (more powerful but uses more disk space)", + "fr": "Est-ce que vous voulez utiliser PostgreSQL ? (plus puissant mais utilise plus d'espace disque)" + }, + "default": true + }, + { + "name": "servername", + "type": "string", + "ask": { + "en": "Choose a name for your server", + "fr": "Choissisez un nom pour votre serveur" + }, + "default": "Minetest server" + }, { "name": "pvp", "type": "boolean", diff --git a/scripts/_common.sh b/scripts/_common.sh index 266a076..48dd698 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,850 +1,180 @@ + #!/bin/bash #================================================= -#================================================= -# TESTING -#================================================= +# COMMON VARIABLES #================================================= -ynh_fpm_config () { - finalphpconf="/etc/php5/fpm/pool.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalphpconf" 1 - sudo cp ../conf/php-fpm.conf "$finalphpconf" - ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf" - ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf" - ynh_replace_string "__USER__" "$app" "$finalphpconf" - sudo chown root: "$finalphpconf" - ynh_store_file_checksum "$finalphpconf" +# dependencies used by the app +pkg_dependencies="build-essential libirrlicht-dev cmake libbz2-dev libpng-dev libjpeg-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev zlib1g-dev libgmp-dev libjsoncpp-dev libluajit-5.1-dev" - if [ -e "../conf/php-fpm.ini" ] +#================================================= +# PERSONAL HELPERS +#================================================= + +#================================================= +# EXPERIMENTAL HELPERS +#================================================= + +#================================================= +# +# POSTGRES HELPERS +# +# Point of contact : Jean-Baptiste Holcroft +#================================================= + +# Create a master password and set up global settings +# Please always call this script in install and restore scripts +# +# usage: ynh_psql_test_if_first_run + +ynh_psql_test_if_first_run() { + if [ -f /etc/yunohost/psql ]; then - finalphpini="/etc/php5/fpm/conf.d/20-$app.ini" - ynh_backup_if_checksum_is_different "$finalphpini" 1 - sudo cp ../conf/php-fpm.ini "$finalphpini" - sudo chown root: "$finalphpini" - ynh_store_file_checksum "$finalphpini" - fi - - sudo systemctl reload php5-fpm -} - -ynh_remove_fpm_config () { - ynh_secure_remove "/etc/php5/fpm/pool.d/$app.conf" - ynh_secure_remove "/etc/php5/fpm/conf.d/20-$app.ini" - sudo systemctl reload php5-fpm -} - -ynh_nginx_config () { - finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalnginxconf" 1 - sudo cp ../conf/nginx.conf "$finalnginxconf" - - # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. - # Substitute in a nginx config file only if the variable is not empty - if test -n "${path_url:-}"; then - ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf" - fi - if test -n "${domain:-}"; then - ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf" - fi - if test -n "${port:-}"; then - ynh_replace_string "__PORT__" "$port" "$finalnginxconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__NAME__" "$app" "$finalnginxconf" - fi - if test -n "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf" - fi - ynh_store_file_checksum "$finalnginxconf" - - sudo systemctl reload nginx -} - -ynh_remove_nginx_config () { - ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf" - sudo systemctl reload nginx -} - -ynh_systemd_config () { - finalsystemdconf="/etc/systemd/system/$app.service" - ynh_backup_if_checksum_is_different "$finalsystemdconf" 1 - sudo cp ../conf/systemd.service "$finalsystemdconf" - - # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. - # Substitute in a nginx config file only if the variable is not empty - if test -n "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalsystemdconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__APP__" "$app" "$finalsystemdconf" - fi - ynh_store_file_checksum "$finalsystemdconf" - - sudo chown root: "$finalsystemdconf" - sudo systemctl enable $app - sudo systemctl daemon-reload -} - -ynh_remove_systemd_config () { - finalsystemdconf="/etc/systemd/system/$app.service" - if [ -e "$finalsystemdconf" ]; then - sudo systemctl stop $app - sudo systemctl disable $app - ynh_secure_remove "$finalsystemdconf" - fi -} - -#================================================= -#================================================= - -#================================================= -# CHECKING -#================================================= - -CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine. - if sudo yunohost app --help | grep --quiet url-available - then - # Check availability of a web path - ynh_webpath_available $domain $path_url - # Register/book a web path for an app - ynh_webpath_register $app $domain $path_url + echo "PostgreSQL is already installed, no need to create master password" else - # Use the legacy command - sudo yunohost app checkurl $domain$path_url -a $app - fi -} + pgsql=$(ynh_string_random) + pg_hba="" + echo "$pgsql" >> /etc/yunohost/psql -CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà utilisé. - final_path=/var/www/$app - test ! -e "$final_path" || ynh_die "This path already contains a folder" -} - -#================================================= -# DISPLAYING -#================================================= - -NO_PRINT () { # Supprime l'affichage dans stdout pour la commande en argument. - set +x - $@ - set -x -} - -WARNING () { # Écrit sur le canal d'erreur pour passer en warning. - $@ >&2 -} - -SUPPRESS_WARNING () { # Force l'écriture sur la sortie standard - $@ 2>&1 -} - -QUIET () { # Redirige la sortie standard dans /dev/null - $@ > /dev/null -} - -ALL_QUIET () { # Redirige la sortie standard et d'erreur dans /dev/null - $@ > /dev/null 2>&1 -} - -#================================================= -# BACKUP -#================================================= - -BACKUP_FAIL_UPGRADE () { - WARNING echo "Upgrade failed." - app_bck=${app//_/-} # Replace all '_' by '-' - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$backup_number; then # Vérifie l'existence de l'archive avant de supprimer l'application et de restaurer - sudo yunohost app remove $app # Supprime l'application avant de la restaurer. - sudo yunohost backup restore --ignore-hooks $app_bck-pre-upgrade$backup_number --apps $app --force # Restore the backup if upgrade failed - ynh_die "The app was restored to the way it was before the failed upgrade." - fi -} - -BACKUP_BEFORE_UPGRADE () { # Backup the current version of the app, restore it if the upgrade fails - backup_number=1 - old_backup_number=2 - app_bck=${app//_/-} # Replace all '_' by '-' - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade1; then # Vérifie l'existence d'une archive déjà numéroté à 1. - backup_number=2 # Et passe le numéro de l'archive à 2 - old_backup_number=1 - fi - - sudo yunohost backup create --ignore-hooks --apps $app --name $app_bck-pre-upgrade$backup_number # Créer un backup différent de celui existant. - if [ "$?" -eq 0 ]; then # Si le backup est un succès, supprime l'archive précédente. - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$old_backup_number; then # Vérifie l'existence de l'ancienne archive avant de la supprimer, pour éviter une erreur. - QUIET sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number + if [ -e /etc/postgresql/9.4/ ] + then + pg_hba=/etc/postgresql/9.4/main/pg_hba.conf + elif [ -e /etc/postgresql/9.6/ ] + then + pg_hba=/etc/postgresql/9.6/main/pg_hba.conf + else + ynh_die "postgresql shoud be 9.4 or 9.6" fi - else # Si le backup a échoué - ynh_die "Backup failed, the upgrade process was aborted." + + systemctl start postgresql + sudo --login --user=postgres psql -c"ALTER user postgres WITH PASSWORD '$pgsql'" postgres + + # force all user to connect to local database using passwords + # https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html#EXAMPLE-PG-HBA.CONF + # Note: we can't use peer since YunoHost create users with nologin + # See: https://github.com/YunoHost/yunohost/blob/unstable/data/helpers.d/user + sed -i '/local\s*all\s*all\s*peer/i \ + local all all password' "$pg_hba" + systemctl enable postgresql + systemctl reload postgresql fi } -HUMAN_SIZE () { # Transforme une taille en Ko en une taille lisible pour un humain - human=$(numfmt --to=iec --from-unit=1K $1) - echo $human -} - -CHECK_SIZE () { # Vérifie avant chaque backup que l'espace est suffisant - file_to_analyse=$1 - backup_size=$(sudo du --summarize "$file_to_analyse" | cut -f1) - free_space=$(sudo df --output=avail "/home/yunohost.backup" | sed 1d) - - if [ $free_space -le $backup_size ] - then - WARNING echo "Espace insuffisant pour sauvegarder $file_to_analyse." - WARNING echo "Espace disponible: $(HUMAN_SIZE $free_space)" - ynh_die "Espace nécessaire: $(HUMAN_SIZE $backup_size)" - fi -} - -# Ce helper est temporaire et sert de remplacement à la véritable fonction ynh_restore_file. Le temps qu'elle arrive... -ynh_restore_file () { - if [ -f "$1" ]; then - ynh_die "There is already a file at this path: $1" - fi - sudo cp -a "${YNH_APP_BACKUP_DIR}$1" "$1" -} - -#================================================= -# PACKAGE CHECK BYPASSING... -#================================================= - -IS_PACKAGE_CHECK () { # Détermine une exécution en conteneur (Non testé) - return $(uname -n | grep -c 'pchecker_lxc') -} - -#================================================= -# NODEJS -#================================================= - -sudo_path () { - sudo env "PATH=$PATH" $@ -} - -# INFOS -# n (Node version management) utilise la variable PATH pour stocker le path de la version de node à utiliser. -# C'est ainsi qu'il change de version -# En attendant une généralisation de root, il est possible d'utiliser sudo avec le helper temporaire sudo_path -# Il permet d'utiliser sudo en gardant le $PATH modifié -# ynh_install_nodejs installe la version de nodejs demandée en argument, avec n -# ynh_use_nodejs active une version de nodejs dans le script courant -# 3 variables sont mises à disposition, et 2 sont stockées dans la config de l'app -# - nodejs_path: Le chemin absolu de cette version de node -# Utilisé pour des appels directs à node. -# - nodejs_version: Simplement le numéro de version de nodejs pour cette application -# - nodejs_use_version: Un alias pour charger une version de node dans le shell courant. -# Utilisé pour démarrer un service ou un script qui utilise node ou npm -# Dans ce cas, c'est $PATH qui contient le chemin de la version de node. Il doit être propagé sur les autres shell si nécessaire. - -n_install_dir="/opt/node_n" -ynh_use_nodejs () { - nodejs_version=$(ynh_app_setting_get $app nodejs_version) - - load_n_path="[[ :$PATH: == *\":$n_install_dir/bin:\"* ]] || PATH+=\":$n_install_dir/bin\"" - - nodejs_use_version="n $nodejs_version" - - # "Load" a version of node - eval $load_n_path; $nodejs_use_version - eval $load_n_path; sudo env "PATH=$PATH" $nodejs_use_version - - # Get the absolute path of this version of node - nodejs_path="$(n bin $nodejs_version)" - - # Make an alias for node use - ynh_node_exec="eval $load_n_path; n use $nodejs_version" - sudo_ynh_node_exec="eval $load_n_path; sudo env \"PATH=$PATH\" n use $nodejs_version" -} - -ynh_install_nodejs () { - # Use n, https://github.com/tj/n to manage the nodejs versions - local nodejs_version="$1" - local n_install_script="https://git.io/n-install" - - # Create $n_install_dir - sudo mkdir -p "$n_install_dir" - - # Load n path in PATH - PATH+=":$n_install_dir/bin" - - # If n is not previously setup, install it - n --version > /dev/null 2>&1 || \ - ( echo "Installation of N - Node.js version management" >&2; \ - curl -sL $n_install_script | sudo N_PREFIX="$n_install_dir" bash -s -- -y $nodejs_version ) - - # Install the requested version of nodejs (except for the first installation of n, which installed the requested version of node.) - sudo env "PATH=$PATH" n $nodejs_version - - # Use the real installed version. Sometimes slightly different - nodejs_version=$(node --version | cut -c2-) - - # Store the ID of this app and the version of node requested for it - echo "$YNH_APP_ID:$nodejs_version" | sudo tee --append "$n_install_dir/ynh_app_version" - - # Store nodejs_version into the config of this app - ynh_app_setting_set $app nodejs_version $nodejs_version - - ynh_use_nodejs -} - -ynh_remove_nodejs () { - ynh_use_nodejs - - # Remove the line for this app - sudo sed --in-place "/$YNH_APP_ID:$nodejs_version/d" "$n_install_dir/ynh_app_version" - - # If none another app uses this version of nodejs, remove it. - if ! grep --quiet "$nodejs_version" "$n_install_dir/ynh_app_version" - then - n rm $nodejs_version - fi - - # If none another app uses n, remove n - if [ ! -s "$n_install_dir/ynh_app_version" ] - then - ynh_secure_remove "$n_install_dir" - sudo sed --in-place "/N_PREFIX/d" /root/.bashrc - fi -} - -#================================================= -#================================================= -# FUTUR YNH HELPERS -#================================================= -# Importer ce fichier de fonction avant celui des helpers officiel -# Ainsi, les officiels prendront le pas sur ceux-ci le cas échéant -#================================================= - -# Normalize the url path syntax -# Handle the slash at the beginning of path and its absence at ending -# Return a normalized url path +# Open a connection as a user # -# example: url_path=$(ynh_normalize_url_path $url_path) -# ynh_normalize_url_path example -> /example -# ynh_normalize_url_path /example -> /example -# ynh_normalize_url_path /example/ -> /example -# ynh_normalize_url_path / -> / +# example: ynh_psql_connect_as 'user' 'pass' <<< "UPDATE ...;" +# example: ynh_psql_connect_as 'user' 'pass' < /path/to/file.sql # -# usage: ynh_normalize_url_path path_to_normalize -# | arg: url_path_to_normalize - URL path to normalize before using it -ynh_normalize_url_path () { - path_url=$1 - test -n "$path_url" || ynh_die "ynh_normalize_url_path expect a URL path as first argument and received nothing." - if [ "${path_url:0:1}" != "/" ]; then # If the first character is not a / - path_url="/$path_url" # Add / at begin of path variable - fi - if [ "${path_url:${#path_url}-1}" == "/" ] && [ ${#path_url} -gt 1 ]; then # If the last character is a / and that not the only character. - path_url="${path_url:0:${#path_url}-1}" # Delete the last character - fi - echo $path_url +# usage: ynh_psql_connect_as user pwd [db] +# | arg: user - the user name to connect as +# | arg: pwd - the user password +# | arg: db - the database to connect to +ynh_psql_connect_as() { + user="$1" + pwd="$2" + db="$3" + sudo --login --user=postgres PGUSER="$user" PGPASSWORD="$pwd" psql "$db" } -# Check if a mysql user exists +# # Execute a command as root user # -# usage: ynh_mysql_user_exists user -# | arg: user - the user for which to check existence -function ynh_mysql_user_exists() -{ - local user=$1 - if [[ -z $(ynh_mysql_execute_as_root "SELECT User from mysql.user WHERE User = '$user';") ]] - then - return 1 - else - return 0 - fi +# usage: ynh_psql_execute_as_root sql [db] +# | arg: sql - the SQL command to execute +# | arg: db - the database to connect to +ynh_psql_execute_as_root () { + sql="$1" + sudo --login --user=postgres psql <<< "$sql" +} + +# Execute a command from a file as root user +# +# usage: ynh_psql_execute_file_as_root file [db] +# | arg: file - the file containing SQL commands +# | arg: db - the database to connect to +ynh_psql_execute_file_as_root() { + file="$1" + db="$2" + sudo --login --user=postgres psql "$db" < "$file" } # Create a database, an user and its password. Then store the password in the app's config # # After executing this helper, the password of the created database will be available in $db_pwd -# It will also be stored as "mysqlpwd" into the app settings. +# It will also be stored as "psqlpwd" into the app settings. # -# usage: ynh_mysql_setup_db user name [pwd] +# usage: ynh_psql_setup_db user name [pwd] # | arg: user - Owner of the database # | arg: name - Name of the database # | arg: pwd - Password of the database. If not given, a password will be generated -ynh_mysql_setup_db () { - local db_user="$1" - local db_name="$2" - local new_db_pwd=$(ynh_string_random) # Generate a random password +ynh_psql_setup_db () { + db_user="$1" + db_name="$2" + new_db_pwd=$(ynh_string_random) # Generate a random password + # If $3 is not given, use new_db_pwd instead for db_pwd. db_pwd="${3:-$new_db_pwd}" - ynh_mysql_create_db "$db_name" "$db_user" "$db_pwd" # Create the database - ynh_app_setting_set $app mysqlpwd $db_pwd # Store the password in the app's config + ynh_psql_create_db "$db_name" "$db_user" "$db_pwd" # Create the database + ynh_app_setting_set "$app" psqlpwd "$db_pwd" # Store the password in the app's config } -# Remove a database if it exists, and the associated user +# Create a database and grant privilegies to a user # -# usage: ynh_mysql_remove_db user name -# | arg: user - Owner of the database -# | arg: name - Name of the database -ynh_mysql_remove_db () { - local db_user="$1" - local db_name="$2" - local mysql_root_password=$(sudo cat $MYSQL_ROOT_PWD_FILE) - if mysqlshow -u root -p$mysql_root_password | grep -q "^| $db_name"; then # Check if the database exists - echo "Removing database $db_name" >&2 - ynh_mysql_drop_db $db_name # Remove the database - else - echo "Database $db_name not found" >&2 - fi - - # Remove mysql user if it exists - if $(ynh_mysql_user_exists $db_user); then - ynh_mysql_drop_user $db_user - fi +# usage: ynh_psql_create_db db [user [pwd]] +# | arg: db - the database name to create +# | arg: user - the user to grant privilegies +# | arg: pwd - the user password +ynh_psql_create_db() { + db="$1" + user="$2" + pwd="$3" + ynh_psql_create_user "$user" "$pwd" + sudo --login --user=postgres createdb --owner="$user" "$db" } -# Correct the name given in argument for mariadb +# Drop a database # -# Avoid invalid name for your database -# -# Exemple: dbname=$(ynh_make_valid_dbid $app) -# -# usage: ynh_make_valid_dbid name -# | arg: name - name to correct -# | ret: the corrected name -ynh_sanitize_dbid () { - dbid=${1//[-.]/_} # We should avoid having - and . in the name of databases. They are replaced by _ - echo $dbid +# usage: ynh_psql_drop_db db +# | arg: db - the database name to drop +# | arg: user - the user to drop +ynh_psql_remove_db() { + db="$1" + user="$2" + sudo --login --user=postgres dropdb "$db" + ynh_psql_drop_user "$user" } -# Manage a fail of the script +# Dump a database # -# Print a warning to inform that the script was failed -# Execute the ynh_clean_setup function if used in the app script +# example: ynh_psql_dump_db 'roundcube' > ./dump.sql # -# usage of ynh_clean_setup function -# This function provide a way to clean some residual of installation that not managed by remove script. -# To use it, simply add in your script: -# ynh_clean_setup () { -# instructions... -# } -# This function is optionnal. -# -# Usage: ynh_exit_properly is used only by the helper ynh_abort_if_errors. -# You must not use it directly. -ynh_exit_properly () { - exit_code=$? - if [ "$exit_code" -eq 0 ]; then - exit 0 # Exit without error if the script ended correctly - fi - - trap '' EXIT # Ignore new exit signals - set +eu # Do not exit anymore if a command fail or if a variable is empty - - echo -e "!!\n $app's script has encountered an error. Its execution was cancelled.\n!!" >&2 - - if type -t ynh_clean_setup > /dev/null; then # Check if the function exist in the app script. - ynh_clean_setup # Call the function to do specific cleaning for the app. - fi - - ynh_die # Exit with error status +# usage: ynh_psql_dump_db db +# | arg: db - the database name to dump +# | ret: the psqldump output +ynh_psql_dump_db() { + db="$1" + sudo --login --user=postgres pg_dump "$db" } -# Exit if an error occurs during the execution of the script. + +# Create a user # -# Stop immediatly the execution if an error occured or if a empty variable is used. -# The execution of the script is derivate to ynh_exit_properly function before exit. -# -# Usage: ynh_abort_if_errors -ynh_abort_if_errors () { - set -eu # Exit if a command fail, and if a variable is used unset. - trap ynh_exit_properly EXIT # Capturing exit signals on shell script +# usage: ynh_psql_create_user user pwd [host] +# | arg: user - the user name to create +ynh_psql_create_user() { + user="$1" + pwd="$2" + sudo --login --user=postgres psql -c"CREATE USER $user WITH PASSWORD '$pwd'" postgres } -# Define and install dependencies with a equivs control file -# This helper can/should only be called once per app +# Drop a user # -# usage: ynh_install_app_dependencies dep [dep [...]] -# | arg: dep - the package name to install in dependence -ynh_install_app_dependencies () { - dependencies=$@ - manifest_path="../manifest.json" - if [ ! -e "$manifest_path" ]; then - manifest_path="../settings/manifest.json" # Into the restore script, the manifest is not at the same place - fi - version=$(sudo grep '\"version\": ' "$manifest_path" | cut -d '"' -f 4) # Retrieve the version number in the manifest file. - dep_app=${app//_/-} # Replace all '_' by '-' - - if ynh_package_is_installed "${dep_app}-ynh-deps"; then - echo "A package named ${dep_app}-ynh-deps is already installed" >&2 - else - cat > ./${dep_app}-ynh-deps.control << EOF # Make a control file for equivs-build -Section: misc -Priority: optional -Package: ${dep_app}-ynh-deps -Version: ${version} -Depends: ${dependencies// /, } -Architecture: all -Description: Fake package for ${app} (YunoHost app) dependencies - This meta-package is only responsible of installing its dependencies. -EOF - ynh_package_install_from_equivs ./${dep_app}-ynh-deps.control \ - || ynh_die "Unable to install dependencies" # Install the fake package and its dependencies - ynh_app_setting_set $app apt_dependencies $dependencies - fi +# usage: ynh_psql_drop_user user +# | arg: user - the user name to drop +ynh_psql_drop_user() { + user="$1" + sudo --login --user=postgres dropuser "$user" } -# Remove fake package and its dependencies -# -# Dependencies will removed only if no other package need them. -# -# usage: ynh_remove_app_dependencies -ynh_remove_app_dependencies () { - dep_app=${app//_/-} # Replace all '_' by '-' - ynh_package_autoremove ${dep_app}-ynh-deps # Remove the fake package and its dependencies if they not still used. -} - -# Use logrotate to manage the logfile -# -# usage: ynh_use_logrotate [logfile] -# | arg: logfile - absolute path of logfile -# -# If no argument provided, a standard directory will be use. /var/log/${app} -# You can provide a path with the directory only or with the logfile. -# /parentdir/logdir/ -# /parentdir/logdir/logfile.log -# -# It's possible to use this helper several times, each config will added to same logrotate config file. -ynh_use_logrotate () { - if [ "$#" -gt 0 ]; then - if [ "$(echo ${1##*.})" == "log" ]; then # Keep only the extension to check if it's a logfile - logfile=$1 # In this case, focus logrotate on the logfile - else - logfile=$1/.log # Else, uses the directory and all logfile into it. - fi - else - logfile="/var/log/${app}/*.log" # Without argument, use a defaut directory in /var/log - fi - cat > ./${app}-logrotate << EOF # Build a config file for logrotate -$logfile { - # Rotate if the logfile exceeds 100Mo - size 100M - # Keep 12 old log maximum - rotate 12 - # Compress the logs with gzip - compress - # Compress the log at the next cycle. So keep always 2 non compressed logs - delaycompress - # Copy and truncate the log to allow to continue write on it. Instead of move the log. - copytruncate - # Do not do an error if the log is missing - missingok - # Not rotate if the log is empty - notifempty - # Keep old logs in the same dir - noolddir -} -EOF - sudo mkdir -p $(dirname "$logfile") # Create the log directory, if not exist - cat ${app}-logrotate | sudo tee -a /etc/logrotate.d/$app > /dev/null # Append this config to the others for this app. If a config file already exist -} - -# Remove the app's logrotate config. -# -# usage: ynh_remove_logrotate -ynh_remove_logrotate () { - if [ -e "/etc/logrotate.d/$app" ]; then - sudo rm "/etc/logrotate.d/$app" - fi -} - -# Find a free port and return it -# -# example: port=$(ynh_find_port 8080) -# -# usage: ynh_find_port begin_port -# | arg: begin_port - port to start to search -ynh_find_port () { - port=$1 - test -n "$port" || ynh_die "The argument of ynh_find_port must be a valid port." - while netcat -z 127.0.0.1 $port # Check if the port is free - do - port=$((port+1)) # Else, pass to next port - done - echo $port -} - -# Create a system user -# -# usage: ynh_system_user_create user_name [home_dir] -# | arg: user_name - Name of the system user that will be create -# | arg: home_dir - Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home -ynh_system_user_create () { - if ! ynh_system_user_exists "$1" # Check if the user exists on the system - then # If the user doesn't exist - if [ $# -ge 2 ]; then # If a home dir is mentioned - user_home_dir="-d $2" - else - user_home_dir="--no-create-home" - fi - sudo useradd $user_home_dir --system --user-group $1 --shell /usr/sbin/nologin || ynh_die "Unable to create $1 system account" - fi -} - -# Delete a system user -# -# usage: ynh_system_user_delete user_name -# | arg: user_name - Name of the system user that will be create -ynh_system_user_delete () { - if ynh_system_user_exists "$1" # Check if the user exists on the system - then - echo "Remove the user $1" >&2 - sudo userdel $1 - else - echo "The user $1 was not found" >&2 - fi -} - -# Curl abstraction to help with POST requests to local pages (such as installation forms) -# -# $domain and $path_url should be defined externally (and correspond to the domain.tld and the /path (of the app?)) -# -# example: ynh_local_curl "/install.php?installButton" "foo=$var1" "bar=$var2" -# -# usage: ynh_local_curl "page_uri" "key1=value1" "key2=value2" ... -# | arg: page_uri - Path (relative to $path_url) of the page where POST data will be sent -# | arg: key1=value1 - (Optionnal) POST key and corresponding value -# | arg: key2=value2 - (Optionnal) Another POST key and corresponding value -# | arg: ... - (Optionnal) More POST keys and values -ynh_local_curl () { - # Define url of page to curl - full_page_url=https://localhost$path_url$1 - - # Concatenate all other arguments with '&' to prepare POST data - POST_data="" - for arg in "${@:2}" - do - POST_data="${POST_data}${arg}&" - done - if [ -n "$POST_data" ] - then - # Add --data arg and remove the last character, which is an unecessary '&' - POST_data="--data \"${POST_data::-1}\"" - fi - - # Curl the URL - curl --silent --show-error -kL -H "Host: $domain" --resolve $domain:443:127.0.0.1 $POST_data "$full_page_url" -} - -# Substitute/replace a string by another in a file -# -# usage: ynh_replace_string match_string replace_string target_file -# | arg: match_string - String to be searched and replaced in the file -# | arg: replace_string - String that will replace matches -# | arg: target_file - File in which the string will be replaced. -ynh_replace_string () { - delimit=@ - match_string=${1//${delimit}/"\\${delimit}"} # Escape the delimiter if it's in the string. - replace_string=${2//${delimit}/"\\${delimit}"} - workfile=$3 - - sudo sed --in-place "s${delimit}${match_string}${delimit}${replace_string}${delimit}g" "$workfile" -} - -# Remove a file or a directory securely -# -# usage: ynh_secure_remove path_to_remove -# | arg: path_to_remove - File or directory to remove -ynh_secure_remove () { - path_to_remove=$1 - forbidden_path=" \ - /var/www \ - /home/yunohost.app" - - if [[ "$forbidden_path" =~ "$path_to_remove" \ - # Match all paths or subpaths in $forbidden_path - || "$path_to_remove" =~ ^/[[:alnum:]]+$ \ - # Match all first level paths from / (Like /var, /root, etc...) - || "${path_to_remove:${#path_to_remove}-1}" = "/" ]] - # Match if the path finishes by /. Because it seems there is an empty variable - then - echo "Avoid deleting $path_to_remove." >&2 - else - if [ -e "$path_to_remove" ] - then - sudo rm -R "$path_to_remove" - else - echo "$path_to_remove wasn't deleted because it doesn't exist." >&2 - fi - fi -} - -# Download, check integrity, uncompress and patch the source from app.src -# -# The file conf/app.src need to contains: -# -# SOURCE_URL=Address to download the app archive -# SOURCE_SUM=Control sum -# # (Optional) Programm to check the integrity (sha256sum, md5sum$YNH_EXECUTION_DIR/...) -# # default: sha256 -# SOURCE_SUM_PRG=sha256 -# # (Optional) Archive format -# # default: tar.gz -# SOURCE_FORMAT=tar.gz -# # (Optional) Put false if source are directly in the archive root -# # default: true -# SOURCE_IN_SUBDIR=false -# # (Optionnal) Name of the local archive (offline setup support) -# # default: ${src_id}.${src_format} -# SOURCE_FILENAME=example.tar.gz -# -# Details: -# This helper download sources from SOURCE_URL if there is no local source -# archive in /opt/yunohost-apps-src/APP_ID/SOURCE_FILENAME -# -# Next, it check the integrity with "SOURCE_SUM_PRG -c --status" command. -# -# If it's ok, the source archive will be uncompress in $dest_dir. If the -# SOURCE_IN_SUBDIR is true, the first level directory of the archive will be -# removed. -# -# Finally, patches named sources/patches/${src_id}-*.patch and extra files in -# sources/extra_files/$src_id will be applyed to dest_dir -# -# -# usage: ynh_setup_source dest_dir [source_id] -# | arg: dest_dir - Directory where to setup sources -# | arg: source_id - Name of the app, if the package contains more than one app -YNH_EXECUTION_DIR="." -ynh_setup_source () { - local dest_dir=$1 - local src_id=${2:-app} # If the argument is not given, source_id equal "app" - - # Load value from configuration file (see above for a small doc about this file - # format) - local src_url=$(grep 'SOURCE_URL=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_sum=$(grep 'SOURCE_SUM=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_sumprg=$(grep 'SOURCE_SUM_PRG=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_format=$(grep 'SOURCE_FORMAT=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_in_subdir=$(grep 'SOURCE_IN_SUBDIR=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_filename=$(grep 'SOURCE_FILENAME=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - - # Default value - src_sumprg=${src_sumprg:-sha256sum} - src_in_subdir=${src_in_subdir:-true} - src_format=${src_format:-tar.gz} - src_format=$(echo "$src_format" | tr '[:upper:]' '[:lower:]') - if [ "$src_filename" = "" ] ; then - src_filename="${src_id}.${src_format}" - fi - local local_src="/opt/yunohost-apps-src/${YNH_APP_ID}/${src_filename}" - - if test -e "$local_src" - then # Use the local source file if it is present - cp $local_src $src_filename - else # If not, download the source - wget -nv -O $src_filename $src_url - fi - - # Check the control sum - echo "${src_sum} ${src_filename}" | ${src_sumprg} -c --status \ - || ynh_die "Corrupt source" - - # Extract source into the app dir - sudo mkdir -p "$dest_dir" - if [ "$src_format" = "zip" ] - then - # Zip format - # Using of a temp directory, because unzip doesn't manage --strip-components - if $src_in_subdir ; then - local tmp_dir=$(mktemp -d) - sudo unzip -quo $src_filename -d "$tmp_dir" - sudo cp -a $tmp_dir/*/. "$dest_dir" - ynh_secure_remove "$tmp_dir" - else - sudo unzip -quo $src_filename -d "$dest_dir" - fi - else - local strip="" - if $src_in_subdir ; then - strip="--strip-components 1" - fi - if [[ "$src_format" =~ ^tar.gz|tar.bz2|tar.xz$ ]] ; then - sudo tar -xf $src_filename -C "$dest_dir" $strip - else - ynh_die "Archive format unrecognized." - fi - fi - - # Apply patches - if (( $(find $YNH_EXECUTION_DIR/../sources/patches/ -type f -name "${src_id}-*.patch" 2> /dev/null | wc -l) > "0" )); then - local old_dir=$(pwd) - (cd "$dest_dir" \ - && for p in $YNH_EXECUTION_DIR/../sources/patches/${src_id}-*.patch; do \ - sudo patch -p1 < $p; done) \ - || ynh_die "Unable to apply patches" - cd $old_dir - fi - - # Add supplementary files - if test -e "$YNH_EXECUTION_DIR/../sources/extra_files/${src_id}"; then - sudo cp -a $YNH_EXECUTION_DIR/../sources/extra_files/$src_id/. "$dest_dir" - fi -} - -# Check availability of a web path -# -# example: ynh_webpath_available some.domain.tld /coffee -# -# usage: ynh_webpath_available domain path -# | arg: domain - the domain/host of the url -# | arg: path - the web path to check the availability of -ynh_webpath_available () { - local domain=$1 - local path=$2 - sudo yunohost domain url-available $domain $path -} - -# Register/book a web path for an app -# -# example: ynh_webpath_register wordpress some.domain.tld /coffee -# -# usage: ynh_webpath_register app domain path -# | arg: app - the app for which the domain should be registered -# | arg: domain - the domain/host of the web path -# | arg: path - the web path to be registered -ynh_webpath_register () { - local app=$1 - local domain=$2 - local path=$3 - sudo yunohost app register-url $app $domain $path -} - -# Calculate and store a file checksum into the app settings -# -# $app should be defined when calling this helper -# -# usage: ynh_store_file_checksum file -# | arg: file - The file on which the checksum will performed, then stored. -ynh_store_file_checksum () { - local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_' - ynh_app_setting_set $app $checksum_setting_name $(sudo md5sum "$1" | cut -d' ' -f1) -} - -# Verify the checksum and backup the file if it's different -# This helper is primarily meant to allow to easily backup personalised/manually -# modified config files. -# -# $app should be defined when calling this helper -# -# usage: ynh_backup_if_checksum_is_different file -# | arg: file - The file on which the checksum test will be perfomed. -# -# | ret: Return the name a the backup file, or nothing -ynh_backup_if_checksum_is_different () { - local file=$1 - local checksum_setting_name=checksum_${file//[\/ ]/_} # Replace all '/' and ' ' by '_' - local checksum_value=$(ynh_app_setting_get $app $checksum_setting_name) - if [ -n "$checksum_value" ] - then # Proceed only if a value was stored into the app settings - if ! echo "$checksum_value $file" | sudo md5sum -c --status - then # If the checksum is now different - backup_file="/home/yunohost.conf/backup/$file.backup.$(date '+%Y%m%d.%H%M%S')" - sudo mkdir -p "$(dirname "$backup_file")" - sudo cp -a "$file" "$backup_file" # Backup the current file - echo "File $file has been manually modified since the installation or last upgrade. So it has been duplicated in $backup_file" >&2 - echo "$backup_file" # Return the name of the backup file - fi - fi -} +#================================================= +# FUTURE OFFICIAL HELPERS +#================================================= diff --git a/scripts/backup b/scripts/backup index 630d6c8..7cb6338 100755 --- a/scripts/backup +++ b/scripts/backup @@ -1,61 +1,90 @@ #!/bin/bash -# Exit on command errors and treat unset variables as an error -set -eu #================================================= -# GENERIC STARTING -#================================================= - +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= -if [ ! -e _common.sh ]; then - # Get the functions file if not present in the current directory - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh -fi -source _common.sh +#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts +source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= + +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + #================================================= # LOAD SETTINGS #================================================= +ynh_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -pvp=$(ynh_app_setting_get $app pvp) -damage=$(ynh_app_setting_get $app damage) -domain=$(ynh_app_setting_get $app domain) -creative=$(ynh_app_setting_get $app creative) -is_public=$(ynh_app_setting_get $app is_public) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +domain=$(ynh_app_setting_get --app=$app --key=domain) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) +postgresql=$(ynh_app_setting_get --app=$app --key=postgresql) #================================================= -# BACKUP STEPS +# STANDARD BACKUP STEPS #================================================= -# CONFIGURATION +# BACKUP THE APP MAIN DIR #================================================= -CHECK_SIZE "/etc/minetest/minetest.conf" -ynh_backup "/etc/minetest/minetest.conf" +# Stop Minetest before backup... +systemctl stop minetest + +ynh_print_info --message="Backing up the main app directory..." + +ynh_backup --src_path="$final_path" #================================================= -# DATA +# BACKUP THE HOME DIR #================================================= -echo ".backup /tmp/map.sqlite" | sqlite3 /var/games/minetest-server/.minetest/worlds/world/map.sqlite -ls -lh /tmp/map.sqlite -CHECK_SIZE "/var/games/minetest-server/" -ynh_backup "/var/games/minetest-server/" +ynh_print_info --message="Backing up nginx web server configuration..." -CHECK_SIZE "/tmp/map.sqlite" -ynh_backup "/tmp/map.sqlite" +ynh_backup --src_path="/home/yunohost.app/$app" #================================================= -# BACKUP OF APT PREFERENCES AND SOURCES.LIST +# BACKUP THE PHP-FPM CONFIGURATION #================================================= -CHECK_SIZE "/etc/apt/sources.list.d/$app.list" -ynh_backup "/etc/apt/sources.list.d/$app.list" +ynh_print_info --message="Backing up php-fpm configuration..." -CHECK_SIZE "/etc/apt/preferences.d/00MinetestPinning" -ynh_backup "/etc/apt/preferences.d/00MinetestPinning" +ynh_backup --src_path="/etc/php/7.0/fpm/pool.d/$app.conf" +#================================================= +# BACKUP THE POSTGRESQL DATABASE +#================================================= +if [ $postgresql -eq 1 ] +then +ynh_print_info --message="Backing up the PostgreSQL database..." +ynh_psql_dump_db --database="$db_name" > db.sql +fi + +#================================================= +# SPECIFIC BACKUP +#================================================= +# BACKUP LOGROTATE +#================================================= +ynh_print_info --message="Backing up logrotate configuration..." + +ynh_backup --src_path="/etc/logrotate.d/$app" + +#================================================= +# BACKUP SYSTEMD +#================================================= +ynh_print_info --message="Backing up systemd configuration..." + +ynh_backup --src_path="/etc/systemd/system/$app.service" + +#================================================= +# END OF SCRIPT +#================================================= +# Restart Minetest +systemctl start minetest + +ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." diff --git a/scripts/install b/scripts/install index 5f4aada..208e1b7 100755 --- a/scripts/install +++ b/scripts/install @@ -1,7 +1,7 @@ #!/bin/bash #================================================= -# GENERIC STARTING +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -10,115 +10,277 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE FAILURE OF THE SCRIPT +# MANAGE SCRIPT FAILURE #================================================= +# Exit if an error occurs during the execution of the script ynh_abort_if_errors #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST #================================================= -pvp=$YNH_APP_ARG_PVP -app=$YNH_APP_INSTANCE_NAME -damage=$YNH_APP_ARG_DAMAGE domain=$YNH_APP_ARG_DOMAIN -creative=$YNH_APP_ARG_CREATIVE is_public=$YNH_APP_ARG_IS_PUBLIC +postgresql=$YNH_APP_ARG_POSTGRESQL +pvp=$YNH_APP_ARG_PVP +creative=$YNH_APP_ARG_CREATIVE +damage=$YNH_APP_ARG_DAMAGE +servername=$YNH_APP_ARG_SERVERNAME + +### If it's a multi-instance app, meaning it can be installed several times independently +### The id of the app as stated in the manifest is available as $YNH_APP_ID +### The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...) +### The app instance name is available as $YNH_APP_INSTANCE_NAME +### - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample +### - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2 +### - ynhexample__{N} for the subsequent installations, with N=3,4, ... +### The app instance name is probably what interests you most, since this is +### guaranteed to be unique. This is a good unique identifier to define installation path, +### db names, ... +app=$YNH_APP_INSTANCE_NAME #================================================= -# CHECK THE DEBIAN'S CODENAME +# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= +ynh_print_info --message="Validating installation parameters..." -codename=$(lsb_release -a 2>/dev/null | grep Codename | cut -f 2) -test -z "$codename" && (ynh_die "codename empty") +### If the app uses nginx as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app". +### If the app provides an internal web server (or uses another application server such as uwsgi), the final path should be "/opt/yunohost/$app" +final_path=/opt/yunohost/$app +test ! -e "$final_path" || ynh_die "This path already contains a folder" + +# Register (book) web path +ynh_webpath_register --app=$app --domain=$domain --path_url=/ + +#================================================= +# STORE SETTINGS FROM MANIFEST +#================================================= +ynh_print_info --message="Storing installation settings..." + +ynh_app_setting_set --app=$app --key=domain --value=$domain +ynh_app_setting_set --app=$app --key=is_public --value=$is_public +ynh_app_setting_set --app=$app --key=postgresql --value=$postgresql +ynh_app_setting_set --app=$app --key=pvp --value=$pvp +ynh_app_setting_set --app=$app --key=creative --value=$creative +ynh_app_setting_set --app=$app --key=damage --value=$damage +ynh_app_setting_set --app=$app --key=servername --value=$servername #================================================= # STANDARD MODIFICATIONS #================================================= # FIND AND OPEN A PORT #================================================= +ynh_print_info --message="Configuring firewall..." -port=$(ynh_find_port 30000) # Cherche un port libre. +### Use these lines if you have to open a port for the application +### `ynh_find_port` will find the first available port starting from the given port. +### If you're not using these lines: +### - Remove the section "CLOSE A PORT" in the remove script -# Open ports in firewall -ALL_QUIET yunohost firewall allow UDP $port -ALL_QUIET yunohost firewall allow TCP $port -ynh_app_setting_set $app port $port +# Find a free port +port=$(ynh_find_port 30000) +# Open this port +ynh_exec_warn_less yunohost firewall allow --no-upnp UDP $port +ynh_app_setting_set --app=$app --key=port --value=$port -# Store informations in Yunohost config -ynh_app_setting_set $app pvp ${pvp} -ynh_app_setting_set $app damage ${damage} -ynh_app_setting_set $app domain ${domain} -ynh_app_setting_set $app creative ${creative} -ynh_app_setting_set $app is_public ${is_public} +#================================================= +# INSTALL DEPENDENCIES +#================================================= +ynh_print_info --message="Installing dependencies..." + +### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package. +### Those deb packages will be installed as dependencies of this package. +### If you're not using this helper: +### - Remove the section "REMOVE DEPENDENCIES" in the remove script +### - Remove the variable "pkg_dependencies" in _common.sh +### - As well as the section "REINSTALL DEPENDENCIES" in the restore script +### - And the section "UPGRADE DEPENDENCIES" in the upgrade script + +ynh_install_app_dependencies $pkg_dependencies +#================================================= +# CREATE A POSTGRESQL DATABASE +#================================================= +if [ $postgresql -eq 1 ] +then +ynh_print_info --message="Creating a PostgreSQL database..." + +# Create a database, an user and its password. Then store the password in the app's config +# +# After executing this helper, the password of the created database will be available in $db_pwd +# It will also be stored as "psqlpwd" into the app settings. + +ynh_psql_test_if_first_run +db_name=$(ynh_sanitize_dbid $app) +ynh_app_setting_set --app=$app --key=db_name --value=$db_name +ynh_psql_setup_db --db_user=$db_name --db_name=$db_name +fi + +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= +ynh_print_info --message="Setting up source files..." + +### `ynh_setup_source` is used to install an app from a zip or tar.gz file, +### downloaded from an upstream source, like a git repository. +### `ynh_setup_source` use the file conf/app.src + +ynh_app_setting_set --app=$app --key=final_path --value=$final_path +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source --dest_dir="$final_path" + +#================================================= +# CREATE DEDICATED USER +#================================================= +ynh_print_info --message="Configuring system user..." + +# Create a system user +ynh_system_user_create --username=$app --home_dir=/home/yunohost.app/$app --use_shell +home_path=/home/yunohost.app/$app + +#================================================= +# COPY CONFIG FILE +#================================================= +mkdir -p /home/yunohost.app/$app/.minetest/ +mkdir /home/yunohost.app/$app/.minetest/worlds/ +cp -a ../conf/minetest.conf /home/yunohost.app/$app/.minetest/ + +#================================================= +# SETUP SYSTEMD +#================================================= +ynh_print_info --message="Configuring a systemd service..." + +### `ynh_systemd_config` is used to configure a systemd script for an app. +### It can be used for apps that use sysvinit (with adaptation) or systemd. +### Have a look at the app to be sure this app needs a systemd script. +### `ynh_systemd_config` will use the file conf/systemd.service +### If you're not using these lines: +### - You can remove those files in conf/. +### - Remove the section "BACKUP SYSTEMD" in the backup script +### - Remove also the section "STOP AND REMOVE SERVICE" in the remove script +### - As well as the section "RESTORE SYSTEMD" in the restore script +### - And the section "SETUP SYSTEMD" in the upgrade script + +# Create a dedicated systemd config +ynh_add_systemd_config #================================================= # SPECIFIC SETUP #================================================= -# INSTALL MINETEST -#================================================= - -# Installation du paquet minetest et ses dépendances -cp -a "../conf/minetest.list" "/etc/apt/sources.list.d/$app.list" -ynh_replace_string "__CODENAME__" "$codename" "/etc/apt/sources.list.d/$app.list" -cp -a "../conf/minetest-preferences" "/etc/apt/preferences.d/00MinetestPinning" -ynh_replace_string "__CODENAME__" "$codename" "/etc/apt/preferences.d/00MinetestPinning" -if [ $(uname -m) == "armv7l" ] +# Compile Minetest +cd /opt/yunohost/$app +# Download Minetest Game +git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game -b stable-5 +if [ $postgresql -eq 1 ] then - gpg --list-keys 7638D0442B90D010 > /dev/null 2>&1 - if [ $? != 0 ] - then - gpg --keyserver pgpkeys.mit.edu --recv-key 7638D0442B90D010 - fi - gpg --list-keys 8B48AD6246925553 > /dev/null 2>&1 - if [ $? != 0 ] - then - gpg --keyserver pgpkeys.mit.edu --recv-key 8B48AD6246925553 - fi - if [ $(apt-key finger | grep "7638 D044 2B90 D010" -c) == 0 ] - then - gpg -a --export 7638D0442B90D010 | apt-key add - - fi - if [ $(apt-key finger | grep "8B48 AD62 4692 5553" -c) == 0 ] - then - gpg -a --export 8B48AD6246925553 | apt-key add - - fi -fi -ynh_package_update -ynh_install_app_dependencies minetest-server sqlite3 - -#================================================= -# ENABLE SERVICE IN ADMIN PANEL -#================================================= - -# Add service to Yunohost's monitoring -yunohost service add minetest --log "/var/log/minetest/minetest.log" - -#================================================= -# CONFIGURE MINETEST -#================================================= - -cp "../conf/minetest.conf" "/etc/minetest/minetest.conf" -chown root:root /etc/minetest/minetest.conf -chmod 644 /etc/minetest/minetest.conf - -# Change Minetest configuration -ynh_replace_string "__PORT__" "$port" /etc/minetest/minetest.conf -if [ $is_public -eq 1 ] -then - ynh_replace_string "__ANNOUNCE__" "true" /etc/minetest/minetest.conf +cmake . -DRUN_IN_PLACE=TRUE -DENABLE_POSTGRESQL=TRUE -DPostgreSQL_TYPE_INCLUDE_DIR=/usr/include/postgresql/ -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE else - ynh_replace_string "__ANNOUNCE__" "false" /etc/minetest/minetest.conf +cmake . -DRUN_IN_PLACE=TRUE -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE fi -ynh_replace_string "__DOMAIN__" "$domain" /etc/minetest/minetest.conf -ynh_replace_string "__PVP__" "$pvp" /etc/minetest/minetest.conf -ynh_replace_string "__CREATIVE__" "$creative" /etc/minetest/minetest.conf -ynh_replace_string "__DAMAGE__" "$damage" /etc/minetest/minetest.conf + +make -j 2 + #================================================= -# RESTART MINETEST'S SERVICE +# MODIFY A CONFIG FILE #================================================= -# Restart Minetest to use new settings -systemctl restart minetest-server +### `ynh_replace_string` is used to replace a string in a file. +### (It's compatible with sed regular expressions syntax) + +ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__SERVERNAME__" --replace_string="$servername" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__ANNOUNCE__" --replace_string="$is_public" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__PVP__" --replace_string="$pvp" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__CREATIVE__" --replace_string="$creative" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__DAMAGE__" --replace_string="$damage" --target_file="$home_path/.minetest/minetest.conf" + + +#================================================= +# CREATE WORLD +#================================================= + +# Set permissions on logs +chown -R minetest:minetest /var/log/minetest + +systemctl start minetest +if [ $postgresql -eq 1 ] +then +systemctl stop minetest +echo "pgsql_connection = host=127.0.0.1 user=$db_user password=$db_pwd dbname=$db_name" > $home_path/.minetest/worlds/world/world.mt +sleep 5 +/opt/yunohost/$app/bin/minetestserver --migrate postgresql --world $home_path/.minetest/worlds/world +fi + +#================================================= +# STORE THE CONFIG FILE CHECKSUM +#================================================= + +### `ynh_store_file_checksum` is used to store the checksum of a file. +### That way, during the upgrade script, by using `ynh_backup_if_checksum_is_different`, +### you can make a backup of this file before modifying it again if the admin had modified it. + +# Calculate and store the config file checksum into the app settings +ynh_store_file_checksum --file="$home_path/.minetest/minetest.conf" + +#================================================= +# GENERIC FINALIZATION +#================================================= +# SECURE FILES AND DIRECTORIES +#================================================= + +### For security reason, any app should set the permissions to root: before anything else. +### Then, if write authorization is needed, any access should be given only to directories +### that really need such authorization. + +# Set permissions to app files +chown -R root: $final_path +chown -R minetest: $home_path + +#================================================= +# SETUP LOGROTATE +#================================================= +ynh_print_info --message="Configuring log rotation..." + +### `ynh_use_logrotate` is used to configure a logrotate configuration for the logs of this app. +### Use this helper only if there is effectively a log file for this app. +### If you're not using this helper: +### - Remove the section "BACKUP LOGROTATE" in the backup script +### - Remove also the section "REMOVE LOGROTATE CONFIGURATION" in the remove script +### - As well as the section "RESTORE THE LOGROTATE CONFIGURATION" in the restore script +### - And the section "SETUP LOGROTATE" in the upgrade script + +# Use logrotate to manage application logfile(s) +ynh_use_logrotate + +#================================================= +# ADVERTISE SERVICE IN ADMIN PANEL +#================================================= + +### `yunohost service add` is a CLI yunohost command to add a service in the admin panel. +### You'll find the service in the 'services' section of YunoHost admin panel. +### This CLI command would be useless if the app does not have any services (systemd or sysvinit) +### If you're not using these lines: +### - You can remove these files in conf/. +### - Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script +### - As well as the section "ADVERTISE SERVICE IN ADMIN PANEL" in the restore script + +yunohost service add $app --log "/var/log/$app/$app.log" +# if using yunohost version 3.2 or more in the 'manifest.json', a description can be added +#yunohost service add $app --description "$app daemon for XXX" --log "/var/log/$app/$app.log" + +#================================================= +# RELOAD MINETEST +#================================================= +ynh_print_info --message="Reloading minetest..." + +systemctl restart minetest +ynh_systemd_action -l "Server for gameid="minetest" listening on :::30000." -p "systemd" +sleep 1 + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_print_info --message="Installation of $app completed" diff --git a/scripts/remove b/scripts/remove index 06b6756..1f2660b 100755 --- a/scripts/remove +++ b/scripts/remove @@ -1,7 +1,7 @@ #!/bin/bash #================================================= -# GENERIC STARTING +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -12,43 +12,100 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -port=$(ynh_app_setting_get $app port) +domain=$(ynh_app_setting_get --app=$app --key=domain) +port=$(ynh_app_setting_get --app=$app --key=port) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) +db_user=$db_name +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +postgresql=$(ynh_app_setting_get --app=$app --key=postgresql) #================================================= # STANDARD REMOVE #================================================= -# DISABLE SERVICE IN ADMIN PANEL +# REMOVE SERVICE FROM ADMIN PANEL #================================================= -# Retire le service du monitoring de Yunohost. -if yunohost service status | grep -q minetest # Test l'existence du service dans Yunohost +# Remove a service from the admin panel, added by `yunohost service add` +if yunohost service status $app >/dev/null 2>&1 then - echo "Remove minetest service" - yunohost service remove minetest + ynh_print_info --message="Removing $app service" + yunohost service remove $app fi #================================================= -# CLOSE THE PORTS +# STOP AND REMOVE SERVICE +#================================================= +ynh_print_info --message="Stopping and removing the systemd service" + +# Remove the dedicated systemd config +ynh_remove_systemd_config + +#================================================= +# REMOVE THE POSTGRESQL DATABASE +#================================================= +if [ $postgresql -eq 1 ] +then +ynh_print_info --message="Removing the PostgreSQL database" + +# Remove a database if it exists, along with the associated user +ynh_psql_remove_db --user=$db_user --db=$db_name +fi + +#================================================= +# REMOVE DEPENDENCIES +#================================================= +ynh_print_info --message="Removing dependencies" + +# Remove metapackage and its dependencies +ynh_remove_app_dependencies + +#================================================= +# REMOVE APP MAIN DIR +#================================================= +ynh_print_info --message="Removing app main directory" + +# Remove the app directory securely +ynh_secure_remove --file="$final_path" +ynh_secure_remove --file="/home/yunohost.app/$app/" + +#================================================= +# REMOVE LOGROTATE CONFIGURATION +#================================================= +ynh_print_info --message="Removing logrotate configuration" + +# Remove the app-specific logrotate config +ynh_remove_logrotate + +#================================================= +# CLOSE A PORT #================================================= -# Ferme les ports dans le firewall -ALL_QUIET yunohost firewall disallow UDP $port -ALL_QUIET yunohost firewall disallow TCP $port +if yunohost firewall list | grep -q "\- $port$" +then + ynh_print_info --message="Closing port $port" + ynh_exec_warn_less yunohost firewall disallow UDP $port +fi #================================================= # SPECIFIC REMOVE #================================================= -# REMOVE MINETEST + +#================================================= +# GENERIC FINALIZATION +#================================================= +# REMOVE DEDICATED USER +#================================================= +ynh_print_info --message="Removing the dedicated system user" + +# Delete a system user +ynh_system_user_delete --username=$app + +#================================================= +# END OF SCRIPT #================================================= -# Suppression du paquet minetest -if [ -e "/usr/lib/minetest/minetestserver" ]; then - echo "Remove minetest package" - ynh_remove_app_dependencies -fi -ynh_secure_remove "/etc/apt/sources.list.d/$app.list" -ynh_secure_remove "/etc/apt/preferences.d/00MinetestPinning" -ynh_package_update +ynh_print_info --message="Removal of $app completed" diff --git a/scripts/restore b/scripts/restore index d3b022a..a83c87b 100755 --- a/scripts/restore +++ b/scripts/restore @@ -1,99 +1,133 @@ #!/bin/bash -# Exit on command errors and treat unset variables as an error -set -eu #================================================= -# GENERIC STARTING -#================================================= - +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= -if [ ! -e _common.sh ]; then - # Get the functions file if not present in the current directory - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh -fi -source _common.sh +#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts +source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= + +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + #================================================= # LOAD SETTINGS #================================================= +ynh_print_info --message="Loading settings..." app=$YNH_APP_INSTANCE_NAME -pvp=$(ynh_app_setting_get $app pvp) -damage=$(ynh_app_setting_get $app damage) -domain=$(ynh_app_setting_get $app domain) -creative=$(ynh_app_setting_get $app creative) -is_public=$(ynh_app_setting_get $app is_public) +domain=$(ynh_app_setting_get --app=$app --key=domain) +path_url=$(ynh_app_setting_get --app=$app --key=path) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) +postgresql=$(ynh_app_setting_get --app=$app --key=postgresql) +home_path=$(ynh_app_setting_get --app=$app --key=home_path) #================================================= -# BACKUP STEPS +# CHECK IF THE APP CAN BE RESTORED #================================================= -# RESTORE APT PREFERENCES AND SOURCES.LIST -#================================================= -ynh_restore_file "/etc/apt/sources.list.d/$app.list" +ynh_print_info --message="Validating restoration parameters..." -ynh_restore_file "/etc/apt/preferences.d/00MinetestPinning" +ynh_webpath_available --domain=$domain \ + || ynh_die --message="Path not available: ${domain}" +test ! -d $final_path \ + || ynh_die --message="There is already a directory: $final_path " #================================================= -# INSTALL +# STANDARD RESTORATION STEPS #================================================= -if [ $(uname -m) == "armv7l" ] + +#================================================= +# RESTORE THE APP MAIN DIR +#================================================= +ynh_print_info --message="Restoring the app main directory..." + +ynh_restore_file --origin_path="$final_path" + +#================================================= +# RECREATE THE DEDICATED USER +#================================================= +ynh_print_info --message="Recreating the dedicated system user..." + +# Create the dedicated user (if not existing) +ynh_system_user_create --username=$app --home_dir=/home/yunohost.app/$app --use_shell + +# Restore home_path +ynh_restore_file --origin_path="$home_path" + +#================================================= +# RESTORE USER RIGHTS +#================================================= + +# Restore permissions on app files +chown -R root: $final_path +chown -R minetest: $home_path + +#================================================= +# SPECIFIC RESTORATION +#================================================= +# REINSTALL DEPENDENCIES +#================================================= +ynh_print_info --message="Reinstalling dependencies..." + +# Define and install dependencies +ynh_install_app_dependencies $pkg_dependencies + +#================================================= +# RESTORE THE POSTGRESQL DATABASE +#================================================= +if [ $postgresql -eq 1 ] then - gpg --list-keys 7638D0442B90D010 > /dev/null 2>&1 - if [ $? != 0 ] - then - gpg --keyserver pgpkeys.mit.edu --recv-key 7638D0442B90D010 - fi - gpg --list-keys 8B48AD6246925553 > /dev/null 2>&1 - if [ $? != 0 ] - then - gpg --keyserver pgpkeys.mit.edu --recv-key 8B48AD6246925553 - fi - if [ $(apt-key finger | grep "7638 D044 2B90 D010" -c) == 0 ] - then - gpg -a --export 7638D0442B90D010 | apt-key add - - fi - if [ $(apt-key finger | grep "8B48 AD62 4692 5553" -c) == 0 ] - then - gpg -a --export 8B48AD6246925553 | apt-key add - - fi +ynh_print_info --message="Restoring the PostgreSQL database..." + +ynh_psql_test_if_first_run +db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) +ynh_psql_setup_db --db_user=$db_name --db_name=$db_name --db_pwd=$db_pwd +ynh_psql_connect_as --user=$db_name --password=$db_pwd --database=$db_name < ./db.sql fi -ynh_package_update -ynh_install_app_dependencies minetest-server sqlite3 #================================================= -# ENABLE SERVICE IN ADMIN PANEL +# RESTORE SYSTEMD #================================================= +ynh_print_info --message="Restoring the systemd configuration..." -# Add service to Yunohost's monitoring -yunohost service add minetest --log "/var/log/minetest/minetest.log" +ynh_restore_file --origin_path="/etc/systemd/system/$app.service" +systemctl enable $app.service #================================================= -# STOP MINETEST +# ADVERTISE SERVICE IN ADMIN PANEL #================================================= -service minetest-server stop + +yunohost service add $app --log "/var/log/$app/$app.log" + #================================================= -# CONFIGURATION +# RESTORE THE LOGROTATE CONFIGURATION #================================================= -ynh_secure_remove "/etc/minetest/minetest.conf" -ynh_restore_file "/etc/minetest/minetest.conf" + +ynh_restore_file --origin_path="/etc/logrotate.d/$app" #================================================= -# DATA +# GENERIC FINALIZATION #================================================= -ynh_secure_remove "/var/games/minetest-server/" -ynh_restore_file "/var/games/minetest-server/" +# RELOAD MINETEST +#================================================= +ynh_print_info --message="Reloading minetest..." -ynh_restore_file "/tmp/map.sqlite" -echo ".restore /tmp/map.sqlite" | sqlite3 /var/games/minetest-server/.minetest/worlds/world/map.sqlite +systemctl restart minetest +ynh_systemd_action -l "ACTION[Main]: Server for gameid="minetest" listening on 0.0.0.0:30000." -p "/var/log/minetest/minetest.log" +sleep 1 #================================================= -# START MINETEST +# END OF SCRIPT #================================================= -service minetest-server start + +ynh_print_info --message="Restoration completed for $app" From 8efb4fbe4fe90deed3277aa966a36fd86740c64a Mon Sep 17 00:00:00 2001 From: Rafi59 Date: Thu, 15 Aug 2019 14:21:00 +0200 Subject: [PATCH 02/29] small fixes --- README.md | 2 +- check_process | 8 +-- manifest.json | 2 +- scripts/_common.sh | 161 +-------------------------------------------- scripts/backup | 8 +-- scripts/change_url | 69 +++++++++++++++++++ scripts/install | 30 ++++++--- scripts/remove | 4 +- scripts/upgrade | 144 ++++++++++++++++++++++++++++++++++++---- 9 files changed, 235 insertions(+), 193 deletions(-) create mode 100644 scripts/change_url diff --git a/README.md b/README.md index 8db1957..2a38a28 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* ## Overview -Quick description of this app. +Minetest is a free open-source voxel game engine with easy modding and game creation. **Shipped version:** 5.0.1 diff --git a/check_process b/check_process index 5002df8..3d54604 100644 --- a/check_process +++ b/check_process @@ -6,7 +6,7 @@ ;; Test complet sans postgresql ; Manifest domain="domain.tld" (DOMAIN) - postgresql=0 + use_postgresql=0 pvp=1 servername="packagecheck" creative=0 @@ -26,12 +26,12 @@ multi_instance=0 incorrect_path=0 port_already_use=1 - change_url=1 + change_url=0 ;; Test complet avec postgresql ; Manifest domain="domain.tld" (DOMAIN) - postgresql=1 + use_postgresql=1 pvp=1 servername="packagecheck" creative=0 @@ -51,7 +51,7 @@ multi_instance=0 incorrect_path=0 port_already_use=1 - change_url=1 + change_url=0 ;;; Levels Level 1=auto diff --git a/manifest.json b/manifest.json index f2acc17..533ad0c 100644 --- a/manifest.json +++ b/manifest.json @@ -47,7 +47,7 @@ "default": false }, { - "name": "postgresql", + "name": "use_postgresql", "type": "boolean", "ask": { "en": "Do you want to use PostgreSQL? (more powerful but uses more disk space)", diff --git a/scripts/_common.sh b/scripts/_common.sh index 48dd698..0d5f16b 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -6,7 +6,7 @@ #================================================= # dependencies used by the app -pkg_dependencies="build-essential libirrlicht-dev cmake libbz2-dev libpng-dev libjpeg-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev zlib1g-dev libgmp-dev libjsoncpp-dev libluajit-5.1-dev" +pkg_dependencies="postgresql postgresql9.6 postgresql-contrib build-essential libirrlicht-dev cmake libbz2-dev libpng-dev libjpeg-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev zlib1g-dev libgmp-dev libjsoncpp-dev libluajit-5.1-dev" #================================================= # PERSONAL HELPERS @@ -16,165 +16,8 @@ pkg_dependencies="build-essential libirrlicht-dev cmake libbz2-dev libpng-dev li # EXPERIMENTAL HELPERS #================================================= -#================================================= -# -# POSTGRES HELPERS -# -# Point of contact : Jean-Baptiste Holcroft -#================================================= - -# Create a master password and set up global settings -# Please always call this script in install and restore scripts -# -# usage: ynh_psql_test_if_first_run - -ynh_psql_test_if_first_run() { - if [ -f /etc/yunohost/psql ]; - then - echo "PostgreSQL is already installed, no need to create master password" - else - pgsql=$(ynh_string_random) - pg_hba="" - echo "$pgsql" >> /etc/yunohost/psql - - if [ -e /etc/postgresql/9.4/ ] - then - pg_hba=/etc/postgresql/9.4/main/pg_hba.conf - elif [ -e /etc/postgresql/9.6/ ] - then - pg_hba=/etc/postgresql/9.6/main/pg_hba.conf - else - ynh_die "postgresql shoud be 9.4 or 9.6" - fi - - systemctl start postgresql - sudo --login --user=postgres psql -c"ALTER user postgres WITH PASSWORD '$pgsql'" postgres - - # force all user to connect to local database using passwords - # https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html#EXAMPLE-PG-HBA.CONF - # Note: we can't use peer since YunoHost create users with nologin - # See: https://github.com/YunoHost/yunohost/blob/unstable/data/helpers.d/user - sed -i '/local\s*all\s*all\s*peer/i \ - local all all password' "$pg_hba" - systemctl enable postgresql - systemctl reload postgresql - fi -} - -# Open a connection as a user -# -# example: ynh_psql_connect_as 'user' 'pass' <<< "UPDATE ...;" -# example: ynh_psql_connect_as 'user' 'pass' < /path/to/file.sql -# -# usage: ynh_psql_connect_as user pwd [db] -# | arg: user - the user name to connect as -# | arg: pwd - the user password -# | arg: db - the database to connect to -ynh_psql_connect_as() { - user="$1" - pwd="$2" - db="$3" - sudo --login --user=postgres PGUSER="$user" PGPASSWORD="$pwd" psql "$db" -} - -# # Execute a command as root user -# -# usage: ynh_psql_execute_as_root sql [db] -# | arg: sql - the SQL command to execute -# | arg: db - the database to connect to -ynh_psql_execute_as_root () { - sql="$1" - sudo --login --user=postgres psql <<< "$sql" -} - -# Execute a command from a file as root user -# -# usage: ynh_psql_execute_file_as_root file [db] -# | arg: file - the file containing SQL commands -# | arg: db - the database to connect to -ynh_psql_execute_file_as_root() { - file="$1" - db="$2" - sudo --login --user=postgres psql "$db" < "$file" -} - -# Create a database, an user and its password. Then store the password in the app's config -# -# After executing this helper, the password of the created database will be available in $db_pwd -# It will also be stored as "psqlpwd" into the app settings. -# -# usage: ynh_psql_setup_db user name [pwd] -# | arg: user - Owner of the database -# | arg: name - Name of the database -# | arg: pwd - Password of the database. If not given, a password will be generated -ynh_psql_setup_db () { - db_user="$1" - db_name="$2" - new_db_pwd=$(ynh_string_random) # Generate a random password - # If $3 is not given, use new_db_pwd instead for db_pwd. - db_pwd="${3:-$new_db_pwd}" - ynh_psql_create_db "$db_name" "$db_user" "$db_pwd" # Create the database - ynh_app_setting_set "$app" psqlpwd "$db_pwd" # Store the password in the app's config -} - -# Create a database and grant privilegies to a user -# -# usage: ynh_psql_create_db db [user [pwd]] -# | arg: db - the database name to create -# | arg: user - the user to grant privilegies -# | arg: pwd - the user password -ynh_psql_create_db() { - db="$1" - user="$2" - pwd="$3" - ynh_psql_create_user "$user" "$pwd" - sudo --login --user=postgres createdb --owner="$user" "$db" -} - -# Drop a database -# -# usage: ynh_psql_drop_db db -# | arg: db - the database name to drop -# | arg: user - the user to drop -ynh_psql_remove_db() { - db="$1" - user="$2" - sudo --login --user=postgres dropdb "$db" - ynh_psql_drop_user "$user" -} - -# Dump a database -# -# example: ynh_psql_dump_db 'roundcube' > ./dump.sql -# -# usage: ynh_psql_dump_db db -# | arg: db - the database name to dump -# | ret: the psqldump output -ynh_psql_dump_db() { - db="$1" - sudo --login --user=postgres pg_dump "$db" -} - - -# Create a user -# -# usage: ynh_psql_create_user user pwd [host] -# | arg: user - the user name to create -ynh_psql_create_user() { - user="$1" - pwd="$2" - sudo --login --user=postgres psql -c"CREATE USER $user WITH PASSWORD '$pwd'" postgres -} - -# Drop a user -# -# usage: ynh_psql_drop_user user -# | arg: user - the user name to drop -ynh_psql_drop_user() { - user="$1" - sudo --login --user=postgres dropuser "$user" -} #================================================= # FUTURE OFFICIAL HELPERS #================================================= + diff --git a/scripts/backup b/scripts/backup index 7cb6338..a736e01 100755 --- a/scripts/backup +++ b/scripts/backup @@ -44,16 +44,10 @@ ynh_backup --src_path="$final_path" #================================================= # BACKUP THE HOME DIR #================================================= -ynh_print_info --message="Backing up nginx web server configuration..." +ynh_print_info --message="Backing up Minetest data..." ynh_backup --src_path="/home/yunohost.app/$app" -#================================================= -# BACKUP THE PHP-FPM CONFIGURATION -#================================================= -ynh_print_info --message="Backing up php-fpm configuration..." - -ynh_backup --src_path="/etc/php/7.0/fpm/pool.d/$app.conf" #================================================= # BACKUP THE POSTGRESQL DATABASE diff --git a/scripts/change_url b/scripts/change_url new file mode 100644 index 0000000..10fe9e2 --- /dev/null +++ b/scripts/change_url @@ -0,0 +1,69 @@ +#!/bin/bash + +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# RETRIEVE ARGUMENTS +#================================================= + +old_domain=$YNH_APP_OLD_DOMAIN + +new_domain=$YNH_APP_NEW_DOMAIN + +app=$YNH_APP_INSTANCE_NAME + +#================================================= +# LOAD SETTINGS +#================================================= +ynh_print_info --message="Loading installation settings..." + +# Needed for helper "ynh_add_nginx_config" +final_path=$(ynh_app_setting_get --app=$app --key=final_path) + +# Add settings here as needed by your application +#db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd) + +#================================================= +# CHECK WHICH PARTS SHOULD BE CHANGED +#================================================= + +change_domain=0 +if [ "$old_domain" != "$new_domain" ] +then + change_domain=1 +fi + +change_path=0 + +#================================================= +# STANDARD MODIFICATIONS +#================================================= +#================================================= +# SPECIFIC MODIFICATIONS +#================================================= +ynh_print_info --message="Stop Minetest..." +systemctl stop minetest +ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="/home/yunohost.app/minetest/.minetest/minetest.conf" + +#================================================= +# GENERIC FINALISATION +#================================================= +# RELOAD MINETEST +#================================================= +ynh_print_info --message="Reloading Minetest..." + +systemctl start minetest + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_print_info --message="Change of URL completed for $app" diff --git a/scripts/install b/scripts/install index 208e1b7..5c565f3 100755 --- a/scripts/install +++ b/scripts/install @@ -22,7 +22,7 @@ ynh_abort_if_errors domain=$YNH_APP_ARG_DOMAIN is_public=$YNH_APP_ARG_IS_PUBLIC -postgresql=$YNH_APP_ARG_POSTGRESQL +use_postgresql=$YNH_APP_ARG_USE_POSTGRESQL pvp=$YNH_APP_ARG_PVP creative=$YNH_APP_ARG_CREATIVE damage=$YNH_APP_ARG_DAMAGE @@ -60,7 +60,7 @@ ynh_print_info --message="Storing installation settings..." ynh_app_setting_set --app=$app --key=domain --value=$domain ynh_app_setting_set --app=$app --key=is_public --value=$is_public -ynh_app_setting_set --app=$app --key=postgresql --value=$postgresql +ynh_app_setting_set --app=$app --key=use_postgresql --value=$use_postgresql ynh_app_setting_set --app=$app --key=pvp --value=$pvp ynh_app_setting_set --app=$app --key=creative --value=$creative ynh_app_setting_set --app=$app --key=damage --value=$damage @@ -101,7 +101,7 @@ ynh_install_app_dependencies $pkg_dependencies #================================================= # CREATE A POSTGRESQL DATABASE #================================================= -if [ $postgresql -eq 1 ] +if [ $use_postgresql -eq 1 ] then ynh_print_info --message="Creating a PostgreSQL database..." @@ -141,8 +141,15 @@ home_path=/home/yunohost.app/$app #================================================= # COPY CONFIG FILE #================================================= + +if [ -e /home/yunohost.app/$app ] +then +echo "Nothing to do..." +else mkdir -p /home/yunohost.app/$app/.minetest/ mkdir /home/yunohost.app/$app/.minetest/worlds/ +fi + cp -a ../conf/minetest.conf /home/yunohost.app/$app/.minetest/ #================================================= @@ -171,14 +178,14 @@ ynh_add_systemd_config cd /opt/yunohost/$app # Download Minetest Game git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game -b stable-5 -if [ $postgresql -eq 1 ] +if [ $use_postgresql -eq 1 ] then cmake . -DRUN_IN_PLACE=TRUE -DENABLE_POSTGRESQL=TRUE -DPostgreSQL_TYPE_INCLUDE_DIR=/usr/include/postgresql/ -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE else cmake . -DRUN_IN_PLACE=TRUE -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE fi -make -j 2 +make -j$(nproc) #================================================= @@ -201,11 +208,19 @@ ynh_replace_string --match_string="__DAMAGE__" --replace_string="$damage" --targ # CREATE WORLD #================================================= +# Create logs dir +if [ -e /var/log/$app ] +then +echo "Nothing to do..." +else +mkdir /var/log/$app +fi + # Set permissions on logs chown -R minetest:minetest /var/log/minetest systemctl start minetest -if [ $postgresql -eq 1 ] +if [ $use_postgresql -eq 1 ] then systemctl stop minetest echo "pgsql_connection = host=127.0.0.1 user=$db_user password=$db_pwd dbname=$db_name" > $home_path/.minetest/worlds/world/world.mt @@ -275,8 +290,7 @@ yunohost service add $app --log "/var/log/$app/$app.log" #================================================= ynh_print_info --message="Reloading minetest..." -systemctl restart minetest -ynh_systemd_action -l "Server for gameid="minetest" listening on :::30000." -p "systemd" +ynh_systemd_action --action=restart --line_match="Server for gameid=minetest listening on :::30000." --log_path="/var/log/minetest/minetest.log" sleep 1 #================================================= diff --git a/scripts/remove b/scripts/remove index 1f2660b..cf239de 100755 --- a/scripts/remove +++ b/scripts/remove @@ -21,7 +21,7 @@ port=$(ynh_app_setting_get --app=$app --key=port) db_name=$(ynh_app_setting_get --app=$app --key=db_name) db_user=$db_name final_path=$(ynh_app_setting_get --app=$app --key=final_path) -postgresql=$(ynh_app_setting_get --app=$app --key=postgresql) +use_postgresql=$(ynh_app_setting_get --app=$app --key=use_postgresql) #================================================= # STANDARD REMOVE @@ -47,7 +47,7 @@ ynh_remove_systemd_config #================================================= # REMOVE THE POSTGRESQL DATABASE #================================================= -if [ $postgresql -eq 1 ] +if [ $use_postgresql -eq 1 ] then ynh_print_info --message="Removing the PostgreSQL database" diff --git a/scripts/upgrade b/scripts/upgrade index 646833b..68847d6 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,9 +1,7 @@ #!/bin/bash -# Exit on command errors and treat unset variables as an error -set -eu #================================================= -# GENERIC STARTING +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -14,28 +12,152 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -pvp=$(ynh_app_setting_get $app pvp) -damage=$(ynh_app_setting_get $app damage) -domain=$(ynh_app_setting_get $app domain) -creative=$(ynh_app_setting_get $app creative) -is_public=$(ynh_app_setting_get $app is_public) +domain=$(ynh_app_setting_get --app=$app --key=domain) +is_public=$(ynh_app_setting_get --app=$app --key=is_public) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +use_postgresql=$(ynh_app_setting_get --app=$app --key=use_postgresql) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) + +#================================================= +# ENSURE DOWNWARD COMPATIBILITY +#================================================= +ynh_print_info --message="Ensuring downward compatibility..." + +# Fix is_public as a boolean value +if [ "$is_public" = "Yes" ]; then + ynh_app_setting_set --app=$app --key=is_public --value=1 + is_public=1 +elif [ "$is_public" = "No" ]; then + ynh_app_setting_set --app=$app --key=is_public --value=0 + is_public=0 +fi + +# If db_name doesn't exist, create it +if [ -z $db_name ]; then + db_name=$(ynh_sanitize_dbid --db_name=$app) + ynh_app_setting_set --app=$app --key=db_name --value=$db_name +fi + +# If final_path doesn't exist, create it +if [ -z $final_path ]; then + final_path=/var/www/$app + ynh_app_setting_set --app=$app --key=final_path --value=$final_path +fi #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= +ynh_print_info --message="Backing up the app before upgrading (may take a while)..." + # Backup the current version of the app ynh_backup_before_upgrade ynh_clean_setup () { - # restore it if the upgrade fails - ynh_restore_upgradebackup + # restore it if the upgrade fails + ynh_restore_upgradebackup } # Exit if an error occurs during the execution of the script ynh_abort_if_errors +#================================================= +# CHECK THE PATH +#================================================= + +# Normalize the URL path syntax +# N.B. : this is for app installations before YunoHost 2.7 +# where this value might be something like /foo/ or foo/ +# instead of /foo .... +# If nobody installed your app before 2.7, then you may +# safely remove this line +path_url=$(ynh_normalize_url_path --path_url=/) + #================================================= # STANDARD UPGRADE STEPS #================================================= -# nothing yet +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= +ynh_print_info --message="Upgrading source files..." + +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source --dest_dir="$final_path" + +#================================================= +# UPGRADE DEPENDENCIES +#================================================= +ynh_print_info --message="Upgrading dependencies..." + +ynh_install_app_dependencies $pkg_dependencies + +#================================================= +# CREATE DEDICATED USER +#================================================= +ynh_print_info --message="Making sure dedicated system user exists..." + +# Create a dedicated user (if not existing) +ynh_system_user_create --username=$app --home_dir=/home/yunohost.app/$app --use_shell +$home_path=/home/yunohost.app/$app + +#================================================= +# SETUP SYSTEMD +#================================================= +ynh_print_info --message="Upgrading systemd configuration..." + +# Create a dedicated systemd config +ynh_add_systemd_config + +#================================================= +# SPECIFIC UPGRADE +#================================================= +# Compile Minetest +cd /opt/yunohost/$app +# Download Minetest Game +git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game -b stable-5 +if [ $use_postgresql -eq 1 ] +then +cmake . -DRUN_IN_PLACE=TRUE -DENABLE_POSTGRESQL=TRUE -DPostgreSQL_TYPE_INCLUDE_DIR=/usr/include/postgresql/ -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE +else +cmake . -DRUN_IN_PLACE=TRUE -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE +fi + +make -j 2 + +### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script. +### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it. +ynh_backup_if_checksum_is_different --file="$final_path/CONFIG_FILE" +# Recalculate and store the checksum of the file for the next upgrade. +ynh_store_file_checksum --file="$home_path/.minetest/minetest.conf" + +#================================================= +# SETUP LOGROTATE +#================================================= +ynh_print_info --message="Upgrading logrotate configuration..." + +# Use logrotate to manage app-specific logfile(s) +ynh_use_logrotate --non-append + + + +#================================================= +# GENERIC FINALIZATION +#================================================= +# SECURE FILES AND DIRECTORIES +#================================================= + +# Set permissions on app files +chown -R root: $final_path + +#================================================= +# RELOAD NGINX +#================================================= +ynh_print_info --message="Reloading nginx web server..." + +systemctl reload nginx + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_print_info --message="Upgrade of $app completed" From f237277d78b8ddd4a0eb4d77cbf522b597be71aa Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Tue, 22 Oct 2019 17:52:18 +0200 Subject: [PATCH 03/29] Remove postgresql support --- check_process | 42 +++--------------------------------------- scripts/_common.sh | 2 +- scripts/backup | 13 ------------- scripts/install | 32 +------------------------------- scripts/remove | 14 -------------- scripts/restore | 15 --------------- scripts/upgrade | 24 ++++++------------------ 7 files changed, 11 insertions(+), 131 deletions(-) diff --git a/check_process b/check_process index 3d54604..4fa4ee6 100644 --- a/check_process +++ b/check_process @@ -3,10 +3,9 @@ # Move this file from check_process.default to check_process when you have filled it. -;; Test complet sans postgresql +;; Test complet ; Manifest domain="domain.tld" (DOMAIN) - use_postgresql=0 pvp=1 servername="packagecheck" creative=0 @@ -26,46 +25,11 @@ multi_instance=0 incorrect_path=0 port_already_use=1 - change_url=0 - -;; Test complet avec postgresql - ; Manifest - domain="domain.tld" (DOMAIN) - use_postgresql=1 - pvp=1 - servername="packagecheck" - creative=0 - damage=1 - is_public=0 (PUBLIC|public=1|private=0) - password="pass" - port="30000" (PORT) - ; Checks - pkg_linter=1 - setup_sub_dir=0 - setup_root=0 - setup_nourl=1 - setup_private=0 - setup_public=0 - upgrade=1 - backup_restore=1 - multi_instance=0 - incorrect_path=0 - port_already_use=1 - change_url=0 + change_url=1 ;;; Levels - Level 1=auto - Level 2=auto - Level 3=auto -# Level 4: If the app supports LDAP and SSOwat, turn level 4 to '1' and add a link to an issue or a part of your code to show it. -# If the app does not use LDAP nor SSOwat, and can't use them, turn level 4 to 'na' and explain as well. - Level 4=0 + # If the level 5 (Package linter) is forced to 1. Please add justifications here. Level 5=auto - Level 6=auto - Level 7=auto - Level 8=0 - Level 9=0 - Level 10=0 ;;; Options Email= Notification=none diff --git a/scripts/_common.sh b/scripts/_common.sh index 0d5f16b..2aa7841 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -6,7 +6,7 @@ #================================================= # dependencies used by the app -pkg_dependencies="postgresql postgresql9.6 postgresql-contrib build-essential libirrlicht-dev cmake libbz2-dev libpng-dev libjpeg-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev zlib1g-dev libgmp-dev libjsoncpp-dev libluajit-5.1-dev" +pkg_dependencies="build-essential libirrlicht-dev cmake libbz2-dev libpng-dev libjpeg-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev zlib1g-dev libgmp-dev libjsoncpp-dev libluajit-5.1-dev" #================================================= # PERSONAL HELPERS diff --git a/scripts/backup b/scripts/backup index a736e01..4b6445f 100755 --- a/scripts/backup +++ b/scripts/backup @@ -26,8 +26,6 @@ app=$YNH_APP_INSTANCE_NAME final_path=$(ynh_app_setting_get --app=$app --key=final_path) domain=$(ynh_app_setting_get --app=$app --key=domain) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -postgresql=$(ynh_app_setting_get --app=$app --key=postgresql) #================================================= # STANDARD BACKUP STEPS @@ -48,17 +46,6 @@ ynh_print_info --message="Backing up Minetest data..." ynh_backup --src_path="/home/yunohost.app/$app" - -#================================================= -# BACKUP THE POSTGRESQL DATABASE -#================================================= -if [ $postgresql -eq 1 ] -then -ynh_print_info --message="Backing up the PostgreSQL database..." - -ynh_psql_dump_db --database="$db_name" > db.sql -fi - #================================================= # SPECIFIC BACKUP #================================================= diff --git a/scripts/install b/scripts/install index 5c565f3..37d0376 100755 --- a/scripts/install +++ b/scripts/install @@ -22,7 +22,6 @@ ynh_abort_if_errors domain=$YNH_APP_ARG_DOMAIN is_public=$YNH_APP_ARG_IS_PUBLIC -use_postgresql=$YNH_APP_ARG_USE_POSTGRESQL pvp=$YNH_APP_ARG_PVP creative=$YNH_APP_ARG_CREATIVE damage=$YNH_APP_ARG_DAMAGE @@ -60,7 +59,6 @@ ynh_print_info --message="Storing installation settings..." ynh_app_setting_set --app=$app --key=domain --value=$domain ynh_app_setting_set --app=$app --key=is_public --value=$is_public -ynh_app_setting_set --app=$app --key=use_postgresql --value=$use_postgresql ynh_app_setting_set --app=$app --key=pvp --value=$pvp ynh_app_setting_set --app=$app --key=creative --value=$creative ynh_app_setting_set --app=$app --key=damage --value=$damage @@ -98,23 +96,6 @@ ynh_print_info --message="Installing dependencies..." ### - And the section "UPGRADE DEPENDENCIES" in the upgrade script ynh_install_app_dependencies $pkg_dependencies -#================================================= -# CREATE A POSTGRESQL DATABASE -#================================================= -if [ $use_postgresql -eq 1 ] -then -ynh_print_info --message="Creating a PostgreSQL database..." - -# Create a database, an user and its password. Then store the password in the app's config -# -# After executing this helper, the password of the created database will be available in $db_pwd -# It will also be stored as "psqlpwd" into the app settings. - -ynh_psql_test_if_first_run -db_name=$(ynh_sanitize_dbid $app) -ynh_app_setting_set --app=$app --key=db_name --value=$db_name -ynh_psql_setup_db --db_user=$db_name --db_name=$db_name -fi #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -178,12 +159,8 @@ ynh_add_systemd_config cd /opt/yunohost/$app # Download Minetest Game git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game -b stable-5 -if [ $use_postgresql -eq 1 ] -then -cmake . -DRUN_IN_PLACE=TRUE -DENABLE_POSTGRESQL=TRUE -DPostgreSQL_TYPE_INCLUDE_DIR=/usr/include/postgresql/ -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE -else + cmake . -DRUN_IN_PLACE=TRUE -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE -fi make -j$(nproc) @@ -220,13 +197,6 @@ fi chown -R minetest:minetest /var/log/minetest systemctl start minetest -if [ $use_postgresql -eq 1 ] -then -systemctl stop minetest -echo "pgsql_connection = host=127.0.0.1 user=$db_user password=$db_pwd dbname=$db_name" > $home_path/.minetest/worlds/world/world.mt -sleep 5 -/opt/yunohost/$app/bin/minetestserver --migrate postgresql --world $home_path/.minetest/worlds/world -fi #================================================= # STORE THE CONFIG FILE CHECKSUM diff --git a/scripts/remove b/scripts/remove index cf239de..2ddd271 100755 --- a/scripts/remove +++ b/scripts/remove @@ -18,10 +18,7 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) port=$(ynh_app_setting_get --app=$app --key=port) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name final_path=$(ynh_app_setting_get --app=$app --key=final_path) -use_postgresql=$(ynh_app_setting_get --app=$app --key=use_postgresql) #================================================= # STANDARD REMOVE @@ -44,17 +41,6 @@ ynh_print_info --message="Stopping and removing the systemd service" # Remove the dedicated systemd config ynh_remove_systemd_config -#================================================= -# REMOVE THE POSTGRESQL DATABASE -#================================================= -if [ $use_postgresql -eq 1 ] -then -ynh_print_info --message="Removing the PostgreSQL database" - -# Remove a database if it exists, along with the associated user -ynh_psql_remove_db --user=$db_user --db=$db_name -fi - #================================================= # REMOVE DEPENDENCIES #================================================= diff --git a/scripts/restore b/scripts/restore index a83c87b..d2b3cc4 100755 --- a/scripts/restore +++ b/scripts/restore @@ -27,8 +27,6 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) path_url=$(ynh_app_setting_get --app=$app --key=path) final_path=$(ynh_app_setting_get --app=$app --key=final_path) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -postgresql=$(ynh_app_setting_get --app=$app --key=postgresql) home_path=$(ynh_app_setting_get --app=$app --key=home_path) #================================================= @@ -81,19 +79,6 @@ ynh_print_info --message="Reinstalling dependencies..." # Define and install dependencies ynh_install_app_dependencies $pkg_dependencies -#================================================= -# RESTORE THE POSTGRESQL DATABASE -#================================================= -if [ $postgresql -eq 1 ] -then -ynh_print_info --message="Restoring the PostgreSQL database..." - -ynh_psql_test_if_first_run -db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) -ynh_psql_setup_db --db_user=$db_name --db_name=$db_name --db_pwd=$db_pwd -ynh_psql_connect_as --user=$db_name --password=$db_pwd --database=$db_name < ./db.sql -fi - #================================================= # RESTORE SYSTEMD #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 68847d6..f87799e 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -19,8 +19,6 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) is_public=$(ynh_app_setting_get --app=$app --key=is_public) final_path=$(ynh_app_setting_get --app=$app --key=final_path) -use_postgresql=$(ynh_app_setting_get --app=$app --key=use_postgresql) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) #================================================= # ENSURE DOWNWARD COMPATIBILITY @@ -36,12 +34,6 @@ elif [ "$is_public" = "No" ]; then is_public=0 fi -# If db_name doesn't exist, create it -if [ -z $db_name ]; then - db_name=$(ynh_sanitize_dbid --db_name=$app) - ynh_app_setting_set --app=$app --key=db_name --value=$db_name -fi - # If final_path doesn't exist, create it if [ -z $final_path ]; then final_path=/var/www/$app @@ -115,14 +107,10 @@ ynh_add_systemd_config cd /opt/yunohost/$app # Download Minetest Game git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game -b stable-5 -if [ $use_postgresql -eq 1 ] -then -cmake . -DRUN_IN_PLACE=TRUE -DENABLE_POSTGRESQL=TRUE -DPostgreSQL_TYPE_INCLUDE_DIR=/usr/include/postgresql/ -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE -else -cmake . -DRUN_IN_PLACE=TRUE -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE -fi -make -j 2 +cmake . -DRUN_IN_PLACE=TRUE -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE + +make -j$(nproc) ### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script. ### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it. @@ -150,11 +138,11 @@ ynh_use_logrotate --non-append chown -R root: $final_path #================================================= -# RELOAD NGINX +# RELOAD MINETEST #================================================= -ynh_print_info --message="Reloading nginx web server..." +ynh_print_info --message="Restarting Minetest..." -systemctl reload nginx +systemctl restart minetest #================================================= # END OF SCRIPT From 5411cc919dc18e765a143f20e352b7a9457384b1 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Tue, 22 Oct 2019 17:59:55 +0200 Subject: [PATCH 04/29] Upgrade to 5.1.0 --- conf/app.src | 4 ++-- manifest.json | 13 ++----------- 2 files changed, 4 insertions(+), 13 deletions(-) diff --git a/conf/app.src b/conf/app.src index 400dd84..0f06741 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/minetest/minetest/archive/5.0.1.tar.gz -SOURCE_SUM=aa771cf178ad1b436d5723e5d6dd24e42b5d56f1cfe9c930f6426b7f24bb1635 +SOURCE_URL=https://github.com/minetest/minetest/archive/5.1.0.tar.gz +SOURCE_SUM=ca53975eecf6a39383040658f41d697c8d7f8d5fe9176460f564979c73b53906 SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=tar.gz SOURCE_IN_SUBDIR=true diff --git a/manifest.json b/manifest.json index 533ad0c..d5734f4 100644 --- a/manifest.json +++ b/manifest.json @@ -1,7 +1,7 @@ { "name": "Minetest", "id": "minetest", - "version": "0.01", + "version": "5.1.0~ynh1", "packaging_format": 1, "description": { "en": "Minetest is a free, open source voxel game engine and game. Fully extendable. Need a client to connect to the server.", @@ -24,7 +24,7 @@ }, "multi_instance": false, "services": [ - "minetest" + "nginx" ], "arguments": { "install" : [ @@ -46,15 +46,6 @@ }, "default": false }, - { - "name": "use_postgresql", - "type": "boolean", - "ask": { - "en": "Do you want to use PostgreSQL? (more powerful but uses more disk space)", - "fr": "Est-ce que vous voulez utiliser PostgreSQL ? (plus puissant mais utilise plus d'espace disque)" - }, - "default": true - }, { "name": "servername", "type": "string", From 2e637ea33175f4dec1c06ef8ca3a93ff1b7d5b92 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Tue, 22 Oct 2019 18:03:41 +0200 Subject: [PATCH 05/29] Fix home_path --- scripts/upgrade | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/upgrade b/scripts/upgrade index f87799e..1097642 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -19,6 +19,7 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) is_public=$(ynh_app_setting_get --app=$app --key=is_public) final_path=$(ynh_app_setting_get --app=$app --key=final_path) +home_path=$(ynh_app_setting_get --app=$app --key=home_path) #================================================= # ENSURE DOWNWARD COMPATIBILITY @@ -90,7 +91,6 @@ ynh_print_info --message="Making sure dedicated system user exists..." # Create a dedicated user (if not existing) ynh_system_user_create --username=$app --home_dir=/home/yunohost.app/$app --use_shell -$home_path=/home/yunohost.app/$app #================================================= # SETUP SYSTEMD From 97b8c913ffaf59940dde58cdedc37c06c3c74e98 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Tue, 22 Oct 2019 18:06:56 +0200 Subject: [PATCH 06/29] Remove path_url from restore --- scripts/restore | 1 - 1 file changed, 1 deletion(-) diff --git a/scripts/restore b/scripts/restore index d2b3cc4..7b175f9 100755 --- a/scripts/restore +++ b/scripts/restore @@ -25,7 +25,6 @@ ynh_print_info --message="Loading settings..." app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) final_path=$(ynh_app_setting_get --app=$app --key=final_path) home_path=$(ynh_app_setting_get --app=$app --key=home_path) From c47995c400a1beec02b28de859bee04ba8040d9c Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Tue, 22 Oct 2019 18:27:38 +0200 Subject: [PATCH 07/29] Fix readme --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2a38a28..3fe1517 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# Minetest app for YunoHost +# Minetest for YunoHost [![Integration level](https://dash.yunohost.org/integration/minetest.svg)](https://dash.yunohost.org/appci/app/minetest) -[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=minetest) + +[![Install Minetest with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=minetest) *[Lire ce readme en français.](./README_fr.md)* @@ -11,7 +12,7 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to ## Overview Minetest is a free open-source voxel game engine with easy modding and game creation. -**Shipped version:** 5.0.1 +**Shipped version:** 5.1.0 ## Screenshots @@ -35,6 +36,7 @@ How to configure this app: by SSH #### Multi-users support Are LDAP and HTTP auth supported? No + Can the app be used by multiple users? Yes #### Supported architectures @@ -58,6 +60,14 @@ You can't migrate directly with an update. * Copy the folder you have copied before in `/home/yunohost.app/minetest/.minetest/worlds` * Start the Minetest service `sudo systemctl start minetest` +* Installing mods + * For installing mods you need to create a mods folder in /home/yunohost.app/minetest/.minetest + * Clone the repo of the mod in this folder (ex: git clone https://github.com/minetest-mods/mesecons) + * Edit /home/yunohost.app/minetest/.minetest/worlds/world/world.mt and add at the end ```load_mod_mesecons = true``` + * Restart Minetest with ```sudo systemctl restart minetest``` + * The mod is now installed :) + + **More information on the documentation page:** https://yunohost.org/packaging_apps From e2e7b9082d3102e2185f2bb439402fbf0d4db893 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Tue, 22 Oct 2019 18:40:18 +0200 Subject: [PATCH 08/29] Fixed upgrade and restore --- scripts/restore | 3 +-- scripts/upgrade | 15 +++------------ 2 files changed, 4 insertions(+), 14 deletions(-) diff --git a/scripts/restore b/scripts/restore index 7b175f9..49b3cb6 100755 --- a/scripts/restore +++ b/scripts/restore @@ -33,8 +33,7 @@ home_path=$(ynh_app_setting_get --app=$app --key=home_path) #================================================= ynh_print_info --message="Validating restoration parameters..." -ynh_webpath_available --domain=$domain \ - || ynh_die --message="Path not available: ${domain}" +ynh_webpath_register --app=$app --domain=$domain --path_url=/ test ! -d $final_path \ || ynh_die --message="There is already a directory: $final_path " diff --git a/scripts/upgrade b/scripts/upgrade index 1097642..26dafe5 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -55,18 +55,6 @@ ynh_clean_setup () { # Exit if an error occurs during the execution of the script ynh_abort_if_errors -#================================================= -# CHECK THE PATH -#================================================= - -# Normalize the URL path syntax -# N.B. : this is for app installations before YunoHost 2.7 -# where this value might be something like /foo/ or foo/ -# instead of /foo .... -# If nobody installed your app before 2.7, then you may -# safely remove this line -path_url=$(ynh_normalize_url_path --path_url=/) - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -74,6 +62,9 @@ path_url=$(ynh_normalize_url_path --path_url=/) #================================================= ynh_print_info --message="Upgrading source files..." +# Remove old install +ynh_secure_remove --file="$final_path" + # Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$final_path" From f1a7402f375a17258ecd63a51e49c2e6ede77818 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Wed, 23 Oct 2019 11:16:32 +0200 Subject: [PATCH 09/29] Fix restore --- check_process | 2 +- scripts/restore | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/check_process b/check_process index 4fa4ee6..f8d85fb 100644 --- a/check_process +++ b/check_process @@ -25,7 +25,7 @@ multi_instance=0 incorrect_path=0 port_already_use=1 - change_url=1 + change_url=0 ;;; Levels # If the level 5 (Package linter) is forced to 1. Please add justifications here. diff --git a/scripts/restore b/scripts/restore index 49b3cb6..238e74a 100755 --- a/scripts/restore +++ b/scripts/restore @@ -26,7 +26,6 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) final_path=$(ynh_app_setting_get --app=$app --key=final_path) -home_path=$(ynh_app_setting_get --app=$app --key=home_path) #================================================= # CHECK IF THE APP CAN BE RESTORED @@ -65,7 +64,7 @@ ynh_restore_file --origin_path="$home_path" # Restore permissions on app files chown -R root: $final_path -chown -R minetest: $home_path +chown -R minetest: /home/yunohost.app/minetest #================================================= # SPECIFIC RESTORATION From 9a03ac105ff32e0822bc861dad0c74568ef41c56 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Wed, 23 Oct 2019 12:06:42 +0200 Subject: [PATCH 10/29] Fixes --- README.md | 2 +- check_process | 2 +- conf/README_fr.md | 93 ++++++++++++++++++++++++++++++++++++++++++ conf/minetest.conf | 2 +- conf/minetest_game.src | 6 +++ conf/systemd.service | 8 ++-- manifest.json | 2 +- scripts/backup | 4 +- scripts/change_url | 6 +-- scripts/install | 14 ++++--- scripts/restore | 6 +-- scripts/upgrade | 35 +++++++++++++--- 12 files changed, 153 insertions(+), 27 deletions(-) create mode 100644 conf/README_fr.md create mode 100644 conf/minetest_game.src diff --git a/README.md b/README.md index 3fe1517..45233b4 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ You can't migrate directly with an update. * Start the Minetest service `sudo systemctl start minetest` * Installing mods - * For installing mods you need to create a mods folder in /home/yunohost.app/minetest/.minetest + * For installing mods you need to create a worldmods folder in /home/yunohost.app/minetest/.minetest/worlds/world/. * Clone the repo of the mod in this folder (ex: git clone https://github.com/minetest-mods/mesecons) * Edit /home/yunohost.app/minetest/.minetest/worlds/world/world.mt and add at the end ```load_mod_mesecons = true``` * Restart Minetest with ```sudo systemctl restart minetest``` diff --git a/check_process b/check_process index f8d85fb..b05c831 100644 --- a/check_process +++ b/check_process @@ -22,7 +22,7 @@ setup_public=0 upgrade=1 backup_restore=1 - multi_instance=0 + multi_instance=1 incorrect_path=0 port_already_use=1 change_url=0 diff --git a/conf/README_fr.md b/conf/README_fr.md new file mode 100644 index 0000000..0992f06 --- /dev/null +++ b/conf/README_fr.md @@ -0,0 +1,93 @@ +# Minetest for YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/minetest.svg)](https://dash.yunohost.org/appci/app/minetest)](https://dash.yunohost.org/appci/app/minetest) + +[![Installer Minetest avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=minetest)(https://install-app.yunohost.org/?app=minetest) + +*[Read this readme in English.](./README.md)* + +> *Ce package vous permet d'installer Minetest rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, veuillez consulter[ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Aperçu +Minetest est un moteur de jeu voxel open-source gratuit avec modding et création de jeu faciles. + +**Version livrée:** 5.1.0 + +## Captures d'écran + +![](https://www.minetest.net/media/gallery/1.jpg) + +## Démo + +Pas de démo mais vous pouvez tester avec des serveurs sur https://servers.minetest.net/ + +## Configuration + +Comment configurer cette application : par SSH + +## Documentation + + * Documentation officielle : https://wiki.minetest.net/ + * Documentation YunoHost : https://yunohost.org/#/minetest + +## Caractéristiques spécifiques de YunoHost + +#### Support multi-utilisateurs + +Les authentifications LDAP et HTTP sont-elles prises en charge ? Non + +L'application peut-elle être utilisée par plusieurs utilisateurs ? Oui + +##### Architectures supportées + +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/minetest%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/minetest/)](https://ci-apps.yunohost.org/ci/apps/minetest/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/minetest%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/minetest/)](https://ci-apps-arm.yunohost.org/ci/apps/minetest/) +* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/minetest%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/minetest/)](https://ci-stretch.nohost.me/ci/apps/minetest/) + +## Limitations + +* Cette application n'est pas compatible avec LDAP. + +## Renseignements supplémentaires + +* Migration de l'ancien paquet +Vous ne pouvez pas migrer directement avec une mise à jour. + * Avant d'installer le nouveau paquetage, vous devez télécharger ce dossier depuis votre serveur `/var/games/minetest-server/.minetest/worlds/world` (ce dossier contient toutes les données mondiales) + * Désinstallez l'ancien paquetage `sudo yunohost application remove minetest`. + * Installez le nouveau `sudo yunohost yunohost application install https://github.com/YunoHost-Apps/minetest_ynh`` + * Stop Minetest service `sudo systemctl systemctl stop minetest` + * Copiez le dossier que vous avez copié auparavant dans `/home/yunohost.app/minetest/.minetest/.worlds'. + * Démarrer le service Minetest `sudo systemctl démarre minetest`. + +* Installer les mods + * Pour installer les mods, vous devez créer un dossier worldmods dans /home/yunohost.app/minetest/.minetest/worlds/world/. + * Cloner le repo du mod dans ce dossier (ex : git clone https://github.com/minetest-mods/mesecons) + * Editez /home/yunohost.app/minetest/.minetest/worlds/world/world/world.mt et ajoutez à la fin ````load_mod_mesecons = true```. + * Redémarrer Minetest avec ```sudo systemctl restart minetest``` + * Le mod est maintenant installé :) + + +**Plus d'informations sur la page documentation:** +https://yunohost.org/packaging_apps + +## Liens + + * Signaler un bug : https://github.com/YunoHost-Apps/minetest_ynh/issues + * Site Web de l'application : https://minetest.net/ + * Site web de YunoHost : https://yunohost.org/ + +--- + +Infos développeurs +---------------- + +**Uniquement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans le master.** +Veuillez faire votre demande de tirage à la[succursale de test] (https://github.com/YunoHost-Apps/minetest_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost installent l'application https://github.com/YunoHost-Apps/minetest_ynh/tree/testing --debug +ou +sudo yunohost mise à jour de l'application minetest -u https://github.com/YunoHost-Apps/minetest_ynh/tree/testing --debug +``` \ No newline at end of file diff --git a/conf/minetest.conf b/conf/minetest.conf index 2db8b34..b76f8a2 100644 --- a/conf/minetest.conf +++ b/conf/minetest.conf @@ -41,7 +41,7 @@ serverlist_url = servers.minetest.net default_game = minetest # World directory (everything in the world is stored here) -map-dir = /home/yunohost.app/minetest/.minetest/worlds/world +map-dir = /home/yunohost.app/__APP__/.minetest/worlds/world # Message of the Day motd = Welcome to Minetest. Enjoy your stay! diff --git a/conf/minetest_game.src b/conf/minetest_game.src new file mode 100644 index 0000000..f7da171 --- /dev/null +++ b/conf/minetest_game.src @@ -0,0 +1,6 @@ +SOURCE_URL=https://github.com/minetest/minetest_game/archive/5.1.0.tar.gz +SOURCE_SUM=f165fac0081bf4797cf9094282cc25034b2347b3ea94e6bb8d9329c5ee63f41b +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=tar.gz +SOURCE_IN_SUBDIR=false +SOURCE_FILENAME=minetest_game-5.1.0.tar.gz \ No newline at end of file diff --git a/conf/systemd.service b/conf/systemd.service index 7d2d9b8..c9e53e2 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -2,11 +2,11 @@ Description=Minetest multiplayer server minetest.conf server config Documentation=man:minetestserver(6) After=network.target -RequiresMountsFor=/home/yunohost.app/minetest +RequiresMountsFor=/home/yunohost.app/__APP__ [Service] Restart=on-failure -User=minetest -Group=minetest -ExecStart=/opt/yunohost/minetest/bin/minetestserver --config /home/yunohost.app/minetest/.minetest/minetest.conf --logfile /var/log/minetest/minetest.log +User=__APP__ +Group=__APP__ +ExecStart=__FINALPATH__/bin/minetestserver --config /home/yunohost.app/__APP__/.minetest/minetest.conf --logfile /var/log/__APP__/minetest.log [Install] WantedBy=multi-user.target diff --git a/manifest.json b/manifest.json index d5734f4..35dda9b 100644 --- a/manifest.json +++ b/manifest.json @@ -22,7 +22,7 @@ "requirements": { "yunohost": ">= 3.5" }, - "multi_instance": false, + "multi_instance": true, "services": [ "nginx" ], diff --git a/scripts/backup b/scripts/backup index 4b6445f..f81bbf5 100755 --- a/scripts/backup +++ b/scripts/backup @@ -33,7 +33,7 @@ domain=$(ynh_app_setting_get --app=$app --key=domain) # BACKUP THE APP MAIN DIR #================================================= # Stop Minetest before backup... -systemctl stop minetest +systemctl stop $app ynh_print_info --message="Backing up the main app directory..." @@ -66,6 +66,6 @@ ynh_backup --src_path="/etc/systemd/system/$app.service" # END OF SCRIPT #================================================= # Restart Minetest -systemctl start minetest +systemctl start $app ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." diff --git a/scripts/change_url b/scripts/change_url index 10fe9e2..776d535 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -50,8 +50,8 @@ change_path=0 # SPECIFIC MODIFICATIONS #================================================= ynh_print_info --message="Stop Minetest..." -systemctl stop minetest -ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="/home/yunohost.app/minetest/.minetest/minetest.conf" +systemctl stop $app +ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="/home/yunohost.app/$app/.minetest/minetest.conf" #================================================= # GENERIC FINALISATION @@ -60,7 +60,7 @@ ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" - #================================================= ynh_print_info --message="Reloading Minetest..." -systemctl start minetest +systemctl start $app #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 37d0376..229489f 100755 --- a/scripts/install +++ b/scripts/install @@ -156,14 +156,15 @@ ynh_add_systemd_config # SPECIFIC SETUP #================================================= # Compile Minetest -cd /opt/yunohost/$app +pushd /opt/yunohost/$app # Download Minetest Game -git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game -b stable-5 +ynh_setup_source --dest_dir=/opt/yunohost/$app/games/minetest_game --source_id=minetest_game cmake . -DRUN_IN_PLACE=TRUE -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE make -j$(nproc) +popd #================================================= # MODIFY A CONFIG FILE @@ -172,6 +173,7 @@ make -j$(nproc) ### `ynh_replace_string` is used to replace a string in a file. ### (It's compatible with sed regular expressions syntax) +ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__SERVERNAME__" --replace_string="$servername" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$home_path/.minetest/minetest.conf" @@ -194,9 +196,9 @@ mkdir /var/log/$app fi # Set permissions on logs -chown -R minetest:minetest /var/log/minetest +chown -R $app:$app /var/log/$app -systemctl start minetest +systemctl start $app #================================================= # STORE THE CONFIG FILE CHECKSUM @@ -221,7 +223,7 @@ ynh_store_file_checksum --file="$home_path/.minetest/minetest.conf" # Set permissions to app files chown -R root: $final_path -chown -R minetest: $home_path +chown -R $app: $home_path #================================================= # SETUP LOGROTATE @@ -260,7 +262,7 @@ yunohost service add $app --log "/var/log/$app/$app.log" #================================================= ynh_print_info --message="Reloading minetest..." -ynh_systemd_action --action=restart --line_match="Server for gameid=minetest listening on :::30000." --log_path="/var/log/minetest/minetest.log" +ynh_systemd_action --action=restart --line_match="Server for gameid=minetest listening on :::30000." --log_path="/var/log/$app/minetest.log" sleep 1 #================================================= diff --git a/scripts/restore b/scripts/restore index 238e74a..17af4e3 100755 --- a/scripts/restore +++ b/scripts/restore @@ -64,7 +64,7 @@ ynh_restore_file --origin_path="$home_path" # Restore permissions on app files chown -R root: $final_path -chown -R minetest: /home/yunohost.app/minetest +chown -R $app: /home/yunohost.app/$app #================================================= # SPECIFIC RESTORATION @@ -104,8 +104,8 @@ ynh_restore_file --origin_path="/etc/logrotate.d/$app" #================================================= ynh_print_info --message="Reloading minetest..." -systemctl restart minetest -ynh_systemd_action -l "ACTION[Main]: Server for gameid="minetest" listening on 0.0.0.0:30000." -p "/var/log/minetest/minetest.log" +systemctl restart $app +ynh_systemd_action -l "ACTION[Main]: Server for gameid="minetest" listening on 0.0.0.0:30000." -p "/var/log/$app/minetest.log" sleep 1 #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 26dafe5..5962e1f 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -17,9 +17,15 @@ ynh_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) +port=$(ynh_app_setting_get --app=$app --key=port) is_public=$(ynh_app_setting_get --app=$app --key=is_public) final_path=$(ynh_app_setting_get --app=$app --key=final_path) home_path=$(ynh_app_setting_get --app=$app --key=home_path) +pvp=$(ynh_app_setting_get --app=$app --key=pvp) +creative=$(ynh_app_setting_get --app=$app --key=creative) +damage=$(ynh_app_setting_get --app=$app --key=damage) +servername=$(ynh_app_setting_get --app=$app --key=servername) + #================================================= # ENSURE DOWNWARD COMPATIBILITY @@ -37,7 +43,7 @@ fi # If final_path doesn't exist, create it if [ -z $final_path ]; then - final_path=/var/www/$app + final_path=/opt/yunohost/$app ynh_app_setting_set --app=$app --key=final_path --value=$final_path fi @@ -95,20 +101,38 @@ ynh_add_systemd_config # SPECIFIC UPGRADE #================================================= # Compile Minetest -cd /opt/yunohost/$app +pushd /opt/yunohost/$app # Download Minetest Game -git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game -b stable-5 +ynh_setup_source --dest_dir=/opt/yunohost/$app/games/minetest_game --source_id=minetest_game cmake . -DRUN_IN_PLACE=TRUE -DENABLE_LUAJIT=TRUE -DBUILD_CLIENT=FALSE -DBUILD_SERVER=TRUE make -j$(nproc) +popd + ### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script. ### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it. -ynh_backup_if_checksum_is_different --file="$final_path/CONFIG_FILE" +ynh_backup_if_checksum_is_different --file="$home_path/.minetest/minetest.conf" # Recalculate and store the checksum of the file for the next upgrade. ynh_store_file_checksum --file="$home_path/.minetest/minetest.conf" +#================================================= +# MODIFY A CONFIG FILE +#================================================= + +### `ynh_replace_string` is used to replace a string in a file. +### (It's compatible with sed regular expressions syntax) + +ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__SERVERNAME__" --replace_string="$servername" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__ANNOUNCE__" --replace_string="$is_public" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__PVP__" --replace_string="$pvp" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__CREATIVE__" --replace_string="$creative" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__DAMAGE__" --replace_string="$damage" --target_file="$home_path/.minetest/minetest.conf" + #================================================= # SETUP LOGROTATE #================================================= @@ -127,13 +151,14 @@ ynh_use_logrotate --non-append # Set permissions on app files chown -R root: $final_path +chown -R $app: $home_path #================================================= # RELOAD MINETEST #================================================= ynh_print_info --message="Restarting Minetest..." -systemctl restart minetest +systemctl restart $app #================================================= # END OF SCRIPT From f6333383c09127da09a36608c4e10dedc45a9a82 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Wed, 23 Oct 2019 12:23:32 +0200 Subject: [PATCH 11/29] Fix README_fr.md --- conf/README_fr.md => README_fr.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) rename conf/README_fr.md => README_fr.md (87%) diff --git a/conf/README_fr.md b/README_fr.md similarity index 87% rename from conf/README_fr.md rename to README_fr.md index 0992f06..6fc952b 100644 --- a/conf/README_fr.md +++ b/README_fr.md @@ -1,13 +1,13 @@ # Minetest for YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/minetest.svg)](https://dash.yunohost.org/appci/app/minetest)](https://dash.yunohost.org/appci/app/minetest) +[![Niveau d'intégration](https://dash.yunohost.org/integration/minetest.svg)](https://dash.yunohost.org/appci/app/minetest) -[![Installer Minetest avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=minetest)(https://install-app.yunohost.org/?app=minetest) +[![Installer Minetest avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=minetest) *[Read this readme in English.](./README.md)* > *Ce package vous permet d'installer Minetest rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, veuillez consulter[ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* +Si vous n'avez pas YunoHost, veuillez consulter [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Aperçu Minetest est un moteur de jeu voxel open-source gratuit avec modding et création de jeu faciles. @@ -41,9 +41,9 @@ L'application peut-elle être utilisée par plusieurs utilisateurs ? Oui ##### Architectures supportées -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/minetest%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/minetest/)](https://ci-apps.yunohost.org/ci/apps/minetest/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/minetest%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/minetest/)](https://ci-apps-arm.yunohost.org/ci/apps/minetest/) -* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/minetest%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/minetest/)](https://ci-stretch.nohost.me/ci/apps/minetest/) +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/minetest%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/minetest/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/minetest%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/minetest/) +* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/minetest%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/minetest/) ## Limitations From 7479885c96c00166658e1df7ab4959dcddf8ac35 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Wed, 23 Oct 2019 13:31:21 +0200 Subject: [PATCH 12/29] Add version check in upgrade --- scripts/upgrade | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/scripts/upgrade b/scripts/upgrade index 5962e1f..0e22561 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -30,6 +30,15 @@ servername=$(ynh_app_setting_get --app=$app --key=servername) #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= +ynh_print_info --message="Checking version..." +version=ynh_app_upstream_version + +if [ "$version" = "0.01" ]; then +then +ynh_die --message="You can't upgrade to this version with simple upgrade. Please read the readme for upgrading https://github.com/YunoHost-Apps/minetest_ynh#additional-information ..." +fi + + ynh_print_info --message="Ensuring downward compatibility..." # Fix is_public as a boolean value @@ -97,6 +106,20 @@ ynh_print_info --message="Upgrading systemd configuration..." # Create a dedicated systemd config ynh_add_systemd_config +#================================================= +# COPY CONFIG FILE +#================================================= + +if [ -e /home/yunohost.app/$app ] +then +echo "Nothing to do..." +else +mkdir -p /home/yunohost.app/$app/.minetest/ +mkdir /home/yunohost.app/$app/.minetest/worlds/ +fi + +cp -a ../conf/minetest.conf /home/yunohost.app/$app/.minetest/ + #================================================= # SPECIFIC UPGRADE #================================================= From 1b1bdbfd8237d9a12da3cd25a07448f3ca160178 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Wed, 23 Oct 2019 14:58:46 +0200 Subject: [PATCH 13/29] Fixed upgrade --- check_process | 2 +- scripts/upgrade | 13 ++++++------- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/check_process b/check_process index b05c831..4fc0316 100644 --- a/check_process +++ b/check_process @@ -25,7 +25,7 @@ multi_instance=1 incorrect_path=0 port_already_use=1 - change_url=0 + change_url=1 ;;; Levels # If the level 5 (Package linter) is forced to 1. Please add justifications here. diff --git a/scripts/upgrade b/scripts/upgrade index 0e22561..2cf195f 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -118,8 +118,6 @@ mkdir -p /home/yunohost.app/$app/.minetest/ mkdir /home/yunohost.app/$app/.minetest/worlds/ fi -cp -a ../conf/minetest.conf /home/yunohost.app/$app/.minetest/ - #================================================= # SPECIFIC UPGRADE #================================================= @@ -134,16 +132,15 @@ make -j$(nproc) popd -### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script. -### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it. -ynh_backup_if_checksum_is_different --file="$home_path/.minetest/minetest.conf" -# Recalculate and store the checksum of the file for the next upgrade. -ynh_store_file_checksum --file="$home_path/.minetest/minetest.conf" #================================================= # MODIFY A CONFIG FILE #================================================= +ynh_backup_if_checksum_is_different --file="$home_path/.minetest/minetest.conf" + +cp ../conf/minetest.conf $home/.minetest/minetest.conf + ### `ynh_replace_string` is used to replace a string in a file. ### (It's compatible with sed regular expressions syntax) @@ -156,6 +153,8 @@ ynh_replace_string --match_string="__PVP__" --replace_string="$pvp" --target_fil ynh_replace_string --match_string="__CREATIVE__" --replace_string="$creative" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__DAMAGE__" --replace_string="$damage" --target_file="$home_path/.minetest/minetest.conf" +ynh_store_file_checksum --file="$home_path/.minetest/minetest.conf" + #================================================= # SETUP LOGROTATE #================================================= From ed8659b5e4dece0ef2e17353ffa8048841143ce5 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Wed, 23 Oct 2019 15:20:32 +0200 Subject: [PATCH 14/29] Restore fixes --- scripts/install | 2 +- scripts/restore | 6 ++---- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/scripts/install b/scripts/install index 229489f..6e1e30c 100755 --- a/scripts/install +++ b/scripts/install @@ -50,7 +50,7 @@ final_path=/opt/yunohost/$app test ! -e "$final_path" || ynh_die "This path already contains a folder" # Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=/ +ynh_webpath_register --app=$app --domain=$domain --path_url="/" #================================================= # STORE SETTINGS FROM MANIFEST diff --git a/scripts/restore b/scripts/restore index 17af4e3..a49b183 100755 --- a/scripts/restore +++ b/scripts/restore @@ -32,7 +32,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= ynh_print_info --message="Validating restoration parameters..." -ynh_webpath_register --app=$app --domain=$domain --path_url=/ +ynh_webpath_register --app=$app --domain=$domain --path_url="/" test ! -d $final_path \ || ynh_die --message="There is already a directory: $final_path " @@ -104,9 +104,7 @@ ynh_restore_file --origin_path="/etc/logrotate.d/$app" #================================================= ynh_print_info --message="Reloading minetest..." -systemctl restart $app -ynh_systemd_action -l "ACTION[Main]: Server for gameid="minetest" listening on 0.0.0.0:30000." -p "/var/log/$app/minetest.log" -sleep 1 +ynh_systemd_action --action=restart --line_match="Server for gameid="$app" listening on :::30000." --log_path="/var/log/$app/minetest.log" #================================================= # END OF SCRIPT From 4c622196a65a0f14bff86e421da6545a6064964f Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Wed, 23 Oct 2019 15:23:05 +0200 Subject: [PATCH 15/29] Fixes --- scripts/change_url | 2 +- scripts/upgrade | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/change_url b/scripts/change_url index 776d535..eb018a3 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -60,7 +60,7 @@ ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" - #================================================= ynh_print_info --message="Reloading Minetest..." -systemctl start $app +systemctl restart $app #================================================= # END OF SCRIPT diff --git a/scripts/upgrade b/scripts/upgrade index 2cf195f..25810e2 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -180,7 +180,7 @@ chown -R $app: $home_path #================================================= ynh_print_info --message="Restarting Minetest..." -systemctl restart $app +ynh_systemd_action --action=restart --line_match="Server for gameid="$app" listening on :::30000." --log_path="/var/log/$app/minetest.log" #================================================= # END OF SCRIPT From 90f09e4e9040398fb9e472ad8e89377e68ca17fe Mon Sep 17 00:00:00 2001 From: Rafi59 Date: Wed, 23 Oct 2019 15:25:30 +0200 Subject: [PATCH 16/29] Update install Co-Authored-By: Kayou --- scripts/install | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/install b/scripts/install index 6e1e30c..44f6959 100755 --- a/scripts/install +++ b/scripts/install @@ -262,7 +262,7 @@ yunohost service add $app --log "/var/log/$app/$app.log" #================================================= ynh_print_info --message="Reloading minetest..." -ynh_systemd_action --action=restart --line_match="Server for gameid=minetest listening on :::30000." --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --action=restart --line_match="Server for gameid="$app" listening on :::30000." --log_path="/var/log/$app/minetest.log" sleep 1 #================================================= From 9dfb098df249a5c7c6a058c86e8a7f8d662599e9 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Wed, 23 Oct 2019 15:27:58 +0200 Subject: [PATCH 17/29] Fixes --- scripts/install | 3 +-- scripts/restore | 2 +- scripts/upgrade | 2 +- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/scripts/install b/scripts/install index 6e1e30c..e7c6e96 100755 --- a/scripts/install +++ b/scripts/install @@ -262,8 +262,7 @@ yunohost service add $app --log "/var/log/$app/$app.log" #================================================= ynh_print_info --message="Reloading minetest..." -ynh_systemd_action --action=restart --line_match="Server for gameid=minetest listening on :::30000." --log_path="/var/log/$app/minetest.log" -sleep 1 +ynh_systemd_action --action=restart --line_match="Server for gameid=\"$app\" listening on :::30000." --log_path="/var/log/$app/minetest.log" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index a49b183..5b65c32 100755 --- a/scripts/restore +++ b/scripts/restore @@ -104,7 +104,7 @@ ynh_restore_file --origin_path="/etc/logrotate.d/$app" #================================================= ynh_print_info --message="Reloading minetest..." -ynh_systemd_action --action=restart --line_match="Server for gameid="$app" listening on :::30000." --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --action=restart --line_match="Server for gameid=\"$app\" listening on :::30000." --log_path="/var/log/$app/minetest.log" #================================================= # END OF SCRIPT diff --git a/scripts/upgrade b/scripts/upgrade index 25810e2..33cdd44 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -180,7 +180,7 @@ chown -R $app: $home_path #================================================= ynh_print_info --message="Restarting Minetest..." -ynh_systemd_action --action=restart --line_match="Server for gameid="$app" listening on :::30000." --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --action=restart --line_match="Server for gameid=\"$app\" listening on :::30000." --log_path="/var/log/$app/minetest.log" #================================================= # END OF SCRIPT From 3893251f7142c3904c1a05b2a9afdf00422b5702 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Wed, 23 Oct 2019 18:15:07 +0200 Subject: [PATCH 18/29] Add ynh_read_manifest --- scripts/_common.sh | 49 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/scripts/_common.sh b/scripts/_common.sh index 2aa7841..4f728d8 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -16,6 +16,55 @@ pkg_dependencies="build-essential libirrlicht-dev cmake libbz2-dev libpng-dev li # EXPERIMENTAL HELPERS #================================================= +# Need also the helper https://github.com/YunoHost-Apps/Experimental_helpers/blob/master/ynh_handle_getopts_args/ynh_handle_getopts_args + +# Read the value of a key in a ynh manifest file +# +# usage: ynh_read_manifest manifest key +# | arg: -m, --manifest= - Path of the manifest to read +# | arg: -k, --key= - Name of the key to find +ynh_read_manifest () { + # Declare an array to define the options of this helper. + declare -Ar args_array=( [m]=manifest= [k]=key= ) + local manifest + local key + # Manage arguments with getopts + ynh_handle_getopts_args "$@" + + python3 -c "import sys, json;print(json.load(open('$manifest', encoding='utf-8'))['$key'])" +} + +# Read the upstream version from the manifest +# The version number in the manifest is defined by ~ynh +# For example : 4.3-2~ynh3 +# This include the number before ~ynh +# In the last example it return 4.3-2 +# +# usage: ynh_app_upstream_version +ynh_app_upstream_version () { + manifest_path="../manifest.json" + if [ ! -e "$manifest_path" ]; then + manifest_path="../settings/manifest.json" # Into the restore script, the manifest is not at the same place + fi + version_key=$(ynh_read_manifest --manifest="$manifest_path" --key="version") + echo "${version_key/~ynh*/}" +} + +# Read package version from the manifest +# The version number in the manifest is defined by ~ynh +# For example : 4.3-2~ynh3 +# This include the number after ~ynh +# In the last example it return 3 +# +# usage: ynh_app_package_version +ynh_app_package_version () { + manifest_path="../manifest.json" + if [ ! -e "$manifest_path" ]; then + manifest_path="../settings/manifest.json" # Into the restore script, the manifest is not at the same place + fi + version_key=$(ynh_read_manifest --manifest="$manifest_path" --key="version") + echo "${version_key/*~ynh/}" +} #================================================= # FUTURE OFFICIAL HELPERS From 7ec48847dc8edaffd5acbba9424bb3f5edf6eae6 Mon Sep 17 00:00:00 2001 From: Kay0u Date: Thu, 24 Oct 2019 11:11:14 +0900 Subject: [PATCH 19/29] Fixes --- scripts/backup | 8 ++++++-- scripts/change_url | 4 ++-- scripts/install | 12 +++++++++--- scripts/remove | 2 +- scripts/restore | 9 +++++++-- scripts/upgrade | 2 ++ 6 files changed, 27 insertions(+), 10 deletions(-) diff --git a/scripts/backup b/scripts/backup index f81bbf5..62d8e57 100755 --- a/scripts/backup +++ b/scripts/backup @@ -14,6 +14,10 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= +ynh_clean_setup () { + ynh_clean_check_starting # Need for the param line_match of ynh_systemd_action +} + # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -33,7 +37,7 @@ domain=$(ynh_app_setting_get --app=$app --key=domain) # BACKUP THE APP MAIN DIR #================================================= # Stop Minetest before backup... -systemctl stop $app +ynh_systemd_action --action=stop ynh_print_info --message="Backing up the main app directory..." @@ -66,6 +70,6 @@ ynh_backup --src_path="/etc/systemd/system/$app.service" # END OF SCRIPT #================================================= # Restart Minetest -systemctl start $app +ynh_systemd_action --action=start --line_match="Server for gameid=\"$app\" listening on :::30000." --log_path="/var/log/$app/minetest.log" ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." diff --git a/scripts/change_url b/scripts/change_url index eb018a3..d1f8c37 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -50,7 +50,7 @@ change_path=0 # SPECIFIC MODIFICATIONS #================================================= ynh_print_info --message="Stop Minetest..." -systemctl stop $app +ynh_systemd_action --action=restart ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="/home/yunohost.app/$app/.minetest/minetest.conf" #================================================= @@ -60,7 +60,7 @@ ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" - #================================================= ynh_print_info --message="Reloading Minetest..." -systemctl restart $app +ynh_systemd_action --action=restart --line_match="Server for gameid=\"$app\" listening on :::30000." --log_path="/var/log/$app/minetest.log" #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index e7c6e96..00c1a05 100755 --- a/scripts/install +++ b/scripts/install @@ -13,6 +13,10 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= +ynh_clean_setup () { + ynh_clean_check_starting # Need for the param line_match of ynh_systemd_action +} + # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -38,6 +42,7 @@ servername=$YNH_APP_ARG_SERVERNAME ### guaranteed to be unique. This is a good unique identifier to define installation path, ### db names, ... app=$YNH_APP_INSTANCE_NAME +path_url="/" #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS @@ -50,7 +55,7 @@ final_path=/opt/yunohost/$app test ! -e "$final_path" || ynh_die "This path already contains a folder" # Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url="/" +ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url #================================================= # STORE SETTINGS FROM MANIFEST @@ -58,6 +63,7 @@ ynh_webpath_register --app=$app --domain=$domain --path_url="/" ynh_print_info --message="Storing installation settings..." ynh_app_setting_set --app=$app --key=domain --value=$domain +ynh_app_setting_set --app=$app --key=path --value=$path_url ynh_app_setting_set --app=$app --key=is_public --value=$is_public ynh_app_setting_set --app=$app --key=pvp --value=$pvp ynh_app_setting_set --app=$app --key=creative --value=$creative @@ -198,7 +204,7 @@ fi # Set permissions on logs chown -R $app:$app /var/log/$app -systemctl start $app +ynh_systemd_action --action=start #================================================= # STORE THE CONFIG FILE CHECKSUM @@ -253,7 +259,7 @@ ynh_use_logrotate ### - Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script ### - As well as the section "ADVERTISE SERVICE IN ADMIN PANEL" in the restore script -yunohost service add $app --log "/var/log/$app/$app.log" +yunohost service add $app --log "/var/log/$app/minetest.log" # if using yunohost version 3.2 or more in the 'manifest.json', a description can be added #yunohost service add $app --description "$app daemon for XXX" --log "/var/log/$app/$app.log" diff --git a/scripts/remove b/scripts/remove index 2ddd271..898aeb0 100755 --- a/scripts/remove +++ b/scripts/remove @@ -56,7 +56,7 @@ ynh_print_info --message="Removing app main directory" # Remove the app directory securely ynh_secure_remove --file="$final_path" -ynh_secure_remove --file="/home/yunohost.app/$app/" +ynh_secure_remove --file="/home/yunohost.app/$app" #================================================= # REMOVE LOGROTATE CONFIGURATION diff --git a/scripts/restore b/scripts/restore index 5b65c32..571b705 100755 --- a/scripts/restore +++ b/scripts/restore @@ -14,6 +14,10 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= +ynh_clean_setup () { + ynh_clean_check_starting # Need for the param line_match of ynh_systemd_action +} + # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -25,6 +29,7 @@ ynh_print_info --message="Loading settings..." app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) +path_url=$(ynh_app_setting_get --app=$app --key=path) final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= @@ -32,7 +37,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= ynh_print_info --message="Validating restoration parameters..." -ynh_webpath_register --app=$app --domain=$domain --path_url="/" +ynh_webpath_available --app=$app --domain=$domain --path_url=$path_url test ! -d $final_path \ || ynh_die --message="There is already a directory: $final_path " @@ -88,7 +93,7 @@ systemctl enable $app.service # ADVERTISE SERVICE IN ADMIN PANEL #================================================= -yunohost service add $app --log "/var/log/$app/$app.log" +yunohost service add $app --log "/var/log/$app/minetest.log" #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 33cdd44..b5b9211 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -64,6 +64,8 @@ ynh_print_info --message="Backing up the app before upgrading (may take a while) # Backup the current version of the app ynh_backup_before_upgrade ynh_clean_setup () { + ynh_clean_check_starting # Need for the param line_match of ynh_systemd_action + # restore it if the upgrade fails ynh_restore_upgradebackup } From 4648784dfcccd50aa28aaf768890770b8aca9ef2 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Thu, 24 Oct 2019 14:55:53 +0200 Subject: [PATCH 20/29] Fixed then in upgrade and ynh_systemd_action --- scripts/backup | 9 ++++++++- scripts/change_url | 2 +- scripts/install | 2 +- scripts/restore | 2 +- scripts/upgrade | 3 +-- 5 files changed, 12 insertions(+), 6 deletions(-) diff --git a/scripts/backup b/scripts/backup index 62d8e57..5508634 100755 --- a/scripts/backup +++ b/scripts/backup @@ -33,6 +33,13 @@ domain=$(ynh_app_setting_get --app=$app --key=domain) #================================================= # STANDARD BACKUP STEPS +#================================================= +# BACKUP THE APP MAIN DIR +#================================================= +# STOP SYSTEMD SERVICE +#================================================= +ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" + #================================================= # BACKUP THE APP MAIN DIR #================================================= @@ -70,6 +77,6 @@ ynh_backup --src_path="/etc/systemd/system/$app.service" # END OF SCRIPT #================================================= # Restart Minetest -ynh_systemd_action --action=start --line_match="Server for gameid=\"$app\" listening on :::30000." --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." diff --git a/scripts/change_url b/scripts/change_url index d1f8c37..e458bd3 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -60,7 +60,7 @@ ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" - #================================================= ynh_print_info --message="Reloading Minetest..." -ynh_systemd_action --action=restart --line_match="Server for gameid=\"$app\" listening on :::30000." --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/$app.log" #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 00c1a05..72d7dc1 100755 --- a/scripts/install +++ b/scripts/install @@ -268,7 +268,7 @@ yunohost service add $app --log "/var/log/$app/minetest.log" #================================================= ynh_print_info --message="Reloading minetest..." -ynh_systemd_action --action=restart --line_match="Server for gameid=\"$app\" listening on :::30000." --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 571b705..16332e8 100755 --- a/scripts/restore +++ b/scripts/restore @@ -109,7 +109,7 @@ ynh_restore_file --origin_path="/etc/logrotate.d/$app" #================================================= ynh_print_info --message="Reloading minetest..." -ynh_systemd_action --action=restart --line_match="Server for gameid=\"$app\" listening on :::30000." --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/$app.log" #================================================= # END OF SCRIPT diff --git a/scripts/upgrade b/scripts/upgrade index b5b9211..80e7fc9 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -34,7 +34,6 @@ ynh_print_info --message="Checking version..." version=ynh_app_upstream_version if [ "$version" = "0.01" ]; then -then ynh_die --message="You can't upgrade to this version with simple upgrade. Please read the readme for upgrading https://github.com/YunoHost-Apps/minetest_ynh#additional-information ..." fi @@ -182,7 +181,7 @@ chown -R $app: $home_path #================================================= ynh_print_info --message="Restarting Minetest..." -ynh_systemd_action --action=restart --line_match="Server for gameid=\"$app\" listening on :::30000." --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/$app.log" #================================================= # END OF SCRIPT From 5125a47ee49f2ce4772f9d66e084a6ae842461e0 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Thu, 24 Oct 2019 15:15:40 +0200 Subject: [PATCH 21/29] Fix log_path --- scripts/backup | 2 +- scripts/change_url | 2 +- scripts/install | 2 +- scripts/restore | 2 +- scripts/upgrade | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/scripts/backup b/scripts/backup index 5508634..635b6cc 100755 --- a/scripts/backup +++ b/scripts/backup @@ -77,6 +77,6 @@ ynh_backup --src_path="/etc/systemd/system/$app.service" # END OF SCRIPT #================================================= # Restart Minetest -ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/minetest.log" ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." diff --git a/scripts/change_url b/scripts/change_url index e458bd3..e1bf314 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -60,7 +60,7 @@ ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" - #================================================= ynh_print_info --message="Reloading Minetest..." -ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/minetest.log" #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 72d7dc1..f69a167 100755 --- a/scripts/install +++ b/scripts/install @@ -268,7 +268,7 @@ yunohost service add $app --log "/var/log/$app/minetest.log" #================================================= ynh_print_info --message="Reloading minetest..." -ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/minetest.log" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 16332e8..8bee0fa 100755 --- a/scripts/restore +++ b/scripts/restore @@ -109,7 +109,7 @@ ynh_restore_file --origin_path="/etc/logrotate.d/$app" #================================================= ynh_print_info --message="Reloading minetest..." -ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/minetest.log" #================================================= # END OF SCRIPT diff --git a/scripts/upgrade b/scripts/upgrade index 80e7fc9..3676161 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -181,7 +181,7 @@ chown -R $app: $home_path #================================================= ynh_print_info --message="Restarting Minetest..." -ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/minetest.log" #================================================= # END OF SCRIPT From 6e52b40eb6d9b4d5f04cdfaac43d330730c29f1a Mon Sep 17 00:00:00 2001 From: Rafi59 Date: Thu, 24 Oct 2019 16:15:55 +0200 Subject: [PATCH 22/29] Fix SOURCE_IN_SUBDIR --- conf/minetest_game.src | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/conf/minetest_game.src b/conf/minetest_game.src index f7da171..dd9efd7 100644 --- a/conf/minetest_game.src +++ b/conf/minetest_game.src @@ -2,5 +2,5 @@ SOURCE_URL=https://github.com/minetest/minetest_game/archive/5.1.0.tar.gz SOURCE_SUM=f165fac0081bf4797cf9094282cc25034b2347b3ea94e6bb8d9329c5ee63f41b SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=false -SOURCE_FILENAME=minetest_game-5.1.0.tar.gz \ No newline at end of file +SOURCE_IN_SUBDIR=true +SOURCE_FILENAME=minetest_game-5.1.0.tar.gz From ff6672c6203d193c1a64fbbb8827d6c69ea83c4d Mon Sep 17 00:00:00 2001 From: Kay0u Date: Thu, 24 Oct 2019 23:45:25 +0900 Subject: [PATCH 23/29] fix restore --- scripts/restore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/restore b/scripts/restore index 8bee0fa..2bd1af0 100755 --- a/scripts/restore +++ b/scripts/restore @@ -37,7 +37,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= ynh_print_info --message="Validating restoration parameters..." -ynh_webpath_available --app=$app --domain=$domain --path_url=$path_url +ynh_webpath_available --domain=$domain --path_url=$path_url test ! -d $final_path \ || ynh_die --message="There is already a directory: $final_path " From bbae6dbffdc9674b3a2bc17c297c21d3a9edd1f7 Mon Sep 17 00:00:00 2001 From: Kay0u Date: Thu, 24 Oct 2019 23:45:31 +0900 Subject: [PATCH 24/29] fix upgrade --- scripts/upgrade | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/upgrade b/scripts/upgrade index 3676161..945ea2d 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -140,7 +140,7 @@ popd ynh_backup_if_checksum_is_different --file="$home_path/.minetest/minetest.conf" -cp ../conf/minetest.conf $home/.minetest/minetest.conf +cp ../conf/minetest.conf $home_path/.minetest/minetest.conf ### `ynh_replace_string` is used to replace a string in a file. ### (It's compatible with sed regular expressions syntax) From 5d6bc9284098b98c1b5feafb0322efcc6d10147a Mon Sep 17 00:00:00 2001 From: Kay0u Date: Fri, 25 Oct 2019 08:55:03 +0900 Subject: [PATCH 25/29] fixing home_path --- scripts/backup | 3 ++- scripts/change_url | 3 ++- scripts/install | 14 ++++++++------ scripts/remove | 3 ++- scripts/restore | 5 +++-- scripts/upgrade | 8 ++++---- 6 files changed, 21 insertions(+), 15 deletions(-) diff --git a/scripts/backup b/scripts/backup index 635b6cc..83c3eb1 100755 --- a/scripts/backup +++ b/scripts/backup @@ -29,6 +29,7 @@ ynh_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME final_path=$(ynh_app_setting_get --app=$app --key=final_path) +home_path=$(ynh_app_setting_get --app=$app --key=home_path) domain=$(ynh_app_setting_get --app=$app --key=domain) #================================================= @@ -55,7 +56,7 @@ ynh_backup --src_path="$final_path" #================================================= ynh_print_info --message="Backing up Minetest data..." -ynh_backup --src_path="/home/yunohost.app/$app" +ynh_backup --src_path="$home_path" #================================================= # SPECIFIC BACKUP diff --git a/scripts/change_url b/scripts/change_url index e1bf314..d37a27d 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -26,6 +26,7 @@ ynh_print_info --message="Loading installation settings..." # Needed for helper "ynh_add_nginx_config" final_path=$(ynh_app_setting_get --app=$app --key=final_path) +home_path=$(ynh_app_setting_get --app=$app --key=home_path) # Add settings here as needed by your application #db_name=$(ynh_app_setting_get --app=$app --key=db_name) @@ -51,7 +52,7 @@ change_path=0 #================================================= ynh_print_info --message="Stop Minetest..." ynh_systemd_action --action=restart -ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="/home/yunohost.app/$app/.minetest/minetest.conf" +ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="$home_path/.minetest/minetest.conf" #================================================= # GENERIC FINALISATION diff --git a/scripts/install b/scripts/install index f69a167..42771f3 100755 --- a/scripts/install +++ b/scripts/install @@ -121,23 +121,25 @@ ynh_setup_source --dest_dir="$final_path" #================================================= ynh_print_info --message="Configuring system user..." -# Create a system user -ynh_system_user_create --username=$app --home_dir=/home/yunohost.app/$app --use_shell home_path=/home/yunohost.app/$app +ynh_app_setting_set --app=$app --key=home_path --value=$home_path + +# Create a system user +ynh_system_user_create --username=$app --home_dir=$home_path --use_shell #================================================= # COPY CONFIG FILE #================================================= -if [ -e /home/yunohost.app/$app ] +if [ -e $home_path ] then echo "Nothing to do..." else -mkdir -p /home/yunohost.app/$app/.minetest/ -mkdir /home/yunohost.app/$app/.minetest/worlds/ +mkdir -p $home_path/.minetest/ +mkdir $home_path/.minetest/worlds/ fi -cp -a ../conf/minetest.conf /home/yunohost.app/$app/.minetest/ +cp -a ../conf/minetest.conf $home_path/.minetest/ #================================================= # SETUP SYSTEMD diff --git a/scripts/remove b/scripts/remove index 898aeb0..5fa3bc7 100755 --- a/scripts/remove +++ b/scripts/remove @@ -19,6 +19,7 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) port=$(ynh_app_setting_get --app=$app --key=port) final_path=$(ynh_app_setting_get --app=$app --key=final_path) +home_path=$(ynh_app_setting_get --app=$app --key=home_path) #================================================= # STANDARD REMOVE @@ -56,7 +57,7 @@ ynh_print_info --message="Removing app main directory" # Remove the app directory securely ynh_secure_remove --file="$final_path" -ynh_secure_remove --file="/home/yunohost.app/$app" +ynh_secure_remove --file="$home_path" #================================================= # REMOVE LOGROTATE CONFIGURATION diff --git a/scripts/restore b/scripts/restore index 2bd1af0..0a1449c 100755 --- a/scripts/restore +++ b/scripts/restore @@ -31,6 +31,7 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) path_url=$(ynh_app_setting_get --app=$app --key=path) final_path=$(ynh_app_setting_get --app=$app --key=final_path) +home_path=$(ynh_app_setting_get --app=$app --key=home_path) #================================================= # CHECK IF THE APP CAN BE RESTORED @@ -58,7 +59,7 @@ ynh_restore_file --origin_path="$final_path" ynh_print_info --message="Recreating the dedicated system user..." # Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir=/home/yunohost.app/$app --use_shell +ynh_system_user_create --username=$app --home_dir=$home_path --use_shell # Restore home_path ynh_restore_file --origin_path="$home_path" @@ -69,7 +70,7 @@ ynh_restore_file --origin_path="$home_path" # Restore permissions on app files chown -R root: $final_path -chown -R $app: /home/yunohost.app/$app +chown -R $app: $home_path #================================================= # SPECIFIC RESTORATION diff --git a/scripts/upgrade b/scripts/upgrade index 945ea2d..0ad4f78 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -97,7 +97,7 @@ ynh_install_app_dependencies $pkg_dependencies ynh_print_info --message="Making sure dedicated system user exists..." # Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir=/home/yunohost.app/$app --use_shell +ynh_system_user_create --username=$app --home_dir=$home_path --use_shell #================================================= # SETUP SYSTEMD @@ -111,12 +111,12 @@ ynh_add_systemd_config # COPY CONFIG FILE #================================================= -if [ -e /home/yunohost.app/$app ] +if [ -e $home_path ] then echo "Nothing to do..." else -mkdir -p /home/yunohost.app/$app/.minetest/ -mkdir /home/yunohost.app/$app/.minetest/worlds/ +mkdir -p $home_path/.minetest/ +mkdir $home_path/.minetest/worlds/ fi #================================================= From 98f8b5dba08fafa9860c46f73bc679b86f7c8a6c Mon Sep 17 00:00:00 2001 From: Kay0u Date: Fri, 25 Oct 2019 23:26:09 +0900 Subject: [PATCH 26/29] remove sso tile --- check_process | 2 +- manifest.json | 2 +- scripts/backup | 1 - scripts/change_url | 70 ---------------------------------------------- scripts/install | 9 ++---- scripts/remove | 1 - scripts/restore | 10 ------- scripts/upgrade | 4 +-- 8 files changed, 7 insertions(+), 92 deletions(-) delete mode 100644 scripts/change_url diff --git a/check_process b/check_process index 4fc0316..b05c831 100644 --- a/check_process +++ b/check_process @@ -25,7 +25,7 @@ multi_instance=1 incorrect_path=0 port_already_use=1 - change_url=1 + change_url=0 ;;; Levels # If the level 5 (Package linter) is forced to 1. Please add justifications here. diff --git a/manifest.json b/manifest.json index 35dda9b..e1a426e 100644 --- a/manifest.json +++ b/manifest.json @@ -29,7 +29,7 @@ "arguments": { "install" : [ { - "name": "domain", + "name": "server_domain", "type": "domain", "ask": { "en": "Choose a domain for your minetest server", diff --git a/scripts/backup b/scripts/backup index 83c3eb1..65f46b9 100755 --- a/scripts/backup +++ b/scripts/backup @@ -30,7 +30,6 @@ app=$YNH_APP_INSTANCE_NAME final_path=$(ynh_app_setting_get --app=$app --key=final_path) home_path=$(ynh_app_setting_get --app=$app --key=home_path) -domain=$(ynh_app_setting_get --app=$app --key=domain) #================================================= # STANDARD BACKUP STEPS diff --git a/scripts/change_url b/scripts/change_url deleted file mode 100644 index d37a27d..0000000 --- a/scripts/change_url +++ /dev/null @@ -1,70 +0,0 @@ -#!/bin/bash - -#================================================= -# GENERIC STARTING -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - -source _common.sh -source /usr/share/yunohost/helpers - -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -old_domain=$YNH_APP_OLD_DOMAIN - -new_domain=$YNH_APP_NEW_DOMAIN - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -# Needed for helper "ynh_add_nginx_config" -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -home_path=$(ynh_app_setting_get --app=$app --key=home_path) - -# Add settings here as needed by your application -#db_name=$(ynh_app_setting_get --app=$app --key=db_name) -#db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd) - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -change_domain=0 -if [ "$old_domain" != "$new_domain" ] -then - change_domain=1 -fi - -change_path=0 - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -#================================================= -# SPECIFIC MODIFICATIONS -#================================================= -ynh_print_info --message="Stop Minetest..." -ynh_systemd_action --action=restart -ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="$home_path/.minetest/minetest.conf" - -#================================================= -# GENERIC FINALISATION -#================================================= -# RELOAD MINETEST -#================================================= -ynh_print_info --message="Reloading Minetest..." - -ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/minetest.log" - -#================================================= -# END OF SCRIPT -#================================================= - -ynh_print_info --message="Change of URL completed for $app" diff --git a/scripts/install b/scripts/install index 42771f3..723e027 100755 --- a/scripts/install +++ b/scripts/install @@ -24,7 +24,7 @@ ynh_abort_if_errors # RETRIEVE ARGUMENTS FROM THE MANIFEST #================================================= -domain=$YNH_APP_ARG_DOMAIN +server_domain=$YNH_APP_ARG_SERVER_DOMAIN is_public=$YNH_APP_ARG_IS_PUBLIC pvp=$YNH_APP_ARG_PVP creative=$YNH_APP_ARG_CREATIVE @@ -54,15 +54,12 @@ ynh_print_info --message="Validating installation parameters..." final_path=/opt/yunohost/$app test ! -e "$final_path" || ynh_die "This path already contains a folder" -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - #================================================= # STORE SETTINGS FROM MANIFEST #================================================= ynh_print_info --message="Storing installation settings..." -ynh_app_setting_set --app=$app --key=domain --value=$domain +ynh_app_setting_set --app=$app --key=server_domain --value=$server_domain ynh_app_setting_set --app=$app --key=path --value=$path_url ynh_app_setting_set --app=$app --key=is_public --value=$is_public ynh_app_setting_set --app=$app --key=pvp --value=$pvp @@ -184,7 +181,7 @@ popd ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__SERVERNAME__" --replace_string="$servername" --target_file="$home_path/.minetest/minetest.conf" -ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__DOMAIN__" --replace_string="$server_domain" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__ANNOUNCE__" --replace_string="$is_public" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__PVP__" --replace_string="$pvp" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__CREATIVE__" --replace_string="$creative" --target_file="$home_path/.minetest/minetest.conf" diff --git a/scripts/remove b/scripts/remove index 5fa3bc7..f180063 100755 --- a/scripts/remove +++ b/scripts/remove @@ -16,7 +16,6 @@ ynh_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get --app=$app --key=domain) port=$(ynh_app_setting_get --app=$app --key=port) final_path=$(ynh_app_setting_get --app=$app --key=final_path) home_path=$(ynh_app_setting_get --app=$app --key=home_path) diff --git a/scripts/restore b/scripts/restore index 0a1449c..79cdedc 100755 --- a/scripts/restore +++ b/scripts/restore @@ -28,20 +28,10 @@ ynh_print_info --message="Loading settings..." app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get --app=$app --key=domain) path_url=$(ynh_app_setting_get --app=$app --key=path) final_path=$(ynh_app_setting_get --app=$app --key=final_path) home_path=$(ynh_app_setting_get --app=$app --key=home_path) -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_print_info --message="Validating restoration parameters..." - -ynh_webpath_available --domain=$domain --path_url=$path_url -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - #================================================= # STANDARD RESTORATION STEPS #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 0ad4f78..57ef7e0 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -16,7 +16,7 @@ ynh_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get --app=$app --key=domain) +server_domain=$(ynh_app_setting_get --app=$app --key=server_domain) port=$(ynh_app_setting_get --app=$app --key=port) is_public=$(ynh_app_setting_get --app=$app --key=is_public) final_path=$(ynh_app_setting_get --app=$app --key=final_path) @@ -148,7 +148,7 @@ cp ../conf/minetest.conf $home_path/.minetest/minetest.conf ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__SERVERNAME__" --replace_string="$servername" --target_file="$home_path/.minetest/minetest.conf" -ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$home_path/.minetest/minetest.conf" +ynh_replace_string --match_string="__DOMAIN__" --replace_string="$server_domain" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__ANNOUNCE__" --replace_string="$is_public" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__PVP__" --replace_string="$pvp" --target_file="$home_path/.minetest/minetest.conf" ynh_replace_string --match_string="__CREATIVE__" --replace_string="$creative" --target_file="$home_path/.minetest/minetest.conf" From fcaab2c4d90ebe5a8822fa37087b40357e40a02c Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Sat, 26 Oct 2019 22:38:40 +0200 Subject: [PATCH 27/29] add line_match --- scripts/backup | 4 +--- scripts/install | 4 +--- scripts/restore | 2 +- scripts/upgrade | 2 +- 4 files changed, 4 insertions(+), 8 deletions(-) diff --git a/scripts/backup b/scripts/backup index 65f46b9..d97d65b 100755 --- a/scripts/backup +++ b/scripts/backup @@ -43,8 +43,6 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app #================================================= # BACKUP THE APP MAIN DIR #================================================= -# Stop Minetest before backup... -ynh_systemd_action --action=stop ynh_print_info --message="Backing up the main app directory..." @@ -77,6 +75,6 @@ ynh_backup --src_path="/etc/systemd/system/$app.service" # END OF SCRIPT #================================================= # Restart Minetest -ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/minetest.log" --line_match="listening on" ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." diff --git a/scripts/install b/scripts/install index 723e027..76862b5 100755 --- a/scripts/install +++ b/scripts/install @@ -203,8 +203,6 @@ fi # Set permissions on logs chown -R $app:$app /var/log/$app -ynh_systemd_action --action=start - #================================================= # STORE THE CONFIG FILE CHECKSUM #================================================= @@ -267,7 +265,7 @@ yunohost service add $app --log "/var/log/$app/minetest.log" #================================================= ynh_print_info --message="Reloading minetest..." -ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/minetest.log" --line_match="listening on" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 79cdedc..b5f44ca 100755 --- a/scripts/restore +++ b/scripts/restore @@ -100,7 +100,7 @@ ynh_restore_file --origin_path="/etc/logrotate.d/$app" #================================================= ynh_print_info --message="Reloading minetest..." -ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/minetest.log" --line_match="listening on" #================================================= # END OF SCRIPT diff --git a/scripts/upgrade b/scripts/upgrade index 57ef7e0..48a6d34 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -181,7 +181,7 @@ chown -R $app: $home_path #================================================= ynh_print_info --message="Restarting Minetest..." -ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/minetest.log" +ynh_systemd_action --service_name=$app --action="restart" --log_path="/var/log/$app/minetest.log" --line_match="listening on" #================================================= # END OF SCRIPT From d8ed05e786c4bddb32ef38444f902eca12997048 Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Sat, 26 Oct 2019 22:42:12 +0200 Subject: [PATCH 28/29] fix ynh_find_port --- scripts/_common.sh | 17 +++++++++++++++++ scripts/install | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/scripts/_common.sh b/scripts/_common.sh index 4f728d8..601fa68 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -12,6 +12,23 @@ pkg_dependencies="build-essential libirrlicht-dev cmake libbz2-dev libpng-dev li # PERSONAL HELPERS #================================================= +# To remove once https://github.com/YunoHost/yunohost/pull/827 get merged +ynh_find_port () { + # Declare an array to define the options of this helper. + local legacy_args=p + declare -Ar args_array=( [p]=port= ) + local port + # Manage arguments with getopts + ynh_handle_getopts_args "$@" + + test -n "$port" || ynh_die --message="The argument of ynh_find_port must be a valid port." + while ss -nltu | grep -q -w :$port # Check if the port is free + do + port=$((port+1)) # Else, pass to next port + done + echo $port +} + #================================================= # EXPERIMENTAL HELPERS #================================================= diff --git a/scripts/install b/scripts/install index 76862b5..da1b344 100755 --- a/scripts/install +++ b/scripts/install @@ -6,8 +6,8 @@ # IMPORT GENERIC HELPERS #================================================= -source _common.sh source /usr/share/yunohost/helpers +source _common.sh #================================================= # MANAGE SCRIPT FAILURE From 4410447b392e98804e7943d518466a8bb2ff378e Mon Sep 17 00:00:00 2001 From: Rafi594 Date: Sun, 27 Oct 2019 09:26:04 +0100 Subject: [PATCH 29/29] Fix restore --- scripts/remove | 4 ++++ scripts/restore | 4 +++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/scripts/remove b/scripts/remove index f180063..2fa1674 100755 --- a/scripts/remove +++ b/scripts/remove @@ -58,6 +58,10 @@ ynh_print_info --message="Removing app main directory" ynh_secure_remove --file="$final_path" ynh_secure_remove --file="$home_path" +# Remove the log files +ynh_secure_remove "/var/log/$app" + + #================================================= # REMOVE LOGROTATE CONFIGURATION #================================================= diff --git a/scripts/restore b/scripts/restore index b5f44ca..02aef87 100755 --- a/scripts/restore +++ b/scripts/restore @@ -84,8 +84,10 @@ systemctl enable $app.service # ADVERTISE SERVICE IN ADMIN PANEL #================================================= -yunohost service add $app --log "/var/log/$app/minetest.log" +mkdir /var/log/$app -p +chown -R $app: /var/log/$app +yunohost service add $app --log "/var/log/$app/minetest.log" #================================================= # RESTORE THE LOGROTATE CONFIGURATION