Enhance util/openssl-update-copyright shell script
authorDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Tue, 9 Jan 2018 15:09:14 +0000 (16:09 +0100)
committerRichard Levitte <levitte@openssl.org>
Wed, 10 Jan 2018 17:23:28 +0000 (18:23 +0100)
- Avoid creating repeated year ranges <current_year>-<current_year> for
  documents which were added in the current year.

- Use extended regular expressions for better readability (less quoting)

- Use a shebang line which is more portable

Reviewed-by: Rich Salz <rsalz@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/5044)

util/openssl-update-copyright

index 98d1365..c432f84 100755 (executable)
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 #
 # Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
 #
@@ -12,12 +12,17 @@ myname="$(basename $0)"
 
 this_year="$(date '+%Y')"
 some_year="[12][0-9][0-9][0-9]"
+year_range="(${some_year})(-${some_year})?"
 
 copyright_owner="The OpenSSL Project"
+copyright="Copyright .*${year_range} .*${copyright_owner}"
 
-search="Copyright \(([cC]) \)\?\(${some_year}\)\(-${some_year}\)\? ${copyright_owner}"
-replace="Copyright \1\2-${this_year} ${copyright_owner}"
-
+# sed_script:
+#   for all lines that contain ${copyright} : {
+#     replace years yyyy-zzzz (or year yyyy) by yyyy-${this_year}
+#     replace repeated years yyyy-yyyy by yyyy
+#   }
+sed_script="/${copyright}/{ s/${year_range}/\1-${this_year}/ ; s/(${some_year})-\1/\1/ }"
 
 function usage() {
        cat >&2 <<EOF
@@ -47,9 +52,9 @@ for arg in "$@"; do
                        ;;
                *)
                        if [ -f "$arg" ]; then
-                               sed -i "s/${search}/${replace}/g" "$arg"
+                               sed -E -i "${sed_script}" "$arg"
                        elif [ -d "$arg" ]; then
-                               find "$arg" -name '.[a-z]*' -prune -o -type f -exec sed -i "s/${search}/${replace}/g" {} +
+                               find "$arg" -name '.[a-z]*' -prune -o -type f -exec sed -E -i "${sed_script}" {} +
                        else
                                echo "$arg: no such file or directory" >&2
                        fi