FileSaver.js 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. /*
  2. Copyright (c) 2011 Eli Grey, http://eligrey.com
  3. This file is based on:
  4. https://github.com/eligrey/FileSaver.js/blob/master/FileSaver.js ,
  5. licensed under X11/MIT.
  6. See https://github.com/eligrey/FileSaver.js/blob/master/LICENSE.md
  7. This file is part of SwitchySharp.
  8. SwitchySharp is free software: you can redistribute it and/or modify
  9. it under the terms of the GNU General Public License as published by
  10. the Free Software Foundation, either version 3 of the License, or
  11. (at your option) any later version.
  12. SwitchySharp is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. GNU General Public License for more details.
  16. You should have received a copy of the GNU General Public License
  17. along with SwitchySharp. If not, see <http://www.gnu.org/licenses/>.
  18. */
  19. var saveAs = saveAs || (function (view) {
  20. "use strict";
  21. var
  22. doc = view.document
  23. // only get URL when necessary in case BlobBuilder.js hasn't overridden it yet
  24. , get_URL = function () {
  25. return view.URL || view.webkitURL || view;
  26. }
  27. , URL = view.URL || view.webkitURL || view
  28. , save_link = doc.createElementNS("http://www.w3.org/1999/xhtml", "a")
  29. , can_use_save_link = "download" in save_link
  30. , click = function (node) {
  31. var event = doc.createEvent("MouseEvents");
  32. event.initMouseEvent(
  33. "click", true, false, view, 0, 0, 0, 0, 0
  34. , false, false, false, false, 0, null
  35. );
  36. return node.dispatchEvent(event); // false if event was cancelled
  37. }
  38. , webkit_req_fs = view.webkitRequestFileSystem
  39. , req_fs = view.requestFileSystem || webkit_req_fs || view.mozRequestFileSystem
  40. , throw_outside = function (ex) {
  41. (view.setImmediate || view.setTimeout)(function () {
  42. throw ex;
  43. }, 0);
  44. }
  45. , force_saveable_type = "application/octet-stream"
  46. , fs_min_size = 0
  47. , deletion_queue = []
  48. , process_deletion_queue = function () {
  49. var i = deletion_queue.length;
  50. while (i--) {
  51. var file = deletion_queue[i];
  52. if (typeof file === "string") { // file is an object URL
  53. URL.revokeObjectURL(file);
  54. } else { // file is a File
  55. file.remove();
  56. }
  57. }
  58. deletion_queue.length = 0; // clear queue
  59. }
  60. , dispatch = function (filesaver, event_types, event) {
  61. event_types = [].concat(event_types);
  62. var i = event_types.length;
  63. while (i--) {
  64. var listener = filesaver["on" + event_types[i]];
  65. if (typeof listener === "function") {
  66. try {
  67. listener.call(filesaver, event || filesaver);
  68. } catch (ex) {
  69. throw_outside(ex);
  70. }
  71. }
  72. }
  73. }
  74. , FileSaver = function (blob, name) {
  75. // First try a.download, then web filesystem, then object URLs
  76. var
  77. filesaver = this
  78. , type = blob.type
  79. , blob_changed = false
  80. , object_url
  81. , target_view
  82. , get_object_url = function (blob) {
  83. var object_url = get_URL().createObjectURL(blob);
  84. deletion_queue.push(object_url);
  85. return object_url;
  86. }
  87. , dispatch_all = function () {
  88. dispatch(filesaver, "writestart progress write writeend".split(" "));
  89. }
  90. // on any filesys errors revert to saving with object URLs
  91. , fs_error = function () {
  92. // don't create more object URLs than needed
  93. if (blob_changed || !object_url) {
  94. object_url = get_object_url(blob);
  95. }
  96. target_view.location.href = object_url;
  97. filesaver.readyState = filesaver.DONE;
  98. dispatch_all();
  99. }
  100. , abortable = function (func) {
  101. return function () {
  102. if (filesaver.readyState !== filesaver.DONE) {
  103. return func.apply(this, arguments);
  104. }
  105. };
  106. }
  107. , create_if_not_found = {create:true, exclusive:false}
  108. , slice
  109. ;
  110. filesaver.readyState = filesaver.INIT;
  111. if (!name) {
  112. name = "download";
  113. }
  114. if (can_use_save_link) {
  115. object_url = get_object_url(blob);
  116. save_link.href = object_url;
  117. save_link.download = name;
  118. if (click(save_link)) {
  119. filesaver.readyState = filesaver.DONE;
  120. dispatch_all();
  121. return;
  122. }
  123. }
  124. // Object and web filesystem URLs have a problem saving in Google Chrome when
  125. // viewed in a tab, so I force save with application/octet-stream
  126. // http://code.google.com/p/chromium/issues/detail?id=91158
  127. if (view.chrome && type && type !== force_saveable_type) {
  128. slice = blob.slice || blob.webkitSlice;
  129. blob = slice.call(blob, 0, blob.size, force_saveable_type);
  130. blob_changed = true;
  131. }
  132. // Since I can't be sure that the guessed media type will trigger a download
  133. // in WebKit, I append .download to the filename.
  134. // https://bugs.webkit.org/show_bug.cgi?id=65440
  135. //if (webkit_req_fs && name !== "download") {
  136. // name += ".download";
  137. //}
  138. if (type === force_saveable_type || webkit_req_fs) {
  139. target_view = view;
  140. } else {
  141. target_view = view.open();
  142. }
  143. if (!req_fs) {
  144. fs_error();
  145. return;
  146. }
  147. fs_min_size += blob.size;
  148. req_fs(view.TEMPORARY, fs_min_size, abortable(function (fs) {
  149. fs.root.getDirectory("saved", create_if_not_found, abortable(function (dir) {
  150. var save = function () {
  151. dir.getFile(name, create_if_not_found, abortable(function (file) {
  152. file.createWriter(abortable(function (writer) {
  153. writer.onwriteend = function (event) {
  154. target_view.location.href = file.toURL();
  155. deletion_queue.push(file);
  156. filesaver.readyState = filesaver.DONE;
  157. dispatch(filesaver, "writeend", event);
  158. };
  159. writer.onerror = function () {
  160. var error = writer.error;
  161. if (error.code !== error.ABORT_ERR) {
  162. fs_error();
  163. }
  164. };
  165. "writestart progress write abort".split(" ").forEach(function (event) {
  166. writer["on" + event] = filesaver["on" + event];
  167. });
  168. writer.write(blob);
  169. filesaver.abort = function () {
  170. writer.abort();
  171. filesaver.readyState = filesaver.DONE;
  172. };
  173. filesaver.readyState = filesaver.WRITING;
  174. }), fs_error);
  175. }), fs_error);
  176. };
  177. dir.getFile(name, {create:false}, abortable(function (file) {
  178. // delete file if it already exists
  179. file.remove();
  180. save();
  181. }), abortable(function (ex) {
  182. if (ex.code === ex.NOT_FOUND_ERR) {
  183. save();
  184. } else {
  185. fs_error();
  186. }
  187. }));
  188. }), fs_error);
  189. }), fs_error);
  190. }
  191. , FS_proto = FileSaver.prototype
  192. , saveAs = function (blob, name) {
  193. return new FileSaver(blob, name);
  194. }
  195. ;
  196. FS_proto.abort = function () {
  197. var filesaver = this;
  198. filesaver.readyState = filesaver.DONE;
  199. dispatch(filesaver, "abort");
  200. };
  201. FS_proto.readyState = FS_proto.INIT = 0;
  202. FS_proto.WRITING = 1;
  203. FS_proto.DONE = 2;
  204. FS_proto.error =
  205. FS_proto.onwritestart =
  206. FS_proto.onprogress =
  207. FS_proto.onwrite =
  208. FS_proto.onabort =
  209. FS_proto.onerror =
  210. FS_proto.onwriteend =
  211. null;
  212. view.addEventListener("unload", process_deletion_queue, false);
  213. return saveAs;
  214. }(self));