commit db3ccb2a11256421f5d8db7caad10a5a2c98def5 Author: Matthew Finkel sysrqb@torproject.org Date: Tue May 19 15:38:20 2020 +0000
Bug 34321 - Add Learn More onboarding item --- browser/app/profile/000-tor-browser.js | 6 +- browser/extensions/onboarding/api.js | 1 + .../extensions/onboarding/content/Onboarding.jsm | 67 +++++++++++++++++----- .../extensions/onboarding/content/onboarding.css | 5 +- 4 files changed, 60 insertions(+), 19 deletions(-)
diff --git a/browser/app/profile/000-tor-browser.js b/browser/app/profile/000-tor-browser.js index 0176e8feb64d..27b7c7972df8 100644 --- a/browser/app/profile/000-tor-browser.js +++ b/browser/app/profile/000-tor-browser.js @@ -296,9 +296,9 @@ pref("browser.download.panel.shown", true); pref("dom.securecontext.whitelist_onions", true);
// Onboarding. -pref("browser.onboarding.tourset-version", 4); -pref("browser.onboarding.newtour", "welcome,privacy,tor-network-9.0,circuit-display,security,expect-differences,onion-services"); -pref("browser.onboarding.updatetour", "toolbar-update-9.0,tor-network-9.0"); +pref("browser.onboarding.tourset-version", 5); +pref("browser.onboarding.newtour", "welcome,privacy,tor-network-9.0,circuit-display,security,expect-differences,onion-services,learn-more"); +pref("browser.onboarding.updatetour", "learn-more"); pref("browser.onboarding.skip-tour-button.hide", true);
// prefs to disable jump-list entries in the taskbar on Windows (see bug #12885) diff --git a/browser/extensions/onboarding/api.js b/browser/extensions/onboarding/api.js index 29b6f68a7914..d7dffaaaac19 100644 --- a/browser/extensions/onboarding/api.js +++ b/browser/extensions/onboarding/api.js @@ -45,6 +45,7 @@ const PREF_WHITELIST = [ "onboarding-tour-tor-expect-differences", "onboarding-tour-tor-onion-services", "onboarding-tour-tor-toolbar-update-9-0", + "onboarding-tour-tor-learn-more", #if 0 // Firefox tours. To reduce conflicts when rebasing against newer Firefox // code, we use the preprocessor to omit this code block. diff --git a/browser/extensions/onboarding/content/Onboarding.jsm b/browser/extensions/onboarding/content/Onboarding.jsm index 4d991acf869d..2115b2bd9d27 100644 --- a/browser/extensions/onboarding/content/Onboarding.jsm +++ b/browser/extensions/onboarding/content/Onboarding.jsm @@ -14,6 +14,7 @@ const ONBOARDING_CSS_URL = "resource://onboarding/onboarding.css"; const TORBUTTON_BUNDLE_URI = "chrome://torbutton/locale/browserOnboarding.properties"; const TORBROWSER_WELCOME_TOUR_NAME_KEY = "onboarding.tour-tor-welcome"; const BUNDLE_URI = "chrome://torbutton/locale/onboarding.properties"; +const BROWSER_BUNDLE_URI = "chrome://browser/locale/browser.properties"; const UITOUR_JS_URI = "resource://onboarding/lib/UITour-lib.js"; const TOUR_AGENT_JS_URI = "resource://onboarding/onboarding-tour-agent.js"; const BRAND_SHORT_NAME = Services.strings @@ -235,6 +236,15 @@ var onboardingTourset = { return div; }, }, + "learn-more": { + id: "onboarding-tour-tor-learn-more", + // Re-use "Learn More" string from Firefox langpacks + tourNameId: "getUserMedia.shareScreen.learnMoreLabel", + highlightId: "onboarding.tour-tor-update.prefix-new", + getPage(win) { + return win.document.createElement("div"); + }, + }, // Tour items for users who have updated their Tor Browser: "toolbar-update-9.0": { id: "onboarding-tour-tor-toolbar-update-9-0", @@ -901,20 +911,29 @@ class Onboarding { }
const kOnionURL = "https://3g2upl4pq6kufc4m.onion/"; // DuckDuckGo + const kLearnMore = "https://www.torproject.org/releases/tor-browser-95/"; let handledTourActionClick = false; switch (id) { case "onboarding-overlay-button-icon": case "onboarding-overlay-button": - this.telemetry({ - type: "onboarding-logo-click", - bubble_state: this._bubbleState, - logo_state: this._logoState, - notification_state: this._notificationState, - session_key: this._session_key, - width: this._windowWidthRounded, - }); - this.showOverlay(); - this.gotoPage(this._firstUncompleteTour.id); + // If this instance upgraded, then directly open the release notes + // when the bubble is clicked. + if (this._tourType === "update") { + this.sendMessageToChrome("tor-open-tab", {url: kLearnMore}); + // Mark item as complete + this.setToursCompleted(["onboarding-tour-tor-learn-more"]); + } else { + this.telemetry({ + type: "onboarding-logo-click", + bubble_state: this._bubbleState, + logo_state: this._logoState, + notification_state: this._notificationState, + session_key: this._session_key, + width: this._windowWidthRounded, + }); + this.showOverlay(); + this.gotoPage(this._firstUncompleteTour.id); + } break; case "onboarding-skip-tour-button": this.hideNotification(); @@ -977,7 +996,6 @@ class Onboarding { case "onboarding-tour-tor-circuit-display-next-button": case "onboarding-tour-tor-security-next-button": case "onboarding-tour-tor-expect-differences-next-button": - case "onboarding-tour-tor-onion-services-next-button": case "onboarding-tour-tor-toolbar-next-button": this.gotoNextTourItem(); handledTourActionClick = true; @@ -994,6 +1012,14 @@ class Onboarding { case "onboarding-tour-tor-onion-services-button": this.sendMessageToChrome("tor-open-tab", {url: kOnionURL}); break; + // Open the Release Notes webpage and hide the overlay. + case "onboarding-tour-tor-onion-services-next-button": + case "onboarding-tour-tor-learn-more": + this.sendMessageToChrome("tor-open-tab", {url: kLearnMore}); + this.hideOverlay(); + // Mark item as complete + this.setToursCompleted(["onboarding-tour-tor-learn-more"]); + break; } if (classList.contains("onboarding-tour-item")) { this.telemetry({ @@ -1852,9 +1878,11 @@ class Onboarding { // _TorOnboardingStringBundle implements the subset of the nsIStringBundle // that is used by the code in this file. It checks first for strings inside // Torbutton's browserOnboarding.properties file and secondarily in Firefox's -// onboarding.properties file. +// onboarding.properties file. Finally, it looks for the string within +// browser.properties. class _TorOnboardingStringBundle { constructor() { + this._mBrowserBundle = Services.strings.createBundle(BROWSER_BUNDLE_URI); this._mFirefoxBundle = Services.strings.createBundle(BUNDLE_URI); this._mTorButtonBundle = Services.strings.createBundle(TORBUTTON_BUNDLE_URI);
@@ -1872,7 +1900,11 @@ class _TorOnboardingStringBundle { try { result = this._mTorButtonBundle.GetStringFromName(aName); } catch (e) { - result = this._mFirefoxBundle.GetStringFromName(aName); + try { + result = this._mFirefoxBundle.GetStringFromName(aName); + } catch (e) { + result = this._mBrowserBundle.GetStringFromName(aName); + } } return result; } @@ -1883,8 +1915,13 @@ class _TorOnboardingStringBundle { result = this._mTorButtonBundle.formatStringFromName(aName, aParams, aLength); } catch (e) { - result = this._mFirefoxBundle.formatStringFromName(aName, aParams, - aLength); + try { + result = this._mFirefoxBundle.formatStringFromName(aName, aParams, + aLength); + } catch (e) { + result = this._mBrowserBundle.formatStringFromName(aName, aParams, + aLength); + } } return result; } diff --git a/browser/extensions/onboarding/content/onboarding.css b/browser/extensions/onboarding/content/onboarding.css index eb214de5e254..431b73bd148e 100644 --- a/browser/extensions/onboarding/content/onboarding.css +++ b/browser/extensions/onboarding/content/onboarding.css @@ -167,7 +167,7 @@
#onboarding-overlay.onboarding-opened > #onboarding-overlay-dialog { width: 960px; - height: 510px; + height: 540px; background: #fff; border: 1px solid rgba(9, 6, 13, 0.2); /* #09060D, 0.2 opacity */ border-radius: 3px; @@ -538,6 +538,9 @@ a#onboarding-tour-tor-expect-differences-button:visited, a#onboarding-tour-tor-onion-services-button, a#onboarding-tour-tor-onion-services-button:hover, a#onboarding-tour-tor-onion-services-button:visited, +a#onboarding-tour-tor-learn-more-button, +a#onboarding-tour-tor-learn-more-button:hover, +a#onboarding-tour-tor-learn-more-button:visited, a#onboarding-tour-screenshots-button, a#onboarding-tour-screenshots-button:hover, a#onboarding-tour-screenshots-button:visited {