2 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
3 # Use of this source code is governed by a BSD-style license that can be
4 # found in the LICENSE file.
6 """Makes sure that all files contain proper licensing information."""
17 print """Usage: python checklicenses.py [--root <root>] [tocheck]
18 --root Specifies the repository root. This defaults to "../.." relative
19 to the script file. This will be correct given the normal location
20 of the script in "<root>/tools/checklicenses".
22 --ignore-suppressions Ignores path-specific license whitelist. Useful when
23 trying to remove a suppression/whitelist entry.
25 tocheck Specifies the directory, relative to root, to check. This defaults
26 to "." so it checks everything.
29 python checklicenses.py
30 python checklicenses.py --root ~/chromium/src third_party"""
33 WHITELISTED_LICENSES
= [
34 'Anti-Grain Geometry',
36 'Apache (v2.0) BSD (2 clause)',
37 'Apache (v2.0) GPL (v2)',
38 'Apple MIT', # https://fedoraproject.org/wiki/Licensing/Apple_MIT_License
40 'APSL (v2) BSD (4 clause)',
44 'BSD (2 clause) MIT/X11 (BSD like)',
46 'BSD (3 clause) GPL (v2)',
48 'BSD (3 clause) LGPL (v2 or later)',
49 'BSD (3 clause) LGPL (v2.1 or later)',
50 'BSD (3 clause) MIT/X11 (BSD like)',
54 # TODO(phajdan.jr): Make licensecheck not print BSD-like twice.
55 'BSD-like MIT/X11 (BSD like)',
58 'FreeType (BSD like)',
59 'FreeType (BSD like) with patent clause',
60 'GPL (v2) LGPL (v2.1 or later)',
61 'GPL (v2 or later) with Bison parser exception',
62 'GPL (v2 or later) with libtool exception',
63 'GPL (v3 or later) with Bison parser exception',
64 'GPL with Bison parser exception',
65 'Independent JPEG Group License',
67 'LGPL (unversioned/unknown version)',
71 'LGPL (v2.1 or later)',
74 'MIT/X11 (BSD like) LGPL (v2.1 or later)',
75 'MPL (v1.0) LGPL (v2 or later)',
77 'MPL (v1.1) BSD (3 clause) GPL (v2) LGPL (v2.1 or later)',
78 'MPL (v1.1) BSD (3 clause) LGPL (v2.1 or later)',
79 'MPL (v1.1) BSD-like',
80 'MPL (v1.1) BSD-like GPL (unversioned/unknown version)',
81 'MPL (v1.1) BSD-like GPL (v2) LGPL (v2.1 or later)',
82 'MPL (v1.1) GPL (v2)',
83 'MPL (v1.1) GPL (v2) LGPL (v2 or later)',
84 'MPL (v1.1) GPL (v2) LGPL (v2.1 or later)',
85 'MPL (v1.1) GPL (unversioned/unknown version)',
86 'MPL (v1.1) LGPL (v2 or later)',
87 'MPL (v1.1) LGPL (v2.1 or later)',
92 'Public domain BSD (3 clause)',
93 'Public domain BSD-like',
94 'Public domain LGPL (v2.1 or later)',
97 'SGI Free Software License B',
98 'University of Illinois/NCSA Open Source License (BSD like)',
99 ('University of Illinois/NCSA Open Source License (BSD like) '
100 'MIT/X11 (BSD like)'),
104 PATH_SPECIFIC_WHITELISTED_LICENSES
= {
105 'base/third_party/icu': [ # http://crbug.com/98087
109 # http://code.google.com/p/google-breakpad/issues/detail?id=450
114 'chrome/common/extensions/docs/examples': [ # http://crbug.com/98092
117 'courgette/third_party/bsdiff_create.cc': [ # http://crbug.com/98095
120 'native_client': [ # http://crbug.com/98099
123 'native_client/toolchain': [
124 'BSD GPL (v2 or later)',
125 'BSD (2 clause) GPL (v2 or later)',
126 'BSD (3 clause) GPL (v2 or later)',
128 'BSL (v1.0) GPL (v3.1)',
130 'GPL (unversioned/unknown version)',
136 'third_party/WebKit': [
140 # http://code.google.com/p/angleproject/issues/detail?id=217
141 'third_party/angle': [
145 # http://crbug.com/222828
146 # http://bugs.python.org/issue17514
147 'third_party/chromite/third_party/argparse.py': [
151 # http://crbug.com/326117
152 # https://bitbucket.org/chrisatlee/poster/issue/21
153 'third_party/chromite/third_party/poster': [
157 # http://crbug.com/333508
158 'third_party/clang_format/script': [
162 'third_party/devscripts': [
165 'third_party/expat/files/lib': [ # http://crbug.com/98121
168 'third_party/ffmpeg': [
172 'UNKNOWN', # http://crbug.com/98123
174 'third_party/fontconfig': [
175 # https://bugs.freedesktop.org/show_bug.cgi?id=73401
178 'third_party/freetype2': [ # http://crbug.com/177319
181 'third_party/hunspell': [ # http://crbug.com/98134
184 'third_party/iccjpeg': [ # http://crbug.com/98137
187 'third_party/icu': [ # http://crbug.com/98301
190 'third_party/lcov': [ # http://crbug.com/98304
193 'third_party/lcov/contrib/galaxy/genflat.pl': [
196 'third_party/libc++/trunk/include/support/solaris': [
197 # http://llvm.org/bugs/show_bug.cgi?id=18291
200 'third_party/libc++/trunk/src/support/solaris/xlocale.c': [
201 # http://llvm.org/bugs/show_bug.cgi?id=18291
204 'third_party/libc++/trunk/test': [
205 # http://llvm.org/bugs/show_bug.cgi?id=18291
208 'third_party/libevent': [ # http://crbug.com/98309
211 'third_party/libjingle/source/talk': [ # http://crbug.com/98310
214 'third_party/libjpeg_turbo': [ # http://crbug.com/98314
217 'third_party/libpng': [ # http://crbug.com/98318
221 # The following files lack license headers, but are trivial.
222 'third_party/libusb/src/libusb/os/poll_posix.h': [
226 'third_party/libvpx/source': [ # http://crbug.com/98319
229 'third_party/libxml': [
232 'third_party/libxslt': [
235 'third_party/lzma_sdk': [
238 'third_party/mesa/src': [
241 'MIT/X11 (BSD like) GPL (v3 or later) with Bison parser exception',
242 'UNKNOWN', # http://crbug.com/98450
244 'third_party/modp_b64': [
247 'third_party/openmax_dl/dl' : [
250 'third_party/openssl': [ # http://crbug.com/98451
253 'third_party/ots/tools/ttf-checksum.py': [ # http://code.google.com/p/ots/issues/detail?id=2
256 'third_party/molokocacao': [ # http://crbug.com/98453
259 'third_party/npapi/npspy': [
262 'third_party/ocmock/OCMock': [ # http://crbug.com/98454
265 'third_party/ply/__init__.py': [
268 'third_party/protobuf': [ # http://crbug.com/98455
272 # http://crbug.com/222831
273 # https://bitbucket.org/eliben/pyelftools/issue/12
274 'third_party/pyelftools': [
278 'third_party/scons-2.0.1/engine/SCons': [ # http://crbug.com/98462
281 'third_party/simplejson': [
284 'third_party/skia': [ # http://crbug.com/98463
287 'third_party/snappy/src': [ # http://crbug.com/98464
290 'third_party/smhasher/src': [ # http://crbug.com/98465
293 'third_party/speech-dispatcher/libspeechd.h': [
296 'third_party/sqlite': [
300 # http://crbug.com/334668
302 'tools/swarming_client/third_party/httplib2': [
306 # http://crbug.com/334668
308 'tools/swarming_client/third_party/oauth2client': [
312 # https://github.com/kennethreitz/requests/issues/1610
313 'tools/swarming_client/third_party/requests': [
317 'third_party/swig/Lib/linkruntime.c': [ # http://crbug.com/98585
320 'third_party/talloc': [
322 'UNKNOWN', # http://crbug.com/98588
324 'third_party/tcmalloc': [
325 'UNKNOWN', # http://crbug.com/98589
327 'third_party/tlslite': [
330 'third_party/webdriver': [ # http://crbug.com/98590
334 # https://github.com/html5lib/html5lib-python/issues/125
335 # https://github.com/KhronosGroup/WebGL/issues/435
336 'third_party/webgl/src': [
340 'third_party/webrtc': [ # http://crbug.com/98592
343 'third_party/xdg-utils': [ # http://crbug.com/98593
346 'third_party/yasm/source': [ # http://crbug.com/98594
349 'third_party/zlib/contrib/minizip': [
352 'third_party/zlib/trees.h': [
355 'tools/emacs': [ # http://crbug.com/98595
361 'tools/python/google/__init__.py': [
364 'tools/stats_viewer/Properties/AssemblyInfo.cs': [
367 'tools/symsrc/pefile.py': [
370 'tools/telemetry/third_party/pyserial': [
371 # https://sourceforge.net/p/pyserial/feature-requests/35/
374 'v8/test/cctest': [ # http://crbug.com/98597
380 def check_licenses(options
, args
):
381 # Figure out which directory we have to check.
383 # No directory to check specified, use the repository root.
384 start_dir
= options
.base_directory
386 # Directory specified. Start here. It's supposed to be relative to the
388 start_dir
= os
.path
.abspath(os
.path
.join(options
.base_directory
, args
[0]))
390 # More than one argument, we don't handle this.
394 print "Using base directory:", options
.base_directory
395 print "Checking:", start_dir
398 licensecheck_path
= os
.path
.abspath(os
.path
.join(options
.base_directory
,
403 licensecheck
= subprocess
.Popen([licensecheck_path
,
406 stdout
=subprocess
.PIPE
,
407 stderr
=subprocess
.PIPE
)
408 stdout
, stderr
= licensecheck
.communicate()
410 print '----------- licensecheck stdout -----------'
412 print '--------- end licensecheck stdout ---------'
413 if licensecheck
.returncode
!= 0 or stderr
:
414 print '----------- licensecheck stderr -----------'
416 print '--------- end licensecheck stderr ---------'
420 used_suppressions
= set()
423 for line
in stdout
.splitlines():
424 filename
, license
= line
.split(':', 1)
425 filename
= os
.path
.relpath(filename
.strip(), options
.base_directory
)
427 # All files in the build output directory are generated one way or another.
428 # There's no need to check them.
429 if filename
.startswith('out/'):
432 # For now we're just interested in the license.
433 license
= license
.replace('*No copyright*', '').strip()
435 # Skip generated files.
436 if 'GENERATED FILE' in license
:
439 if license
in WHITELISTED_LICENSES
:
442 if not options
.ignore_suppressions
:
444 prefix
for prefix
in PATH_SPECIFIC_WHITELISTED_LICENSES
445 if filename
.startswith(prefix
) and
446 license
in PATH_SPECIFIC_WHITELISTED_LICENSES
[prefix
]]
448 used_suppressions
.update(set(matched_prefixes
))
451 errors
.append({'filename': filename
, 'license': license
})
454 with
open(options
.json
, 'w') as f
:
459 print "'%s' has non-whitelisted license '%s'" % (
460 error
['filename'], error
['license'])
463 print "http://www.chromium.org/developers/adding-3rd-party-libraries"
464 print "for more info how to handle the failure."
466 print "Please respect OWNERS of checklicenses.py. Changes violating"
467 print "this requirement may be reverted."
469 # Do not print unused suppressions so that above message is clearly
470 # visible and gets proper attention. Too much unrelated output
471 # would be distracting and make the important points easier to miss.
478 unused_suppressions
= set(
479 PATH_SPECIFIC_WHITELISTED_LICENSES
.iterkeys()).difference(
481 if unused_suppressions
:
482 print "\nNOTE: unused suppressions detected:\n"
483 print '\n'.join(unused_suppressions
)
489 default_root
= os
.path
.abspath(
490 os
.path
.join(os
.path
.dirname(__file__
), '..', '..'))
491 option_parser
= optparse
.OptionParser()
492 option_parser
.add_option('--root', default
=default_root
,
493 dest
='base_directory',
494 help='Specifies the repository root. This defaults '
495 'to "../.." relative to the script file, which '
496 'will normally be the repository root.')
497 option_parser
.add_option('-v', '--verbose', action
='store_true',
498 default
=False, help='Print debug logging')
499 option_parser
.add_option('--ignore-suppressions',
502 help='Ignore path-specific license whitelist.')
503 option_parser
.add_option('--json', help='Path to JSON output file')
504 options
, args
= option_parser
.parse_args()
505 return check_licenses(options
, args
)
508 if '__main__' == __name__
: