commit 17b4c2e98e5a3d12fb235d5c25ed3dfda1b0b63e
parent 6b4bce875447801184265c61d2fde056acb89645
Author: Dan Stillman <dstillman@zotero.org>
Date: Sun, 29 Apr 2018 04:53:00 -0400
Show upgrade prompt for connector pings from below a certain version
Shows a prompt once per restart or once per day, whichever is longer,
with an option to not show again for a month. Can be disabled completely
by setting extensions.zotero.showConnectorVersionWarning to false.
Currently prompts for connector versions below 5.0.35.
This is a temporary solution for #1489 until the connector checks and
warns on its own when it's outdated and most people are on a version
that does that (particularly Safari users, who don't auto-upgrade).
Diffstat:
3 files changed, 102 insertions(+), 0 deletions(-)
diff --git a/chrome/content/zotero/xpcom/connector/server_connector.js b/chrome/content/zotero/xpcom/connector/server_connector.js
@@ -1263,8 +1263,108 @@ Zotero.Server.Connector.Ping.prototype = {
response.prefs.reportActiveURL = true;
}
+ this.versionWarning(req);
+
return [200, 'application/json', JSON.stringify(response)];
}
+ },
+
+
+ /**
+ * Warn on outdated connector version
+ *
+ * We can remove this once the connector checks and warns on its own and most people are on
+ * a version that does that.
+ */
+ versionWarning: function (req) {
+ try {
+ if (!Zotero.Prefs.get('showConnectorVersionWarning')) return;
+ if (!req.headers) return;
+
+ var minVersion = ZOTERO_CONFIG.CONNECTOR_MIN_VERSION;
+ var appName = ZOTERO_CONFIG.CLIENT_NAME;
+ var domain = ZOTERO_CONFIG.DOMAIN_NAME;
+ var origin = req.headers.Origin;
+
+ var browser;
+ var message;
+ var showDownloadButton = false;
+ if (origin && origin.startsWith('safari-extension')) {
+ browser = 'safari';
+ message = `An update is available for the ${appName} Connector for Safari.\n\n`
+ + 'You can upgrade from the Extensions pane of the Safari preferences.';
+ }
+ else if (origin && origin.startsWith('chrome-extension')) {
+ browser = 'chrome';
+ message = `An update is available for the ${appName} Connector for Chrome.\n\n`
+ + `You can upgrade to the latest version from ${domain}.`;
+ showDownloadButton = true;
+ }
+ else if (req.headers['User-Agent'] && req.headers['User-Agent'].includes('Firefox/')) {
+ browser = 'firefox';
+ message = `An update is available for the ${appName} Connector for Firefox.\n\n`
+ + `You can upgrade to the latest version from ${domain}.`;
+ showDownloadButton = true;
+ }
+ else {
+ Zotero.debug("Unknown browser");
+ return;
+ }
+
+ if (Zotero.Server.Connector['skipVersionWarning-' + browser]) return;
+
+ var version = req.headers['X-Zotero-Version'];
+ if (!version) return;
+
+ // If connector is up to date, bail
+ if (Services.vc.compare(version, minVersion) >= 0) return;
+
+ var showNextPref = `nextConnectorVersionWarning.${browser}`;
+ var showNext = Zotero.Prefs.get(showNextPref);
+ if (showNext && new Date() < new Date(showNext * 1000)) return;
+
+ // Don't show again for this browser until restart
+ Zotero.Server.Connector['skipVersionWarning-' + browser] = true;
+ var ps = Services.prompt;
+ var buttonFlags;
+ if (showDownloadButton) {
+ buttonFlags = ps.BUTTON_POS_0 * ps.BUTTON_TITLE_IS_STRING
+ + ps.BUTTON_POS_1 * ps.BUTTON_TITLE_IS_STRING;
+ }
+ else {
+ buttonFlags = ps.BUTTON_POS_0 * ps.BUTTON_TITLE_OK;
+ }
+ setTimeout(function () {
+ var dontShow = {};
+ var index = ps.confirmEx(null,
+ Zotero.getString('general.updateAvailable'),
+ message,
+ buttonFlags,
+ showDownloadButton ? Zotero.getString('general.upgrade') : null,
+ showDownloadButton ? Zotero.getString('general.notNow') : null,
+ null,
+ "Don\u0027t show again for a month",
+ dontShow
+ );
+
+ var nextShowDays;
+ if (dontShow.value) {
+ nextShowDays = 30;
+ }
+ // Don't show again for at least a day, even after a restart
+ else {
+ nextShowDays = 1;
+ }
+ Zotero.Prefs.set(showNextPref, Math.round(Date.now() / 1000) + 86400 * nextShowDays);
+
+ if (showDownloadButton && index == 0) {
+ Zotero.launchURL(ZOTERO_CONFIG.CONNECTORS_URL);
+ }
+ }, 500);
+ }
+ catch (e) {
+ Zotero.debug(e, 2);
+ }
}
}
diff --git a/defaults/preferences/zotero.js b/defaults/preferences/zotero.js
@@ -47,6 +47,7 @@ pref("extensions.zotero.showTrashWhenEmpty", true);
pref("extensions.zotero.trashAutoEmptyDays", 30);
pref("extensions.zotero.viewOnDoubleClick", true);
pref("extensions.zotero.firstRunGuidance", true);
+pref("extensions.zotero.showConnectorVersionWarning", true);
pref("extensions.zotero.groups.copyChildLinks", true);
pref("extensions.zotero.groups.copyChildFileAttachments", true);
diff --git a/resource/config.js b/resource/config.js
@@ -13,6 +13,7 @@ var ZOTERO_CONFIG = {
STREAMING_URL: 'wss://stream.zotero.org/',
RECOGNIZE_URL: 'https://recognize.zotero.org/',
API_VERSION: 3,
+ CONNECTOR_MIN_VERSION: '5.0.35', // show upgrade prompt for requests from below this version
PREF_BRANCH: 'extensions.zotero.',
BOOKMARKLET_ORIGIN: 'https://www.zotero.org',
HTTP_BOOKMARKLET_ORIGIN: 'http://www.zotero.org',
