-
Notifications
You must be signed in to change notification settings - Fork 862
/
generate_licenses.py
executable file
·245 lines (193 loc) · 8.85 KB
/
generate_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
#!/usr/bin/env python3
# Copyright (c) 2020 The Brave Authors. All rights reserved.
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at https://mozilla.org/MPL/2.0/. */
import json
import os
import sys
from io import open
from lib.config import SOURCE_ROOT
KNOWN_MISSING = [
# Emailed author (henrik@schack.dk) on 2019-11-05.
os.path.join('components', 'third_party',
'adblock', 'lists', 'adblock_dk'),
# https://github.com/gfmaster/adblock-korea-contrib/issues/47
os.path.join('components', 'third_party', 'adblock',
'lists', 'adblock_korea_contrib'),
]
def extract_license_info(directory):
readme_path = os.path.join(directory, 'README.chromium')
if not os.path.isfile(readme_path):
print(f'Missing README.chromium in {directory}')
sys.exit(1)
metadata = {
'slug': os.path.basename(directory),
'Name': None,
'URL': None,
'License': None,
'License File': None,
'License Text': None,
}
with open(readme_path, mode='rt', encoding='utf-8') as file_handle:
for line in file_handle:
for field in metadata:
if f'{field}:' in line:
metadata[field] = line[len(field) + 1:].strip()
break
if not metadata['License File']:
license_path = os.path.join(directory, 'LICENSE')
if os.path.isfile(license_path):
with open(license_path, mode='rt', encoding='utf-8') as file_handle:
metadata['License Text'] = file_handle.read()
elif metadata['License'] == 'unknown':
relative_dir = directory[len(SOURCE_ROOT) + 1:]
if relative_dir not in KNOWN_MISSING:
print(f'Unknown license is not whitelisted: {relative_dir}')
sys.exit(1)
else:
print(metadata)
print(f'Missing LICENSE in {directory}')
sys.exit(1)
return metadata
def read_license_text(filename):
# README.chromium files assume UNIX path separators.
full_path = os.path.dirname(SOURCE_ROOT)
for piece in filename.split('/'):
full_path = os.path.join(full_path, piece)
if not os.path.isfile(full_path):
print(f'License file not found: {full_path}')
sys.exit(1)
with open(full_path, mode='rt', encoding='utf-8') as file_handle:
return file_handle.read()
def external_component_license_file(preamble, components):
component_notices = ''
component_licenses = ''
licenses = {}
for component in components:
if component_notices:
component_notices += '\n'
license_id = component['License']
license_text = component['License Text']
if license_text:
# Custom license
license_id += '-' + component['slug']
component_notices += f"Name: {component['Name']}\n" \
f"URL: {component['URL']}\n" \
f"License: {license_id}\n"
if license_id == 'unknown':
continue
if license_id not in licenses:
if license_text:
licenses[license_id] = license_text
else:
licenses[license_id] = read_license_text(
component['License File'])
for (license_id, license_text) in licenses.items():
component_licenses += '----------------------------------------' \
'----------------------------------------\n'
component_licenses += f'{license_id}:\n\n'
component_licenses += f'{license_text}\n'
return f'{preamble}\n\n{component_notices}\n{component_licenses}'
def list_sub_components(base_dir):
found = []
for dirpath, dirs, dummy in os.walk(base_dir):
for dir_name in sorted(dirs):
found.append(extract_license_info(os.path.join(dirpath, dir_name)))
return found
def write_license_file(directory, contents):
file_path = os.path.join(directory, 'LICENSE')
if os.path.isfile(file_path):
with open(file_path, mode='r', encoding='utf-8') as file_handle:
old_contents = file_handle.read()
if old_contents == contents:
return False # Don't overwrite file needlessly.
with open(file_path, mode='wt', encoding='utf-8') as file_handle:
file_handle.write(contents)
return True
def list_ntp_backgrounds(metadata_file):
json_metadata = ''
with open(metadata_file, mode='rt', encoding='utf-8') as file_handle:
# Extract only the background images.
metadata = file_handle.readlines()[3:12]
# Hack to turn this TypeScript file into valid JSON
json_metadata = "".join(metadata) \
.replace("export const images: NewTab.BraveBackground[] = [",
"[") \
.replace('"', '"').replace("'", '"')
images = json.loads(json_metadata)
return images
def validated_data_field(data, field_name):
field_value = data[field_name]
if not field_value:
print(f"Missing {field_name} for background image {data['name']}")
sys.exit(1)
return field_value
def generate_backgrounds_license(preamble, backgrounds):
notices = ''
for background in backgrounds:
if notices:
notices += '\n'
filename = validated_data_field(background, 'wallpaperImageUrl')
author_name = validated_data_field(background, 'author')
# Don't validate link. it can be empty.
author_link = background['link']
original_url = validated_data_field(background, 'originalUrl')
license_text = validated_data_field(background, 'license')
if license_text != 'used with permission' \
and license_text[0:8] != 'https://' \
and license_text[0:7] != 'http://':
print('Invalid license for background image ' \
f"{background['name']}. It needs to be a URL or the " \
'string "used with permission".')
sys.exit(1)
if author_link != '':
notices += f'File: {filename}\nAuthor: {author_name} ' \
f'({author_link})\nURL: {original_url}\n' \
f'License: {license_text}\n'
else:
notices += f'File: {filename}\nAuthor: {author_name}\n' \
f'URL: {original_url}\nLicense: {license_text}\n'
return f'{preamble}\n\n{notices}'
def main():
components_dir = os.path.join(SOURCE_ROOT, 'components')
third_party_dir = os.path.join(components_dir, 'third_party')
# Brave Ad Block component
adblock_dir = os.path.join(third_party_dir, 'adblock')
adblock_lists_dir = os.path.join(adblock_dir, 'lists')
adblock_preamble = 'These licenses do not apply to any of the code ' \
'shipped with the Brave Browser, but may apply to lists downloaded ' \
'after installation for use with the Brave Shields feature. The ' \
'Brave Browser and such lists are separate and independent works.'
adblock_components = list_sub_components(adblock_lists_dir)
if write_license_file(adblock_dir, external_component_license_file(
adblock_preamble, adblock_components)):
print(f'- {len(adblock_components)} sub-components added in ' \
'adblock/LICENSE')
# Brave Local Data component
local_data_dir = os.path.join(third_party_dir, 'local_data')
local_data_lists_dir = os.path.join(local_data_dir, 'lists')
local_data_preamble = 'These licenses do not apply to any of the code ' \
'shipped with the Brave Browser, but may apply to data files ' \
'downloaded after installation for use with various Brave features. ' \
'The Brave Browser and such data files are separate and independent ' \
'works.'
local_data_components = list_sub_components(local_data_lists_dir)
if write_license_file(local_data_dir, external_component_license_file(
local_data_preamble, local_data_components)):
print(f'- {len(local_data_components)} sub-components added in ' \
'local_data/LICENSE')
# Brave New Tab UI component
ntp_data_dir = os.path.join(components_dir, 'brave_new_tab_ui', 'data')
ntp_backgrounds_preamble = 'These licenses do not apply to any of the ' \
'code shipped with the Brave Browser and instead apply to ' \
'background images used on the new tab page. The Brave Browser and ' \
'such data files are separate and independent works.'
ntp_backgrounds = list_ntp_backgrounds(
os.path.join(ntp_data_dir, 'backgrounds.ts'))
if write_license_file(ntp_data_dir, generate_backgrounds_license(
ntp_backgrounds_preamble, ntp_backgrounds)):
print(f'- {len(ntp_backgrounds)} sub-components added in ' \
'brave_new_tab_ui/data/LICENSE')
if __name__ == '__main__':
sys.exit(main())