build-aux/git-hooks/commit-msg

   1 #!/bin/sh
   2 # Check the format of GNU Emacs change log entries.
   3
   4 # Copyright 2014-2019 Free Software Foundation, Inc.
   5
   6 # This file is part of GNU Emacs.
   7
   8 # GNU Emacs is free software: you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation, either version 3 of the License, or
  11 # (at your option) any later version.
  12
  13 # GNU Emacs is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17
  18 # You should have received a copy of the GNU General Public License
  19 # along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
  20
  21 # Written by Paul Eggert.
  22
  23 # Prefer gawk if available, as it handles NUL bytes properly.
  24 if type gawk >/dev/null 2>&1; then
  25   awk=gawk
  26 else
  27   awk=awk
  28 fi
  29
  30 # Use a UTF-8 locale if available, so that the UTF-8 check works.
  31 # Use U+00A2 CENT SIGN to test whether the locale works.
  32 cent_sign_utf8_format='\302\242\n'
  33 cent_sign=`printf "$cent_sign_utf8_format"`
  34 print_at_sign='BEGIN {print substr("'$cent_sign'@", 2)}'
  35 at_sign=`$awk "$print_at_sign" </dev/null 2>/dev/null`
  36 if test "$at_sign" != @; then
  37   at_sign=`LC_ALL=en_US.UTF-8 $awk "$print_at_sign" </dev/null 2>/dev/null`
  38   if test "$at_sign" = @; then
  39     LC_ALL=en_US.UTF-8
  40   else
  41     LC_ALL=C
  42   fi
  43   export LC_ALL
  44 fi
  45
  46 # Check the log entry.
  47 exec $awk -v at_sign="$at_sign" -v cent_sign="$cent_sign" -v file="$1" '
  48   BEGIN {
  49     # These regular expressions assume traditional Unix unibyte behavior.
  50     # They are needed for old or broken versions of awk, e.g.,
  51     # mawk 1.3.3 (1996), or gawk on MSYS (2015), and/or for systems that
  52     # cannot use UTF-8 as the codeset for the locale.
  53     space = "[ \f\n\r\t\v]"
  54     non_space = "[^ \f\n\r\t\v]"
  55     # The non_print below rejects control characters and surrogates
  56     # UTF-8 for: 0x01-0x1f 0x7f   0x80-0x9f  0xd800-0xdbff  0xdc00-0xdfff
  57     non_print = "[\1-\37\177]|\302[\200-\237]|\355[\240-\277][\200-\277]"
  58
  59     # Prefer POSIX regular expressions if available, as they do a
  60     # better job of checking.  Similarly, prefer POSIX negated
  61     # expressions if UTF-8 also works.
  62     if (" " ~ /[[:space:]]/) {
  63       space = "[[:space:]]"
  64       if (at_sign == "@" && cent_sign ~ /^[[:print:]]$/) {
  65         non_space = "[^[:space:]]"
  66         non_print = "[^[:print:]]"
  67       }
  68     }
  69     c_lower = "abcdefghijklmnopqrstuvwxyz"
  70     unsafe_gnu_url = "(http|ftp)://([" c_lower ".]*\\.)?(gnu|fsf)\\.org"
  71   }
  72
  73   { input[NR] = $0 }
  74
  75   /^#/ {
  76     # Ignore every line after a scissors line.
  77     if (/^# *---* *(>[8%]|[8%]<) *---* *$/) { exit }
  78
  79     # Ignore comment lines.
  80     next
  81   }
  82
  83   !/^.*$/ {
  84     print "Invalid character (not UTF-8) in commit message"
  85     status = 1
  86   }
  87
  88   nlines == 0 && $0 !~ non_space { next }
  89
  90   { nlines++ }
  91
  92   nlines == 1 {
  93     # Ignore special markers used by "git rebase --autosquash".
  94     if (! sub(/^fixup! /, ""))
  95       sub(/^squash! /, "")
  96
  97     if ($0 ~ "^" space) {
  98       print "White space at start of commit message'\''s first line"
  99       status = 1
 100     }
 101   }
 102
 103   nlines == 2 && $0 ~ non_space {
 104     print "Nonempty second line in commit message"
 105     status = 1
 106   }
 107
 108   {
 109     # Expand tabs to spaces for length calculations etc.
 110     while (match($0, /\t/)) {
 111       before_tab = substr($0, 1, RSTART - 1)
 112       after_tab = substr($0, RSTART + 1)
 113       $0 = sprintf("%s%*s%s", before_tab, 8 - (RSTART - 1) % 8, "", after_tab)
 114     }
 115   }
 116
 117   78 < length && $0 ~ space {
 118     print "Line longer than 78 characters in commit message"
 119     status = 1
 120   }
 121
 122   140 < length {
 123     print "Word longer than 140 characters in commit message"
 124     status = 1
 125   }
 126
 127   /^Signed-off-by: / {
 128     print "'\''Signed-off-by:'\'' in commit message"
 129     status = 1
 130   }
 131
 132   $0 ~ unsafe_gnu_url {
 133     needs_rewriting = 1
 134   }
 135
 136   $0 ~ non_print {
 137     print "Unprintable character in commit message"
 138     status = 1
 139   }
 140
 141   END {
 142     if (nlines == 0) {
 143       print "Empty commit message"
 144       status = 1
 145     }
 146     if (status == 0 && needs_rewriting) {
 147       for (i = 1; i <= NR; i++) {
 148         line = input[i]
 149         while (match(line, unsafe_gnu_url)) {
 150           prefix = substr(line, 1, RSTART - 1)
 151           suffix = substr(line, RSTART)
 152           line = prefix "https:" substr(suffix, 5 + (suffix ~ /^http:/))
 153         }
 154         print line >file
 155       }
 156       if (close(file) != 0) {
 157         print "Cannot rewrite: " file
 158         status = 1
 159       }
 160     }
 161     if (status != 0) {
 162       print "Commit aborted; please see the file 'CONTRIBUTE'"
 163     }
 164     exit status
 165   }
 166 ' <"$1"