Merge Chromium + Blink git repositories
[chromium-blink-merge.git] / tools / checklicenses / checklicenses.py
blob1a107c362f032e58a9d49820e4ad3660cee24530
1 #!/usr/bin/env python
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."""
9 import json
10 import optparse
11 import os.path
12 import subprocess
13 import sys
16 def PrintUsage():
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.
28 Examples:
29 python checklicenses.py
30 python checklicenses.py --root ~/chromium/src third_party"""
33 WHITELISTED_LICENSES = [
34 'Anti-Grain Geometry',
35 'Apache (v2.0)',
36 'Apache (v2.0) BSD (2 clause)',
37 'Apache (v2.0) GPL (v2)',
38 'Apple MIT', # https://fedoraproject.org/wiki/Licensing/Apple_MIT_License
39 'APSL (v2)',
40 'APSL (v2) BSD (4 clause)',
41 'BSD',
42 'BSD (2 clause)',
43 'BSD (2 clause) ISC',
44 'BSD (2 clause) MIT/X11 (BSD like)',
45 'BSD (3 clause)',
46 'BSD (3 clause) GPL (v2)',
47 'BSD (3 clause) ISC',
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)',
51 'BSD (4 clause)',
52 'BSD-like',
54 # TODO(phajdan.jr): Make licensecheck not print BSD-like twice.
55 'BSD-like MIT/X11 (BSD like)',
57 'BSL (v1.0)',
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',
66 'ISC',
67 'LGPL (unversioned/unknown version)',
68 'LGPL (v2)',
69 'LGPL (v2 or later)',
70 'LGPL (v2.1)',
71 'LGPL (v2.1 or later)',
72 'LGPL (v3 or later)',
73 'MIT/X11 (BSD like)',
74 'MIT/X11 (BSD like) LGPL (v2.1 or later)',
75 'MPL (v1.0) LGPL (v2 or later)',
76 'MPL (v1.1)',
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)',
88 'MPL (v2.0)',
89 'Ms-PL',
90 'Public domain',
91 'Public domain BSD',
92 'Public domain BSD (3 clause)',
93 'Public domain BSD-like',
94 'Public domain LGPL (v2.1 or later)',
95 'libpng',
96 'zlib/libpng',
97 'SGI Free Software License B',
98 'SunSoft (BSD like)',
99 'University of Illinois/NCSA Open Source License (BSD like)',
100 ('University of Illinois/NCSA Open Source License (BSD like) '
101 'MIT/X11 (BSD like)'),
105 PATH_SPECIFIC_WHITELISTED_LICENSES = {
106 'base/third_party/icu': [ # http://crbug.com/98087
107 'UNKNOWN',
110 # http://code.google.com/p/google-breakpad/issues/detail?id=450
111 'breakpad/src': [
112 'UNKNOWN',
115 'buildtools/third_party/libc++/trunk/test': [
116 # http://llvm.org/bugs/show_bug.cgi?id=18291
117 'UNKNOWN',
120 'chrome/common/extensions/docs/examples': [ # http://crbug.com/98092
121 'UNKNOWN',
123 # This contains files copied from elsewhere from the tree. Since the copied
124 # directories might have suppressions below (like simplejson), whitelist the
125 # whole directory. This is also not shipped code.
126 'chrome/common/extensions/docs/server2/third_party': [
127 'UNKNOWN',
129 'courgette/third_party/bsdiff_create.cc': [ # http://crbug.com/98095
130 'UNKNOWN',
132 'courgette/third_party/qsufsort.h': [ # http://crbug.com/98095
133 'UNKNOWN',
135 'native_client': [ # http://crbug.com/98099
136 'UNKNOWN',
138 'native_client/toolchain': [
139 'BSD GPL (v2 or later)',
140 'BSD MIT/X11 (BSD like)',
141 'BSD (2 clause) GPL (v2 or later)',
142 'BSD (3 clause) GPL (v2 or later)',
143 'BSD (4 clause) ISC',
144 'BSL (v1.0) GPL',
145 'BSL (v1.0) GPL (v3.1)',
146 'GPL',
147 'GPL (unversioned/unknown version)',
148 'GPL (v2)',
149 'GPL (v2 or later)',
150 'GPL (v3.1)',
151 'GPL (v3 or later)',
152 'MPL (v1.1) LGPL (unversioned/unknown version)',
154 'third_party/WebKit': [
155 'UNKNOWN',
158 # http://code.google.com/p/angleproject/issues/detail?id=217
159 'third_party/angle': [
160 'UNKNOWN',
163 # http://crbug.com/222828
164 # http://bugs.python.org/issue17514
165 'third_party/chromite/third_party/argparse.py': [
166 'UNKNOWN',
169 # http://crbug.com/326117
170 # https://bitbucket.org/chrisatlee/poster/issue/21
171 'third_party/chromite/third_party/poster': [
172 'UNKNOWN',
175 # http://crbug.com/333508
176 'third_party/clang_format/script': [
177 'UNKNOWN',
180 # http://crbug.com/333508
181 'buildtools/clang_format/script': [
182 'UNKNOWN',
185 # https://mail.python.org/pipermail/cython-devel/2014-July/004062.html
186 'third_party/cython': [
187 'UNKNOWN',
190 'third_party/devscripts': [
191 'GPL (v2 or later)',
193 'third_party/catapult/tracing/third_party/devscripts': [
194 'GPL (v2 or later)',
197 # https://github.com/shazow/apiclient/issues/8
198 # MIT license.
199 'third_party/catapult/third_party/apiclient': [
200 'UNKNOWN',
202 'third_party/catapult/dashboard/third_party/apiclient': [
203 'UNKNOWN',
206 # https://bugs.launchpad.net/beautifulsoup/+bug/1481316
207 # MIT license.
208 'third_party/catapult/third_party/beautifulsoup': [
209 'UNKNOWN'
211 'third_party/catapult/dashboard/third_party/beautifulsoup': [
212 'UNKNOWN'
215 # https://code.google.com/p/graphy/issues/detail?id=6
216 # Apache (v2.0)
217 'third_party/catapult/third_party/graphy': [
218 'UNKNOWN',
220 'third_party/catapult/dashboard/third_party/graphy': [
221 'UNKNOWN',
224 # https://github.com/html5lib/html5lib-python/issues/125
225 # MIT license.
226 'third_party/catapult/third_party/html5lib-python': [
227 'UNKNOWN',
230 # https://github.com/jcgregorio/httplib2/issues/307
231 # MIT license.
232 'third_party/catapult/third_party/httplib2': [
233 'UNKNOWN',
235 'third_party/catapult/dashboard/third_party/httplib2': [
236 'UNKNOWN',
239 # https://github.com/GoogleCloudPlatform/appengine-mapreduce/issues/71
240 # Apache (v2.0)
241 'third_party/catapult/third_party/mapreduce': [
242 'UNKNOWN',
244 'third_party/catapult/dashboard/third_party/mapreduce': [
245 'UNKNOWN',
248 # https://code.google.com/p/webapp-improved/issues/detail?id=103
249 # Apache (v2.0).
250 'third_party/catapult/third_party/webapp2': [
251 'UNKNOWN',
253 'third_party/catapult/dashboard/third_party/webapp2': [
254 'UNKNOWN',
257 # https://github.com/Pylons/webob/issues/211
258 # MIT license.
259 'third_party/catapult/third_party/WebOb': [
260 'UNKNOWN',
262 'third_party/catapult/dashboard/third_party/WebOb': [
263 'UNKNOWN',
266 # https://github.com/Pylons/webtest/issues/141
267 # MIT license.
268 'third_party/catapult/third_party/webtest': [
269 'UNKNOWN',
271 'third_party/catapult/dashboard/third_party/webtest': [
272 'UNKNOWN',
275 # https://bitbucket.org/ianb/paste/issues/12/add-license-headers-to-source-files
276 # MIT license.
277 'third_party/catapult/third_party/Paste': [
278 'UNKNOWN',
280 'third_party/catapult/dashboard/third_party/Paste': [
281 'UNKNOWN',
284 # https://github.com/google/oauth2client/issues/231
285 # Apache v2.0.
286 'third_party/catapult/third_party/oauth2client': [
287 'UNKNOWN',
289 'third_party/catapult/dashboard/third_party/oauth2client': [
290 'UNKNOWN',
293 # https://bitbucket.org/gutworth/six/issues/129/add-license-headers-to-source-files
294 # MIT license.
295 'third_party/catapult/third_party/six': [
296 'UNKNOWN',
298 'third_party/catapult/dashboard/third_party/six': [
299 'UNKNOWN',
302 'third_party/expat/files/lib': [ # http://crbug.com/98121
303 'UNKNOWN',
305 'third_party/ffmpeg': [
306 'GPL',
307 'GPL (v2)',
308 'GPL (v2 or later)',
309 'GPL (v3 or later)',
310 'UNKNOWN', # http://crbug.com/98123
312 'third_party/fontconfig': [
313 # https://bugs.freedesktop.org/show_bug.cgi?id=73401
314 'UNKNOWN',
316 'third_party/freetype2': [ # http://crbug.com/177319
317 'UNKNOWN',
319 'third_party/hunspell': [ # http://crbug.com/98134
320 'UNKNOWN',
322 'third_party/iccjpeg': [ # http://crbug.com/98137
323 'UNKNOWN',
325 'third_party/icu': [ # http://crbug.com/98301
326 'UNKNOWN',
328 'third_party/jsoncpp/source': [
329 # https://github.com/open-source-parsers/jsoncpp/issues/234
330 'UNKNOWN',
332 'third_party/junit/src': [
333 # https://github.com/junit-team/junit/issues/1132
334 'UNKNOWN',
336 'third_party/lcov': [ # http://crbug.com/98304
337 'UNKNOWN',
339 'third_party/lcov/contrib/galaxy/genflat.pl': [
340 'GPL (v2 or later)',
342 'third_party/libevent': [ # http://crbug.com/98309
343 'UNKNOWN',
345 'third_party/libjingle/source/talk': [ # http://crbug.com/98310
346 'UNKNOWN',
348 'third_party/libjpeg_turbo': [ # http://crbug.com/98314
349 'UNKNOWN',
352 # Many liblouis files are mirrored but not used in the NaCl module.
353 # They are not excluded from the mirror because of lack of infrastructure
354 # support. Getting license headers added to the files where missing is
355 # tracked in https://github.com/liblouis/liblouis/issues/22.
356 'third_party/liblouis/src': [
357 'GPL (v3 or later)',
358 'UNKNOWN',
361 'third_party/libpng': [ # http://crbug.com/98318
362 'UNKNOWN',
365 # The following files lack license headers, but are trivial.
366 'third_party/libusb/src/libusb/os/poll_posix.h': [
367 'UNKNOWN',
370 'third_party/libvpx/source': [ # http://crbug.com/98319
371 'UNKNOWN',
373 'third_party/libvpx_new/source': [ # http://crbug.com/98319
374 'UNKNOWN',
376 'third_party/libxml': [
377 'UNKNOWN',
379 'third_party/libxslt': [
380 'UNKNOWN',
382 'third_party/lzma_sdk': [
383 'UNKNOWN',
385 'third_party/mesa/src': [
386 'GPL (v2)',
387 'GPL (v3 or later)',
388 'MIT/X11 (BSD like) GPL (v3 or later) with Bison parser exception',
389 'UNKNOWN', # http://crbug.com/98450
391 'third_party/modp_b64': [
392 'UNKNOWN',
394 'third_party/openmax_dl/dl' : [
395 'Khronos Group',
397 'third_party/openssl': [ # http://crbug.com/98451
398 'UNKNOWN',
400 'third_party/boringssl': [
401 # There are some files in BoringSSL which came from OpenSSL and have no
402 # license in them. We don't wish to add the license header ourselves
403 # thus we don't expect to pass license checks.
404 'UNKNOWN',
406 'third_party/ots/tools/ttf-checksum.py': [ # http://code.google.com/p/ots/issues/detail?id=2
407 'UNKNOWN',
409 'third_party/molokocacao': [ # http://crbug.com/98453
410 'UNKNOWN',
412 'third_party/ocmock/OCMock': [ # http://crbug.com/98454
413 'UNKNOWN',
415 'third_party/protobuf': [ # http://crbug.com/98455
416 'UNKNOWN',
419 # https://bitbucket.org/ned/coveragepy/issue/313/add-license-file-containing-2-3-or-4
420 # BSD 2-clause license.
421 'third_party/pycoverage': [
422 'UNKNOWN',
425 'third_party/pyelftools': [ # http://crbug.com/222831
426 'UNKNOWN',
428 'third_party/scons-2.0.1/engine/SCons': [ # http://crbug.com/98462
429 'UNKNOWN',
431 'third_party/simplejson': [
432 'UNKNOWN',
434 'third_party/skia': [ # http://crbug.com/98463
435 'UNKNOWN',
437 'third_party/snappy/src': [ # http://crbug.com/98464
438 'UNKNOWN',
440 'third_party/smhasher/src': [ # http://crbug.com/98465
441 'UNKNOWN',
443 'third_party/speech-dispatcher/libspeechd.h': [
444 'GPL (v2 or later)',
446 'third_party/sqlite': [
447 'UNKNOWN',
450 # http://crbug.com/334668
451 # MIT license.
452 'tools/swarming_client/third_party/httplib2': [
453 'UNKNOWN',
456 # http://crbug.com/334668
457 # Apache v2.0.
458 'tools/swarming_client/third_party/oauth2client': [
459 'UNKNOWN',
462 # http://crbug.com/471372
463 # BSD
464 'tools/swarming_client/third_party/pyasn1': [
465 'UNKNOWN',
468 # http://crbug.com/471372
469 # Apache v2.0.
470 'tools/swarming_client/third_party/rsa': [
471 'UNKNOWN',
474 # https://github.com/kennethreitz/requests/issues/1610
475 'tools/swarming_client/third_party/requests': [
476 'UNKNOWN',
479 'third_party/talloc': [
480 'GPL (v3 or later)',
481 'UNKNOWN', # http://crbug.com/98588
483 'third_party/tcmalloc': [
484 'UNKNOWN', # http://crbug.com/98589
486 'third_party/tlslite': [
487 'UNKNOWN',
489 'third_party/webdriver': [ # http://crbug.com/98590
490 'UNKNOWN',
493 # https://github.com/html5lib/html5lib-python/issues/125
494 # https://github.com/KhronosGroup/WebGL/issues/435
495 'third_party/webgl/src': [
496 'UNKNOWN',
499 'third_party/webrtc': [ # http://crbug.com/98592
500 'UNKNOWN',
502 'third_party/xdg-utils': [ # http://crbug.com/98593
503 'UNKNOWN',
505 'third_party/yasm/source': [ # http://crbug.com/98594
506 'UNKNOWN',
508 'third_party/zlib/contrib/minizip': [
509 'UNKNOWN',
511 'third_party/zlib/trees.h': [
512 'UNKNOWN',
514 'tools/emacs': [ # http://crbug.com/98595
515 'UNKNOWN',
517 'tools/gyp/test': [
518 'UNKNOWN',
520 'tools/python/google/__init__.py': [
521 'UNKNOWN',
523 'tools/stats_viewer/Properties/AssemblyInfo.cs': [
524 'UNKNOWN',
526 'tools/symsrc/pefile.py': [
527 'UNKNOWN',
529 # Not shipped, MIT license but the header files contain no licensing info.
530 'tools/telemetry/third_party/altgraph': [
531 'UNKNOWN',
533 # Not shipped, downloaded on trybots sometimes.
534 'tools/telemetry/third_party/gsutil': [
535 'BSD MIT/X11 (BSD like)',
536 'UNKNOWN',
538 # Not shipped, MIT license but the header files contain no licensing info.
539 'tools/telemetry/third_party/modulegraph': [
540 'UNKNOWN',
542 'tools/telemetry/third_party/pyserial': [
543 # https://sourceforge.net/p/pyserial/feature-requests/35/
544 'UNKNOWN',
546 'v8/test/cctest': [ # http://crbug.com/98597
547 'UNKNOWN',
549 'v8/src/third_party/kernel/tools/perf/util/jitdump.h': [ # http://crbug.com/391716
550 'UNKNOWN',
554 EXCLUDED_PATHS = [
555 # Don't check generated files
556 'out/',
558 # Don't check sysroot directories
559 'build/linux/debian_wheezy_amd64-sysroot',
560 'build/linux/debian_wheezy_arm-sysroot',
561 'build/linux/debian_wheezy_i386-sysroot',
562 'build/linux/debian_wheezy_mips-sysroot',
566 def check_licenses(options, args):
567 # Figure out which directory we have to check.
568 if len(args) == 0:
569 # No directory to check specified, use the repository root.
570 start_dir = options.base_directory
571 elif len(args) == 1:
572 # Directory specified. Start here. It's supposed to be relative to the
573 # base directory.
574 start_dir = os.path.abspath(os.path.join(options.base_directory, args[0]))
575 else:
576 # More than one argument, we don't handle this.
577 PrintUsage()
578 return 1
580 print "Using base directory:", options.base_directory
581 print "Checking:", start_dir
582 print
584 licensecheck_path = os.path.abspath(os.path.join(options.base_directory,
585 'third_party',
586 'devscripts',
587 'licensecheck.pl'))
589 licensecheck = subprocess.Popen([licensecheck_path,
590 '-l', '100',
591 '-r', start_dir],
592 stdout=subprocess.PIPE,
593 stderr=subprocess.PIPE)
594 stdout, stderr = licensecheck.communicate()
595 if options.verbose:
596 print '----------- licensecheck stdout -----------'
597 print stdout
598 print '--------- end licensecheck stdout ---------'
599 if licensecheck.returncode != 0 or stderr:
600 print '----------- licensecheck stderr -----------'
601 print stderr
602 print '--------- end licensecheck stderr ---------'
603 print "\nFAILED\n"
604 return 1
606 used_suppressions = set()
607 errors = []
609 for line in stdout.splitlines():
610 filename, license = line.split(':', 1)
611 filename = os.path.relpath(filename.strip(), options.base_directory)
613 # Check if the file belongs to one of the excluded paths.
614 if any((filename.startswith(path) for path in EXCLUDED_PATHS)):
615 continue
617 # For now we're just interested in the license.
618 license = license.replace('*No copyright*', '').strip()
620 # Skip generated files.
621 if 'GENERATED FILE' in license:
622 continue
624 if license in WHITELISTED_LICENSES:
625 continue
627 if not options.ignore_suppressions:
628 matched_prefixes = [
629 prefix for prefix in PATH_SPECIFIC_WHITELISTED_LICENSES
630 if filename.startswith(prefix) and
631 license in PATH_SPECIFIC_WHITELISTED_LICENSES[prefix]]
632 if matched_prefixes:
633 used_suppressions.update(set(matched_prefixes))
634 continue
636 errors.append({'filename': filename, 'license': license})
638 if options.json:
639 with open(options.json, 'w') as f:
640 json.dump(errors, f)
642 if errors:
643 for error in errors:
644 print "'%s' has non-whitelisted license '%s'" % (
645 error['filename'], error['license'])
646 print "\nFAILED\n"
647 print "Please read",
648 print "http://www.chromium.org/developers/adding-3rd-party-libraries"
649 print "for more info how to handle the failure."
650 print
651 print "Please respect OWNERS of checklicenses.py. Changes violating"
652 print "this requirement may be reverted."
654 # Do not print unused suppressions so that above message is clearly
655 # visible and gets proper attention. Too much unrelated output
656 # would be distracting and make the important points easier to miss.
658 return 1
660 print "\nSUCCESS\n"
662 if not len(args):
663 unused_suppressions = set(
664 PATH_SPECIFIC_WHITELISTED_LICENSES.iterkeys()).difference(
665 used_suppressions)
666 if unused_suppressions:
667 print "\nNOTE: unused suppressions detected:\n"
668 print '\n'.join(unused_suppressions)
670 return 0
673 def main():
674 default_root = os.path.abspath(
675 os.path.join(os.path.dirname(__file__), '..', '..'))
676 option_parser = optparse.OptionParser()
677 option_parser.add_option('--root', default=default_root,
678 dest='base_directory',
679 help='Specifies the repository root. This defaults '
680 'to "../.." relative to the script file, which '
681 'will normally be the repository root.')
682 option_parser.add_option('-v', '--verbose', action='store_true',
683 default=False, help='Print debug logging')
684 option_parser.add_option('--ignore-suppressions',
685 action='store_true',
686 default=False,
687 help='Ignore path-specific license whitelist.')
688 option_parser.add_option('--json', help='Path to JSON output file')
689 options, args = option_parser.parse_args()
690 return check_licenses(options, args)
693 if '__main__' == __name__:
694 sys.exit(main())