From e7a9e8a9b0bddf1fbe3ce648f859e12226bfa9c9 Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Wed, 14 Dec 2016 16:05:13 +0100 Subject: [PATCH] Usage des helpers et fix restore --- scripts/.fonctions | 27 +++++++++++++------------ scripts/backup | 4 ++-- scripts/install | 44 ++++++++++++++++++++--------------------- scripts/remove | 6 +++--- scripts/restore | 49 ++++++++++++++++++++++++++++------------------ scripts/upgrade | 28 +++++++++++++------------- 6 files changed, 85 insertions(+), 73 deletions(-) diff --git a/scripts/.fonctions b/scripts/.fonctions index fcd5b76..5475459 100755 --- a/scripts/.fonctions +++ b/scripts/.fonctions @@ -16,7 +16,7 @@ EXIT_PROPERLY () { # Provoque l'arrêt du script en cas d'erreur. Et nettoye les # Compense le bug de ssowat qui ne supprime pas l'entrée de l'app en cas d'erreur d'installation. sudo sed -i "\@\"$domain$path/\":@d" /etc/ssowat/conf.json - exit 1 + ynh_die } TRAP_ON () { # Activate signal capture @@ -32,7 +32,7 @@ TRAP_OFF () { # Ignoring signal capture until TRAP_ON 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" >&2 && false) + ynh_user_exists "$1" || (echo "Wrong admin" >&2 && false) } CHECK_PATH () { # Vérifie la présence du / en début de path. Et son absence à la fin. @@ -59,14 +59,15 @@ CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà u GENERATE_DB () { # Créer une base de données et un utilisateur dédié au nom de l'app. # $1 = Nom de la base de donnée - # Génère un mot de passe aléatoire. db_user=$1 - db_pwd=$(head -n20 /dev/urandom | tr -c -d 'A-Za-z0-9' | head -c20) + # Génère un mot de passe aléatoire. +# db_pwd=$(head -n20 /dev/urandom | tr -c -d 'A-Za-z0-9' | head -c20) + db_pwd=$(ynh_string_random) CHECK_VAR "$db_pwd" "db_pwd empty" # Utilise '$app' comme nom d'utilisateur et de base de donnée # 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 + ynh_app_setting_set $app mysqlpwd $db_pwd } SETUP_SOURCE () { # Télécharge la source, décompresse et copie dans $final_path @@ -91,7 +92,7 @@ SETUP_SOURCE () { # Télécharge la source, décompresse et copie dans $final_pa } ADD_SYS_USER () { # Créer un utilisateur système dédié à l'app - if grep -q "^$app:" /etc/passwd # Test l'existence de l'utilisateur + 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 || (echo "Unable to create $app system account" >&2 && false) fi @@ -113,13 +114,13 @@ POOL_FPM () { # Créer le fichier de configuration du pool php-fpm et le configu 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 $(sudo md5sum "$2" | cut -d' ' -f1) + ynh_app_setting_set $app $1_file_md5 $(sudo 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)" != $(sudo md5sum "$2" | cut -d' ' -f1) ]; then + if [ "$(ynh_app_setting_get $app $1_file_md5)" != $(sudo 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 } @@ -164,7 +165,7 @@ REMOVE_LOGROTATE_CONF () { # Suppression de la configuration de logrotate } SECURE_REMOVE () { # Suppression de dossier avec vérification des variables - chaine="$1" + chaine="$1" # L'argument doit être donné entre quotes simple '', pour éviter d'interpréter les variables. no_var=0 while (echo "$chaine" | grep -q '\$') # Boucle tant qu'il y a des $ dans la chaine do @@ -180,8 +181,10 @@ SECURE_REMOVE () { # Suppression de dossier avec vérification des variable done if [ "$no_var" -eq 1 ] then - echo "Delete directory $chaine" - sudo rm -r "$chaine" + if [ -e "$chaine" ]; then + echo "Delete directory $chaine" + sudo rm -r "$chaine" + fi return 0 else echo "No detected variable." >&2 @@ -201,7 +204,7 @@ REMOVE_BDD () { # Suppression de la base de donnée et de l'utilisateur associé } REMOVE_SYS_USER () { # Supprime l'utilisateur système dédié à l'app - if grep -q "^$app:" /etc/passwd # Test l'existence de l'utilisateur + if ynh_system_user_exists "$app" # Test l'existence de l'utilisateur then sudo userdel $app fi diff --git a/scripts/backup b/scripts/backup index 6b0fc60..c0cd5d6 100644 --- a/scripts/backup +++ b/scripts/backup @@ -5,8 +5,8 @@ source /usr/share/yunohost/helpers # Récupère les infos de l'application. app=$YNH_APP_INSTANCE_NAME -final_path=$(sudo yunohost app setting $app final_path) -domain=$(sudo yunohost app setting $app domain) +final_path=$(ynh_app_setting_get $app final_path) +domain=$(ynh_app_setting_get $app domain) # The parameter $1 is the backup directory location diff --git a/scripts/install b/scripts/install index 2832e92..2e86d19 100644 --- a/scripts/install +++ b/scripts/install @@ -4,7 +4,11 @@ source .fonctions # Charge les fonctions génériques habituellement utilisées CLEAN_SETUP () { # Nettoyage des résidus d'installation non pris en charge par le script remove. -# Pas de nettoyage supplémentaire nécessaire ici... + if test -n "$PID_TAIL" + then + kill -s 15 $PID_TAIL > /dev/null # Arrête l'exécution de tail. + sudo rm -f "$tempfile" + fi echo "" } TRAP_ON # Active trap pour arrêter le script si une erreur est détectée. @@ -53,13 +57,13 @@ CHECK_FINALPATH # Vérifie que le dossier de destination n'est pas déjà utilis FIND_PORT 9001 # Cherche un port libre. # Enregistre les infos dans la config YunoHost -sudo yunohost app setting $app domain -v $domain -sudo yunohost app setting $app admin -v $admin -sudo yunohost app setting $app is_public -v $is_public -sudo yunohost app setting $app password -v $password -sudo yunohost app setting $app language -v $language -sudo yunohost app setting $app port -v $port -sudo yunohost app setting $app abiword -v $abiword +ynh_app_setting_set $app domain $domain +ynh_app_setting_set $app admin $admin +ynh_app_setting_set $app is_public $is_public +ynh_app_setting_set $app password $password +ynh_app_setting_set $app language $language +ynh_app_setting_set $app port $port +ynh_app_setting_set $app abiword $abiword GENERATE_DB $app # Créer une base de données et un utilisateur dédié au nom de l'app. @@ -67,7 +71,7 @@ GENERATE_DB $app # Créer une base de données et un utilisateur dédié au nom # Créer le repertoire de destination et stocke son emplacement. sudo mkdir "$final_path" -sudo yunohost app setting $app final_path -v $final_path +ynh_app_setting_set $app final_path $final_path SETUP_SOURCE "1.6.0.tar.gz" # Télécharge la source, décompresse et copie dans $final_path @@ -81,20 +85,14 @@ sudo sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf sudo apt-get update sudo apt-get install npm nodejs-legacy -qy -# Créer l'user etherpad -if ! grep -q "^etherpad:" /etc/passwd # Test l'existence de l'utilisateur -then # Si il n'existe pas, l'user etherpad est créé - sudo useradd etherpad -d /home/.etherpad -fi -sudo mkdir -p /home/.etherpad -sudo chown etherpad: -R /home/.etherpad +ADD_SYS_USER # Créer un user système dédié pour l'application # Créer le dossier de log sudo mkdir -p /var/log/$app sudo touch /var/log/$app/etherpad.log install_log=/var/log/$app/installation.log sudo touch $install_log -sudo chown etherpad -R /var/log/$app +sudo chown $app -R /var/log/$app sudo chown admin -R $install_log # Installe les dépendances de etherpad et procède à l'intallation. @@ -122,7 +120,7 @@ STORE_MD5_CONFIG "credentials.json" "$final_path/credentials.json" # Enregistre # Configure les droits d'accès au fichiers # Les fichiers appartiennent à etherpad -sudo chown -R etherpad: $final_path +sudo chown -R $app: $final_path sudo chmod 600 $final_path/credentials.json # Restreint l'accès à credentials.json @@ -162,7 +160,7 @@ sudo npm install ep_subscript_and_superscript >> $install_log 2>&1 # Framapad - sudo npm install ep_table_of_contents >> $install_log 2>&1 # Framapad - View a table of contents for your pad # sudo npm install ep_unoconv # Framapad - Use unoconv instead of abiword to export pads. sudo npm install ep_user_font_size >> $install_log 2>&1 # Framapad - User Pad Contents font size can be set in settings, this does not effect other peoples views -sudo chown -R etherpad: $final_path/node_modules +sudo chown -R $app: $final_path/node_modules # Ajoute un lien vers etherpad pour créer des pads anonymes depuis Mypads. sudo sed -i "s@^ *\"DESCRIPTION\": .*@&Pads anonymes@g" $final_path/node_modules/ep_mypads/static/l10n/fr.json @@ -182,9 +180,9 @@ sudo service $app start # Démarre etherpad. Le démarrage est fait le plus tôt # Make app public if necessary if [ "$is_public" = "Yes" ]; then - sudo yunohost app setting $app skipped_uris -v "/" + ynh_app_setting_set $app skipped_uris "/" else - sudo yunohost app setting $app skipped_uris -v "/admin" # La page d'admin etherpad ne supporte pas le sso... + ynh_app_setting_set $app skipped_uris "/admin" # La page d'admin etherpad ne supporte pas le sso... fi # Recharge la configuration Nginx @@ -194,8 +192,8 @@ sudo yunohost app ssowatconf # Surveille le démarrage du service. lang_OK=0 -for i in `seq 1 30` -do # La boucle attend le démarrage d'etherpad. Ou 30 secondes. Cette boucle évite simplement un 502 au début, car le démarrage est long... +for i in `seq 1 60` +do # La boucle attend le démarrage d'etherpad. Ou 1 minute. Cette boucle évite simplement un 502 au début, car le démarrage est long... if grep -q "You can access your Etherpad instance at" "$tempfile" && [ "$lang_OK" -eq 0 ] ; then # Si le log annonce une première fois le démarrage d'etherpad, applique la langue de mypads et redémarre le service. sudo sed -i "s/__LANGUAGE__/$language/g" "$script_dir/../conf/lang_mypads.sql" diff --git a/scripts/remove b/scripts/remove index 6d3b68f..87284bf 100755 --- a/scripts/remove +++ b/scripts/remove @@ -8,8 +8,8 @@ app=$YNH_APP_INSTANCE_NAME # Source app helpers source /usr/share/yunohost/helpers -domain=$(sudo yunohost app setting $app domain) -port=$(sudo yunohost app setting $app port) +domain=$(ynh_app_setting_get $app domain) +port=$(ynh_app_setting_get $app port) # Arrêt du service @@ -24,7 +24,7 @@ fi if sudo yunohost service status | grep -q $app # Test l'existence du service dans Yunohost then echo "Remove $app service" - sudo yunohost service remove $app.service + sudo yunohost service remove $app fi REMOVE_BDD $app # Suppression de la base de donnée et de l'utilisateur associé. diff --git a/scripts/restore b/scripts/restore index 6f0679a..469336a 100644 --- a/scripts/restore +++ b/scripts/restore @@ -5,12 +5,11 @@ source /usr/share/yunohost/helpers # Récupère les infos de l'application. app=$YNH_APP_INSTANCE_NAME -domain=$(sudo yunohost app setting $app domain) -final_path=$(sudo yunohost app setting $app final_path) +domain=$(ynh_app_setting_get $app domain) +final_path=$(ynh_app_setting_get $app final_path) if [ -d $final_path ]; then - echo "There is already a directory: $final_path " >&2 - exit 1 + ynh_die "There is already a directory: $final_path" fi # The parameter $1 is the uncompressed restore directory location @@ -19,8 +18,7 @@ backup_dir=$1/apps/$app # Restore Nginx conf=/etc/nginx/conf.d/$domain.d/$app.conf if [ -f $conf ]; then - echo "There is already a nginx conf file at this path: $conf " >&2 - exit 1 + ynh_die "There is already a nginx conf file at this path: $conf" fi sudo cp -a $backup_dir/nginx.conf $conf @@ -30,28 +28,39 @@ sudo cp -a $backup_dir/yunohost/. /etc/yunohost/apps/$app # Restore sources & data sudo cp -a "$backup_dir/sources/." $final_path +# Créer le dossier de log +sudo mkdir -p /var/log/$app +sudo touch /var/log/$app/etherpad.log +install_log=/var/log/$app/installation.log +sudo touch $install_log +sudo chown etherpad -R /var/log/$app +sudo chown admin -R $install_log + +# Installation de npm et nodejs +sudo apt-get update +sudo apt-get install npm nodejs-legacy -qy + +# Installe les dépendances de etherpad +# sudo "$final_path/bin/installDeps.sh" > $install_log 2>&1 +sudo npm install forever -g >> $install_log 2>&1 + # Créer la base de donnée et la restaure -db_pwd=$(sudo yunohost app setting $app mysqlpwd) +db_pwd=$(ynh_app_setting_get $app mysqlpwd) db_user=$app ynh_mysql_create_db $db_user $db_user $db_pwd mysql --debug-check -u $db_user -p$db_pwd $db_user < ${backup_dir}/db.sql -# Créer l'user etherpad -if ! grep -q "^etherpad:" /etc/passwd # Test l'existence de l'utilisateur -then # Si il n'existe pas, l'user etherpad est créé - sudo useradd etherpad -r +# ADD_SYS_USER # Créer un user système dédié pour l'application +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 || (echo "Unable to create $app system account" >&2 && false) fi -# Créer le dossier de log -sudo mkdir -p /var/log/$app -sudo touch /var/log/$app/etherpad.log -sudo chown etherpad -R /var/log/$app - # Restaure la configuration de logrotate sudo cp -a $backup_dir/logrotate /etc/logrotate.d/$app # Ajoute le service au monitoring de Yunohost. -sudo yunohost service add $app.service --log "/var/log/$app/etherpad.log" +sudo yunohost service add $app --log "/var/log/$app/etherpad.log" # Restauration des fichiers du script systemd sudo cp -a $backup_dir/$app.service /etc/systemd/system/$app.service @@ -69,8 +78,8 @@ sudo service $app start # Démarre etherpad. Le démarrage est fait le plus tôt sudo service nginx reload # Surveille le démarrage du service. -for i in `seq 1 20` -do # La boucle attend le démarrage d'etherpad. Ou 20 secondes. Cette boucle évite simplement un 502 au début, car le démarrage est long... +for i in `seq 1 60` +do # La boucle attend le démarrage d'etherpad. Ou 1 minute. Cette boucle évite simplement un 502 au début, car le démarrage est long... if grep -q "You can access your Etherpad instance at" "$tempfile"; then break # Si le log annonce le démarrage d'etherpad, sort de la boucle. fi @@ -80,3 +89,5 @@ done echo "" kill -s 15 $PID_TAIL > /dev/null # Arrête l'exécution de tail. sudo rm "$tempfile" + +sudo cat /var/log/$app/etherpad.log >&2 diff --git a/scripts/upgrade b/scripts/upgrade index 3354e44..e91bc24 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -7,14 +7,14 @@ source /usr/share/yunohost/helpers # Récupère les infos de l'application. app=$YNH_APP_INSTANCE_NAME -domain=$(sudo yunohost app setting $app domain) -path=$(sudo yunohost app setting $app path) -admin=$(sudo yunohost app setting $app admin) -language=$(sudo yunohost app setting $app language) -is_public=$(sudo yunohost app setting $app is_public) -final_path=$(sudo yunohost app setting $app final_path) -port=$(sudo yunohost app setting $app port) -abiword=$(sudo yunohost app setting $app abiword) +domain=$(ynh_app_setting_get $app domain) +path=$(ynh_app_setting_get $app path) +admin=$(ynh_app_setting_get $app admin) +language=$(ynh_app_setting_get $app language) +is_public=$(ynh_app_setting_get $app is_public) +final_path=$(ynh_app_setting_get $app final_path) +port=$(ynh_app_setting_get $app port) +abiword=$(ynh_app_setting_get $app abiword) SETUP_SOURCE "1.6.0.tar.gz" # Télécharge la source, décompresse et copie dans $final_path @@ -33,7 +33,7 @@ sudo cp ../conf/settings.json "$final_path/settings.json" sudo cp ../conf/credentials.json "$final_path/credentials.json" sudo sed -i "s/__PORT__/$port/g" "$final_path/settings.json" sudo sed -i "s/__DB_USER__/$app/g" "$final_path/credentials.json" -db_pwd=$(sudo yunohost app setting $app mysqlpwd) +db_pwd=$(ynh_app_setting_get $app mysqlpwd) sudo sed -i "s/__DB_PWD__/$db_pwd/g" "$final_path/credentials.json" sudo sed -i "s/__ADMIN__/$admin/g" "$final_path/credentials.json" sudo sed -i "s/__PASSWD__/$password/g" "$final_path/credentials.json" @@ -44,7 +44,7 @@ then fi if test -z $language; then language=en # En cas d'upgrade d'une version ne gérant pas la langue, la langue est anglais par défaut - sudo yunohost app setting $app language -v $language + ynh_app_setting_set $app language $language fi sudo sed -i "s/__LANGUAGE__/$language/g" "$final_path/settings.json" STORE_MD5_CONFIG "settings.json" "$final_path/settings.json" # Réenregistre la somme de contrôle du fichier de config @@ -92,9 +92,9 @@ sudo service $app start # Démarre etherpad. Le démarrage est fait le plus tôt # Make app public if necessary if [ "$is_public" = "Yes" ]; then - sudo yunohost app setting $app skipped_uris -v "/" + ynh_app_setting_set $app skipped_uris "/" else - sudo yunohost app setting $app skipped_uris -v "/admin" # La page d'admin etherpad ne supporte pas le sso... + ynh_app_setting_set $app skipped_uris "/admin" # La page d'admin etherpad ne supporte pas le sso... fi # Recharge la configuration Nginx @@ -103,8 +103,8 @@ sudo service nginx reload sudo yunohost app ssowatconf # Surveille le démarrage du service. -for i in `seq 1 20` -do # La boucle attend le démarrage d'etherpad. Ou 20 secondes. Cette boucle évite simplement un 502 au début, car le démarrage est long... +for i in `seq 1 60` +do # La boucle attend le démarrage d'etherpad. Ou 1 minute. Cette boucle évite simplement un 502 au début, car le démarrage est long... if grep -q "You can access your Etherpad instance at" "$tempfile"; then break # Si le log annonce le démarrage d'etherpad, sort de la boucle. fi