#!/usr/bin/env python3 """Writes IptvAppSwift/Resources/Acknowledgements.json, the Acknowledgements page in Settings. Every library the app ships, at the version Package.resolved pins, with its licence text copied verbatim from the package's own files -- or, where a package's licence file only gives the address its terms are published at, as the Cast SDK's does, that address for the page to link to. VLCKit is the exception: Popvue ships its own build of it, the local package in Vendor/MobileVLCKit, made by Scripts/vlckit/build-vlckit.sh, so its version is the tag that script builds and its licence is VLCKit's COPYING from that tag, kept in Scripts/vlckit-licences. Its entry also carries where its source and libVLC's can be had, as the LGPL asks: the VLCKit tag, and the libVLC release tag its binary names. Run it again whenever a package is added or updated, or VLCKit rebuilt: python3 Scripts/generate_acknowledgements.py where is the folder Xcode resolved the packages into, holding `checkouts` and `artifacts` (DerivedData/IptvAppSwift-*/SourcePackages). The script stops rather than write a list with a licence missing. The MobileVLCKit binary links in libVLC's contrib libraries too -- FFmpeg, dav1d, FreeType and some forty more -- whose licences the package doesn't carry. Scripts/vlckit-licences holds them, copied from the contrib tarballs of the VLCKit version its manifest names, and they follow VLCKit's LGPL text: each library's own licence text, or, for one used under the LGPL, a line naming it, the LGPL text above standing for it; one Popvue's build alters first says so, as its licence asks. The manifest pins the VLCKit tag and the libVLC build the binary reports ("3.0.21-53": vlc's tag, then VLCKit's patches and Popvue's); when either changes -- VLCKit updated, a patch added or dropped -- the script stops until the list and the texts are taken again from the new build (contrib/src//rules.mak at the libVLC revision its build script pins, and the libraries the binary really links). """ import json import plistlib import re import sys from pathlib import Path REPO = Path(__file__).resolve().parent.parent RESOLVED = REPO / "IptvAppSwift.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved" OUTPUT = REPO / "IptvAppSwift/Resources/Acknowledgements.json" VLCKIT_LICENCES = REPO / "Scripts/vlckit-licences" VLCKIT_BUILD = REPO / "Scripts/vlckit/build-vlckit.sh" VLCKIT_BINARY = REPO / "Vendor/MobileVLCKit/MobileVLCKit.xcframework/ios-arm64/MobileVLCKit.framework/MobileVLCKit" def read(path: Path) -> str: """A licence file as written, only the blank lines around it trimmed.""" if not path.is_file(): sys.exit(f"missing licence file: {path}") return path.read_text(encoding="utf-8").strip("\n") def licence_link(text: str): """The address a licence file gives in place of a licence: a single line, a web address.""" stripped = text.strip() if "\n" not in stripped and re.fullmatch(r"https?://\S+", stripped): return stripped return None def vlckit_version() -> str: """The VLCKit release Popvue's build is made from: the tag build-vlckit.sh checks out. The binary itself names only libVLC's version.""" match = re.search(r'^VLCKIT_TAG="([^"]+)"$', VLCKIT_BUILD.read_text(encoding="utf-8"), re.MULTILINE) if not match: sys.exit(f"no VLCKIT_TAG in {VLCKIT_BUILD.relative_to(REPO)}") return match.group(1) def libvlc_version() -> tuple: """libVLC's version as Popvue's MobileVLCKit names itself ("LibVLC/3.0.21"), and the build it reports ("3.0.21-53-ge2283f330b": vlc's 3.0.21 tag, then 53 patches, VLCKit's and Popvue's) less the commit, which changes with every build as the patches are applied afresh.""" if not VLCKIT_BINARY.is_file(): sys.exit(f"missing {VLCKIT_BINARY.relative_to(REPO)}: build it with Scripts/vlckit/build-vlckit.sh") binary = VLCKIT_BINARY.read_bytes() version = re.search(rb"LibVLC/(\d+)\.(\d+)\.(\d+)", binary) builds = {match.group(1) for match in re.finditer(rb"(\d+\.\d+\.\d+-\d+)-g[0-9a-f]{7,}", binary)} if not version or len(builds) != 1: sys.exit(f"no single libVLC version in {VLCKIT_BINARY.relative_to(REPO)}") parts = tuple(part.decode() for part in version.groups()) build = builds.pop().decode() if not build.startswith(".".join(parts) + "-"): sys.exit(f"libVLC {'.'.join(parts)} reports the build {build}") return parts, build def vlckit_inclusions(vlckit_version: str, libvlc: tuple, libvlc_build: str) -> list: """The licences of the libraries inside MobileVLCKit, in the manifest's order: a library's texts headed "FFmpeg 4.4.4", its further ones "FFmpeg 4.4.4: