Merge branch 'testing' into add-change-theme

check_process

@@ -5,6 +5,7 @@
 		path="/path"	(PATH)
 		is_public=1 (PUBLIC|public=1|private=0)
 		theme="milligram" (THEME)
+		password="verysecretpassword" (PASSWORD)
 	; Checks
 		pkg_linter=1
 		setup_sub_dir=1
@@ -14,22 +15,17 @@
 		setup_public=1
 		upgrade=1
 		backup_restore=1
-		multi_instance=0
+		multi_instance=1
-		wrong_user=1
-		wrong_path=1
 		incorrect_path=1
-		corrupt_source=1
+		port_already_use=1 (8095)
-		fail_download_source=1
+		change_url=1
-		port_already_use=1
-		final_path_already_use=1
 ;;; Levels
 	Level 1=auto
 	Level 2=auto
 	Level 3=auto
 	Level 4=na
 # level 4: https://github.com/YunoHost-Apps/lstu_ynh/issues/4
-	Level 5=1
+	Level 5=auto
-# level 5: https://github.com/YunoHost-Apps/lstu_ynh/issues/3
 	Level 6=auto
 	Level 7=auto
 	Level 8=0

conf/lstu.conf.template

@@ -29,7 +29,7 @@
     # secret hashed passphrase to access some admin features
     # Hash your password by issuing `echo -n s3cr3T | sha256sum` on your terminal
     # optional, but you won't have access to admin /stats if not set and if adminpwd is not set either
-    #hashed_adminpwd => '94b2feede6ea5e2eec62f457ecb7d3f719b24d19c29d4e5466246a31908fc23b',
+    hashed_adminpwd => '__PASSWORD_HASHED__',
 
     # choose a theme. See the available themes in `themes` directory
     # optional, default is 'default'

manifest.json

@@ -16,7 +16,7 @@
 		"name": "frju365",
 		"email": "abld@abld.info"
 	},
-	"multi_instance": false,
+	"multi_instance": true,
 	"services": [
 		"nginx"
 	],
@@ -59,6 +59,14 @@
 				},
 				"choices": ["default","milligram"],
 				"default": "milligram"
+      },
+      {
+				"name": "password",
+				"type": "password",
+				"ask": {
+					"en": "Choose a password",
+					"fr": "Choisissez un mot de passe"
+				}
 			}
 		]
 	}

scripts/_common.sh

@@ -1,12 +1,5 @@
 #!/bin/bash
 
-CHECK_VAR () {	# Verifies that the variable is not empty.
-	# $1 = Variable to be checked
-	# $2 = Display text on error
-	test -n "$1" || (echo "$2" >&2 && false)
-}
-
-
 # Start (or other actions) a service,  print a log in case of failure and optionnaly wait until the service is completely started
 #
 # usage: ynh_systemd_action [-n service_name] [-a action] [ [-l "line to match"] [-p log_path] [-t timeout] [-e length] ]
@@ -95,3 +88,142 @@ ynh_clean_check_starting () {
 	kill -s 15 $pid_tail 2>&1
 	ynh_secure_remove "$templog" 2>&1
 }
+
+#=================================================
+# EXPERIMENTAL HELPERS
+#=================================================
+
+# Send an email to inform the administrator
+#
+# usage: ynh_send_readme_to_admin --app_message=app_message [--recipients=recipients] [--type=type]
+# | arg: -m --app_message= - The file with the content to send to the administrator.
+# | arg: -r, --recipients= - The recipients of this email. Use spaces to separate multiples recipients. - default: root
+#	example: "root admin@domain"
+#	If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you
+#	example: "root admin@domain user1 user2"
+# | arg: -t, --type= - Type of mail, could be 'backup', 'change_url', 'install', 'remove', 'restore', 'upgrade'
+ynh_send_readme_to_admin() {
+	# Declare an array to define the options of this helper.
+	declare -Ar args_array=( [m]=app_message= [r]=recipients= [t]=type= )
+	local app_message
+	local recipients
+	local type
+	# Manage arguments with getopts
+
+	ynh_handle_getopts_args "$@"
+	app_message="${app_message:-}"
+	recipients="${recipients:-root}"
+	type="${type:-install}"
+
+	# Get the value of admin_mail_html
+	admin_mail_html=$(ynh_app_setting_get $app admin_mail_html)
+	admin_mail_html="${admin_mail_html:-0}"
+
+	# Retrieve the email of users
+	find_mails () {
+		local list_mails="$1"
+		local mail
+		local recipients=" "
+		# Read each mail in argument
+		for mail in $list_mails
+		do
+			# Keep root or a real email address as it is
+			if [ "$mail" = "root" ] || echo "$mail" | grep --quiet "@"
+			then
+				recipients="$recipients $mail"
+			else
+				# But replace an user name without a domain after by its email
+				if mail=$(ynh_user_get_info "$mail" "mail" 2> /dev/null)
+				then
+					recipients="$recipients $mail"
+				fi
+			fi
+		done
+		echo "$recipients"
+	}
+	recipients=$(find_mails "$recipients")
+
+	# Subject base
+	local mail_subject="☁️🆈🅽🅷☁️: \`$app\`"
+
+	# Adapt the subject according to the type of mail required.
+	if [ "$type" = "backup" ]; then
+		mail_subject="$mail_subject has just been backup."
+	elif [ "$type" = "change_url" ]; then
+		mail_subject="$mail_subject has just been moved to a new URL!"
+	elif [ "$type" = "remove" ]; then
+		mail_subject="$mail_subject has just been removed!"
+	elif [ "$type" = "restore" ]; then
+		mail_subject="$mail_subject has just been restored!"
+	elif [ "$type" = "upgrade" ]; then
+		mail_subject="$mail_subject has just been upgraded!"
+	else	# install
+		mail_subject="$mail_subject has just been installed!"
+	fi
+
+	local mail_message="This is an automated message from your beloved YunoHost server.
+Specific information for the application $app.
+$(if [ -n "$app_message" ]
+then
+	cat "$app_message"
+else
+	echo "...No specific information..."
+fi)
+---
+Automatic diagnosis data from YunoHost
+__PRE_TAG1__$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')__PRE_TAG2__"
+
+	# Store the message into a file for further modifications.
+	echo "$mail_message" > mail_to_send
+
+	# If a html email is required. Apply html tags to the message.
+ 	if [ "$admin_mail_html" -eq 1 ]
+ 	then
+		# Insert 'br' tags at each ending of lines.
+		ynh_replace_string "$" "<br>" mail_to_send
+
+		# Insert starting HTML tags
+		sed --in-place '1s@^@<!DOCTYPE html>\n<html>\n<head></head>\n<body>\n@' mail_to_send
+
+		# Keep tabulations
+		ynh_replace_string "  " "\&#160;\&#160;" mail_to_send
+		ynh_replace_string "\t" "\&#160;\&#160;" mail_to_send
+
+		# Insert url links tags
+		ynh_replace_string "__URL_TAG1__\(.*\)__URL_TAG2__\(.*\)__URL_TAG3__" "<a href=\"\2\">\1</a>" mail_to_send
+
+		# Insert pre tags
+		ynh_replace_string "__PRE_TAG1__" "<pre>" mail_to_send
+		ynh_replace_string "__PRE_TAG2__" "<\pre>" mail_to_send
+
+		# Insert finishing HTML tags
+		echo -e "\n</body>\n</html>" >> mail_to_send
+
+	# Otherwise, remove tags to keep a plain text.
+	else
+		# Remove URL tags
+		ynh_replace_string "__URL_TAG[1,3]__" "" mail_to_send
+		ynh_replace_string "__URL_TAG2__" ": " mail_to_send
+
+		# Remove PRE tags
+		ynh_replace_string "__PRE_TAG[1-2]__" "" mail_to_send
+	fi
+
+	# Define binary to use for mail command
+	if [ -e /usr/bin/bsd-mailx ]
+	then
+		local mail_bin=/usr/bin/bsd-mailx
+	else
+		local mail_bin=/usr/bin/mail.mailutils
+	fi
+
+	if [ "$admin_mail_html" -eq 1 ]
+	then
+		content_type="text/html"
+	else
+		content_type="text/plain"
+	fi
+
+	# Send the email to the recipients
+	cat mail_to_send | $mail_bin -a "Content-Type: $content_type; charset=UTF-8" -s "$mail_subject" "$recipients"
+}

scripts/change_url

@@ -0,0 +1,126 @@
+#!/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
+#=================================================
+
+# Needed for helper "ynh_add_nginx_config"
+final_path=$(ynh_app_setting_get $app final_path)
+
+# Needed for lstu conf
+port=$(ynh_app_setting_get $app port)
+db_name=$(ynh_app_setting_get "$app" db_name)
+db_pwd=$(ynh_app_setting_get $app psqlpwd)
+db_user=$db_name
+secret=$(ynh_app_setting_get $app secret)
+
+#=================================================
+# CHECK THE SYNTAX OF THE PATHS
+#=================================================
+
+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
+#=================================================
+
+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"
+	# Set global variables for nginx helper
+	domain="$old_domain"
+	path_url="$new_path"
+	# Create a dedicated nginx config
+	ynh_add_nginx_config
+fi
+
+# Change the domain for nginx
+if [ $change_domain -eq 1 ]
+then
+	# 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
+
+#=================================================
+# SPECIFIC MODIFICATIONS
+#=================================================
+# SETUP LSTU
+#=================================================
+
+domain="$new_domain"
+path_url="$new_path"
+
+ynh_backup_if_checksum_is_different "$final_path/lstu.conf"
+cp ../conf/lstu.conf.template "${final_path}/lstu.conf"
+ynh_replace_string "__DOMAIN__" "$domain" "${final_path}/lstu.conf"
+ynh_replace_string "__PATH__" "$path_url" "${final_path}/lstu.conf"
+ynh_replace_string "__PORT__" "$port" "${final_path}/lstu.conf"
+ynh_replace_string "__DB_NAME__" "$db_name"  "${final_path}/lstu.conf"
+ynh_replace_string "__DB_USER__" "$db_user"  "${final_path}/lstu.conf"
+ynh_replace_string "__DB_PWD__" "$db_pwd" "${final_path}/lstu.conf"
+
+ynh_replace_string "__SECRET__" "$secret" "${final_path}/lstu.conf"
+ynh_store_file_checksum "${final_path}/lstu.conf"
+
+#=================================================
+# GENERIC FINALISATION
+#=================================================
+# RESTART LSTU
+#=================================================
+
+ynh_systemd_action -n $app -a reload -l "Starting hot deployment for Hypnotoad server" -p "systemd"
+
+#=================================================
+# RELOAD NGINX
+#=================================================
+
+systemctl reload nginx

scripts/install

@@ -28,6 +28,7 @@ domain=$YNH_APP_ARG_DOMAIN
 path_url=$YNH_APP_ARG_PATH
 is_public=$YNH_APP_ARG_IS_PUBLIC
 theme=$YNH_APP_ARG_THEME
+password=$YNH_APP_ARG_PASSWORD
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -40,8 +41,6 @@ app=$YNH_APP_INSTANCE_NAME
 final_path=/var/www/$app
 test ! -e "$final_path" || ynh_die "This path already contains a folder"
 
-domain_regex=$(echo "$domain" | sed 's@-@.@g')
-
 # Normalize the url path syntax
 path_url=$(ynh_normalize_url_path $path_url)
 
@@ -49,7 +48,6 @@ path_url=$(ynh_normalize_url_path $path_url)
 ynh_webpath_available $domain $path_url
 # Register (book) web path
 ynh_webpath_register $app $domain $path_url
-CHECK_VAR "$domain_regex" "domain_regex empty"
 
 #=================================================
 # FIND AND OPEN A PORT
@@ -69,6 +67,8 @@ ynh_app_setting_set $app is_public $is_public
 ynh_app_setting_set $app port $port
 ynh_app_setting_set $app path $path_url
 ynh_app_setting_set $app theme $theme
+hashed_password=$(echo -n $password | sha256sum | cut -d' ' -f1)
+ynh_app_setting_set $app hashed_password $hashed_password
 
 #=================================================
 # INSTALL DEPENDENCIES
@@ -76,7 +76,7 @@ ynh_app_setting_set $app theme $theme
 
 ynh_install_app_dependencies build-essential libssl-dev zlib1g-dev libpng-dev libpq-dev memcached postgresql
 # Install Carton
-echo yes | sudo cpan Carton
+echo yes | cpan Carton
 
 #=================================================
 # CREATE A POSTGRESQL DATABASE
@@ -125,6 +125,7 @@ ynh_replace_string "__DB_NAME__" "$db_name"  "${final_path}/lstu.conf"
 ynh_replace_string "__DB_USER__" "$db_user"  "${final_path}/lstu.conf"
 ynh_replace_string "__DB_PWD__" "$db_pwd" "${final_path}/lstu.conf"
 ynh_replace_string "__SELECTED_THEME__" "$theme" "${final_path}/lstu.conf"
+ynh_replace_string "__PASSWORD_HASHED__" "$hashed_password" "${final_path}/lstu.conf"
 
 secret=$(ynh_string_random 24)
 ynh_app_setting_set $app secret $secret
@@ -157,7 +158,7 @@ ynh_use_logrotate
 # ADVERTISE SERVICE IN ADMIN PANEL
 #=================================================
 
-yunohost service add $app --log "/var/log/$app.log"
+yunohost service add $app --log "/var/log/$app.log" --log "/var/www/$app/log/production.log"
 
 #=================================================
 # SETUP SSOWAT
@@ -170,7 +171,7 @@ then	# If the app is private, only the shortened URLs are publics
 	if [ "$path_url" == "/" ]; then
 		path_url=""
 	fi
-	ynh_app_setting_set $app protected_regex "$domain_regex$path_url/login$","$domain_regex$path_url/logout$","$domain_regex$path_url/api$","$domain_regex$path_url/extensions$","$domain_regex$path_url/stats$","$domain_regex$path_url/d/.*$","$domain_regex$path_url/a$","$domain_regex$path_url/$"
+	ynh_app_setting_set $app protected_regex "$domain$path_url/login$","$domain$path_url/logout$","$domain$path_url/api$","$domain$path_url/extensions$","$domain$path_url/stats$","$domain$path_url/d/.*$","$domain$path_url/a$","$domain$path_url/$"
 else
 	ynh_replace_string "#--PRIVATE--" "" "/etc/nginx/conf.d/$domain.d/$app.conf"
 fi
@@ -179,7 +180,7 @@ fi
 # Configure owner
 #=================================================
 
-sudo chown -R www-data $final_path
+chown -R www-data $final_path
 
 #=================================================
 # Start lstu

scripts/remove

@@ -22,6 +22,17 @@ db_user=$db_name
 
 #=================================================
 # STANDARD REMOVE
+#=================================================
+# REMOVE SERVICE FROM ADMIN PANEL
+#=================================================
+
+# Remove a service from the admin panel, added by `yunohost service add`
+if yunohost service status | grep -q $app
+then
+	echo "Remove $app service"
+	yunohost service remove $app
+fi
+
 #=================================================
 # STOP AND REMOVE SERVICE
 #=================================================

scripts/upgrade

@@ -36,6 +36,7 @@ db_name=$(ynh_app_setting_get $app db_name)
 db_user=$db_name
 db_pwd=$(ynh_app_setting_get $app psqlpwd)
 theme=$(ynh_app_setting_get $app theme)
+hashed_password=$(ynh_app_setting_get $app hashed_password)
 
 #=================================================
 # FIX OLD THINGS
@@ -74,6 +75,19 @@ if [ -z "$theme" ]; then
 	ynh_app_setting_set $app theme $theme
 fi
 
+if [ -z "$hashed_password" ]; then
+	# Generate random password
+	password=$(openssl rand -hex 8)
+	hashed_password=$(echo -n $password | sha256sum | cut -d' ' -f1)
+
+	echo "The new version of LSTU provide an admin and a stats area which required a password.
+
+This password is: $password" > mail_to_send
+
+	ynh_send_readme_to_admin --app_message="mail_to_send" --type="upgrade"
+	
+	ynh_app_setting_set $app hashed_password $hashed_password
+fi
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -105,6 +119,7 @@ ynh_replace_string "__DB_NAME__" "$db_name"  "${final_path}/lstu.conf"
 ynh_replace_string "__DB_USER__" "$db_user"  "${final_path}/lstu.conf"
 ynh_replace_string "__DB_PWD__" "$db_pwd" "${final_path}/lstu.conf"
 ynh_replace_string "__SELECTED_THEME__" "$theme" "${final_path}/lstu.conf"
+ynh_replace_string "__PASSWORD_HASHED__" "$hashed_password" "${final_path}/lstu.conf"
 
 ynh_replace_string "__SECRET__" "$secret" "${final_path}/lstu.conf"
 ynh_store_file_checksum "${final_path}/lstu.conf"
@@ -147,7 +162,7 @@ yunohost service add $app --log "/var/log/$app.log"
 # RESTART LSTU
 #=================================================
 
-ynh_systemd_action -n $app -a reload -l "Starting hot deployment for Hypnotoad server" -p "systemd"
+ynh_systemd_action -n $app -a reload -l "Reloaded Shortened URLs service." -p "systemd"
 
 #=================================================
 # SETUP SSOWAT