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
|
# 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 http://mozilla.org/MPL/2.0/.
import datetime
import json
import logging
import os
import shutil
import subprocess
import tarfile
import tempfile
import zipfile
from email.utils import format_datetime
from pathlib import Path
from string import Template
import mozfile
import mozpack.path as mozpath
import requests
from mozilla_version.gecko import GeckoVersion
from redo import retry
from mozbuild.repackaging.application_ini import get_application_ini_values
class NoDebPackageFound(Exception):
"""Raised when no .deb is found after calling dpkg-buildpackage"""
def __init__(self, deb_file_path) -> None:
super().__init__(
f"No {deb_file_path} package found after calling dpkg-buildpackage"
)
class HgServerError(Exception):
"""Raised when Hg responds with an error code that is not 404 (i.e. when there is an outage)"""
def __init__(self, msg) -> None:
super().__init__(msg)
_DEB_ARCH = {
"all": "all",
"x86": "i386",
"x86_64": "amd64",
}
# At the moment the Firefox build baseline is jessie.
# The debian-repackage image defined in taskcluster/docker/debian-repackage/Dockerfile
# bootstraps the /srv/jessie-i386 and /srv/jessie-amd64 chroot environments we use to
# create the `.deb` repackages. By running the repackage using chroot we generate shared
# library dependencies that match the Firefox build baseline
# defined in taskcluster/scripts/misc/build-sysroot.sh
_DEB_DIST = "jessie"
def repackage_deb(
log,
infile,
output,
template_dir,
arch,
version,
build_number,
release_product,
release_type,
fluent_localization,
fluent_resource_loader,
):
if not tarfile.is_tarfile(infile):
raise Exception("Input file %s is not a valid tarfile." % infile)
tmpdir = _create_temporary_directory(arch)
source_dir = os.path.join(tmpdir, "source")
try:
mozfile.extract_tarball(infile, source_dir)
application_ini_data = _load_application_ini_data(infile, version, build_number)
build_variables = _get_build_variables(
application_ini_data,
arch,
depends="${shlibs:Depends},",
release_product=release_product,
)
_copy_plain_deb_config(template_dir, source_dir)
_render_deb_templates(
template_dir,
source_dir,
build_variables,
exclude_file_names=["package-prefs.js"],
)
app_name = application_ini_data["name"]
with open(
mozpath.join(source_dir, app_name.lower(), "is-packaged-app"), "w"
) as f:
f.write("This is a packaged app.\n")
_inject_deb_distribution_folder(source_dir, app_name)
_inject_deb_desktop_entry_file(
log,
source_dir,
build_variables,
release_product,
release_type,
fluent_localization,
fluent_resource_loader,
)
_inject_deb_prefs_file(source_dir, app_name, template_dir)
_generate_deb_archive(
source_dir,
target_dir=tmpdir,
output_file_path=output,
build_variables=build_variables,
arch=arch,
)
finally:
shutil.rmtree(tmpdir)
def repackage_deb_l10n(
input_xpi_file,
input_tar_file,
output,
template_dir,
version,
build_number,
release_product,
):
arch = "all"
tmpdir = _create_temporary_directory(arch)
source_dir = os.path.join(tmpdir, "source")
try:
langpack_metadata = _extract_langpack_metadata(input_xpi_file)
langpack_dir = mozpath.join(source_dir, "firefox", "distribution", "extensions")
application_ini_data = _load_application_ini_data(
input_tar_file, version, build_number
)
langpack_id = langpack_metadata["langpack_id"]
if release_product == "devedition":
depends = (
f"firefox-devedition (= {application_ini_data['deb_pkg_version']})"
)
else:
depends = f"{application_ini_data['remoting_name']} (= {application_ini_data['deb_pkg_version']})"
build_variables = _get_build_variables(
application_ini_data,
arch,
depends=depends,
# Debian package names are only lowercase
package_name_suffix=f"-l10n-{langpack_id.lower()}",
description_suffix=f" - {langpack_metadata['description']}",
release_product=release_product,
)
_copy_plain_deb_config(template_dir, source_dir)
_render_deb_templates(template_dir, source_dir, build_variables)
os.makedirs(langpack_dir, exist_ok=True)
shutil.copy(
input_xpi_file,
mozpath.join(
langpack_dir,
f"{langpack_metadata['browser_specific_settings']['gecko']['id']}.xpi",
),
)
_generate_deb_archive(
source_dir=source_dir,
target_dir=tmpdir,
output_file_path=output,
build_variables=build_variables,
arch=arch,
)
finally:
shutil.rmtree(tmpdir)
def _extract_application_ini_data(input_tar_file):
with tempfile.TemporaryDirectory() as d:
with tarfile.open(input_tar_file) as tar:
application_ini_files = [
tar_info
for tar_info in tar.getmembers()
if tar_info.name.endswith("/application.ini")
]
if len(application_ini_files) == 0:
raise ValueError(
f"Cannot find any application.ini file in archive {input_tar_file}"
)
if len(application_ini_files) > 1:
raise ValueError(
f"Too many application.ini files found in archive {input_tar_file}. "
f"Found: {application_ini_files}"
)
tar.extract(application_ini_files[0], path=d)
application_ini_data = _extract_application_ini_data_from_directory(d)
return application_ini_data
def _load_application_ini_data(infile, version, build_number):
extracted_application_ini_data = _extract_application_ini_data(infile)
parsed_application_ini_data = _parse_application_ini_data(
extracted_application_ini_data, version, build_number
)
return parsed_application_ini_data
def _parse_application_ini_data(application_ini_data, version, build_number):
application_ini_data["timestamp"] = datetime.datetime.strptime(
application_ini_data["build_id"], "%Y%m%d%H%M%S"
)
application_ini_data["remoting_name"] = application_ini_data[
"remoting_name"
].lower()
application_ini_data["deb_pkg_version"] = _get_deb_pkg_version(
version, application_ini_data["build_id"], build_number
)
return application_ini_data
def _get_deb_pkg_version(version, build_id, build_number):
gecko_version = GeckoVersion.parse(version)
deb_pkg_version = (
f"{gecko_version}~{build_id}"
if gecko_version.is_nightly
else f"{gecko_version}~build{build_number}"
)
return deb_pkg_version
def _extract_application_ini_data_from_directory(application_directory):
values = get_application_ini_values(
application_directory,
dict(section="App", value="Name"),
dict(section="App", value="CodeName", fallback="Name"),
dict(section="App", value="Vendor"),
dict(section="App", value="RemotingName"),
dict(section="App", value="BuildID"),
)
data = {
"name": next(values),
"display_name": next(values),
"vendor": next(values),
"remoting_name": next(values),
"build_id": next(values),
}
return data
def _get_build_variables(
application_ini_data,
arch,
depends,
package_name_suffix="",
description_suffix="",
release_product="",
):
if release_product == "devedition":
deb_pkg_install_path = "usr/lib/firefox-devedition"
deb_pkg_name = f"firefox-devedition{package_name_suffix}"
else:
deb_pkg_install_path = f"usr/lib/{application_ini_data['remoting_name']}"
deb_pkg_name = f"{application_ini_data['remoting_name']}{package_name_suffix}"
return {
"DEB_DESCRIPTION": f"{application_ini_data['vendor']} {application_ini_data['display_name']}"
f"{description_suffix}",
"DEB_PKG_INSTALL_PATH": deb_pkg_install_path,
"DEB_PKG_NAME": deb_pkg_name,
"DEB_PKG_VERSION": application_ini_data["deb_pkg_version"],
"DEB_CHANGELOG_DATE": format_datetime(application_ini_data["timestamp"]),
"DEB_ARCH_NAME": _DEB_ARCH[arch],
"DEB_DEPENDS": depends,
}
def _copy_plain_deb_config(input_template_dir, source_dir):
template_dir_filenames = os.listdir(input_template_dir)
plain_filenames = [
mozpath.basename(filename)
for filename in template_dir_filenames
if not filename.endswith(".in") and not filename.endswith(".js")
]
os.makedirs(mozpath.join(source_dir, "debian"), exist_ok=True)
for filename in plain_filenames:
shutil.copy(
mozpath.join(input_template_dir, filename),
mozpath.join(source_dir, "debian", filename),
)
def _render_deb_templates(
input_template_dir, source_dir, build_variables, exclude_file_names=None
):
exclude_file_names = [] if exclude_file_names is None else exclude_file_names
template_dir_filenames = os.listdir(input_template_dir)
template_filenames = [
mozpath.basename(filename)
for filename in template_dir_filenames
if filename.endswith(".in") and filename not in exclude_file_names
]
os.makedirs(mozpath.join(source_dir, "debian"), exist_ok=True)
for file_name in template_filenames:
with open(mozpath.join(input_template_dir, file_name)) as f:
template = Template(f.read())
with open(mozpath.join(source_dir, "debian", Path(file_name).stem), "w") as f:
f.write(template.substitute(build_variables))
def _inject_deb_distribution_folder(source_dir, app_name):
with tempfile.TemporaryDirectory() as git_clone_dir:
subprocess.check_call(
[
"git",
"clone",
"https://github.com/mozilla-partners/deb.git",
git_clone_dir,
],
)
shutil.copytree(
mozpath.join(git_clone_dir, "desktop/deb/distribution"),
mozpath.join(source_dir, app_name.lower(), "distribution"),
)
def _inject_deb_prefs_file(source_dir, app_name, template_dir):
src = mozpath.join(template_dir, "package-prefs.js")
dst = mozpath.join(source_dir, app_name.lower(), "defaults/pref")
shutil.copy(src, dst)
def _inject_deb_desktop_entry_file(
log,
source_dir,
build_variables,
release_product,
release_type,
fluent_localization,
fluent_resource_loader,
):
desktop_entry_file_text = _generate_browser_desktop_entry_file_text(
log,
build_variables,
release_product,
release_type,
fluent_localization,
fluent_resource_loader,
)
desktop_entry_file_filename = f"{build_variables['DEB_PKG_NAME']}.desktop"
os.makedirs(mozpath.join(source_dir, "debian"), exist_ok=True)
with open(
mozpath.join(source_dir, "debian", desktop_entry_file_filename), "w"
) as f:
f.write(desktop_entry_file_text)
def _generate_browser_desktop_entry_file_text(
log,
build_variables,
release_product,
release_type,
fluent_localization,
fluent_resource_loader,
):
localizations = _create_fluent_localizations(
fluent_resource_loader, fluent_localization, release_type, release_product, log
)
desktop_entry = _generate_browser_desktop_entry(build_variables, localizations)
desktop_entry_file_text = "\n".join(desktop_entry)
return desktop_entry_file_text
def _create_fluent_localizations(
fluent_resource_loader, fluent_localization, release_type, release_product, log
):
brand_fluent_filename = "brand.ftl"
l10n_central_url = "https://hg.mozilla.org/l10n-central"
desktop_entry_fluent_filename = "linuxDesktopEntry.ftl"
l10n_dir = tempfile.mkdtemp()
loader = fluent_resource_loader(os.path.join(l10n_dir, "{locale}"))
localizations = {}
linux_l10n_changesets = _load_linux_l10n_changesets(
"browser/locales/l10n-changesets.json"
)
locales = ["en-US"]
locales.extend(linux_l10n_changesets.keys())
en_US_brand_fluent_filename = _get_en_US_brand_fluent_filename(
brand_fluent_filename, release_type, release_product
)
for locale in locales:
locale_dir = os.path.join(l10n_dir, locale)
os.mkdir(locale_dir)
localized_desktop_entry_filename = os.path.join(
locale_dir, desktop_entry_fluent_filename
)
if locale == "en-US":
en_US_desktop_entry_fluent_filename = os.path.join(
"browser", "locales", "en-US", "browser", desktop_entry_fluent_filename
)
shutil.copyfile(
en_US_desktop_entry_fluent_filename,
localized_desktop_entry_filename,
)
else:
non_en_US_fluent_resource_file_url = f"{l10n_central_url}/{locale}/raw-file/{linux_l10n_changesets[locale]['revision']}/browser/browser/{desktop_entry_fluent_filename}"
response = requests.get(non_en_US_fluent_resource_file_url)
response = retry(
requests.get,
args=[non_en_US_fluent_resource_file_url],
attempts=5,
sleeptime=3,
jitter=2,
)
mgs = "Missing {fluent_resource_file_name} for {locale}: received HTTP {status_code} for GET {resource_file_url}"
params = {
"fluent_resource_file_name": desktop_entry_fluent_filename,
"locale": locale,
"resource_file_url": non_en_US_fluent_resource_file_url,
"status_code": response.status_code,
}
action = "repackage-deb"
if response.status_code == 404:
log(
logging.WARNING,
action,
params,
mgs,
)
continue
if response.status_code != 200:
log(
logging.ERROR,
action,
params,
mgs,
)
raise HgServerError(mgs.format(**params))
with open(localized_desktop_entry_filename, "w", encoding="utf-8") as f:
f.write(response.text)
shutil.copyfile(
en_US_brand_fluent_filename,
os.path.join(locale_dir, brand_fluent_filename),
)
fallbacks = [locale]
if locale != "en-US":
fallbacks.append("en-US")
localizations[locale] = fluent_localization(
fallbacks, [desktop_entry_fluent_filename, brand_fluent_filename], loader
)
return localizations
def _get_en_US_brand_fluent_filename(
brand_fluent_filename, release_type, release_product
):
branding_fluent_filename_template = os.path.join(
"browser/branding/{brand}/locales/en-US", brand_fluent_filename
)
if release_type == "nightly":
return branding_fluent_filename_template.format(brand="nightly")
elif release_type == "release" or release_type == "release-rc":
return branding_fluent_filename_template.format(brand="official")
elif release_type == "beta" and release_product == "firefox":
return branding_fluent_filename_template.format(brand="official")
elif release_type == "beta" and release_product == "devedition":
return branding_fluent_filename_template.format(brand="aurora")
else:
return branding_fluent_filename_template.format(brand="unofficial")
def _load_linux_l10n_changesets(l10n_changesets_filename):
with open(l10n_changesets_filename) as l10n_changesets_file:
l10n_changesets = json.load(l10n_changesets_file)
return {
locale: changeset
for locale, changeset in l10n_changesets.items()
if any(platform.startswith("linux") for platform in changeset["platforms"])
}
def _generate_browser_desktop_entry(build_variables, localizations):
mime_types = [
"application/json",
"application/pdf",
"application/rdf+xml",
"application/rss+xml",
"application/x-xpinstall",
"application/xhtml+xml",
"application/xml",
"audio/flac",
"audio/ogg",
"audio/webm",
"image/avif",
"image/gif",
"image/jpeg",
"image/png",
"image/svg+xml",
"image/webp",
"text/html",
"text/xml",
"video/ogg",
"video/webm",
"x-scheme-handler/chrome",
"x-scheme-handler/http",
"x-scheme-handler/https",
"x-scheme-handler/mailto",
]
categories = [
"GNOME",
"GTK",
"Network",
"WebBrowser",
]
actions = [
{
"name": "new-window",
"message": "desktop-action-new-window-name",
"command": f"{build_variables['DEB_PKG_NAME']} --new-window %u",
},
{
"name": "new-private-window",
"message": "desktop-action-new-private-window-name",
"command": f"{build_variables['DEB_PKG_NAME']} --private-window %u",
},
{
"name": "open-profile-manager",
"message": "desktop-action-open-profile-manager",
"command": f"{build_variables['DEB_PKG_NAME']} --ProfileManager",
},
]
desktop_entry = _desktop_entry_section(
"Desktop Entry",
[
{
"key": "Version",
"value": "1.0",
},
{
"key": "Type",
"value": "Application",
},
{
"key": "Exec",
"value": f"{build_variables['DEB_PKG_NAME']} %u",
},
{
"key": "Terminal",
"value": "false",
},
{
"key": "X-MultipleArgs",
"value": "false",
},
{
"key": "Icon",
"value": build_variables["DEB_PKG_NAME"],
},
{
"key": "StartupWMClass",
"value": "firefox-aurora"
if build_variables["DEB_PKG_NAME"] == "firefox-devedition"
else build_variables["DEB_PKG_NAME"],
},
{
"key": "Categories",
"value": _desktop_entry_list(categories),
},
{
"key": "MimeType",
"value": _desktop_entry_list(mime_types),
},
{
"key": "StartupNotify",
"value": "true",
},
{
"key": "Actions",
"value": _desktop_entry_list([action["name"] for action in actions]),
},
{"key": "Name", "value": "desktop-entry-name", "l10n": True},
{"key": "Comment", "value": "desktop-entry-comment", "l10n": True},
{"key": "GenericName", "value": "desktop-entry-generic-name", "l10n": True},
{"key": "Keywords", "value": "desktop-entry-keywords", "l10n": True},
{
"key": "X-GNOME-FullName",
"value": "desktop-entry-x-gnome-full-name",
"l10n": True,
},
],
localizations,
)
for action in actions:
desktop_entry.extend(
_desktop_entry_section(
f"Desktop Action {action['name']}",
[
{
"key": "Name",
"value": action["message"],
"l10n": True,
},
{
"key": "Exec",
"value": action["command"],
},
],
localizations,
)
)
return desktop_entry
def _desktop_entry_list(iterable):
delimiter = ";"
return f"{delimiter.join(iterable)}{delimiter}"
def _desktop_entry_attribute(key, value, locale=None, localizations=None):
if not locale and not localizations:
return f"{key}={value}"
if locale and locale == "en-US":
return f"{key}={localizations[locale].format_value(value)}"
else:
return f"{key}[{locale.replace('-', '_')}]={localizations[locale].format_value(value)}"
def _desktop_entry_section(header, attributes, localizations):
desktop_entry_section = [f"[{header}]"]
l10n_attributes = [attribute for attribute in attributes if attribute.get("l10n")]
non_l10n_attributes = [
attribute for attribute in attributes if not attribute.get("l10n")
]
for attribute in non_l10n_attributes:
desktop_entry_section.append(
_desktop_entry_attribute(attribute["key"], attribute["value"])
)
for attribute in l10n_attributes:
for locale in localizations:
desktop_entry_section.append(
_desktop_entry_attribute(
attribute["key"], attribute["value"], locale, localizations
)
)
desktop_entry_section.append("")
return desktop_entry_section
def _generate_deb_archive(
source_dir, target_dir, output_file_path, build_variables, arch
):
command = _get_command(arch)
subprocess.check_call(command, cwd=source_dir)
deb_arch = _DEB_ARCH[arch]
deb_file_name = f"{build_variables['DEB_PKG_NAME']}_{build_variables['DEB_PKG_VERSION']}_{deb_arch}.deb"
deb_file_path = mozpath.join(target_dir, deb_file_name)
if not os.path.exists(deb_file_path):
raise NoDebPackageFound(deb_file_path)
subprocess.check_call(["dpkg-deb", "--info", deb_file_path])
shutil.move(deb_file_path, output_file_path)
def _get_command(arch):
deb_arch = _DEB_ARCH[arch]
command = [
"dpkg-buildpackage",
# TODO: Use long options once we stop supporting Debian Jesse. They're more
# explicit.
#
# Long options were added in dpkg 1.18.8 which is part of Debian Stretch.
#
# https://git.dpkg.org/cgit/dpkg/dpkg.git/commit/?h=1.18.x&id=293bd243a19149165fc4fd8830b16a51d471a5e9
# https://packages.debian.org/stretch/dpkg-dev
"-us", # --unsigned-source
"-uc", # --unsigned-changes
"-b", # --build=binary
]
if deb_arch != "all":
command.append(f"--host-arch={deb_arch}")
if _is_chroot_available(arch):
flattened_command = " ".join(command)
command = [
"chroot",
_get_chroot_path(arch),
"bash",
"-c",
f"cd /tmp/*/source; {flattened_command}",
]
return command
def _create_temporary_directory(arch):
if _is_chroot_available(arch):
return tempfile.mkdtemp(dir=f"{_get_chroot_path(arch)}/tmp")
else:
return tempfile.mkdtemp()
def _is_chroot_available(arch):
return os.path.isdir(_get_chroot_path(arch))
def _get_chroot_path(arch):
deb_arch = "amd64" if arch == "all" else _DEB_ARCH[arch]
return f"/srv/{_DEB_DIST}-{deb_arch}"
_MANIFEST_FILE_NAME = "manifest.json"
def _extract_langpack_metadata(input_xpi_file):
with tempfile.TemporaryDirectory() as d:
with zipfile.ZipFile(input_xpi_file) as zip:
zip.extract(_MANIFEST_FILE_NAME, path=d)
with open(mozpath.join(d, _MANIFEST_FILE_NAME)) as f:
return json.load(f)
|