From cb5d0d8b996e93aec62bdf5494c22292e022dfe1 Mon Sep 17 00:00:00 2001
From: "Wladimir J. van der Laan" <laanwj@gmail.com>
Date: Mon, 18 Jun 2018 13:12:07 +0200
Subject: [PATCH] Merge #13454: Make sure LC_ALL=C is set in all shell scripts

47776a958b08382d76d69b5df7beed807af168b3 Add linter: Make sure all shell scripts opt out of locale dependence using "export LC_ALL=C" (practicalswift)
3352da8da1243c03fc83ba678d2f5d193bd5a0c2 Add "export LC_ALL=C" to all shell scripts (practicalswift)

Pull request description:

  ~~Make sure `LC_ALL=C` is set when using `grep` range expressions.~~

  Make sure `LC_ALL=C` is set in all shell scripts.

  From the `grep(1)` documentation:

  > Within a bracket expression, a range expression consists of two characters separated by a hyphen. It matches any single character that sorts between the two characters, inclusive, using the locale's collating sequence and character set. For example, in the default C locale, `[a-d]` is equivalent to `[abcd]`. Many  locales sort characters in dictionary order, and in these locales `[a-d]` is typically not equivalent to `[abcd]`; it might be equivalent to `[aBbCcDd]`, for example. To obtain the traditional interpretation of bracket expressions, you can use the C locale by setting the `LC_ALL` environment variable to the value C.

  Context: [Locale issue found when reviewing #13450](https://github.com/bitcoin/bitcoin/pull/13450/files#r194877736)

Tree-SHA512: fd74d2612998f9b49ef9be24410e505d8c842716f84d085157fc7f9799d40e8a7b4969de783afcf99b7fae4f91bbb4559651f7dd6578a6a081a50bdea29f0909
---
 autogen.sh                               |  1 +
 contrib/devtools/commit-script-check.sh  |  1 +
 contrib/devtools/gen-manpages.sh         |  1 +
 contrib/devtools/git-subtree-check.sh    |  1 +
 contrib/devtools/lint-all.sh             |  4 ++++
 contrib/devtools/lint-include-guards.sh  |  1 +
 contrib/devtools/lint-includes.sh        |  1 +
 contrib/devtools/lint-logs.sh            |  2 +-
 contrib/devtools/lint-python-shebang.sh  |  2 ++
 contrib/devtools/lint-python.sh          |  2 ++
 contrib/devtools/lint-shell.sh           |  4 ++++
 contrib/devtools/lint-tests.sh           |  1 +
 contrib/devtools/lint-whitespace.sh      |  1 +
 contrib/macdeploy/detached-sig-apply.sh  |  1 +
 contrib/macdeploy/detached-sig-create.sh |  1 +
 contrib/macdeploy/extract-osx-sdk.sh     |  1 +
 contrib/qos/tc.sh                        |  1 +
 contrib/verify-commits/gpg.sh            |  1 +
 contrib/verify-commits/pre-push-hook.sh  |  1 +
 contrib/verifybinaries/verify.sh         |  1 +
 contrib/windeploy/detached-sig-create.sh |  1 +
 share/genbuild.sh                        |  1 +
 src/qt/res/movies/makespinner.sh         |  1 +
 test/lint/lint-locale-dependence.sh      |  1 +
 test/lint/lint-shell-locale.sh           | 24 ++++++++++++++++++++++++
 25 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100755 test/lint/lint-shell-locale.sh

diff --git a/autogen.sh b/autogen.sh
index 27417daf76..0c05626ccc 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -3,6 +3,7 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
+export LC_ALL=C
 set -e
 srcdir="$(dirname $0)"
 cd "$srcdir"
diff --git a/contrib/devtools/commit-script-check.sh b/contrib/devtools/commit-script-check.sh
index 1c9dbc7f68..f1327469f3 100755
--- a/contrib/devtools/commit-script-check.sh
+++ b/contrib/devtools/commit-script-check.sh
@@ -11,6 +11,7 @@
 # The resulting script should exactly transform the previous commit into the current
 # one. Any remaining diff signals an error.
 
+export LC_ALL=C
 if test "x$1" = "x"; then
     echo "Usage: $0 <commit>..."
     exit 1
diff --git a/contrib/devtools/gen-manpages.sh b/contrib/devtools/gen-manpages.sh
index d09748249c..9cc2af74ea 100755
--- a/contrib/devtools/gen-manpages.sh
+++ b/contrib/devtools/gen-manpages.sh
@@ -1,5 +1,6 @@
 #!/bin/bash
 
+export LC_ALL=C
 TOPDIR=${TOPDIR:-$(git rev-parse --show-toplevel)}
 BUILDDIR=${BUILDDIR:-$TOPDIR}
 
diff --git a/contrib/devtools/git-subtree-check.sh b/contrib/devtools/git-subtree-check.sh
index 2384d66cad..d487c1d9bd 100755
--- a/contrib/devtools/git-subtree-check.sh
+++ b/contrib/devtools/git-subtree-check.sh
@@ -3,6 +3,7 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
+export LC_ALL=C
 DIR="$1"
 COMMIT="$2"
 if [ -z "$COMMIT" ]; then
diff --git a/contrib/devtools/lint-all.sh b/contrib/devtools/lint-all.sh
index b6d86959c6..c9d4ec7199 100755
--- a/contrib/devtools/lint-all.sh
+++ b/contrib/devtools/lint-all.sh
@@ -7,6 +7,10 @@
 # This script runs all contrib/devtools/lint-*.sh files, and fails if any exit
 # with a non-zero status code.
 
+# This script is intentionally locale dependent by not setting "export LC_ALL=C"
+# in order to allow for the executed lint scripts to opt in or opt out of locale
+# dependence themselves.
+
 set -u
 
 SCRIPTDIR=$(dirname "${BASH_SOURCE[0]}")
diff --git a/contrib/devtools/lint-include-guards.sh b/contrib/devtools/lint-include-guards.sh
index 50677ae712..4e5dac7b2f 100755
--- a/contrib/devtools/lint-include-guards.sh
+++ b/contrib/devtools/lint-include-guards.sh
@@ -6,6 +6,7 @@
 #
 # Check include guards.
 
+export LC_ALL=C
 HEADER_ID_PREFIX="BITCOIN_"
 HEADER_ID_SUFFIX="_H"
 
diff --git a/contrib/devtools/lint-includes.sh b/contrib/devtools/lint-includes.sh
index 4f794d8146..8e89446c4d 100755
--- a/contrib/devtools/lint-includes.sh
+++ b/contrib/devtools/lint-includes.sh
@@ -8,6 +8,7 @@
 # Guard against accidental introduction of new Boost dependencies.
 # Check includes: Check for duplicate includes. Enforce bracket syntax includes.
 
+export LC_ALL=C
 IGNORE_REGEXP="/(leveldb|secp256k1|univalue)/"
 
 filter_suffix() {
diff --git a/contrib/devtools/lint-logs.sh b/contrib/devtools/lint-logs.sh
index 3bb54359a8..103471e7ba 100755
--- a/contrib/devtools/lint-logs.sh
+++ b/contrib/devtools/lint-logs.sh
@@ -12,7 +12,7 @@
 # There are some instances of LogPrintf() in comments. Those can be
 # ignored
 
-
+export LC_ALL=C
 UNTERMINATED_LOGS=$(git grep "LogPrintf(" -- "*.cpp" | \
     grep -v '\\n"' | \
     grep -v "/\* Continued \*/" | \
diff --git a/contrib/devtools/lint-python-shebang.sh b/contrib/devtools/lint-python-shebang.sh
index f5c5971c03..031487a91a 100755
--- a/contrib/devtools/lint-python-shebang.sh
+++ b/contrib/devtools/lint-python-shebang.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 # Shebang must use python3 (not python or python2)
+
+export LC_ALL=C
 EXIT_CODE=0
 for PYTHON_FILE in $(git ls-files -- "*.py"); do
     if [[ $(head -c 2 "${PYTHON_FILE}") == "#!" &&
diff --git a/contrib/devtools/lint-python.sh b/contrib/devtools/lint-python.sh
index ad19679b46..e1178c4aaa 100755
--- a/contrib/devtools/lint-python.sh
+++ b/contrib/devtools/lint-python.sh
@@ -6,6 +6,8 @@
 #
 # Check for specified flake8 warnings in python files.
 
+export LC_ALL=C
+
 # E112 expected an indented block
 # E113 unexpected indentation
 # E115 expected an indented block (comment)
diff --git a/contrib/devtools/lint-shell.sh b/contrib/devtools/lint-shell.sh
index 5f5fa9a925..bf56db90c6 100755
--- a/contrib/devtools/lint-shell.sh
+++ b/contrib/devtools/lint-shell.sh
@@ -6,6 +6,10 @@
 #
 # Check for shellcheck warnings in shell scripts.
 
+# This script is intentionally locale dependent by not setting "export LC_ALL=C"
+# to allow running certain versions of shellcheck that core dump when LC_ALL=C
+# is set.
+
 # Disabled warnings:
 # SC2001: See if you can use ${variable//search/replace} instead.
 # SC2004: $/${} is unnecessary on arithmetic variables.
diff --git a/contrib/devtools/lint-tests.sh b/contrib/devtools/lint-tests.sh
index ffc0660551..9d83547df4 100755
--- a/contrib/devtools/lint-tests.sh
+++ b/contrib/devtools/lint-tests.sh
@@ -6,6 +6,7 @@
 #
 # Check the test suite naming conventions
 
+export LC_ALL=C
 EXIT_CODE=0
 
 NAMING_INCONSISTENCIES=$(git grep -E '^BOOST_FIXTURE_TEST_SUITE\(' -- \
diff --git a/contrib/devtools/lint-whitespace.sh b/contrib/devtools/lint-whitespace.sh
index fd4b5c2fd1..d5f3ca1cf4 100755
--- a/contrib/devtools/lint-whitespace.sh
+++ b/contrib/devtools/lint-whitespace.sh
@@ -8,6 +8,7 @@
 
 # We can't run this check unless we know the commit range for the PR.
 
+export LC_ALL=C
 while getopts "?" opt; do
   case $opt in
     ?)
diff --git a/contrib/macdeploy/detached-sig-apply.sh b/contrib/macdeploy/detached-sig-apply.sh
index 91674a92e6..f8503e4de8 100755
--- a/contrib/macdeploy/detached-sig-apply.sh
+++ b/contrib/macdeploy/detached-sig-apply.sh
@@ -3,6 +3,7 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
+export LC_ALL=C
 set -e
 
 UNSIGNED="$1"
diff --git a/contrib/macdeploy/detached-sig-create.sh b/contrib/macdeploy/detached-sig-create.sh
index ae72b10312..d95095d46b 100755
--- a/contrib/macdeploy/detached-sig-create.sh
+++ b/contrib/macdeploy/detached-sig-create.sh
@@ -3,6 +3,7 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
+export LC_ALL=C
 set -e
 
 ROOTDIR=dist
diff --git a/contrib/macdeploy/extract-osx-sdk.sh b/contrib/macdeploy/extract-osx-sdk.sh
index ff9fbd58df..94122b56fc 100755
--- a/contrib/macdeploy/extract-osx-sdk.sh
+++ b/contrib/macdeploy/extract-osx-sdk.sh
@@ -3,6 +3,7 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
+export LC_ALL=C
 set -e
 
 INPUTFILE="Xcode_7.3.1.dmg"
diff --git a/contrib/qos/tc.sh b/contrib/qos/tc.sh
index c3eb64d280..109e546f0e 100644
--- a/contrib/qos/tc.sh
+++ b/contrib/qos/tc.sh
@@ -2,6 +2,7 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
+export LC_ALL=C
 #network interface on which to limit traffic
 IF="eth0"
 #limit of the network interface in question
diff --git a/contrib/verify-commits/gpg.sh b/contrib/verify-commits/gpg.sh
index 16d41d7269..7a10ba7d7d 100755
--- a/contrib/verify-commits/gpg.sh
+++ b/contrib/verify-commits/gpg.sh
@@ -3,6 +3,7 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
+export LC_ALL=C
 INPUT=$(cat /dev/stdin)
 VALID=false
 REVSIG=false
diff --git a/contrib/verify-commits/pre-push-hook.sh b/contrib/verify-commits/pre-push-hook.sh
index 20e13e8480..45b54150f5 100755
--- a/contrib/verify-commits/pre-push-hook.sh
+++ b/contrib/verify-commits/pre-push-hook.sh
@@ -3,6 +3,7 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
+export LC_ALL=C
 if ! [[ "$2" =~ ^(git@)?(www.)?github.com(:|/)dashpay/dash(.git)?$ ]]; then
     exit 0
 fi
diff --git a/contrib/verifybinaries/verify.sh b/contrib/verifybinaries/verify.sh
index e0266bf08a..42d9ffb752 100755
--- a/contrib/verifybinaries/verify.sh
+++ b/contrib/verifybinaries/verify.sh
@@ -11,6 +11,7 @@
 ###   The script returns 0 if everything passes the checks. It returns 1 if either the
 ###   signature check or the hash check doesn't pass. If an error occurs the return value is 2
 
+export LC_ALL=C
 function clean_up {
    for file in $*
    do
diff --git a/contrib/windeploy/detached-sig-create.sh b/contrib/windeploy/detached-sig-create.sh
index bf4978d143..15f8108cf0 100755
--- a/contrib/windeploy/detached-sig-create.sh
+++ b/contrib/windeploy/detached-sig-create.sh
@@ -3,6 +3,7 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
+export LC_ALL=C
 if [ -z "$OSSLSIGNCODE" ]; then
   OSSLSIGNCODE=osslsigncode
 fi
diff --git a/share/genbuild.sh b/share/genbuild.sh
index 419e0da0fd..38c9ba176c 100755
--- a/share/genbuild.sh
+++ b/share/genbuild.sh
@@ -3,6 +3,7 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
+export LC_ALL=C
 if [ $# -gt 1 ]; then
     cd "$2" || exit 1
 fi
diff --git a/src/qt/res/movies/makespinner.sh b/src/qt/res/movies/makespinner.sh
index d0deb1238c..76e36e4f31 100755
--- a/src/qt/res/movies/makespinner.sh
+++ b/src/qt/res/movies/makespinner.sh
@@ -2,6 +2,7 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
+export LC_ALL=C
 FRAMEDIR=$(dirname $0)
 for i in {0..35}
 do
diff --git a/test/lint/lint-locale-dependence.sh b/test/lint/lint-locale-dependence.sh
index 3144f2c841..98814ce4b9 100755
--- a/test/lint/lint-locale-dependence.sh
+++ b/test/lint/lint-locale-dependence.sh
@@ -1,5 +1,6 @@
 #!/bin/bash
 
+export LC_ALL=C
 KNOWN_VIOLATIONS=(
     "src/base58.cpp:.*isspace"
     "src/bitcoin-tx.cpp.*stoul"
diff --git a/test/lint/lint-shell-locale.sh b/test/lint/lint-shell-locale.sh
new file mode 100755
index 0000000000..d78bac2d47
--- /dev/null
+++ b/test/lint/lint-shell-locale.sh
@@ -0,0 +1,24 @@
+#!/bin/bash
+#
+# Copyright (c) 2018 The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
+#
+# Make sure all shell scripts:
+# a.) explicitly opt out of locale dependence using "export LC_ALL=C", or
+# b.) explicitly opt in to locale dependence using the annotation below.
+
+export LC_ALL=C
+
+EXIT_CODE=0
+for SHELL_SCRIPT in $(git ls-files -- "*.sh" | grep -vE "src/(secp256k1|univalue)/"); do
+    if grep -q "# This script is intentionally locale dependent by not setting \"export LC_ALL=C\"" "${SHELL_SCRIPT}"; then
+        continue
+    fi
+    FIRST_NON_COMMENT_LINE=$(grep -vE '^(#.*|)$' "${SHELL_SCRIPT}" | head -1)
+    if [[ ${FIRST_NON_COMMENT_LINE} != "export LC_ALL=C" ]]; then
+        echo "Missing \"export LC_ALL=C\" (to avoid locale dependence) as first non-comment non-empty line in ${SHELL_SCRIPT}"
+        EXIT_CODE=1
+    fi
+done
+exit ${EXIT_CODE}