Core: Added new event

This helps identify when the browser is not capable enough to run ZeroClipboard, e.g. IE<9 without polyfills. Fixes #546
zeroclipboard · Nov 15, 2016 · 5beb963 · 5beb963
1 parent 3aefadb
commit 5beb963
Show file tree

Hide file tree

Showing 14 changed files with 246 additions and 36 deletions.
diff --git a/dist/ZeroClipboard.Core.js b/dist/ZeroClipboard.Core.js
@@ -12,7 +12,7 @@
  * Store references to critically important global functions that may be
  * overridden on certain web pages.
  */
-  var _window = window, _document = _window.document, _navigator = _window.navigator, _setTimeout = _window.setTimeout, _clearTimeout = _window.clearTimeout, _setInterval = _window.setInterval, _clearInterval = _window.clearInterval, _getComputedStyle = _window.getComputedStyle, _encodeURIComponent = _window.encodeURIComponent, _ActiveXObject = _window.ActiveXObject, _Error = _window.Error, _parseInt = _window.Number.parseInt || _window.parseInt, _parseFloat = _window.Number.parseFloat || _window.parseFloat, _isNaN = _window.Number.isNaN || _window.isNaN, _now = _window.Date.now, _keys = _window.Object.keys, _defineProperty = _window.Object.defineProperty, _hasOwn = _window.Object.prototype.hasOwnProperty, _slice = _window.Array.prototype.slice, _unwrap = function() {
+  var _window = window, _document = _window.document, _navigator = _window.navigator, _setTimeout = _window.setTimeout, _clearTimeout = _window.clearTimeout, _setInterval = _window.setInterval, _clearInterval = _window.clearInterval, _getComputedStyle = _window.getComputedStyle, _encodeURIComponent = _window.encodeURIComponent, _ActiveXObject = _window.ActiveXObject, _Error = _window.Error, _parseInt = _window.Number.parseInt || _window.parseInt, _parseFloat = _window.Number.parseFloat || _window.parseFloat, _isNaN = _window.Number.isNaN || _window.isNaN, _now = _window.Date.now, _keys = _window.Object.keys, _hasOwn = _window.Object.prototype.hasOwnProperty, _slice = _window.Array.prototype.slice, _unwrap = function() {
     var unwrapper = function(el) {
       return el;
     };
@@ -367,7 +367,8 @@
       "version-mismatch": "ZeroClipboard JS version number does not match ZeroClipboard SWF version number",
       "clipboard-error": "At least one error was thrown while ZeroClipboard was attempting to inject your data into the clipboard",
       "config-mismatch": "ZeroClipboard configuration does not match Flash's reality",
-      "swf-not-found": "The ZeroClipboard SWF object could not be loaded, so please check your `swfPath` configuration and/or network connectivity"
+      "swf-not-found": "The ZeroClipboard SWF object could not be loaded, so please check your `swfPath` configuration and/or network connectivity",
+      "browser-unsupported": "The browser does not support the required HTML DOM and JavaScript features"
     }
   };
   /**
@@ -458,7 +459,9 @@
   var _state = function() {
     _detectSandbox();
     return {
-      browser: _pick(_navigator, [ "userAgent", "platform", "appName", "appVersion" ]),
+      browser: _extend(_pick(_navigator, [ "userAgent", "platform", "appName", "appVersion" ]), {
+        isSupported: _isBrowserSupported()
+      }),
       flash: _omit(_flashState, [ "bridge" ]),
       zeroclipboard: {
         version: ZeroClipboard.version,
@@ -467,6 +470,13 @@
     };
   };
   /**
+ * Does this browser support all of the necessary DOM and JS features necessary?
+ * @private
+ */
+  var _isBrowserSupported = function() {
+    return !!(_document.addEventListener && _window.Object.keys && _window.Array.prototype.map);
+  };
+  /**
  * The underlying implementation of `ZeroClipboard.isFlashUnusable`.
  * @private
  */
@@ -503,6 +513,12 @@
         });
       }
       if (added.error) {
+        if (!_isBrowserSupported()) {
+          ZeroClipboard.emit({
+            type: "error",
+            name: "browser-unsupported"
+          });
+        }
         for (i = 0, len = _flashStateErrorNames.length; i < len; i++) {
           if (_flashState[_flashStateErrorNames[i].replace(/^flash-/, "")] === true) {
             ZeroClipboard.emit({
@@ -607,6 +623,14 @@
  */
   var _create = function() {
     var previousState = _flashState.sandboxed;
+    if (!_isBrowserSupported()) {
+      _flashState.ready = false;
+      ZeroClipboard.emit({
+        type: "error",
+        name: "browser-unsupported"
+      });
+      return;
+    }
     _detectSandbox();
     if (typeof _flashState.ready !== "boolean") {
       _flashState.ready = false;
@@ -957,7 +981,17 @@
       if (typeof isSandboxed === "boolean") {
         _flashState.sandboxed = isSandboxed;
       }
-      if (_flashStateErrorNames.indexOf(event.name) !== -1) {
+      if (event.name === "browser-unsupported") {
+        _extend(_flashState, {
+          disabled: false,
+          outdated: false,
+          unavailable: false,
+          degraded: false,
+          deactivated: false,
+          overdue: false,
+          ready: false
+        });
+      } else if (_flashStateErrorNames.indexOf(event.name) !== -1) {
         _extend(_flashState, {
           disabled: event.name === "flash-disabled",
           outdated: event.name === "flash-outdated",
@@ -1881,12 +1915,7 @@
  * @readonly
  * @property {string}
  */
-  _defineProperty(ZeroClipboard, "version", {
-    value: "2.3.0-beta.1",
-    writable: false,
-    configurable: true,
-    enumerable: true
-  });
+  ZeroClipboard.version = "2.3.0-beta.1";
   /**
  * Update or get a copy of the ZeroClipboard global configuration.
  * Returns a copy of the current/updated configuration.

diff --git a/dist/ZeroClipboard.Core.min.js b/dist/ZeroClipboard.Core.min.js
diff --git a/dist/ZeroClipboard.Core.min.map b/dist/ZeroClipboard.Core.min.map
diff --git a/dist/ZeroClipboard.js b/dist/ZeroClipboard.js
@@ -12,7 +12,7 @@
  * Store references to critically important global functions that may be
  * overridden on certain web pages.
  */
-  var _window = window, _document = _window.document, _navigator = _window.navigator, _setTimeout = _window.setTimeout, _clearTimeout = _window.clearTimeout, _setInterval = _window.setInterval, _clearInterval = _window.clearInterval, _getComputedStyle = _window.getComputedStyle, _encodeURIComponent = _window.encodeURIComponent, _ActiveXObject = _window.ActiveXObject, _Error = _window.Error, _parseInt = _window.Number.parseInt || _window.parseInt, _parseFloat = _window.Number.parseFloat || _window.parseFloat, _isNaN = _window.Number.isNaN || _window.isNaN, _now = _window.Date.now, _keys = _window.Object.keys, _defineProperty = _window.Object.defineProperty, _hasOwn = _window.Object.prototype.hasOwnProperty, _slice = _window.Array.prototype.slice, _unwrap = function() {
+  var _window = window, _document = _window.document, _navigator = _window.navigator, _setTimeout = _window.setTimeout, _clearTimeout = _window.clearTimeout, _setInterval = _window.setInterval, _clearInterval = _window.clearInterval, _getComputedStyle = _window.getComputedStyle, _encodeURIComponent = _window.encodeURIComponent, _ActiveXObject = _window.ActiveXObject, _Error = _window.Error, _parseInt = _window.Number.parseInt || _window.parseInt, _parseFloat = _window.Number.parseFloat || _window.parseFloat, _isNaN = _window.Number.isNaN || _window.isNaN, _now = _window.Date.now, _keys = _window.Object.keys, _hasOwn = _window.Object.prototype.hasOwnProperty, _slice = _window.Array.prototype.slice, _unwrap = function() {
     var unwrapper = function(el) {
       return el;
     };
@@ -367,7 +367,8 @@
       "version-mismatch": "ZeroClipboard JS version number does not match ZeroClipboard SWF version number",
       "clipboard-error": "At least one error was thrown while ZeroClipboard was attempting to inject your data into the clipboard",
       "config-mismatch": "ZeroClipboard configuration does not match Flash's reality",
-      "swf-not-found": "The ZeroClipboard SWF object could not be loaded, so please check your `swfPath` configuration and/or network connectivity"
+      "swf-not-found": "The ZeroClipboard SWF object could not be loaded, so please check your `swfPath` configuration and/or network connectivity",
+      "browser-unsupported": "The browser does not support the required HTML DOM and JavaScript features"
     }
   };
   /**
@@ -458,7 +459,9 @@
   var _state = function() {
     _detectSandbox();
     return {
-      browser: _pick(_navigator, [ "userAgent", "platform", "appName", "appVersion" ]),
+      browser: _extend(_pick(_navigator, [ "userAgent", "platform", "appName", "appVersion" ]), {
+        isSupported: _isBrowserSupported()
+      }),
       flash: _omit(_flashState, [ "bridge" ]),
       zeroclipboard: {
         version: ZeroClipboard.version,
@@ -467,6 +470,13 @@
     };
   };
   /**
+ * Does this browser support all of the necessary DOM and JS features necessary?
+ * @private
+ */
+  var _isBrowserSupported = function() {
+    return !!(_document.addEventListener && _window.Object.keys && _window.Array.prototype.map);
+  };
+  /**
  * The underlying implementation of `ZeroClipboard.isFlashUnusable`.
  * @private
  */
@@ -503,6 +513,12 @@
         });
       }
       if (added.error) {
+        if (!_isBrowserSupported()) {
+          ZeroClipboard.emit({
+            type: "error",
+            name: "browser-unsupported"
+          });
+        }
         for (i = 0, len = _flashStateErrorNames.length; i < len; i++) {
           if (_flashState[_flashStateErrorNames[i].replace(/^flash-/, "")] === true) {
             ZeroClipboard.emit({
@@ -607,6 +623,14 @@
  */
   var _create = function() {
     var previousState = _flashState.sandboxed;
+    if (!_isBrowserSupported()) {
+      _flashState.ready = false;
+      ZeroClipboard.emit({
+        type: "error",
+        name: "browser-unsupported"
+      });
+      return;
+    }
     _detectSandbox();
     if (typeof _flashState.ready !== "boolean") {
       _flashState.ready = false;
@@ -957,7 +981,17 @@
       if (typeof isSandboxed === "boolean") {
         _flashState.sandboxed = isSandboxed;
       }
-      if (_flashStateErrorNames.indexOf(event.name) !== -1) {
+      if (event.name === "browser-unsupported") {
+        _extend(_flashState, {
+          disabled: false,
+          outdated: false,
+          unavailable: false,
+          degraded: false,
+          deactivated: false,
+          overdue: false,
+          ready: false
+        });
+      } else if (_flashStateErrorNames.indexOf(event.name) !== -1) {
         _extend(_flashState, {
           disabled: event.name === "flash-disabled",
           outdated: event.name === "flash-outdated",
@@ -1881,12 +1915,7 @@
  * @readonly
  * @property {string}
  */
-  _defineProperty(ZeroClipboard, "version", {
-    value: "2.3.0-beta.1",
-    writable: false,
-    configurable: true,
-    enumerable: true
-  });
+  ZeroClipboard.version = "2.3.0-beta.1";
   /**
  * Update or get a copy of the ZeroClipboard global configuration.
  * Returns a copy of the current/updated configuration.

diff --git a/dist/ZeroClipboard.min.js b/dist/ZeroClipboard.min.js
diff --git a/dist/ZeroClipboard.min.map b/dist/ZeroClipboard.min.map
diff --git a/dist/ZeroClipboard.swf b/dist/ZeroClipboard.swf
diff --git a/docs/api/ZeroClipboard.Core.md b/docs/api/ZeroClipboard.Core.md
@@ -403,6 +403,27 @@ itself to implode by calling `ZeroClipboard.destroy()` under error conditions.
 want to do just that.
 
 
+##### `error[name = "browser-unsupported"]`
+
+This type of `error` event fires when the browser does not support the required HTML DOM and JavaScript features. Check the ["Support" section of the README](../../README.md#support) for the browser support expectations.
+
+```js
+ZeroClipboard.on("error", function(e) {
+/*
+  e = {
+    type: "error",
+    name: "browser-unsupported",
+    messsage: "The browser does not support the required HTML DOM and JavaScript features",
+    target: null,
+    relatedTarget: null,
+    currentTarget: null,
+    timeStamp: Date.now()
+  };
+*/
+});
+```
+
+
 ##### `error[name = "flash-disabled"]`
 
 This type of `error` event fires when Flash Player is either not installed or not enabled in the browser.

diff --git a/docs/api/ZeroClipboard.md b/docs/api/ZeroClipboard.md
@@ -403,6 +403,27 @@ itself to implode by calling `ZeroClipboard.destroy()` under error conditions.
 want to do just that.
 
 
+##### `error[name = "browser-unsupported"]`
+
+This type of `error` event fires when the browser does not support the required HTML DOM and JavaScript features. Check the ["Support" section of the README](../../README.md#support) for the browser support expectations.
+
+```js
+ZeroClipboard.on("error", function(e) {
+/*
+  e = {
+    type: "error",
+    name: "browser-unsupported",
+    messsage: "The browser does not support the required HTML DOM and JavaScript features",
+    target: null,
+    relatedTarget: null,
+    currentTarget: null,
+    timeStamp: Date.now()
+  };
+*/
+});
+```
+
+
 ##### `error[name = "flash-disabled"]`
 
 This type of `error` event fires when Flash Player is either not installed or not enabled in the browser.

diff --git a/src/js/core/api.js b/src/js/core/api.js
@@ -28,12 +28,7 @@ var ZeroClipboard = function() {
  * @readonly
  * @property {string}
  */
-_defineProperty(ZeroClipboard, "version", {
-  value: "<%= version %>",
-  writable: false,
-  configurable: true,
-  enumerable: true
-});
+ZeroClipboard.version = "<%= version %>";
 
 
 /**

diff --git a/src/js/core/private.js b/src/js/core/private.js
@@ -55,7 +55,7 @@ var _state = function() {
   _detectSandbox();
 
   return {
-    browser: _pick(_navigator, ["userAgent", "platform", "appName", "appVersion"]),
+    browser: _extend(_pick(_navigator, ["userAgent", "platform", "appName", "appVersion"]), { "isSupported": _isBrowserSupported() }),
     flash: _omit(_flashState, ["bridge"]),
     zeroclipboard: {
       version: ZeroClipboard.version,
@@ -65,6 +65,21 @@ var _state = function() {
 };
 
 
+/**
+ * Does this browser support all of the necessary DOM and JS features necessary?
+ * @private
+ */
+var _isBrowserSupported = function() {
+  return !!(
+    // DOM Level 2
+    _document.addEventListener &&
+    // ECMAScript 5.1
+    _window.Object.keys &&
+    _window.Array.prototype.map
+  );
+};
+
+
 /**
  * The underlying implementation of `ZeroClipboard.isFlashUnusable`.
  * @private
@@ -120,6 +135,12 @@ var _on = function(eventType, listener) {
       });
     }
     if (added.error) {
+      if (!_isBrowserSupported()) {
+        ZeroClipboard.emit({
+          type: "error",
+          name: "browser-unsupported"
+        });
+      }
       for (i = 0, len = _flashStateErrorNames.length; i < len; i++) {
         if (_flashState[_flashStateErrorNames[i].replace(/^flash-/, "")] === true) {
           ZeroClipboard.emit({
@@ -251,6 +272,12 @@ var _create = function() {
   // Make note of the most recent sandbox assessment
   var previousState = _flashState.sandboxed;
 
+  if (!_isBrowserSupported()) {
+    _flashState.ready = false;
+    ZeroClipboard.emit({ type: "error", name: "browser-unsupported" });
+    return;
+  }
+
   // Always reassess the `sandboxed` state of the page at important Flash-related moments
   _detectSandbox();
 
@@ -741,7 +768,7 @@ var _getSandboxStatusFromErrorEvent = function(event) {
  * @private
  */
 var _preprocessEvent = function(event) {
-  /*jshint maxstatements:27 */
+  /*jshint maxstatements:28 */
 
   var element = event.target || _currentElement || null;
 
@@ -755,7 +782,18 @@ var _preprocessEvent = function(event) {
         _flashState.sandboxed = isSandboxed;
       }
 
-      if (_flashStateErrorNames.indexOf(event.name) !== -1) {
+      if (event.name === "browser-unsupported") {
+        _extend(_flashState, {
+          disabled:    false,
+          outdated:    false,
+          unavailable: false,
+          degraded:    false,
+          deactivated: false,
+          overdue:     false,
+          ready:       false
+        });
+      }
+      else if (_flashStateErrorNames.indexOf(event.name) !== -1) {
         _extend(_flashState, {
           disabled:    event.name === "flash-disabled",
           outdated:    event.name === "flash-outdated",

diff --git a/src/js/core/state.js b/src/js/core/state.js
@@ -118,7 +118,8 @@ var _eventMessages = {
     "version-mismatch": "ZeroClipboard JS version number does not match ZeroClipboard SWF version number",
     "clipboard-error": "At least one error was thrown while ZeroClipboard was attempting to inject your data into the clipboard",
     "config-mismatch": "ZeroClipboard configuration does not match Flash's reality",
-    "swf-not-found": "The ZeroClipboard SWF object could not be loaded, so please check your `swfPath` configuration and/or network connectivity"
+    "swf-not-found": "The ZeroClipboard SWF object could not be loaded, so please check your `swfPath` configuration and/or network connectivity",
+    "browser-unsupported": "The browser does not support the required HTML DOM and JavaScript features"
   }
 };
 

diff --git a/src/js/shared/state.js b/src/js/shared/state.js
@@ -20,7 +20,6 @@ var _window = window,
     _isNaN = _window.Number.isNaN || _window.isNaN,
     _now = _window.Date.now,
     _keys = _window.Object.keys,
-    _defineProperty = _window.Object.defineProperty,
     _hasOwn = _window.Object.prototype.hasOwnProperty,
     _slice = _window.Array.prototype.slice,
     _unwrap = (function() {