1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/lutim_ynh.git synced 2024-09-03 19:36:24 +02:00

Factorisation du code

This commit is contained in:
Maniack Crudelis 2016-06-15 23:56:45 +02:00
parent c2904771c0
commit fdf555cbee
6 changed files with 228 additions and 102 deletions

178
scripts/.fonctions Executable file
View file

@ -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
}

View file

@ -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

View file

@ -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,65 +34,23 @@ else
fi
script_dir=$PWD
# 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 "$is_public" && (echo "is_public not set" && touch /force_stop)
test -z "$always_encrypt" && (echo "always_encrypt 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 $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
}
TRAP_ON
# Vérifie que les variables ne sont pas vides.
CHECK_VAR "$app" "app name not set"
CHECK_VAR "$script_dir" "script_dir 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
# Vérifie l'absence du / en fin de path
pathRslash=$(echo "$path" | sed 's@/$@@')
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"
# Cherche un port libre.
port=8095
while ! sudo yunohost app checkport $port ; do
port=$((port+1))
done
FIND_PORT 8095 # Cherche un port libre.
# Enregistre les infos dans la config YunoHost
sudo yunohost app setting $app admin -v $admin
@ -96,17 +64,9 @@ sudo yunohost app setting $app always_encrypt -v $always_encrypt
sudo mkdir "$final_path"
sudo yunohost app setting $app final_path -v $final_path
# Télécharge la source
wget -nv --show-progress -i ../sources/source_url -O lutim.tar.gz
# 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
tar -x -f lutim.tar.gz
# 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"
# Et copie le fichier de config nginx
SETUP_SOURCE "lutim.tar.gz" # Télécharge la source, décompresse et copie dans $final_path
# Copie le fichier de config nginx
sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
@ -126,11 +86,13 @@ else
fi
sudo sed -i "s@__ENCRYPT__@$always_encrypt@g" "$final_path/lutim.conf"
secret=$(dd if=/dev/urandom bs=1 count=200 2> /dev/null | tr -c -d 'A-Za-z0-9' | sed -n 's/\(.\{24\}\).*/\1/p')
CHECK_VAR "$secret" "secret empty"
sudo sed -i "s@__SECRET__@$secret@g" "$final_path/lutim.conf"
sudo yunohost app setting $app lutim.conf_file_md5 -v $(md5sum "$final_path/lutim.conf" | cut -d' ' -f1)
STORE_MD5_CONFIG "lutim.conf" "$final_path/lutim.conf" # Enregistre la somme de contrôle du fichier de config
codename=$(lsb_release -a 2>/dev/null | grep Codename | cut -f 2)
CHECK_VAR "$codename" "codename empty"
sudo yunohost app setting $app codename -v $codename
if [ "$codename" = "wheezy" ]
then # On utilise le script init pour wheezy.
@ -170,7 +132,9 @@ arch_dir=$(ls -1 $final_path/local/lib/perl5/ | grep linux-gnu)
if [ "$?" -ne 0 ]
then
echo "Impossible de trouver le dossier relatif à l'architecture système." | sudo tee -a "/var/log/$app/setup_carton.log"
false
fi
CHECK_VAR "$arch_dir" "arch_dir empty"
sudo sed -i "s@__ARCHDIR__@$arch_dir@g" "$final_path/script/lutim"
# Change variables in nginx configuration
@ -181,7 +145,7 @@ sudo sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf
sudo yunohost app setting $app skipped_uris -v "/"
if [ "$is_public" = "No" ];
then # Si l'app est privée, seul le visionnage des images reste public
sudo yunohost app setting $app protected_regex -v "$domain_regex$pathRslash/stats$","$domain_regex$pathRslash/manifest.webapp$","$domain_regex$pathRslash/$","$domain_regex$pathRslash/d/.*$","$domain_regex$pathRslash/m/.*$"
sudo yunohost app setting $app protected_regex -v "$domain_regex$path/stats$","$domain_regex$path/manifest.webapp$","$domain_regex$path/$","$domain_regex$path/d/.*$","$domain_regex$path/m/.*$"
fi
# Making log symbolic link to /var/log

View file

@ -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
@ -34,18 +36,9 @@ then
sudo yunohost service remove lutim
fi
# Suppression du dossier 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
# 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
# Retirer le cron
if [ -e "/etc/cron.d/$app" ]; then
@ -59,11 +52,7 @@ if [ -e "/var/log/$app/" ]; then
sudo rm -r "/var/log/$app/"
fi
# 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_LOGROTATE_CONF # Suppression de la configuration de logrotate
# Régénère la configuration de SSOwat
sudo yunohost app ssowatconf

View file

@ -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

View file

@ -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
@ -20,21 +22,12 @@ then # Si final_path n'est pas renseigné dans la config yunohost, cas d'ancien
fi
# Vérifie l'absence du / en fin de path
pathRslash=$(echo "$path" | sed 's@/$@@')
CHECK_PATH # Vérifie et corrige la syntaxe du path.
# Modifie le domaine pour qu'il passe dans une regex
domain_regex=$(echo "$domain" | sed 's@-@.@g')
# Télécharge la source
wget -nv --show-progress -i ../sources/source_url -O lutim.tar.gz
# 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
tar -x -f lutim.tar.gz
# 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"
SETUP_SOURCE "lutim.tar.gz" # Télécharge la source, décompresse et copie dans $final_path
# Et copie le fichier de config nginx
sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
@ -43,10 +36,7 @@ sudo sed -i "s@__PATH__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf
sudo sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf
## Copie et configuration du fichier de conf.
config_file="$final_path/lutim.conf"
if [ "$(sudo yunohost app setting $app lutim.conf_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 "lutim.conf" "$final_path/lutim.conf" # Créé un backup du fichier de config si il a été modifié.
sudo cp ../conf/lutim.conf.template "$final_path/lutim.conf"
sudo sed -i "s@__DOMAIN__@$domain@g" "$final_path/lutim.conf"
sudo sed -i "s@__PATH__@$path@g" "$final_path/lutim.conf"
@ -57,6 +47,7 @@ else
always_encrypt=1
fi
sudo sed -i "s@__ENCRYPT__@$always_encrypt@g" "$final_path/lutim.conf"
STORE_MD5_CONFIG "lutim.conf" "$final_path/lutim.conf" # Réenregistre la somme de contrôle du fichier de config
codename=$(lsb_release -a 2>/dev/null | grep Codename | cut -f 2)
sudo yunohost app setting $app codename -v $codename
@ -102,7 +93,7 @@ sudo carton install 2>&1 | sudo tee -a "/var/log/$app/setup_carton.log"
sudo yunohost app setting $app skipped_uris -v "/"
if [ "$is_public" = "No" ];
then # Si l'app est privée, seul le visionnage des images reste public
sudo yunohost app setting $app protected_regex -v "$domain_regex$pathRslash/stats$","$domain_regex$pathRslash/manifest.webapp$","$domain_regex$pathRslash/$","$domain_regex$pathRslash/d/.*$","$domain_regex$pathRslash/m/.*$"
sudo yunohost app setting $app protected_regex -v "$domain_regex$path/stats$","$domain_regex$path/manifest.webapp$","$domain_regex$path/$","$domain_regex$path/d/.*$","$domain_regex$path/m/.*$"
fi
# Configure les droits d'accès au fichiers