From b27fa9e7cca4acf7aff9cb2f5a79356c5d62c8c2 Mon Sep 17 00:00:00 2001
From: magikcypress <cyp@rouquin.me>
Date: Sun, 18 Jun 2017 01:53:14 +0200
Subject: [PATCH] [fix] add ynh_exit_properly on generic function

---
 scripts/_common.sh | 34 ++++++++++++++++++++++++++++++++++
 scripts/install    |  2 +-
 2 files changed, 35 insertions(+), 1 deletion(-)

diff --git a/scripts/_common.sh b/scripts/_common.sh
index e8691e2..2bea361 100644
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -343,6 +343,40 @@ ynh_backup_before_upgrade () {  # Backup the current version of the app, restore
   fi
 }
 
+
+# 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
+      ynh_die # 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.
diff --git a/scripts/install b/scripts/install
index 06c8e2b..e4d11b1 100644
--- a/scripts/install
+++ b/scripts/install
@@ -80,7 +80,7 @@ exec_composer admin "$final_path" require \
     "sblaisot/automatic_addressbook 0.4.2"
 installed_plugins+=" 'contextmenu', 'automatic_addressbook',"
 
-# Instal CardDAV plugin
+# Install CardDAV plugin
 if [[ $with_carddav -eq 1 ]]; then
   install_carddav "$final_path" \
     && installed_plugins+=" 'carddav'," \