From f402087ef88a2ae9b059d078ab36cdb6c65b8799 Mon Sep 17 00:00:00 2001 From: Jimmy Monin Date: Sun, 27 Aug 2017 09:51:33 +0200 Subject: [PATCH 1/6] Keep optional configuration lines in nginx.conf to allow changing URL from/to "/path" locations Rename comment prefixes fore more readability --- conf/nginx.conf | 6 +++--- scripts/install | 9 ++++----- scripts/upgrade | 9 ++++----- 3 files changed, 11 insertions(+), 13 deletions(-) diff --git a/conf/nginx.conf b/conf/nginx.conf index 9867550..13d7d68 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -35,7 +35,7 @@ location @__NAME__ { rewrite ^ __PATH__/app.php/$is_args$args; } -#noroot location __PATH__ { -#noroot return 301 __PATH__/; -#noroot } +#for-subdir location __PATH__ { +#for-subdir return 301 __PATH__/; +#for-subdir } diff --git a/scripts/install b/scripts/install index d738015..599cfd6 100644 --- a/scripts/install +++ b/scripts/install @@ -126,13 +126,12 @@ ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_user" <<< "UPDATE craue_config_s ynh_add_nginx_config if [ "$path_url" = "/" ] then - # Remove prefix on #noroot lines - sudo sed --in-place '/#noroot*/d' /etc/nginx/conf.d/$domain.d/$app.conf # Replace "//" location (due to nginx template) - ynh_replace_string " // " " / " /etc/nginx/conf.d/$domain.d/$app.conf + # Prevent from replacing in "http://" expressions by excluding ":" as preceding character + sudo sed --in-place "s@\([^:]\)//@\1/@g" /etc/nginx/conf.d/$domain.d/$app.conf else - # Remove #noroot lines - ynh_replace_string "#noroot" "" /etc/nginx/conf.d/$domain.d/$app.conf + # Move prefix comment #for-subdir at end of lines + sudo sed --in-place "s/#for-subdir\(.*\)/\1 #for-subdir/g" /etc/nginx/conf.d/$domain.d/$app.conf fi ynh_store_file_checksum "/etc/nginx/conf.d/$domain.d/$app.conf" diff --git a/scripts/upgrade b/scripts/upgrade index e6e98d7..8fef0df 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -116,13 +116,12 @@ ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_user" <<< "UPDATE craue_config_s ynh_add_nginx_config if [ "$path_url" = "/" ] then - # Remove prefix on #noroot lines - sudo sed --in-place '/#noroot*/d' /etc/nginx/conf.d/$domain.d/$app.conf # Replace "//" location (due to nginx template) - ynh_replace_string " // " " / " /etc/nginx/conf.d/$domain.d/$app.conf + # Prevent from replacing in "http://" expressions by excluding ":" as preceding character + sudo sed --in-place "s@\([^:]\)//@\1/@g" /etc/nginx/conf.d/$domain.d/$app.conf else - # Remove #noroot lines - ynh_replace_string "#noroot" "" /etc/nginx/conf.d/$domain.d/$app.conf + # Move prefix comment #for-subdir at end of lines + sudo sed --in-place "s/#for-subdir\(.*\)/\1 #for-subdir/g" /etc/nginx/conf.d/$domain.d/$app.conf fi ynh_store_file_checksum "/etc/nginx/conf.d/$domain.d/$app.conf" From b49a2e0af18e52818f199b803eb5e07a561f4979 Mon Sep 17 00:00:00 2001 From: Jimmy Monin Date: Sun, 27 Aug 2017 09:52:15 +0200 Subject: [PATCH 2/6] Add change_url script --- check_process | 1 + scripts/change_url | 122 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 123 insertions(+) create mode 100644 scripts/change_url diff --git a/check_process b/check_process index 4eafc80..043d27d 100644 --- a/check_process +++ b/check_process @@ -15,6 +15,7 @@ multi_instance=1 incorrect_path=1 port_already_use=0 + change_url=1 ;;; Levels Level 1=auto Level 2=auto diff --git a/scripts/change_url b/scripts/change_url new file mode 100644 index 0000000..52a8a5e --- /dev/null +++ b/scripts/change_url @@ -0,0 +1,122 @@ +#!/bin/bash + +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# RETRIEVE ARGUMENTS +#================================================= + +old_domain=$YNH_APP_OLD_DOMAIN +old_path=$YNH_APP_OLD_PATH + +new_domain=$YNH_APP_NEW_DOMAIN +new_path=$YNH_APP_NEW_PATH + +app=$YNH_APP_INSTANCE_NAME + +#================================================= +# LOAD SETTINGS +#================================================= + +db_name=$(ynh_app_setting_get "$app" db_name) +db_pwd=$(ynh_app_setting_get "$app" mysqlpwd) +db_user="$db_name" + +#================================================= +# CHECK PATHS SYNTAX +#================================================= + +test -n "$old_path" || old_path="/" +test -n "$new_path" || new_path="/" +new_path=$(ynh_normalize_url_path $new_path) +old_path=$(ynh_normalize_url_path $old_path) + +#================================================= +# CHECK WHICH PARTS SHOULD BE CHANGED +#================================================= + +change_domain=0 +if [ "$old_domain" != "$new_domain" ] +then + change_domain=1 +fi + +change_path=0 +if [ "$old_path" != "$new_path" ] +then + change_path=1 +fi + +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# MODIFY URL IN NGINX CONF FILE +#================================================= + +nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf + +# Change the path in the nginx config file +if [ $change_path -eq 1 ] +then + if [ "$new_path" = "/" ] && [ "$old_path" != "/" ] ; then + # Replace path in several location occurrences based on different recognition patterns + sudo sed --in-place "s@location $old_path/ {\$@location / {@" "$nginx_conf_path" + ynh_replace_string "location ~ ^$old_path" "location ~ ^" "$nginx_conf_path" + ynh_replace_string "location $old_path {" "location / {" "$nginx_conf_path" + ynh_replace_string "rewrite ^ $old_path" "rewrite ^ " "$nginx_conf_path" + + # Move #for-subdir comment at the beginning of the line (line not needed for "/" path) + sudo sed --in-place "s/\(.*\) #for-subdir/#for-subdir \1/g" "$nginx_conf_path" + elif [ "$new_path" != "/" ] && [ "$old_path" = "/" ] ; then + # Move #for-subdir comment at the end of the line (line needed for "/path" path) + sudo sed --in-place "s/#for-subdir\(.*\)/\1 #for-subdir/g" "$nginx_conf_path" + + # Replace path in several location occurrences based on different recognition patterns + sudo sed --in-place "s@location / {\$@location $new_path/ {@" "$nginx_conf_path" + ynh_replace_string "location ~ ^" "location ~ ^$new_path" "$nginx_conf_path" + ynh_replace_string "location / {" "location $new_path {" "$nginx_conf_path" + ynh_replace_string "rewrite ^ /" "rewrite ^ $new_path/" "$nginx_conf_path" + else + # Replace locations starting with old_path + # Look for every possible patterns for location (see https://nginx.org/en/docs/http/ngx_http_core_module.html#location) + sudo sed --in-place "s@location\( \(=\|~\|~\*\|\^~\)\)\? \(\^\)\?$old_path@location\1 \3$new_path@" "$nginx_conf_path" + # Replace path in "rewrite" directive + ynh_replace_string "rewrite ^ $old_path" "rewrite ^ $new_path" "$nginx_conf_path" + fi +fi + +# Change the domain for nginx +if [ $change_domain -eq 1 ] +then + sudo mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf +fi + +#================================================= +# SPECIFIC MODIFICATIONS +#================================================= + +# Configure Wallabag instance URL +ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_user" <<< "UPDATE craue_config_setting SET value = 'https://$new_domain$new_path' WHERE name = 'wallabag_url'" + +# If "Download images locally" option has been enabled in Internal Settings +download_images_enabled=$(ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_user" <<< "SELECT value from craue_config_setting WHERE name='download_images_enabled '" | tail -n 1) +if [ "$download_images_enabled" = "1" ] ; then + echo "Updating images URL; this operation may take a while..." + # Query/replace the domain/path in every entry.content in mysql database + ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_user" <<< "UPDATE entry SET content = REPLACE(content, '$old_domain$old_path', '$new_domain$new_path');" +fi + +#================================================= +# GENERIC FINALIZATION +#================================================= +# RELOAD NGINX +#================================================= + +sudo systemctl reload nginx From 4ac33ccf5941e8a1ae4135a62d1689d65a0471f7 Mon Sep 17 00:00:00 2001 From: Jimmy Monin Date: Sun, 27 Aug 2017 10:56:00 +0200 Subject: [PATCH 3/6] Require YNH 2.7.2, remove helpers and sudo prefixes --- manifest.json | 2 +- scripts/_common.sh | 556 +-------------------------------------------- scripts/backup | 4 +- scripts/change_url | 14 +- scripts/install | 16 +- scripts/remove | 4 +- scripts/restore | 16 +- scripts/upgrade | 16 +- 8 files changed, 41 insertions(+), 587 deletions(-) diff --git a/manifest.json b/manifest.json index 6f14933..17fe8f9 100644 --- a/manifest.json +++ b/manifest.json @@ -15,7 +15,7 @@ }, "multi_instance": true, "requirements": { - "yunohost": ">= 2.4.0" + "yunohost": ">= 2.7.2" }, "services": [ "nginx", diff --git a/scripts/_common.sh b/scripts/_common.sh index 0a1e55b..a1b1dc7 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -14,8 +14,8 @@ exec_as() { if [[ $USER = $(whoami) ]]; then eval $@ else - # use sudo twice to be root and be allowed to use another user - sudo sudo -u "$USER" "$@" + # use twice to be root and be allowed to use another user + sudo -u "$USER" "$@" fi } @@ -43,8 +43,8 @@ HUMAN_SIZE () { # Transforms a Kb-based size to a human-readable size CHECK_SIZE () { # Check if enough disk space available on backup storage 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) + backup_size=$(du --summarize "$file_to_analyse" | cut -f1) + free_space=$(df --output=avail "/home/yunohost.backup" | sed 1d) if [ $free_space -le $backup_size ] then @@ -55,556 +55,10 @@ CHECK_SIZE () { # Check if enough disk space available on backup storage } CHECK_DOMAINPATH () { # Check domain/path availability - sudo yunohost app checkurl $domain$path_url -a $app + yunohost app checkurl $domain$path_url -a $app } CHECK_FINALPATH () { # Check if destination directory already exists final_path="/var/www/$app" test ! -e "$final_path" || ynh_die "This path already contains a folder" } - -#================================================= -# FUTURE YUNOHOST HELPERS - TO BE REMOVED LATER -#================================================= - -# 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 -# ynh_normalize_url_path / -> / -# -# 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 -} - -# 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_abort_if_errors. -# 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 -} - -# Define and install dependencies with a equivs control file -# This helper can/should only be called once per app -# -# 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. -} - -# Check if a mysql user exists -# -# usage: ynh_mysql_user_exists user -# | arg: user - the user for which to check existence -function ynh_mysql_user_exists() -{ - local user=$1 - if [[ -z $(ynh_mysql_execute_as_root "SELECT User from mysql.user WHERE User = '$user';") ]] - then - return 1 - else - return 0 - fi -} - -# Create a database, an user and its password. Then store the password in the app's config -# -# After executing this helper, the password of the created database will be available in $db_pwd -# It will also be stored as "mysqlpwd" into the app settings. -# -# usage: ynh_mysql_setup_db user name -# | arg: user - Owner of the database -# | arg: name - Name of the database -ynh_mysql_setup_db () { - local db_user="$1" - local db_name="$2" - db_pwd=$(ynh_string_random) # Generate a random password - ynh_mysql_create_db "$db_name" "$db_user" "$db_pwd" # Create the database - ynh_app_setting_set $app mysqlpwd $db_pwd # Store the password in the app's config -} - -# Remove a database if it exists, and the associated user -# -# usage: ynh_mysql_remove_db user name -# | arg: user - Owner of the database -# | arg: name - Name of the database -ynh_mysql_remove_db () { - local db_user="$1" - local db_name="$2" - local mysql_root_password=$(sudo cat $MYSQL_ROOT_PWD_FILE) - if mysqlshow -u root -p$mysql_root_password | grep -q "^| $db_name"; then # Check if the database exists - echo "Removing database $db_name" >&2 - ynh_mysql_drop_db $db_name # Remove the database - else - echo "Database $db_name not found" >&2 - fi - - # Remove mysql user if it exists - if $(ynh_mysql_user_exists $db_user); then - ynh_mysql_drop_user $db_user - fi -} - -# Sanitize a string intended to be the name of a database -# (More specifically : replace - and . by _) -# -# Exemple: dbname=$(ynh_sanitize_dbid $app) -# -# usage: ynh_sanitize_dbid name -# | arg: name - name to correct/sanitize -# | ret: the corrected name -ynh_sanitize_dbid () { - dbid=${1//[-.]/_} # We should avoid having - and . in the name of databases. They are replaced by _ - echo $dbid -} - -# Substitute/replace a string by another in a file -# -# usage: ynh_replace_string match_string replace_string target_file -# | arg: match_string - String to be searched and replaced in the file -# | arg: replace_string - String that will replace matches -# | arg: target_file - File in which the string will be replaced. -ynh_replace_string () { - delimit=@ - match_string=${1//${delimit}/"\\${delimit}"} # Escape the delimiter if it's in the string. - replace_string=${2//${delimit}/"\\${delimit}"} - workfile=$3 - - sudo sed --in-place "s${delimit}${match_string}${delimit}${replace_string}${delimit}g" "$workfile" -} - -# Remove a file or a directory securely -# -# usage: ynh_secure_remove path_to_remove -# | arg: path_to_remove - File or directory to remove -ynh_secure_remove () { - path_to_remove=$1 - forbidden_path=" \ - /var/www \ - /home/yunohost.app" - - if [[ "$forbidden_path" =~ "$path_to_remove" \ - # Match all paths or subpaths in $forbidden_path - || "$path_to_remove" =~ ^/[[:alnum:]]+$ \ - # Match all first level paths from / (Like /var, /root, etc...) - || "${path_to_remove:${#path_to_remove}-1}" = "/" ]] - # Match if the path finishes by /. Because it seems there is an empty variable - then - echo "Avoid deleting $path_to_remove." >&2 - else - if [ -e "$path_to_remove" ] - then - sudo rm -R "$path_to_remove" - else - echo "$path_to_remove wasn't deleted because it doesn't exist." >&2 - fi - fi -} - -# 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 - sudo useradd $user_home_dir --system --user-group $1 --shell /usr/sbin/nologin || ynh_die "Unable to create $1 system account" - fi -} - -# 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 - echo "Remove the user $1" >&2 - sudo userdel $1 - else - echo "The user $1 was not found" >&2 - fi -} - -# Restore a previous backup if the upgrade process failed -# -# usage: -# ynh_backup_before_upgrade -# ynh_clean_setup () { -# ynh_backup_after_failed_upgrade -# } -# ynh_abort_if_errors -# -ynh_backup_after_failed_upgrade () { - echo "Upgrade failed." >&2 - app_bck=${app//_/-} # Replace all '_' by '-' - # Check if a existing backup can be found before remove and restore the application. - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$backup_number - then - # Remove the application then restore it - sudo yunohost app remove $app - # Restore the backup if the upgrade failed - sudo yunohost backup restore --ignore-hooks $app_bck-pre-upgrade$backup_number --apps $app --force - ynh_die "The app was restored to the way it was before the failed upgrade." - fi -} - -# Make a backup in case of failed upgrade -# -# usage: -# ynh_backup_before_upgrade -# ynh_clean_setup () { -# ynh_backup_after_failed_upgrade -# } -# ynh_abort_if_errors -# -ynh_backup_before_upgrade () { - backup_number=1 - old_backup_number=2 - app_bck=${app//_/-} # Replace all '_' by '-' - # Check if a backup already exist with the prefix 1. - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade1 - then - # Prefix become 2 to preserve the previous backup - backup_number=2 - old_backup_number=1 - fi - - # Create another backup - sudo yunohost backup create --ignore-hooks --apps $app --name $app_bck-pre-upgrade$backup_number - if [ "$?" -eq 0 ] - then - # If the backup succedded, remove the previous backup - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$old_backup_number - then - # Remove the previous backup only if it exists - sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number > /dev/null - fi - else - ynh_die "Backup failed, the upgrade process was aborted." - fi -} - -# Create a dedicated nginx config -# -# usage: ynh_add_nginx_config -ynh_add_nginx_config () { - finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalnginxconf" 1 - sudo cp ../conf/nginx.conf "$finalnginxconf" - - # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. - # Substitute in a nginx config file only if the variable is not empty - if test -n "${path_url:-}"; then - ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf" - fi - if test -n "${domain:-}"; then - ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf" - fi - if test -n "${port:-}"; then - ynh_replace_string "__PORT__" "$port" "$finalnginxconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__NAME__" "$app" "$finalnginxconf" - fi - if test -n "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf" - fi - ynh_store_file_checksum "$finalnginxconf" - - sudo systemctl reload nginx -} - -# Remove the dedicated nginx config -# -# usage: ynh_remove_nginx_config -ynh_remove_nginx_config () { - ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf" - sudo systemctl reload nginx -} - -# Create a dedicated php-fpm config -# -# usage: ynh_add_fpm_config -ynh_add_fpm_config () { - finalphpconf="/etc/php5/fpm/pool.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalphpconf" 1 - sudo cp ../conf/php-fpm.conf "$finalphpconf" - ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf" - ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf" - ynh_replace_string "__USER__" "$app" "$finalphpconf" - sudo chown root: "$finalphpconf" - ynh_store_file_checksum "$finalphpconf" - - if [ -e "../conf/php-fpm.ini" ] - then - finalphpini="/etc/php5/fpm/conf.d/20-$app.ini" - ynh_backup_if_checksum_is_different "$finalphpini" 1 - sudo cp ../conf/php-fpm.ini "$finalphpini" - sudo chown root: "$finalphpini" - ynh_store_file_checksum "$finalphpini" - fi - - sudo systemctl reload php5-fpm -} - -# Remove the dedicated php-fpm config -# -# usage: ynh_remove_fpm_config -ynh_remove_fpm_config () { - ynh_secure_remove "/etc/php5/fpm/pool.d/$app.conf" - ynh_secure_remove "/etc/php5/fpm/conf.d/20-$app.ini" 2>&1 - sudo systemctl reload php5-fpm -} - -# Calculate and store a file checksum into the app settings -# -# $app should be defined when calling this helper -# -# usage: ynh_store_file_checksum file -# | arg: file - The file on which the checksum will performed, then stored. -ynh_store_file_checksum () { - local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_' - ynh_app_setting_set $app $checksum_setting_name $(sudo md5sum "$1" | cut -d' ' -f1) -} - -# Verify the checksum and backup the file if it's different -# This helper is primarily meant to allow to easily backup personalised/manually -# modified config files. -# -# $app should be defined when calling this helper -# -# usage: ynh_backup_if_checksum_is_different file [compress] -# | arg: file - The file on which the checksum test will be perfomed. -# | arg: compress - 1 to compress the backup instead of a simple copy -# A compression is needed for a file which will be analyzed even if its name is different. -# -# | ret: Return the name a the backup file, or nothing -ynh_backup_if_checksum_is_different () { - local file=$1 - local compress_backup=${2:-0} # If $2 is empty, compress_backup will set at 0 - local checksum_setting_name=checksum_${file//[\/ ]/_} # Replace all '/' and ' ' by '_' - local checksum_value=$(ynh_app_setting_get $app $checksum_setting_name) - if [ -n "$checksum_value" ] - then # Proceed only if a value was stored into the app settings - if ! echo "$checksum_value $file" | sudo md5sum -c --status - then # If the checksum is now different - backup_file="$file.backup.$(date '+%d.%m.%y_%Hh%M,%Ss')" - if [ $compress_backup -eq 1 ] - then - sudo tar --create --gzip --file "$backup_file.tar.gz" "$file" # Backup the current file and compress - backup_file="$backup_file.tar.gz" - else - sudo cp -a "$file" "$backup_file" # Backup the current file - fi - echo "File $file has been manually modified since the installation or last upgrade. So it has been duplicated in $backup_file" >&2 - echo "$backup_file" # Return the name of the backup file - fi - fi -} - -YNH_EXECUTION_DIR=$(pwd) -# Download, check integrity, uncompress and patch the source from app.src -# -# The file conf/app.src need to contains: -# -# SOURCE_URL=Address to download the app archive -# SOURCE_SUM=Control sum -# # (Optional) Programm to check the integrity (sha256sum, md5sum$YNH_EXECUTION_DIR/...) -# # default: sha256 -# SOURCE_SUM_PRG=sha256 -# # (Optional) Archive format -# # default: tar.gz -# SOURCE_FORMAT=tar.gz -# # (Optional) Put false if source are directly in the archive root -# # default: true -# SOURCE_IN_SUBDIR=false -# # (Optionnal) Name of the local archive (offline setup support) -# # default: ${src_id}.${src_format} -# SOURCE_FILENAME=example.tar.gz -# -# Details: -# This helper download sources from SOURCE_URL if there is no local source -# archive in /opt/yunohost-apps-src/APP_ID/SOURCE_FILENAME -# -# Next, it check the integrity with "SOURCE_SUM_PRG -c --status" command. -# -# If it's ok, the source archive will be uncompress in $dest_dir. If the -# SOURCE_IN_SUBDIR is true, the first level directory of the archive will be -# removed. -# -# Finally, patches named sources/patches/${src_id}-*.patch and extra files in -# sources/extra_files/$src_id will be applyed to dest_dir -# -# -# usage: ynh_setup_source dest_dir [source_id] -# | arg: dest_dir - Directory where to setup sources -# | arg: source_id - Name of the app, if the package contains more than one app -ynh_setup_source () { - local dest_dir=$1 - local src_id=${2:-app} # If the argument is not given, source_id equal "app" - - # Load value from configuration file (see above for a small doc about this file - # format) - local src_url=$(grep 'SOURCE_URL=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_sum=$(grep 'SOURCE_SUM=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_sumprg=$(grep 'SOURCE_SUM_PRG=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_format=$(grep 'SOURCE_FORMAT=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_in_subdir=$(grep 'SOURCE_IN_SUBDIR=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_filename=$(grep 'SOURCE_FILENAME=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - - # Default value - src_sumprg=${src_sumprg:-sha256sum} - src_in_subdir=${src_in_subdir:-true} - src_format=${src_format:-tar.gz} - src_format=$(echo "$src_format" | tr '[:upper:]' '[:lower:]') - if [ "$src_filename" = "" ] ; then - src_filename="${src_id}.${src_format}" - fi - local local_src="/opt/yunohost-apps-src/${YNH_APP_ID}/${src_filename}" - - if test -e "$local_src" - then # Use the local source file if it is present - cp $local_src $src_filename - else # If not, download the source - wget -nv -O $src_filename $src_url - fi - - # Check the control sum - echo "${src_sum} ${src_filename}" | ${src_sumprg} -c --status \ - || ynh_die "Corrupt source" - - # Extract source into the app dir - mkdir -p "$dest_dir" - if [ "$src_format" = "zip" ] - then - # Zip format - # Using of a temp directory, because unzip doesn't manage --strip-components - if $src_in_subdir ; then - local tmp_dir=$(mktemp -d) - unzip -quo $src_filename -d "$tmp_dir" - cp -a $tmp_dir/*/. "$dest_dir" - ynh_secure_remove "$tmp_dir" - else - unzip -quo $src_filename -d "$dest_dir" - fi - else - local strip="" - if $src_in_subdir ; then - strip="--strip-components 1" - fi - if [[ "$src_format" =~ ^tar.gz|tar.bz2|tar.xz$ ]] ; then - tar -xf $src_filename -C "$dest_dir" $strip - else - ynh_die "Archive format unrecognized." - fi - fi - - # Apply patches - if (( $(find $YNH_EXECUTION_DIR/../sources/patches/ -type f -name "${src_id}-*.patch" 2> /dev/null | wc -l) > "0" )); then - local old_dir=$(pwd) - (cd "$dest_dir" \ - && for p in $YNH_EXECUTION_DIR/../sources/patches/${src_id}-*.patch; do \ - patch -p1 < $p; done) \ - || ynh_die "Unable to apply patches" - cd $old_dir - fi - - # Add supplementary files - if test -e "$YNH_EXECUTION_DIR/../sources/extra_files/${src_id}"; then - cp -a $YNH_EXECUTION_DIR/../sources/extra_files/$src_id/. "$dest_dir" - fi - -} \ No newline at end of file diff --git a/scripts/backup b/scripts/backup index 81ca5dd..8e94cd5 100644 --- a/scripts/backup +++ b/scripts/backup @@ -9,8 +9,8 @@ set -eu if [ ! -e _common.sh ]; then # Fetch helpers file if not in current directory - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh + cp ../settings/scripts/_common.sh ./_common.sh + chmod a+rx _common.sh fi source _common.sh source /usr/share/yunohost/helpers diff --git a/scripts/change_url b/scripts/change_url index 52a8a5e..fecf7aa 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -67,26 +67,26 @@ if [ $change_path -eq 1 ] then if [ "$new_path" = "/" ] && [ "$old_path" != "/" ] ; then # Replace path in several location occurrences based on different recognition patterns - sudo sed --in-place "s@location $old_path/ {\$@location / {@" "$nginx_conf_path" + sed --in-place "s@location $old_path/ {\$@location / {@" "$nginx_conf_path" ynh_replace_string "location ~ ^$old_path" "location ~ ^" "$nginx_conf_path" ynh_replace_string "location $old_path {" "location / {" "$nginx_conf_path" ynh_replace_string "rewrite ^ $old_path" "rewrite ^ " "$nginx_conf_path" # Move #for-subdir comment at the beginning of the line (line not needed for "/" path) - sudo sed --in-place "s/\(.*\) #for-subdir/#for-subdir \1/g" "$nginx_conf_path" + sed --in-place "s/\(.*\) #for-subdir/#for-subdir \1/g" "$nginx_conf_path" elif [ "$new_path" != "/" ] && [ "$old_path" = "/" ] ; then # Move #for-subdir comment at the end of the line (line needed for "/path" path) - sudo sed --in-place "s/#for-subdir\(.*\)/\1 #for-subdir/g" "$nginx_conf_path" + sed --in-place "s/#for-subdir\(.*\)/\1 #for-subdir/g" "$nginx_conf_path" # Replace path in several location occurrences based on different recognition patterns - sudo sed --in-place "s@location / {\$@location $new_path/ {@" "$nginx_conf_path" + sed --in-place "s@location / {\$@location $new_path/ {@" "$nginx_conf_path" ynh_replace_string "location ~ ^" "location ~ ^$new_path" "$nginx_conf_path" ynh_replace_string "location / {" "location $new_path {" "$nginx_conf_path" ynh_replace_string "rewrite ^ /" "rewrite ^ $new_path/" "$nginx_conf_path" else # Replace locations starting with old_path # Look for every possible patterns for location (see https://nginx.org/en/docs/http/ngx_http_core_module.html#location) - sudo sed --in-place "s@location\( \(=\|~\|~\*\|\^~\)\)\? \(\^\)\?$old_path@location\1 \3$new_path@" "$nginx_conf_path" + sed --in-place "s@location\( \(=\|~\|~\*\|\^~\)\)\? \(\^\)\?$old_path@location\1 \3$new_path@" "$nginx_conf_path" # Replace path in "rewrite" directive ynh_replace_string "rewrite ^ $old_path" "rewrite ^ $new_path" "$nginx_conf_path" fi @@ -95,7 +95,7 @@ fi # Change the domain for nginx if [ $change_domain -eq 1 ] then - sudo mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf + mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf fi #================================================= @@ -119,4 +119,4 @@ fi # RELOAD NGINX #================================================= -sudo systemctl reload nginx +systemctl reload nginx diff --git a/scripts/install b/scripts/install index 599cfd6..9474c0c 100644 --- a/scripts/install +++ b/scripts/install @@ -95,18 +95,18 @@ ynh_replace_string "{DESKEY}" "${deskey}" "$wb_conf" chmod 600 "$wb_conf" # Install files and set permissions -sudo mv "$TMPDIR" "$final_path" +mv "$TMPDIR" "$final_path" # Set rights on directory -sudo chown -R $app: $final_path -sudo chmod 755 $final_path +chown -R $app: $final_path +chmod 755 $final_path # Install dependencies and Wallabag exec_console $app "$final_path" wallabag:install # Add users to Wallabag for username in $(ynh_user_list); do - user_email=$(sudo yunohost user info "$username" --output-as plain \ + user_email=$(yunohost user info "$username" --output-as plain \ | ynh_get_plain_key mail) user_pass=$(ynh_string_random) exec_console $app "$final_path" fos:user:create \ @@ -128,10 +128,10 @@ if [ "$path_url" = "/" ] then # Replace "//" location (due to nginx template) # Prevent from replacing in "http://" expressions by excluding ":" as preceding character - sudo sed --in-place "s@\([^:]\)//@\1/@g" /etc/nginx/conf.d/$domain.d/$app.conf + sed --in-place "s@\([^:]\)//@\1/@g" /etc/nginx/conf.d/$domain.d/$app.conf else # Move prefix comment #for-subdir at end of lines - sudo sed --in-place "s/#for-subdir\(.*\)/\1 #for-subdir/g" /etc/nginx/conf.d/$domain.d/$app.conf + sed --in-place "s/#for-subdir\(.*\)/\1 #for-subdir/g" /etc/nginx/conf.d/$domain.d/$app.conf fi ynh_store_file_checksum "/etc/nginx/conf.d/$domain.d/$app.conf" @@ -144,5 +144,5 @@ ynh_app_setting_set "$app" unprotected_uris "/" #================================================= # RELOAD NGINX #================================================= -sudo systemctl restart php5-fpm -sudo systemctl reload nginx +systemctl restart php5-fpm +systemctl reload nginx diff --git a/scripts/remove b/scripts/remove index 831ef6b..4a4ae81 100644 --- a/scripts/remove +++ b/scripts/remove @@ -52,8 +52,8 @@ ynh_remove_fpm_config ynh_remove_nginx_config # Reload services -sudo systemctl restart php5-fpm -sudo systemctl reload nginx +systemctl restart php5-fpm +systemctl reload nginx #================================================= # REMOVE DEDICATED USER diff --git a/scripts/restore b/scripts/restore index 4f717de..8058237 100644 --- a/scripts/restore +++ b/scripts/restore @@ -9,8 +9,8 @@ set -eu if [ ! -e _common.sh ]; then # Fetch helpers file if not in current directory - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh + cp ../settings/scripts/_common.sh ./_common.sh + chmod a+rx _common.sh fi source _common.sh source /usr/share/yunohost/helpers @@ -46,13 +46,13 @@ ynh_install_app_dependencies "$PKG_DEPENDENCIES" # RESTORE NGINX CONFIGURATION #================================================= -sudo cp -a ./nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf +cp -a ./nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf #================================================= # RESTORE APP MAIN DIR #================================================= -sudo cp -a ./sources/. $final_path +cp -a ./sources/. $final_path #================================================= # RESTORE MYSQL DB @@ -72,13 +72,13 @@ ynh_system_user_create $app # Recreate the dedicated user, if not existing # RESTORE USER RIGHTS #================================================= -sudo chown -R $app: $final_path +chown -R $app: $final_path #================================================= # RESTORE PHP-FPM CONFIGURATION #================================================= -sudo cp -a ./php-fpm.conf /etc/php5/fpm/pool.d/$app.conf +cp -a ./php-fpm.conf /etc/php5/fpm/pool.d/$app.conf #================================================= # GENERIC FINALIZATION @@ -86,5 +86,5 @@ sudo cp -a ./php-fpm.conf /etc/php5/fpm/pool.d/$app.conf # RELOAD NGINX AND PHP-FPM #================================================= -sudo systemctl reload php5-fpm -sudo systemctl reload nginx +systemctl reload php5-fpm +systemctl reload nginx diff --git a/scripts/upgrade b/scripts/upgrade index 8fef0df..d134c64 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -97,10 +97,10 @@ ynh_replace_string "{DESKEY}" "${deskey}" "$wb_conf" # Replace files and set permissions ynh_secure_remove "${final_path}/var/cache" -sudo mkdir "${final_path}/var/cache" -sudo cp -a $TMPDIR/. "${final_path}" -sudo chown -R $app: "${final_path}" -sudo chmod 755 $final_path +mkdir "${final_path}/var/cache" +cp -a $TMPDIR/. "${final_path}" +chown -R $app: "${final_path}" +chmod 755 $final_path # Upgrade database and clear the cache exec_console $app "${final_path}" doctrine:migrations:migrate @@ -118,10 +118,10 @@ if [ "$path_url" = "/" ] then # Replace "//" location (due to nginx template) # Prevent from replacing in "http://" expressions by excluding ":" as preceding character - sudo sed --in-place "s@\([^:]\)//@\1/@g" /etc/nginx/conf.d/$domain.d/$app.conf + sed --in-place "s@\([^:]\)//@\1/@g" /etc/nginx/conf.d/$domain.d/$app.conf else # Move prefix comment #for-subdir at end of lines - sudo sed --in-place "s/#for-subdir\(.*\)/\1 #for-subdir/g" /etc/nginx/conf.d/$domain.d/$app.conf + sed --in-place "s/#for-subdir\(.*\)/\1 #for-subdir/g" /etc/nginx/conf.d/$domain.d/$app.conf fi ynh_store_file_checksum "/etc/nginx/conf.d/$domain.d/$app.conf" @@ -134,5 +134,5 @@ ynh_app_setting_set "$app" unprotected_uris "/" #================================================= # RELOAD NGINX #================================================= -sudo systemctl restart php5-fpm -sudo systemctl reload nginx \ No newline at end of file +systemctl restart php5-fpm +systemctl reload nginx \ No newline at end of file From 99fe5e9a3b3cc72b9141439a21206805c7537618 Mon Sep 17 00:00:00 2001 From: Jimmy Monin Date: Tue, 5 Sep 2017 21:17:03 +0200 Subject: [PATCH 4/6] Use ynh_replace_string --- scripts/change_url | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/scripts/change_url b/scripts/change_url index fecf7aa..34495e4 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -67,26 +67,26 @@ if [ $change_path -eq 1 ] then if [ "$new_path" = "/" ] && [ "$old_path" != "/" ] ; then # Replace path in several location occurrences based on different recognition patterns - sed --in-place "s@location $old_path/ {\$@location / {@" "$nginx_conf_path" + ynh_replace_string "location $old_path/ {\$" "location / {" "$nginx_conf_path" ynh_replace_string "location ~ ^$old_path" "location ~ ^" "$nginx_conf_path" ynh_replace_string "location $old_path {" "location / {" "$nginx_conf_path" ynh_replace_string "rewrite ^ $old_path" "rewrite ^ " "$nginx_conf_path" # Move #for-subdir comment at the beginning of the line (line not needed for "/" path) - sed --in-place "s/\(.*\) #for-subdir/#for-subdir \1/g" "$nginx_conf_path" + ynh_replace_string "\(.*\) #for-subdir" "#for-subdir \1" "$nginx_conf_path" elif [ "$new_path" != "/" ] && [ "$old_path" = "/" ] ; then # Move #for-subdir comment at the end of the line (line needed for "/path" path) - sed --in-place "s/#for-subdir\(.*\)/\1 #for-subdir/g" "$nginx_conf_path" + ynh_replace_string "#for-subdir\(.*\)" "\1 #for-subdir" "$nginx_conf_path" # Replace path in several location occurrences based on different recognition patterns - sed --in-place "s@location / {\$@location $new_path/ {@" "$nginx_conf_path" + ynh_replace_string "location / {\$" "location $new_path/ {" "$nginx_conf_path" ynh_replace_string "location ~ ^" "location ~ ^$new_path" "$nginx_conf_path" ynh_replace_string "location / {" "location $new_path {" "$nginx_conf_path" ynh_replace_string "rewrite ^ /" "rewrite ^ $new_path/" "$nginx_conf_path" else # Replace locations starting with old_path - # Look for every possible patterns for location (see https://nginx.org/en/docs/http/ngx_http_core_module.html#location) - sed --in-place "s@location\( \(=\|~\|~\*\|\^~\)\)\? \(\^\)\?$old_path@location\1 \3$new_path@" "$nginx_conf_path" + # Look for every possible patterns for location directive(see https://nginx.org/en/docs/http/ngx_http_core_module.html#location) + ynh_replace_string "location\( \(=\|~\|~\*\|\^~\)\)\? \(\^\)\?$old_path" "location\1 \3$new_path" "$nginx_conf_path" # Replace path in "rewrite" directive ynh_replace_string "rewrite ^ $old_path" "rewrite ^ $new_path" "$nginx_conf_path" fi From f0042e4aa06cd5040b4b7ec3ad206b1f8e5f01eb Mon Sep 17 00:00:00 2001 From: Jimmy Monin Date: Tue, 5 Sep 2017 21:23:44 +0200 Subject: [PATCH 5/6] Handle nginx conf file checksums --- scripts/_common.sh | 14 ++++++++++++++ scripts/change_url | 10 +++++++++- 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/scripts/_common.sh b/scripts/_common.sh index a1b1dc7..656978d 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -36,6 +36,7 @@ QUIET () { # redirect standard output to /dev/null $@ > /dev/null } + HUMAN_SIZE () { # Transforms a Kb-based size to a human-readable size human=$(numfmt --to=iec --from-unit=1K $1) echo $human @@ -62,3 +63,16 @@ CHECK_FINALPATH () { # Check if destination directory already exists final_path="/var/www/$app" test ! -e "$final_path" || ynh_die "This path already contains a folder" } + + +# ============= FUTURE YUNOHOST HELPER ============= +# Delete a file checksum from the app settings +# +# $app should be defined when calling this helper +# +# usage: ynh_remove_file_checksum file +# | arg: file - The file for which the checksum will be deleted +ynh_delete_file_checksum () { + local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_' + ynh_app_setting_delete $app $checksum_setting_name +} diff --git a/scripts/change_url b/scripts/change_url index 34495e4..1a2bb6e 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -65,6 +65,8 @@ nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf # Change the path in the nginx config file if [ $change_path -eq 1 ] then + # Make a backup of the original nginx config file if modified + ynh_backup_if_checksum_is_different "$nginx_conf_path" if [ "$new_path" = "/" ] && [ "$old_path" != "/" ] ; then # Replace path in several location occurrences based on different recognition patterns ynh_replace_string "location $old_path/ {\$" "location / {" "$nginx_conf_path" @@ -90,12 +92,18 @@ then # Replace path in "rewrite" directive ynh_replace_string "rewrite ^ $old_path" "rewrite ^ $new_path" "$nginx_conf_path" fi + # Calculate and store the nginx config file checksum + ynh_store_file_checksum "$nginx_conf_path" fi # Change the domain for nginx if [ $change_domain -eq 1 ] then - mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf + # Delete file checksum for the old conf file location + ynh_delete_file_checksum "$nginx_conf_path" + mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf + # Store file checksum for the new config file location + ynh_store_file_checksum "/etc/nginx/conf.d/$new_domain.d/$app.conf" fi #================================================= From 7cb11d53f96200e54935e8e36e8f264b16263b8f Mon Sep 17 00:00:00 2001 From: Jimmy Monin Date: Sun, 22 Oct 2017 22:02:38 +0200 Subject: [PATCH 6/6] Fix indentation --- check_process | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/check_process b/check_process index 043d27d..813d5d2 100644 --- a/check_process +++ b/check_process @@ -15,7 +15,7 @@ multi_instance=1 incorrect_path=1 port_already_use=0 - change_url=1 + change_url=1 ;;; Levels Level 1=auto Level 2=auto