Inside Bitcoin

1#!/usr/bin/env python3
2#
3# Copyright (c) 2018-present The Bitcoin Core developers
4# Distributed under the MIT software license, see the accompanying
5# file COPYING or http://www.opensource.org/licenses/mit-license.php.
6
7"""
8Make sure all shell scripts explicitly opt out of locale dependence
9using "export LC_ALL=C.UTF-8", which also enables UTF-8 mode in
10Python. See: https://docs.python.org/3/library/os.html#python-utf-8-mode
11"""
12
13import subprocess
14import sys
15import re
16
17OPT_OUT_LINES = [
18    'export LC_ALL=C.UTF-8',
19]
20
21def get_shell_files_list():
22    command = [
23        'git',
24        'ls-files',
25        '--',
26        '*.sh',
27    ]
28    try:
29        return subprocess.check_output(command, stderr = subprocess.STDOUT, text=True).splitlines()
30    except subprocess.CalledProcessError as e:
31        if e.returncode > 1: # return code is 1 when match is empty
32            print(e.output, end='')
33            sys.exit(1)
34        return []
35
36def main():
37    exit_code = 0
38    shell_files = get_shell_files_list()
39    for file_path in shell_files:
40        if re.search('src/(ipc/libmultiprocess|secp256k1|minisketch)/', file_path):
41            continue
42
43        with open(file_path, 'r') as file_obj:
44            contents = file_obj.read()
45
46        non_comment_pattern = re.compile(r'^\s*((?!#).+)$', re.MULTILINE)
47        non_comment_lines = re.findall(non_comment_pattern, contents)
48        if not non_comment_lines:
49            continue
50
51        first_non_comment_line = non_comment_lines[0]
52        if first_non_comment_line not in OPT_OUT_LINES:
53            print(f'Missing "export LC_ALL=C.UTF-8" (to avoid locale dependence) as first non-comment non-empty line in {file_path}')
54            exit_code = 1
55
56    return sys.exit(exit_code)
57
58if __name__ == '__main__':
59    main()
60
61