Synchronize git hooks

This patch introduces the latest changes from lab0-c [1] for Git hooks,
which prevent students from wring something unpleasant. This patch introduces

[1] https://github.com/sysprog21/lab0-c

Author: jserv

scripts/commit-msg.hook

@@ -118,6 +118,9 @@ read_commit_message() {
     [[ $REPLY =~ ^# ]]
     test $? -eq 0 || COMMIT_MSG_LINES+=("$REPLY")
 
+    [[ $REPLY =~ "# ------------------------ >8 ------------------------" ]]
+    break
+
   done < $COMMIT_MSG_FILE
 }
 
@@ -154,7 +157,7 @@ validate_commit_message() {
       echo "Aspell not installed - unable to check spelling"
   else
       LINE_NUMBER=1
-      MISSPELLED_WORDS=`echo "$COMMIT_MSG_LINES[LINE_NUMBER]" | $ASPELL --lang=en --list --home-dir=scripts --personal=aspell-pws`
+      MISSPELLED_WORDS=$(echo "$COMMIT_MSG_LINES[LINE_NUMBER]" | $ASPELL --lang=en --list --home-dir=scripts --personal=aspell-pws)
       if [ -n "$MISSPELLED_WORDS" ]; then
         add_warning LINE_NUMBER "Possible misspelled word(s): $MISSPELLED_WORDS"
       fi
@@ -169,7 +172,7 @@ validate_commit_message() {
   # 2. Limit the subject line to configured number of characters
   # ------------------------------------------------------------------------------
 
-  subject_max_length=$(git config --get hooks.goodcommit.subjectmaxlength || echo '60')
+  subject_max_length=$(git config --get hooks.goodcommit.subjectmaxlength || echo '50')
   test "${#COMMIT_SUBJECT}" -le $subject_max_length
   test $? -eq 0 || add_warning 1 "Limit the subject line to $subject_max_length characters (${#COMMIT_SUBJECT} chars)"
 
@@ -188,7 +191,7 @@ validate_commit_message() {
   # 5. Use the imperative mood in the subject line
   # ------------------------------------------------------------------------------
 
-  IMPERATIVE_MOOD_BLACKLIST=(
+  IMPERATIVE_MOOD_DENYLIST=(
     added          adds          adding
     adjusted       adjusts       adjusting
     amended        amends        amending
@@ -235,9 +238,9 @@ validate_commit_message() {
   # enable case insensitive match
   shopt -s nocasematch
 
-  for BLACKLISTED_WORD in "${IMPERATIVE_MOOD_BLACKLIST[@]}"; do
-    [[ ${COMMIT_SUBJECT_TO_PROCESS} =~ ^[[:blank:]]*$BLACKLISTED_WORD ]]
-    test $? -eq 0 && add_warning 1 "Use the imperative mood in the subject line, e.g 'fix' not 'fixes'" && break
+  for DENYLISTED_WORD in "${IMPERATIVE_MOOD_DENYLIST[@]}"; do
+    [[ ${COMMIT_SUBJECT_TO_PROCESS} =~ ^[[:blank:]]*$DENYLISTED_WORD ]]
+    test $? -eq 0 && add_warning 1 "Use the imperative mood in the subject line, e.g., 'fix' not 'fixes'" && break
   done
 
   # disable case insensitive match
@@ -266,6 +269,10 @@ validate_commit_message() {
   test "${#COMMIT_SUBJECT_WORDS[@]}" -gt 1
   test $? -eq 0 || add_warning 1 "Do no write single worded commits"
 
+  # 8a. Do not mention C source filenames
+  [[ ${COMMIT_SUBJECT_TO_PROCESS} =~ [_a-zA-Z0-9]+\.[ch]$ ]]
+  test $? -eq 1 || add_warning 1 "Avoid mentioning C source filenames"
+
   # 9. Do not start the subject line with whitespace
   # ------------------------------------------------------------------------------
 

scripts/pre-commit.hook

@@ -1,7 +1,16 @@
 #!/usr/bin/env bash
 
-CPPCHECK_suppresses="--suppress=missingIncludeSystem"
-CPPCHECK_OPTS="-I. --enable=all --error-exitcode=1 --force $CPPCHECK_suppresses ."
+CPPCHECK_unmatched=
+for f in *.c; do
+    CPPCHECK_unmatched="$CPPCHECK_unmatched --suppress=unmatchedSuppression:$f"
+done
+
+CPPCHECK_suppresses="\
+--suppress=missingIncludeSystem \
+--suppress=noValidConfiguration \
+--suppress=unusedFunction\
+"
+CPPCHECK_OPTS="-I. --enable=all --error-exitcode=1 --force $CPPCHECK_suppresses $CPPCHECK_unmatched ."
 
 RETURN=0
 CLANG_FORMAT=$(which clang-format)
@@ -16,23 +25,45 @@ if [ $? -ne 0 ]; then
     exit 1
 fi
 
+# Expected Cppcheck version is 1.90+
+# First, Cppcheck 2.x
+if [ -z "$($CPPCHECK --version | grep -E '^Cppcheck\s2')" ]; then
+    # Second, Cppcheck 1.x
+    CPPCHECK_VER=$($CPPCHECK --version | sed -Ee 's/Cppcheck 1.([0-9]+)/\1/;q')
+    if [ $CPPCHECK_VER -lt 90 ]; then
+        echo "[!] cppcheck version must be at least 1.90." >&2
+        echo -e "    Check 'Developer Info' for building Cppcheck from source:\n" \
+                "          http://cppcheck.sourceforge.net/devinfo/" >&2
+        exit 1
+    fi
+fi
+
 ASPELL=$(which aspell)
 if [ $? -ne 0 ]; then
     echo "[!] aspell not installed. Unable to do spelling check." >&2
     exit 1
 fi
+if [ -z "$(aspell dump dicts | grep -E '^en$')" ]; then
+    echo "[!] aspell-en not installed. Unable to do spelling check." >&2
+    exit 1
+fi
 
 DIFF=$(which colordiff)
 if [ $? -ne 0 ]; then
     DIFF=diff
 fi
 
-FILES=`git diff --cached --name-only --diff-filter=ACMR | grep -E "\.(c|cpp|h)$"`
+SHA1SUM=$(which sha1sum)
+if [ $? -ne 0 ]; then
+    SHA1SUM=shasum
+fi
+
+FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep -E "\.(c|cpp|h)$")
 for FILE in $FILES; do
-    nf=`git checkout-index --temp $FILE | cut -f 1`
-    tempdir=`mktemp -d` || exit 1
-    newfile=`mktemp ${tempdir}/${nf}.XXXXXX` || exit 1
-    basename=`basename $FILE`
+    nf=$(git checkout-index --temp $FILE | cut -f 1)
+    tempdir=$(mktemp -d) || exit 1
+    newfile=$(mktemp ${tempdir}/${nf}.XXXXXX) || exit 1
+    basename=$(basename $FILE)
 
     source="${tempdir}/${basename}"
     mv $nf $source
@@ -54,6 +85,17 @@ for FILE in $FILES; do
     fi
 done
 
+if [ ! -z "${FILES[*]}" ]; then
+    echo "Following files need to be cleaned up:"
+    echo "${FILES[*]}"
+fi
+
+$SHA1SUM -c scripts/checksums >/dev/null
+if [ $? -ne 0 ]; then
+    echo "[!] You are not allowed to change the header file queue.h or list.h" >&2
+    exit 1
+fi
+
 # Prevent unsafe functions
 root=$(git rev-parse --show-toplevel)
 banned="([^f]gets\()|(sprintf\()|(strcpy\()"
@@ -81,4 +123,18 @@ if [ $? -ne 0 ]; then
     echo
 fi
 
+# non-ASCII filenames are not allowed.
+# Cross platform projects tend to avoid non-ASCII filenames; prevent
+# them from being added to the repository.
+if test $(git diff --cached --name-only --diff-filter=A -z $against |
+        LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
+then
+    cat <<\EOF
+ERROR: Attempt to add a non-ASCII file name.
+This can cause problems if you want to work with people on other platforms.
+To be portable it is advisable to rename the file.
+EOF
+    RETURN=1
+fi
+
 exit $RETURN