From a12f65d41edfa19b6eeec8703bb606d49840f414 Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Wed, 15 Jun 2016 23:57:31 +0200 Subject: [PATCH] Factorisation du code --- scripts/.fonctions | 178 ++++++++++++++++++ scripts/backup | 4 +- scripts/install | 89 +++------ scripts/remove | 34 +--- scripts/restore | 4 +- scripts/upgrade | 36 ++-- .../infcloud}/cache_update.sh | 0 .../infcloud}/interface.js | 0 8 files changed, 225 insertions(+), 120 deletions(-) create mode 100755 scripts/.fonctions rename sources/{ajouts_infcloud => ajouts/infcloud}/cache_update.sh (100%) rename sources/{ajouts_infcloud => ajouts/infcloud}/interface.js (100%) diff --git a/scripts/.fonctions b/scripts/.fonctions new file mode 100755 index 0000000..7569aae --- /dev/null +++ b/scripts/.fonctions @@ -0,0 +1,178 @@ +#!/bin/bash + +YNH_VERSION () { # Renvoi le numéro de version de la moulinette Yunohost + ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2) +} + +CHECK_VAR () { # Vérifie que la variable n'est pas vide. +# $1 = Variable à vérifier +# $2 = Texte à afficher en cas d'erreur + test -n "$1" || (echo "$2" && false) +} + +EXIT_PROPERLY () { # Provoque l'arrêt du script en cas d'erreur. Et nettoye les résidus. + trap '' ERR + echo -e "\e[91m \e[1m" # Shell in light red bold + echo -e "!!\n $app install's script has encountered an error. Installation was cancelled.\n!!" + + CLEAN_SETUP # Appel la fonction de nettoyage spécifique du script install. + + if [ $ynh_version = "2.2" ]; then + /bin/bash $script_dir/remove # Appel le script remove. En 2.2, ce comportement n'est pas automatique. + fi + + exit 1 +} + +TRAP_ON () { # Activate signal capture + trap EXIT_PROPERLY ERR # Capturing exit signals on error +} + +TRAP_OFF () { # Ignoring signal capture until TRAP_ON + # Pour une raison que j'ignore, la fonction TRAP_ON fonctionne très bien. + # Mais pas la fonction TRAP_OFF... + # Utiliser directement `trap '' ERR` dans le code pour l'utiliser, à la place de la fonction. + trap '' ERR # Ignoring exit signals +} + +CHECK_USER () { # Vérifie la validité de l'user admin +# $1 = Variable de l'user admin. + sudo yunohost user list --json | grep -q "\"username\": \"$1\"" || (echo "Wrong admin" && false) +} + +CHECK_PATH () { # Vérifie la présence du / en début de path. Et son absence à la fin. + if [ "${path:0:1}" != "/" ]; then # Si le premier caractère n'est pas un / + path="/$path" # Ajoute un / en début de path + fi + if [ "${path:${#path}-1}" == "/" ] && [ ${#path} -gt 1 ]; then # Si le dernier caractère est un / et que ce n'est pas le seul caractère. + path="${path:0:${#path}-1}" # Supprime le dernier caractère + fi +} + +CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine. + sudo yunohost app checkurl $domain$path -a $app +} + +CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà utilisé. + final_path=/var/www/$app + if [ -e "$final_path" ] + then + echo "This path already contains a folder" + false + fi +} + +GENERATE_DB () { # Créer une base de données et un utilisateur dédié au nom de l'app. + # Génère un mot de passe aléatoire. + db_pwd=$(head -n20 /dev/urandom | tr -c -d 'A-Za-z0-9' | head -c20) + CHECK_VAR "$db_pwd" "db_pwd empty" + # Utilise '$app' comme nom d'utilisateur et de base de donnée + db_user=$app + # Initialise la base de donnée et stocke le mot de passe mysql. + ynh_mysql_create_db $db_user $db_user $db_pwd + sudo yunohost app setting $app mysqlpwd -v $db_pwd +} + +SETUP_SOURCE () { # Télécharge la source, décompresse et copie dans $final_path +# $1 = Nom de l'archive téléchargée. + wget -nv --show-progress -i ../sources/source_url -O $1 + # Vérifie la somme de contrôle de la source téléchargée. + md5sum -c ../sources/source_md5 --status || (echo "Corrupt source" && false) + # Décompresse la source + if [ "$(echo ${1##*.})" == "gz" ]; then + tar -x -f $1 + elif [ "$(echo ${1##*.})" == "zip" ]; then + unzip -q $1 + else + false # Format d'archive non pris en charge. + fi + # Copie les fichiers sources + sudo cp -a $(cat ../sources/source_dir)/. "$final_path" + # Copie les fichiers additionnels ou modifiés. + sudo cp -a ../sources/ajouts/. "$final_path" +} + +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 + finalphpconf=/etc/php5/fpm/pool.d/$app.conf + sudo cp ../conf/php-fpm.conf $finalphpconf + sudo chown root: $finalphpconf + 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 +} + +STORE_MD5_CONFIG () { # Enregistre la somme de contrôle du fichier de config +# $1 = Nom du fichier de conf pour le stockage dans settings.yml +# $2 = Nom complet et chemin du fichier de conf. + sudo yunohost app setting $app $1_file_md5 -v $(md5sum "$2" | cut -d' ' -f1) +} + +CHECK_MD5_CONFIG () { # Créé un backup du fichier de config si il a été modifié. +# $1 = Nom du fichier de conf pour le stockage dans settings.yml +# $2 = Nom complet et chemin du fichier de conf. + if [ "$(sudo yunohost app setting $app $1_file_md5)" != $(md5sum "$2" | cut -d' ' -f1) ]; then + sudo cp -a "$2" "$2.backup.$(date '+%d.%m.%y_%Hh%M,%Ss')" # Si le fichier de config a été modifié, créer un backup. + fi +} + +FIND_PORT () { # Cherche un port libre. +# $1 = Numéro de port pour débuter la recherche. + port=$1 + while ! sudo yunohost app checkport $port ; do + port=$((port+1)) + done + CHECK_VAR "$port" "port empty" +} + + +### REMOVE SCRIPT + +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 + fi +} + +REMOVE_FPM_CONF () { # Suppression de la configuration du pool php-fpm + if [ -e "/etc/php5/fpm/pool.d/$app.conf" ]; then # Delete fpm config + echo "Delete fpm config" + sudo rm "/etc/php5/fpm/pool.d/$app.conf" + fi + if [ -e "/etc/php5/fpm/conf.d/20-$app.ini" ]; then # Delete php config + echo "Delete php config" + sudo rm "/etc/php5/fpm/conf.d/20-$app.ini" + fi + sudo service php5-fpm reload +} + +REMOVE_LOGROTATE_CONF () { # Suppression de la configuration de logrotate + if [ -e "/etc/logrotate.d/$app" ]; then + echo "Delete logrotate config" + sudo rm "/etc/logrotate.d/$app" + fi +} + +REMOVE_APP_DIR () { # Suppression du dossier de l'application + if [ test -n "$app" ] + then # Supprime le dossier seulement si $app n'est pas vide. + if [ -e "/var/www/$app" ]; then # Delete final_path + echo "Delete app dir" + sudo rm -r "/var/www/$app" + fi + fi +} + +REMOVE_BDD () { # Suppression de la base de donnée et de l'utilisateur associé. + # Utilise '$app' comme nom d'utilisateur et de base de donnée + db_user=$app + if mysqlshow -u root -p$(sudo cat $MYSQL_ROOT_PWD_FILE) | grep -q "^| $db_user"; then + echo "Delete db" + ynh_mysql_drop_db $db_user + ynh_mysql_drop_user $db_user + fi +} diff --git a/scripts/backup b/scripts/backup index 83ec202..ba9055a 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,7 +1,9 @@ #!/bin/bash +source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script + # Récupère les infos de l'application. -ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2) +YNH_VERSION # Récupère le numéro de version de Yunohost. if [ $ynh_version = "2.4" ]; then app=$YNH_APP_INSTANCE_NAME else diff --git a/scripts/install b/scripts/install index 0177888..a675d4f 100755 --- a/scripts/install +++ b/scripts/install @@ -1,6 +1,16 @@ #!/bin/bash -ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2) +source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script + +YNH_VERSION # Récupère le numéro de version de Yunohost. + +CLEAN_SETUP () { +# Nettoyage des résidus d'installation non pris en charge par le script remove. +# Pas de nettoyage supplémentaire nécessaire ici... + echo "" +} +TRAP_ON # Active trap pour arrêter le script si une erreur est détectée. + # Retrieve arguments if [ $ynh_version = "2.4" ] then @@ -24,56 +34,19 @@ else fi # Checks variables are not empty -test -z "$domain" && (echo "domain not set" && touch /force_stop) -test -z "$path" && (echo "path not set" && touch /force_stop) -test -z "$admin" && (echo "admin not set" && touch /force_stop) -test -z "$infcloud" && (echo "infcloud not set" && touch /force_stop) -test -z "$language" && (echo "language not set" && touch /force_stop) - -# Delete files and db if exit with an error -EXIT_PROPERLY () { - trap '' ERR - echo -e "\e[91m \e[1m" # Shell in light red bold - echo -e "!!\n $app install's script has encountered an error. Installation was cancelled.\n!!" - - if [ $ynh_version = "2.2" ]; then - /bin/bash ./remove # Appel le script remove. En 2.2, ce comportement n'est pas automatique. - fi - exit 1 -} -TRAP_ON () { # Activate signal capture - trap EXIT_PROPERLY ERR # Capturing exit signals on error -} -TRAP_OFF () { # Ignoring signal capture until TRAP_ON -# Pour une raison que j'ignore, la fonction TRAP_ON fonctionne très bien. -# Mais pas la fonction TRAP_OFF... -# Utiliser directement `trap '' ERR` dans le code pour l'utiliser, à la place de la fonction. - trap '' ERR # Ignoring exit signals -} -TRAP_ON +CHECK_VAR "$app" "app name not set" -# Vérifie la validité de l'user admin -sudo yunohost user list --json | grep -q "\"username\": \"$admin\"" || (echo "Wrong admin" && touch /force_stop 2> /dev/null) +CHECK_USER "$admin" # Vérifie la validité de l'user admin -# Vérifie la disponibilité du path et du domaine. -sudo yunohost app checkurl $domain$path -a $app +CHECK_PATH # Vérifie et corrige la syntaxe du path. +CHECK_DOMAINPATH # Vérifie la disponibilité du path et du domaine. -# Vérifie que le dossier de destination n'est pas déjà utilisé. -final_path=/var/www/$app -if [ -e "$final_path" ] -then - echo "This path already contains a folder" - touch /force_stop 2> /dev/null -fi - -# Vérifie la présence du / en début de path -if [ $(echo $path | cut -c1) != "/" ]; then - path="/$path" -fi +CHECK_FINALPATH # Vérifie que le dossier de destination n'est pas déjà utilisé. # Modifie le domaine pour qu'il passe dans une regex domain_regex=$(echo "$domain" | sed 's@-@.@g') +CHECK_VAR "$domain_regex" "domain_regex empty" if [ "$infcloud" = "Yes" ] || [ "$infcloud" = "yes" ] || [ "$infcloud" = "YES" ] || [ "$infcloud" = "Y" ] || [ "$infcloud" = "y" ] then @@ -113,16 +86,7 @@ sudo mv "$final_path/regex.py" /opt/yunohost/$app/lib/python*/site-packages/radi sudo rm /opt/yunohost/$app/lib/python*/site-packages/radicale/rights/regex.pyc if [ "$infcloud" = "1" ] then #Instal InfCloud - # Télécharge la source - wget -nv --show-progress -i ../sources/source_url -O infcloud.zip - # Vérifie la somme de contrôle de la source téléchargée. - md5sum -c ../sources/source_md5 --status || (echo "Corrupt source" && false) - # Décompresse la source - unzip -q infcloud.zip - # Copie les fichiers sources - sudo cp -a $(cat ../sources/source_dir)/. "$final_path" - # Copie les fichiers additionnels ou modifiés. - sudo cp -a ../sources/ajouts_infcloud/. "$final_path/infcloud/" + SETUP_SOURCE "infcloud.zip" # Télécharge la source, décompresse et copie dans $final_path fi #Configuration Radicale @@ -132,8 +96,8 @@ sudo cp ../conf/logging /etc/$app/ sudo cp ../conf/rights /etc/$app/ sudo sed -i "s@__PATH__@$path@g" /etc/$app/config sudo sed -i "s@__FINALPATH__@$final_path@g" /etc/$app/config -sudo yunohost app setting $app config_file_md5 -v $(md5sum "/etc/$app/config" | cut -d' ' -f1) -sudo yunohost app setting $app logging_file_md5 -v $(md5sum "/etc/$app/logging" | cut -d' ' -f1) +STORE_MD5_CONFIG "config" "/etc/$app/config" # Enregistre la somme de contrôle du fichier de config +STORE_MD5_CONFIG "logging" "/etc/$app/logging" # Enregistre la somme de contrôle du fichier de config if [ "$infcloud" = "1" ] then #Configuration InfCloud # Détermine la langue @@ -176,7 +140,7 @@ then #Configuration InfCloud sudo sed -i "s@__LANG__@$language@g" "$final_path/infcloud/config.js" sudo sed -i "s@__ADMIN__@$admin@g" "$final_path/infcloud/config.js" sudo sed -i "s@__TIMEZONE__@$(cat /etc/timezone)@g" "$final_path/infcloud/config.js" - sudo yunohost app setting $app config.js_file_md5 -v $(md5sum "$final_path/infcloud/config.js" | cut -d' ' -f1) + STORE_MD5_CONFIG "config.js" "$final_path/infcloud/config.js" # Enregistre la somme de contrôle du fichier de config fi # Set permissions to radicale directory @@ -208,16 +172,7 @@ fi if [ "$infcloud" = "1" ] then - # 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 - finalphpconf=/etc/php5/fpm/pool.d/$app.conf - sudo cp ../conf/php-fpm.conf $finalphpconf - sudo chown root: $finalphpconf - 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 + POOL_FPM # Créer le fichier de configuration du pool php-fpm et le configure. fi # Fix permission diff --git a/scripts/remove b/scripts/remove index 1555fad..cda7827 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,7 +1,9 @@ #!/bin/bash +source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script + # Récupère les infos de l'application. -ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2) +YNH_VERSION # Récupère le numéro de version de Yunohost. if [ $ynh_version = "2.4" ]; then app=$YNH_APP_INSTANCE_NAME @@ -12,11 +14,7 @@ else fi domain=$(sudo yunohost app setting $app domain) -# Suppression des dossiers de l'application -if [ -e "/var/www/$app/" ]; then # Delete final_path - echo "Delete app dir" - sudo rm -r "/var/www/$app/" -fi +REMOVE_APP_DIR # Suppression du dossier de l'application if [ -e "/opt/yunohost/$app" ]; then echo "Delete virtualenv" sudo rm -r "/opt/yunohost/$app" @@ -45,29 +43,11 @@ fi # Redémarre le service uwsgi sudo service uwsgi start -# 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 -fi +REMOVE_NGINX_CONF # Suppression de la configuration nginx -# Suppression de la configuration du pool php-fpm -if [ -e "/etc/php5/fpm/pool.d/$app.conf" ]; then # Delete fpm config - echo "Delete fpm config" - sudo rm "/etc/php5/fpm/pool.d/$app.conf" -fi -if [ -e "/etc/php5/fpm/conf.d/20-$app.ini" ]; then # Delete php config - echo "Delete php config" - sudo rm "/etc/php5/fpm/conf.d/20-$app.ini" -fi -sudo service php5-fpm reload +REMOVE_FPM_CONF # Suppression de la configuration du pool php-fpm -# Suppression de la configuration de logrotate - if [ -e "/etc/logrotate.d/$app" ]; then - echo "Delete logrotate config" - sudo rm -r "/etc/logrotate.d/$app" - fi +REMOVE_LOGROTATE_CONF # Suppression de la configuration de logrotate if [ $ynh_version != "2.4" ] then diff --git a/scripts/restore b/scripts/restore index 301b1b9..48696e0 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,7 +1,9 @@ #!/bin/bash +source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script + # Récupère les infos de l'application. -ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2) +YNH_VERSION # Récupère le numéro de version de Yunohost. if [ $ynh_version = "2.4" ]; then app=$YNH_APP_INSTANCE_NAME else diff --git a/scripts/upgrade b/scripts/upgrade index be76822..d5014ee 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,7 +1,9 @@ #!/bin/bash -# Get app settings -ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2) +source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script + +# Récupère les infos de l'application. +YNH_VERSION # Récupère le numéro de version de Yunohost. if [ $ynh_version = "2.4" ]; then app=$YNH_APP_INSTANCE_NAME else @@ -14,6 +16,7 @@ infcloud=$(sudo yunohost app setting $app infcloud) language=$(sudo yunohost app setting $app language) +CHECK_PATH # Vérifie et corrige la syntaxe du path. # Check depends installation sudo apt-get install -y python-pip python-virtualenv python-dev libldap2-dev libsasl2-dev libssl-dev uwsgi uwsgi-plugin-python @@ -46,31 +49,18 @@ sudo mv "$final_path/regex.py" /opt/yunohost/$app/lib/python*/site-packages/radi sudo rm /opt/yunohost/$app/lib/python*/site-packages/radicale/rights/regex.pyc if [ "$infcloud" = "1" ] then #Instal InfCloud - # Télécharge la source - wget -nv --show-progress -i ../sources/source_url -O infcloud.zip - # Vérifie la somme de contrôle de la source téléchargée. - md5sum -c ../sources/source_md5 --status || (echo "Corrupt source" && false) - # Décompresse la source - unzip -q infcloud.zip - # Copie les fichiers sources - sudo cp -a $(cat ../sources/source_dir)/. "$final_path" - # Copie les fichiers additionnels ou modifiés. - sudo cp -a ../sources/ajouts/. "$final_path/infcloud/" + SETUP_SOURCE "infcloud.zip" # Télécharge la source, décompresse et copie dans $final_path fi # Radicale configuration -config_file="/etc/$app/config" -if [ "$(sudo yunohost app setting $app config_file_md5)" != $(md5sum "$config_file" | cut -d' ' -f1) ]; then - sudo cp -a "$config_file" "$config_file.backup.$(date '+%d.%m.%y_%Hh%M,%Ss')" # Si le fichier de config a été modifié, créer un backup. -fi +CHECK_MD5_CONFIG "config" "/etc/$app/config" # Créé un backup du fichier de config si il a été modifié. sudo cp ../conf/config /etc/$app/ -config_file="/etc/$app/logging" -if [ "$(sudo yunohost app setting $app logging_file_md5)" != $(md5sum "$config_file" | cut -d' ' -f1) ]; then - sudo cp -a "$config_file" "$config_file.backup.$(date '+%d.%m.%y_%Hh%M,%Ss')" # Si le fichier de config a été modifié, créer un backup. -fi +CHECK_MD5_CONFIG "logging" "/etc/$app/logging" # Créé un backup du fichier de config si il a été modifié. sudo cp ../conf/logging /etc/$app/ +STORE_MD5_CONFIG "logging" "/etc/$app/logging" # Réenregistre la somme de contrôle du fichier de config sudo sed -i "s@__PATH__@$path@g" /etc/$app/config sudo sed -i "s@__FINALPATH__@$path@g" /etc/$app/config +STORE_MD5_CONFIG "config" "/etc/$app/config" # Réenregistre la somme de contrôle du fichier de config if [ "$infcloud" = "1" ] then #Configuration InfCloud # Détermine la langue @@ -107,16 +97,14 @@ then #Configuration InfCloud ;; esac sudo yunohost app setting $app language -v $language - config_file="$final_path/infcloud/config.js" - if [ "$(sudo yunohost app setting $app config.js_file_md5)" != $(md5sum "$config_file" | cut -d' ' -f1) ]; then - sudo cp -a "$config_file" "$config_file.backup.$(date '+%d.%m.%y_%Hh%M,%Ss')" # Si le fichier de config a été modifié, créer un backup. - fi + CHECK_MD5_CONFIG "config.js" "$final_path/infcloud/config.js" # Enregistre la somme de contrôle du fichier de config sudo cp ../conf/config.js "$final_path/infcloud/" sudo sed -i "s@__DOMAIN__@$domain@g" "$final_path/infcloud/config.js" sudo sed -i "s@__PATH__@$path@g" "$final_path/infcloud/config.js" sudo sed -i "s@__LANG__@$language@g" "$final_path/infcloud/config.js" sudo sed -i "s@__ADMIN__@$admin@g" "$final_path/infcloud/config.js" sudo sed -i "s@__TIMEZONE__@$(cat /etc/timezone)@g" "$final_path/infcloud/config.js" + STORE_MD5_CONFIG "config.js" "$final_path/infcloud/config.js" # Réenregistre la somme de contrôle du fichier de config fi # Copy uwsgi config diff --git a/sources/ajouts_infcloud/cache_update.sh b/sources/ajouts/infcloud/cache_update.sh similarity index 100% rename from sources/ajouts_infcloud/cache_update.sh rename to sources/ajouts/infcloud/cache_update.sh diff --git a/sources/ajouts_infcloud/interface.js b/sources/ajouts/infcloud/interface.js similarity index 100% rename from sources/ajouts_infcloud/interface.js rename to sources/ajouts/infcloud/interface.js