forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathlicenses.py
executable file
·1481 lines (1279 loc) · 53.6 KB
/
licenses.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
# Copyright 2012 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Utility for checking and processing licensing information in third_party
directories.
Usage: licenses.py <command>
Commands:
scan scan third_party directories, verifying that we have licensing info
credits generate about:credits on stdout
(You can also import this as a module.)
"""
from __future__ import print_function
import argparse
import codecs
import csv
import io
import itertools
import json
import logging
import os
import pathlib
import re
import shutil
import subprocess
import sys
import tempfile
from typing import Any, Dict, Iterable, List, Optional
if sys.version_info.major == 2:
import cgi as html
else:
import html
from spdx_writer import SpdxWriter
_REPOSITORY_ROOT = os.path.abspath(
os.path.join(os.path.dirname(__file__), '..', '..'))
sys.path.insert(0, os.path.join(_REPOSITORY_ROOT, 'build'))
import action_helpers
METADATA_FILE_NAMES = frozenset({
"README.chromium", "README.crashpad", "README.v8", "README.pdfium",
"README.angle"
})
# Paths from the root of the tree to directories to skip.
PRUNE_PATHS = set([
# Placeholder directory only, not third-party code.
os.path.join('third_party', 'adobe'),
# Will remove it once converted private sdk using cipd.
os.path.join('third_party', 'android_tools_internal'),
# Build files only, not third-party code.
os.path.join('third_party', 'widevine'),
# Only binaries, used during development.
os.path.join('third_party', 'valgrind'),
# Supplies configuration setting for enabling or disabling field trials and
# features in Chromium projects.
os.path.join('components', 'variations', 'test_data', 'cipd'),
# Used for development and test, not in the shipping product.
os.path.join('build', 'secondary'),
os.path.join('third_party', 'bison'),
os.path.join('third_party', 'chromite'),
os.path.join('third_party', 'clang-format'),
os.path.join('third_party', 'cygwin'),
os.path.join('third_party', 'gnu_binutils'),
os.path.join('third_party', 'gold'),
os.path.join('third_party', 'gperf'),
os.path.join('third_party', 'lighttpd'),
os.path.join('third_party', 'llvm'),
os.path.join('third_party', 'llvm-build'),
os.path.join('third_party', 'mingw-w64'),
os.path.join('third_party', 'nacl_sdk_binaries'),
os.path.join('third_party', 'pefile'),
os.path.join('third_party', 'perl'),
os.path.join('third_party', 'psyco_win32'),
os.path.join('third_party', 'pyelftools'),
os.path.join('third_party', 'pylib'),
os.path.join('third_party', 'pywebsocket'),
os.path.join('third_party', 'syzygy'),
# Stuff pulled in from chrome-internal for official builds/tools.
os.path.join('third_party', 'amd'),
os.path.join('third_party', 'clear_cache'),
os.path.join('third_party', 'gnu'),
os.path.join('third_party', 'googlemac'),
os.path.join('third_party', 'pcre'),
os.path.join('third_party', 'psutils'),
os.path.join('third_party', 'sawbuck'),
os.path.join('third_party', 'wix'),
# See crbug.com/350472
os.path.join('chrome', 'browser', 'resources', 'chromeos', 'quickoffice'),
# Chrome for Android proprietary code.
os.path.join('clank'),
# Proprietary barcode detection library.
os.path.join('third_party', 'barhopper'),
# Internal Chrome Build only for proprietary webref library.
os.path.join('components', 'optimization_guide', 'internal', 'third_party'),
# Proprietary DevTools code.
os.path.join('third_party', 'devtools-frontend-internal'),
# Redistribution does not require attribution in documentation.
os.path.join('third_party', 'directxsdk'),
# For testing only, presents on some bots.
os.path.join('isolate_deps_dir'),
# Mock test data.
os.path.join('tools', 'binary_size', 'libsupersize', 'testdata'),
# Overrides some WebRTC files, same license. Skip this one.
os.path.join('third_party', 'webrtc_overrides'),
])
# Directories we don't scan through.
VCS_METADATA_DIRS = ('.svn', '.git')
PRUNE_DIRS = VCS_METADATA_DIRS + ('layout_tests', ) # lots of subdirs
# A third_party directory can define this file, containing a list of
# subdirectories to process in addition to itself. Intended for directories
# that contain multiple others as transitive dependencies.
ADDITIONAL_PATHS_FILENAME = 'additional_readme_paths.json'
# A list of paths that contain license information but that would otherwise
# not be included. Possible reasons include:
# - Third party directories in //clank which are considered to be Google-owned
# - Directories that are directly checked out from upstream, and thus
# don't have a README.chromium
# - Directories that contain example code, or build tooling.
# - Nested third_party code inside other third_party libraries.
ADDITIONAL_PATHS = (
os.path.join('chrome', 'test', 'chromeos', 'autotest'),
os.path.join('chrome', 'test', 'data'),
os.path.join('native_client'),
os.path.join('third_party', 'android_deps', 'autorolled'),
os.path.join('third_party', 'boringssl', 'src', 'third_party', 'fiat'),
os.path.join('third_party', 'devtools-frontend', 'src', 'front_end',
'third_party'),
os.path.join('third_party', 'devtools-frontend-internal', 'front_end',
'third_party'),
os.path.join('tools', 'page_cycler', 'acid3'),
os.path.join('url', 'third_party', 'mozilla'),
os.path.join('v8'),
# Fake directories to include the strongtalk and fdlibm licenses.
os.path.join('v8', 'strongtalk'),
os.path.join('v8', 'fdlibm'),
)
# SPECIAL_CASES are used for historical directories where we checked out
# directly from upstream into the same directory as we would put metadata.
# In new cases, you should check out upstream source into //root/foo/src
# and keep the corresponding README.chromium file at //root/foo/README.chromium
# instead of adding a SPECIAL_CASE.
# These SPECIAL_CASES should not be used to suppress errors. Please fix
# any metadata files with errors and if you encounter a parsing issue,
# please file a bug.
SPECIAL_CASES = {
os.path.join('native_client'): {
"Name": "native client",
"URL": "https://code.google.com/p/nativeclient",
"Shipped": "yes",
"License": "BSD",
"License File": ["//native_client/LICENSE"],
},
os.path.join('third_party', 'angle'): {
"Name": "Almost Native Graphics Layer Engine",
"URL": "https://chromium.googlesource.com/angle/angle/",
"Shipped": "yes",
"License": "BSD",
},
os.path.join('third_party', 'cros_system_api'): {
"Name": "Chromium OS system API",
"URL": "https://www.chromium.org/chromium-os",
"Shipped": "yes",
"License": "BSD",
# Absolute path here is resolved as relative to the source root.
"License File": ["//LICENSE.chromium_os"],
},
os.path.join('third_party', 'ipcz'): {
"Name": "ipcz",
"URL": (
"https://chromium.googlesource.com/chromium/src/third_party/ipcz"),
"Shipped": "yes",
"License": "BSD",
"License File": ["//third_party/ipcz/LICENSE"],
},
os.path.join('third_party', 'lss'): {
"Name": "linux-syscall-support",
"URL": "https://chromium.googlesource.com/linux-syscall-support/",
"Shipped": "yes",
"License": "BSD",
"License File": ["//third_party/lss/LICENSE"],
},
os.path.join('third_party', 'openscreen', 'src', 'third_party', 'abseil'): {
"Name": "abseil",
"URL": "https://github.com/abseil/abseil-cpp/",
"Shipped": "yes",
"License": "Apache 2.0",
"License File": ["//third_party/abseil-cpp/LICENSE"],
},
os.path.join('third_party', 'openscreen', 'src', 'third_party',
'boringssl'): {
"Name": "BoringSSL",
"URL": "https://boringssl.googlesource.com/boringssl/",
"Shipped": "yes",
"License": "BSDish",
"License File": ["//third_party/boringssl/src/LICENSE"],
},
os.path.join('third_party', 'openscreen', 'src', 'third_party',
'jsoncpp'): {
"Name": "jsoncpp",
"URL": "https://github.com/open-source-parsers/jsoncpp",
"Shipped": "yes",
"License": "MIT",
"License File": ["//third_party/jsoncpp/LICENSE"],
},
os.path.join('third_party', 'openscreen', 'src', 'third_party',
'mozilla'): {
"Name": "mozilla",
"URL": "https://github.com/mozilla",
"Shipped": "yes",
"License": "MPL 1.1/GPL 2.0/LGPL 2.1",
"License File": ["LICENSE.txt"],
},
os.path.join('third_party', 'pdfium'): {
"Name": "PDFium",
"URL": "https://pdfium.googlesource.com/pdfium/",
"Shipped": "yes",
"License": "BSD",
},
os.path.join('third_party', 'ppapi'): {
"Name": "ppapi",
"URL": "https://code.google.com/p/ppapi/",
"Shipped": "yes",
},
os.path.join('third_party', 'crashpad', 'crashpad', 'third_party',
'getopt'): {
"Name": "getopt",
"URL": "https://sourceware.org/ml/newlib/2005/msg00758.html",
"Shipped": "yes",
"License": "Public domain",
"License File": [
"//third_party/crashpad/crashpad/third_party/getopt/LICENSE",
],
},
os.path.join('third_party', 'crashpad', 'crashpad', 'third_party', 'xnu'): {
"Name": "xnu",
"URL": "https://opensource.apple.com/source/xnu/",
"Shipped": "yes",
"License": "Apple Public Source License 2.0",
"License File": ["APPLE_LICENSE"],
},
os.path.join('third_party', 'v8-i18n'): {
"Name": "Internationalization Library for v8",
"URL": "https://code.google.com/p/v8-i18n/",
"Shipped": "yes",
"License": "Apache 2.0",
},
os.path.join('third_party', 'blink'): {
# about:credits doesn't show "Blink" but "WebKit".
# Blink is a fork of WebKit, and Chromium project has maintained it
# since the fork. about:credits needs to mention the code before
# the fork.
"Name": "WebKit",
"URL": "https://webkit.org/",
"Shipped": "yes",
"License": "BSD and LGPL v2 and LGPL v2.1",
# Absolute path here is resolved as relative to the source root.
"License File": ["//third_party/blink/LICENSE_FOR_ABOUT_CREDITS"],
},
os.path.join('v8'): {
"Name": "V8 JavaScript Engine",
"URL": "https://v8.dev/",
"Shipped": "yes",
"License": "BSD",
},
os.path.join('v8', 'strongtalk'): {
"Name": "Strongtalk",
"URL": "https://www.strongtalk.org/",
"Shipped": "yes",
"License": "BSD",
# Absolute path here is resolved as relative to the source root.
"License File": ["//v8/LICENSE.strongtalk"],
},
os.path.join('v8', 'fdlibm'): {
"Name": "fdlibm",
"URL": "https://www.netlib.org/fdlibm/",
"Shipped": "yes",
"License": "Freely Distributable",
# Absolute path here is resolved as relative to the source root.
"License File": ["//v8/LICENSE.fdlibm"],
"License Android Compatible": "yes",
},
os.path.join('third_party', 'swiftshader'): {
"Name": "SwiftShader",
"URL": "https://swiftshader.googlesource.com/SwiftShader",
"Shipped": "yes",
"License": "Apache 2.0 and compatible licenses",
"License Android Compatible": "yes",
"License File": ["//third_party/swiftshader/LICENSE.txt"],
},
os.path.join('third_party', 'swiftshader', 'third_party', 'SPIRV-Tools'): {
"Name": "SPIRV-Tools",
"URL": "https://github.com/KhronosGroup/SPIRV-Tools",
"Shipped": "yes",
"License": "Apache 2.0",
"License File": [
"//third_party/swiftshader/third_party/SPIRV-Tools/LICENSE",
],
},
os.path.join('third_party', 'swiftshader', 'third_party',
'SPIRV-Headers'): {
"Name": "SPIRV-Headers",
"URL": "https://github.com/KhronosGroup/SPIRV-Headers",
"Shipped": "yes",
"License": "Apache 2.0",
"License File": [
"//third_party/swiftshader/third_party/SPIRV-Headers/LICENSE",
],
},
os.path.join('third_party', 'dawn', 'third_party', 'khronos'): {
"Name": "khronos_platform",
"URL": "https://registry.khronos.org/EGL/",
"Shipped": "yes",
"License": "Apache 2.0",
"License File": ["//third_party/dawn/third_party/khronos/LICENSE"],
},
}
# These buildtools/third_party directories only contain
# chromium build files. The actual third_party source files and their
# README.chromium files are under third_party/libc*/.
# So we do not include licensing metadata for these directories.
# See crbug.com/1458042 for more details.
PRUNE_PATHS.update([
os.path.join('buildtools', 'third_party', 'libc++'),
os.path.join('buildtools', 'third_party', 'libc++abi'),
os.path.join('buildtools', 'third_party', 'libunwind'),
])
# The mandatory metadata fields for a single dependency.
MANDATORY_FIELDS = {
"Name", # Short name (for header on about:credits).
"URL", # Project home page.
"License", # Software license.
"License File", # Relative paths to license texts.
"Shipped", # Whether the package is in the shipped product.
}
# Field aliases (key is the alias, value is the field to map to).
# Note: if both fields are provided, the alias field value will be used.
ALIAS_FIELDS = {
"Shipped in Chromium": "Shipped",
}
# The metadata fields that can have multiple values.
MULTIVALUE_FIELDS = {
"License File",
}
# Line used to separate dependencies within the same metadata file.
PATTERN_DEPENDENCY_DIVIDER = re.compile(r"^-{20} DEPENDENCY DIVIDER -{20}$")
# The delimiter used to separate multiple values for one metadata field.
VALUE_DELIMITER = ","
# Soon-to-be-deprecated special value for 'License File' field used to indicate
# that the library is not shipped so the license file should not be used in
# about:credits.
# This value is still supported, but the preferred method is to set the
# 'Shipped' field to 'no' in the library's README.chromium.
NOT_SHIPPED = "NOT_SHIPPED"
# Valid values for the 'Shipped' field used to indicate whether the library is
# shipped and consequently whether the license file should be used in
# about:credits.
YES = "yes"
NO = "no"
# Paths for libraries that we have checked are not shipped on iOS. These are
# left out of the licenses file primarily because we don't want to cause a
# firedrill due to someone thinking that Chrome for iOS is using LGPL code
# when it isn't.
# This is a temporary hack; the real solution is crbug.com/178215
KNOWN_NON_IOS_LIBRARIES = set([
os.path.join('base', 'third_party', 'symbolize'),
os.path.join('base', 'third_party', 'xdg_mime'),
os.path.join('base', 'third_party', 'xdg_user_dirs'),
os.path.join('chrome', 'installer', 'mac', 'third_party', 'bsdiff'),
os.path.join('chrome', 'installer', 'mac', 'third_party', 'xz'),
os.path.join('chrome', 'test', 'data', 'third_party', 'kraken'),
os.path.join('chrome', 'test', 'data', 'third_party', 'spaceport'),
os.path.join('chrome', 'third_party', 'mozilla_security_manager'),
os.path.join('third_party', 'angle'),
os.path.join('third_party', 'apple_apsl'),
os.path.join('third_party', 'apple_sample_code'),
os.path.join('third_party', 'ashmem'),
os.path.join('third_party', 'blink'),
os.path.join('third_party', 'bspatch'),
os.path.join('third_party', 'cld'),
os.path.join('third_party', 'flot'),
os.path.join('third_party', 'gtk+'),
os.path.join('third_party', 'iaccessible2'),
os.path.join('third_party', 'isimpledom'),
os.path.join('third_party', 'jsoncpp'),
os.path.join('third_party', 'khronos'),
os.path.join('third_party', 'libcxx', 'libc++'),
os.path.join('third_party', 'libcxx', 'libc++abi'),
os.path.join('third_party', 'libevent'),
os.path.join('third_party', 'libjpeg'),
os.path.join('third_party', 'libusb'),
os.path.join('third_party', 'libxslt'),
os.path.join('third_party', 'lss'),
os.path.join('third_party', 'lzma_sdk'),
os.path.join('third_party', 'mesa'),
os.path.join('third_party', 'mozc'),
os.path.join('third_party', 'mozilla'),
os.path.join('third_party', 'npapi'),
os.path.join('third_party', 'ots'),
os.path.join('third_party', 'perfetto'),
os.path.join('third_party', 'ppapi'),
os.path.join('third_party', 're2'),
os.path.join('third_party', 'safe_browsing'),
os.path.join('third_party', 'smhasher'),
os.path.join('third_party', 'swiftshader'),
os.path.join('third_party', 'swig'),
os.path.join('third_party', 'talloc'),
os.path.join('third_party', 'usb_ids'),
os.path.join('third_party', 'v8-i18n'),
os.path.join('third_party', 'wtl'),
os.path.join('third_party', 'yasm'),
os.path.join('v8', 'strongtalk'),
])
class InvalidMetadata(Exception):
"""This exception is raised when metadata is invalid."""
pass
class LicenseError(Exception):
"""We raise this exception when a dependency's licensing info isn't
fully filled out.
"""
pass
def AbsolutePath(path, filename, root):
"""Convert a path in README.chromium to be absolute based on the source
root."""
if filename.startswith('/'):
# Absolute-looking paths are relative to the source root
# (which is the directory we're run from).
absolute_path = os.path.join(root, os.path.normpath(filename.lstrip('/')))
else:
absolute_path = os.path.join(root, path, os.path.normpath(filename))
if os.path.exists(absolute_path):
return absolute_path
return None
def ParseMetadataFile(filepath: str,
optional_fields: List[str] = []) -> List[Dict[str, Any]]:
"""Parses the metadata from the file.
Args:
filepath: the path to a file from which to parse metadata.
optional_fields: list of optional metadata fields.
Returns: the metadata for all dependencies described in the file.
Raises:
InvalidMetadata - if the metadata in the file has duplicate fields
for a dependency.
"""
known_fields = (list(MANDATORY_FIELDS) + list(ALIAS_FIELDS.keys()) +
optional_fields)
field_lookup = {name.lower(): name for name in known_fields}
dependencies = []
metadata = {}
with codecs.open(filepath, encoding="utf-8") as readme:
for line in readme:
line = line.strip()
# Skip empty lines.
if not line:
continue
# Check if a new dependency will be described.
if re.match(PATTERN_DEPENDENCY_DIVIDER, line):
# Save the metadata for the previous dependency.
if metadata:
dependencies.append(metadata)
metadata = {}
continue
# Otherwise, try to parse the field name and field value.
parts = line.split(": ", 1)
if len(parts) == 2:
raw_field, value = parts
field = field_lookup.get(raw_field.lower())
if field:
if field in metadata:
# Duplicate field for this dependency.
raise InvalidMetadata(f"duplicate '{field}' in {filepath}")
if field in MULTIVALUE_FIELDS:
metadata[field] = [
entry.strip() for entry in value.split(VALUE_DELIMITER)
]
else:
metadata[field] = value
# The end of the file has been reached. Save the metadata for the
# last dependency, if available.
if metadata:
dependencies.append(metadata)
return dependencies
def ProcessMetadata(metadata: Dict[str, Any],
readme_path: str,
path: str,
root: str,
require_license_file: bool = True,
enable_warnings: bool = False) -> List[str]:
"""Processes a single dependency's metadata and returns the updated
data if it passes validation. This function updates the given metadata
to use fallback fields and change any relative paths to absolute.
Args:
metadata: a single dependency's metadata.
readme_path: the source of the metadata (either a metadata file
or a SPECIAL_CASES entry).
path: the source file for the metadata.
root: the root directory of the repo.
require_license_file: whether a license file is required.
enable_warnings: whether warnings should be displayed.
Returns: error messages, if there were any issues processing the
metadata for license information.
"""
errors = []
# The dependency reference, for more precise error messages.
dep_ref = os.path.relpath(readme_path, root)
dep_name = metadata.get("Name")
if dep_name:
dep_ref = f"{dep_ref}>>{dep_name}"
# Set field values for fields with aliases.
for alias, field in ALIAS_FIELDS.items():
if alias in metadata:
metadata[field] = metadata[alias]
metadata.pop(alias)
# Set the default "License File" value.
if metadata.get("License File") is None:
metadata["License File"] = ["LICENSE"]
# If the "Shipped" field isn't present (or is empty), set it based on
# the value of the "License File" field.
if not metadata.get("Shipped"):
shipped = YES
if NOT_SHIPPED in metadata.get("License File"):
shipped = NO
metadata["Shipped"] = shipped
# Check all mandatory fields have a non-empty value.
for field in MANDATORY_FIELDS:
if not metadata.get(field):
errors.append(f"couldn't find '{field}' line in README.chromium or "
"licenses.py SPECIAL_CASES")
license_file_value = metadata.get("License File")
shipped_value = metadata.get("Shipped")
if enable_warnings:
# Check for the deprecated special value used in the "License File"
# field.
if NOT_SHIPPED in license_file_value:
logging.warning(
f"{dep_ref} is using deprecated {NOT_SHIPPED} value "
"in 'License File' field - remove this and instead specify "
f"'Shipped: {NO}'.")
# Check the "Shipped" field does not contradict the "License File"
# field.
if shipped_value == YES:
logging.warning(
f"Contradictory metadata for {dep_ref} - 'Shipped: {YES}' "
f"but 'License File' includes '{NOT_SHIPPED}'")
# For the modules that are in the shipping product, we need their
# license in about:credits, so update the license files to be the
# full paths.
license_paths = process_license_files(root, path, license_file_value)
if shipped_value == YES and require_license_file and not license_paths:
errors.append(
f"License file not found for {dep_ref}. Either add a file named "
"LICENSE, import upstream's COPYING if available, or add a "
"'License File:' line to README.chromium with the appropriate paths.")
metadata["License File"] = license_paths
if errors:
# if there were any errors during parsing, clear all values from
# the dependenct metadata so no further processing occurs
metadata = {}
return errors
def ParseDir(path,
root,
require_license_file=True,
optional_keys=[],
enable_warnings=False,
metadata_file_names=METADATA_FILE_NAMES):
"""Examine a third_party path and extract that directory's metadata.
Note: directory metadata can contain metadata for multiple
dependencies.
Returns: A tuple with a list of directory metadata, and accrued parsing errors
"""
# Get the metadata values, from
# (a) looking up the path in SPECIAL_CASES; or
# (b) parsing the metadata from a README.chromium file.
if path in SPECIAL_CASES:
readme_path = f"licenses.py SPECIAL_CASES entry for {path}"
directory_metadata = dict(SPECIAL_CASES[path])
errors = ProcessMetadata(directory_metadata,
readme_path,
path,
root,
require_license_file=require_license_file,
enable_warnings=enable_warnings)
return [directory_metadata], errors
errors = []
readmes_in_dir = False
valid_metadata = []
directory_metadata = []
for name in metadata_file_names:
for readme_path in (pathlib.Path(root) / path).glob(name):
readmes_in_dir = True
try:
file_metadata = ParseMetadataFile(str(readme_path),
optional_fields=optional_keys)
for dependency_metadata in file_metadata:
meta_errors = ProcessMetadata(
dependency_metadata,
readme_path,
path,
root,
require_license_file=require_license_file,
enable_warnings=enable_warnings)
if meta_errors:
errors.append(
"Errors in %s:\n %s\n" %
(os.path.relpath(readme_path, root), ";\n ".join(meta_errors)))
continue
if dependency_metadata:
valid_metadata.append(dependency_metadata)
except InvalidMetadata as e:
errors.append(f"Invalid metadata file: {e}")
continue
if not readmes_in_dir:
raise LicenseError(f"missing third party metadata file "
f"or licenses.py SPECIAL_CASES entry in {path}\n")
return valid_metadata, errors
def process_license_files(
root: str,
path: str,
license_files: List[str],
) -> List[str]:
"""
Convert a list of license file paths which were specified in a
README.chromium to be absolute paths based on the source root.
Args:
root: the repository source root.
path: the relative path from root.
license_files: list of values specified in the 'License File' field.
Returns: absolute paths to license files that exist.
"""
license_paths = []
for file_path in license_files:
if file_path == NOT_SHIPPED:
continue
license_path = AbsolutePath(path, file_path, root)
# Check that the license file exists.
if license_path is not None:
license_paths.append(license_path)
# If there are no license files at all, check for the COPYING license file.
if not license_paths:
license_path = AbsolutePath(path, "COPYING", root)
# Check that the license file exists.
if license_path is not None:
license_paths.append(license_path)
return license_paths
def _ContainsFiles(path):
"""Determines whether any files exist in a directory or in any of its
subdirectories."""
for _, dirs, files in os.walk(path):
if files:
return True
for vcs_metadata in VCS_METADATA_DIRS:
if vcs_metadata in dirs:
dirs.remove(vcs_metadata)
return False
def _MaybeAddThirdPartyPath(root, dirpath, third_party_dirs):
"""Adds |dirpath| to |third_party_dirs| and processes
additional_readme_paths.json."""
# Prune paths and guard against cycles.
if dirpath in PRUNE_PATHS or dirpath in third_party_dirs:
return
# Guard against missing / empty dirs (gclient creates empty directories for
# conditionally downloaded submodules).
resolved_path = os.path.join(root, dirpath)
if not os.path.exists(resolved_path) or not _ContainsFiles(resolved_path):
return
third_party_dirs.add(dirpath)
additional_paths_file = os.path.join(root, dirpath, ADDITIONAL_PATHS_FILENAME)
if not os.path.exists(additional_paths_file):
return
with codecs.open(additional_paths_file, encoding='utf-8') as paths_file:
additional_paths = json.load(paths_file)
for p in additional_paths:
subpath = os.path.normpath(os.path.join(dirpath, p))
_MaybeAddThirdPartyPath(root, subpath, third_party_dirs)
def FindThirdPartyDirs(root, extra_third_party_dirs=None):
"""Find all third_party directories underneath the source root."""
third_party_dirs = set()
for path, dirs, files in os.walk(root):
path = path[len(root) + 1:] # Pretty up the path.
# .gitignore ignores /out*/, so do the same here.
if path in PRUNE_PATHS or path.startswith('out'):
dirs[:] = []
continue
# Don't recurse into paths in ADDITIONAL_PATHS, like we do with regular
# third_party/foo paths.
if path in ADDITIONAL_PATHS:
dirs[:] = []
# Prune out directories we want to skip.
# (Note that we loop over PRUNE_DIRS so we're not iterating over a
# list that we're simultaneously mutating.)
for skip in PRUNE_DIRS:
if skip in dirs:
dirs.remove(skip)
if os.path.basename(path) == 'third_party':
# Add all subdirectories that are not marked for skipping.
for d in dirs:
dirpath = os.path.join(path, d)
_MaybeAddThirdPartyPath(root, dirpath, third_party_dirs)
extra_paths = set(ADDITIONAL_PATHS)
if extra_third_party_dirs:
extra_paths.update(extra_third_party_dirs)
for path in extra_paths:
_MaybeAddThirdPartyPath(root, path, third_party_dirs)
return sorted(third_party_dirs)
# Many builders do not contain 'gn' in their PATH, so use the GN binary from
# //buildtools.
def _GnBinary():
exe = 'gn'
if sys.platform.startswith('linux'):
subdir = 'linux64'
elif sys.platform == 'darwin':
subdir = 'mac'
elif sys.platform == 'win32':
subdir, exe = 'win', 'gn.exe'
else:
raise RuntimeError("Unsupported platform '%s'." % sys.platform)
return os.path.join(_REPOSITORY_ROOT, 'buildtools', subdir, exe)
def LogParseDirErrors(errors):
"""Provides a convenience method for printing out the errors resulting
from running ParseDir() over a directory."""
for error in sorted(errors):
print(error)
def GetThirdPartyDepsFromGNDepsOutput(
gn_deps: str,
target_os: str,
extra_allowed_dirs: Optional[List[str]] = None):
"""Returns third_party/foo directories given the output of "gn desc deps".
Note that it always returns the direct sub-directory of third_party
where README.chromium and LICENSE files are, so that it can be passed to
ParseDir(). e.g.:
third_party/cld_3/src/src/BUILD.gn -> third_party/cld_3/
Rust dependencies are a special case, with a deeper structure:
third_party/rust/foo/v1/crate/BUILD.gn -> third_party/rust/foo/v1/
It returns relative paths from _REPOSITORY_ROOT, not absolute paths.
"""
allowed_paths_list = ['third_party']
if extra_allowed_dirs:
allowed_paths_list.extend(extra_allowed_dirs)
# Use non-capturing group with or's for all possible options.
allowed_paths = '|'.join([re.escape(x) for x in allowed_paths_list])
sep = re.escape(os.path.sep)
path_regex = re.compile(
r'''^
( # capture
(.+{sep})? # any prefix
(?:{allowed_paths}) # any of the allowed paths
{sep}
(?: # either..
rust{sep}{nonsep}+{sep}v{nonsep}+ # rust/<crate>/v<version>
|{nonsep}+) # or any single path element
{sep}
)
(.+{sep})?BUILD\.gn$ # with filename BUILD.gn
'''.format(allowed_paths=allowed_paths, sep=sep, nonsep=f'[^{sep}]'),
re.VERBOSE)
third_party_deps = set()
for absolute_build_dep in gn_deps.split():
relative_build_dep = os.path.relpath(absolute_build_dep, _REPOSITORY_ROOT)
m = path_regex.search(relative_build_dep)
if not m:
continue
third_party_path = m.group(1)
if any(third_party_path.startswith(p + os.sep) for p in PRUNE_PATHS):
continue
if (target_os == 'ios' and any(
third_party_path.startswith(p + os.sep)
for p in KNOWN_NON_IOS_LIBRARIES)):
# Skip over files that are known not to be used on iOS.
continue
third_party_deps.add(third_party_path[:-1])
return third_party_deps
def FindThirdPartyDeps(gn_out_dir: str,
gn_target: str,
target_os: str,
extra_third_party_dirs: Optional[List[str]] = None,
extra_allowed_dirs: Optional[List[str]] = None):
if not gn_out_dir:
raise RuntimeError("--gn-out-dir is required if --gn-target is used.")
# Generate gn project in temp directory and use it to find dependencies.
# Current gn directory cannot be used when we run this script in a gn action
# rule, because gn always evaluate *.gn/*.gni and causes side-effect
# by `write_file`, `exec_script` or so, and "gn desc" requires "gn gen".
# If only "args.gn", it fails with "ERROR Not a build directory."
with tempfile.TemporaryDirectory(
dir=os.path.join(gn_out_dir, '..')) as tmp_dir:
shutil.copy(os.path.join(gn_out_dir, "args.gn"), tmp_dir)
subprocess.check_output(
[_GnBinary(), "gen",
"--root=%s" % _REPOSITORY_ROOT, tmp_dir])
gn_deps = subprocess.check_output([
_GnBinary(), "desc",
"--root=%s" % _REPOSITORY_ROOT, tmp_dir, gn_target, "deps",
"--as=buildfile", "--all"
],
stderr=sys.stderr)
if isinstance(gn_deps, bytes):
gn_deps = gn_deps.decode("utf-8")
third_party_deps = GetThirdPartyDepsFromGNDepsOutput(gn_deps, target_os,
extra_allowed_dirs)
if extra_third_party_dirs:
third_party_deps.update(extra_third_party_dirs)
return sorted(third_party_deps)
def ScanThirdPartyDirs(root=None):
"""Scan a list of directories and report on any problems we find."""
if root is None:
root = os.getcwd()
third_party_dirs = FindThirdPartyDirs(root)
errors = []
for path in sorted(third_party_dirs):
try:
_, errors = ParseDir(path, root, enable_warnings=True)
except LicenseError as e:
errors.append(f"{path}: {e}")
continue
LogParseDirErrors(errors)
return len(errors) == 0
def GenerateCredits(file_template_file,
entry_template_file,
reciprocal_template_file,
output_file,
target_os,
gn_out_dir,
gn_target,
extra_third_party_dirs=None,
depfile=None,
enable_warnings=False):
"""Generate about:credits."""
def EvaluateTemplate(template, env, escape=True):
"""Expand a template with variables like {{foo}} using a
dictionary of expansions."""
for key, val in env.items():
if escape:
val = html.escape(val)
template = template.replace('{{%s}}' % key, val)
return template
def MetadataToTemplateEntry(metadata, entry_template):
licenses = []
for filepath in metadata['License File']:
licenses.append(
codecs.open(filepath, errors="replace", encoding='utf-8').read())
license_content = '\n\n'.join(licenses)
env = {
'name': metadata['Name'],
'url': metadata['URL'],
'license': license_content,
}
return {
'name': metadata['Name'],
'content': EvaluateTemplate(entry_template, env),
'license_file': metadata['License File'],
}
if gn_target:
third_party_dirs = FindThirdPartyDeps(gn_out_dir, gn_target, target_os,
extra_third_party_dirs)
# Sanity-check to raise a build error if invalid gn_... settings are
# somehow passed to this script.
if not third_party_dirs:
raise RuntimeError("No deps found.")
else:
third_party_dirs = FindThirdPartyDirs(_REPOSITORY_ROOT,
extra_third_party_dirs)
if not file_template_file:
file_template_file = os.path.join(_REPOSITORY_ROOT, 'components', 'webui',
'about', 'resources',
'about_credits.tmpl')
if not entry_template_file:
entry_template_file = os.path.join(_REPOSITORY_ROOT, 'components', 'webui',
'about', 'resources',
'about_credits_entry.tmpl')
# Used to add a link at the top of credits for Chromium code to
# satisfy the requirements for reciprocal license types.
if not reciprocal_template_file: