Vastly improved installer script

install.sh

@@ -4,12 +4,14 @@ PROGRAM=obackup
 PROGRAM_VERSION=2.0-RC1
 PROGRAM_BINARY=$PROGRAM".sh"
 PROGRAM_BATCH=$PROGRAM"-batch.sh"
-SCRIPT_BUILD=2016052501
+SCRIPT_BUILD=2016052601
 
 ## osync / obackup / pmocr / zsnap install script
 ## Tested on RHEL / CentOS 6 & 7, Fedora 23, Debian 7 & 8, Mint 17 and FreeBSD 8 & 10
 ## Please adapt this to fit your distro needs
 
+#TODO: silent mode and no stats mode
+
 CONF_DIR=/etc/$PROGRAM
 BIN_DIR=/usr/local/bin
 SERVICE_DIR_INIT=/etc/init.d
@@ -28,8 +30,56 @@ PMOCR_SERVICE_FILE_SYSTEMD_SYSTEM="pmocr-srv.service"
 
 ## Generic code
 
+## Default log file
+if [ -w /var/log ]; then
+        LOG_FILE="/var/log/$PROGRAM-install.log"
+elif ([ "$HOME" != "" ] && [ -w "$HOME" ]); then
+        LOG_FILE="$HOME/$PROGRAM-install.log"
+else
+    	LOG_FILE="./$PROGRAM-install.log"
+fi
+
+# Generic quick logging function
+function _QuickLogger {
+        local value="${1}"
+       	local destination="${2}" # Destination: stdout, log, both
+
+        if ([ "$destination" == "log" ] || [ "$destination" == "both" ]); then
+                echo -e "$(date) - $value" >> "$LOG_FILE"
+        elif ([ "$destination" == "stdout" ] || [ "$destination" == "both" ]); then
+                echo -e "$value"
+       	fi
+}
+
+function QuickLogger {
+	local value="${1}"
+
+	if [ "$_SILENT" -eq 1 ]; then
+		_QuickLogger "$value" "log"
+	else
+		_QuickLogger "$value" "stdout"
+	fi
+}
+
+function urlencode() {
+    # urlencode <string>
+
+    local LANG=C
+    local length="${#1}"
+    for (( i = 0; i < length; i++ )); do
+        local c="${1:i:1}"
+        case $c in
+            [a-zA-Z0-9.~_-]) printf "$c" ;;
+            *) printf '%%%02X' "'$c" ;; 
+        esac
+    done
+}
+
+function SetOSSettings {
 	USER=root
 
+	local local_os_var
+
 	local_os_var="$(uname -spio 2>&1)"
 	if [ $? != 0 ]; then
 		local_os_var="$(uname -v 2>&1)"
@@ -55,10 +105,14 @@ case $local_os_var in
 	esac
 
 	if ([ "$USER" != "" ] && [ "$(whoami)" != "$USER" ]); then
-  echo "Must be run as $USER."
+	  	QuickLogger "Must be run as $USER."
 		exit 1
 	fi
 
+	OS=$(urlencode "$local_os_var")
+}
+
+function GetInit {
 	if [ -f /sbin/init ]; then
 		if file /sbin/init | grep systemd > /dev/null; then
 			init="systemd"
@@ -66,22 +120,26 @@ if [ -f /sbin/init ]; then
 			init="initV"
 		fi
 	else
-	echo "Can't detect initV or systemd. Service files won't be installed. You can still run $PROGRAM manually or via cron."
+		QuickLogger "Can't detect initV or systemd. Service files won't be installed. You can still run $PROGRAM manually or via cron."
-	init=none
+		init="none"
 	fi
+}
 
+function CreateConfDir {
 	if [ ! -d "$CONF_DIR" ]; then
 		mkdir "$CONF_DIR"
 		if [ $? == 0 ]; then
-		echo "Created directory [$CONF_DIR]."
+			QuickLogger "Created directory [$CONF_DIR]."
 		else
-		echo "Cannot create directory [$CONF_DIR]."
+			QuickLogger "Cannot create directory [$CONF_DIR]."
 			exit 1
 		fi
 	else
-	echo "Config directory [$CONF_DIR] exists."
+		QuickLogger "Config directory [$CONF_DIR] exists."
 	fi
+}
 
+function CopyExampleFiles {
 	if [ -f "./sync.conf.example" ]; then
 		cp "./sync.conf.example" "/etc/$PROGRAM/sync.conf.example"
 	fi
@@ -97,59 +155,64 @@ fi
 	if [ -f "./snapshot.conf.example" ]; then
 		cp "./snapshot.conf.example" "/etc/$PROGRAM/snapshot.conf.example"
 	fi
+}
 
+function CopyProgram {
 	cp "./$PROGRAM_BINARY" "$BIN_DIR"
 	if [ $? != 0 ]; then
-	echo "Cannot copy $PROGRAM_BINARY to [$BIN_DIR]."
+		QuickLogger "Cannot copy $PROGRAM_BINARY to [$BIN_DIR]. Make sure to run install script in the directory containing all other files."
+		QuickLogger "Also make sure you have permissions to write to [$BIN_DIR]."
+		exit 1
 	else
 		chmod 755 "$BIN_DIR/$PROGRAM_BINARY"
-	echo "Copied $PROGRAM_BINARY to [$BIN_DIR]."
+		QuickLogger "Copied $PROGRAM_BINARY to [$BIN_DIR]."
 	fi
 
 	if [ -f "./$PROGRAM_BATCH" ]; then
 		cp "./$PROGRAM_BATCH" "$BIN_DIR"
 		if [ $? != 0 ]; then
-		echo "Cannot copy $PROGRAM_BATCH to [$BIN_DIR]."
+			QuickLogger "Cannot copy $PROGRAM_BATCH to [$BIN_DIR]."
 		else
 			chmod 755 "$BIN_DIR/$PROGRAM_BATCH"
-		echo "Copied $PROGRAM_BATCH to [$BIN_DIR]."
+			QuickLogger "Copied $PROGRAM_BATCH to [$BIN_DIR]."
 		fi
 	fi
 
 	if [  -f "./ssh_filter.sh" ]; then
 		cp "./ssh_filter.sh" "$BIN_DIR"
 		if [ $? != 0 ]; then
-		echo "Cannot copy ssh_filter.sh to [$BIN_DIR]."
+			QuickLogger "Cannot copy ssh_filter.sh to [$BIN_DIR]."
 		else
 			chmod 755 "$BIN_DIR/ssh_filter.sh"
 			if ([ "$USER" != "" ] && [ "$GROUP" != "" ]); then
 				chown $USER:$GROUP "$BIN_DIR/ssh_filter.sh"
 			fi
-		echo "Copied ssh_filter.sh to [$BIN_DIR]."
+			QuickLogger "Copied ssh_filter.sh to [$BIN_DIR]."
 		fi
 	fi
+}
 
-
+function CopyServiceFiles {
 	# OSYNC SPECIFIC
 	if ([ "$init" == "systemd" ] && [ -f "./$OSYNC_SERVICE_FILE_SYSTEMD_SYSTEM" ]); then
 		cp "./$OSYNC_SERVICE_FILE_SYSTEMD_SYSTEM" "$SERVICE_DIR_SYSTEMD_SYSTEM" && cp "./$OSYNC_SERVICE_FILE_SYSTEMD_USER" "$SERVICE_DIR_SYSTEMD_USER/$SERVICE_FILE_SYSTEMD_SYSTEM"
 		if [ $? != 0 ]; then
-		echo "Cannot copy the systemd file to [$SERVICE_DIR_SYSTEMD_SYSTEM] or [$SERVICE_DIR_SYSTEMD_USER]."
+			QuickLogger "Cannot copy the systemd file to [$SERVICE_DIR_SYSTEMD_SYSTEM] or [$SERVICE_DIR_SYSTEMD_USER]."
 		else
-		echo "Created osync-srv service in [$SERVICE_DIR_SYSTEMD_SYSTEM] and [$SERVICE_DIR_SYSTEMD_USER]."
+			QuickLogger "Created osync-srv service in [$SERVICE_DIR_SYSTEMD_SYSTEM] and [$SERVICE_DIR_SYSTEMD_USER]."
-		echo "Can be activated with [systemctl start osync-srv@instance.conf] where instance.conf is the name of the config file in /etc/osync."
+			QuickLogger "Can be activated with [systemctl start osync-srv@instance.conf] where instance.conf is the name of the config file in /etc/osync."
-		echo "Can be enabled on boot with [systemctl enable osync-srv@instance.conf]."
+			QuickLogger "Can be enabled on boot with [systemctl enable osync-srv@instance.conf]."
-		echo "In userland, active with [systemctl --user start osync-srv@instance.conf]."
+			QuickLogger "In userland, active with [systemctl --user start osync-srv@instance.conf]."
 		fi
-elif ( "$init" == "initV" ] && [ -f "./$OSYNC_SERVICE_FILE_INIT" ]); then
+	elif ([ "$init" == "initV" ] && [ -f "./$OSYNC_SERVICE_FILE_INIT" ]); then
 		cp "./$OSYNC_SERVICE_FILE_INIT" "$SERVICE_DIR_INIT"
 		if [ $? != 0 ]; then
-		echo "Cannot copy osync-srv to [$SERVICE_DIR_INIT]."
+			QuickLogger "Cannot copy osync-srv to [$SERVICE_DIR_INIT]."
 		else
 			chmod 755 "$SERVICE_DIR_INIT/$OSYNC_SERVICE_FILE_INIT"
-		echo "Created osync-srv service in [$SERVICE_DIR_INIT]."
+			QuickLogger "Created osync-srv service in [$SERVICE_DIR_INIT]."
-		echo "Can be activated with [service $OSYNC_SERVICE_FILE_INIT start]."
+			QuickLogger "Can be activated with [service $OSYNC_SERVICE_FILE_INIT start]."
-		echo "Can be enabled on boot with [chkconfig $OSYNC_SERVICE_FILE_INIT on]."
+			QuickLogger "Can be enabled on boot with [chkconfig $OSYNC_SERVICE_FILE_INIT on]."
 		fi
 	fi
 
@@ -157,48 +220,83 @@ fi
 	if ([ "$init" == "systemd" ] && [ -f "./$PMOCR_SERVICE_FILE_SYSTEMD_SYSTEM" ]); then
 		cp "./$PMOCR_SERVICE_FILE_SYSTEMD_SYSTEM" "$SERVICE_DIR_SYSTEMD_SYSTEM"
 		if [ $? != 0 ]; then
-		echo "Cannot copy the systemd file to [$SERVICE_DIR_SYSTEMD_SYSTEM] or [$SERVICE_DIR_SYSTEMD_USER]."
+			QuickLogger "Cannot copy the systemd file to [$SERVICE_DIR_SYSTEMD_SYSTEM] or [$SERVICE_DIR_SYSTEMD_USER]."
 		else
-		echo "Created pmocr-srv service in [$SERVICE_DIR_SYSTEMD_SYSTEM] and [$SERVICE_DIR_SYSTEMD_USER]."
+			QuickLogger "Created pmocr-srv service in [$SERVICE_DIR_SYSTEMD_SYSTEM] and [$SERVICE_DIR_SYSTEMD_USER]."
-		echo "Can be activated with [systemctl start pmocr-srv] after configuring file options in [$BIN_DIR/$PROGRAM]."
+			QuickLogger "Can be activated with [systemctl start pmocr-srv] after configuring file options in [$BIN_DIR/$PROGRAM]."
-		echo "Can be enabled on boot with [systemctl enable pmocr-srv]."
+			QuickLogger "Can be enabled on boot with [systemctl enable pmocr-srv]."
 		fi
 	elif ([ "$init" == "initV" ] && [ -f "./$PMOCR_SERVICE_FILE_INIT" ]); then
 		cp "./$PMOCR_SERVICE_FILE_INIT" "$SERVICE_DIR_INIT"
 		if [ $? != 0 ]; then
-		echo "Cannot copy pmoct-srv to [$SERVICE_DIR_INIT]."
+			QuickLogger "Cannot copy pmoct-srv to [$SERVICE_DIR_INIT]."
 		else
 			chmod 755 "$SERVICE_DIR_INIT/$PMOCR_SERVICE_FILE_INIT"
-		echo "Created osync-srv service in [$SERVICE_DIR_INIT]."
+			QuickLogger "Created osync-srv service in [$SERVICE_DIR_INIT]."
-		echo "Can be activated with [service $PMOCR_SERVICE_FILE_INIT start]."
+			QuickLogger "Can be activated with [service $PMOCR_SERVICE_FILE_INIT start]."
-		echo "Can be enabled on boot with [chkconfig $PMOCR_SERVICE_FILE_INIT on]."
+			QuickLogger "Can be enabled on boot with [chkconfig $PMOCR_SERVICE_FILE_INIT on]."
 		fi
 	fi
+}
 
 function Statistics {
-
-        local link="http://instcount.netpower.fr?program=$PROGRAM&version=$PROGRAM_VERSION&os=$local_os_var"
         if type wget > /dev/null; then
-                wget -qO- $link > /dev/null 2>&1
+                wget -qO- "$STATS_LINK" > /dev/null 2>&1
                 if [ $? == 0 ]; then
                         return 0
                 fi
 	fi
 
         if type curl > /dev/null; then
-                curl -o /dev/null $link > /dev/null 2>&1
+                curl "$STATS_LINK" -o /dev/null > /dev/null 2>&1
                 if [ $? == 0 ]; then
                         return 0
                 fi
 	fi
 
-       	echo "Neiter wget nor curl could be used for. Cannot run statistics. Use the provided link please."
+       	QuickLogger "Neiter wget nor curl could be used for. Cannot run statistics. Use the provided link please."
-        retun 1
+        return 1
 }
 
-echo "$PROGRAM installed. Use with $BIN_DIR/$PROGRAM"
+function Usage {
-echo ""
+	echo "Installs $PROGRAM into $BIN_DIR"
-echo "In order to make install statistics, the script would like to connect to http://instcount.netpower.fr?program=$PROGRAM&version=$PROGRAM_VERSION"
+	echo "options:"
+	echo "--silent		Will log and bypass user interaction."
+	echo "--no-stats	Used with --silent in order to refuse sending anonymous install stats."
+	exit 127
+}
+
+_SILENT=0
+_STATS=1
+for i in "$@"
+do
+	case $i in
+		--silent)
+		_SILENT=1
+		;;
+		--no-stats)
+		_STATS=0
+		;;
+		--help|-h|-?)
+		Usage
+	esac
+done
+
+SetOSSettings
+CreateConfDir
+CopyExampleFiles
+CopyProgram
+GetInit
+CopyServiceFiles
+
+STATS_LINK="http://instcount.netpower.fr?program=$PROGRAM&version=$PROGRAM_VERSION&os=$OS"
+
+QuickLogger "$PROGRAM installed. Use with $BIN_DIR/$PROGRAM"
+if [ $_STATS -eq 1 ]; then
+	if [ $_SILENT -eq 1 ]; then
+		Statistics
+	else
+		QuickLogger "In order to make install statistics, the script would like to connect to $STATS_LINK"
 		read -r -p "No data except those in the url will be send. Allow [Y/n]" response
 		case $response in
 			[nN])
@@ -209,3 +307,5 @@ case $response in
 			exit $?
 			;;
 		esac
+	fi
+fi