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
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#############################################################################
##
## Copyright (C) 2022 The Qt Company Ltd.
## Contact: https://www.qt.io/licensing/
##
## This file is part of the release tools of the Qt Toolkit.
##
## $QT_BEGIN_LICENSE:GPL-EXCEPT$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and The Qt Company. For licensing terms
## and conditions see https://www.qt.io/terms-conditions. For further
## information use the contact form at https://www.qt.io/contact-us.
##
## GNU General Public License Usage
## Alternatively, this file may be used under the terms of the GNU
## General Public License version 3 as published by the Free Software
## Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
## included in the packaging of this file. Please review the following
## information to ensure the GNU General Public License requirements will
## be met: https://www.gnu.org/licenses/gpl-3.0.html.
##
## $QT_END_LICENSE$
##
#############################################################################
import os
import sys
import ntpath
import bldinstallercommon
ONLINE_ARCHIVE_LIST_TAG = '<!--ONLINE_ARCHIVE_LIST-->'
class SdkComponent:
"""SdkComponent class contains all required info for one installable SDK component"""
class DownloadableArchive:
"""DownloadableArchive subclass contains all required info about data packages for one SDK component"""
def __init__(self, archive, package_name, parent_target_install_base, archive_server_name, target_config, archive_location_resolver, key_value_substitution_list):
self.archive_uri = bldinstallercommon.config_section_map(target_config, archive)['archive_uri']
self.archive_action = bldinstallercommon.safe_config_key_fetch(target_config, archive, 'archive_action')
self.extract_archive = bldinstallercommon.safe_config_key_fetch(target_config, archive, 'extract_archive')
self.package_strip_dirs = bldinstallercommon.safe_config_key_fetch(target_config, archive, 'package_strip_dirs')
self.package_finalize_items = bldinstallercommon.safe_config_key_fetch(target_config, archive, 'package_finalize_items')
# parent's 'target_install_base'
self.parent_target_install_base = parent_target_install_base
# in case the individual archive needs to be installed outside the root dir specified by the parent component
self.target_install_base = bldinstallercommon.safe_config_key_fetch(target_config, archive, 'target_install_base')
# this is relative to 1) current archive's 'target_install_base' 2) parent components 'target_install_base'. (1) takes priority
self.target_install_dir = bldinstallercommon.safe_config_key_fetch(target_config, archive, 'target_install_dir').lstrip(os.path.sep)
self.rpath_target = bldinstallercommon.safe_config_key_fetch(target_config, archive, 'rpath_target')
self.component_sha1_file = bldinstallercommon.safe_config_key_fetch(target_config, archive, 'component_sha1_file')
self.nomalize_archive_uri(package_name, archive_server_name, archive_location_resolver)
self.archive_name = bldinstallercommon.safe_config_key_fetch(target_config, archive, 'archive_name')
if not self.archive_name:
self.archive_name = self.path_leaf(self.archive_uri)
# Parse unnecessary extensions away from filename (QTBUG-39219)
known_archive_types = ['.tar.gz', '.tar', '.zip', '.tar.xz', '.tar.bz2']
for item in known_archive_types:
if self.archive_name.endswith(item):
self.archive_name = self.archive_name.replace(item, '')
if not self.archive_name.endswith('.7z'):
self.archive_name += '.7z'
# substitute key-value pairs if any
for item in key_value_substitution_list:
self.target_install_base = self.target_install_base.replace(item[0], item[1])
self.target_install_dir = self.target_install_dir.replace(item[0], item[1])
self.archive_name = self.archive_name.replace(item[0], item[1])
def nomalize_archive_uri(self, package_name, archive_server_name, archive_location_resolver):
self.archive_uri = archive_location_resolver.resolve_full_uri(package_name, archive_server_name, self.archive_uri)
def check_archive_data(self):
if self.archive_uri.startswith('http'):
res = bldinstallercommon.is_content_url_valid(self.archive_uri)
if not res:
return '*** Archive check fail! ***\n*** Unable to locate archive: ' + self.archive_uri
elif not os.path.isfile(self.archive_uri):
return '*** Archive check fail! ***\n*** Unable to locate archive: ' + self.archive_uri
def path_leaf(self, path):
head, tail = ntpath.split(path)
return tail or ntpath.basename(head)
def get_archive_installation_directory(self):
if self.target_install_base:
return self.target_install_base + os.path.sep + self.target_install_dir
else:
return self.parent_target_install_base + os.path.sep + self.target_install_dir
def __init__(self, section_name, target_config, packages_full_path_list, archive_location_resolver, key_value_substitution_list, is_offline_build):
self.static_component = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'static_component')
self.root_component = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'root_component')
self.package_name = section_name
self.package_subst_name = section_name
self.packages_full_path_list = packages_full_path_list
self.archives = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'archives')
self.archives = self.archives.replace(' ', '').replace('\n', '')
self.archives_extract_dir = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'archives_extract_dir')
self.archive_server_name = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'archive_server_name')
self.downloadable_archive_list = []
self.target_install_base = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'target_install_base')
self.version = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'version')
self.version_tag = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'version_tag')
self.package_default = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'package_default')
self.install_priority = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'install_priority')
self.sorting_priority = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'sorting_priority')
self.component_sha1 = ""
self.component_sha1_uri = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'component_sha1_uri')
if (self.component_sha1_uri):
self.component_sha1_uri = archive_location_resolver.resolve_full_uri(self.package_name, self.archive_server_name, self.component_sha1_uri)
self.optional_for_offline = False
self.key_value_substitution_list = key_value_substitution_list
self.archive_skip = False
self.include_filter = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'include_filter')
if is_offline_build:
tmp = bldinstallercommon.safe_config_key_fetch(target_config, section_name, 'optional_for_offline')
for item in self.key_value_substitution_list:
tmp = tmp.replace(item[0], item[1])
if tmp.lower() in ['yes', 'true', '1']:
self.optional_for_offline = True
self.downloadable_arch_list_qs = []
self.pkg_template_dir = ''
self.sanity_check_error_msg = ''
self.target_config = target_config
self.archive_location_resolver = archive_location_resolver
# substitute key-value pairs if any
for item in self.key_value_substitution_list:
self.target_install_base = self.target_install_base.replace(item[0], item[1])
self.version = self.version.replace(item[0], item[1])
def is_root_component(self):
if self.root_component == 'yes' or self.root_component == 'true':
return True
return False
def setArchiveSkip(self, doSkip):
self.archive_skip = doSkip
def validate(self):
# look up correct package template directory from list
found = False
for item in self.key_value_substitution_list:
self.package_name = self.package_name.replace(item[0], item[1])
for item in self.packages_full_path_list:
template_full_path = os.path.normpath(item + os.sep + self.package_subst_name)
if os.path.exists(template_full_path):
if not found:
# take the first match
self.pkg_template_dir = template_full_path
found = True
else:
# sanity check, duplicate template should not exist to avoid
# problems!
print ('*** Found duplicate template for: ' + self.package_name)
print ('*** Ignoring: ' + template_full_path)
print ('*** Using: ' + self.pkg_template_dir)
self.parse_archives(self.target_config, self.archive_location_resolver)
self.check_component_data(self.target_config)
def check_component_data(self, target_config):
if self.static_component:
if not os.path.isfile(self.static_component):
self.sanity_check_fail(self.package_name, 'Unable to locate given static package: ' + self.static_component)
return
# no more checks needed for static component
return
if not self.package_name:
self.sanity_check_fail(self.package_name, 'Undefined package name?')
return
if self.archives and not self.target_install_base:
self.sanity_check_fail(self.package_name, 'Undefined target_install_base?')
return
if self.version and not self.version_tag:
self.sanity_check_fail(self.package_name, 'Undefined version_tag?')
return
if self.version_tag and not self.version:
self.sanity_check_fail(self.package_name, 'Undefined version?')
return
if self.package_default not in ['true', 'false', 'script']:
self.package_default = 'false'
# check that package template exists
if not os.path.exists(self.pkg_template_dir):
self.sanity_check_fail(self.package_name, 'Package template dir does not exist: ' + self.pkg_template_dir)
return
if not self.archive_skip:
# next check that archive locations exist
for archive in self.downloadable_archive_list:
error_msg = archive.check_archive_data()
if error_msg:
if self.optional_for_offline:
print('!!! Package: [{0}] Given data archive not found: [{1}] But this component was marked optional -> keep going'.format(self.package_name, archive.archive_uri))
self.sanity_check_fail(self.package_name, 'Given data archive not found: [{0}] But this component was marked optional'.format(archive.archive_uri))
return
else:
self.sanity_check_fail(self.package_name, error_msg)
return
def sanity_check_fail(self, component_name, message):
self.sanity_check_error_msg = '*** Sanity check fail! ***\n*** Component: [' + component_name + ']\n*** ' + message
def is_valid(self):
if self.sanity_check_error_msg:
return False
else:
return True
def error_msg(self):
return self.sanity_check_error_msg
def optional_for_offline_installer(self):
return self.optional_for_offline
def parse_archives(self, target_config, archive_location_resolver):
if self.archives:
archives_list = self.archives.split(',')
for archive in archives_list:
if not archive:
print ("Warning: There appears to be ',' issues in the config file archive list for component: ", self.package_name)
continue
# check that archive template exists
if not target_config.has_section(archive):
raise RuntimeError('*** Error! Given archive section does not exist in configuration file: %s' % archive)
archive_obj = SdkComponent.DownloadableArchive(archive, self.package_name, self.target_install_base, self.archive_server_name,
target_config, archive_location_resolver,
self.key_value_substitution_list)
self.downloadable_archive_list.append(archive_obj)
def generate_downloadable_archive_list(self):
"""Generate list that is embedded into package.xml"""
output = ''
for item in self.downloadable_archive_list:
if not output:
output = item.archive_name
else:
output = output + ', ' + item.archive_name
temp_list = []
temp_list.append([ONLINE_ARCHIVE_LIST_TAG, output])
return temp_list
def print_component_data(self):
print ('=============================================================')
print (' [' + self.package_name + ']')
if self.static_component:
print (' Static component: ' + self.static_component)
return
if self.root_component:
print (' Root component: ' + self.root_component)
print (' Include filter: ' + self.include_filter)
print (' Target install base: ' + self.target_install_base)
print (' Version: ' + self.version)
print (' Version tag: ' + self.version_tag)
print (' Package default: ' + self.package_default)
if self.downloadable_archive_list:
print (' Archives:')
for archive in self.downloadable_archive_list:
print (' ---------------------------------------------------------------')
print (' Downloadable archive name: ' + archive.archive_name)
print (' Archive strip dirs: ' + archive.package_strip_dirs)
print (' Archive target install dir: ' + archive.get_archive_installation_directory())
print (' Archive RPath target: ' + archive.rpath_target)
print (' Archive URI: ' + archive.archive_uri)
|
