[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
[tor-commits] [tor-browser] 48/48: Bug 11698: Incorporate Tor Browser Manual pages into Tor Browser
This is an automated email from the git hooks/post-receive script.
richard pushed a commit to branch tor-browser-102.3.0esr-12.0-2
in repository tor-browser.
commit 132fd7cc5ad6362c544f988ea49905aa108fbe96
Author: Pier Angelo Vendrame <pierov@xxxxxxxxxxxxxx>
AuthorDate: Thu May 5 20:15:01 2022 +0200
Bug 11698: Incorporate Tor Browser Manual pages into Tor Browser
This patch associates the about:manual page to a translated page that
must be injected to browser/omni.ja after the build.
The content must be placed in chrome/browser/content/browser/manual/, so
that is then available at chrome://browser/content/manual/.
We preferred giving absolute freedom to the web team, rather than having
to change the patch in case of changes on the documentation.
---
browser/components/about/AboutRedirector.cpp | 64 ++++++++++++++++++++++++++++
browser/components/about/components.conf | 1 +
2 files changed, 65 insertions(+)
diff --git a/browser/components/about/AboutRedirector.cpp b/browser/components/about/AboutRedirector.cpp
index c3095c4bd3bb..05fec67c79e0 100644
--- a/browser/components/about/AboutRedirector.cpp
+++ b/browser/components/about/AboutRedirector.cpp
@@ -15,6 +15,11 @@
#include "mozilla/StaticPrefs_browser.h"
#include "mozilla/dom/ContentChild.h"
+// For Tor Browser manual
+#include "nsTHashSet.h"
+#include "mozilla/intl/LocaleService.h"
+#include "mozilla/Omnijar.h"
+
namespace mozilla {
namespace browser {
@@ -150,6 +155,11 @@ static const RedirEntry kRedirMap[] = {
nsIAboutModule::URI_CAN_LOAD_IN_CHILD | nsIAboutModule::ALLOW_SCRIPT |
nsIAboutModule::HIDE_FROM_ABOUTABOUT |
nsIAboutModule::IS_SECURE_CHROME_UI},
+ // The correct URI must be obtained by GetManualChromeURI
+ {"manual", "about:blank", nsIAboutModule::URI_SAFE_FOR_UNTRUSTED_CONTENT |
+ nsIAboutModule::ALLOW_SCRIPT | nsIAboutModule::URI_MUST_LOAD_IN_CHILD |
+ nsIAboutModule::URI_CAN_LOAD_IN_PRIVILEGEDABOUT_PROCESS |
+ nsIAboutModule::IS_SECURE_CHROME_UI},
};
static nsAutoCString GetAboutModuleName(nsIURI* aURI) {
@@ -166,6 +176,52 @@ static nsAutoCString GetAboutModuleName(nsIURI* aURI) {
return path;
}
+static nsTHashSet<nsCStringHashKey> GetManualLocales()
+{
+ nsTHashSet<nsCStringHashKey> locales;
+ RefPtr<nsZipArchive> zip = Omnijar::GetReader(Omnijar::APP);
+ UniquePtr<nsZipFind> find;
+ const nsAutoCString prefix("chrome/browser/content/browser/manual/");
+ nsAutoCString needle = prefix;
+ needle.Append("*.html");
+ if (NS_SUCCEEDED(zip->FindInit(needle.get(), getter_Transfers(find)))) {
+ const char* entryName;
+ uint16_t entryNameLen;
+ while (NS_SUCCEEDED(find->FindNext(&entryName, &entryNameLen))) {
+ // 5 is to remove the final `.html`
+ const size_t length = entryNameLen - prefix.Length() - 5;
+ locales.Insert(nsAutoCString(entryName + prefix.Length(), length));
+ }
+ }
+ return locales;
+}
+
+static nsAutoCString GetManualChromeURI() {
+ static nsTHashSet<nsCStringHashKey> locales = GetManualLocales();
+
+ nsAutoCString reqLocale;
+ intl::LocaleService::GetInstance()->GetAppLocaleAsBCP47(reqLocale);
+ // Check every time the URL is needed in case the lang has been changed.
+ // We do not provide multi-language builds at the moment, so this should not
+ // happen, at least in Tor Browser desktop, but we prepared the patch to be
+ // ready also in such a case.
+ if (!locales.Contains(reqLocale) && reqLocale.Length() > 2 &&
+ reqLocale[2] == '-') {
+ // At the moment, codes in our manual output are either 2 letters (en) or
+ // 5 letters (pt-BR)
+ reqLocale.SetLength(2);
+ }
+ if (!locales.Contains(reqLocale)) {
+ reqLocale = "en";
+ }
+
+ // %s is the language
+ constexpr char model[] = "chrome://browser/content/manual/%s.html";
+ nsAutoCString url;
+ url.AppendPrintf(model, reqLocale.get());
+ return url;
+}
+
NS_IMETHODIMP
AboutRedirector::NewChannel(nsIURI* aURI, nsILoadInfo* aLoadInfo,
nsIChannel** result) {
@@ -219,6 +275,10 @@ AboutRedirector::NewChannel(nsIURI* aURI, nsILoadInfo* aLoadInfo,
NS_ENSURE_SUCCESS(rv, rv);
}
+ if (path.EqualsLiteral("manual")) {
+ url = GetManualChromeURI();
+ }
+
// fall back to the specified url in the map
if (url.IsEmpty()) {
url.AssignASCII(redir.url);
@@ -277,6 +337,10 @@ AboutRedirector::GetChromeURI(nsIURI* aURI, nsIURI** chromeURI) {
nsAutoCString name = GetAboutModuleName(aURI);
+ if (name.EqualsLiteral("manual")) {
+ return NS_NewURI(chromeURI, GetManualChromeURI());
+ }
+
for (const auto& redir : kRedirMap) {
if (name.Equals(redir.id)) {
return NS_NewURI(chromeURI, redir.url);
diff --git a/browser/components/about/components.conf b/browser/components/about/components.conf
index d35ad34ec8ba..527718871468 100644
--- a/browser/components/about/components.conf
+++ b/browser/components/about/components.conf
@@ -13,6 +13,7 @@ pages = [
'logins',
'loginsimportreport',
'firefoxview',
+ 'manual',
'newtab',
'pocket-home',
'pocket-saved',
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits