From 3be74eb1ebd9da9b13f9080fd7aa0e535ab09192 Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Sun, 19 Mar 2017 18:36:20 +0100 Subject: [PATCH] Reprise globale du package --- check_process | 16 +- conf/app.src | 2 + conf/logrotate | 20 -- conf/php-fpm.conf | 4 +- manifest.json | 6 +- scripts/.fonctions | 564 ++++++++++++++++++++++++++++++++++----------- scripts/backup | 92 +++++--- scripts/install | 236 ++++++++++++------- scripts/remove | 95 ++++++-- scripts/restore | 140 ++++++++--- scripts/upgrade | 212 ++++++++++++----- sources/source_dir | 1 - sources/source_md5 | 1 - sources/source_url | 1 - 14 files changed, 972 insertions(+), 418 deletions(-) create mode 100644 conf/app.src delete mode 100644 conf/logrotate delete mode 100644 sources/source_dir delete mode 100644 sources/source_md5 delete mode 100644 sources/source_url diff --git a/check_process b/check_process index 640c937..70672b8 100644 --- a/check_process +++ b/check_process @@ -4,7 +4,7 @@ domain="domain.tld" (DOMAIN) path="/path" (PATH) admin="john" (USER) - infcloud="Yes" + infcloud=1 language="French" ; Checks pkg_linter=1 @@ -16,20 +16,15 @@ upgrade=1 backup_restore=1 multi_instance=0 - 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 sans Infcloud auto_remove=1 ; Manifest domain="domain.tld" (DOMAIN) path="/path" (PATH) admin="john" (USER) - infcloud="No" + infcloud=0 language="French" ; Checks setup_sub_dir=1 @@ -40,18 +35,15 @@ upgrade=1 backup_restore=1 multi_instance=0 - 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/radicale_ynh/issues/2 Level 4=0 +# Level 5: https://github.com/YunoHost-Apps/radicale_ynh/issues/6 Level 5=auto Level 6=auto Level 7=auto diff --git a/conf/app.src b/conf/app.src new file mode 100644 index 0000000..0f5aa4d --- /dev/null +++ b/conf/app.src @@ -0,0 +1,2 @@ +SOURCE_URL>https://www.inf-it.com/InfCloud_0.13.1.zip +SOURCE_SUM=6ffb1b3b9b7f54137723c6c13e9c5635 diff --git a/conf/logrotate b/conf/logrotate deleted file mode 100644 index 3849e25..0000000 --- a/conf/logrotate +++ /dev/null @@ -1,20 +0,0 @@ -/var/log/__NAME__/__NAME__.log { - # Effectue une rotation des logs tout les mois - monthly - # Ou si le fichier de log dépasse 100Mo - size 100M - # Garde un maximum de 12 anciens logs - rotate 12 - # Compresse pas les logs avec gzip - compress - # Compresse le log au cycle suivant. Donc garde toujours 2 logs non compressés. - delaycompress - # Copie et tronque le journal pour permettre la poursuite de l'écriture. Plutôt que de déplacer le log. - copytruncate - # Ne renvoi pas d'erreur si le fichier de log est absent. - missingok - # Ne fait pas de rotation si le log est vide. - notifempty - # Garde les anciens logs dans le même dossier. - noolddir -} 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 fe778b6..070fee0 100644 --- a/manifest.json +++ b/manifest.json @@ -11,7 +11,7 @@ }, "version": "1.1.1", "url": "http://radicale.org", - "license": "free", + "license": "GPL-3.0, AGPL-3.0", "maintainer": { "name": "Maniack Crudelis", "email": "maniackc_dev@crudelis.fr" @@ -53,12 +53,12 @@ }, { "name": "infcloud", + "type": "boolean", "ask": { "en": "Install InfCloud web interface?", "fr": "Installer l'interface web InfCloud?" }, - "choices": ["Yes", "No"], - "default": "Yes" + "default": true }, { "name": "language", 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 fa1a603..5aeaa3f 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,43 +1,81 @@ #!/bin/bash +#================================================= +# GENERIC STARTING +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= + +# Exit on command errors and treat unset variables as an error +set -eu + +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +if [ ! -e .fonctions ]; then + # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant + sudo cp ../settings/scripts/.fonctions ./.fonctions + sudo chmod a+rx .fonctions +fi +source .fonctions +source /usr/share/yunohost/helpers + +#================================================= +# LOAD SETTINGS +#================================================= + # Récupère les infos de l'application. app=$YNH_APP_INSTANCE_NAME -# Source app helpers -source /usr/share/yunohost/helpers - final_path=$(ynh_app_setting_get $app final_path) domain=$(ynh_app_setting_get $app domain) infcloud=$(ynh_app_setting_get $app infcloud) +#================================================= +# STANDARD BACKUP STEPS +#================================================= +# BACKUP OF THE MAIN DIR OF THE APP +#================================================= -# The parameter $1 is the backup directory location -# which will be compressed afterward -backup_dir=$1/apps/$app -sudo mkdir -p "$backup_dir" +CHECK_SIZE "$final_path" +ynh_backup "$final_path" "sources" +CHECK_SIZE "/opt/yunohost/$app" +ynh_backup "/opt/yunohost/$app" "virtualenv" -# Backup sources & data -sudo cp -a $final_path/. $backup_dir/sources +#================================================= +# BACKUP OF THE NGINX CONFIGURATION +#================================================= -# Backup virtualenv -sudo cp -a /opt/yunohost/$app/. $backup_dir/virtualenv +ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "nginx.conf" -# Backup uwsgi config -sudo cp -a /etc/uwsgi/apps-available/radicale.ini $backup_dir/uwsgi_conf +#================================================= +# BACKUP OF THE PHP-FPM CONFIGURATION +#================================================= -# Copy Nginx and YunoHost parameters to make the script "standalone" -sudo cp -a /etc/yunohost/apps/$app/. $backup_dir/yunohost -sudo cp -a /etc/nginx/conf.d/$domain.d/$app.conf $backup_dir/nginx.conf - -# Copy radicale configuration -sudo cp -a /etc/$app/. $backup_dir/etc - -# Copie la configuration de logrotate -sudo cp -a /etc/logrotate.d/$app $backup_dir/logrotate - -# Copy dedicated php-fpm process to backup folder -if [ "$infcloud" = "1" ] +if [ $infcloud -eq 1 ] then - sudo cp -a /etc/php5/fpm/pool.d/$app.conf $backup_dir/php-fpm.conf - sudo cp -a /etc/php5/fpm/conf.d/20-$app.ini $backup_dir/php-fpm.ini + 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" fi + +#================================================= +# SPECIFIC BACKUP +#================================================= +# BACKUP OF THE UWSGI CONFIG +#================================================= + +ynh_backup "/etc/uwsgi/apps-available/radicale.ini" "uwsgi_conf" + +#================================================= +# BACKUP OF THE RADICALE CONFIGURATION +#================================================= + +CHECK_SIZE "/etc/$app" +ynh_backup "/etc/$app" "etc" + +#================================================= +# BACKUP OF THE LOGROTATE CONFIGURATION +#================================================= + +ynh_backup "/etc/logrotate.d/$app" "logrotate" diff --git a/scripts/install b/scripts/install index e340bd9..ca2d1e3 100755 --- a/scripts/install +++ b/scripts/install @@ -1,69 +1,106 @@ #!/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. -# 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. +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=$YNH_APP_ARG_ADMIN infcloud=$YNH_APP_ARG_INFCLOUD language=$YNH_APP_ARG_LANGUAGE app=$YNH_APP_INSTANCE_NAME -# Source app helpers -source /usr/share/yunohost/helpers - -# Checks variables are not empty -CHECK_VAR "$app" "app name not set" +version=1.1.1 +#================================================= +# CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS +#================================================= CHECK_USER "$admin" # 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é. -# Modifie le domaine pour qu'il passe dans une regex -domain_regex=$(echo "$domain" | sed 's@-@.@g') -CHECK_VAR "$domain_regex" "domain_regex empty" +#================================================= +# STORE SETTINGS FROM MANIFEST +#================================================= -if [ "$infcloud" = "Yes" ] || [ "$infcloud" = "yes" ] || [ "$infcloud" = "YES" ] || [ "$infcloud" = "Y" ] || [ "$infcloud" = "y" ] -then - infcloud=1 -else - infcloud=0 -fi - -# Enregistre les infos dans la config YunoHost 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 ynh_app_setting_set $app infcloud $infcloud +ynh_app_setting_set $app version $version +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# INSTALL DEPENDENCIES +#================================================= + +ynh_install_app_dependencies python-pip python-virtualenv python-dev libldap2-dev libsasl2-dev libssl-dev uwsgi uwsgi-plugin-python + +#================================================= +# 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@__PATH__@$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 +if [ "$path_url" = "/" ] +then + sudo sed -i "s@__PATH_NO_ROOT__@@g" /etc/nginx/conf.d/$domain.d/$app.conf +else + sudo sed -i "s@__PATH_NO_ROOT__@$path_url@g" /etc/nginx/conf.d/$domain.d/$app.conf +fi +if [ $infcloud -eq 1 ] +then # Ajoute InfCloud dans la config Nginx + sudo sed -i "s@#INFCLOUD#@@g" /etc/nginx/conf.d/$domain.d/$app.conf +fi + +#================================================= +# CREATE DEDICATED USER +#================================================= + +ynh_system_user_create $app # Créer un utilisateur système dédié à l'app + +#================================================= +# SPECIFIC SETUP +#================================================= +# INSTALL RADICALE IN A VIRTUALENV +#================================================= + +# Init virtualenv +sudo virtualenv /opt/yunohost/$app +sudo /opt/yunohost/$app/bin/pip install radicale==$version python-ldap + +#================================================= +# COPY FILES INTO $FINAL_PATH +#================================================= # Crée le repertoire de destination et stocke son emplacement. sudo mkdir "$final_path" ynh_app_setting_set $app final_path $final_path - - -# Check depends installation -sudo apt-get install -y python-pip python-virtualenv python-dev libldap2-dev libsasl2-dev libssl-dev uwsgi uwsgi-plugin-python - -# Init virtualenv -sudo virtualenv /opt/yunohost/$app -sudo /opt/yunohost/$app/bin/pip install radicale==1.1.1 python-ldap - - # Copy files to the right place sudo mkdir -p $final_path/collections sudo cp ../conf/radicale.wsgi $final_path @@ -72,24 +109,27 @@ sudo cp -a ../sources/ajouts_radicale/. "$final_path" # Le fichier regex.py est patché pour corrigé le commit destructeur e807c3d35bea9cfcfcacac83b1b17d748ea15a39 du 3/12/2015 qui arrête la lecture du fichier rights à la première occurence validée. sudo mv "$final_path/regex.py" /opt/yunohost/$app/lib/python*/site-packages/radicale/rights/regex.py sudo rm /opt/yunohost/$app/lib/python*/site-packages/radicale/rights/regex.pyc -if [ "$infcloud" = "1" ] +if [ $infcloud -eq 1 ] then #Instal InfCloud final_path_backup=$final_path # Sauvegarde le contenu de $final_path final_path=$final_path/infcloud # Change final_path pour l'installation de infcloud - SETUP_SOURCE "infcloud.zip" # Télécharge la source, décompresse et copie dans $final_path + SETUP_SOURCE_ZIP # Télécharge la source, décompresse et copie dans $final_path final_path=$final_path_backup # Restaure le contenu de $final_path fi -#Configuration Radicale +#================================================= +# CONFIGURE RADICALE +#================================================= + sudo mkdir -p /etc/$app sudo cp ../conf/config /etc/$app/ sudo cp ../conf/logging /etc/$app/ sudo cp ../conf/rights /etc/$app/ -sudo sed -i "s@__PATH__@$path@g" /etc/$app/config +sudo sed -i "s@__PATH__@$path_url@g" /etc/$app/config sudo sed -i "s@__FINALPATH__@$final_path@g" /etc/$app/config STORE_MD5_CONFIG "config" "/etc/$app/config" # Enregistre la somme de contrôle du fichier de config STORE_MD5_CONFIG "logging" "/etc/$app/logging" # Enregistre la somme de contrôle du fichier de config -if [ "$infcloud" = "1" ] +if [ $infcloud -eq 1 ] then #Configuration InfCloud # Détermine la langue case "$language" in @@ -127,18 +167,20 @@ then #Configuration InfCloud ynh_app_setting_set $app language $language sudo cp ../conf/config.js "$final_path/infcloud/" sudo sed -i "s@__DOMAIN__@$domain@g" "$final_path/infcloud/config.js" - sudo sed -i "s@__PATH__@$path@g" "$final_path/infcloud/config.js" + sudo sed -i "s@__PATH__@$path_url@g" "$final_path/infcloud/config.js" sudo sed -i "s@__LANG__@$language@g" "$final_path/infcloud/config.js" sudo sed -i "s@__ADMIN__@$admin@g" "$final_path/infcloud/config.js" sudo sed -i "s@__TIMEZONE__@$(cat /etc/timezone)@g" "$final_path/infcloud/config.js" STORE_MD5_CONFIG "config.js" "$final_path/infcloud/config.js" # Enregistre la somme de contrôle du fichier de config fi -# Set permissions to radicale directory -sudo useradd radicale -d /opt/yunohost/$app +#================================================= +# SET PERMISSIONS ON RADICALE'S DIRECTORIES +#================================================= + +# sudo useradd radicale -d /opt/yunohost/$app sudo chown radicale: -R /opt/yunohost/$app -# Set permissions to radicale directory sudo chown -R radicale: $final_path sudo mkdir -p /var/log/$app sudo touch /var/log/$app/$app.log @@ -147,37 +189,23 @@ sudo chown radicale -R /var/log/$app sudo chmod 666 -R $final_path/default_collections sudo chmod 777 $final_path/default_collections $final_path/default_collections/USER -# Copy uwsgi config -sudo cp ../conf/radicale.ini /etc/uwsgi/apps-available/ -sudo ln -s /etc/uwsgi/apps-available/radicale.ini /etc/uwsgi/apps-enabled/ - -# Modify Nginx configuration file and copy it to Nginx conf directory -sudo sed -i "s@__PATH__@$path@g" ../conf/nginx.conf -if [ "$path" = "/" ] -then - sudo sed -i "s@__PATH_NO_ROOT__@@g" ../conf/nginx.conf -else - sudo sed -i "s@__PATH_NO_ROOT__@$path@g" ../conf/nginx.conf -fi -sudo sed -i "s@__FINALPATH__@$final_path@g" ../conf/nginx.conf -sudo sed -i "s@__NAMETOCHANGE__@$app@g" ../conf/nginx.conf -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf -if [ "$infcloud" = "1" ] -then # Ajoute InfCloud dans la config Nginx - sudo sed -i "s@#INFCLOUD#@@g" /etc/nginx/conf.d/$domain.d/$app.conf -fi - -if [ "$infcloud" = "1" ] -then - POOL_FPM # Créer le fichier de configuration du pool php-fpm et le configure. -fi - # Fix permission sudo chmod 755 /etc/$app/ sudo find /opt/yunohost/$app/ -type d -exec chmod 2755 {} \; sudo find /opt/yunohost/$app/ -type f -exec chmod g+r,o+r {} \; sudo chmod 644 /etc/$app/* +#================================================= +# CONFIGURE UWSGI FOR RADICALE +#================================================= + +sudo cp ../conf/radicale.ini /etc/uwsgi/apps-available/ +sudo ln -s /etc/uwsgi/apps-available/radicale.ini /etc/uwsgi/apps-enabled/ + +#================================================= +# GENERATE CALENDARS AND ADDRESS BOOKS FOR ALL USERS +#================================================= + # Créer les calendriers et carnets d'adresses par défaut des utilisateurs. while read user #USER en majuscule est une variable système, à éviter. do @@ -186,25 +214,55 @@ do done <<< "$(sudo yunohost user list | grep username | cut -d ":" -f 2 | cut -c 2-)" # Liste les utilisateurs et supprime l'espace après username: # Le triple chevron <<< permet de prendre la sortie de commande en entrée de boucle. -# Configuration de logrotate -sed -i "s@__NAME__@$app@g" ../conf/logrotate -sudo cp ../conf/logrotate /etc/logrotate.d/$app +#================================================= +# ENABLE UWSGI SERVICE IN ADMIN PANEL +#================================================= -## Reload Nginx and regenerate SSOwat conf -sudo service nginx reload -sudo service uwsgi restart -sudo yunohost service add uwsgi -l /var/log/uwsgi/app/radicale.log -if [ "$infcloud" = "1" ] -then # /infcloud vient se rajouter à l'adresse de radicale pour y être associé sur le portail. - ynh_app_setting_set $app path $path/infcloud # Remplace radicale par InfCloud dans le portail Yunohost - ynh_app_setting_set $app protected_uris "/" # Protège l'accès à infcloud - ynh_app_setting_set $app unprotected_regex "$domain_regex$path" # Radicale est accessible librement (pour l'accès distant aux ressources) -else # Si seul radicale est installé. - ynh_app_setting_set $app unprotected_uris "/" # Radicale est accessible librement (pour l'accès distant aux ressources) -fi +sudo systemctl restart uwsgi +# Ajoute le service au monitoring de Yunohost. +sudo yunohost service add uwsgi --log "/var/log/uwsgi/app/radicale.log" -sudo yunohost app ssowatconf +#================================================= +# PREPARE THE HOOKS +#================================================= # Modification des hook pour la création des collections par défaut des nouveaux utilisateurs. Et leur suppression sudo sed -i "s@__FINALPATH__@$final_path@g" ../hooks/post_user_create sudo sed -i "s@__FINALPATH__@$final_path@g" ../hooks/post_user_delete + +#================================================= +# GENERIC FINALISATION +#================================================= +# SETUP SSOWAT +#================================================= + +if [ $infcloud -eq 1 ] +then # /infcloud vient se rajouter à l'adresse de radicale pour y être associé sur le portail. + ynh_app_setting_set $app path $path_url/infcloud # Remplace radicale par InfCloud dans le portail Yunohost + ynh_app_setting_set $app protected_uris "/" # Protège l'accès à infcloud + domain_regex=$(echo "$domain" | sed 's@-@.@g') + ynh_app_setting_set $app unprotected_regex "$domain_regex$path_url" # Radicale est accessible librement (pour l'accès distant aux ressources) +else # Si seul radicale est installé. + ynh_app_setting_set $app unprotected_uris "/" # Radicale est accessible librement (pour l'accès distant aux ressources) +fi + +#================================================= +# SETUP LOGROTATE +#================================================= + +ynh_use_logrotate + +#================================================= +# PHP-FPM CONFIGURATION +#================================================= + +if [ $infcloud -eq 1 ] +then + POOL_FPM # Créer le fichier de configuration du pool php-fpm et le configure. +fi + +#================================================= +# RELOAD NGINX +#================================================= + +sudo systemctl reload nginx diff --git a/scripts/remove b/scripts/remove index a213076..9839604 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,24 +1,30 @@ #!/bin/bash -source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# Récupère les infos de l'application. -app=$YNH_APP_INSTANCE_NAME - -# Source app helpers +source .fonctions source /usr/share/yunohost/helpers +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + domain=$(ynh_app_setting_get $app domain) -SECURE_REMOVE '/var/www/$app' # Suppression du dossier de l'application - -SECURE_REMOVE '/opt/yunohost/$app' - -SECURE_REMOVE '/etc/$app/' # Delete radicale config +#================================================= +# STANDARD REMOVE +#================================================= +# STOP AND REMOVE SERVICE +#================================================= # Suppression de la configuration uwsgi -# Stoppe le service uwsgi -sudo service uwsgi stop +sudo systemctl stop uwsgi if [ -e "/etc/uwsgi/apps-available/radicale.ini" ]; then echo "Delete uwsgi config" sudo rm "/etc/uwsgi/apps-available/radicale.ini" @@ -28,20 +34,65 @@ if [ -h "/etc/uwsgi/apps-enabled/radicale.ini" ]; then sudo rm "/etc/uwsgi/apps-enabled/radicale.ini" fi -if ynh_system_user_exists "radicale" # Test l'existence de l'utilisateur -then - sudo userdel radicale -fi -# Redémarre le service uwsgi -sudo service uwsgi start +#================================================= +# REMOVE DEPENDENCIES +#================================================= + +ynh_remove_app_dependencies + +#================================================= +# REMOVE THE MAIN DIR OF THE APP +#================================================= + +SECURE_REMOVE '/var/www/$app' # Suppression du dossier de l'application +SECURE_REMOVE '/opt/yunohost/$app' + +#================================================= +# 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 -REMOVE_LOGROTATE_CONF # Suppression de la configuration de logrotate +#================================================= +# REMOVE THE LOGROTATE CONFIG +#================================================= -# Régénère la configuration de SSOwat -sudo yunohost app ssowatconf +ynh_remove_logrotate # Suppression de la configuration de logrotate -echo -e "\e[0m" # Restore normal color +#================================================= +# SPECIFIC REMOVE +#================================================= +# REMOVE RADICALE'S CONFIG +#================================================= + +SECURE_REMOVE '/etc/$app/' # Delete radicale config + +#================================================= +# DISABLE SERVICE IN ADMIN PANEL +#================================================= + +if [ -e /etc/init.d/uwsgi ] +then + # Redémarre le service uwsgi si il n'est pas désinstallé. + sudo systemctl start uwsgi +else + if sudo yunohost service status | grep -q uwsgi # Test l'existence du service dans Yunohost + then + echo "Remove uwsgi service" + sudo yunohost service remove uwsgi + fi +fi + +#================================================= +# GENERIC FINALISATION +#================================================= +# REMOVE DEDICATED USER +#================================================= + +ynh_system_user_delete $app diff --git a/scripts/restore b/scripts/restore index 4fb9760..678043c 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,37 +1,97 @@ #!/bin/bash -# Récupère les infos de l'application. -app=$YNH_APP_INSTANCE_NAME +#================================================= +# GENERIC STARTING +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= -# Source app helpers +# Exit on command errors and treat unset variables as an error +set -eu + +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +if [ ! -e .fonctions ]; then + # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant + sudo cp ../settings/scripts/.fonctions ./.fonctions + sudo chmod a+rx .fonctions +fi +source .fonctions source /usr/share/yunohost/helpers +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + final_path=$(ynh_app_setting_get $app final_path) domain=$(ynh_app_setting_get $app domain) infcloud=$(ynh_app_setting_get $app infcloud) +path_url=$(ynh_app_setting_get $app path) -# The parameter $1 is the uncompressed restore directory location -backup_dir=$1/apps/$app +#================================================= +# CHECK IF THE APP CAN BE RESTORED +#================================================= -# Restore sources & data -sudo cp -a $backup_dir/sources/. $final_path +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 " +test ! -d "/opt/yunohost/$app" \ + || ynh_die "There is already a directory: /opt/yunohost/$app " -# Restore Nginx and YunoHost parameters -sudo cp -a $backup_dir/yunohost/. /etc/yunohost/apps/$app -sudo cp -a $backup_dir/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf +#================================================= +# STANDARD RESTORE STEPS +#================================================= +# RESTORE OF THE NGINX CONFIGURATION +#================================================= -# Check depends installation -sudo apt-get install -y python-pip python-virtualenv python-dev libldap2-dev libsasl2-dev libssl-dev uwsgi uwsgi-plugin-python - -# Restore virtualenv -sudo mkdir -p /opt/yunohost/$app -sudo cp -a $backup_dir/virtualenv/. /opt/yunohost/$app/ - -# Set permissions to radicale directory -if ! ynh_system_user_exists "radicale" -then # Si il n'existe pas, l'user radicale est créé - sudo useradd radicale -d /opt/yunohost/$app +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 " fi +sudo cp -a ./nginx.conf $conf + +#================================================= +# RESTORE OF THE MAIN DIR OF THE APP +#================================================= + +sudo cp -a ./sources/. $final_path +sudo mkdir -p /opt/yunohost/$app +sudo cp -a ./virtualenv/. /opt/yunohost/$app/ + +#================================================= +# INSTALL DEPENDENCIES +#================================================= + +ynh_install_app_dependencies python-pip python-virtualenv python-dev libldap2-dev libsasl2-dev libssl-dev uwsgi uwsgi-plugin-python + +#================================================= +# RECREATE OF THE DEDICATED USER +#================================================= + +ynh_system_user_create $app # Recreate the dedicated user, if not exist + +#================================================= +# RESTORE OF THE PHP-FPM CONFIGURATION +#================================================= + +if [ $infcloud -eq 1 ] +then + 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 + sudo systemctl reload php5-fpm +fi + +#================================================= +# SPECIFIC RESTORE +#================================================= +# RESTORE USER RIGHTS +#================================================= + sudo chown radicale: -R /opt/yunohost/$app sudo chown -R radicale: $final_path @@ -39,26 +99,30 @@ sudo mkdir -p /var/log/$app sudo touch /var/log/$app/$app.log sudo chown radicale -R /var/log/$app -# Restore radicale configuration -sudo cp -a $backup_dir/etc/. /etc/$app +#================================================= +# RESTORE THE UWSGI CONFIG +#================================================= -# Restore uwsgi config -sudo cp -a $backup_dir/uwsgi_conf /etc/uwsgi/apps-available/radicale.ini +sudo cp -a ./uwsgi_conf /etc/uwsgi/apps-available/radicale.ini sudo ln -s /etc/uwsgi/apps-available/radicale.ini /etc/uwsgi/apps-enabled/ -# Copy dedicated php-fpm process to backup folder -if [ "$infcloud" = "1" ] -then - sudo cp -a $backup_dir/php-fpm.conf /etc/php5/fpm/pool.d/$app.conf - sudo cp -a $backup_dir/php-fpm.ini /etc/php5/fpm/conf.d/20-$app.ini - sudo service php5-fpm reload -fi +#================================================= +# RESTORE THE RADICALE CONFIGURATION +#================================================= -# Restaure la configuration de logrotate -sudo cp -a $backup_dir/logrotate /etc/logrotate.d/$app +sudo cp -a ./etc /etc/$app -# Restart webserver -sudo service nginx reload +#================================================= +# BACKUP OF THE LOGROTATE CONFIGURATION +#================================================= -# Restart uwsgi -sudo service uwsgi restart +sudo cp -a ./logrotate /etc/logrotate.d/$app + +#================================================= +# GENERIC FINALISATION +#================================================= +# RELOAD NGINX AND UWSGI +#================================================= + +sudo systemctl restart uwsgi +sudo systemctl reload nginx diff --git a/scripts/upgrade b/scripts/upgrade index 0414488..6347cef 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,42 +1,123 @@ #!/bin/bash -source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# Récupère les infos de l'application. -app=$YNH_APP_INSTANCE_NAME - -# Source app helpers +source .fonctions source /usr/share/yunohost/helpers +#================================================= +# 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=$(ynh_app_setting_get $app admin) infcloud=$(ynh_app_setting_get $app infcloud) language=$(ynh_app_setting_get $app language) final_path=$(ynh_app_setting_get $app final_path) +version=$(ynh_app_setting_get $app version) -# Modifie le domaine pour qu'il passe dans une regex -domain_regex=$(echo "$domain" | sed 's@-@.@g') -CHECK_VAR "$domain_regex" "domain_regex empty" +#================================================= +# FIX OLD THINGS +#================================================= - -CHECK_PATH # Vérifie et corrige la syntaxe du path. -if [ "$infcloud" = "1" ]; then - path=$(echo $path | sed "s@/infcloud@@") # Retire /infcloud pour traiter le path seul. -fi -# Check depends installation -sudo apt-get install -y python-pip python-virtualenv python-dev libldap2-dev libsasl2-dev libssl-dev uwsgi uwsgi-plugin-python - -if [ -d /usr/local/radicale ]; +if [ -d /usr/local/radicale ] then - sudo mkdir -p /opt/yunohost - sudo mv /usr/local/radicale /opt/yunohost/ + sudo mkdir -p /opt/yunohost + sudo mv /usr/local/radicale /opt/yunohost/ fi +if [ -z "$version" ] +then + version=1.1.1 +fi + +if [ "$infcloud" = "Yes" ]; then + ynh_app_setting_set $app infcloud 1 # Fixe infcloud en booléen + infcloud=1 +elif [ "$infcloud" = "No" ]; then + ynh_app_setting_set $app infcloud 0 + infcloud=0 +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 +#================================================= + + +if [ $infcloud -eq 1 ]; then + path_url=$(echo $path_url | sed "s@/infcloud@@") # Retire /infcloud pour traiter le path seul. +fi +path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. + +#================================================= +# STANDARD UPGRADE STEPS +#================================================= +# 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@__PATH__@$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 +if [ "$path_url" = "/" ] +then + sudo sed -i "s@__PATH_NO_ROOT__@@g" /etc/nginx/conf.d/$domain.d/$app.conf +else + sudo sed -i "s@__PATH_NO_ROOT__@$path_url@g" /etc/nginx/conf.d/$domain.d/$app.conf +fi +if [ $infcloud -eq 1 ] +then # Ajoute InfCloud dans la config Nginx + sudo sed -i "s@#INFCLOUD#@@g" /etc/nginx/conf.d/$domain.d/$app.conf +fi + +#================================================= +# CREATE DEDICATED USER +#================================================= + +ynh_system_user_create $app # Create the dedicated user, if not exist + +if [ $infcloud -eq 1 ] +then + #================================================= + # PHP-FPM CONFIGURATION + #================================================= + + POOL_FPM # Créer le fichier de configuration du pool php-fpm et le configure. +fi + +#================================================= +# SPECIFIC UPGRADE +#================================================= +# UPGRADE RADICALE IN ITS VIRTUALENV +#================================================= + # Upgrade pip packages sudo rm -Rf /opt/yunohost/$app sudo virtualenv /opt/yunohost/$app -sudo bash -c 'source /opt/yunohost/radicale/bin/activate && pip install radicale==1.1.1 python-ldap' +sudo bash -c "source /opt/yunohost/radicale/bin/activate && pip install radicale==$version python-ldap" + +#================================================= +# COPY FILES INTO $FINAL_PATH +#================================================= # Copy files to the right place sudo mkdir -p $final_path/collections @@ -50,20 +131,23 @@ if [ "$infcloud" = "1" ] then #Instal InfCloud final_path_backup=$final_path # Sauvegarde le contenu de $final_path final_path=$final_path/infcloud # Change final_path pour l'installation de infcloud - SETUP_SOURCE "infcloud.zip" # Télécharge la source, décompresse et copie dans $final_path + SETUP_SOURCE_ZIP # Télécharge la source, décompresse et copie dans $final_path final_path=$final_path_backup # Restaure le contenu de $final_path fi -# Radicale configuration +#================================================= +# CONFIGURE RADICALE +#================================================= + CHECK_MD5_CONFIG "config" "/etc/$app/config" # Créé un backup du fichier de config si il a été modifié. sudo cp ../conf/config /etc/$app/ CHECK_MD5_CONFIG "logging" "/etc/$app/logging" # Créé un backup du fichier de config si il a été modifié. sudo cp ../conf/logging /etc/$app/ STORE_MD5_CONFIG "logging" "/etc/$app/logging" # Réenregistre la somme de contrôle du fichier de config -sudo sed -i "s@__PATH__@$path@g" /etc/$app/config +sudo sed -i "s@__PATH__@$path_url@g" /etc/$app/config sudo sed -i "s@__FINALPATH__@$final_path@g" /etc/$app/config STORE_MD5_CONFIG "config" "/etc/$app/config" # Réenregistre la somme de contrôle du fichier de config -if [ "$infcloud" = "1" ] +if [ $infcloud -eq 1 ] then #Configuration InfCloud # Détermine la langue case "$language" in @@ -102,43 +186,17 @@ then #Configuration InfCloud CHECK_MD5_CONFIG "config.js" "$final_path/infcloud/config.js" # Créé un backup du fichier de config si il a été modifié. sudo cp ../conf/config.js "$final_path/infcloud/" sudo sed -i "s@__DOMAIN__@$domain@g" "$final_path/infcloud/config.js" - sudo sed -i "s@__PATH__@$path@g" "$final_path/infcloud/config.js" + sudo sed -i "s@__PATH__@$path_url@g" "$final_path/infcloud/config.js" sudo sed -i "s@__LANG__@$language@g" "$final_path/infcloud/config.js" sudo sed -i "s@__ADMIN__@$admin@g" "$final_path/infcloud/config.js" sudo sed -i "s@__TIMEZONE__@$(cat /etc/timezone)@g" "$final_path/infcloud/config.js" STORE_MD5_CONFIG "config.js" "$final_path/infcloud/config.js" # Réenregistre la somme de contrôle du fichier de config fi -# Copy uwsgi config -sudo cp ../conf/radicale.ini /etc/uwsgi/apps-available/ +#================================================= +# SET PERMISSIONS ON RADICALE'S DIRECTORIES +#================================================= -# Update Nginx configuration file -sudo sed -i "s@__PATH__@$path@g" ../conf/nginx.conf -if [ "$path" = "/" ] -then - sudo sed -i "s@__PATH_NO_ROOT__@@g" ../conf/nginx.conf -else - sudo sed -i "s@__PATH_NO_ROOT__@$path@g" ../conf/nginx.conf -fi -sudo sed -i "s@__FINALPATH__@$final_path@g" ../conf/nginx.conf -sudo sed -i "s@__NAMETOCHANGE__@$app@g" ../conf/nginx.conf -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf -if [ "$infcloud" = "1" ] -then # Ajoute InfCloud dans la config Nginx - sudo sed -i "s@#INFCLOUD#@@g" /etc/nginx/conf.d/$domain.d/$app.conf -fi - -if [ "$infcloud" = "1" ] -then - POOL_FPM # Créer le fichier de configuration du pool php-fpm et le configure. -fi - -# Set permissions to radicale directory -sudo grep radicale /etc/passwd > /dev/null 2>&1 -if [ $? != 0 ]; -then - sudo useradd radicale -d /opt/yunohost/$app -fi sudo chown radicale: -R /opt/yunohost/$app # Fix permission @@ -154,18 +212,44 @@ sudo chown radicale -R /var/log/$app sudo chmod 666 -R $final_path/default_collections sudo chmod 777 $final_path/default_collections $final_path/default_collections/USER -if [ "$infcloud" = "1" ] +#================================================= +# CONFIGURE UWSGI FOR RADICALE +#================================================= + +sudo cp ../conf/radicale.ini /etc/uwsgi/apps-available/ + +#================================================= +# RESTART UWSGI +#================================================= + +sudo systemctl restart uwsgi + +#================================================= +# PREPARE THE HOOKS +#================================================= + +# Modification des hook pour la création des collections par défaut des nouveaux utilisateurs. Et leur suppression +sudo sed -i "s@__FINALPATH__@$final_path@g" ../hooks/post_user_create +sudo sed -i "s@__FINALPATH__@$final_path@g" ../hooks/post_user_delete + +#================================================= +# GENERIC FINALISATION +#================================================= +# SETUP SSOWAT +#================================================= + +if [ $infcloud -eq 1 ] then # /infcloud vient se rajouter à l'adresse de radicale pour y être associé sur le portail. - ynh_app_setting_set $app path $path/infcloud # Remplace radicale par InfCloud dans le portail Yunohost + ynh_app_setting_set $app path $path_url/infcloud # Remplace radicale par InfCloud dans le portail Yunohost ynh_app_setting_set $app protected_uris "/" # Protège l'accès à infcloud - ynh_app_setting_set $app unprotected_regex "$domain_regex$path" # Radicale est accessible librement (pour l'accès distant aux ressources) + domain_regex=$(echo "$domain" | sed 's@-@.@g') + ynh_app_setting_set $app unprotected_regex "$domain_regex$path_url" # Radicale est accessible librement (pour l'accès distant aux ressources) else # Si seul radicale est installé. ynh_app_setting_set $app unprotected_uris "/" # Radicale est accessible librement (pour l'accès distant aux ressources) fi -sudo yunohost app ssowatconf -sudo service uwsgi restart -sudo service nginx reload -# Mise en place des hook pour la création des collections par défaut des nouveaux utilisateurs. Et leur suppression -sudo sed -i "s@__FINALPATH__@$final_path@g" ../hooks/post_user_create -sudo sed -i "s@__FINALPATH__@$final_path@g" ../hooks/post_user_delete +#================================================= +# RELOAD NGINX +#================================================= + +sudo systemctl reload nginx diff --git a/sources/source_dir b/sources/source_dir deleted file mode 100644 index de0ff39..0000000 --- a/sources/source_dir +++ /dev/null @@ -1 +0,0 @@ -infcloud \ No newline at end of file diff --git a/sources/source_md5 b/sources/source_md5 deleted file mode 100644 index 908ca79..0000000 --- a/sources/source_md5 +++ /dev/null @@ -1 +0,0 @@ -6ffb1b3b9b7f54137723c6c13e9c5635 infcloud.zip \ No newline at end of file diff --git a/sources/source_url b/sources/source_url deleted file mode 100644 index 5f1271b..0000000 --- a/sources/source_url +++ /dev/null @@ -1 +0,0 @@ -https://www.inf-it.com/InfCloud_0.13.1.zip \ No newline at end of file