- tor-commits - lists.torproject.org

[Git][tpo/applications/tor-browser-build][main] Bug 41800: Add a script for the new offline manual.
by henry (＠henry) 20 Jul '26

20 Jul '26

henry pushed to branch main at The Tor Project / Applications / tor-browser-build Commits: fee9e7b2 by Henry Wilkes at 2026-07-20T14:55:57+00:00 Bug 41800: Add a script for the new offline manual. - - - - - 2 changed files: - + projects/manual/package_marble_build_artifacts.py - + projects/manual/test_package_marble_build_artifacts.py Changes: ===================================== projects/manual/package_marble_build_artifacts.py ===================================== @@ -0,0 +1,669 @@ +import html +import html.parser +import os +import re +import shutil +from urllib.parse import quote_plus, urlparse + +DEFAULT_LOCALE = "en" +ORIG_HTML_PATH = "offline/tor-browser/index.html" + +# The '#' will be replaced with the locale name. +HTML_NAME_TEMPLATE = "aboutManual-#.html" +ASSETS_DIR_NAME = "assets" + + +class ManualParser(html.parser.HTMLParser): + """ + A parser for the Tor Browser manual. Extracts the <body> of the input HTML, + swaps attributes, and writes out a new HTML. + """ + + _CHROME_URI_BASE = "chrome://browser/content/aboutmanual/" + _CHROME_ASSET_PATH = _CHROME_URI_BASE + ASSETS_DIR_NAME + "/" + _CHROME_JS = _CHROME_URI_BASE + "aboutManual.js" + + # The base for external support pages. + _SUPPORT_URI_BASE = "https://support.torproject.org" + + # The name of online page that the offline manual is derived from (the + # `data-olm-product` value). + # In our case, the offline manual is derived from + # https://support.torproject.org/tor-browser/ + _TOP_PAGE_NAME = "tor-browser" + + # The `id` attribute value that points to the top-page. + _TOP_ID = "index" + + # The pages that are covered by the offline manual. + # The first value in the tuple specifies the paths that are covered. Every + # path that starts with this is considered internal. + # The second value indicates whether an anchor reference to this page should + # include the start of the path or not. + _INTERNAL_PAGES = [ + ([_TOP_PAGE_NAME], False), + (["get-in-touch", "bug-or-feedback"], True), + (["get-in-touch", "user-support"], True), + ] + + # The content security policy we want for the output. + _CSP = "default-src 'none'; style-src chrome:; img-src chrome:; script-src chrome:" + + # Elements that should not appear in the <body>. + _FORBIDDEN_BODY_TAGS = [ + "script", + "noscript", + "meta", + "link", + "html", + "head", + "body", + ] + + # HTML elements that are void elements. + _VOID_HTML_TAGS = [ + "area", + "base", + "br", + "col", + "embed", + "hr", + "img", + "input", + "link", + "meta", + "source", + "track", + "wbr", + ] + + _VALID_DIR_VALS = ["rtl", "ltr"] + + def __init__( + self, locale: str, html_path: str, top_dir: str, all_locales: list[str] + ) -> None: + """ + Create a new parser for the offline manual. + """ + super().__init__(convert_charrefs=True) + self._locale = locale + self._html_path = html_path + self._html_dir = os.path.dirname(html_path) + self._top_dir = top_dir + self._all_locales = all_locales + + # As we parse the HTML, we track which tags we are currently inside, as + # well as some other details about those tags. + # The last element in the list is the most recent tag. + self._ancestor_details: list[dict[str, str]] = [] + + # The <body> content we should write to the output. + self._body_content = "" + + # Whether we are currently below the <body> tag. + self._in_body = False + # Whether we have encountered the <body> tag at some point. + self._visited_body = False + # The lang attribute found on the <html> element. + self._lang: None | str = None + # The dir attribute found on the <html> element. + self._dir: None | str = None + # The <title> content we have found. + self._title = "" + # The stylesheet references to include. + self._style_hrefs: list[str] = [] + # The found asset paths. + self._asset_paths: dict[str, str] = {} + # A list of all internal references we want to verify exist. + # The first member of the tuple gives the document position where the + # `href` was found. + # The second member of the tuple gives the `href` value. + self._internal_hrefs: list[tuple[tuple[int, int], str]] = [] + # The list of all `id` attributes we found in the <body>. + self._all_ids: list[str] = [] + + def _error(self, message: str, pos: None | tuple[int, int] = None) -> ValueError: + """ + Create a new parsing error. + + :param message: The message to show. + :param pos: The document position associated with the error. Defaults to + the current position. + + :returns: A new error instance. + """ + if pos is None: + pos = self.getpos() + return ValueError(f"{self._html_path}: {pos}: {message}") + + def _in_context(self, expected_ancestors: list[str]) -> bool: + """ + Test if we are currently below the given ancestors. + + :param expected_ancestors: The tag names for the ancestors we expect. + + :returns: Whether we are directly below the specified ancestors. + """ + return [d["tag"] for d in self._ancestor_details] == expected_ancestors + + def _add_to_body(self, data: str) -> None: + """ + Write to the body content. + + :param data: The content to write. + """ + self._body_content += data + + def _add_end_tag_to_body(self, tag: str) -> None: + """ + Write an ending tag to the body. + + :param tag: The name of the tag to close. + """ + self._add_to_body(f"</{tag}>") + + def _add_start_tag_to_body( + self, tag: str, attrs: dict[str, None | str], self_close: bool + ) -> None: + """ + Write a starting tag to the body. + + :param tag: The name of the tag to open. + :param attrs: The attributes for this tag. + :param self_close: Whether this tag should be self-closed. + """ + attr_part = "" + for name, value in attrs.items(): + attr_part += f" {name}" + if value is not None: + attr_part += f'="{html.escape(value, quote=True)}"' + close_part = " />" if self_close else ">" + self._add_to_body(f"<{tag}{attr_part}{close_part}") + + def _has_class(self, attrs: dict[str, None | str], class_name: str) -> bool: + """ + Test if an element has a certain class. + + :param attrs: The attributes for the element. + :param class_name: The name of the class to check for. + + :returns: Whether the element has the given class. + """ + class_val = attrs.get("class") + if not class_val: + return False + return class_name in class_val.split(" ") + + def _handle_html_tag(self, attrs: dict[str, None | str]) -> None: + """ + Process a html tag. + + :param attrs: The tag's attributes. + """ + if not self._in_context([]): + raise self._error("html has a parent") + if self._lang: + raise self._error("More than one html tag") + lang = attrs.get("lang") + if not lang: + raise self._error("html is missing a lang attribute") + if lang != self._locale: + raise self._error(f"Unexpected lang attribute: {lang}") + dir_val = attrs.get("dir") + if not dir_val: + raise self._error("html is missing a dir attribute") + if dir_val not in self._VALID_DIR_VALS: + raise self._error(f"Unexpected dir attribute: {dir_val}") + + self._lang = lang + self._dir = dir_val + + _NON_SAFE_ASSET_CHARS = re.compile(r"[^a-zA-Z0-9_.-]") + + def _swap_asset_path(self, orig_path: str) -> str: + """ + Swap an an asset path with a new one, and record the old path. + + :param orig_path: The original path for the asset. + + :returns: The new path to use. + """ + # Parse as a URL so we can strip any queries. + url = urlparse(orig_path) + if url.scheme: + raise self._error(f"Unexpected asset path with a scheme: {url.scheme}") + + if url.path.startswith("/"): + abs_path = os.path.abspath(os.path.join(self._top_dir, url.path[1:])) + else: + abs_path = os.path.abspath(os.path.join(self._html_dir, url.path)) + + if os.path.commonpath([self._top_dir, abs_path]) != self._top_dir: + raise self._error(f"References an asset outside {self._top_dir}") + if not os.path.isfile(abs_path): + raise self._error(f"References a non-existent asset: {abs_path}") + + # Replace any (unexpected) non-safe characters with underscores. + asset_name = self._NON_SAFE_ASSET_CHARS.sub( + "_", os.path.relpath(abs_path, start=self._top_dir).replace("/", "__") + ) + + if asset_name not in self._asset_paths: + self._asset_paths[asset_name] = abs_path + elif self._asset_paths[asset_name] != abs_path: + raise self._error(f"More than one asset with the same name: {asset_name}") + + return self._CHROME_ASSET_PATH + asset_name + + def _handle_link_tag(self, attrs: dict[str, None | str]) -> None: + """ + Process a link tag. + + :param attrs: The tag's attributes. + """ + if attrs.get("rel") != "stylesheet": + return + + href = attrs.get("href") + if not href: + raise self._error("stylesheet link missing an href") + + self._style_hrefs.append(self._swap_asset_path(href)) + + def _handle_body_tag(self) -> None: + """ + Process a body tag. + """ + if not self._in_context(["html"]): + raise self._error("Wrong context for the body tag") + if self._visited_body: + raise self._error("More than one body tag") + self._visited_body = True + + def _handle_img_tag(self, attrs: dict[str, None | str]) -> None: + """ + Process an img tag. + + :param attrs: The tag's attributes, which may be modified. + """ + if "srcset" in attrs: + # In principle, we should also map "srcset" as we map "src", but it + # is unexpected and not worth the parsing logic. + raise self._error("Unhandled srcset attribute") + src = attrs.get("src") + if not src: + return + + attrs["src"] = self._swap_asset_path(src) + + def _convert_relative_href(self, href: str) -> tuple[str, bool]: + """ + Convert a relative href into a href that can be used in the final HTML. + + :param href: The href to convert. + + :returns: The new href, and whether the href is an internal link. + """ + url = urlparse(href) + parts = [p for p in url.path.replace("../../", "").split("/") if p] + if not parts or ".." in parts or "." in parts: + raise self._error(f"Unexpected path: {href}") + + if parts == [self._TOP_PAGE_NAME] and not url.fragment: + href = "#" + self._TOP_ID + return href, True + + for page_path, keep_prefix in self._INTERNAL_PAGES: + cmp_len = len(page_path) + if parts[:cmp_len] == page_path: + if not keep_prefix: + parts = parts[cmp_len:] + href = "#" + "__".join(parts) + if url.fragment: + href += "___" + url.fragment + return href, True + + href = self._SUPPORT_URI_BASE + "/" + if self._locale != DEFAULT_LOCALE: + href += quote_plus(self._locale) + "/" + href += "/".join(parts) + if url.fragment: + href += "#" + url.fragment + # Note: we don't expect a query parameter. + return href, False + + def _handle_a_tag( + self, attrs: dict[str, str | None], details: dict[str, str] + ) -> None: + """ + Process an anchor tag. + + :param attrs: The tag's attributes, which may be modified. + :param details: The tag details to save, which may be modified. + """ + # Always remove these attributes, and maybe replace them below. + # NOTE: Whilst, some "rel" attribute tokens would, in principle, be + # valid to keep, we don't expect it to be used in the origin for + # anything other than "noopener" or "norefferor" in the original + # document. + for attr_name in ("rel", "referrerpolicy", "target"): + if attr_name in attrs: + del attrs[attr_name] + + # Change href if it includes relative path + href = attrs.get("href") + if not href: + return + + is_external = False + is_internal = False + if href.startswith("http:") or href.startswith("https:"): + is_external = True + elif href.startswith("mailto:"): + # Do not allow mailto: + del attrs["href"] + elif href.startswith("#"): + # Keep as is. + is_internal = True + elif href.startswith("../../"): + href, is_internal = self._convert_relative_href(href) + attrs["href"] = href + if not is_internal: + is_external = True + else: + raise self._error(f"Unexpected href: {href}") + + if is_external: + attrs["target"] = "_blank" # Implies rel="noopener". + # Is noreferrer needed for external links within a chrome: document? + attrs["rel"] = "noreferrer" + if is_internal: + self._internal_hrefs.append((self.getpos(), href)) + + return + + def _handle_div_tag( + self, attrs: dict[str, str | None], details: dict[str, str] + ) -> None: + """ + Process a div tag. + + :param attrs: The tag's attributes, which may be modified. + :param details: The tag details to save, which may be modified. + """ + if self._has_class(attrs, "heading-anchor"): + # Convert the .heading-anchor id to include a prefix from its + # ancestor .olm-page element. + el_id = attrs.get("id") + if not el_id: + raise self._error("Heading is missing an id") + page_id = None + # Search for the nearest ancestor with a page-id. + for ancestor in reversed(self._ancestor_details): + page_id = ancestor.get("page-id") + if page_id: + break + if not page_id: + raise self._error("Missing a page to use for the heading id") + attrs["id"] = page_id + "___" + el_id + elif self._has_class(attrs, "olm-page"): + el_id = attrs.get("id") + if not el_id: + raise self._error("olm-page is missing an id") + for other in self._ancestor_details: + if "page-id" in other: + raise self._error("olm-page is below another") + details["page-id"] = el_id + + def _save_id(self, tag: str, attrs: dict[str, str | None]) -> None: + """ + Maybe save an `id` to the list of `id`s that can be referenced + internally. + """ + attr_id = attrs.get("id") + if not attr_id or not self._in_body: + # Ignore + return + if attr_id in self._all_ids: + if tag == "input" and self._has_class(attrs, "toggler"): + # Known issue that *some* <input class="toggler" /> will use + # the same id as the heading element above it. + # TODO: tor-browser-build#41818. Remove once this element is + # removed. + del attrs["id"] + return + raise self._error(f"Duplicate id: {attr_id}") + self._all_ids.append(attr_id) + + def _handle_tag( + self, tag: str, attr_pairs: list[tuple[str, str | None]], is_closed: bool + ) -> None: + """ + Handle a start tag, + + :param tag: The name of the tag. + :param attr_pairs: The list of all attributes for this tag. + :param is_closed: Whether the tag is self-closing. + """ + details = {"tag": tag, "orig-tag": tag} + + attrs = {} + for attr_name, attr_value in attr_pairs: + if attr_name in attrs: + raise self._error(f"{tag} has a duplicate attribute: {attr_name}") + attrs[attr_name] = attr_value + + if not self._in_body: + if tag == "html": + self._handle_html_tag(attrs) + elif tag == "link": + self._handle_link_tag(attrs) + elif tag == "body": + self._handle_body_tag() + self._in_body = True + elif tag in self._FORBIDDEN_BODY_TAGS: + raise self._error(f"Unexpected {tag} tag in body") + elif tag == "img": + self._handle_img_tag(attrs) + elif tag == "a": + self._handle_a_tag(attrs, details) + elif tag == "div": + self._handle_div_tag(attrs, details) + + # The tag may have changed. + tag = details["tag"] + self._save_id(tag, attrs) + + # NOTE: Technically, we would need to take the `xmlns` into account to + # ensure that we are still in a HTML context, but we don't expect these + # void tag names to appear in other contexts. + is_void_tag = tag in self._VOID_HTML_TAGS + is_open_tag = not is_void_tag and not is_closed + + if self._in_body: + # Write the tag, which may differ from the original tag. + self._add_start_tag_to_body(tag, attrs, is_void_tag) + if not is_void_tag and not is_open_tag: + # Close immediately to keep this empty. + self._add_end_tag_to_body(tag) + + if is_open_tag: + # Track this as an ancestor. + self._ancestor_details.append(details) + + ## HTMLParser API + + def handle_starttag(self, tag: str, attrs: list[tuple[str, str | None]]) -> None: + self._handle_tag(tag, attrs, False) + + def handle_startendtag(self, tag: str, attrs: list[tuple[str, str | None]]) -> None: + self._handle_tag(tag, attrs, True) + + def handle_endtag(self, tag: str) -> None: + if not self._ancestor_details: + raise self._error(f"Unmatched end tag: {tag}") + details = self._ancestor_details.pop() + if details["orig-tag"] != tag: + raise self._error(f"Unmatched end tag: {tag}") + + if self._in_body: + # Write the tag found in `details` to match the tag that was *written* + # for the start tag, which may differ from `orig-tag`. + self._add_end_tag_to_body(details["tag"]) + if tag == "body": + self._in_body = False + + def handle_comment(self, _data: str) -> None: + # ignore + pass + + def handle_data(self, data: str) -> None: + if self._in_body: + self._add_to_body(html.escape(data, quote=False)) + elif self._in_context(["html", "head", "title"]): + self._title += data + + def handle_decl(self, decl: str) -> None: + if decl != "DOCTYPE html" or not self._in_context([]): + raise self._error("Unexpected declaration") + + def handle_pi(self, _data: str) -> None: + raise self._error("Unexpected processing instruction") + + def unknown_decl(self, _data: str) -> None: + raise self._error("Unknown declaration") + + ## Public methods. + + def process(self) -> tuple[str, dict[str, str]]: + """ + Process the HTML file. + + :returns: A 2-tuple of the filtered HTML content and a dictionary + that maps from the name of an asset in the HTML content to its + original file path. + """ + with open(self._html_path, encoding="utf-8") as file: + self.feed(file.read()) + + # Make sure we are not in an invalid state. + if self._ancestor_details or self._in_body: + raise self._error("Document was not closed") + if not self._visited_body: + raise self._error("Missing a body element") + if not self._lang or not self._dir: + raise self._error("Missing lang or dir") + if not self._title: + raise self._error("Missing a title") + + # Make sure all our internal references actually point to an element. + for pos, href in self._internal_hrefs: + el_id = href[1:] # Strip the starting '#'. + if el_id not in self._all_ids: + raise self._error(f"Missing an element with the id {el_id}", pos=pos) + + lang = html.escape(self._lang, quote=True) + dir_val = html.escape(self._dir, quote=True) + csp = html.escape(self._CSP, quote=True) + js_chrome = html.escape(self._CHROME_JS, quote=True) + title_content = html.escape(self._title, quote=False) + + html_output = f"""<!DOCTYPE html> +<html lang="{lang}" dir="{dir_val}"> +<head> + <meta http-equiv="Content-Security-Policy" content="{csp}" /> + <title>{title_content}</title> + <script src="{js_chrome}"></script> +""" + for href in self._style_hrefs: + html_output += ( + f' <link rel="stylesheet" href="{html.escape(href, quote=True)}" />\n' + ) + html_output += "</head>\n" + html_output += self._body_content + html_output += "\n</html>\n" + + return html_output, self._asset_paths.copy() + + +def main(top_dir: str, out_dir: str, out_locales: str) -> None: + out_dir = os.path.abspath(out_dir) + out_locales = os.path.abspath(out_locales) + top_dir = os.path.abspath(top_dir) + + if not os.path.isdir(out_dir): + raise ValueError(f"Not a directory: {out_dir}") + + default_path = os.path.join(top_dir, ORIG_HTML_PATH) + if not os.path.isfile(default_path): + raise ValueError(f"Missing file: {default_path}") + + locale_regex = re.compile("^[a-z]{2}(-[A-Z]{2})?$") + locale_html = {DEFAULT_LOCALE: default_path} + for maybe_locale in os.listdir(top_dir): + if not locale_regex.fullmatch(maybe_locale): + continue + maybe_path = os.path.join(top_dir, maybe_locale, ORIG_HTML_PATH) + if os.path.isfile(maybe_path): + locale_html[maybe_locale] = maybe_path + + all_locales = sorted(locale_html.keys()) + all_asset_paths: dict[str, str] = {} + + for locale, html_path in locale_html.items(): + parser = ManualParser( + locale=locale, + html_path=html_path, + top_dir=top_dir, + all_locales=all_locales, + ) + content, asset_paths = parser.process() + + for asset_name, orig_path in asset_paths.items(): + if asset_name not in all_asset_paths: + all_asset_paths[asset_name] = orig_path + elif all_asset_paths[asset_name] != orig_path: + raise ValueError(f"Duplicate asset names: {asset_name}") + + out_html_path = os.path.join(out_dir, HTML_NAME_TEMPLATE.replace("#", locale)) + with open(out_html_path, "w", encoding="utf-8") as file: + file.write(content) + + asset_dir = os.path.join(out_dir, ASSETS_DIR_NAME) + try: + os.mkdir(asset_dir) + except FileExistsError: + pass + + for asset_name, orig_path in all_asset_paths.items(): + shutil.copyfile(orig_path, os.path.join(os.path.join(asset_dir, asset_name))) + + with open(out_locales, "w", encoding="utf-8") as file: + file.write(",".join(all_locales)) + + +if __name__ == "__main__": + import argparse + + arg_parser = argparse.ArgumentParser( + description="Filter the offline manual HTML files to be used in Tor Browser" + ) + + arg_parser.add_argument( + "--in-dir", + required=True, + help="The 'public' directory to read the original HTML files from", + ) + arg_parser.add_argument( + "--out-dir", + required=True, + help="The directory to write the output HTML and assets to", + ) + arg_parser.add_argument( + "--out-locales", + required=True, + help="The file to write the list of locales to", + ) + + args = arg_parser.parse_args() + main(args.in_dir, args.out_dir, args.out_locales) ===================================== projects/manual/test_package_marble_build_artifacts.py ===================================== @@ -0,0 +1,1654 @@ +import os +import re +import shutil +import tempfile +import textwrap +import unittest + +from package_marble_build_artifacts import ManualParser, main + +EXPECT_CSP_META = '<meta http-equiv="Content-Security-Policy" content="default-src 'none'; style-src chrome:; img-src chrome:; script-src chrome:" />' +EXPECT_SCRIPT = ( + '<script src="chrome://browser/content/aboutmanual/aboutManual.js"></script>' +) +EXPECT_CHROME_ASSETS = "chrome://browser/content/aboutmanual/assets" + + +class TestSingleHTML(unittest.TestCase): + top_dir: str | None = None + html_path: str | None = None + all_locales = ["en", "ar"] + + # Set the TestCase.maxDiff to a larger number to see the full HTML. + maxDiff = 2000 + + @classmethod + def setUpClass(cls) -> None: + cls.top_dir = tempfile.mkdtemp() + try: + os.chdir(cls.top_dir) + html_dir = os.path.join(cls.top_dir, "html/html") + assets1_dir = os.path.join(cls.top_dir, "html/assets1") + assets2_sub_dir = os.path.join(cls.top_dir, "assets2/sub") + os.makedirs(html_dir) + os.makedirs(assets1_dir) + os.makedirs(assets2_sub_dir) + cls.html_path = os.path.join(html_dir, "test.html") + + for filename in ( + "html/html/neighbour1.svg", + "html/html/neighbour2.svg", + "html/html/neighbour1.css", + "html/html/neighbour2.css", + "html/assets1/image1.png", + "html/assets1/style1.css", + "assets2/image2.png", + "assets2/style2.css", + "assets2/sub/image2.png", + "assets2/sub/style2.css", + "html/assets1/image(a)2x.png", + "html/assets1/🦭.svg", + "html/assets1/~.svg", + ): + # Create an empty file. + open(os.path.join(cls.top_dir, filename), "w", encoding="utf-8").close() + except: + shutil.rmtree(cls.top_dir) + raise + + @classmethod + def tearDownClass(cls) -> None: + assert cls.top_dir is not None + shutil.rmtree(cls.top_dir) + + @staticmethod + def dedent(in_str: str) -> str: + out_str = textwrap.dedent(in_str) + if out_str.startswith("\n"): + out_str = out_str[1:] + return out_str + + def assert_html_out( + self, in_html: str, locale: str, expect_html: str, expect_assets: dict[str, str] + ) -> None: + assert self.html_path is not None + assert self.top_dir is not None + + with open(self.html_path, "w", encoding="utf-8") as file: + file.write(self.dedent(in_html)) + expect_html = self.dedent(expect_html) + + expect_assets = { + key: os.path.join(self.top_dir, val) for key, val in expect_assets.items() + } + + parser = ManualParser( + locale=locale, + html_path=self.html_path, + top_dir=self.top_dir, + all_locales=self.all_locales, + ) + out_html, out_assets = parser.process() + self.assertEqual(out_html, expect_html, "HTML should match") + self.assertEqual(out_assets, expect_assets) + + def assert_body_out( + self, + in_body: str, + expect_body: str, + expect_assets: dict[str, str], + locale: str = "ar", + ) -> None: + indent = " " + in_body = textwrap.indent(self.dedent(in_body), prefix=indent) + expect_body = textwrap.indent(self.dedent(expect_body), prefix=indent) + in_html = f""" + <html lang="{locale}" dir="rtl"> + <head> + <title>Test</title> + </head>\n{in_body}{indent}</html> + """ + expect_html = f""" + <!DOCTYPE html> + <html lang="{locale}" dir="rtl"> + <head> + {EXPECT_CSP_META} + <title>Test</title> + {EXPECT_SCRIPT} + </head>\n{expect_body}{indent}</html> + """ + self.assert_html_out(in_html, locale, expect_html, expect_assets) + + def assert_html_raises( + self, in_html: str, locale: str, expect_err_str: str + ) -> None: + assert self.html_path is not None + assert self.top_dir is not None + + with open(self.html_path, "w", encoding="utf-8") as file: + file.write(self.dedent(in_html)) + parser = ManualParser( + locale=locale, + html_path=self.html_path, + top_dir=self.top_dir, + all_locales=self.all_locales, + ) + with self.assertRaisesRegex( + ValueError, + r"^[^:]+.html: $[0-9]+, [0-9]+$: " + re.escape(expect_err_str) + "$", + ): + parser.process() + + def assert_body_raises(self, in_body: str, expect_err_str: str) -> None: + indent = " " + in_body = textwrap.indent(self.dedent(in_body), prefix=indent) + in_html = f""" + <html lang="ar" dir="rtl"> + <head> + <title>Test</title> + </head>\n{in_body}{indent}</html> + """ + self.assert_html_raises(in_html, "ar", expect_err_str) + + def test_empty_body(self) -> None: + self.assert_body_out("<body></body>\n", "<body></body>\n", {}) + + def test_html_tag(self) -> None: + self.assert_html_out( + """ + <html lang="en" dir="rtl"> + <head> + <title>Test</title> + </head> + <body> + </body> + </html> + """, + "en", + f""" + <!DOCTYPE html> + <html lang="en" dir="rtl"> + <head> + {EXPECT_CSP_META} + <title>Test</title> + {EXPECT_SCRIPT} + </head> + <body> + </body> + </html> + """, + {}, + ) + # Invalid. + self.assert_html_raises( + """ + <div> + <html> + </html> + </div> + """, + "ar", + "html has a parent", + ) + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + </html> + <html lang="en" dir="ltr"> + </html> + """, + "ar", + "More than one html tag", + ) + self.assert_html_raises( + """ + <html dir="rtl"> + </html> + """, + "ar", + "html is missing a lang attribute", + ) + self.assert_html_raises( + """ + <html lang="ar"> + </html> + """, + "ar", + "html is missing a dir attribute", + ) + self.assert_html_raises( + """ + <html lang="en" dir="rtl"> + </html> + """, + "ar", + "Unexpected lang attribute: en", + ) + self.assert_html_raises( + """ + <html lang="en" dir="LTR"> + </html> + """, + "en", + "Unexpected dir attribute: LTR", + ) + self.assert_html_raises( + """ + <html lang="en" dir="auto"> + </html> + """, + "en", + "Unexpected dir attribute: auto", + ) + + def test_head_ignored(self) -> None: + # Most of the tags and attributes in the head are ignored. + self.assert_html_out( + """ + <html lang="ar" dir="rtl" other="blah"> + <head attr="ignored"> + <meta charset="utf-8"> + <meta content="width=device-width, initial-scale=1.0" name="viewport" /> + <meta http-equiv="Content-Security-Policy" content="default-src 'self'"> + <link rel="stylesheet" href="../assets1/style1.css" other="blah"> + <link rel="other" href="https://example.org"> + <title some-attr="blah">دليل استخدام متصفح تور</title> + <script src="https://example.org"></script> + <script src="../script.js"></script> + <script> + const val = "hello"; + </script> + <div>oops</div> + <style> + body { + display: none; + } + </style> + </head> + <div>oops</div> + <body> + </body> + </html> + """, + "ar", + f""" + <!DOCTYPE html> + <html lang="ar" dir="rtl"> + <head> + {EXPECT_CSP_META} + <title>دليل استخدام متصفح تور</title> + {EXPECT_SCRIPT} + <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/html__assets1__style1.css" /> + </head> + <body> + </body> + </html> + """, + {"html__assets1__style1.css": "html/assets1/style1.css"}, + ) + + def test_title(self) -> None: + # NOTE: Expected to fail in python 3.13.5, 3.12.11, 3.11.12, 3.10.18, + # 3.9.22 and earlier, due to a bug in html.parser, which fails to treat + # the "<div>" as text content. This should not cause any issues in + # practice, since the title is not expected include a raw <. + # It is tested here for robustness. + self.assert_html_out( + """ + <html lang="ar" dir="rtl"> + <head> + <title>title content <div> 'more"</title> + </head> + <body> + </body> + </html> + """, + "ar", + f""" + <!DOCTYPE html> + <html lang="ar" dir="rtl"> + <head> + {EXPECT_CSP_META} + <title>title content <div> 'more"</title> + {EXPECT_SCRIPT} + </head> + <body> + </body> + </html> + """, + {}, + ) + # <title> elements outside the <head> are ignored. + self.assert_html_out( + """ + <html lang="ar" dir="rtl"> + <head> + <title>Test</title> + </head> + <title>Some other title</title> + <body> + <title>Body title</title> + </body> + </html> + """, + "ar", + f""" + <!DOCTYPE html> + <html lang="ar" dir="rtl"> + <head> + {EXPECT_CSP_META} + <title>Test</title> + {EXPECT_SCRIPT} + </head> + <body> + <title>Body title</title> + </body> + </html> + """, + {}, + ) + + def test_stylesheets(self) -> None: + self.assert_html_out( + """ + <html lang="ar" dir="rtl"> + <head> + <link rel="stylesheet" href="../assets1/style1.css"> + <link rel="stylesheet" href="../../assets2/sub/style2.css?query=ignored"> + <link rel="stylesheet" href="/assets2/style2.css#anchor-ignored"> + <link rel="stylesheet" href="neighbour1.css"> + <link rel="stylesheet" href="./neighbour2.css"> + <title>دليل استخدام متصفح تور</title> + </head> + <body> + </body> + </html> + """, + "ar", + f""" + <!DOCTYPE html> + <html lang="ar" dir="rtl"> + <head> + {EXPECT_CSP_META} + <title>دليل استخدام متصفح تور</title> + {EXPECT_SCRIPT} + <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/html__assets1__style1.css" /> + <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/assets2__sub__style2.css" /> + <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/assets2__style2.css" /> + <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/html__html__neighbour1.css" /> + <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/html__html__neighbour2.css" /> + </head> + <body> + </body> + </html> + """, + { + "html__assets1__style1.css": "html/assets1/style1.css", + "assets2__sub__style2.css": "assets2/sub/style2.css", + "assets2__style2.css": "assets2/style2.css", + "html__html__neighbour1.css": "html/html/neighbour1.css", + "html__html__neighbour2.css": "html/html/neighbour2.css", + }, + ) + + # Stylesheets and img references are treated the same. + self.assert_html_out( + """ + <html lang="ar" dir="rtl"> + <head> + <link rel="stylesheet" href="../assets1/style1.css"> + <link rel="stylesheet" href="/assets2/sub/style2.css"> + <link rel="stylesheet" href="neighbour2.css"> + <title>دليل استخدام متصفح تور</title> + </head> + <body> + <img src="../assets1/image1.png"> + <img src="/assets2/image2.png"> + <img src="neighbour2.svg"> + </body> + </html> + """, + "ar", + f""" + <!DOCTYPE html> + <html lang="ar" dir="rtl"> + <head> + {EXPECT_CSP_META} + <title>دليل استخدام متصفح تور</title> + {EXPECT_SCRIPT} + <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/html__assets1__style1.css" /> + <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/assets2__sub__style2.css" /> + <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/html__html__neighbour2.css" /> + </head> + <body> + <img src="{EXPECT_CHROME_ASSETS}/html__assets1__image1.png" /> + <img src="{EXPECT_CHROME_ASSETS}/assets2__image2.png" /> + <img src="{EXPECT_CHROME_ASSETS}/html__html__neighbour2.svg" /> + </body> + </html> + """, + { + "html__assets1__style1.css": "html/assets1/style1.css", + "assets2__sub__style2.css": "assets2/sub/style2.css", + "html__html__neighbour2.css": "html/html/neighbour2.css", + "html__assets1__image1.png": "html/assets1/image1.png", + "assets2__image2.png": "assets2/image2.png", + "html__html__neighbour2.svg": "html/html/neighbour2.svg", + }, + ) + + # Invalid stylesheets. + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <link rel="stylesheet" href="https://example.org"> + </head> + </html> + """, + "ar", + "Unexpected asset path with a scheme: https", + ) + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <link rel="stylesheet" href="./style.css"> + </head> + </html> + """, + "ar", + f"References a non-existent asset: {self.top_dir}/html/html/style.css", + ) + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <link rel="stylesheet" href="style.css"> + </head> + </html> + """, + "ar", + f"References a non-existent asset: {self.top_dir}/html/html/style.css", + ) + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <link rel="stylesheet" href="/style.css"> + </head> + </html> + """, + "ar", + f"References a non-existent asset: {self.top_dir}/style.css", + ) + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <link rel="stylesheet" href="../../../style.css"> + </head> + </html> + """, + "ar", + f"References an asset outside {self.top_dir}", + ) + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <link rel="stylesheet" href="/../style.css"> + </head> + </html> + """, + "ar", + f"References an asset outside {self.top_dir}", + ) + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <link rel="stylesheet" href="../none.css"> + </head> + </html> + """, + "ar", + f"References a non-existent asset: {self.top_dir}/html/none.css", + ) + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <link rel="stylesheet"> + </head> + </html> + """, + "ar", + "stylesheet link missing an href", + ) + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <link rel="stylesheet" href> + </head> + </html> + """, + "ar", + "stylesheet link missing an href", + ) + + def test_tag_tracking(self) -> None: + # Convert a self-closing non-void tag into a pair of tags with no content. + self.assert_body_out( + """ + <body> + <div class="ok" /> + </body> + """, + """ + <body> + <div class="ok"></div> + </body> + """, + {}, + ) + # Convert a void tag into a self-closing tag. + self.assert_body_out( + """ + <body> + <img class="ok"> + <br> + <hr> + <hr /> + </body> + """, + """ + <body> + <img class="ok" /> + <br /> + <hr /> + <hr /> + </body> + """, + {}, + ) + + # Trying to close a void tag. + # Missing the </div>. + self.assert_body_raises( + """ + <body> + <img></img> + </body> + """, + "Unmatched end tag: img", + ) + # Missing the </div>. + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <title>Test</title> + <div> + </head> + <body> + </body> + </html> + """, + "ar", + "Unmatched end tag: head", + ) + # Closing tag with no starting tag. + self.assert_body_raises( + """ + <body> + </div > + </body> + """, + "Unmatched end tag: div", + ) + # Missing the </div> + self.assert_body_raises( + """ + <body> + <div> + </body> + """, + "Unmatched end tag: body", + ) + # Missing the closing </html> + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <title>Test</title> + </head> + <body> + </body> + """, + "ar", + "Document was not closed", + ) + # Closing an unmatched tag in the outer scope. + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <head> + <title>Test</title> + </head> + <body> + </body> + </html> + </div> + """, + "ar", + "Unmatched end tag: div", + ) + + # Duplicate attributes. + self.assert_body_raises( + """ + <body class="ok" class="other"></body> + """, + "body has a duplicate attribute: class", + ) + + def test_misc_data(self) -> None: + # Comments are ignored. + self.assert_body_out( + """ + <body> + <div>ab<! hello ></div></ bogus comment> + </body> + """, + """ + <body> + <div>ab</div> + </body> + """, + {}, + ) + # Attributes and content are escaped. + self.assert_body_out( + """ + <body> + <div empty-attr attr2="'hello" attr='"<div>inject'>x < "6"</div attr2="hello"> + </body> + """, + """ + <body> + <div empty-attr attr2="'hello" attr=""<div>inject">x < "6"</div> + </body> + """, + {}, + ) + + # CDATA. + self.assert_body_raises( + """ + <body> + <div> + <![CDATA[<img class="ok">]]> + </div> + </body> + """, + "Unknown declaration", + ) + + # A doctype html at the start is ok. + self.assert_html_out( + """ + <!DOCTYPE html> + <html lang="ar" dir="rtl"> + <head> + <title>Test</title> + </head> + <body></body> + </html> + """, + "ar", + f""" + <!DOCTYPE html> + <html lang="ar" dir="rtl"> + <head> + {EXPECT_CSP_META} + <title>Test</title> + {EXPECT_SCRIPT} + </head> + <body></body> + </html> + """, + {}, + ) + # Other declarations are not ok. + self.assert_html_raises( + """ + <!DOCTYPE other> + <html></html> + """, + "ar", + "Unexpected declaration", + ) + # Declaration further down. + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <!DOCTYPE html> + </html> + """, + "ar", + "Unexpected declaration", + ) + # Processing instruction. + self.assert_body_raises( + """ + <body> + <?xml-stylesheet href="style.css"?> + </body> + """, + "Unexpected processing instruction", + ) + + def test_body_tag(self) -> None: + # Attributes are preserved. + self.assert_body_out( + """ + <body class="my-class" attr="blah"> + <div></div> + </body> + """, + """ + <body class="my-class" attr="blah"> + <div></div> + </body> + """, + {}, + ) + # Invalid. + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <div> + <body> + </body> + </div> + </html> + """, + "ar", + "Wrong context for the body tag", + ) + self.assert_html_raises( + """ + <html lang="ar" dir="rtl"> + <body> + </body> + <div></div> + <body></body> + </html> + """, + "ar", + "More than one body tag", + ) + self.assert_body_raises( + """ + <body> + <div> + <body></body> + </div> + </body> + """, + "Unexpected body tag in body", + ) + self.assert_body_raises( + """ + <body> + <main> + <script src="inject"> + </script> + </main> + </body> + """, + "Unexpected script tag in body", + ) + self.assert_body_raises( + """ + <body> + <main> + <SCRIpT>const val = "inject";</SCRIpT> + </main> + </body> + """, + "Unexpected script tag in body", + ) + self.assert_body_raises( + """ + <body> + <meta http-equiv="Content-Security-Policy" content="default-src 'self'"> + </body> + """, + "Unexpected meta tag in body", + ) + self.assert_body_raises( + """ + <body> + <link href="inject"> + </body> + """, + "Unexpected link tag in body", + ) + self.assert_body_raises( + "<body><noscript></noscript></body>", "Unexpected noscript tag in body" + ) + self.assert_body_raises( + "<body><html>content</html></body>", "Unexpected html tag in body" + ) + self.assert_body_raises( + "<body><head></head></body>", "Unexpected head tag in body" + ) + + def test_img_tag(self) -> None: + self.assert_body_out( + """ + <body> + <img src="../assets1/image1.png"> + </body> + """, + f""" + <body> + <img src="{EXPECT_CHROME_ASSETS}/html__assets1__image1.png" /> + </body> + """, + {"html__assets1__image1.png": "html/assets1/image1.png"}, + ) + # Multiple and duplicates. + self.assert_body_out( + """ + <body> + <img src="../assets1/image1.png"> + + <div> + <img src="../assets1/image1.png"> + <p> + <img src="../../assets2/image2.png" alt="hello"/> + <img src="./neighbour1.svg"> + </p> + <img src="../../assets2/sub/image2.png" + ><br> + <img src="/assets2/sub/image2.png"> + <img src="neighbour1.svg"> + <img src="./neighbour2.svg"> + </div> + </body> + """, + f""" + <body> + <img src="{EXPECT_CHROME_ASSETS}/html__assets1__image1.png" /> + + <div> + <img src="{EXPECT_CHROME_ASSETS}/html__assets1__image1.png" /> + <p> + <img src="{EXPECT_CHROME_ASSETS}/assets2__image2.png" alt="hello" /> + <img src="{EXPECT_CHROME_ASSETS}/html__html__neighbour1.svg" /> + </p> + <img src="{EXPECT_CHROME_ASSETS}/assets2__sub__image2.png" /><br /> + <img src="{EXPECT_CHROME_ASSETS}/assets2__sub__image2.png" /> + <img src="{EXPECT_CHROME_ASSETS}/html__html__neighbour1.svg" /> + <img src="{EXPECT_CHROME_ASSETS}/html__html__neighbour2.svg" /> + </div> + </body> + """, + { + "html__assets1__image1.png": "html/assets1/image1.png", + "assets2__image2.png": "assets2/image2.png", + "assets2__sub__image2.png": "assets2/sub/image2.png", + "html__html__neighbour1.svg": "html/html/neighbour1.svg", + "html__html__neighbour2.svg": "html/html/neighbour2.svg", + }, + ) + + # Invalid. + self.assert_body_raises( + """ + <body> + <img src="https://example.org"> + </body> + """, + "Unexpected asset path with a scheme: https", + ) + self.assert_body_raises( + """ + <body> + <img src="./image.png"> + </body> + """, + f"References a non-existent asset: {self.top_dir}/html/html/image.png", + ) + self.assert_body_raises( + """ + <body> + <img src="image.png"> + </body> + """, + f"References a non-existent asset: {self.top_dir}/html/html/image.png", + ) + self.assert_body_raises( + """ + <body> + <img src="/image.png"> + </body> + """, + f"References a non-existent asset: {self.top_dir}/image.png", + ) + self.assert_body_raises( + """ + <body> + <img src="../../../image.css"> + </body> + """, + f"References an asset outside {self.top_dir}", + ) + self.assert_body_raises( + """ + <body> + <img src="/../image.css"> + </body> + """, + f"References an asset outside {self.top_dir}", + ) + self.assert_body_raises( + """ + <body> + <img src="../none.png"> + </body> + """, + f"References a non-existent asset: {self.top_dir}/html/none.png", + ) + self.assert_body_raises( + """ + <body> + <img srcset="../assets1/image1.png 2x, ../assets1/image1.png" /> + </body> + """, + "Unhandled srcset attribute", + ) + + # Special characters are substituted to safe characters. + self.assert_body_out( + """ + <body> + <img src="../assets1/🦭.svg"> + </body> + """, + f""" + <body> + <img src="{EXPECT_CHROME_ASSETS}/html__assets1___.svg" /> + </body> + """, + {"html__assets1___.svg": "html/assets1/🦭.svg"}, + ) + self.assert_body_out( + """ + <body> + <img src="../assets1/~.svg"> + <img src="../assets1/image(a)2x.png"> + </body> + """, + f""" + <body> + <img src="{EXPECT_CHROME_ASSETS}/html__assets1___.svg" /> + <img src="{EXPECT_CHROME_ASSETS}/html__assets1__image_2x.png" /> + </body> + """, + { + "html__assets1___.svg": "html/assets1/~.svg", + "html__assets1__image_2x.png": "html/assets1/image(a)2x.png", + }, + ) + # Conflicting names. + self.assert_body_raises( + """ + <body> + <img src="../assets1/~.svg"> + <img src="../assets1/🦭.svg"> + </body> + """, + "More than one asset with the same name: html__assets1___.svg", + ) + + def test_a_tag(self) -> None: + # Internal or no href. + self.assert_body_out( + """ + <body> + <div> + <a href="#index">index</a> + <a href="#index" rel="author" class="ok">in<span>d</span>ex</a> + <a rel="author noreferrer">none</a> + </div> + <div id="index"></div> + </body> + """, + """ + <body> + <div> + <a href="#index">index</a> + <a href="#index" class="ok">in<span>d</span>ex</a> + <a>none</a> + </div> + <div id="index"></div> + </body> + """, + {}, + ) + + # External. + self.assert_body_out( + """ + <body> + <a href="https://example.org">example</a> + <a href="https://example.org?query=ok" rel="noopener" class="hello">example2</a> + <a href="https://example.net" referrerpolicy="no-referrer" target="self">example3</a> + </body> + """, + """ + <body> + <a href="https://example.org" target="_blank" rel="noreferrer">example</a> + <a href="https://example.org?query=ok" class="hello" target="_blank" rel="noreferrer">example2</a> + <a href="https://example.net" target="_blank" rel="noreferrer">example3</a> + </body> + """, + {}, + ) + + # Relative: tor-browser. + self.assert_body_out( + """ + <body> + <a href="../../tor-browser/sub-page/">other section</a> + <a href="../../tor-browser/sub-page" rel="author prev">other section2</a> + <div> + <a href="../../tor-browser/sub-page#anchor">other section3</a> + <a href="../../tor-browser/sub-page/further#anchor" class="ok">other section4</a> + </div> + <div id="sub-page"> + <span id="sub-page___anchor"></span> + <div id="sub-page__further"> + <span id="sub-page__further___anchor"></span> + </div> + </div> + </body> + """, + """ + <body> + <a href="#sub-page">other section</a> + <a href="#sub-page">other section2</a> + <div> + <a href="#sub-page___anchor">other section3</a> + <a href="#sub-page__further___anchor" class="ok">other section4</a> + </div> + <div id="sub-page"> + <span id="sub-page___anchor"></span> + <div id="sub-page__further"> + <span id="sub-page__further___anchor"></span> + </div> + </div> + </body> + """, + {}, + ) + # A plain "tor-browser/" will point to "#index" as a special case. + self.assert_body_out( + """ + <body> + <a href="../../tor-browser/">top</a> + <div id="index"></div> + </body> + """, + """ + <body> + <a href="#index">top</a> + <div id="index"></div> + </body> + """, + {}, + ) + # Relative: outside tor-browser and get-in-touch. + self.assert_body_out( + """ + <body> + <a href="../../tor-vpn/sub-page">Tor VPN</a> + <a href="../../tor-vpn/sub-page?query=ok#anchor">Tor VPN</a> + </body> + """, + """ + <body> + <a href="https://support.torproject.org/ar/tor-vpn/sub-page" target="_blank" rel="noreferrer">Tor VPN</a> + <a href="https://support.torproject.org/ar/tor-vpn/sub-page#anchor" target="_blank" rel="noreferrer">Tor VPN</a> + </body> + """, + {}, + locale="ar", + ) + # For the "en" locale, we do not include /en/ in the support URL. + self.assert_body_out( + """ + <body> + <a href="../../tor-vpn/sub-page">Tor VPN</a> + <a href="../../tor-vpn/sub-page?query=ok#anchor">Tor VPN</a> + </body> + """, + """ + <body> + <a href="https://support.torproject.org/tor-vpn/sub-page" target="_blank" rel="noreferrer">Tor VPN</a> + <a href="https://support.torproject.org/tor-vpn/sub-page#anchor" target="_blank" rel="noreferrer">Tor VPN</a> + </body> + """, + {}, + locale="en", + ) + # Relative: get-in-touch. + # Only "bug-or-feedback" or "user-support" is expected. + self.assert_body_out( + """ + <body> + <a href="../../get-in-touch/bug-or-feedback" class="hello">bug</a> + <a href="../../get-in-touch/user-support#anchor">support</a> + <a href="../../get-in-touch/other">get in touch other</a> + <a href="../../get-in-touch">get in touch top</a> + <div id="get-in-touch__bug-or-feedback"></div> + <div id="get-in-touch__user-support___anchor"></div> + </body> + """, + """ + <body> + <a href="#get-in-touch__bug-or-feedback" class="hello">bug</a> + <a href="#get-in-touch__user-support___anchor">support</a> + <a href="https://support.torproject.org/ar/get-in-touch/other" target="_blank" rel="noreferrer">get in touch other</a> + <a href="https://support.torproject.org/ar/get-in-touch" target="_blank" rel="noreferrer">get in touch top</a> + <div id="get-in-touch__bug-or-feedback"></div> + <div id="get-in-touch__user-support___anchor"></div> + </body> + """, + {}, + locale="ar", + ) + + # mailto href is removed. + self.assert_body_out( + """ + <body> + <a href="mailto:me@email.org" class="ok">email</a> + </body> + """, + """ + <body> + <a class="ok">email</a> + </body> + """, + {}, + ) + + # Missing internal id. + self.assert_body_raises( + """ + <body> + <a href="#top"></a> + </body> + """, + "Missing an element with the id top", + ) + + # Missing internal id. + self.assert_body_raises( + """ + <body> + <a href="../../tor-browser/sub-page"></a> + </body> + """, + "Missing an element with the id sub-page", + ) + + # Unhandled hrefs. + self.assert_body_raises( + """ + <body> + <a href="../page"></a> + </body> + """, + "Unexpected href: ../page", + ) + self.assert_body_raises( + """ + <body> + <a href="chrome://page"></a> + </body> + """, + "Unexpected href: chrome://page", + ) + self.assert_body_raises( + """ + <body> + <a href="../../../page"></a> + </body> + """, + "Unexpected path: ../../../page", + ) + self.assert_body_raises( + """ + <body> + <a href="../../page/./"></a> + </body> + """, + "Unexpected path: ../../page/./", + ) + self.assert_body_raises( + """ + <body> + <a href="../../page/../other"></a> + </body> + """, + "Unexpected path: ../../page/../other", + ) + + def test_ids(self) -> None: + # The "id" of the heading-anchor adopts a prefix from the nearest + # olm-page. + self.assert_body_out( + """ + <body> + <div class="other olm-page" id="somesection"> + <main> + <div id="somename" class="heading-anchor other"></div> + <h2>Some heading</h2> + </main> + </div> + </body> + """, + """ + <body> + <div class="other olm-page" id="somesection"> + <main> + <div id="somesection___somename" class="heading-anchor other"></div> + <h2>Some heading</h2> + </main> + </div> + </body> + """, + {}, + ) + + # Multiple. + self.assert_body_out( + """ + <body> + <div class="other olm-page" id="somesection"> + <main> + <div id="somename" class="heading-anchor other"></div> + <h2>Some heading</h2> + </main> + </div> + <div> + <div class="olm-page" id="somesection__2"> + <main> + <div> + <div id="somename2" class="heading-anchor"></div> + <h2>Some heading</h2> + </div> + </main> + </div> + </div> + </body> + """, + """ + <body> + <div class="other olm-page" id="somesection"> + <main> + <div id="somesection___somename" class="heading-anchor other"></div> + <h2>Some heading</h2> + </main> + </div> + <div> + <div class="olm-page" id="somesection__2"> + <main> + <div> + <div id="somesection__2___somename2" class="heading-anchor"></div> + <h2>Some heading</h2> + </div> + </main> + </div> + </div> + </body> + """, + {}, + ) + + # Duplicate ids. + self.assert_body_raises( + """ + <body> + <div id="first"></div> + <div id="first"></div> + </body> + """, + "Duplicate id: first", + ) + self.assert_body_raises( + """ + <body> + <div id="somesection___somename"></div> + <div class="olm-page" id="somesection"> + <div id="somename" class="heading-anchor"></div> + </div> + </body> + """, + "Duplicate id: somesection___somename", + ) + + # Ignore duplicate ids on a toggler element. + # TODO: tor-browser-build#41818. Remove this part of the test. + self.assert_body_out( + """ + <body> + <div id="first"></div> + <input id="first" class="toggler"> + </body> + """, + """ + <body> + <div id="first"></div> + <input class="toggler" /> + </body> + """, + {}, + ) + + # Nested olm-page. + self.assert_body_raises( + """ + <body> + <div class="olm-page" id="outer"> + <main> + <div class="olm-page" id="outer__sub"></div> + </main> + </div> + </body> + """, + "olm-page is below another", + ) + + # olm-page with no id. + self.assert_body_raises( + """ + <body> + <div class="olm-page"></div> + </body> + """, + "olm-page is missing an id", + ) + + # Missing olm-page. + self.assert_body_raises( + """ + <body> + <div class="olm-page" id="ok"></div> + <div class="heading-anchor" id="ok2"></div> + </body> + """, + "Missing a page to use for the heading id", + ) + + # heading-anchor with no id. + self.assert_body_raises( + """ + <body> + <div class="olm-page" id="ok"> + <div class="heading-anchor"></div> + </div> + </body> + """, + "Heading is missing an id", + ) + + +class TestMain(unittest.TestCase): + # Set the TestCase.maxDiff to a larger number to see the full HTML. + maxDiff = 2000 + + def setUp(self) -> None: + self.root_dir = tempfile.mkdtemp() + try: + os.chdir(self.root_dir) + self.public_dir = os.path.join(self.root_dir, "public") + self.out_dir = os.path.join(self.root_dir, "output") + self.out_locales = os.path.join(self.root_dir, "locales/available") + os.mkdir(self.public_dir) + os.mkdir(self.out_dir) + os.mkdir(os.path.dirname(self.out_locales)) + except: + shutil.rmtree(self.root_dir) + raise + + def tearDown(self) -> None: + shutil.rmtree(self.root_dir) + + def assert_out_content(self, path: str, expect_content: str) -> None: + with open(os.path.join(self.out_dir, path), encoding="utf-8") as file: + self.assertEqual(file.read(), expect_content) + + def test_locales(self) -> None: + base = "offline/tor-browser/index.html" + for locale, rel_path in ( + ("en", base), + ("ar", f"ar/{base}"), + ("zh-CN", f"zh-CN/{base}"), + # Locales with the wrong lang tags should be ignored. + ("inv", f"inv/{base}"), + ("in-VAL", f"in-VAL/{base}"), + (",", f",/{base}"), + ): + path = os.path.join(self.public_dir, rel_path) + os.makedirs(os.path.dirname(path)) + with open(path, "w", encoding="utf-8") as file: + file.write( + "<!DOCTYPE html>" + f'<html lang={locale} dir="rtl">' + f"<head><title>{locale} manual</title></head><body>" + '<a href="../../other">content</a>' + '<a href="../../tor-browser/sub-page"></a><div id="sub-page"></div>' + "</body></html>" + ) + # Directories with the correct code, but no index.html file in the + # expected place are ignored. + os.makedirs(os.path.join(self.public_dir, "js")) + os.makedirs(os.path.join(self.public_dir, "de/offline/tor-browser")) + # File in wrong place: + open( + os.path.join(self.public_dir, "de/offline/index.html"), + "w", + encoding="utf-8", + ).close() + # Not a file: + os.makedirs(os.path.join(self.public_dir, f"bb/{base}")) + + main(self.public_dir, self.out_dir, self.out_locales) + + self.assertCountEqual( + os.listdir(self.out_dir), + [ + "assets", + "aboutManual-en.html", + "aboutManual-ar.html", + "aboutManual-zh-CN.html", + ], + ) + self.assertEqual(os.listdir(os.path.join(self.out_dir, "assets")), []) + + with open(self.out_locales, encoding="utf-8") as file: + self.assertEqual(file.read(), "ar,en,zh-CN", "list matches") + + for locale, is_default in (("en", True), ("ar", False), ("zh-CN", False)): + filename = f"aboutManual-{locale}.html" + support_page = ( + "https://support.torproject.org/other" + if is_default + else f"https://support.torproject.org/{locale}/other" + ) + self.assert_out_content( + filename, + "<!DOCTYPE html>\n" + f'<html lang="{locale}" dir="rtl">\n<head>\n' + f" {EXPECT_CSP_META}\n" + f" <title>{locale} manual</title>\n" + f" {EXPECT_SCRIPT}\n" + "</head>\n<body>" + f'<a href="{support_page}" target="_blank" rel="noreferrer">content</a>' + '<a href="#sub-page"></a><div id="sub-page"></div>' + "</body>\n</html>\n", + ) + + # Missing default locale's HTML. + default_html = os.path.join(self.public_dir, base) + os.unlink(default_html) + with self.assertRaisesRegex( + ValueError, rf"Missing file: {re.escape(default_html)}" + ): + main(self.public_dir, self.out_dir, self.out_locales) + + def test_assets(self) -> None: + def write_html( + path: str, locale: str, style1: str, style2: str, image1: str, image2: str + ) -> None: + path = os.path.join(self.public_dir, path) + os.makedirs(os.path.dirname(path), exist_ok=True) + with open(path, "w", encoding="utf-8") as file: + file.write( + "<!DOCTYPE html>\n" + f'<html lang={locale} dir="rtl">\n' + "<head>" + f'<link rel="stylesheet" href={style1}>' + "<title>Test</title>" + f'<link rel="stylesheet" href={style2}>' + "</head><body>" + f'<img src="{image1}"><img src="{image2}">' + "</body></html>" + ) + + for rel_path, content in ( + ("offline/ltr.min.css", "0"), + ("offline/rtl.min.css", "1"), + ("static/style.css", "2"), + ("offline/image.png", "3"), + ("ar/offline/image.png", "4"), + ("sub/page/image(a)2x.png", "5"), + ("sub/page/image~2x.png", "6"), + ): + orig_path = os.path.join(self.public_dir, rel_path) + os.makedirs(os.path.dirname(orig_path), exist_ok=True) + with open(orig_path, "w", encoding="utf-8") as file: + file.write(content) + + write_html( + "offline/tor-browser/index.html", + "en", + "../ltr.min.css", + "../../static/style.css", + "../image.png", + "../../sub/page/image(a)2x.png", + ) + write_html( + "ar/offline/tor-browser/index.html", + "ar", + "../../../offline/rtl.min.css", + "../../../static/style.css", + "../image.png", + "../../../sub/page/image(a)2x.png", + ) + + main(self.public_dir, self.out_dir, self.out_locales) + + self.assertCountEqual( + os.listdir(self.out_dir), + ["assets", "aboutManual-en.html", "aboutManual-ar.html"], + ) + self.assertCountEqual( + os.listdir(os.path.join(self.out_dir, "assets")), + [ + "offline__ltr.min.css", + "offline__rtl.min.css", + "static__style.css", + "offline__image.png", + "ar__offline__image.png", + "sub__page__image_2x.png", + ], + ) + + self.assert_out_content( + "aboutManual-en.html", + "<!DOCTYPE html>\n" + '<html lang="en" dir="rtl">\n' + "<head>\n" + f" {EXPECT_CSP_META}\n" + " <title>Test</title>\n" + f" {EXPECT_SCRIPT}\n" + f' <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/offline__ltr.min.css" />\n' + f' <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/static__style.css" />\n' + "</head>\n<body>" + f'<img src="{EXPECT_CHROME_ASSETS}/offline__image.png" />' + f'<img src="{EXPECT_CHROME_ASSETS}/sub__page__image_2x.png" />' + "</body>\n</html>\n", + ) + + self.assert_out_content( + "aboutManual-ar.html", + "<!DOCTYPE html>\n" + '<html lang="ar" dir="rtl">\n' + "<head>\n" + f" {EXPECT_CSP_META}\n" + " <title>Test</title>\n" + f" {EXPECT_SCRIPT}\n" + f' <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/offline__rtl.min.css" />\n' + f' <link rel="stylesheet" href="{EXPECT_CHROME_ASSETS}/static__style.css" />\n' + "</head>\n<body>" + f'<img src="{EXPECT_CHROME_ASSETS}/ar__offline__image.png" />' + f'<img src="{EXPECT_CHROME_ASSETS}/sub__page__image_2x.png" />' + "</body>\n</html>\n", + ) + + # Make sure the new assets were copied over. + self.assert_out_content("assets/offline__ltr.min.css", "0") + self.assert_out_content("assets/offline__rtl.min.css", "1") + self.assert_out_content("assets/static__style.css", "2") + self.assert_out_content("assets/offline__image.png", "3") + self.assert_out_content("assets/ar__offline__image.png", "4") + self.assert_out_content("assets/sub__page__image_2x.png", "5") + + # Duplicate asset names, from different files. + write_html( + "offline/tor-browser/index.html", + "en", + "../ltr.min.css", + "../../static/style.css", + "../image.png", + "../../sub/page/image~2x.png", + ) + with self.assertRaisesRegex( + ValueError, r"^Duplicate asset names: sub__page__image_2x.png$" + ): + main(self.public_dir, self.out_dir, self.out_locales) + + # Wrong relative path. + write_html( + "ar/offline/tor-browser/index.html", + "ar", + "../../../offline/rtl.min.css", + # Wrong relative path for the "ar" directory: + "../static/style.css", + "../image.png", + "../../../sub/page/image~2x.png", + ) + with self.assertRaisesRegex( + ValueError, + r"^.*: References a non-existent asset: .*/ar/offline/static/style\.css$", + ): + main(self.public_dir, self.out_dir, self.out_locales) View it on GitLab: https://gitlab.torproject.org/tpo/applications/tor-browser-build/-/commit/f… -- View it on GitLab: https://gitlab.torproject.org/tpo/applications/tor-browser-build/-/commit/f… You're receiving this email because of your account on gitlab.torproject.org. Manage all notifications: https://gitlab.torproject.org/-/profile/notifications | Help: https://gitlab.torproject.org/help

1 0

[Git][tpo/applications/mullvad-browser][mullvad-browser-153.0a1-16.0-2] fixup! Firefox preference overrides.
by Pier Angelo Vendrame (＠pierov) 20 Jul '26

20 Jul '26

Pier Angelo Vendrame pushed to branch mullvad-browser-153.0a1-16.0-2 at The Tor Project / Applications / Mullvad Browser Commits: 01b97e0c by Pier Angelo Vendrame at 2026-07-20T11:53:19+02:00 fixup! Firefox preference overrides. BB 45110: Disable the settings redesign until we feel it's ready for us. - - - - - 1 changed file: - browser/app/profile/001-base-profile.js Changes: ===================================== browser/app/profile/001-base-profile.js ===================================== @@ -230,6 +230,10 @@ pref("browser.urlbar.update2.engineAliasRefresh", false); // https://bugzilla.mozilla.org/show_bug.cgi?id=1915280 pref("browser.uitour.enabled", false); +// tor-browser#45110: Disable unified settings until we have migrated all our +// settings and have applied our desired changes to upstream new designs. +pref("browser.settings-redesign.enabled", false); + // Make sure Unified Telemetry is really disabled, see: #18738. pref("toolkit.telemetry.unified", false); // This needs to be locked, or nightly builds will automatically lock it to true View it on GitLab: https://gitlab.torproject.org/tpo/applications/mullvad-browser/-/commit/01b… -- View it on GitLab: https://gitlab.torproject.org/tpo/applications/mullvad-browser/-/commit/01b… You're receiving this email because of your account on gitlab.torproject.org. Manage all notifications: https://gitlab.torproject.org/-/profile/notifications | Help: https://gitlab.torproject.org/help

1 0

[Git][tpo/applications/tor-browser][tor-browser-153.0a1-16.0-2] fixup! Firefox preference overrides.
by Pier Angelo Vendrame (＠pierov) 20 Jul '26

20 Jul '26

Pier Angelo Vendrame pushed to branch tor-browser-153.0a1-16.0-2 at The Tor Project / Applications / Tor Browser Commits: 94bcf6f8 by Pier Angelo Vendrame at 2026-07-16T17:39:02+02:00 fixup! Firefox preference overrides. BB 45110: Disable the settings redesign until we feel it's ready for us. - - - - - 1 changed file: - browser/app/profile/001-base-profile.js Changes: ===================================== browser/app/profile/001-base-profile.js ===================================== @@ -230,6 +230,10 @@ pref("browser.urlbar.update2.engineAliasRefresh", false); // https://bugzilla.mozilla.org/show_bug.cgi?id=1915280 pref("browser.uitour.enabled", false); +// tor-browser#45110: Disable unified settings until we have migrated all our +// settings and have applied our desired changes to upstream new designs. +pref("browser.settings-redesign.enabled", false); + // Make sure Unified Telemetry is really disabled, see: #18738. pref("toolkit.telemetry.unified", false); // This needs to be locked, or nightly builds will automatically lock it to true View it on GitLab: https://gitlab.torproject.org/tpo/applications/tor-browser/-/commit/94bcf6f… -- View it on GitLab: https://gitlab.torproject.org/tpo/applications/tor-browser/-/commit/94bcf6f… You're receiving this email because of your account on gitlab.torproject.org. Manage all notifications: https://gitlab.torproject.org/-/profile/notifications | Help: https://gitlab.torproject.org/help

1 0

[Git][tpo/applications/tor-browser] Pushed new tag FIREFOX_153_0esr_BUILD1
by Pier Angelo Vendrame (＠pierov) 20 Jul '26

20 Jul '26

Pier Angelo Vendrame pushed new tag FIREFOX_153_0esr_BUILD1 at The Tor Project / Applications / Tor Browser -- View it on GitLab: https://gitlab.torproject.org/tpo/applications/tor-browser/-/tree/FIREFOX_1… You're receiving this email because of your account on gitlab.torproject.org. Manage all notifications: https://gitlab.torproject.org/-/profile/notifications | Help: https://gitlab.torproject.org/help

1 0

[Git][tpo/applications/mullvad-browser][mullvad-browser-153.0a1-16.0-2] BB 45102: Use match-any logic for XPCShell tags
by brizental (＠brizental) 16 Jul '26

16 Jul '26

brizental pushed to branch mullvad-browser-153.0a1-16.0-2 at The Tor Project / Applications / Mullvad Browser Commits: c7a101d5 by Beatriz Rizental at 2026-07-16T13:55:20-03:00 BB 45102: Use match-any logic for XPCShell tags This is being upstream'd in https://bugzilla.mozilla.org/show_bug.cgi?id=2052314 - - - - - 2 changed files: - testing/mozbase/manifestparser/manifestparser/filters.py - testing/xpcshell/runxpcshelltests.py Changes: ===================================== testing/mozbase/manifestparser/manifestparser/filters.py ===================================== @@ -361,7 +361,7 @@ class tags(InstanceFilter): """ Removes tests that don't contain any of the given tags. This overrides InstanceFilter's __eq__ method, so multiple instances can be added. - Multiple tag filters is equivalent to joining tags with the AND operator. + Multiple tag filters is equivalent to joining tags with the OR operator. To define a tag in a manifest, add a `tags` attribute to a test or DEFAULT section. Tests can have multiple tags, in which case they should be ===================================== testing/xpcshell/runxpcshelltests.py ===================================== @@ -1281,7 +1281,7 @@ class XPCShellTests: filters = [] if test_tags: - filters.extend([tags(x) for x in test_tags]) + filters.append(tags(test_tags)) path_filter = None if test_paths: View it on GitLab: https://gitlab.torproject.org/tpo/applications/mullvad-browser/-/commit/c7a… -- View it on GitLab: https://gitlab.torproject.org/tpo/applications/mullvad-browser/-/commit/c7a… You're receiving this email because of your account on gitlab.torproject.org. Manage all notifications: https://gitlab.torproject.org/-/profile/notifications | Help: https://gitlab.torproject.org/help

1 0

[Git][tpo/applications/tor-browser] Pushed new branch tor-browser-153.0esr-16.0-1
by Pier Angelo Vendrame (＠pierov) 16 Jul '26

16 Jul '26

Pier Angelo Vendrame pushed new branch tor-browser-153.0esr-16.0-1 at The Tor Project / Applications / Tor Browser -- View it on GitLab: https://gitlab.torproject.org/tpo/applications/tor-browser/-/tree/tor-brows… You're receiving this email because of your account on gitlab.torproject.org. Manage all notifications: https://gitlab.torproject.org/-/profile/notifications | Help: https://gitlab.torproject.org/help

1 0

[Git][tpo/applications/mullvad-browser][mullvad-browser-153.0a1-16.0-2] fixup! MB 21: Disable the password manager
by Pier Angelo Vendrame (＠pierov) 16 Jul '26

16 Jul '26

Pier Angelo Vendrame pushed to branch mullvad-browser-153.0a1-16.0-2 at The Tor Project / Applications / Mullvad Browser Commits: a75a17f9 by Pier Angelo Vendrame at 2026-07-16T17:21:10+02:00 fixup! MB 21: Disable the password manager MB 559: Fix settings after the 153 rebase. - - - - - 1 changed file: - browser/components/preferences/privacy.inc.xhtml Changes: ===================================== browser/components/preferences/privacy.inc.xhtml ===================================== @@ -405,7 +405,7 @@   -<groupbox id="passwordsGroup" orient="vertical" data-category="panePrivacy" data-subcategory="logins" data-hidden-from-search="true" hidden="true" data-srd-groupid="passwords" data-srd-migrated=""></groupbox> +<groupbox id="passwordsGroup" orient="vertical" data-category="panePrivacy" data-subcategory="logins" data-hidden-from-search="true" hidden="true" data-srd-groupid="passwords" data-srd-migrated=""> <label><html:h2 data-l10n-id="pane-privacy-passwords-header" data-l10n-attrs="searchkeywords"/></label> <vbox id="passwordSettings"> View it on GitLab: https://gitlab.torproject.org/tpo/applications/mullvad-browser/-/commit/a75… -- View it on GitLab: https://gitlab.torproject.org/tpo/applications/mullvad-browser/-/commit/a75… You're receiving this email because of your account on gitlab.torproject.org. Manage all notifications: https://gitlab.torproject.org/-/profile/notifications | Help: https://gitlab.torproject.org/help

1 0

[Git][tpo/applications/tor-browser-build][main] Bug 45108: Set MacOS packaging variables before ./mach configure
by brizental (＠brizental) 16 Jul '26

16 Jul '26

brizental pushed to branch main at The Tor Project / Applications / tor-browser-build Commits: 8c6b06c7 by Beatriz Rizental at 2026-07-16T01:27:38-03:00 Bug 45108: Set MacOS packaging variables before ./mach configure These now need to be set before configure so that the right configuration and environment files are created and available at packaging time. - - - - - 1 changed file: - projects/firefox/build Changes: ===================================== projects/firefox/build ===================================== @@ -110,6 +110,14 @@ export LANG=C.UTF-8 patch -p1 < $rootdir/firefoxbrowser-BB-29320.patch [% END -%] +[% IF c("var/dev_artifacts") -%] + [% IF c("var/macos") -%] + export MOZ_PKG_MAC_BACKGROUND=$(find $rootdir/dmg-root/[% c('var/ProjectName') %].dmg/.background -type f) + export MOZ_PKG_MAC_DSSTORE=$rootdir/dmg-root/[% c('var/ProjectName') %].dmg/nightly.DS_Store + export MOZ_PKG_MAC_ICON=$rootdir/dmg-root/[% c('var/ProjectName') %].dmg/.VolumeIcon.icns + [% END -%] +[% END -%] + echo "Starting ./mach configure $(date)" ./mach configure \ --with-distribution-id=org.torproject \ @@ -137,12 +145,6 @@ echo "Starting ./mach build $(date)" [% IF c("var/dev_artifacts") -%] echo "Building development artifacts" - [% IF c("var/macos") -%] - export MOZ_PKG_MAC_BACKGROUND=$(find $rootdir/dmg-root/[% c('var/ProjectName') %].dmg/.background -type f) - export MOZ_PKG_MAC_DSSTORE=$rootdir/dmg-root/[% c('var/ProjectName') %].dmg/nightly.DS_Store - export MOZ_PKG_MAC_ICON=$rootdir/dmg-root/[% c('var/ProjectName') %].dmg/.VolumeIcon.icns - [% END -%] - # Package the browser and also create all the test artifacts. # # MOZ_SIMPLE_PACKAGE_NAME will force all artifact files to start with "target", View it on GitLab: https://gitlab.torproject.org/tpo/applications/tor-browser-build/-/commit/8… -- View it on GitLab: https://gitlab.torproject.org/tpo/applications/tor-browser-build/-/commit/8… You're receiving this email because of your account on gitlab.torproject.org. Manage all notifications: https://gitlab.torproject.org/-/profile/notifications | Help: https://gitlab.torproject.org/help

1 0

[Git][tpo/applications/mullvad-browser] Pushed new tag mullvad-browser-140.13.0esr-15.0-1-build1
by Pier Angelo Vendrame (＠pierov) 16 Jul '26

16 Jul '26

Pier Angelo Vendrame pushed new tag mullvad-browser-140.13.0esr-15.0-1-build1 at The Tor Project / Applications / Mullvad Browser -- View it on GitLab: https://gitlab.torproject.org/tpo/applications/mullvad-browser/-/tree/mullv… You're receiving this email because of your account on gitlab.torproject.org. Manage all notifications: https://gitlab.torproject.org/-/profile/notifications | Help: https://gitlab.torproject.org/help

1 0

[Git][tpo/applications/mullvad-browser][mullvad-browser-140.13.0esr-15.0-1] 24 commits: Add CI for Mullvad Browser
by Pier Angelo Vendrame (＠pierov) 16 Jul '26

16 Jul '26

Pier Angelo Vendrame pushed to branch mullvad-browser-140.13.0esr-15.0-1 at The Tor Project / Applications / Mullvad Browser Commits: 271379c7 by Henry Wilkes at 2026-07-16T11:42:28+02:00 Add CI for Mullvad Browser - - - - - fc26a288 by Pier Angelo Vendrame at 2026-07-16T11:42:28+02:00 MB 38: Mullvad Browser configuration - - - - - b014dfee by Pier Angelo Vendrame at 2026-07-16T11:42:29+02:00 MB 1: Mullvad Browser branding See also: mullvad-browser#5: Product name and directory customization mullvad-browser#12: Create new branding directories and integrate Mullvad icons+branding mullvad-browser#14: Remove Default Built-in bookmarks mullvad-browser#35: Add custom PDF icons for Windows builds mullvad-browser#48: Replace Mozilla copyright and legal trademarks in mullvadbrowser.exe metadata mullvad-browser#51: Update trademark string mullvad-browser#104: Update shipped dll metadata copyright/licensing info mullvad-browser#107: Add alpha and nightly icons - - - - - d33223d2 by Henry Wilkes at 2026-07-16T11:42:29+02:00 Mullvad Browser strings This commit adds strings needed by the following Mullvad Browser patches. - - - - - 6e6cf39e by Pier Angelo Vendrame at 2026-07-16T11:42:29+02:00 MB 20: Allow packaged-addons in PBM. We install a few addons from the distribution directory, but they are not automatically enabled for PBM mode. This commit modifies the code that installs them to also add the PBM permission to the known ones. - - - - - c8a9b20f by Pier Angelo Vendrame at 2026-07-16T11:42:30+02:00 MB 63: Customize some about pages for Mullvad Browser Also: mullvad-browser#57: Purge unneeded about: pages - - - - - 08453ba6 by Pier Angelo Vendrame at 2026-07-16T11:42:30+02:00 MB 37: Customization for the about dialog - - - - - ce7403d0 by Henry Wilkes at 2026-07-16T11:42:30+02:00 MB 39: Add home page about:mullvad-browser - - - - - f8f1e9cf by hackademix at 2026-07-16T11:42:30+02:00 MB 97: Remove UI cues to install new extensions. - - - - - 9e1871e0 by hackademix at 2026-07-16T11:42:31+02:00 MB 47: uBlock Origin customization - - - - - 1345fb8e by Pier Angelo Vendrame at 2026-07-16T11:42:31+02:00 MB 21: Disable the password manager This commit disables the about:login page and removes the "Login and Password" section of about:preferences. We do not do anything to the real password manager of Firefox, that is in toolkit: it contains C++ parts that make it difficult to actually prevent it from being built.. Finally, we modify the the function that opens about:login to report an error in the console so that we can quickly get a backtrace to the code that tries to use it. - - - - - 166008af by Pier Angelo Vendrame at 2026-07-16T11:42:31+02:00 MB 112: Updater customization for Mullvad Browser MB 71: Set the updater base URL to Mullvad domain - - - - - 473b2bbf by Nicolas Vigier at 2026-07-16T11:42:31+02:00 MB 79: Add Mullvad Browser MAR signing keys MB 256: Add mullvad-browser nightly mar signing key - - - - - 0e89691a by Pier Angelo Vendrame at 2026-07-16T11:42:32+02:00 MB 34: Hide unsafe and unwanted preferences UI about:preferences allow to override some of our defaults, that could be fingeprintable or have some other unwanted consequences. - - - - - 258ba770 by Pier Angelo Vendrame at 2026-07-16T11:42:32+02:00 MB 160: Disable the cookie exceptions button Besides disabling the "Delete on close checkbox", disable also the "Manage Exceptions" button when always using PBM. - - - - - 704aa902 by hackademix at 2026-07-16T11:42:32+02:00 MB 163: prevent uBlock Origin from being uninstalled/disabled - - - - - 13a73e3d by Pier Angelo Vendrame at 2026-07-16T11:42:32+02:00 MB 188: Customize Gitlab Issue and Merge templates - - - - - d10b051a by Pier Angelo Vendrame at 2026-07-16T11:42:33+02:00 MB 213: Customize the search engines list. MB 483: Ship DDG without AI as a bundled search engine. MB 487: Use custom order for search engines. - - - - - 20f8988c by hackademix at 2026-07-16T11:42:33+02:00 MB 214: Enable cross-tab identity leak protection in "quiet" mode - - - - - 0c3a1442 by Pier Angelo Vendrame at 2026-07-16T11:42:33+02:00 MB 80: Enable Mullvad Browser as a default browser - - - - - 52251648 by Pier Angelo Vendrame at 2026-07-16T11:42:33+02:00 MB 320: Temporarily disable WebRTC and WDBA on Windows. WebRTC should be re-enabled when tor-browser#42758 is resolved, and and the default browser agent when in general we make this feature work again. - - - - - 04827eed by Henry Wilkes at 2026-07-16T11:42:34+02:00 MB 329: Customize toolbar for mullvad-browser. - - - - - a255c82e by Henry Wilkes at 2026-07-16T11:42:34+02:00 MB 419: Mullvad Browser migration procedures. This commit implements the the Mullvad Browser's version of _migrateUI. - - - - - 80c62904 by Henry Wilkes at 2026-07-16T11:42:34+02:00 MB 488: Adjust search engine removal notification for Mullvad Leta. - - - - - 253 changed files: - .gitlab/ci/jobs/update-translations.yml - .gitlab/issue_templates/000 Bug Report.md - .gitlab/issue_templates/010 Proposal.md - .gitlab/issue_templates/020 Web Compatibility.md - .gitlab/issue_templates/030 Test.md - .gitlab/issue_templates/040 Feature.md - .gitlab/issue_templates/060 Rebase - Alpha.md - .gitlab/issue_templates/061 Rebase - Stable.md - .gitlab/issue_templates/063 Rebase - Rapid.md - .gitlab/issue_templates/090 Emergency Security Issue.md - .gitlab/merge_request_templates/Default.md - + .gitlab/merge_request_templates/Rebase.md - browser/app/Makefile.in - browser/app/macbuild/Contents/Info.plist.in - browser/app/module.ver - browser/app/firefox.exe.manifest → browser/app/mullvadbrowser.exe.manifest - + browser/app/profile/000-mullvad-browser.js - browser/app/profile/001-base-profile.js - browser/base/content/aboutDialog.xhtml - browser/base/content/appmenu-viewcache.inc.xhtml - browser/base/content/browser-menubar.inc - browser/base/content/browser-places.js - browser/base/content/browser.js - browser/base/content/default-bookmarks.html - browser/base/content/nsContextMenu.sys.mjs - browser/base/content/overrides/app-license.html - browser/base/content/pageinfo/pageInfo.xhtml - browser/base/content/utilityOverlay.js - browser/branding/branding-common.mozbuild - + browser/branding/mb-alpha/VisualElements_150.png - + browser/branding/mb-alpha/VisualElements_70.png - + browser/branding/mb-alpha/configure.sh - + browser/branding/mb-alpha/content/about-logo.png - + browser/branding/mb-alpha/content/about-logo.svg - + browser/branding/mb-alpha/content/about-logo(a)2x.png - + browser/branding/mb-alpha/content/about-wordmark.svg - + browser/branding/mb-alpha/content/about.png - + browser/branding/mb-alpha/content/aboutDialog.css - + browser/branding/mb-alpha/content/document_pdf.svg - + browser/branding/mb-alpha/content/firefox-wordmark.svg - + browser/branding/mb-alpha/content/icon128.png - + browser/branding/mb-alpha/content/icon16.png - + browser/branding/mb-alpha/content/icon256.png - + browser/branding/mb-alpha/content/icon32.png - + browser/branding/mb-alpha/content/icon48.png - + browser/branding/mb-alpha/content/icon64.png - + browser/branding/mb-alpha/content/jar.mn - + browser/branding/mb-alpha/content/moz.build - + browser/branding/mb-alpha/content/mullvad-branding.css - + browser/branding/mb-alpha/default128.png - + browser/branding/mb-alpha/default16.png - + browser/branding/mb-alpha/default22.png - + browser/branding/mb-alpha/default24.png - + browser/branding/mb-alpha/default256.png - + browser/branding/mb-alpha/default32.png - + browser/branding/mb-alpha/default48.png - + browser/branding/mb-alpha/default64.png - + browser/branding/mb-alpha/document.icns - + browser/branding/mb-alpha/document.ico - + browser/branding/mb-alpha/document_pdf.ico - + browser/branding/mb-alpha/firefox.icns - + browser/branding/mb-alpha/firefox.ico - + browser/branding/mb-alpha/firefox.svg - + browser/branding/mb-alpha/locales/en-US/brand.ftl - + browser/branding/mb-alpha/locales/en-US/brand.properties - + browser/branding/mb-alpha/locales/jar.mn - + browser/branding/mb-alpha/locales/moz.build - + browser/branding/mb-alpha/locales/mullvad-about-wordmark-en.ftl - + browser/branding/mb-alpha/moz.build - + browser/branding/mb-alpha/mullvadbrowser.VisualElementsManifest.xml - + browser/branding/mb-alpha/newtab.ico - + browser/branding/mb-alpha/newwindow.ico - + browser/branding/mb-alpha/pbmode.ico - + browser/branding/mb-alpha/pref/firefox-branding.js - + browser/branding/mb-nightly/VisualElements_150.png - + browser/branding/mb-nightly/VisualElements_70.png - + browser/branding/mb-nightly/configure.sh - + browser/branding/mb-nightly/content/about-logo.png - + browser/branding/mb-nightly/content/about-logo.svg - + browser/branding/mb-nightly/content/about-logo(a)2x.png - + browser/branding/mb-nightly/content/about-wordmark.svg - + browser/branding/mb-nightly/content/about.png - + browser/branding/mb-nightly/content/aboutDialog.css - + browser/branding/mb-nightly/content/document_pdf.svg - + browser/branding/mb-nightly/content/firefox-wordmark.svg - + browser/branding/mb-nightly/content/icon128.png - + browser/branding/mb-nightly/content/icon16.png - + browser/branding/mb-nightly/content/icon256.png - + browser/branding/mb-nightly/content/icon32.png - + browser/branding/mb-nightly/content/icon48.png - + browser/branding/mb-nightly/content/icon64.png - + browser/branding/mb-nightly/content/jar.mn - + browser/branding/mb-nightly/content/moz.build - + browser/branding/mb-nightly/content/mullvad-branding.css - + browser/branding/mb-nightly/default128.png - + browser/branding/mb-nightly/default16.png - + browser/branding/mb-nightly/default22.png - + browser/branding/mb-nightly/default24.png - + browser/branding/mb-nightly/default256.png - + browser/branding/mb-nightly/default32.png - + browser/branding/mb-nightly/default48.png - + browser/branding/mb-nightly/default64.png - + browser/branding/mb-nightly/document.icns - + browser/branding/mb-nightly/document.ico - + browser/branding/mb-nightly/document_pdf.ico - + browser/branding/mb-nightly/firefox.icns - + browser/branding/mb-nightly/firefox.ico - + browser/branding/mb-nightly/firefox.svg - + browser/branding/mb-nightly/locales/en-US/brand.ftl - + browser/branding/mb-nightly/locales/en-US/brand.properties - + browser/branding/mb-nightly/locales/jar.mn - + browser/branding/mb-nightly/locales/moz.build - + browser/branding/mb-nightly/locales/mullvad-about-wordmark-en.ftl - + browser/branding/mb-nightly/moz.build - + browser/branding/mb-nightly/mullvadbrowser.VisualElementsManifest.xml - + browser/branding/mb-nightly/newtab.ico - + browser/branding/mb-nightly/newwindow.ico - + browser/branding/mb-nightly/pbmode.ico - + browser/branding/mb-nightly/pref/firefox-branding.js - + browser/branding/mb-release/VisualElements_150.png - + browser/branding/mb-release/VisualElements_70.png - + browser/branding/mb-release/configure.sh - + browser/branding/mb-release/content/about-logo.png - + browser/branding/mb-release/content/about-logo.svg - + browser/branding/mb-release/content/about-logo(a)2x.png - + browser/branding/mb-release/content/about-wordmark.svg - + browser/branding/mb-release/content/about.png - + browser/branding/mb-release/content/aboutDialog.css - + browser/branding/mb-release/content/document_pdf.svg - + browser/branding/mb-release/content/firefox-wordmark.svg - + browser/branding/mb-release/content/icon128.png - + browser/branding/mb-release/content/icon16.png - + browser/branding/mb-release/content/icon256.png - + browser/branding/mb-release/content/icon32.png - + browser/branding/mb-release/content/icon48.png - + browser/branding/mb-release/content/icon64.png - + browser/branding/mb-release/content/jar.mn - + browser/branding/mb-release/content/moz.build - + browser/branding/mb-release/content/mullvad-branding.css - + browser/branding/mb-release/default128.png - + browser/branding/mb-release/default16.png - + browser/branding/mb-release/default22.png - + browser/branding/mb-release/default24.png - + browser/branding/mb-release/default256.png - + browser/branding/mb-release/default32.png - + browser/branding/mb-release/default48.png - + browser/branding/mb-release/default64.png - + browser/branding/mb-release/document.icns - + browser/branding/mb-release/document.ico - + browser/branding/mb-release/document_pdf.ico - + browser/branding/mb-release/firefox.icns - + browser/branding/mb-release/firefox.ico - + browser/branding/mb-release/firefox.svg - + browser/branding/mb-release/locales/en-US/brand.ftl - + browser/branding/mb-release/locales/en-US/brand.properties - + browser/branding/mb-release/locales/jar.mn - + browser/branding/mb-release/locales/moz.build - + browser/branding/mb-release/locales/mullvad-about-wordmark-en.ftl - + browser/branding/mb-release/moz.build - + browser/branding/mb-release/mullvadbrowser.VisualElementsManifest.xml - + browser/branding/mb-release/newtab.ico - + browser/branding/mb-release/newwindow.ico - + browser/branding/mb-release/pbmode.ico - + browser/branding/mb-release/pref/firefox-branding.js - browser/components/BrowserContentHandler.sys.mjs - browser/components/BrowserGlue.sys.mjs - browser/components/DesktopActorRegistry.sys.mjs - browser/components/ProfileDataUpgrader.sys.mjs - browser/components/about/AboutRedirector.cpp - browser/components/about/components.conf - browser/components/customizableui/CustomizableUI.sys.mjs - browser/components/moz.build - + browser/components/mullvad-browser/AboutMullvadBrowserChild.sys.mjs - + browser/components/mullvad-browser/AboutMullvadBrowserParent.sys.mjs - + browser/components/mullvad-browser/content/2728-sparkles.svg - + browser/components/mullvad-browser/content/aboutMullvadBrowser.css - + browser/components/mullvad-browser/content/aboutMullvadBrowser.html - + browser/components/mullvad-browser/content/aboutMullvadBrowser.js - + browser/components/mullvad-browser/jar.mn - + browser/components/mullvad-browser/moz.build - browser/components/preferences/home.inc.xhtml - browser/components/preferences/main.js - browser/components/preferences/preferences.xhtml - browser/components/preferences/privacy.inc.xhtml - browser/components/preferences/privacy.js - browser/components/preferences/search.inc.xhtml - browser/components/search/SearchUIUtils.sys.mjs - browser/components/shell/ShellService.sys.mjs - browser/components/shell/WindowsDefaultBrowser.cpp - browser/components/shell/nsWindowsShellService.cpp - browser/components/tabbrowser/NewTabPagePreloading.sys.mjs - browser/config/mozconfigs/base-browser - + browser/config/mozconfigs/mullvad-browser - browser/installer/package-manifest.in - browser/installer/windows/nsis/updater_append.ini - browser/locales/l10n.toml - browser/modules/HomePage.sys.mjs - browser/moz.build - browser/moz.configure - config/create_rc.py - devtools/client/aboutdebugging/src/actions/runtimes.js - devtools/client/aboutdebugging/src/components/sidebar/Sidebar.js - devtools/client/jar.mn - devtools/client/themes/images/aboutdebugging-firefox-aurora.svg - devtools/client/themes/images/aboutdebugging-firefox-beta.svg - devtools/client/themes/images/aboutdebugging-firefox-logo.svg - devtools/client/themes/images/aboutdebugging-firefox-nightly.svg - devtools/client/themes/images/aboutdebugging-firefox-release.svg - + devtools/client/themes/images/aboutdebugging-mullvadbrowser-logo.svg - docshell/base/nsAboutRedirector.cpp - docshell/build/components.conf - moz.configure - mozconfig-linux-aarch64 - mozconfig-linux-aarch64-dev - mozconfig-linux-x86_64 - mozconfig-linux-x86_64-asan - mozconfig-linux-x86_64-dev - mozconfig-macos - mozconfig-macos-dev - mozconfig-windows-x86_64 - + other-licenses/nsis/Contrib/ApplicationID/Makefile - other-licenses/nsis/Contrib/ApplicationID/Set.cpp - + other-licenses/nsis/Contrib/CityHash/Makefile - toolkit/components/extensions/child/ext-storage.js - toolkit/components/extensions/parent/ext-storage.js - toolkit/components/passwordmgr/LoginHelper.sys.mjs - toolkit/components/search/SearchService.sys.mjs - toolkit/components/search/content/base-browser-search-engine-icons.json - toolkit/components/search/content/base-browser-search-engines.json - + toolkit/components/search/content/brave.svg - + toolkit/components/search/content/mojeek.ico - toolkit/components/search/tests/xpcshell/test_base_browser.js - toolkit/components/securitylevel/SecurityLevel.sys.mjs - + toolkit/content/aboutRightsMullvad.xhtml - + toolkit/content/aboutTelemetryMullvad.xhtml - toolkit/content/jar.mn - + toolkit/locales/en-US/toolkit/global/mullvad-browser.ftl - toolkit/mozapps/defaultagent/EventLog.h - toolkit/mozapps/defaultagent/SetDefaultBrowser.cpp - toolkit/mozapps/extensions/AddonManager.sys.mjs - toolkit/mozapps/extensions/content/aboutaddons.css - toolkit/mozapps/extensions/internal/XPIDatabase.sys.mjs - toolkit/mozapps/extensions/internal/XPIProvider.sys.mjs - toolkit/mozapps/update/updater/nightly_aurora_level3_primary.der - toolkit/mozapps/update/updater/nightly_aurora_level3_secondary.der - toolkit/mozapps/update/updater/release_primary.der - toolkit/mozapps/update/updater/release_secondary.der - + toolkit/themes/shared/icons/mullvadbrowser.png - toolkit/themes/shared/minimal-toolkit.jar.inc.mn - toolkit/xre/nsAppRunner.cpp - tools/lint/fluent-lint/exclusions.yml - widget/windows/WinTaskbar.cpp - widget/windows/moz.build The diff was not included because it is too large. View it on GitLab: https://gitlab.torproject.org/tpo/applications/mullvad-browser/-/compare/9a… -- View it on GitLab: https://gitlab.torproject.org/tpo/applications/mullvad-browser/-/compare/9a… You're receiving this email because of your account on gitlab.torproject.org. Manage all notifications: https://gitlab.torproject.org/-/profile/notifications | Help: https://gitlab.torproject.org/help

1 0