From 0a87fdbb42fcee7b64aced639ffba94892dc96ef Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Sun, 19 Mar 2017 18:41:21 +0100 Subject: [PATCH] Reprise globale du package --- README.md | 24 +- check_process | 20 +- conf/app.src | 2 + conf/php-fpm.conf | 4 +- manifest.json | 12 +- scripts/.fonctions | 564 ++++++++++++++++++++++++++++++++++----------- scripts/backup | 68 ++++-- scripts/install | 228 +++++++++++------- scripts/remove | 54 ++++- scripts/restore | 114 ++++++--- scripts/upgrade | 148 +++++++++--- sources/source_dir | 1 - sources/source_md5 | 1 - sources/source_url | 1 - 14 files changed, 888 insertions(+), 353 deletions(-) create mode 100644 conf/app.src delete mode 100644 sources/source_dir delete mode 100644 sources/source_md5 delete mode 100644 sources/source_url diff --git a/README.md b/README.md index 1087a49..a02c88a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,24 @@ -Wordpress multisite for YunoHost +# Wordpress multisite for YunoHost ================== -[Yunohost project](https://yunohost.org/#/) +Site du project Yunohost : [Yunohost.org](https://yunohost.org/#/) +## English version +Wordpress lets you create your blog or web site very easily.
+With this package, you can even activate the [multisite](http://codex.wordpress.org/Glossary#Multisite) + +https://wordpress.org/ + +If the multisite option is activated, the script also installs *php5-cli*. + +**How to upgrade the package:** +1) sudo yunohost app upgrade --verbose wordpress -u https://github.com/YunoHost-Apps/wordpress_ynh
+2) To be noted that once installed, the updates of the php code of the Wordpress blog are managed from the Wordpress web admin interface.
+3) There may also be some upgrades of the wordpress_ynh package, these are to cover its integration whithin the Yunohost system. + +**Multi-user support:** Yes, with LDAP ability. + +## Version Française Logiciel de création de blog ou de site Web avec option [multisite](http://codex.wordpress.org/Glossary#Multisite) https://wordpress.org/ @@ -10,6 +26,8 @@ https://wordpress.org/ Si l'option multisite est activée, le script installe le paquet *php5-cli*. **Mise à jour du package:** -sudo yunohost app upgrade --verbose wordpress -u https://github.com/YunoHost-Apps/wordpress_ynh +1) sudo yunohost app upgrade --verbose wordpress -u https://github.com/YunoHost-Apps/wordpress_ynh
+2) A noter qu'une fois installé, les mises à jour du code php du blog Wordpress se font depuis l'interface wed d'admin de Wordpress
+3) Il peut également y avoir des mises à jour du paquet wordpress_ynh, celles-ci sont liées à l'intégration du paquet dans le systeme Yunohost. **Multi-utilisateur:** Oui, avec support ldap. diff --git a/check_process b/check_process index 5402b3b..fed2063 100644 --- a/check_process +++ b/check_process @@ -5,8 +5,8 @@ path="/path" (PATH) admin="john" (USER) language="fr_FR" - multisite="No" - is_public="Yes" (PUBLIC|public=Yes|private=No) + multisite=0 + is_public=1 (PUBLIC|public=1|private=0) ; Checks pkg_linter=1 setup_sub_dir=1 @@ -17,13 +17,8 @@ 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 ;; Test avec multisite auto_remove=1 ; Manifest @@ -31,8 +26,8 @@ path="/path" (PATH) admin="john" (USER) language="fr_FR" - multisite="Yes" - is_public="Yes" (PUBLIC|public=Yes|private=No) + multisite=1 + is_public=1 (PUBLIC|public=1|private=0) ; Checks setup_sub_dir=1 setup_root=0 @@ -42,18 +37,15 @@ upgrade=1 backup_restore=1 multi_instance=1 - wrong_user=0 - wrong_path=0 incorrect_path=0 - 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/YunoHost-Apps/wordpress_ynh/blob/master/conf/sql/single.sql#L1 Level 4=1 +# Level 5: https://github.com/YunoHost-Apps/wordpress_ynh/issues/18 Level 5=1 Level 6=auto Level 7=auto diff --git a/conf/app.src b/conf/app.src new file mode 100644 index 0000000..2041a74 --- /dev/null +++ b/conf/app.src @@ -0,0 +1,2 @@ +SOURCE_URL>https://wordpress.org/wordpress-4.7.2.tar.gz +SOURCE_SUM=17f9fe2fa6d14eba86aad152059b5afd diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf index b516d66..6c69660 100644 --- a/conf/php-fpm.conf +++ b/conf/php-fpm.conf @@ -19,8 +19,8 @@ ; Unix user/group of processes ; Note: The user is mandatory. If the group is not set, the default user's group ; will be used. -user = www-data -group = www-data +user = __USER__ +group = __USER__ ; The address on which to accept FastCGI requests. ; Valid syntaxes are: diff --git a/manifest.json b/manifest.json index 67ef8ca..bcc0c71 100644 --- a/manifest.json +++ b/manifest.json @@ -9,9 +9,9 @@ "en": "Create a beautiful blog or website easily", "fr": "Logiciel de création de blog ou de site Web" }, - "version": "4.5.2", + "version": "4.7.2", "url": "https://wordpress.org/", - "license": "free", + "license": "GPLv2", "maintainer": { "name": "Maniack Crudelis", "email": "maniackc_dev@crudelis.fr" @@ -63,21 +63,21 @@ }, { "name": "multisite", + "type": "boolean", "ask": { "en": "Enable multisite option ?", "fr": "Activer l'option multisite ?" }, - "choices": ["Yes", "No"], - "default": "No" + "default": false }, { "name": "is_public", + "type": "boolean", "ask": { "en": "Is it a public WordPress site ?", "fr": "Est-ce un site public ?" }, - "choices": ["Yes", "No"], - "default": "Yes" + "default": true } ] } diff --git a/scripts/.fonctions b/scripts/.fonctions index c18e8d3..2243dd2 100755 --- a/scripts/.fonctions +++ b/scripts/.fonctions @@ -1,103 +1,86 @@ #!/bin/bash -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" >&2 && false) -} - -EXIT_PROPERLY () { # Provoque l'arrêt du script en cas d'erreur. Et nettoye les résidus. - exit_code=$? - if [ "$exit_code" -eq 0 ]; then - exit 0 # Quitte sans erreur si le script se termine correctement. - fi - trap '' EXIT - set +eu - 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!!" >&2 - - if type -t CLEAN_SETUP > /dev/null; then # Vérifie l'existance de la fonction avant de l'exécuter. - CLEAN_SETUP # Appel la fonction de nettoyage spécifique du script install. - fi - - # 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 - - ynh_die -} - -TRAP_ON () { # Activate signal capture - set -eu # Exit if a command fail, and if a variable is used unset. - trap EXIT_PROPERLY EXIT # Capturing exit signals on shell script -} +#================================================= +# CHECKING +#================================================= CHECK_USER () { # Vérifie la validité de l'user admin # $1 = Variable de l'user admin. - 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. - 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 + ynh_user_exists "$1" || ynh_die "Wrong user" } CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine. - sudo yunohost app checkurl $domain$path -a $app + sudo yunohost app checkurl $domain$path_url -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" >&2 - false - fi + test ! -e "$final_path" || ynh_die "This path already contains a folder" } -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 - db_user=$1 - db_user=${db_user//-/_} # mariadb ne supporte pas les - dans les noms de base de données. Ils sont donc remplacé par des _ - # 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 - ynh_app_setting_set $app mysqlpwd $db_pwd +#================================================= +# 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 +} + +#================================================= +# SETUP +#================================================= + 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 -i ../sources/source_url -O $1 + 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 # Vérifie la somme de contrôle de la source téléchargée. - md5sum -c ../sources/source_md5 --status || (echo "Corrupt source" >&2 && 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" + echo "$src_checksum source.tar.gz" | md5sum -c --status || ynh_die "Corrupt source" + # Extract source into the app dir + sudo mkdir -p $final_path + sudo tar -x -f source.tar.gz -C $final_path --strip-components 1 # 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 || (echo "Unable to create $app system account" >&2 && false) - fi +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_checksum=$(cat ../conf/app.src | grep SOURCE_SUM | cut -d= -f2) + # Download sources from the upstream + wget -nv -O source.zip $src_url + # Vérifie la somme de contrôle de la source téléchargée. + echo "$src_checksum source.zip" | md5sum -c --status || ynh_die "Corrupt source" + # Extract source into the app dir + sudo mkdir -p $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 } POOL_FPM () { # Créer le fichier de configuration du pool php-fpm et le configure. @@ -110,9 +93,123 @@ 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 + curl -kL -H "Host: $domain" --resolve $domain:443:127.0.0.1 --data "$data_post" "https://localhost$path_url$url_access" 2>&1 +} + +#================================================= +# REMOVE +#================================================= + +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 systemctl reload nginx + 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 systemctl reload php5-fpm +} + +SECURE_REMOVE () { # Suppression de dossier avec vérification des variables + 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 + no_var=1 + global_var=$(echo "$chaine" | cut -d '$' -f 2) # Isole la première variable trouvée. + only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)') # Isole complètement la variable en ajoutant le $ au début et en gardant uniquement le nom de la variable. Se débarrasse surtout du / et d'un éventuel chemin derrière. + real_var=$(eval "echo ${only_var}") # `eval "echo ${var}` permet d'interpréter une variable contenue dans une variable. + if test -z "$real_var" || [ "$real_var" = "/" ]; then + WARNING echo "Variable $only_var is empty, suppression of $chaine cancelled." + return 1 + fi + chaine=$(echo "$chaine" | sed "s@$only_var@$real_var@") # remplace la variable par sa valeur dans la chaine. + done + if [ "$no_var" -eq 1 ] + then + if [ -e "$chaine" ]; then + echo "Delete directory $chaine" + sudo rm -r "$chaine" + fi + return 0 + else + WARNING echo "No detected variable." + return 1 + fi +} + +#================================================= +# 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 + 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 +#================================================= + 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. @@ -127,87 +224,278 @@ CHECK_MD5_CONFIG () { # Créé un backup du fichier de config si il a été modi 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" + +#================================================= +#================================================= +# 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 +#================================================= + +# Ignore the yunohost-cli log to prevent errors with conditionals commands +# usage: ynh_no_log COMMAND +# Simply duplicate the log, execute the yunohost command and replace the log without the result of this command +# It's a very badly hack... +ynh_no_log() { + ynh_cli_log=/var/log/yunohost/yunohost-cli.log + sudo cp -a ${ynh_cli_log} ${ynh_cli_log}-move + eval $@ + exit_code=$? + sudo mv ${ynh_cli_log}-move ${ynh_cli_log} + return $? } +# Normalize the url path syntax +# Handle the slash at the beginning of path and its absence at ending +# Return a normalized url path +# +# 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 +# +# 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 +} -### REMOVE SCRIPT +# Create a database, an user and its password. Then store the password in the app's config +# +# User of database will be store in db_user's variable. +# Name of database will be store in db_name's variable. +# And password in db_pwd's variable. +# +# usage: ynh_mysql_generate_db user name +# | arg: user - Owner of the database +# | arg: name - Name of the database +ynh_mysql_generate_db () { + db_pwd=$(ynh_string_random) # Generate a random password + ynh_mysql_create_db "$2" "$1" "$db_pwd" # Create the database + ynh_app_setting_set $app mysqlpwd $db_pwd # Store the password in the app's config +} -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 +# Remove a database if it exist and the associated user +# +# usage: ynh_mysql_remove_db user name +# | arg: user - Proprietary of the database +# | arg: name - Name of the database +ynh_mysql_remove_db () { + if mysqlshow -u root -p$(sudo cat $MYSQL_ROOT_PWD_FILE) | grep -q "^| $2"; then # Check if the database exist + echo "Remove database $2" >&2 + ynh_mysql_drop_db $2 # Remove the database + ynh_mysql_drop_user $1 # Remove the associated user to database + else + echo "Database $2 not found" >&2 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 +# Correct the name given in argument for mariadb +# +# 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_make_valid_dbid () { + dbid=${1//[-.]/_} # Mariadb doesn't support - and . in the name of databases. It will be replace by _ + echo $dbid } -REMOVE_LOGROTATE_CONF () { # Suppression de la configuration de logrotate +# Manage a fail of the script +# +# Print a warning to inform that the script was failed +# Execute the ynh_clean_setup function if used in the app script +# +# 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_check_error. +# 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 +} + +# Exit if an error occurs during the execution of the script. +# +# 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 +} + +# Install dependencies with a equivs control file +# +# 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 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 '-' + + 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 +} + +# 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 - echo "Delete logrotate config" sudo rm "/etc/logrotate.d/$app" fi } -SECURE_REMOVE () { # Suppression de dossier avec vérification des variables - 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 +# 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 - no_var=1 - global_var=$(echo "$chaine" | cut -d '$' -f 2) # Isole la première variable trouvée. - only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)') # Isole complètement la variable en ajoutant le $ au début et en gardant uniquement le nom de la variable. Se débarrasse surtout du / et d'un éventuel chemin derrière. - real_var=$(eval "echo ${only_var}") # `eval "echo ${var}` permet d'interpréter une variable contenue dans une variable. - if test -z "$real_var" || [ "$real_var" = "/" ]; then - echo "Variable $only_var is empty, suppression of $chaine cancelled." >&2 - return 1 - fi - chaine=$(echo "$chaine" | sed "s@$only_var@$real_var@") # remplace la variable par sa valeur dans la chaine. + port=$((port+1)) # Else, pass to next port done - if [ "$no_var" -eq 1 ] - then - if [ -e "$chaine" ]; then - echo "Delete directory $chaine" - sudo rm -r "$chaine" + 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 - return 0 - else - echo "No detected variable." >&2 - return 1 + sudo useradd $user_home_dir --system --user-group $1 --shell /usr/sbin/nologin || ynh_die "Unable to create $1 system account" fi } -REMOVE_BDD () { # Suppression de la base de donnée et de l'utilisateur associé. -# $1 = Nom de la base de donnée - # Utilise '$app' comme nom d'utilisateur et de base de donnée - db_user=$1 - 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 -} - -REMOVE_SYS_USER () { # Supprime l'utilisateur système dédié à l'app - if ynh_system_user_exists "$app" # Test l'existence de l'utilisateur +# 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 - sudo userdel $app + 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 c2b8361..fd8538f 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,29 +1,63 @@ #!/bin/bash -# The parameter $1 is the backup directory location dedicated to the app -backup_dir=$1 +#================================================= +# GENERIC STARTING +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= -# The parameter $2 is theid of the app instance -app=$2 +# Exit on command errors and treat unset variables as an error +set -eu -# Source app helpers +#================================================= +# 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 +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + domain=$(ynh_app_setting_get $app domain) final_path=$(ynh_app_setting_get $app final_path) +db_name=$(ynh_app_setting_get $app db_name) +db_pwd=$(ynh_app_setting_get "$app" mysqlpwd) -# Copy the app files -sudo mkdir -p ${backup_dir}/var/www -sudo cp -a $final_path "${backup_dir}/var/www/$app" +#================================================= +# STANDARD BACKUP STEPS +#================================================= +# BACKUP OF THE MAIN DIR OF THE APP +#================================================= -# Copy the conf files -sudo mkdir -p "${backup_dir}/conf" -sudo cp -a /etc/nginx/conf.d/$domain.d/$app.conf "${backup_dir}/conf/nginx.conf" +CHECK_SIZE "$final_path" +ynh_backup "$final_path" "sources" -# Copy dedicated php-fpm process to backup folder -sudo cp -a /etc/php5/fpm/pool.d/$app.conf "${backup_dir}/conf/php-fpm.conf" -sudo cp -a /etc/php5/fpm/conf.d/20-$app.ini "${backup_dir}/conf/php-fpm.ini" +#================================================= +# BACKUP OF THE NGINX CONFIGURATION +#================================================= -# Backup db -root_pwd=$(sudo cat /etc/yunohost/mysql) -sudo su -c "mysqldump -u root -p$root_pwd --no-create-db $app > ${backup_dir}/db.sql" +ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "nginx.conf" + +#================================================= +# BACKUP OF THE PHP-FPM CONFIGURATION +#================================================= + +ynh_backup "/etc/php5/fpm/pool.d/$app.conf" "php-fpm.conf" +ynh_backup "/etc/php5/fpm/conf.d/20-$app.ini" "php-fpm.ini" + +#================================================= +# BACKUP OF THE SQL BDD +#================================================= + +ynh_mysql_dump_db "$db_name" > dump.sql +CHECK_SIZE "dump.sql" +ynh_backup "dump.sql" "db.sql" diff --git a/scripts/install b/scripts/install index e1b4e36..feaaaea 100644 --- a/scripts/install +++ b/scripts/install @@ -1,17 +1,27 @@ #!/bin/bash -source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -CLEAN_SETUP () { -# Nettoyage des résidus d'installation non pris en charge par le script remove. - # Clean hosts - sudo sed -i '/#WORDPRESS/d' /etc/hosts -} -TRAP_ON # Active trap pour arrêter le script si une erreur est détectée. +source .fonctions +source /usr/share/yunohost/helpers + +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= + +ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. + +#================================================= +# RETRIEVE ARGUMENTS FROM THE MANIFEST +#================================================= # Retrieve arguments domain=$YNH_APP_ARG_DOMAIN -path=$YNH_APP_ARG_PATH +path_url=$YNH_APP_ARG_PATH admin_wordpress=$YNH_APP_ARG_ADMIN language=$YNH_APP_ARG_LANGUAGE multisite=$YNH_APP_ARG_MULTISITE @@ -19,138 +29,168 @@ is_public=$YNH_APP_ARG_IS_PUBLIC app=$YNH_APP_INSTANCE_NAME -# Source app helpers -source /usr/share/yunohost/helpers - -# Vérifie que les variables ne sont pas vides. -CHECK_VAR "$app" "app name not set" - +#================================================= +# CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS +#================================================= CHECK_USER "$admin_wordpress" # Vérifie la validité de l'user admin - -CHECK_PATH # Vérifie et corrige la syntaxe du path. +path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. CHECK_DOMAINPATH # Vérifie la disponibilité du path et du domaine. - CHECK_FINALPATH # Vérifie que le dossier de destination n'est pas déjà utilisé. -if [ "$path" == "/" ] && [ "$multisite" = "Yes" ]; then - echo "Multisite option of wordpress doesn't work at root of domain." >&2 - false +if [ "$path_url" == "/" ] && [ "$multisite" = "Yes" ]; then + ynh_die "Multisite option of wordpress doesn't work at root of domain." fi -# Enregistre les infos dans la config YunoHost +#================================================= +# STORE SETTINGS FROM MANIFEST +#================================================= + ynh_app_setting_set $app domain $domain -ynh_app_setting_set $app path $path +ynh_app_setting_set $app path $path_url ynh_app_setting_set $app admin $admin_wordpress ynh_app_setting_set $app is_public $is_public ynh_app_setting_set $app language $language ynh_app_setting_set $app multisite $multisite -GENERATE_DB $app # Créer une base de données et un utilisateur dédié au nom de l'app. +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# INSTALL DEPENDENCIES +#================================================= +ynh_install_app_dependencies php5-cli + +#================================================= +# CREATE A SQL BDD +#================================================= + +db_name=$(ynh_make_valid_dbid $app) +ynh_app_setting_set $app db_name $db_name +ynh_mysql_generate_db $db_name $db_name + +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= -# Crée le repertoire de destination et stocke son emplacement. -sudo mkdir "$final_path" ynh_app_setting_set $app final_path $final_path +SETUP_SOURCE # Télécharge la source, décompresse et copie dans $final_path +#================================================= +# NGINX CONFIGURATION +#================================================= -SETUP_SOURCE "wordpress.tar.gz" # Télécharge la source, décompresse et copie dans $final_path - -# Et copie le fichier de config nginx +# Copie le fichier de config nginx sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf - - # Modifie les variables dans le fichier de configuration nginx -sudo sed -i "s@__PATHTOCHANGE__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf +sudo sed -i "s@__PATHTOCHANGE__@$path_url@g" /etc/nginx/conf.d/$domain.d/$app.conf sudo sed -i "s@__FINALPATH__@$final_path@g" /etc/nginx/conf.d/$domain.d/$app.conf sudo sed -i "s@__NAMETOCHANGE__@$app@g" /etc/nginx/conf.d/$domain.d/$app.conf +#================================================= +# CREATE DEDICATED USER +#================================================= + +ynh_system_user_create $app # Créer un utilisateur système dédié à l'app + +#================================================= +# PHP-FPM CONFIGURATION +#================================================= + POOL_FPM # Créer le fichier de configuration du pool php-fpm et le configure. +#================================================= +# SPECIFIC SETUP +#================================================= +# CONFIGURE WP-CONFIG +#================================================= sudo cp ../conf/wp-config.php $final_path/wp-config.php - # Change variables in Wordpress configuration -sudo sed -i "s/__DB_USER__/$db_user/g" $final_path/wp-config.php +sudo sed -i "s/__DB_USER__/$db_name/g" $final_path/wp-config.php sudo sed -i "s/__DB_PWD__/$db_pwd/g" $final_path/wp-config.php sudo sed -i "s/__DOMAIN__/$domain/g" $final_path/wp-config.php -sudo sed -i "s@__PATH__@$path@g" $final_path/wp-config.php - +sudo sed -i "s@__PATH__@$path_url@g" $final_path/wp-config.php for i in 1 2 3 4 5 6 7 8 do - j=$(dd if=/dev/urandom bs=1 count=200 2> /dev/null | tr -c -d '[A-Za-z0-9]' | sed -n 's/\(.\{40\}\).*/\1/p') - if [ "$j" = "" ]; - then - # For obscure reasons, the loop is too fast at execution - sleep 1 - j=$(dd if=/dev/urandom bs=1 count=200 2> /dev/null | tr -c -d '[A-Za-z0-9]' | sed -n 's/\(.\{40\}\).*/\1/p') - fi - sudo sed -i "s/KEY$i/$j/g" $final_path/wp-config.php + j=$(dd if=/dev/urandom bs=1 count=200 2> /dev/null | tr -c -d '[A-Za-z0-9]' | sed -n 's/\(.\{40\}\).*/\1/p') + if [ "$j" = "" ]; + then + # For obscure reasons, the loop is too fast at execution + sleep 1 + j=$(dd if=/dev/urandom bs=1 count=200 2> /dev/null | tr -c -d '[A-Za-z0-9]' | sed -n 's/\(.\{40\}\).*/\1/p') + fi + sudo sed -i "s/KEY$i/$j/g" $final_path/wp-config.php done -# Set permissions to wordpress directory -sudo chown -R www-data: $final_path +#================================================= +# SETTING UP WITH CURL +#================================================= -# Donne un accès public pour curl +# Set right permissions for curl install +sudo chown -R $app: $final_path + +# Rend la page d'install publique pour curl ynh_app_setting_set $app unprotected_uris "/" -# Recharge la configuration Nginx -sudo service nginx reload -# Régénère la configuration de SSOwat -sudo yunohost app ssowatconf +sudo yunohost app ssowatconf # Régénère la configuration de SSOwat +# Reload Nginx +sudo systemctl reload nginx # Wordpress installation -echo -e "127.0.0.1 $domain #WORDPRESS" | sudo tee -a /etc/hosts -sleep 1 -curl -kL -H "Host: $domain" --data "&weblog_title=YunoBlog&user_name=$admin_wordpress&admin_password=$db_pwd&admin_password2=$db_pwd&admin_email=$admin_wordpress@$domain&language=$language&Submit=Install+WordPress" https://localhost$path/wp-admin/install.php?step=2 > /dev/null 2>&1 +YNH_CURL "&weblog_title=YunoBlog&user_name=$admin_wordpress&admin_password=$db_pwd&admin_password2=$db_pwd&admin_email=$admin_wordpress@$domain&language=$language&Submit=Install+WordPress" "/wp-admin/install.php?step=2" -echo -n "Please wait during Wordpress installation" >&2 +WARNING echo -n "Please wait during Wordpress installation" for i in `seq 1 300` do # La boucle attend la fin de l'installation de wordpress Ou 5 minutes. - if mysql --debug-check -u $db_user -p$db_pwd $db_user -e "show tables" | grep -q "wp_options"; then + if ynh_mysql_connect_as $db_name $db_pwd $db_name -e "show tables" | grep -q "wp_options"; then break # Si la table wp_options est trouvée, l'installation de wordpress est terminée. Quitte la boucle. fi - echo -n "." >&2 + WARNING echo -n "." sleep 1 done +#================================================= +# LOAD SQL CONFIG +#================================================= + # Replace variables in sql scripts -sudo sed -i "s@__DOMAIN_PATH__@$domain$path@g" ../conf/sql/*.sql +sudo sed -i "s@__DOMAIN_PATH__@$domain$path_url@g" ../conf/sql/*.sql sudo sed -i "s/__LANGUAGE__/$language/g" ../conf/sql/*.sql sudo sed -i "s/__DATE__/$(date +%s)/g" ../conf/sql/*.sql # Charge les commandes sql communes à tous les scripts. -mysql --debug-check -u $db_user -p$db_pwd $db_user < ../conf/sql/common.sql +# mysql --debug-check -u $db_user -p$db_pwd $db_user < ../conf/sql/common.sql +ynh_mysql_connect_as $db_name $db_pwd $db_name < ../conf/sql/common.sql -if [ "$multisite" = "Yes" ] +#================================================= +# CONFIGURE MULTISITE +#================================================= + +if [ $multisite -eq 1 ] then - # Installation de php5-cli pour wp-cli - sudo apt-get update - sudo apt-get install php5-cli -qy - - sudo sed -i "s@#--MULTISITE--@@g" /etc/nginx/conf.d/$domain.d/$app.conf - # Autorise le multisite wordpress - sudo sed -i "s@//--MULTISITE1--define@define@g" $final_path/wp-config.php + sudo sed -i "s@#--MULTISITE--@@g" /etc/nginx/conf.d/$domain.d/$app.conf + # Autorise le multisite wordpress + sudo sed -i "s@//--MULTISITE1--define@define@g" $final_path/wp-config.php # Active le multisite via wp-cli. sudo wget -nv https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar -O $final_path/wp-cli.phar - php $final_path/wp-cli.phar core multisite-convert --path=$final_path --base=$path/ > /dev/null 2>&1 -# echo "The 2 warnings of php about \"Permission denied\" on wp-config.php are normal. The install script writing into this file, not wp-cli!" + ALL_QUIET php $final_path/wp-cli.phar core multisite-convert --path=$final_path --base=$path_url/ - # Active le multisite wordpress - sudo sed -i "s@//--MULTISITE2--define@define@g" $final_path/wp-config.php + # Active le multisite wordpress + sudo sed -i "s@//--MULTISITE2--define@define@g" $final_path/wp-config.php - # Charge les commandes sql pour activer les plugins - if [ "$is_public" = "No" ]; - then + # Charge les commandes sql pour activer les plugins + if [ $is_public -eq 0 ] + then sudo sed -i "s@#--PRIVATE--@@g" ../conf/sql/multisite.sql - else + else sudo sed -i "s@#--PUBLIC--@@g" ../conf/sql/multisite.sql - fi - mysql --debug-check -u $db_user -p$db_pwd $db_user < ../conf/sql/multisite.sql + fi + ynh_mysql_connect_as $db_name $db_pwd $db_name < ../conf/sql/multisite.sql else - if [ "$is_public" = "No" ]; + if [ $is_public -eq 0 ] then sudo sed -i "s@#--PRIVATE--@@g" /etc/nginx/conf.d/$domain.d/$app.conf sudo sed -i "s@#--PRIVATE--@@g" ../conf/sql/single.sql @@ -160,32 +200,48 @@ else sudo sed -i "s@#--PUBLIC--@@g" ../conf/sql/single.sql fi # Charge les commandes sql pour activer les plugins - mysql --debug-check -u $db_user -p$db_pwd $db_user < ../conf/sql/single.sql + ynh_mysql_connect_as $db_name $db_pwd $db_name < ../conf/sql/single.sql fi # Décommente les add_filter, qui auraient provoqué une erreur avec wp-cli sudo sed -i "s@//add_filter@add_filter@g" $final_path/wp-config.php +#================================================= +# STORE THE CHECKSUM OF THE CONFIG FILE +#================================================= + STORE_MD5_CONFIG "wp-config.php" "$final_path/wp-config.php" # Enregistre la somme de contrôle du fichier de config +#================================================= +# GENERIC FINALISATION +#================================================= +# SECURING FILES AND DIRECTORIES +#================================================= -# Configure les droits d'accès au fichiers -# Les fichiers appartiennent à www-data, pour permettre les mises à jour. -sudo chown -R www-data: $final_path +# Les fichiers appartiennent à l'user wordpress, pour permettre les mises à jour. +sudo chown -R $app: $final_path # Sauf le fichier de config wp-config.php qui appartient à root sudo chown root: $final_path/wp-config.php -if [ "$is_public" = "No" ]; +#================================================= +# SETUP SSOWAT +#================================================= + +if [ $is_public -eq 0 ]; then # Retire l'accès public ynh_app_setting_delete $app unprotected_uris - sudo yunohost app ssowatconf fi -sudo service nginx reload +#================================================= +# RELOAD NGINX +#================================================= -# Clean hosts -sudo sed -i '/#WORDPRESS/d' /etc/hosts +sudo systemctl reload nginx + +#================================================= +# REMOVE WP-CLI.PHAR +#================================================= # wp-cli me semble un peu trop permissif... Il a terminé son travail... sudo rm -f $final_path/wp-cli.phar diff --git a/scripts/remove b/scripts/remove index 21aaef0..a864fa9 100755 --- a/scripts/remove +++ b/scripts/remove @@ -1,23 +1,59 @@ #!/bin/bash -source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# Source app helpers +source .fonctions source /usr/share/yunohost/helpers -# Récupère les infos de l'application. -app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get $app domain) +#================================================= +# LOAD SETTINGS +#================================================= -REMOVE_BDD $app # Suppression de la base de donnée et de l'utilisateur associé. +app=$YNH_APP_INSTANCE_NAME + +domain=$(ynh_app_setting_get $app domain) +db_name=$(ynh_app_setting_get $app db_name) + +#================================================= +# STANDARD REMOVE +#================================================= +# REMOVE DEPENDENCIES +#================================================= + +ynh_remove_app_dependencies + +#================================================= +# REMOVE THE SQL BDD +#================================================= + +ynh_mysql_remove_db $db_name $db_name # Suppression de la base de donnée et de l'utilisateur associé. + +#================================================= +# REMOVE THE MAIN DIR OF THE APP +#================================================= SECURE_REMOVE '/var/www/$app' # Suppression du dossier de l'application +#================================================= +# REMOVE THE NGINX CONFIGURATION +#================================================= + REMOVE_NGINX_CONF # Suppression de la configuration nginx +#================================================= +# REMOVE THE PHP-FPM CONFIGURATION +#================================================= + REMOVE_FPM_CONF # Suppression de la configuration du pool php-fpm -# Régénère la configuration de SSOwat -sudo yunohost app ssowatconf +#================================================= +# GENERIC FINALISATION +#================================================= +# REMOVE DEDICATED USER +#================================================= -echo -e "\e[0m" # Restore normal color +ynh_system_user_delete $app diff --git a/scripts/restore b/scripts/restore index c08116e..0e7bdc1 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,60 +1,100 @@ #!/bin/bash -# This restore script is adapted to Yunohost >=2.4 -# The parameter $1 is the backup directory location dedicated to the app -backup_dir=$1 +#================================================= +# GENERIC STARTING +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= -# The parameter $2 is the id of the app instance ex: ynhexample__2 -app=$2 +# Exit on command errors and treat unset variables as an error +set -eu -# Source app helpers +#================================================= +# 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 -# Get old parameter of the app +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + domain=$(ynh_app_setting_get $app domain) -path=$(ynh_app_setting_get $app path) +path_url=$(ynh_app_setting_get $app path) is_public=$(ynh_app_setting_get $app is_public) final_path=$(ynh_app_setting_get $app final_path) +db_name=$(ynh_app_setting_get $app db_name) -if [ -d $final_path ]; then - ynh_die "There is already a directory: $final_path" -fi +#================================================= +# CHECK IF THE APP CAN BE RESTORED +#================================================= + +sudo yunohost app checkurl "${domain}${path_url}" -a "$app" \ + || ynh_die "Path not available: ${domain}${path_url}" +test ! -d $final_path \ + || ynh_die "There is already a directory: $final_path " + +#================================================= +# STANDARD RESTORE STEPS +#================================================= +# RESTORE OF THE NGINX CONFIGURATION +#================================================= 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 -# Restore conf files -sudo cp -a "${backup_dir}/conf/nginx.conf" $conf +sudo cp -a ./nginx.conf $conf -# Reload Nginx -sudo service nginx reload +#================================================= +# RESTORE OF THE MAIN DIR OF THE APP +#================================================= -sudo cp -a "${backup_dir}/var/www/$app" $final_path +sudo cp -a ./sources/. $final_path + +#================================================= +# RESTORE OF THE SQL BDD +#================================================= db_pwd=$(ynh_app_setting_get $app mysqlpwd) -db_user=$app -ynh_mysql_create_db $db_user $db_user $db_pwd -sudo su -c "mysql -u $db_user -p$db_pwd $app < ${backup_dir}/db.sql" -sudo rm -f "${backup_dir}/db.sql" -sudo sed -i -e "s/'DB_USER', *'[^']*'/'DB_USER', '$app'/g" $final_path/wp-config.php -sudo sed -i -e "s/'DB_NAME', *'[^']*'/'DB_NAME', '$app'/g" $final_path/wp-config.php +ynh_mysql_create_db $db_name $db_name $db_pwd +ynh_mysql_connect_as $db_name $db_pwd $db_name < ./db.sql -# Set permissions -# Les fichiers appartiennent à www-data, pour permettre les mises à jour. -sudo chown -R www-data: $final_path +#================================================= +# RECREATE OF THE DEDICATED USER +#================================================= + +ynh_system_user_create $app # Recreate the dedicated user, if not exist + +#================================================= +# RESTORE USER RIGHTS +#================================================= + +# Les fichiers appartiennent à l'user wordpress, pour permettre les mises à jour. +sudo chown -R $app: $final_path # Sauf le fichier de config wp-config.php qui appartient à root sudo chown root: $final_path/wp-config.php -# Copy dedicated php-fpm process from backup folder to the right location -sudo cp -a $backup_dir/conf/php-fpm.conf /etc/php5/fpm/pool.d/$app.conf -sudo cp -a $backup_dir/conf/php-fpm.ini /etc/php5/fpm/conf.d/20-$app.ini -# And restart service -sudo service php5-fpm reload +#================================================= +# RESTORE OF THE PHP-FPM CONFIGURATION +#================================================= -# Set ssowat config -if [ "$is_public" = "No" ]; -then - ynh_app_setting_delete $app skipped_uris -fi -sudo yunohost app ssowatconf +sudo cp -a ./php-fpm.conf /etc/php5/fpm/pool.d/$app.conf +sudo cp -a ./php-fpm.ini /etc/php5/fpm/conf.d/20-$app.ini + +#================================================= +# GENERIC FINALISATION +#================================================= +# RELOAD NGINX AND PHP-FPM +#================================================= + +sudo systemctl reload php5-fpm +sudo systemctl reload nginx diff --git a/scripts/upgrade b/scripts/upgrade index b7e71fd..d238e76 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,66 +1,126 @@ #!/bin/bash -source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# Source app helpers +source .fonctions source /usr/share/yunohost/helpers -# Récupère les infos de l'application. +#================================================= +# LOAD SETTINGS +#================================================= + app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get $app domain) -path=$(ynh_app_setting_get $app path) +path_url=$(ynh_app_setting_get $app path) admin_wordpress=$(ynh_app_setting_get $app admin) language=$(ynh_app_setting_get $app language) is_public=$(ynh_app_setting_get $app is_public) multisite=$(ynh_app_setting_get $app multisite) final_path=$(ynh_app_setting_get $app final_path) +db_name=$(ynh_app_setting_get $app db_name) -CHECK_PATH # Vérifie et corrige la syntaxe du path. +#================================================= +# FIX OLD THINGS +#================================================= -# Check if admin is not null -if [[ "$admin_wordpress" = "" || "$is_public" = "" || "$language" = "" ]]; then - echo "Unable to upgrade, please contact support" - ynh_die -fi - -root_pwd=$(sudo cat /etc/yunohost/mysql) -db_name=$app -if [[ "$admin_wordpress" = "" ]]; -then - mysql -u root -p$root_pwd $db_name -e "select MAX(user_login) from wp_users where user_status=0 INTO OUTFILE '/tmp/wordpressuser';" - admin_wordpress=$(cat /tmp/wordpressuser) - sudo rm -f /tmp/wordpressuser +if [ -z "$admin_wordpress" ]; then + ynh_mysql_execute_as_root "select MAX(user_login) from wp_users where user_status=0 INTO OUTFILE '/tmp/wordpressuser';" $db_name + admin_wordpress=$(cat /tmp/wordpressuser) + sudo rm -f /tmp/wordpressuser ynh_app_setting_set $app admin $admin_wordpress fi -if [[ "$final_path" = "" ]]; -then - final_path=/var/www/$app +if [ -z "$final_path" ]; then + final_path=/var/www/$app ynh_app_setting_set $app final_path $final_path fi -if [[ "$language" = "" ]]; -then - language=$(sudo grep WPLANG $final_path/wp-config.php | cut -d"'" -f4) +if [ -z "$language" ]; then + language=$(sudo grep WPLANG $final_path/wp-config.php | cut -d"'" -f4) ynh_app_setting_set $app language $language fi +if [ "$is_public" = "Yes" ]; then + ynh_app_setting_set $app is_public 1 # Fixe is_public en booléen + is_public=1 +elif [ "$is_public" = "No" ]; then + ynh_app_setting_set $app is_public 0 + is_public=0 +fi + +if [ "$multisite" = "Yes" ]; then + ynh_app_setting_set $app multisite 1 # Fixe multisite en booléen + multisite=1 +elif [ "$multisite" = "No" ]; then + ynh_app_setting_set $app multisite 0 + multisite=0 +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 + +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= + +BACKUP_BEFORE_UPGRADE # Backup the current version of the app +ynh_clean_setup () { + BACKUP_FAIL_UPGRADE # restore it if the upgrade fails +} +ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. + +#================================================= +# CHECK THE PATH +#================================================= + +path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. + +#================================================= +# NGINX CONFIGURATION +#================================================= + # Copie le fichier de config nginx sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf # Modifie les variables dans le fichier de configuration nginx -sudo sed -i "s@__PATHTOCHANGE__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf +sudo sed -i "s@__PATHTOCHANGE__@$path_url@g" /etc/nginx/conf.d/$domain.d/$app.conf sudo sed -i "s@__FINALPATH__@$final_path@g" /etc/nginx/conf.d/$domain.d/$app.conf sudo sed -i "s@__NAMETOCHANGE__@$app@g" /etc/nginx/conf.d/$domain.d/$app.conf +#================================================= +# CREATE DEDICATED USER +#================================================= + +ynh_system_user_create $app # Create the dedicated user, if not exist + +#================================================= +# PHP-FPM CONFIGURATION +#================================================= + POOL_FPM # Créer le fichier de configuration du pool php-fpm et le configure. +#================================================= +# SPECIFIC UPGRADE +#================================================= +# SAVE THE CONFIG FILE IF IT BEEN MODIFIED +#================================================= CHECK_MD5_CONFIG "wp-config.php" "$final_path/wp-config.php" # Créé un backup du fichier de config si il a été modifié. -if [ "$multisite" = "Yes" ]; + +#================================================= +# CONFIGURE MULTISITE +#================================================= + +if [ $multisite -eq 1 ] then - sudo sed -i "s@#--MULTISITE--@@g" /etc/nginx/conf.d/$domain.d/$app.conf + sudo sed -i "s@#--MULTISITE--@@g" /etc/nginx/conf.d/$domain.d/$app.conf else - multisite="No" - if [ "$is_public" = "No" ]; + multisite=0 + if [ $is_public -eq 0 ] then sudo sed -i "s@#--PRIVATE--@@g" /etc/nginx/conf.d/$domain.d/$app.conf else @@ -68,25 +128,37 @@ else fi fi ynh_app_setting_set $app multisite $multisite + +#================================================= +# STORE THE CHECKSUM OF THE CONFIG FILE +#================================================= + STORE_MD5_CONFIG "wp-config.php" "$final_path/wp-config.php" # Réenregistre la somme de contrôle du fichier de config -# Configure les droits d'accès au fichiers -# Les fichiers appartiennent à www-data, pour permettre les mises à jour. -sudo chown -R www-data: $final_path +#================================================= +# GENERIC FINALISATION +#================================================= +# SECURING FILES AND DIRECTORIES +#================================================= + +# Les fichiers appartiennent à l'user wordpress, pour permettre les mises à jour. +sudo chown -R $app: $final_path # Sauf le fichier de config wp-config.php qui appartient à root sudo chown root: $final_path/wp-config.php +#================================================= +# SETUP SSOWAT +#================================================= ynh_app_setting_delete $app skipped_uris # Retire le skipped_uris si il existe encore. -if [ "$is_public" = "No" ]; then # Retire l'accès public +if [ $is_public -eq 0 ]; then # Retire l'accès public ynh_app_setting_delete $app unprotected_uris else # Ou remplace le skipped_uris par unprotected_uris le cas échéant. ynh_app_setting_set $app unprotected_uris "/" fi -sudo yunohost app ssowatconf +#================================================= +# RELOAD NGINX +#================================================= -# Recharge la configuration Nginx -sudo service nginx reload -# Régénère la configuration de SSOwat -sudo yunohost app ssowatconf +sudo systemctl reload nginx diff --git a/sources/source_dir b/sources/source_dir deleted file mode 100644 index a8be288..0000000 --- a/sources/source_dir +++ /dev/null @@ -1 +0,0 @@ -wordpress \ No newline at end of file diff --git a/sources/source_md5 b/sources/source_md5 deleted file mode 100644 index 99db23a..0000000 --- a/sources/source_md5 +++ /dev/null @@ -1 +0,0 @@ -17f9fe2fa6d14eba86aad152059b5afd wordpress.tar.gz diff --git a/sources/source_url b/sources/source_url deleted file mode 100644 index f88ac0b..0000000 --- a/sources/source_url +++ /dev/null @@ -1 +0,0 @@ -https://wordpress.org/wordpress-4.7.2.tar.gz