From c1dab9e7fca3a00ae10cc536573f4e56022833cf Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Holcroft Date: Thu, 19 Oct 2017 14:57:07 +0200 Subject: [PATCH] use ynh_replace_string, ynh_secure_remove, ynh_app_setting_set, ynh_restore_file, and --- conf/nginx.conf | 2 +- scripts/backup | 11 ++++---- scripts/install | 63 ++++++++++++++++++++++--------------------- scripts/remove | 6 ++--- scripts/restore | 28 ++++++------------- scripts/upgrade | 71 ++++++++++++++++++++++++------------------------- 6 files changed, 85 insertions(+), 96 deletions(-) diff --git a/conf/nginx.conf b/conf/nginx.conf index 7656a7c..1b77e75 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,5 +1,5 @@ location PATHTOCHANGE { - alias ALIASTOCHANGE; + alias ALIASTOCHANGE/; if ($scheme = http) { rewrite ^ https://$server_name$request_uri? permanent; } diff --git a/scripts/backup b/scripts/backup index eb29fb2..538c223 100644 --- a/scripts/backup +++ b/scripts/backup @@ -22,15 +22,14 @@ dbuser=$app # Retrieve app settings domain=$(ynh_app_setting_get "$app" domain) dbpass=$(ynh_app_setting_get "$app" mysqlpwd) +final_path=$(ynh_app_setting_get "$app" final_path) # Copy the app source files -DESTDIR="/var/www/$app" -ynh_backup "$DESTDIR" "www" +ynh_backup "$final_path" > ./db.sql # Copy the conf files -mkdir ./conf -ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "conf/nginx.conf" -ynh_backup "/etc/php5/fpm/pool.d/${app}.conf" "conf/php-fpm.conf" +ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" +ynh_backup "/etc/php5/fpm/pool.d/${app}.conf" # Dump the database -mysqldump -u "$dbuser" -p"$dbpass" --no-create-db "$dbname" > ./db.sql +ynh_mysql_dump_db "$dbname" diff --git a/scripts/install b/scripts/install index ac54707..eea7b01 100644 --- a/scripts/install +++ b/scripts/install @@ -18,23 +18,23 @@ is_public=$YNH_APP_ARG_IS_PUBLIC app=$YNH_APP_INSTANCE_NAME # Normalize the url path syntax -path_url=$(ynh_normalize_url_path "$path_url") +path=$(ynh_normalize_url_path "$path") # Check web path availability -ynh_webpath_available "$domain" "$path_url" +ynh_webpath_available "$domain" "$path" # Register (book) web path -ynh_webpath_register "$app" "$domain" "$path_url" +ynh_webpath_register "$app" "$domain" "$path" ynh_app_setting_set $app admin_user $admin # Retrieve admin email -email=$(yunohost user info $admin | grep mail: | sed "s/mail: //g") +email=$(ynh_user_get_info "$admin" mail) # Check destination directory -DESTDIR="/var/www/$app" -[[ -d $DESTDIR ]] && ynh_die \ -"The destination directory '$DESTDIR' already exists.\ - You should safely delete it before installing this app." +final_path="/var/www/$app" +test ! -e "$final_path" || ynh_die "This path already contains a folder" + +ynh_app_setting_set $app final_path $final_path # Generate random password dbpass=$(ynh_string_random) @@ -47,35 +47,39 @@ ynh_app_setting_set $app mysqlpwd $dbpass ynh_app_setting_set $app adminusername $admin ynh_app_setting_set $app is_public $is_public -ynh_setup_source "$DESTDIR" +ynh_setup_source "$final_path" # Copy and edit config.php -cp ../conf/config.php ${DESTDIR} -sed -i "s/yuno_dbpdw/${dbpass}/g" ${DESTDIR}/config.php -sed -i "s/yuno_dbuser/${dbuser}/g" ${DESTDIR}/config.php -sed -i "s/yuno_admin/${admin}/g" ${DESTDIR}/config.php -sed -i "s/yuno_email/${email}/g" ${DESTDIR}/config.php -sed -i "s/yuno_domain/${domain}/g" ${DESTDIR}/config.php +config_php="${final_path}/config.php" + +cp ../conf/config.php "$config_php" +ynh_replace_string "yuno_dbpdw" "$dbpass" "$config_php" +ynh_replace_string "yuno_dbuser" "$dbuser" "$config_php" +ynh_replace_string "yuno_admin" "$admin" "$config_php" +ynh_replace_string "yuno_email" "$email" "$config_php" +ynh_replace_string "yuno_domain" "$domain" "$config_php" # Set permissions to kanboard and data directory -chown -R root:root ${DESTDIR} -chown -R www-data ${DESTDIR}/{data,plugins} +chown -R root:root ${final_path} +chown -R www-data ${final_path}/{data,plugins} # Copy and set php-fpm configuration phpfpm_conf="/etc/php5/fpm/pool.d/${app}.conf" -sed -i "s@#POOLNAME#@${app}@g" ../conf/php-fpm.conf -sed -i "s@#DESTDIR#@${DESTDIR}/@g" ../conf/php-fpm.conf + cp ../conf/php-fpm.conf "$phpfpm_conf" +ynh_replace_string "#POOLNAME#" "$app" "$phpfpm_conf" +ynh_replace_string "#DESTDIR#" "$final_path" "$phpfpm_conf" + chown root: $phpfpm_conf chmod 644 $phpfpm_conf finalnginxconf="/etc/nginx/conf.d/${domain}.d/${app}.conf" +cp ../conf/nginx.conf "$finalnginxconf" # Modify Nginx configuration file and copy it to Nginx conf directory -sed -i "s@NAMETOCHANGE@${app}@g" ../conf/nginx.conf* -sed -i "s@PATHTOCHANGE@${path}@g" ../conf/nginx.conf* -sed -i "s@ALIASTOCHANGE@${DESTDIR}/@g" ../conf/nginx.conf* -cp ../conf/nginx.conf "$finalnginxconf" +ynh_replace_string "NAMETOCHANGE" "$app" "$finalnginxconf" +ynh_replace_string "PATHTOCHANGE" "$path" "$finalnginxconf" +ynh_replace_string "ALIASTOCHANGE" "$final_path" "$finalnginxconf" if [ "$path" == "/" ] then @@ -86,16 +90,15 @@ fi # Make app public or private if [[ "$is_public" -eq 1 ]]; then - yunohost app setting ${app} unprotected_uris -v "/" - sed -i "s/define('LDAP_AUTH'.*$/define('LDAP_AUTH', true);/g" ${DESTDIR}/config.php - sed -i "s/define('HIDE_LOGIN_FORM'.*$/define('HIDE_LOGIN_FORM', false);/g" ${DESTDIR}/config.php - sed -i "s/define('REMEMBER_ME_AUTH'.*$/define('REMEMBER_ME_AUTH', true);/g" ${DESTDIR}/config.php - sed -i "s/define('DISABLE_LOGOUT'.*$/define('DISABLE_LOGOUT', false);/g" ${DESTDIR}/config.php + ynh_app_setting_set "$app" unprotected_uris "/" + ynh_replace_string "define('LDAP_AUTH'.*$" "define('LDAP_AUTH', true);" "$config_php" + ynh_replace_string "define('HIDE_LOGIN_FORM'.*$" "define('HIDE_LOGIN_FORM', false);" "$config_php" + ynh_replace_string "define('REMEMBER_ME_AUTH'.*$" "define('REMEMBER_ME_AUTH', true);" "$config_php" + ynh_replace_string "define('DISABLE_LOGOUT'.*$" "define('DISABLE_LOGOUT', false);" "$config_php" fi # Init database -#chmod o+x ${DESTDIR} ${DESTDIR}/app/ ${DESTDIR}/app/Schema/ ${DESTDIR}/app/Schema/Sql -ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ${DESTDIR}/app/Schema/Sql/mysql.sql +ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ${final_path}/app/Schema/Sql/mysql.sql # Reload services service php5-fpm restart || true diff --git a/scripts/remove b/scripts/remove index 5e25244..2d66042 100644 --- a/scripts/remove +++ b/scripts/remove @@ -19,9 +19,9 @@ ynh_mysql_drop_user "$dbuser" 2>/dev/null || true domain=$(ynh_app_setting_get "$app" domain) # Delete app directory and configurations -rm -rf "/var/www/${app}" -rm -f "/etc/php5/fpm/pool.d/${app}.conf" -[[ -n $domain ]] && rm -f "/etc/nginx/conf.d/${domain}.d/${app}.conf" +ynh_secure_remove "/var/www/${app}" +ynh_secure_remove "/etc/php5/fpm/pool.d/${app}.conf" +ynh_secure_remove "/etc/nginx/conf.d/${domain}.d/${app}.conf" # Reload services service php5-fpm restart || true diff --git a/scripts/restore b/scripts/restore index 7aacb91..b43b5de 100644 --- a/scripts/restore +++ b/scripts/restore @@ -19,40 +19,28 @@ dbuser=$app domain=$(ynh_app_setting_get "$app" domain) path=$(ynh_app_setting_get "$app" path) dbpass=$(ynh_app_setting_get "$app" mysqlpwd) +final_path=$(ynh_app_setting_get "$app" final_path) # Check web path availability -ynh_webpath_available "$domain" "$path_url" +ynh_webpath_available "$domain" "$path" # Check destination directory -DESTDIR="/var/www/$app" -[[ -d $DESTDIR ]] && ynh_die \ -"The destination directory '$DESTDIR' already exists.\ - You should safely delete it before restoring this app." - -# Check configuration files -nginx_conf="/etc/nginx/conf.d/${domain}.d/${app}.conf" -[[ -f $nginx_conf ]] && ynh_die \ -"The NGINX configuration already exists at '${nginx_conf}'. -You should safely delete it before restoring this app." -phpfpm_conf="/etc/php5/fpm/pool.d/${app}.conf" -[[ -f $phpfpm_conf ]] && ynh_die \ -"The PHP FPM configuration already exists at '${phpfpm_conf}'. -You should safely delete it before restoring this app." +test ! -e "$final_path" || ynh_die "This path already contains a folder" # Restore the app files -cp -a ./www "$DESTDIR" +ynh_restore_file "$final_path" # Create and restore the database ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass" ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ./db.sql # Restore permissions -chown -R root:root "$DESTDIR" -chown -R www-data ${DESTDIR}/{data,plugins} +chown -R root:root "$final_path" +chown -R www-data ${final_path}/{data,plugins} # Restore configuration files -cp -a ./conf/nginx.conf "$nginx_conf" -cp -a ./conf/php-fpm.conf "$phpfpm_conf" +ynh_restore_file "/etc/nginx/conf.d/${domain}.d/${app}.conf" +ynh_restore_file "/etc/php5/fpm/pool.d/${app}.conf" # Reload services service php5-fpm restart || true diff --git a/scripts/upgrade b/scripts/upgrade index b795b7d..a905bb6 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -22,72 +22,71 @@ source /usr/share/yunohost/helpers domain=$(ynh_app_setting_get "$app" domain) path=$(ynh_app_setting_get "$app" path) admin=$(ynh_app_setting_get "$app" adminusername) -email=$(yunohost user info $admin | grep mail: | sed "s/mail: //g") +email=$(ynh_user_get_info "$admin" mail) dbpass=$(ynh_app_setting_get "$app" mysqlpwd) is_public=$(ynh_app_setting_get "$app" is_public) +final_path=$(ynh_app_setting_get "$app" final_path) + if [ -z $is_public ] then # Old version doesnt have is_public settings is_public=0 ynh_app_setting_set $app is_public $is_public fi -# Check destination directory -DESTDIR="/var/www/$app" -[[ ! -d $DESTDIR ]] && ynh_die \ -"The destination directory '$DESTDIR' does not exist.\ - The app is not correctly installed, you should remove it first." - # flush php sessions before upgrade -rm -rf /var/lib/php5/session/* +ynh_secure_remove /var/lib/php5/session/* # Move old app dir -mv ${DESTDIR} ${DESTDIR}.old +mv ${final_path} ${final_path}.old -ynh_setup_source "$DESTDIR" +ynh_setup_source "$final_path" # restore data -cp -a ${DESTDIR}.old/data ${DESTDIR} +cp -a ${final_path}.old/data ${final_path} # restore plugins -if [ -e ${DESTDIR}.old/plugins ] +if [ -e ${final_path}.old/plugins ] then - cp -a ${DESTDIR}.old/plugins ${DESTDIR} + cp -a ${final_path}.old/plugins ${final_path} fi # delete temp directory -rm -Rf ${DESTDIR}.old +ynh_secure_remove "${final_path}.old" # Copy and edit config.php -cp ../conf/config.php ${DESTDIR} -sed -i "s/yuno_dbpdw/${dbpass}/g" ${DESTDIR}/config.php -sed -i "s/yuno_dbuser/${dbuser}/g" ${DESTDIR}/config.php -sed -i "s/yuno_admin/${admin}/g" ${DESTDIR}/config.php -sed -i "s/yuno_email/${email}/g" ${DESTDIR}/config.php -sed -i "s/yuno_domain/${domain}/g" ${DESTDIR}/config.php +config_php=${final_path}/config.php +cp ../conf/config.php "$config_php" +ynh_replace_string "yuno_dbpdw" "$dbpass" "$config_php" +ynh_replace_string "yuno_dbuser" "$dbuser" "$config_php" +ynh_replace_string "yuno_admin" "$admin" "$config_php" +ynh_replace_string "yuno_email" "$email" "$config_php" +ynh_replace_string "yuno_domain" "$domain" "$config_php" # Set permissions to kanboard and data directory -chown -R root:root ${DESTDIR} -chown -R www-data ${DESTDIR}/{data,plugins} +chown -R root:root ${final_path} +chown -R www-data ${final_path}/{data,plugins} # Launch database migration -${DESTDIR}/cli db:migrate +${final_path}/cli db:migrate # Copy and set php-fpm configuration phpfpm_conf="/etc/php5/fpm/pool.d/${app}.conf" -sed -i "s@#USER#@${app}@g" ../conf/php-fpm.conf -sed -i "s@#GROUP#@${app}@g" ../conf/php-fpm.conf -sed -i "s@#POOLNAME#@${app}@g" ../conf/php-fpm.conf -sed -i "s@#DESTDIR#@${DESTDIR}/@g" ../conf/php-fpm.conf cp ../conf/php-fpm.conf "$phpfpm_conf" + +ynh_replace_string "#USER#" "$app" "$phpfpm_conf" +ynh_replace_string "#GROUP#" "$app" "$phpfpm_conf" +ynh_replace_string "#POOLNAME#" "$app" "$phpfpm_conf" +ynh_replace_string "#DESTDIR#" "$final_path" "$phpfpm_conf" + chown root: $phpfpm_conf chmod 644 $phpfpm_conf finalnginxconf="/etc/nginx/conf.d/${domain}.d/${app}.conf" +cp ../conf/nginx.conf "$finalnginxconf" # Modify Nginx configuration file and copy it to Nginx conf directory -sed -i "s@NAMETOCHANGE@${app}@g" ../conf/nginx.conf* -sed -i "s@PATHTOCHANGE@${path}@g" ../conf/nginx.conf* -sed -i "s@ALIASTOCHANGE@${DESTDIR}/@g" ../conf/nginx.conf* -cp ../conf/nginx.conf "$finalnginxconf" +ynh_replace_string "NAMETOCHANGE" "${app}" "$finalnginxconf" +ynh_replace_string "PATHTOCHANGE" "${path}" "$finalnginxconf" +ynh_replace_string "ALIASTOCHANGE" "${final_path}" "$finalnginxconf" if [ "$path" == "/" ] then @@ -98,11 +97,11 @@ fi # Make app public or private if [[ "$is_public" -eq 1 ]]; then - yunohost app setting ${app} unprotected_uris -v "/" - sed -i "s/define('LDAP_AUTH'.*$/define('LDAP_AUTH', true);/g" ${DESTDIR}/config.php - sed -i "s/define('HIDE_LOGIN_FORM'.*$/define('HIDE_LOGIN_FORM', false);/g" ${DESTDIR}/config.php - sed -i "s/define('REMEMBER_ME_AUTH'.*$/define('REMEMBER_ME_AUTH', true);/g" ${DESTDIR}/config.php - sed -i "s/define('DISABLE_LOGOUT'.*$/define('DISABLE_LOGOUT', false);/g" ${DESTDIR}/config.php + ynh_app_setting_set "$app" unprotected_uris "/" + ynh_replace_string "define('LDAP_AUTH'.*$" "define('LDAP_AUTH', true);" "$config_php" + ynh_replace_string "define('HIDE_LOGIN_FORM'.*$" "define('HIDE_LOGIN_FORM', false);" "$config_php" + ynh_replace_string "define('REMEMBER_ME_AUTH'.*$" "define('REMEMBER_ME_AUTH', true);" "$config_php" + ynh_replace_string "define('DISABLE_LOGOUT'.*$" "define('DISABLE_LOGOUT', false);" "$config_php" fi # Reload services