#!/bin/sh
+#
+## Copyright (C) 1996-2021 The Squid Software Foundation and contributors
+##
+## Squid software is distributed under GPLv2+ license and includes
+## contributions from numerous individuals and organizations.
+## Please see the COPYING and CONTRIBUTORS files for details.
+##
+
#
# This script contains the code run to perform automatic source maintenance
+# on Squid
#
## Source Code Format Enforcement
# If code alteration takes place the process is halted for manual intervention.
#
+# whether to continue execution after a failure
+# TODO: Expand the subset of failures covered by this feature; see run_().
+KeepGoing="no"
+# the actual name of the directive that enabled keep-going mode
+KeepGoingDirective=""
+#
+# The script checks that the version of astyle is TargetAstyleVersion.
+# if it isn't, the default behaviour is to not perform the formatting stage
+# in order to avoid unexpected massive changes if the behaviour of astyle
+# has changed in different releases.
+# if --with-astyle /path/to/astyle is used, the check is still performed
+# and a warning is printed, but the sources are reformatted
+TargetAstyleVersion="2.04"
+ASTYLE='astyle'
+
+# whether to check and, if necessary, update boilerplate copyright years
+CheckAndUpdateCopyright=yes
+
+printUsage () {
+ echo "Usage: $0 [option...]"
+ echo "options:"
+ echo " --keep-going|-k"
+ echo " --check-and-update-copyright <yes|no>"
+ echo " --with-astyle </path/to/astyle/executable>"
+}
+
+# command-line options
+while [ $# -ge 1 ]; do
+ case "$1" in
+ --keep-going|-k)
+ KeepGoing=yes
+ KeepGoingDirective=$1
+ shift
+ ;;
+ --check-and-update-copyright)
+ if test "x$2" != xyes -a "x$2" != xno
+ then
+ printUsage
+ echo "Error: Option $1 expects a yes or no argument but got $2"
+ exit 1;
+ fi
+ CheckAndUpdateCopyright=$2
+ shift 2
+ ;;
+ --help|-h)
+ printUsage
+ exit 0;
+ ;;
+ --with-astyle)
+ ASTYLE=$2
+ export ASTYLE
+ shift 2
+ ;;
+ *)
+ printUsage
+ echo "Unsupported command-line option: $1"
+ exit 1;
+ ;;
+ esac
+done
+
+# an error code seen by a KeepGoing-aware command (or zero)
+SeenErrors=0
+
+
+if ! git diff --quiet; then
+ echo "There are unstaged changes. This script may modify sources."
+ echo "Stage changes to avoid permanent losses when things go bad."
+ exit 1
+fi
+
# On squid-cache.org we have to use the python scripted md5sum
HOST=`hostname`
if test "$HOST" = "squid-cache.org" ; then
MD5="md5sum"
fi
-ROOT=`bzr root`
-
-ASVER=`astyle --version 2>&1 | grep -o -E "[0-9.]+"`
-if test "${ASVER}" != "1.23" ; then
- echo "Astyle version problem. You have ${ASVER} instead of 1.23";
+${ASTYLE} --version >/dev/null 2>/dev/null
+result=$?
+if test $result -gt 0 ; then
+ echo "ERROR: cannot run ${ASTYLE}"
+ exit 1
+fi
+ASVER=`${ASTYLE} --version 2>&1 | grep -o -E "[0-9.]+"`
+if test "${ASVER}" != "${TargetAstyleVersion}" ; then
+ if test "${ASTYLE}" = "astyle" ; then
+ echo "Astyle version problem. You have ${ASVER} instead of ${TargetAstyleVersion}"
+ echo "Formatting step skipped due to version mismatch"
+ ASVER=""
+ else
+ echo "WARNING: ${ASTYLE} is version ${ASVER} instead of ${TargetAstyleVersion}"
+ echo "Formatting anyway, please double check output before submitting"
+ fi
else
echo "Found astyle ${ASVER}. Formatting..."
fi
-srcformat ()
+if test $CheckAndUpdateCopyright = yes
+then
+ COPYRIGHT_YEARS=`date +"1996-%Y"`
+ echo "s/1996-2[0-9]+ The Squid Software Foundation and contributors/${COPYRIGHT_YEARS} The Squid Software Foundation and contributors/g" >> boilerplate_fix.sed
+fi
+
+# executes the specified command
+# in KeepGoing mode, remembers errors and hides them from callers
+run_ ()
{
-PWD=`pwd`
-#echo "FORMAT: ${PWD}..."
+ "$@" && return; # return on success
+ error=$?
+
+ if test $KeepGoing = no; then
+ return $error
+ fi
-for FILENAME in `ls -1`; do
+ echo "ERROR: Continuing after a failure ($error) due to $KeepGoingDirective"
+ SeenErrors=$error # TODO: Remember the _first_ error instead
+ return 0 # hide error from the caller
+}
+
+updateIfChanged ()
+{
+ original="$1"
+ updated="$2"
+ message="$3"
+
+ if ! cmp -s "${original}" "${updated}"; then
+ echo "NOTICE: File ${original} changed: ${message}"
+ run_ mv "${updated}" "${original}" || return
+ else
+ run_ rm -f "${updated}" || exit $?
+ fi
+}
+
+# uses the given script to update the given source file
+applyPlugin ()
+{
+ script="$1"
+ source="$2"
+
+ new="$source.new"
+ $script "$source" > "$new" &&
+ updateIfChanged "$source" "$new" "by $script"
+}
+
+# updates the given source file using the given script(s)
+applyPluginsTo ()
+{
+ source="$1"
+ shift
+
+ for script in `git ls-files "$@"`; do
+ run_ applyPlugin $script $source || return
+ done
+}
+
+# succeeds if all MakeNamedErrorDetail() names are unique
+checkMakeNamedErrorDetails ()
+{
+ problems=1 # assume there are problems until proven otherwise
+
+ options='-h --only-matching --extended-regexp'
+ git grep $options 'MakeNamedErrorDetail[(]".*?"[)]' src |
+ sort |
+ uniq --count > \
+ MakeNamedErrorDetail.tmp
+
+ if grep --quiet --word-regexp 1 MakeNamedErrorDetail.tmp; then
+ if grep --invert-match --word-regexp 1 MakeNamedErrorDetail.tmp; then
+ echo "ERROR: Duplicated MakeNamedErrorDetail names (see above)."
+ else
+ problems=0
+ fi
+ else
+ echo "ERROR: Cannot find or process MakeNamedErrorDetail calls."
+ fi
+
+ rm MakeNamedErrorDetail.tmp # ignore (unexpected) cleanup failures
+ return $problems
+}
+
+srcFormat ()
+{
+#
+# Scan for incorrect use of #ifdef/#ifndef
+#
+git grep "ifn?def .*_SQUID_" |
+ grep -v -E "_H$" |
+ grep -v "scripts/source-maintenance.sh" |
+ while read f; do echo "PROBLEM?: ${f}"; done
+
+#
+# Scan for file-specific actions
+#
+for FILENAME in `git ls-files`; do
+ skip_copyright_check=""
+
+ # skip subdirectories, git ls-files is recursive
+ test -d $FILENAME && continue
case ${FILENAME} in
#
# Code Style formatting maintenance
#
- if test "${ASVER}" = "1.23"; then
- ${ROOT}/scripts/formater.pl ${FILENAME}
+ applyPluginsTo ${FILENAME} scripts/maintenance/ || return
+ if test "${ASVER}"; then
+ ./scripts/formater.pl ${FILENAME}
if test -e $FILENAME -a -e "$FILENAME.astylebak"; then
md51=`cat $FILENAME| tr -d "\n \t\r" | $MD5`;
md52=`cat $FILENAME.astylebak| tr -d "\n \t\r" | $MD5`;
- if test "$md51" != "$md52" ; then
- echo "ERROR: File $PWD/$FILENAME not formating well";
+ if test "$md51" != "$md52"; then
+ echo "ERROR: File $FILENAME not formatting well";
mv $FILENAME $FILENAME.astylebad
mv $FILENAME.astylebak $FILENAME
+ git checkout -- ${FILENAME}
else
rm -f $FILENAME.astylebak
fi
fi
#
- # REQUIRE config.h/squid.h as first #include
+ # REQUIRE squid.h first #include
#
case ${FILENAME} in
+ src/cf_gen.cc)
+ # ignore, this is a build tool.
+ ;;
*.c|*.cc)
FI=`grep "#include" ${FILENAME} | head -1`;
- if test "${FI}" != "#include \"config.h\"" -a "${FI}" != "#include \"squid.h\"" ; then
- echo "ERROR: ${PWD}/${FILENAME} does not include config.h or squid.h first!"
+ if test "${FI}" != "#include \"squid.h\"" -a "${FILENAME}" != "cf_gen.cc"; then
+ echo "ERROR: ${FILENAME} does not include squid.h first!"
fi
;;
*.h|*.cci)
- FI=`grep "#include \"config.h\"" ${FILENAME}`;
+ FI=`grep "#include \"squid.h\"" ${FILENAME}`;
if test "x${FI}" != "x" ; then
- echo "ERROR: ${PWD}/${FILENAME} duplicate include of config.h"
+ echo "ERROR: ${FILENAME} duplicate include of squid.h"
fi
;;
esac
+ #
+ # If a file includes openssl headers, then it must include compat/openssl.h
+ #
+ if test "${FILENAME}" != "compat/openssl.h"; then
+ FA=`grep "#include.*openssl/" "${FILENAME}" 2>/dev/null | head -1`;
+ FB=`grep '#include.*compat/openssl[.]h' "${FILENAME}" 2>/dev/null | head -1`;
+ if test "x${FA}" != "x" -a "x${FB}" = "x"; then
+ echo "ERROR: ${FILENAME} includes openssl headers without including \"compat/openssl.h\""
+ fi
+ fi
+
+ #
+ # forward.h means different things to Squid code depending on the path
+ # require the full path is explicit for every include
+ #
+ FI=`grep "#include \"forward.h\"" ${FILENAME}`;
+ if test "x${FI}" != "x" ; then
+ echo "ERROR: ${FILENAME} contains reference to forward.h without path"
+ fi
+
+ #
+ # detect functions unsafe for use within Squid.
+ # strdup() - only allowed in compat/xstring.h which defines a safe replacement.
+ # sprintf() - not allowed anywhere.
+ #
+ STRDUP=`grep -e "[^x]strdup(" ${FILENAME}`;
+ if test "x${STRDUP}" != "x" -a "${FILENAME}" != "compat/xstring.h"; then
+ echo "ERROR: ${FILENAME} contains unprotected use of strdup()"
+ fi
+ SPRINTF=`grep -e "[^v]sprintf(" ${FILENAME}`;
+ if test "x${SPRINTF}" != "x" ; then
+ echo "ERROR: ${FILENAME} contains unsafe use of sprintf()"
+ fi
+
#
# DEBUG Section list maintenance
#
- grep " DEBUG: section" <${FILENAME} | sed -e 's/ \* DEBUG: //' >>${ROOT}/doc/debug-sections.tmp
+ grep " DEBUG: section" <${FILENAME} | sed -e 's/ \* DEBUG: //' -e 's%/\* DEBUG: %%' -e 's% \*/%%' | sort -u >>doc/debug-sections.tmp
#
# File permissions maintenance.
chmod 755 ${FILENAME}
;;
- Makefile.am)
-
- perl -i -p -e 's/@([A-Z0-9_]+)@/\$($1)/g' <${FILENAME} >${FILENAME}.styled
- mv ${FILENAME}.styled ${FILENAME}
+ *.am)
+ applyPluginsTo ${FILENAME} scripts/format-makefile-am.pl || return
;;
+ ChangeLog|CREDITS|CONTRIBUTORS|COPYING|*.png|*.po|*.pot|rfcs/|*.txt|test-suite/squidconf/empty|.bzrignore)
+ # we do not enforce copyright blurbs in:
+ #
+ # Squid Project contributor attribution file
+ # third-party copyright attribution file
+ # images,
+ # translation PO/POT
+ # license documentation files
+ # (imported) plain-text documentation files and ChangeLogs
+ # VCS internal files
+ #
+ skip_copyright_check=1
+ ;;
esac
- if test "$FILENAME" = "libltdl" ; then
- :
- elif test -d $FILENAME ; then
- cd $FILENAME
- srcformat ${ROOT} || exit 1
- cd ..
+ # check for Foundation copyright blurb
+ if test $CheckAndUpdateCopyright = yes -a -f ${FILENAME} -a "x$skip_copyright_check" = "x"; then
+ BLURB=`grep -o "${COPYRIGHT_YEARS} The Squid Software Foundation and contributors" ${FILENAME}`;
+ if test "x${BLURB}" = "x"; then
+ BOILER=`grep -o -E "1996-2[0-9]+ The Squid Software Foundation and contributors" ${FILENAME}`;
+ if test "x${BOILER}" != "x"; then
+ echo "UPDATE COPYRIGHT for ${FILENAME}"
+ sed --in-place -r -f boilerplate_fix.sed ${FILENAME}
+ else
+ echo "CHECK COPYRIGHT for ${FILENAME}"
+ fi
+ fi
fi
done
}
# Build XPROF types file from current sources
-echo "#ifndef _PROFILER_XPROF_TYPE_H_" >${ROOT}/lib/profiler/list
-echo "#define _PROFILER_XPROF_TYPE_H_" >>${ROOT}/lib/profiler/list
-echo "/* AUTO-GENERATED FILE */" >>${ROOT}/lib/profiler/list
-echo "#if USE_XPROF_STATS" >>${ROOT}/lib/profiler/list
-echo "typedef enum {" >>${ROOT}/lib/profiler/list
-echo "XPROF_PROF_UNACCOUNTED," >>${ROOT}/lib/profiler/list
-grep -R -h "PROF_start.*" ./* | grep -v probename | sed -e 's/ //g; s/PROF_start(/XPROF_/; s/);/,/' | sort -u >>${ROOT}/lib/profiler/list
-echo " XPROF_LAST } xprof_type;" >>${ROOT}/lib/profiler/list
-echo "#endif" >>${ROOT}/lib/profiler/list
-echo "#endif" >>${ROOT}/lib/profiler/list
-mv ${ROOT}/lib/profiler/list ${ROOT}/lib/profiler/xprof_type.h
-
-# Run formating
-echo "" >${ROOT}/doc/debug-sections.tmp
-srcformat || exit 1
-sort -u <${ROOT}/doc/debug-sections.tmp | sort -n >${ROOT}/doc/debug-sections.txt
-rm ${ROOT}/doc/debug-sections.tmp
+(
+cat scripts/boilerplate.h
+echo "#ifndef _PROFILER_XPROF_TYPE_H_"
+echo "#define _PROFILER_XPROF_TYPE_H_"
+echo "/* AUTO-GENERATED FILE */"
+echo "#if USE_XPROF_STATS"
+echo "typedef enum {"
+echo " XPROF_PROF_UNACCOUNTED,"
+grep -R -h "PROF_start.*" ./* | grep -v probename | sed -e 's/ //g; s/PROF_start(/ XPROF_/; s/);/,/;' | sort -u
+echo " XPROF_LAST"
+echo "} xprof_type;"
+echo "#endif"
+echo "#endif"
+echo ""
+) >lib/profiler/list
+mv lib/profiler/list lib/profiler/xprof_type.h
+
+printAmFile ()
+{
+ sed -e 's%\ \*%##%; s%/\*%##%; s%##/%##%' < scripts/boilerplate.h
+ echo -n "$1 ="
+ git ls-files $2$3 | sed -e s%$2%%g | sort -u | while read f; do
+ echo " \\"
+ echo -n " ${f}"
+ done
+ echo ""
+}
+
+# Build icons install include from current icons available
+printAmFile ICONS "icons/" "silk/*" > icons/icon.am
+
+# Build templates install include from current templates available
+printAmFile ERROR_TEMPLATES "errors/" "templates/ERR_*" > errors/template.am
+
+# Build errors translation install include from current .PO available
+printAmFile TRANSLATE_LANGUAGES "errors/" "*.po" | sed 's%\.po%\.lang%g' > errors/language.am
+
+# Build manuals translation install include from current .PO available
+printAmFile TRANSLATE_LANGUAGES "doc/manuals/" "*.po" | sed 's%\.po%\.lang%g' > doc/manuals/language.am
+
+# Build STUB framework include from current stub_* available
+printAmFile STUB_SOURCE "src/" "tests/stub_*.cc" > src/tests/Stub.am
+
+# Build the GPERF generated content
+make -C src/http gperf-files
+
+run_ checkMakeNamedErrorDetails || exit 1
+
+# Run formatting
+echo "" >doc/debug-sections.tmp
+srcFormat || exit 1
+sort -u <doc/debug-sections.tmp | sort -n >doc/debug-sections.tmp2
+cat scripts/boilerplate.h doc/debug-sections.tmp2 >doc/debug-sections.txt
+rm doc/debug-sections.tmp doc/debug-sections.tmp2
+rm -f boilerplate_fix.sed
+
+exit $SeenErrors
projects / thirdparty / squid.git / blobdiff