From 1765a1013ddba73ff92dcee4008b576b7e3eff28 Mon Sep 17 00:00:00 2001 From: MilhouseVH Date: Sat, 29 Dec 2018 23:51:01 +0000 Subject: [PATCH] tools/pkgcheck: new script --- tools/pkgcheck | 158 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 158 insertions(+) create mode 100755 tools/pkgcheck diff --git a/tools/pkgcheck b/tools/pkgcheck new file mode 100755 index 0000000000..53e4b661ad --- /dev/null +++ b/tools/pkgcheck @@ -0,0 +1,158 @@ +#!/bin/bash + +# SPDX-License-Identifier: GPL-2.0-or-later +# Copyright (C) 2018-present Team LibreELEC (https://libreelec.tv) + +TXRED="$(tput setaf 1 bold)" +TXGREEN="$(tput setaf 2 bold)" +TXYELLOW="$(tput setaf 3 bold)" +TXBLUE="$(tput setaf 4 bold)" +TXMAGENTA="$(tput setaf 5 bold)" +TXCYAN="$(tput setaf 6 bold)" +TXRESET="$(tput sgr0)" +TXCLR="$(tput el)" + +log() { + local filename="$1" lc=$2 level="$3" msg="$4" data="$5" + local txcolour flc colw + + [ "${level}" = "FAIL" ] && txcolour="${TXRED}" || txcolour="${TXYELLOW}" + [[ ${filename} =~ ^\./ ]] && filename="${filename:2}" + [ ${lc} -eq 0 ] && flc="---" || flc="$(printf "%03d" ${lc})" + [[ ${filename} =~ packages/addons/addon-depends ]] && colw=80 || colw=50 + + printf "[%s]: %3s: %-*s: %-25s: %s\n" "${txcolour}${level}${TXRESET}" "${flc}" ${colw} "${filename}" "${msg}" "${data}" +} + +process_line() { + local filename="$1" lc="$2" line="$3" inassign="$4" infunc="$5" + local var matches assignallowed=Y + + [ "${infunc}" = "Y" ] && return 0 + + rightside="${line#*=}" + + for var in PKG_SHORTDESC PKG_LONGDESC PKG_IS_ADDON PKG_NEED_UNPACK PKG_SOURCE_NAME PKG_ADDON_IS_STANDALONE \ + PKG_CONFIGURE_SCRIPT PKG_CMAKE_SCRIPT PKG_MESON_SCRIPT \ + PKG_DIR PKG_ADDON_ID PKG_BUILD \ + DESTIMAGE CC CXX CPP LD AS AR NM \ + RANLIB OBJCOPY OBJDUMP STRIP \ + CPPFLAGS CFLAGS CXXFLAGS LDFLAGS \ + PKG_CONFIG PKG_CONFIG_PATH PKG_CONFIG_LIBDIR PKG_CONFIG_SYSROOT_DIR PKG_CONFIG_ALLOW_SYSTEM_CFLAGS PKG_CONFIG_ALLOW_SYSTEM_LIBS \ + CMAKE_CONF CMAKE \ + HOST_CC HOST_CXX HOSTCC HOSTCXX \ + CC_FOR_BUILD CXX_FOR_BUILD BUILD_CC BUILD_CXX \ + _python_sysroot _python_prefix _python_exec_prefix \ + TARGET_CONFIGURE_OPTS CMAKE_GENERATOR_NINJA TARGET_CMAKE_OPTS TARGET_MESON_OPTS \ + HOST_CONFIGURE_OPTS HOST_CMAKE_OPTS HOST_MESON_OPTS \ + INIT_CONFIGURE_OPTS INIT_CMAKE_OPTS INIT_MESON_OPTS \ + BOOTSTRAP_CONFIGURE_OPTS BOOTSTRAP_CMAKE_OPTS BOOTSTRAP_MESON_OPTS \ + ; do + + # After PKG_DIR, treat assigns to var as invalid + [ "${var}" = "PKG_DIR" ] && assignallowed=N + + if [ "${assignallowed}" = "N" ]; then + if [[ ${line} =~ (^|[[:space:]])${var}= ]]; then + [ "${inassign}" = "N" ] && matches+=", assign to ${var}" + fi + fi + + if [[ ${line} =~ \$\{${var}} ]] || [[ ${line} =~ \$${var}[^A-Za-z0-9_] ]]; then + matches+=", ref ${var}" + fi + + if [[ ${line} =~ (^|[[:space:]])unset\ ${var}($|[[:space:]]) ]]; then + matches+=", unset ${var}" + fi + done + + [ -n "${matches}" ] && log "${filename}" ${lc} "FAIL" "late binding violation" "${matches:2}" +} + +init_multi_func() { + local f t multi + + for t in target host init bootstrap; do + for f in pre_build \ + pre_configure configure post_configure \ + pre_make make post_make \ + pre_makeinstall makeinstall post_makeinstall \ + ; do + multi+=" ${f}_${t}" + done + done + echo "${multi:1}" +} + +check_func_name() { + local filename="$1" lc="$2" line="$3" + local f + + for f in configure_package \ + pre_unpack unpack post_unpack \ + pre_patch post_patch \ + ${MULTI_FUNC} \ + pre_install post_install \ + addon \ + ; do + [[ ${line} =~ ^${f} ]] && return 0 + done + + log "${filename}" ${lc} "WARN" "unknown function" "${line// *{*/}" +} + +process_pkg() { + local filename="$1" + local lc=0 isassign=N isfunc=N fc=0 intertwined=N + + while IFS= read -r line; do + lc=$((lc + 1)) + [[ ${line} =~ ^[[:space:]]*$ ]] && continue + [[ ${line} =~ ^(|[[:space:]]*)# ]] && continue + + if [[ "${line}" =~ ^[^#]*\(\)[[:space:]]*$ ]]; then + log "${filename}" ${lc} "FAIL" "bad func - missing brace" "${line}" + fi + + if [[ "${line}" =~ \(\)[[:space:]]*\{ ]]; then + isfunc=Y + fc=$((fc+1)) + check_func_name "${filename}" "${lc}" "${line}" + fi + + if [ "${intertwined}" = "N" -a "${isfunc}" = "N" -a ${fc} -ge 1 ]; then + log "${filename}" ${lc} "WARN" "intertwined vars & funcs" "${line}" + intertwined=Y + fi + + [[ "${line}" =~ ^[[:space:]]*PKG_.*=\" ]] && isassign=Y + + process_line "$1" "${lc}" "${line}" "${isassign}" "${isfunc}" + + [[ "${line}" =~ (\"$|\"[[:space:]]*$|\"[[:space:]]*#.*$) ]] && isassign=N + [[ "${line}" =~ (^}|^[[:space:]]*}) ]] && isfunc=N + done < "${filename}" + + # Duplicate function check + while read -r count line; do + [ -n "${line}" ] && log "${filename}" 0 "FAIL" "duplicate function def" "${line}" + done <<< "$(grep -E ".*() {" "${filename}" | sed 's/[[:space:]]*{.*//' | sort | uniq -c | grep -v ^[[:space:]]*1[[:space:]])" +} + +MULTI_FUNC="$(init_multi_func)" + +if [ $# -ne 0 ]; then + for arg in ${@}; do + for p in $(find packages projects -type f -path */${arg}/package.mk | sort); do + echo -en "${TXCLR}${p}...\r" >&2 + process_pkg "${p}" + done + done +else + for p in $(find packages projects -type f -name package.mk | sort); do + echo -en "${TXCLR}${p}...\r" >&2 + process_pkg "${p}" + done +fi +echo -en "${TXCLR}" >&2