From 65c382d139596fcb37b4c97c39398815a1dcb4e8 Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Sun, 19 Mar 2017 18:31:53 +0100 Subject: [PATCH] Reprise globale du package v2 --- check_process | 7 +-- conf/app.src | 2 +- scripts/.fonctions | 124 +++++++++++++++++++++++++++++++-------------- scripts/backup | 11 +++- scripts/install | 8 +-- scripts/remove | 2 +- scripts/restore | 17 ++++--- scripts/upgrade | 9 ++-- 8 files changed, 119 insertions(+), 61 deletions(-) diff --git a/check_process b/check_process index 827632c..490e10e 100644 --- a/check_process +++ b/check_process @@ -18,18 +18,15 @@ upgrade=1 backup_restore=1 multi_instance=1 - wrong_user=1 - wrong_path=1 incorrect_path=1 - corrupt_source=0 - fail_download_source=0 port_already_use=0 - final_path_already_use=0 ;;; Levels Level 1=auto Level 2=auto Level 3=auto +# Level 4: https://github.com/LeedRSS/Leed/commit/841719a25e3753b0c50275bed62c29a55aa21bb9 Level 4=1 +# Level 5: https://github.com/YunoHost-Apps/leed_ynh/issues/6 Level 5=1 Level 6=auto Level 7=auto diff --git a/conf/app.src b/conf/app.src index 6f30e01..d5af0a3 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,2 +1,2 @@ -SOURCE_URL=https://github.com/ldleman/Leed/archive/v1.7.tar.gz +SOURCE_URL>https://github.com/ldleman/Leed/archive/v1.7.tar.gz SOURCE_SUM=f54a18cef71704be85e7b963cff19357 diff --git a/scripts/.fonctions b/scripts/.fonctions index 97167e1..2243dd2 100755 --- a/scripts/.fonctions +++ b/scripts/.fonctions @@ -24,24 +24,24 @@ CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà u NO_PRINT () { # Supprime l'affichage dans stdout pour la commande en argument. set +x - eval "$@" + $@ set -x } WARNING () { # Écrit sur le canal d'erreur pour passer en warning. - eval "$@" >&2 + $@ >&2 } SUPPRESS_WARNING () { # Force l'écriture sur la sortie standard - eval "$@" 2>&1 + $@ 2>&1 } QUIET () { # Redirige la sortie standard dans /dev/null - eval "$@" > /dev/null + $@ > /dev/null } ALL_QUIET () { # Redirige la sortie standard et d'erreur dans /dev/null - eval "$@" > /dev/null 2>&1 + $@ > /dev/null 2>&1 } #================================================= @@ -49,7 +49,7 @@ ALL_QUIET () { # Redirige la sortie standard et d'erreur dans /dev/null #================================================= SETUP_SOURCE () { # Télécharge la source, décompresse et copie dans $final_path - src_url=$(cat ../conf/app.src | grep SOURCE_URL | cut -d= -f2) + src_url=$(cat ../conf/app.src | grep SOURCE_URL | cut -d'>' -f2) src_checksum=$(cat ../conf/app.src | grep SOURCE_SUM | cut -d= -f2) # Download sources from the upstream wget -nv -O source.tar.gz $src_url @@ -65,7 +65,7 @@ SETUP_SOURCE () { # Télécharge la source, décompresse et copie dans $final_pa } SETUP_SOURCE_ZIP () { # Télécharge la source, décompresse et copie dans $final_path - src_url=$(cat ../conf/app.src | grep SOURCE_URL | cut -d= -f2) + src_url=$(cat ../conf/app.src | grep SOURCE_URL | cut -d'>' -f2) src_checksum=$(cat ../conf/app.src | grep SOURCE_SUM | cut -d= -f2) # Download sources from the upstream wget -nv -O source.zip $src_url @@ -73,20 +73,16 @@ SETUP_SOURCE_ZIP () { # Télécharge la source, décompresse et copie dans $fina echo "$src_checksum source.zip" | md5sum -c --status || ynh_die "Corrupt source" # Extract source into the app dir sudo mkdir -p $final_path - sudo unzip -quo source.zip -d $final_path + temp_dir=$(mktemp -d) + unzip -quo source.zip -d $temp_dir # On passe par un dossier temporaire car unzip ne permet pas d'ignorer le dossier parent. + sudo cp -a $temp_dir/*/. $final_path + rm -r $temp_dir # Copie les fichiers additionnels ou modifiés. if test -e "../sources/ajouts"; then sudo cp -a ../sources/ajouts/. "$final_path" fi } -ADD_SYS_USER () { # Créer un utilisateur système dédié à l'app - if ! ynh_system_user_exists "$app" # Test l'existence de l'utilisateur - then - sudo useradd -d /var/www/$app --system --user-group $app --shell /usr/sbin/nologin || ynh_die "Unable to create $app system account" - fi -} - POOL_FPM () { # Créer le fichier de configuration du pool php-fpm et le configure. sed -i "s@__NAMETOCHANGE__@$app@g" ../conf/php-fpm.conf sed -i "s@__FINALPATH__@$final_path@g" ../conf/php-fpm.conf @@ -97,14 +93,14 @@ POOL_FPM () { # Créer le fichier de configuration du pool php-fpm et le configu finalphpini=/etc/php5/fpm/conf.d/20-$app.ini sudo cp ../conf/php-fpm.ini $finalphpini sudo chown root: $finalphpini - sudo service php5-fpm reload + sudo systemctl reload php5-fpm } YNH_CURL () { data_post=$1 url_access=$2 sleep 1 - SUPPRESS_WARNING curl -kL -H \"Host: $domain\" --resolve $domain:443:127.0.0.1 --data \"$data_post\" \"https://localhost$path_url$url_access\" + curl -kL -H "Host: $domain" --resolve $domain:443:127.0.0.1 --data "$data_post" "https://localhost$path_url$url_access" 2>&1 } #================================================= @@ -115,7 +111,7 @@ REMOVE_NGINX_CONF () { # Suppression de la configuration nginx if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then # Delete nginx config echo "Delete nginx config" sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf" - sudo service nginx reload + sudo systemctl reload nginx fi } @@ -128,7 +124,7 @@ REMOVE_FPM_CONF () { # Suppression de la configuration du pool php-fpm echo "Delete php config" sudo rm "/etc/php5/fpm/conf.d/20-$app.ini" fi - sudo service php5-fpm reload + sudo systemctl reload php5-fpm } SECURE_REMOVE () { # Suppression de dossier avec vérification des variables @@ -159,22 +155,16 @@ SECURE_REMOVE () { # Suppression de dossier avec vérification des variable fi } -REMOVE_SYS_USER () { # Supprime l'utilisateur système dédié à l'app - if ynh_system_user_exists "$app" # Test l'existence de l'utilisateur - then - sudo userdel $app - fi -} - #================================================= # BACKUP #================================================= BACKUP_FAIL_UPGRADE () { WARNING echo "Upgrade failed." - if ALL_QUIET sudo yunohost backup list | grep -q $app-before-upgrade$backup_number; then # Vérifie l'existence de l'archive avant de supprimer l'application et de restaurer + 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-before-upgrade$backup_number --apps $app --force # Restore the backup if upgrade failed + 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 } @@ -182,21 +172,40 @@ BACKUP_FAIL_UPGRADE () { BACKUP_BEFORE_UPGRADE () { # Backup the current version of the app, restore it if the upgrade fails backup_number=1 old_backup_number=2 - if ALL_QUIET sudo yunohost backup list | grep -q $app-before-upgrade1; then # Vérifie l'existence d'une archive déjà numéroté à 1. + 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-before-upgrade$backup_number # Créer un backup différent de celui existant. + 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 ALL_QUIET sudo yunohost backup list | grep -q $app-before-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-before-upgrade$old_backup_number + 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 fi else # Si le backup a échoué ynh_die "Backup failed, the upgrade process was aborted." 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 +} + #================================================= # CONFIGURATION #================================================= @@ -342,17 +351,17 @@ ynh_exit_properly () { # 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_check_error -ynh_check_error () { +# 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 } # Install dependencies with a equivs control file # -# usage: ynh_app_dependencies dep [dep [...]] +# usage: ynh_install_app_dependencies dep [dep [...]] # | arg: dep - the package name to install in dependence -ynh_app_dependencies () { +ynh_install_app_dependencies () { dependencies=$@ manifest_path="../manifest.json" if [ ! -e "$manifest_path" ]; then @@ -360,7 +369,11 @@ ynh_app_dependencies () { fi version=$(sudo python3 -c "import sys, json;print(json.load(open(\"$manifest_path\"))['version'])") # Retrieve the version number in the manifest file. dep_app=${app//_/-} # Replace all '_' by '-' - cat > ./${dep_app}-ynh-deps.control << EOF # Make a control file for equivs-build + + 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 @@ -370,8 +383,10 @@ 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_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 } # Remove fake package and its dependencies @@ -453,3 +468,34 @@ ynh_find_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 +} diff --git a/scripts/backup b/scripts/backup index f28fb22..6ce7e63 100644 --- a/scripts/backup +++ b/scripts/backup @@ -13,6 +13,12 @@ set -eu # IMPORT GENERIC HELPERS #================================================= +if [ ! -e .fonctions ]; then + # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant + sudo cp ../settings/scripts/.fonctions ./.fonctions + sudo chmod a+rx .fonctions +fi +source .fonctions source /usr/share/yunohost/helpers #================================================= @@ -32,6 +38,7 @@ db_pwd=$(ynh_app_setting_get "$app" mysqlpwd) # BACKUP OF THE MAIN DIR OF THE APP #================================================= +CHECK_SIZE "$final_path" ynh_backup "$final_path" "sources" #================================================= @@ -51,7 +58,9 @@ ynh_backup "/etc/php5/fpm/conf.d/20-$app.ini" "php-fpm.ini" # BACKUP OF THE SQL BDD #================================================= -mysqldump -u "$db_name" -p"$db_pwd" --no-create-db "$db_name" > ./db.sql +ynh_mysql_dump_db "$db_name" > dump.sql +CHECK_SIZE "dump.sql" +ynh_backup "dump.sql" "db.sql" #================================================= # SPECIFIC BACKUP diff --git a/scripts/install b/scripts/install index eb91e4e..27c7e0e 100644 --- a/scripts/install +++ b/scripts/install @@ -13,7 +13,7 @@ source /usr/share/yunohost/helpers # MANAGE FAILURE OF THE SCRIPT #================================================= -ynh_check_error # Active trap pour arrêter le script si une erreur est détectée. +ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST @@ -78,7 +78,7 @@ sudo sed -i "s@__NAMETOCHANGE__@$app@g" /etc/nginx/conf.d/$domain.d/$app.conf # CREATE DEDICATED USER #================================================= -ADD_SYS_USER # Créer un utilisateur système dédié à l'app +ynh_system_user_create $app # Créer un utilisateur système dédié à l'app #================================================= # PHP-FPM CONFIGURATION @@ -100,7 +100,7 @@ ynh_app_setting_set $app unprotected_uris "/" #L'usage de unprotected_uris a la sudo yunohost app ssowatconf # Reload Nginx -sudo service nginx reload +sudo systemctl reload nginx # Leed installation via curl YNH_CURL "install_changeLngLeed=$language&root=$domain$path_url&mysqlHost=localhost&mysqlLogin=$db_name&mysqlMdp=$db_pwd&mysqlBase=$db_name&mysqlPrefix=leed_&login=$admin&password=$user_pwd" "/install.php?installButton" @@ -161,4 +161,4 @@ fi # RELOAD NGINX #================================================= -sudo service nginx reload +sudo systemctl reload nginx diff --git a/scripts/remove b/scripts/remove index 247b8b7..6d8e452 100644 --- a/scripts/remove +++ b/scripts/remove @@ -61,4 +61,4 @@ fi # REMOVE DEDICATED USER #================================================= -REMOVE_SYS_USER +ynh_system_user_delete $app diff --git a/scripts/restore b/scripts/restore index 7b89a8e..ff261c2 100644 --- a/scripts/restore +++ b/scripts/restore @@ -13,6 +13,12 @@ set -eu # IMPORT GENERIC HELPERS #================================================= +if [ ! -e .fonctions ]; then + # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant + sudo cp ../settings/scripts/.fonctions ./.fonctions + sudo chmod a+rx .fonctions +fi +source .fonctions source /usr/share/yunohost/helpers #================================================= @@ -43,7 +49,7 @@ test ! -d $final_path \ conf=/etc/nginx/conf.d/$domain.d/$app.conf if [ -f $conf ]; then - ynh_die "There is already a nginx conf file at this path: $conf " + ynh_die "There is already a nginx conf file at this path: $conf " fi sudo cp -a ./nginx.conf $conf @@ -65,10 +71,7 @@ ynh_mysql_connect_as $db_name $db_pwd $db_name < ./db.sql # RECREATE THE DEDICATED USER #================================================= -if ! ynh_system_user_exists "$app" # Test l'existence de l'utilisateur -then - sudo useradd -d /var/www/$app --system --user-group $app --shell /usr/sbin/nologin || ynh_die "Unable to create $app system account" -fi +ynh_system_user_create $app # Recreate the dedicated user, if not exist #================================================= # RESTORE OF THE PHP-FPM CONFIGURATION @@ -97,5 +100,5 @@ sudo chown -R $app $final_path/cache $final_path/plugins $final_path/updates # RELOAD NGINX AND PHP-FPM #================================================= -sudo service php5-fpm reload -sudo service nginx reload +sudo systemctl reload php5-fpm +sudo systemctl reload nginx diff --git a/scripts/upgrade b/scripts/upgrade index 1a619d1..934bb08 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -31,10 +31,12 @@ if [ -z $final_path ]; then # Si final_path n'est pas renseigné dans app settin final_path=/var/www/$app ynh_app_setting_set $app final_path $final_path fi + if [ -z $db_name ]; then # Si db_name n'est pas renseigné dans app setting db_name=$(ynh_make_valid_dbid $app) ynh_app_setting_set $app db_name $db_name fi + if [ -z "$is_public" ]; then # Raté avec get au lieu de set... public_check=$(ynh_app_setting_get $app skipped_uris) if [ -z "$public_check" ]; then # Si skipped_uris est vide, c'était une install publique. @@ -52,6 +54,7 @@ else is_public=0 fi fi + market=$(ynh_app_setting_get $app market) if [ "$market" = "Yes" ]; then ynh_app_setting_set $app market 1 # Fixe market en booléen @@ -67,7 +70,7 @@ BACKUP_BEFORE_UPGRADE # Backup the current version of the app ynh_clean_setup () { BACKUP_FAIL_UPGRADE # restore it if the upgrade fails } -ynh_check_error # Active trap pour arrêter le script si une erreur est détectée. +ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. #================================================= # CHECK THE PATH @@ -98,7 +101,7 @@ sudo sed -i "s@__NAMETOCHANGE__@$app@g" /etc/nginx/conf.d/$domain.d/$app.conf # CREATE DEDICATED USER #================================================= -ADD_SYS_USER # Créer un utilisateur système dédié à l'app +ynh_system_user_create $app # Create the dedicated user, if not exist #================================================= # PHP-FPM CONFIGURATION @@ -167,4 +170,4 @@ fi # RELOAD NGINX #================================================= -sudo service nginx reload +sudo systemctl reload nginx