# 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/.
# Note: This script was written to follow the same business logic # as make_incremental_update.sh and funsize logic. There are many # opportunities for refactoring and improving how this works. # Some improvement ideas: # - The script diffs xz-compressed files. This is not optimal, # if we change XZ compression options, this will cause the # partial to have unnecessary updates. # - Only decompress the target complete mar once # - Separate this script into a python module with multiple files (ie: download, validation, diffing) # - Implement caching of diffs. https://bugzilla.mozilla.org/show_bug.cgi?id=1842209 # - Writing of the manifest file could be done at the very end instead of multiple writes
import argparse import configparser import functools import glob import hashlib import json import logging import os import re import shutil import subprocess import sys import traceback import urllib.error import urllib.request from concurrent.futures import ProcessPoolExecutor from tempfile import NamedTemporaryFile
from mardor.reader import MarReader from mardor.signing import get_keysize
# Copied from scriptworker def get_hash(path, algo="sha512"):
h = hashlib.new(algo) with open(path, "rb") as f: for chunk in iter(functools.partial(f.read, 4096), b""):
h.update(chunk) return h.hexdigest()
def _hash_dir(directory): """Return {rel_path: sha256_hex} for every file under directory."""
result = {} for root, _, filenames in os.walk(directory): for filename in filenames:
abs_path = os.path.join(root, filename)
rel_path = os.path.relpath(abs_path, directory)
result[rel_path] = get_hash(abs_path, "sha256") return result
def _extract_cache_mar(patch_cache_dir, target_mar, workdir): """Extract the cached partial mar matching target_mar's basename into
workdir/cache_extracted. Returns the extracted dir on success, orNone if the cached mar is missing or extraction fails."""
dest_mar_basename = os.path.basename(target_mar)
cached_mar = os.path.join(patch_cache_dir, dest_mar_basename) ifnot os.path.exists(cached_mar):
log(
f"Cached mar not found: {cached_mar}", "_extract_cache_mar",
) returnNone
cache_extracted_dir = os.path.join(workdir, "cache_extracted") try:
mar_extract(cached_mar, cache_extracted_dir) except Exception as e:
log(
f"Failed to extract cached mar {cached_mar}: {e}", "_extract_cache_mar",
) returnNone return cache_extracted_dir
def _maybe_use_cached_file(
cache_entry,
rel_path,
local_from_sha,
local_to_sha,
cache_extracted_dir,
partials_dir,
manifest_file,
): """Reuse a precomputed patch/full file from a previously-built partial mar
when the (from, to) sha256 pair for rel_path matches a cache entry.
Returns the archivefile name on hit, None on miss.""" if local_from_sha isNoneor local_to_sha isNone: returnNone
expected_from = cache_entry.get("from_mar_files", {}).get(rel_path)
expected_to = cache_entry.get("to_mar_files", {}).get(rel_path) if expected_from != local_from_sha or expected_to != local_to_sha: returnNone
src_patch = os.path.join(cache_extracted_dir, f"{rel_path}.patch")
src_full = os.path.join(cache_extracted_dir, rel_path) try: if os.path.exists(src_patch):
dest = os.path.join(partials_dir, f"{rel_path}.patch")
os.makedirs(os.path.dirname(dest) or".", exist_ok=True)
shutil.copy2(src_patch, dest)
make_patch_instruction(rel_path, manifest_file)
log(f"Cache hit (patch): {rel_path}", "_maybe_use_cached_file") return f"{rel_path}.patch" if os.path.exists(src_full): # The cached partial mar stored the full file (not a .patch) # likely because the patch was bigger than the file itself. Reuse # that decision so we don't re-run the diff just to throw it away.
dest = os.path.join(partials_dir, rel_path)
os.makedirs(os.path.dirname(dest) or".", exist_ok=True)
shutil.copy2(src_full, dest)
make_add_instruction(rel_path, manifest_file)
log(f"Cache hit (add): {rel_path}", "_maybe_use_cached_file") return rel_path except OSError as e:
log(f"Cache copy failed for {rel_path}: {e}", "_maybe_use_cached_file") returnNone
log(
f"Cache hashes match but file missing in upstream mar: {rel_path}", "_maybe_use_cached_file",
) returnNone
# The thread-safety of this function should be ok, given that each thread only reads it's own from_mar # and the main thread reads the to_mar
@functools.cache def get_text_from_compressed(path):
proc = subprocess.run(
("xz", "-d", "-c", path),
capture_output=True,
text=True,
check=True,
) return proc.stdout
def get_option_from_compressed(directory, filename, section, option): """Gets an option from an XZ compressed config file"""
log(
f"Extracting [{section}]: {option} from {directory}/**/{filename}", "get_option_from_compressed",
)
files = list(glob.glob(f"{directory}/**/{filename}", recursive=True)) ifnot files: raise Exception(f"Could not find {filename} in {directory}")
f = files.pop()
contents = get_text_from_compressed(f)
config = configparser.ConfigParser()
config.read_string(contents)
rv = config.get(section, option)
log(f"Found {section}.{option}: {rv}", "get_option_from_compressed") return rv
def check_for_forced_update(force_list, file_path): """Check for files that are forced to update. Note: .chk files are always force updated""" # List of files that are always force updated
always_force_updated = ( "precomplete", "Contents/Resources/precomplete", "removed-files", "Contents/Resources/removed-files", "Contents/CodeResources",
) return (
file_path in always_force_updated or file_path.endswith(".chk") or file_path in force_list
)
def list_files_and_dirs(dir_path):
files = []
dirs = [] for root, directories, filenames in os.walk(dir_path): for directory in directories:
dirs.append(os.path.relpath(os.path.join(root, directory), dir_path)) for filename in filenames:
files.append(os.path.relpath(os.path.join(root, filename), dir_path)) return files, dirs
def make_add_instruction(filename, manifest): """Adds an instruction to the update manifest file.""" # Check if the path is an extension directory
is_extension = re.search(r"distribution/extensions/.*/", filename) isnotNone
if is_extension: # Extract the subdirectory to test before adding
testdir = re.sub(r"(.*distribution/extensions/[^/]*)/.*", r"\1", filename) with open(manifest, "a") as file:
file.write(f'add-if "{testdir}" "{filename}"\n') else: with open(manifest, "a") as file:
file.write(f'add "{filename}"\n')
def check_for_add_if_not_update(filename):
basename = os.path.basename(filename) return (
basename in {"channel-prefs.js", "update-settings.ini"} or re.search(r"(^|/)ChannelPrefs\.framework/", filename) or re.search(r"(^|/)UpdateSettings\.framework/", filename)
)
def make_patch_instruction(filename, manifest): with open(manifest, "a") as manifest_file:
manifest_file.write(f'patch "{filename}.patch" "{filename}"\n')
def add_remove_instructions(remove_array, manifest): with open(manifest, "a") as manifest_file: for file in remove_array:
manifest_file.write(f'remove "{file}"\n')
def make_add_if_not_instruction(filename, manifest): with open(manifest, "a") as manifest_file:
manifest_file.write(f'add-if-not "{filename}" "{filename}"\n')
def append_remove_instructions(newdir, manifest):
removed_files_path = os.path.join(newdir, "removed-files") if os.path.exists(removed_files_path): with NamedTemporaryFile() as rmv, open(rmv.name) as f:
xz_cmd(("--decompress",), removed_files_path, rmv.name)
removed_files = f.readlines() with open(manifest, "a") as manifest_file: for file in removed_files:
manifest_file.write(f'remove "{file.strip()}"\n')
def validate_mar_channel_id(mar_path, mar_channel_id): """Validate MAR has correct channel id"""
channel_ids = set(mar_channel_id.split(","))
product_info = MarReader(open(mar_path, "rb")).productinfo ifnot isinstance(product_info, tuple): raise Exception(f"Malformed product info in mar: {mar_path}")
found_channel_ids = set(product_info[1].split(",")) ifnot found_channel_ids.issubset(channel_ids): raise Exception(
f"MAR_CHANNEL_ID mismatch, {product_info[1]} not in {channel_ids}"
)
log(f"Validated {mar_path}: channel {product_info[1]} in {mar_channel_id}") returnTrue
def xz_cmd(cmd, source_file, destination_file): """Run xz command via pipes to avoid file extension checks."""
os.makedirs(os.path.dirname(destination_file), exist_ok=True) with open(destination_file, "wb") as dest_fd, open(source_file, "rb") as source_fd: try:
subprocess.run(("xz", *cmd), stdin=source_fd, stdout=dest_fd, check=True) except subprocess.CalledProcessError as e:
log(
f"XZ Failure running xz {cmd} on {source_file} to {destination_file}: {e.stderr}", "xz_cmd",
) raise Exception(f"XZ exited with code {e.returncode}")
def create_patch(from_file, to_file, destination_patch): """Create a patch between 2 xz compressed files"""
log(f"{from_file} -> {destination_patch}", "create_patch")
with NamedTemporaryFile() as from_fd, NamedTemporaryFile() as to_fd, NamedTemporaryFile() as patch_fd:
xz_cmd(("--decompress",), from_file, from_fd.name)
# TODO: Potentially don't decompress to_mar files once per thread?
xz_cmd(("--decompress",), to_file, to_fd.name)
args = ["zucchini", "-gen", from_fd.name, to_fd.name, patch_fd.name] try:
subprocess.run(args, check=True) except subprocess.CalledProcessError as e:
log(f"Zucchini failed to create patch:\n{e.stderr}", "create_patch") raise Exception(f"Zucchini exited with code: {e.returncode}")
# List files and directories
oldfiles, _ = list_files_and_dirs(from_mar_dir)
newfiles, newdirs = list_files_and_dirs(to_mar_dir)
for newdir in newdirs:
os.makedirs(os.path.join(partials_dir, newdir), exist_ok=True)
# Check if precomplete file exists in the new directory ifnot os.path.exists(
os.path.join(to_mar_dir, "precomplete")
) andnot os.path.exists(
os.path.join(to_mar_dir, "Contents/Resources/precomplete")
):
log("precomplete file is missing!", "make_partial") raise Exception("precomplete file is missing!")
# Create update manifest with open(manifest_file, "w") as manifest_fd:
manifest_fd.write('type "partial"\n')
remove_array = []
# Process files for patching # Note: these files are already XZ compressed for rel_path in oldfiles: # updatev3.manifest is the partial manifest, not a patch[able] file if rel_path == "updatev3.manifest": continue
new_file_abs = os.path.join(to_mar_dir, rel_path)
old_file_abs = os.path.join(from_mar_dir, rel_path)
if os.path.exists(new_file_abs):
patch_file = os.path.join(partials_dir, rel_path) if check_for_add_if_not_update(old_file_abs):
make_add_if_not_instruction(rel_path, manifest_file)
shutil.copy2(new_file_abs, patch_file)
archivefiles.append(rel_path) elif check_for_forced_update(requested_forced_updates, rel_path):
make_add_instruction(rel_path, manifest_file)
shutil.copy2(new_file_abs, patch_file)
archivefiles.append(rel_path) else:
cache_archive = None if cache_extracted_dir isnotNoneand cache_entry isnotNone:
cache_archive = _maybe_use_cached_file(
cache_entry,
rel_path,
from_hashes[rel_path],
to_hashes[rel_path],
cache_extracted_dir,
partials_dir,
manifest_file,
) if cache_archive isnotNone:
archivefiles.append(cache_archive) elif ( # TODO: !!! This check will always trigger if we switch XZ options!
subprocess.run(
("diff", old_file_abs, new_file_abs),
check=False,
).returncode
!= 0
): # Check for smaller patch or full file size and choose the smaller of the two to package
create_patch(old_file_abs, new_file_abs, f"{patch_file}.patch") if (
os.stat(f"{patch_file}.patch").st_size
> os.stat(new_file_abs).st_size
):
make_add_instruction(rel_path, manifest_file)
os.unlink(f"{patch_file}.patch")
shutil.copy2(new_file_abs, patch_file)
archivefiles.append(rel_path) else:
make_patch_instruction(rel_path, manifest_file)
archivefiles.append(f"{rel_path}.patch")
else:
remove_array.append(rel_path)
# Newly added files for newfile_rel in newfiles:
new_file_abs = os.path.join(to_mar_dir, newfile_rel) if newfile_rel notin oldfiles:
patch_file = os.path.join(partials_dir, newfile_rel)
make_add_instruction(newfile_rel, manifest_file)
archivefiles.append(newfile_rel)
shutil.copy2(new_file_abs, patch_file)
# Add directory removal instructions from removed-files
append_remove_instructions(to_mar_dir, manifest_file)
# Compress manifest file and add to list of archived files
compressed_manifest = os.path.join(partials_dir, "updatev3.manifest")
xz_cmd(xz_compression_options(arch), manifest_file, compressed_manifest)
archivefiles.append("updatev3.manifest")
version = get_option_from_compressed(
to_mar_dir, "application.ini", "App", "Version"
)
def validate_url(url, allow_staging):
allowed_url_prefixes = ALLOWED_URL_PREFIXES if allow_staging:
allowed_url_prefixes += STAGING_URL_PREFIXES ifnot url.startswith(allowed_url_prefixes): raise Exception(f"URL not allowed: {url}")
def verify_signature(path, signing_cert): with open(path, "rb") as fd:
m = MarReader(fd) ifnot m.verify(verify_key=signing_cert): raise Exception(f"MAR Signature invalid: {path}")
def download_file(url, save_path, allow_staging, signing_cert=None): """
Downloads a file from a given URL and saves it to disk.
Validates URL before proceeding with download.
Args:
url (str): The URL to download the file from.
save_path (str): The path (including filename) where the file should be saved.
allow_staging (bool): Allows staging URLs """
validate_url(url, allow_staging) try: # Download the file and save it to the specified path
urllib.request.urlretrieve(url, save_path)
log(f"File downloaded successfully: {save_path}", "download_file") except urllib.error.URLError as e:
log(f"Error downloading file: {url} -> {e}", "download_file") raise Exception("Failed to download file.") except Exception as e:
log(f"An unexpected error occurred: {url} -> {e}", "download_file") raise Exception("Failed to download file.")
if signing_cert:
verify_signature(save_path, signing_cert)
def process_single(
update_number,
from_mar_url,
to_mar_dir,
target_mar,
mar_channel_id,
workdir,
signing_cert,
arch,
force,
staging,
previousVersion=None,
compute_hashes=False,
cache_entry=None,
to_hashes=None,
patch_cache_dir=None,
): try:
mar_manifest, from_hashes = make_partial(
from_mar_url=from_mar_url,
to_mar_dir=to_mar_dir,
target_mar=target_mar,
mar_channel_id=mar_channel_id,
workdir=workdir,
signing_cert=signing_cert,
arch=arch,
force=force,
staging=staging,
compute_hashes=compute_hashes,
cache_entry=cache_entry,
to_hashes=to_hashes,
patch_cache_dir=patch_cache_dir,
)
mar_manifest["update_number"] = update_number if previousVersion:
mar_manifest["previousVersion"] = previousVersion # Validate the created mar has valid channel id if validate_mar_channel_id(target_mar, mar_channel_id): returnNone, mar_manifest, from_hashes else: # Since we still want to capture the manifest, we return the exception without raising it return Exception("Invalid partial MAR id!"), mar_manifest, from_hashes except Exception as e:
log(traceback.format_exc(), "process_single") return e, None, None
def main():
parser = argparse.ArgumentParser(
description="Generate incremental update packages with zucchini."
)
parser.add_argument( "--from-mars-json",
help="JSON data of complete mar URLs",
action="store",
required=True,
)
parser.add_argument( "--branch", help="Project branch", action="store", required=True
)
parser.add_argument("--to-mar", help="To complete mar", required=True)
parser.add_argument( "--to-mar-url",
help="To mar URL. Only used for filling the manifest.json file.",
action="store",
required=False,
default="",
)
parser.add_argument("--target", help="Target partial mar location", required=True)
parser.add_argument( "--cert-path",
help="Certificate path",
type=argparse.FileType("rb"),
required=False,
)
parser.add_argument( "--allow-staging-urls",
help="Allows downloading from staging URLs",
action="store_true",
)
parser.add_argument( "--workdir", help="Work directory", action="store", required=True
)
parser.add_argument( "--mar-channel-id", help="MAR channel ID", action="store", default="unknown"
)
parser.add_argument("--locale", help="Build locale", action="store", required=True)
parser.add_argument( "--arch",
help="Target Architecture",
action="store",
choices=BCJ_OPTIONS.keys(),
required=True,
)
parser.add_argument( "--force",
help="Clobber this file in the installation. Must be a path to a file to clobber in the partial update.",
action="append",
)
parser.add_argument( "--generate-hashes",
help="Write a hashes.json file alongside manifest.json with per-file sha256 metadata. Used by downstream l10n tasks for cache reuse.",
action="store_true",
)
parser.add_argument( "--patch-cache-dir",
help="Directory containing an upstream hashes.json plus the cached partial mars. When set, per-file diffs are reused from the upstream cache when (from, to) sha256 hashes match.",
action="store",
default=None,
)
# Multithread one partial per CPU
cpus = os.cpu_count() # This isn't optimal, but will do for now
log(f"CPUs available for parallel computing: {cpus}", "main")
# Decompress to_mar early
to_mar_dir = os.path.join(base_workdir, "to_mar")
mar_extract(args.to_mar, to_mar_dir)
# Note: we can't validate "from mar" channels. See bug 1543662 for details. # Validate to_mar channel id ifnot validate_mar_channel_id(args.to_mar, args.mar_channel_id):
log("Invalid MAR channel id in to-mar!", "main") raise Exception("Invalid MAR channel id in to-mar!")
cache_index = {} if args.patch_cache_dir:
cache_path = os.path.join(args.patch_cache_dir, "hashes.json") try: with open(cache_path) as fd:
cache_index = json.load(fd)
log(f"Loaded patch cache index from {cache_path}", "main") except (FileNotFoundError, json.JSONDecodeError) as e:
log(
f"Could not load patch cache index from {cache_path}: {e}; cache disabled.", "main",
)
compute_hashes = args.generate_hashes or bool(args.patch_cache_dir)
to_hashes = _hash_dir(to_mar_dir) if compute_hashes elseNone
with ProcessPoolExecutor(cpus) as executor:
from_data = json.loads(args.from_mars_json) assert isinstance(from_data, list), ( "Param --from-mars-json should be a JSON list."
)
for from_data_index in range(len(from_data)):
source_data = from_data[from_data_index]
update_number = source_data["update_number"]
process_workdir = os.path.join(base_workdir, str(from_data_index))
os.makedirs(process_workdir, exist_ok=True)
cache_entry = cache_index.get(source_data["dest_mar"]) if args.patch_cache_dir and cache_entry isNone:
log(
f"No upstream cache entry for {source_data['dest_mar']}; cache disabled for this partial.", "main",
)
errd = False
results = []
hashes_output = {} for error, manifest, from_hashes in futures_result: if manifest:
manifest.update(to_mar_info)
results.append(manifest) if args.generate_hashes and from_hashes isnotNone:
hashes_output[manifest["mar"]] = { "from_mar_files": from_hashes, "to_mar_files": to_hashes,
} else:
errd = True
log("Process raised an exception!", "main")
print(error)
# Write final task manifest with open(os.path.join(target, "manifest.json"), "w") as fd:
fd.write(json.dumps(results))
log("Finished writing final manifest.", "main")
if args.generate_hashes: with open(os.path.join(target, "hashes.json"), "w") as fd:
fd.write(json.dumps(hashes_output))
log("Finished writing hashes.json.", "main")
if errd:
sys.exit(1)
if __name__ == "__main__":
main()
Messung V0.5 in Prozent
¤ Dauer der Verarbeitung: 0.18 Sekunden
(vorverarbeitet am 2026-08-25)
¤
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.