FileSaver.js 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  1. /* FileSaver.js
  2. * A saveAs() FileSaver implementation.
  3. * 2014-11-29
  4. *
  5. * By Eli Grey, http://eligrey.com
  6. * License: X11/MIT
  7. * See https://github.com/eligrey/FileSaver.js/blob/master/LICENSE.md
  8. */
  9. /*global self */
  10. /*jslint bitwise: true, indent: 4, laxbreak: true, laxcomma: true, smarttabs: true, plusplus: true */
  11. /*! @source http://purl.eligrey.com/github/FileSaver.js/blob/master/FileSaver.js */
  12. var saveAs = saveAs
  13. // IE 10+ (native saveAs)
  14. || (typeof navigator !== "undefined" &&
  15. navigator.msSaveOrOpenBlob && navigator.msSaveOrOpenBlob.bind(navigator))
  16. // Everyone else
  17. || (function(view) {
  18. "use strict";
  19. // IE <10 is explicitly unsupported
  20. if (typeof navigator !== "undefined" &&
  21. /MSIE [1-9]\./.test(navigator.userAgent)) {
  22. return;
  23. }
  24. var
  25. doc = view.document
  26. // only get URL when necessary in case Blob.js hasn't overridden it yet
  27. , get_URL = function() {
  28. return view.URL || view.webkitURL || view;
  29. }
  30. , save_link = doc.createElementNS("http://www.w3.org/1999/xhtml", "a")
  31. , can_use_save_link = "download" in save_link
  32. , click = function(node) {
  33. var event = doc.createEvent("MouseEvents");
  34. event.initMouseEvent(
  35. "click", true, false, view, 0, 0, 0, 0, 0
  36. , false, false, false, false, 0, null
  37. );
  38. node.dispatchEvent(event);
  39. }
  40. , webkit_req_fs = view.webkitRequestFileSystem
  41. , req_fs = view.requestFileSystem || webkit_req_fs || view.mozRequestFileSystem
  42. , throw_outside = function(ex) {
  43. (view.setImmediate || view.setTimeout)(function() {
  44. throw ex;
  45. }, 0);
  46. }
  47. , force_saveable_type = "application/octet-stream"
  48. , fs_min_size = 0
  49. // See https://code.google.com/p/chromium/issues/detail?id=375297#c7 and
  50. // https://github.com/eligrey/FileSaver.js/commit/485930a#commitcomment-8768047
  51. // for the reasoning behind the timeout and revocation flow
  52. , arbitrary_revoke_timeout = 500 // in ms
  53. , revoke = function(file) {
  54. var revoker = function() {
  55. if (typeof file === "string") { // file is an object URL
  56. get_URL().revokeObjectURL(file);
  57. } else { // file is a File
  58. file.remove();
  59. }
  60. };
  61. if (view.chrome) {
  62. revoker();
  63. } else {
  64. setTimeout(revoker, arbitrary_revoke_timeout);
  65. }
  66. }
  67. , dispatch = function(filesaver, event_types, event) {
  68. event_types = [].concat(event_types);
  69. var i = event_types.length;
  70. while (i--) {
  71. var listener = filesaver["on" + event_types[i]];
  72. if (typeof listener === "function") {
  73. try {
  74. listener.call(filesaver, event || filesaver);
  75. } catch (ex) {
  76. throw_outside(ex);
  77. }
  78. }
  79. }
  80. }
  81. , FileSaver = function(blob, name) {
  82. // First try a.download, then web filesystem, then object URLs
  83. var
  84. filesaver = this
  85. , type = blob.type
  86. , blob_changed = false
  87. , object_url
  88. , target_view
  89. , dispatch_all = function() {
  90. dispatch(filesaver, "writestart progress write writeend".split(" "));
  91. }
  92. // on any filesys errors revert to saving with object URLs
  93. , fs_error = function() {
  94. // don't create more object URLs than needed
  95. if (blob_changed || !object_url) {
  96. object_url = get_URL().createObjectURL(blob);
  97. }
  98. if (target_view) {
  99. target_view.location.href = object_url;
  100. } else {
  101. var new_tab = view.open(object_url, "_blank");
  102. if (new_tab == undefined && typeof safari !== "undefined") {
  103. //Apple do not allow window.open, see http://bit.ly/1kZffRI
  104. view.location.href = object_url
  105. }
  106. }
  107. filesaver.readyState = filesaver.DONE;
  108. dispatch_all();
  109. revoke(object_url);
  110. }
  111. , abortable = function(func) {
  112. return function() {
  113. if (filesaver.readyState !== filesaver.DONE) {
  114. return func.apply(this, arguments);
  115. }
  116. };
  117. }
  118. , create_if_not_found = {create: true, exclusive: false}
  119. , slice
  120. ;
  121. filesaver.readyState = filesaver.INIT;
  122. if (!name) {
  123. name = "download";
  124. }
  125. if (can_use_save_link) {
  126. object_url = get_URL().createObjectURL(blob);
  127. save_link.href = object_url;
  128. save_link.download = name;
  129. click(save_link);
  130. filesaver.readyState = filesaver.DONE;
  131. dispatch_all();
  132. revoke(object_url);
  133. return;
  134. }
  135. // Object and web filesystem URLs have a problem saving in Google Chrome when
  136. // viewed in a tab, so I force save with application/octet-stream
  137. // http://code.google.com/p/chromium/issues/detail?id=91158
  138. // Update: Google errantly closed 91158, I submitted it again:
  139. // https://code.google.com/p/chromium/issues/detail?id=389642
  140. if (view.chrome && type && type !== force_saveable_type) {
  141. slice = blob.slice || blob.webkitSlice;
  142. blob = slice.call(blob, 0, blob.size, force_saveable_type);
  143. blob_changed = true;
  144. }
  145. // Since I can't be sure that the guessed media type will trigger a download
  146. // in WebKit, I append .download to the filename.
  147. // https://bugs.webkit.org/show_bug.cgi?id=65440
  148. if (webkit_req_fs && name !== "download") {
  149. name += ".download";
  150. }
  151. if (type === force_saveable_type || webkit_req_fs) {
  152. target_view = view;
  153. }
  154. if (!req_fs) {
  155. fs_error();
  156. return;
  157. }
  158. fs_min_size += blob.size;
  159. req_fs(view.TEMPORARY, fs_min_size, abortable(function(fs) {
  160. fs.root.getDirectory("saved", create_if_not_found, abortable(function(dir) {
  161. var save = function() {
  162. dir.getFile(name, create_if_not_found, abortable(function(file) {
  163. file.createWriter(abortable(function(writer) {
  164. writer.onwriteend = function(event) {
  165. target_view.location.href = file.toURL();
  166. filesaver.readyState = filesaver.DONE;
  167. dispatch(filesaver, "writeend", event);
  168. revoke(file);
  169. };
  170. writer.onerror = function() {
  171. var error = writer.error;
  172. if (error.code !== error.ABORT_ERR) {
  173. fs_error();
  174. }
  175. };
  176. "writestart progress write abort".split(" ").forEach(function(event) {
  177. writer["on" + event] = filesaver["on" + event];
  178. });
  179. writer.write(blob);
  180. filesaver.abort = function() {
  181. writer.abort();
  182. filesaver.readyState = filesaver.DONE;
  183. };
  184. filesaver.readyState = filesaver.WRITING;
  185. }), fs_error);
  186. }), fs_error);
  187. };
  188. dir.getFile(name, {create: false}, abortable(function(file) {
  189. // delete file if it already exists
  190. file.remove();
  191. save();
  192. }), abortable(function(ex) {
  193. if (ex.code === ex.NOT_FOUND_ERR) {
  194. save();
  195. } else {
  196. fs_error();
  197. }
  198. }));
  199. }), fs_error);
  200. }), fs_error);
  201. }
  202. , FS_proto = FileSaver.prototype
  203. , saveAs = function(blob, name) {
  204. return new FileSaver(blob, name);
  205. }
  206. ;
  207. FS_proto.abort = function() {
  208. var filesaver = this;
  209. filesaver.readyState = filesaver.DONE;
  210. dispatch(filesaver, "abort");
  211. };
  212. FS_proto.readyState = FS_proto.INIT = 0;
  213. FS_proto.WRITING = 1;
  214. FS_proto.DONE = 2;
  215. FS_proto.error =
  216. FS_proto.onwritestart =
  217. FS_proto.onprogress =
  218. FS_proto.onwrite =
  219. FS_proto.onabort =
  220. FS_proto.onerror =
  221. FS_proto.onwriteend =
  222. null;
  223. return saveAs;
  224. }(
  225. typeof self !== "undefined" && self
  226. || typeof window !== "undefined" && window
  227. || this.content
  228. ));
  229. // `self` is undefined in Firefox for Android content script context
  230. // while `this` is nsIContentFrameMessageManager
  231. // with an attribute `content` that corresponds to the window
  232. if (typeof module !== "undefined" && module !== null) {
  233. module.exports = saveAs;
  234. } else if ((typeof define !== "undefined" && define !== null) && (define.amd != null)) {
  235. define([], function() {
  236. return saveAs;
  237. });
  238. }