GODT-1560: Dependecy licenses update and link.

2025-12-10 04:36:43 +00:00 · 2022-05-16 16:42:21 +02:00
parent 5033e9718c
commit d6d7ea592e
10 changed files with 203 additions and 58 deletions
--- a/utils/dependency_license.sh
+++ b/utils/dependency_license.sh
@ -0,0 +1,103 @@
+#!/bin/bash
+
+# Copyright (c) 2022 Proton Technologies AG
+#
+# This file is part of ProtonMail Bridge.
+#
+# ProtonMail Bridge is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ProtonMail Bridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with ProtonMail Bridge.  If not, see <https://www.gnu.org/licenses/>.
+
+set -eo pipefail
+
+src=go.mod
+tgt=COPYING_NOTES.md
+
+STARTAUTOGEN="<!-- START AUTOGEN -->"
+ENDAUTOGEN="<!-- END AUTOGEN -->"
+RE_STARTAUTOGEN="^${STARTAUTOGEN}$"
+RE_ENDAUTOGEN="^${ENDAUTOGEN}$"
+tmpDepLicenses=""
+
+error(){
+    echo "Error: $*"
+    exit 1
+}
+
+generate_dep_licenses(){
+    [ -r $src ] || error "Cannot read file '$src'"
+
+
+    tmpDepLicenses="$(mktemp)"
+
+    # Collect all go.mod lines beginig with tab:
+    # * which no replace
+    # * which have replace
+    grep -E $'^\t[^=>]*$'    $src  | sed -r 's/\t([^ ]*) v.*/\1/g'         > "$tmpDepLicenses"
+    grep -E $'^\t.*=>.*v.*$' $src  | sed -r 's/^.*=> ([^ ]*)( v.*)?/\1/g' >> "$tmpDepLicenses"
+
+    # Replace each line with formated link
+    sed  -i -r '/^github.com\/therecipe\/qt\/internal\/binding\/files\/docs\//d;' "$tmpDepLicenses"
+    sed -i -r 's|^(.*)/([[:alnum:]-]+)/(v[[:digit:]]+)$|* [\2](https://\1/\2/\3)|g' "$tmpDepLicenses"
+    sed -i -r 's|^(.*)/([[:alnum:]-]+)$|* [\2](https://\1/\2)|g' "$tmpDepLicenses"
+
+    ## add license file to github links, and others
+    sed -i -r '/github.com/s|^(.*(https://[^)]+).*)$|\1 available under [license](\2/blob/master/LICENSE) |g' "$tmpDepLicenses"
+    sed -i -r '/go.etcd.io\/bbolt/s|^(.*)$|\1 available under [license](https://github.com/etcd-io/bbolt/blob/master/LICENSE) |g' "$tmpDepLicenses"
+    sed -i -r '/howett.net\/plist/s|^(.*)$|\1 available under [license](https://github.com/DHowett/go-plist/blob/main/LICENSE) |g' "$tmpDepLicenses"
+    sed -i -r '/golang.org\/x/s|^(.*golang.org/x/([^)]+).*)$|\1 available under [license](https://cs.opensource.google/go/x/\2/+/master:LICENSE) |g' "$tmpDepLicenses"
+}
+
+check_dependecies(){
+    generate_dep_licenses
+
+    tmpHaveLicenses=$(mktemp)
+    sed "/${RE_STARTAUTOGEN}/,/${RE_ENDAUTOGEN}/!d;//d" $tgt > "$tmpHaveLicenses"
+
+    #echo "have"
+    #cat "$tmpHaveLicenses"
+
+    #echo "want"
+    #cat "$tmpDepLicenses"
+
+    diffOK=0
+    if ! diff "$tmpHaveLicenses" "$tmpDepLicenses"; then diffOK=1; fi
+
+    rm "$tmpDepLicenses" || echo "Failed to clean tmp file"
+    rm "$tmpHaveLicenses" || echo "Failed to clean tmp file"
+
+    [ $diffOK -eq 0 ] || error "Dependency licenses are not up-to-date"
+    exit 0
+}
+
+update_dependecies(){
+    generate_dep_licenses
+
+    sed -i -e "/${RE_STARTAUTOGEN}/,/${RE_ENDAUTOGEN}/!b" \
+        -e "/${RE_ENDAUTOGEN}/i ${STARTAUTOGEN}" \
+        -e "/${RE_ENDAUTOGEN}/r $tmpDepLicenses" \
+        -e "/${RE_ENDAUTOGEN}/a ${ENDAUTOGEN}" \
+        -e "d" \
+        $tgt
+
+
+    rm "$tmpDepLicenses" || echo "Failed to clean tmp file"
+
+    exit 0
+}
+
+case $1 in
+    "check") check_dependecies;;
+    "update") update_dependecies;;
+    *) error "One of actions needed: check update" ;;
+esac
+