Merging with upstream 3.0.11

1 files changed, 122 insertions, 21 deletions

diff --git a/git-tools/hooks/commit-msg b/git-tools/hooks/commit-msg
index a6777ff9c9..b156d276df 100755
--- a/git-tools/hooks/commit-msg
+++ b/git-tools/hooks/commit-msg
@@ -11,14 +11,30 @@
 #
 # ln -s ../../git-tools/hooks/commit-msg \\
 #   .git/hooks/commit-msg
+#
+# You can configure whether invalid commit messages abort commits:
+#
+# git config phpbb.hooks.commit-msg.fatal true	(abort)
+# git config phpbb.hooks.commit-msg.fatal false (warn only, do not abort)
+#
+# The default is to warn only.
+#
+# Warning/error messages use color by default if the output is a terminal
+# ("output" here is normally standard error when you run git commit).
+# To force or disable the use of color:
+#
+# git config phpbb.hooks.commit-msg.color true	(force color output)
+# git config phpbb.hooks.commit-msg.color false (disable color output)
 
 config_ns="phpbb.hooks.commit-msg";
 
-if [ "$(git config --bool $config_ns.fatal)" = "false" ]
+if [ "$(git config --bool $config_ns.fatal)" = "true" ]
 then
-	fatal=0;
-else
 	fatal=1;
+	severity=Error;
+else
+	fatal=0;
+	severity=Warning;
 fi
 
 debug_level=$(git config --int $config_ns.debug || echo 0);
@@ -47,20 +63,86 @@ debug()
 
 quit()
 {
-	if [ $1 -gt 0 ] && [ $1 -ne $ERR_UNKNOWN ] && [ $fatal -eq 0 ]
+	if [ $1 -eq 0 ] || [ $1 -eq $ERR_UNKNOWN ]
 	then
+		# success
+		exit 0;
+	elif [ $fatal -eq 0 ]
+	then
+		# problems found but fatal is false
+		complain 'Please run `git commit --amend` and fix the problems mentioned.' 1>&2
 		exit 0;
 	else
+		complain "Aborting commit." 1>&2
 		exit $1;
 	fi
 }
 
-msg=$(grep -nE '.{81,}' "$1");
+use_color()
+{
+	if [ -z "$use_color_cached" ]
+	then
+		case $(git config --bool $config_ns.color)
+		in
+		false)
+			use_color_cached=1
+			;;
+		true)
+			use_color_cached=0
+			;;
+		*)
+			# tty detection in shell:
+			# http://hwi.ath.cx/jsh/list/shext/isatty.sh.html
+			tty 0>/dev/stdout >/dev/null 2>&1
+			use_color_cached=$?
+			;;
+		esac
+	fi
+	# return value is the flag inverted -
+	# if return value is 0, this means use color
+	return $use_color_cached
+}
+
+complain()
+{
+	if use_color
+	then
+		# Careful: our argument may include arguments to echo like -n
+		# ANSI color codes:
+		# http://pueblo.sourceforge.net/doc/manual/ansi_color_codes.html
+		printf "\033[31m\033[1m"
+		if [ "$1" = "-n" ]
+		then
+			echo "$@"
+			printf "\033[0m"
+		else
+			# This will print one trailing space.
+			# Not sure how to avoid this at the moment.
+			echo "$@" $(printf "\033[0m")
+		fi
+	else
+		echo "$@"
+	fi
+}
+
+# Check for empty commit message
+if ! grep -qv '^#' "$1"
+then
+	# Commit message is empty (or contains only comments).
+	# Let git handle this.
+	# It will abort with a message like so:
+	#
+	# Aborting commit due to empty commit message.
+	exit 0
+fi
+
+msg=$(grep -v '^#' "$1" |grep -nE '.{81,}')
 
 if [ $? -eq 0 ]
 then
-	echo "The following lines are greater than 80 characters long:\n" >&2;
-	echo $msg >&2;
+	complain "The following lines are greater than 80 characters long:" >&2;
+	complain >&2
+	complain "$msg" >&2;
 
 	quit $ERR_LENGTH;
 fi
@@ -107,7 +189,19 @@ do
 		case $expect in
 			"header")
 				err=$ERR_HEADER;
-				echo "$line" | grep -Eq "^\[(ticket/[0-9]+|feature/$branch_regex|task/$branch_regex)\] [A-Z].+$"
+				echo "$line" | grep -Eq "^\[(ticket/[0-9]+|feature/$branch_regex|task/$branch_regex)\] .+$"
+				result=$?
+				if ! echo "$line" | grep -Eq "^\[(ticket/[0-9]+|feature/$branch_regex|task/$branch_regex)\] [A-Z].+$"
+				then
+					# Don't be too strict.
+					# Commits may be temporary, intended to be squashed later.
+					# Just issue a warning here.
+					complain "$severity: heading should be a sentence beginning with a capital letter." 1>&2
+					complain "You entered:" 1>&2
+					complain "$line" 1>&2
+				fi
+				# restore exit code
+				(exit $result)
 			;;
 			"empty")
 				err=$ERR_EMPTY;
@@ -128,11 +222,15 @@ do
 				# Should not end up here
 				false
 			;;
+			"possibly-eof")
+				# Allow empty and/or comment lines at the end
+				! tail -n +"$i" "$1" |grep -qvE '^($|#)'
+			;;
 			"comment")
 				echo "$line" | grep -Eq "^#";
 			;;
 			*)
-				echo "Unrecognised token $expect" >&2;
+				complain "Unrecognised token $expect" >&2;
 				quit $err;
 			;;
 		esac
@@ -188,7 +286,7 @@ do
 				in_description=1;
 			;;
 			"footer")
-				expecting="footer eof";
+				expecting="footer possibly-eof";
 				if [ "$tickets" = "" ]
 				then
 					tickets="$line";
@@ -199,8 +297,11 @@ do
 			"comment")
 				# Comments should expect the same thing again
 			;;
+			"possibly-eof")
+				expecting="eof";
+			;;
 			*)
-				echo "Unrecognised token $expect" >&2;
+				complain "Unrecognised token $expect" >&2;
 				quit 254;
 			;;
 		esac
@@ -214,11 +315,11 @@ do
 	else
 		# None of the expected line formats matched
 		# Guess we'll call it a day here then
-		echo "Syntax error on line $i:" >&2;
-		echo ">> $line" >&2;
-		echo -n "Expecting: " >&2;
-		echo "$expecting" | sed 's/ /, /g' >&2;
-		exit $err;
+		complain "Syntax error on line $i:" >&2;
+		complain ">> $line" >&2;
+		complain -n "Expecting: " >&2;
+		complain "$expecting" | sed 's/ /, /g' >&2;
+		quit $err;
 	fi
 
 	i=$(( $i + 1 ));
@@ -227,7 +328,7 @@ done
 # If EOF is expected exit cleanly
 echo "$expecting" | grep -q "eof" || (
 	# Unexpected EOF, error
-	echo "Unexpected EOF encountered" >&2;
+	complain "Unexpected EOF encountered" >&2;
 	quit $ERR_EOF;
 ) && (
 	# Do post scan checks
@@ -238,8 +339,8 @@ echo "$expecting" | grep -q "eof" || (
 
 		if [ ! -z "$dupes" ]
 		then
-			echo "The following tickets are repeated:" >&2;
-			echo "$dupes" | sed 's/ /\n/g;s/^/* /g' >&2;
+			complain "The following tickets are repeated:" >&2;
+			complain "$dupes" | sed 's/ /\n/g;s/^/* /g' >&2;
 			quit $ERR_FOOTER;
 		fi
 	fi
@@ -247,8 +348,8 @@ echo "$expecting" | grep -q "eof" || (
 	if [ $ticket -gt 0 ]
 	then
 		echo "$tickets" | grep -Eq "\bPHPBB3-$ticket\b" || (
-			echo "Ticket ID [$ticket] of branch missing from list of tickets:" >&2;
-			echo "$tickets" | sed 's/ /\n/g;s/^/* /g' >&2;
+			complain "Ticket ID [$ticket] of branch missing from list of tickets:" >&2;
+			complain "$tickets" | sed 's/ /\n/g;s/^/* /g' >&2;
 			quit $ERR_FOOTER;
 		) || exit $?;
 	fi