Add 'dtds' and 'fix' directories to the checklicense whitelist, they don't
[metze/wireshark/wip.git] / tools / checklicenses.py
1 #!/usr/bin/env python
2 # Copyright (c) 2013 The Chromium Authors. All rights reserved.
3 #
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
6 # met:
7 #
8 #    * Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 #    * Redistributions in binary form must reproduce the above
11 # copyright notice, this list of conditions and the following disclaimer
12 # in the documentation and/or other materials provided with the
13 # distribution.
14 #    * Neither the name of Google Inc. nor the names of its
15 # contributors may be used to endorse or promote products derived from
16 # this software without specific prior written permission.
17 #
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 """Makes sure that all files contain proper licensing information."""
31
32
33 import optparse
34 import os.path
35 import subprocess
36 import sys
37
38
39 def PrintUsage():
40   print """Usage: python checklicenses.py [--root <root>] [tocheck]
41   --root   Specifies the repository root. This defaults to ".." relative
42            to the script file. This will be correct given the normal location
43            of the script in "<root>/tools".
44
45   --ignore-suppressions  Ignores path-specific license whitelist. Useful when
46                          trying to remove a suppression/whitelist entry.
47
48   tocheck  Specifies the directory, relative to root, to check. This defaults
49            to "." so it checks everything.
50
51 Examples:
52   python checklicenses.py
53   python checklicenses.py --root ~/chromium/src third_party"""
54
55
56 WHITELISTED_LICENSES = [
57     'Apache (v2.0)',
58     'Apache (v2.0) BSD (2 clause)',
59     'Apache (v2.0) GPL (v2)',
60     'Apple MIT',  # https://fedoraproject.org/wiki/Licensing/Apple_MIT_License
61     'APSL (v2)',
62     'APSL (v2) BSD (4 clause)',
63     'BSD',
64     'BSD (2 clause)',
65     'BSD (2 clause) MIT/X11 (BSD like)',
66     'BSD (3 clause)',
67     'BSD (3 clause) ISC',
68     'BSD (3 clause) LGPL (v2 or later)',
69     'BSD (3 clause) LGPL (v2.1 or later)',
70     'BSD (3 clause) MIT/X11 (BSD like)',
71     'BSD (4 clause)',
72     'BSD-like',
73
74     # TODO(phajdan.jr): Make licensecheck not print BSD-like twice.
75     'BSD-like MIT/X11 (BSD like)',
76
77     'BSL (v1.0)',
78     'GPL (v2 or later)',
79     'GPL (v2 or later) with Bison parser exception',
80     'GPL (v2 or later) with libtool exception',
81     'GPL (v3 or later) with Bison parser exception',
82     'GPL with Bison parser exception',
83     'ISC',
84     'LGPL',
85     'LGPL (v2)',
86     'LGPL (v2 or later)',
87     'LGPL (v2.1)',
88     'LGPL (v3 or later)',
89
90     # TODO(phajdan.jr): Make licensecheck convert that comma to a dot.
91     'LGPL (v2,1 or later)',
92
93     'LGPL (v2.1 or later)',
94     'MPL (v1.0) LGPL (v2 or later)',
95     'MPL (v1.1)',
96     'MPL (v1.1) BSD-like',
97     'MPL (v1.1) BSD-like GPL (unversioned/unknown version)',
98     'MPL (v1.1,) BSD (3 clause) GPL (unversioned/unknown version) '
99         'LGPL (v2.1 or later)',
100     'MPL (v1.1) GPL (unversioned/unknown version)',
101     'MPL (v2.0)',
102
103     # TODO(phajdan.jr): Make licensecheck not print the comma after 1.1.
104     'MPL (v1.1,) GPL (unversioned/unknown version) LGPL (v2 or later)',
105     'MPL (v1.1,) GPL (unversioned/unknown version) LGPL (v2.1 or later)',
106
107     'MIT/X11 (BSD like)',
108     'Ms-PL',
109     'Public domain',
110     'Public domain BSD',
111     'Public domain BSD (3 clause)',
112     'Public domain BSD-like',
113     'Public domain LGPL (v2.1 or later)',
114     'libpng',
115     'zlib/libpng',
116     'SGI Free Software License B',
117     'University of Illinois/NCSA Open Source License (BSD like)',
118 ]
119
120
121 PATH_SPECIFIC_WHITELISTED_LICENSES = {
122     'dtds': [
123         'UNKNOWN',
124     ],
125     'fix': [
126         'UNKNOWN',
127     ],
128     'tools/pidl': [
129         'UNKNOWN',
130     ],
131     'wiretap/ascend.c': [
132         'GPL (v3 or later)',
133     ],
134     'wiretap/ascend.h': [
135         'GPL (v3 or later)',
136     ]
137 }
138
139
140 def check_licenses(options, args):
141   # Figure out which directory we have to check.
142   if len(args) == 0:
143     # No directory to check specified, use the repository root.
144     start_dir = options.base_directory
145   elif len(args) == 1:
146     # Directory specified. Start here. It's supposed to be relative to the
147     # base directory.
148     start_dir = os.path.abspath(os.path.join(options.base_directory, args[0]))
149   else:
150     # More than one argument, we don't handle this.
151     PrintUsage()
152     return 1
153
154   print "Using base directory:", options.base_directory
155   print "Checking:", start_dir
156   print
157
158   #licensecheck_path = os.path.abspath(os.path.join(options.base_directory,
159   #                                                 'third_party',
160   #                                                 'devscripts',
161   #                                                 'licensecheck.pl'))
162   licensecheck_path = 'licensecheck'
163
164   licensecheck = subprocess.Popen([licensecheck_path,
165                                    '-l', '100',
166                                    '-r', start_dir],
167                                   stdout=subprocess.PIPE,
168                                   stderr=subprocess.PIPE)
169   stdout, stderr = licensecheck.communicate()
170   if options.verbose:
171     print '----------- licensecheck stdout -----------'
172     print stdout
173     print '--------- end licensecheck stdout ---------'
174   if licensecheck.returncode != 0 or stderr:
175     print '----------- licensecheck stderr -----------'
176     print stderr
177     print '--------- end licensecheck stderr ---------'
178     print "\nFAILED\n"
179     return 1
180
181   success = True
182   for line in stdout.splitlines():
183     filename, license = line.split(':', 1)
184     filename = os.path.relpath(filename.strip(), options.base_directory)
185
186     # All files in the build output directory are generated one way or another.
187     # There's no need to check them.
188     if filename.startswith('out/') or filename.startswith('sconsbuild/'):
189       continue
190
191     # For now we're just interested in the license.
192     license = license.replace('*No copyright*', '').strip()
193
194     # Skip generated files.
195     if 'GENERATED FILE' in license:
196       continue
197
198     if license in WHITELISTED_LICENSES:
199       continue
200
201     if not options.ignore_suppressions:
202       found_path_specific = False
203       for prefix in PATH_SPECIFIC_WHITELISTED_LICENSES:
204         if (filename.startswith(prefix) and
205             license in PATH_SPECIFIC_WHITELISTED_LICENSES[prefix]):
206           found_path_specific = True
207           break
208       if found_path_specific:
209         continue
210
211     print "'%s' has non-whitelisted license '%s'" % (filename, license)
212     success = False
213
214   if success:
215     print "\nSUCCESS\n"
216     return 0
217   else:
218     print "\nFAILED\n"
219     print "Please read",
220     print "http://www.chromium.org/developers/adding-3rd-party-libraries"
221     print "for more info how to handle the failure."
222     print
223     print "Please respect OWNERS of checklicenses.py. Changes violating"
224     print "this requirement may be reverted."
225     return 1
226
227
228 def main():
229   default_root = os.path.abspath(
230       os.path.join(os.path.dirname(__file__), '..'))
231   option_parser = optparse.OptionParser()
232   option_parser.add_option('--root', default=default_root,
233                            dest='base_directory',
234                            help='Specifies the repository root. This defaults '
235                            'to "../.." relative to the script file, which '
236                            'will normally be the repository root.')
237   option_parser.add_option('-v', '--verbose', action='store_true',
238                            default=False, help='Print debug logging')
239   option_parser.add_option('--ignore-suppressions',
240                            action='store_true',
241                            default=False,
242                            help='Ignore path-specific license whitelist.')
243   options, args = option_parser.parse_args()
244   return check_licenses(options, args)
245
246
247 if '__main__' == __name__:
248   sys.exit(main())