FileSaver.js 7.8 KB

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