Patrick Georgi | e882630 | 2010-11-19 10:16:43 +0000 | [diff] [blame] | 1 | #!/bin/sh |
| 2 | # This file is part of the coreboot project. |
| 3 | # |
| 4 | # Copyright (C) 2010 coresystems GmbH |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 5 | # Copyright (C) 2016 Google Inc. |
Patrick Georgi | e882630 | 2010-11-19 10:16:43 +0000 | [diff] [blame] | 6 | # |
| 7 | # This program is free software; you can redistribute it and/or modify |
| 8 | # it under the terms of the GNU General Public License as published by |
| 9 | # the Free Software Foundation; version 2 of the License. |
| 10 | # |
| 11 | # This program is distributed in the hope that it will be useful, |
| 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | # GNU General Public License for more details. |
| 15 | # |
Patrick Georgi | e882630 | 2010-11-19 10:16:43 +0000 | [diff] [blame] | 16 | # |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 17 | # DESCR: Check that files in have valid license headers |
| 18 | # $1 is an optional command line parameter containing directories to check |
| 19 | |
| 20 | # regex list of files and directories to exclude from the search |
| 21 | HEADER_EXCLUDED="\ |
Martin Roth | bdad9a8 | 2018-05-26 19:47:07 -0600 | [diff] [blame] | 22 | ^src/lib/gnat/|\ |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 23 | ^src/vendorcode/|\ |
Martin Roth | bdad9a8 | 2018-05-26 19:47:07 -0600 | [diff] [blame] | 24 | ^util/amdtools/example_input/|\ |
| 25 | ^util/cbfstool/lzma/|\ |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 26 | ^util/kconfig/|\ |
| 27 | ^util/romcc/tests|\ |
| 28 | ^util/romcc/results|\ |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 29 | Kconfig|\ |
| 30 | \<COPYING\>|\ |
| 31 | \<LICENSE\>|\ |
| 32 | \<README\>|\ |
| 33 | Changelog|\ |
| 34 | TODO|\ |
| 35 | EXAMPLE|\ |
Martin Roth | bdad9a8 | 2018-05-26 19:47:07 -0600 | [diff] [blame] | 36 | NEWS|\ |
| 37 | ChangeLog|\ |
| 38 | Dockerfile|\ |
| 39 | \.in$|\ |
| 40 | \.[18]$|\ |
| 41 | \.md$|\ |
| 42 | \.wiki$|\ |
| 43 | \.xxdump$|\ |
| 44 | \.spec$|\ |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 45 | \.txt$|\ |
| 46 | \.jpg$|\ |
| 47 | \.cksum$|\ |
| 48 | \.bin$|\ |
Martin Roth | dea1333 | 2018-05-04 09:19:07 -0600 | [diff] [blame] | 49 | \.vbt$|\ |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 50 | \.hex$|\ |
| 51 | \.patch$|\ |
| 52 | _shipped$|\ |
| 53 | /microcode-[^/]*.h$|\ |
| 54 | /sdram-.*\.inc$|\ |
Martin Roth | 84129b8 | 2016-04-11 13:35:59 -0600 | [diff] [blame] | 55 | Makefile\.inc|\ |
| 56 | \.fmd|\ |
Naresh G Solanki | 358b2b3 | 2016-10-27 23:13:37 +0530 | [diff] [blame] | 57 | \.cb|\ |
Martin Roth | 84129b8 | 2016-04-11 13:35:59 -0600 | [diff] [blame] | 58 | \.cfg$|\ |
| 59 | \.spd|\ |
| 60 | config|\ |
| 61 | cmos\.layout|\ |
| 62 | cmos\.default\ |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 63 | " |
| 64 | |
| 65 | #space separated list of directories to test |
| 66 | if [ "$1" = "" ]; then |
| 67 | HEADER_DIRS="src util" |
| 68 | else |
| 69 | HEADER_DIRS="$1" |
| 70 | fi |
Patrick Georgi | e882630 | 2010-11-19 10:16:43 +0000 | [diff] [blame] | 71 | |
| 72 | LC_ALL=C export LC_ALL |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 73 | |
| 74 | #get initial list from git, removing HEADER_EXCLUDED files. |
| 75 | #make a copy to check for the old style header later. |
| 76 | headerlist=$(git ls-files $HEADER_DIRS | egrep -v "($HEADER_EXCLUDED)") |
| 77 | |
| 78 | #update headerlist by removing files that match the license string |
| 79 | check_for_license() { |
Martin Roth | 84129b8 | 2016-04-11 13:35:59 -0600 | [diff] [blame] | 80 | if [ -n "$headerlist" ] && [ -z "$2" ]; then |
Martin Roth | f8db028 | 2016-01-21 13:20:39 -0700 | [diff] [blame] | 81 | headerlist="$(grep -iL "$1" $headerlist 2>/dev/null)" |
Martin Roth | 84129b8 | 2016-04-11 13:35:59 -0600 | [diff] [blame] | 82 | elif [ -n "$headerlist" ]; then |
| 83 | p1list="$(grep -il "$1" $headerlist 2>/dev/null)" |
| 84 | p2list="$(grep -il "$2" $headerlist 2>/dev/null)" |
Martin Roth | f8db028 | 2016-01-21 13:20:39 -0700 | [diff] [blame] | 85 | |
| 86 | # Make list of files that were in both previous lists |
Martin Roth | 84129b8 | 2016-04-11 13:35:59 -0600 | [diff] [blame] | 87 | pbothlist="$(echo $p1list $p2list | tr ' ' "\n" | \ |
Martin Roth | f8db028 | 2016-01-21 13:20:39 -0700 | [diff] [blame] | 88 | sort | uniq -d)" |
| 89 | |
| 90 | # Remove all files that were in both of the previous lists |
| 91 | # Note that this is unstable if we ever get any filenames |
| 92 | # with spaces. |
| 93 | headerlist="$(echo $headerlist $pbothlist | tr ' ' "\n" | \ |
| 94 | sort | uniq -u)" |
| 95 | fi |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 96 | } |
| 97 | |
| 98 | #search the files for license headers |
Martin Roth | f8db028 | 2016-01-21 13:20:39 -0700 | [diff] [blame] | 99 | check_for_license "under the terms of the GNU General Public License" \ |
| 100 | "WITHOUT ANY WARRANTY" |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 101 | check_for_license 'IS PROVIDED .*"AS IS"' |
Martin Roth | 84129b8 | 2016-04-11 13:35:59 -0600 | [diff] [blame] | 102 | check_for_license 'IS DISTRIBUTED .*"AS IS"' |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 103 | check_for_license "IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE" |
| 104 | check_for_license '"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES' |
Martin Roth | ed0ee0a | 2017-04-04 14:35:42 -0600 | [diff] [blame] | 105 | check_for_license 'assumes any liability or responsibility for the use' |
| 106 | check_for_license 'THE AUTHORS DISCLAIM.*ALL WARRANTIES WITH REGARD TO THIS SOFTWARE' |
Martin Roth | 84129b8 | 2016-04-11 13:35:59 -0600 | [diff] [blame] | 107 | check_for_license 'No license required' |
Martin Roth | bdad9a8 | 2018-05-26 19:47:07 -0600 | [diff] [blame] | 108 | check_for_license 'GNU Lesser General Public' |
Ronald G. Minnich | 688eec1 | 2018-09-14 01:09:46 -0700 | [diff] [blame] | 109 | check_for_license 'SPDX-License-Identifier:.*GPL-2.0-or-later' |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 110 | |
| 111 | for file in $headerlist; do |
Martin Roth | 03e9d6a | 2017-02-09 16:44:24 -0800 | [diff] [blame] | 112 | # Verify the file exists, and has content that requires a header |
| 113 | # This assumes that a file that has 4 lines or fewer is not notable |
| 114 | # enough to require a license. |
| 115 | if [ -f "$file" ] && [ "$(wc -l < "$file")" -gt 4 ]; then |
Martin Roth | c4511e2 | 2016-01-12 10:25:49 -0700 | [diff] [blame] | 116 | echo "$file has no recognized license header." |
| 117 | fi |
| 118 | done |