1 /* FileSaver.js

     2  * A saveAs() FileSaver implementation.

     3  * 2015-03-04

     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 

    10 /*global self */

    11 /*jslint bitwise: true, indent: 4, laxbreak: true, laxcomma: true, smarttabs: true, plusplus: true */

    12 

    13 /*! @source http://purl.eligrey.com/github/FileSaver.js/blob/master/FileSaver.js */

    14 

    15 var saveAs = saveAs

    16   // IE 10+ (native saveAs)

    17   || (typeof navigator !== "undefined" &&

    18       navigator.msSaveOrOpenBlob && navigator.msSaveOrOpenBlob.bind(navigator))

    19   // Everyone else

    20   || (function(view) {

    21 	"use strict";

    22 	// IE <10 is explicitly unsupported

    23 	if (typeof navigator !== "undefined" &&

    24 	    /MSIE [1-9]\./.test(navigator.userAgent)) {

    25 		return;

    26 	}

    27 	var

    28 		  doc = view.document

    29 		  // only get URL when necessary in case Blob.js hasn't overridden it yet

    30 		, get_URL = function() {

    31 			return view.URL || view.webkitURL || view;

    32 		}

    33 		, save_link = doc.createElementNS("http://www.w3.org/1999/xhtml", "a")

    34 		, can_use_save_link = "download" in save_link

    35 		, click = function(node) {

    36 			var event = doc.createEvent("MouseEvents");

    37 			event.initMouseEvent(

    38 				"click", true, false, view, 0, 0, 0, 0, 0

    39 				, false, false, false, false, 0, null

    40 			);

    41 			node.dispatchEvent(event);

    42 		}

    43 		, webkit_req_fs = view.webkitRequestFileSystem

    44 		, req_fs = view.requestFileSystem || webkit_req_fs || view.mozRequestFileSystem

    45 		, throw_outside = function(ex) {

    46 			(view.setImmediate || view.setTimeout)(function() {

    47 				throw ex;

    48 			}, 0);

    49 		}

    50 		, force_saveable_type = "application/octet-stream"

    51 		, fs_min_size = 0

    52 		// See https://code.google.com/p/chromium/issues/detail?id=375297#c7 and

    53 		// https://github.com/eligrey/FileSaver.js/commit/485930a#commitcomment-8768047

    54 		// for the reasoning behind the timeout and revocation flow

    55 		, arbitrary_revoke_timeout = 500 // in ms

    56 		, revoke = function(file) {

    57 			var revoker = function() {

    58 				if (typeof file === "string") { // file is an object URL

    59 					get_URL().revokeObjectURL(file);

    60 				} else { // file is a File

    61 					file.remove();

    62 				}

    63 			};

    64 			if (view.chrome) {

    65 				revoker();

    66 			} else {

    67 				setTimeout(revoker, arbitrary_revoke_timeout);

    68 			}

    69 		}

    70 		, dispatch = function(filesaver, event_types, event) {

    71 			event_types = [].concat(event_types);

    72 			var i = event_types.length;

    73 			while (i--) {

    74 				var listener = filesaver["on" + event_types[i]];

    75 				if (typeof listener === "function") {

    76 					try {

    77 						listener.call(filesaver, event || filesaver);

    78 					} catch (ex) {

    79 						throw_outside(ex);

    80 					}

    81 				}

    82 			}

    83 		}

    84 		, FileSaver = function(blob, name) {

    85 			// First try a.download, then web filesystem, then object URLs

    86 			var

    87 				  filesaver = this

    88 				, type = blob.type

    89 				, blob_changed = false

    90 				, object_url

    91 				, target_view

    92 				, dispatch_all = function() {

    93 					dispatch(filesaver, "writestart progress write writeend".split(" "));

    94 				}

    95 				// on any filesys errors revert to saving with object URLs

    96 				, fs_error = function() {

    97 					// don't create more object URLs than needed

    98 					if (blob_changed || !object_url) {

    99 						object_url = get_URL().createObjectURL(blob);

   100 					}

   101 					if (target_view) {

   102 						target_view.location.href = object_url;

   103 					} else {

   104 						var new_tab = view.open(object_url, "_blank");

   105 						if (new_tab == undefined && typeof safari !== "undefined") {

   106 							//Apple do not allow window.open, see http://bit.ly/1kZffRI

   107 							view.location.href = object_url

   108 						}

   109 					}

   110 					filesaver.readyState = filesaver.DONE;

   111 					dispatch_all();

   112 					revoke(object_url);

   113 				}

   114 				, abortable = function(func) {

   115 					return function() {

   116 						if (filesaver.readyState !== filesaver.DONE) {

   117 							return func.apply(this, arguments);

   118 						}

   119 					};

   120 				}

   121 				, create_if_not_found = {create: true, exclusive: false}

   122 				, slice

   123 			;

   124 			filesaver.readyState = filesaver.INIT;

   125 			if (!name) {

   126 				name = "download";

   127 			}

   128 			if (can_use_save_link) {

   129 				object_url = get_URL().createObjectURL(blob);

   130 				save_link.href = object_url;

   131 				save_link.download = name;

   132 				click(save_link);

   133 				filesaver.readyState = filesaver.DONE;

   134 				dispatch_all();

   135 				revoke(object_url);

   136 				return;

   137 			}

   138 			// prepend BOM for UTF-8 XML and text/plain types

   139 			if (/^\s*(?:text\/(?:plain|xml)|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(blob.type)) {

   140 				blob = new Blob(["\ufeff", blob], {type: blob.type});

   141 			}

   142 			// Object and web filesystem URLs have a problem saving in Google Chrome when

   143 			// viewed in a tab, so I force save with application/octet-stream

   144 			// http://code.google.com/p/chromium/issues/detail?id=91158

   145 			// Update: Google errantly closed 91158, I submitted it again:

   146 			// https://code.google.com/p/chromium/issues/detail?id=389642

   147 			if (view.chrome && type && type !== force_saveable_type) {

   148 				slice = blob.slice || blob.webkitSlice;

   149 				blob = slice.call(blob, 0, blob.size, force_saveable_type);

   150 				blob_changed = true;

   151 			}

   152 			// Since I can't be sure that the guessed media type will trigger a download

   153 			// in WebKit, I append .download to the filename.

   154 			// https://bugs.webkit.org/show_bug.cgi?id=65440

   155 			if (webkit_req_fs && name !== "download") {

   156 				name += ".download";

   157 			}

   158 			if (type === force_saveable_type || webkit_req_fs) {

   159 				target_view = view;

   160 			}

   161 			if (!req_fs) {

   162 				fs_error();

   163 				return;

   164 			}

   165 			fs_min_size += blob.size;

   166 			req_fs(view.TEMPORARY, fs_min_size, abortable(function(fs) {

   167 				fs.root.getDirectory("saved", create_if_not_found, abortable(function(dir) {

   168 					var save = function() {

   169 						dir.getFile(name, create_if_not_found, abortable(function(file) {

   170 							file.createWriter(abortable(function(writer) {

   171 								writer.onwriteend = function(event) {

   172 									target_view.location.href = file.toURL();

   173 									filesaver.readyState = filesaver.DONE;

   174 									dispatch(filesaver, "writeend", event);

   175 									revoke(file);

   176 								};

   177 								writer.onerror = function() {

   178 									var error = writer.error;

   179 									if (error.code !== error.ABORT_ERR) {

   180 										fs_error();

   181 									}

   182 								};

   183 								"writestart progress write abort".split(" ").forEach(function(event) {

   184 									writer["on" + event] = filesaver["on" + event];

   185 								});

   186 								writer.write(blob);

   187 								filesaver.abort = function() {

   188 									writer.abort();

   189 									filesaver.readyState = filesaver.DONE;

   190 								};

   191 								filesaver.readyState = filesaver.WRITING;

   192 							}), fs_error);

   193 						}), fs_error);

   194 					};

   195 					dir.getFile(name, {create: false}, abortable(function(file) {

   196 						// delete file if it already exists

   197 						file.remove();

   198 						save();

   199 					}), abortable(function(ex) {

   200 						if (ex.code === ex.NOT_FOUND_ERR) {

   201 							save();

   202 						} else {

   203 							fs_error();

   204 						}

   205 					}));

   206 				}), fs_error);

   207 			}), fs_error);

   208 		}

   209 		, FS_proto = FileSaver.prototype

   210 		, saveAs = function(blob, name) {

   211 			return new FileSaver(blob, name);

   212 		}

   213 	;

   214 	FS_proto.abort = function() {

   215 		var filesaver = this;

   216 		filesaver.readyState = filesaver.DONE;

   217 		dispatch(filesaver, "abort");

   218 	};

   219 	FS_proto.readyState = FS_proto.INIT = 0;

   220 	FS_proto.WRITING = 1;

   221 	FS_proto.DONE = 2;

   222 

   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 

   232 	return saveAs;

   233 }(

   234 	   typeof self !== "undefined" && self

   235 	|| typeof window !== "undefined" && window

   236 	|| this.content

   237 ));

   238 // `self` is undefined in Firefox for Android content script context

   239 // while `this` is nsIContentFrameMessageManager

   240 // with an attribute `content` that corresponds to the window

   241 

   242 if (typeof module !== "undefined" && module.exports) {

   243   module.exports.saveAs = saveAs;

   244 } else if ((typeof define !== "undefined" && define !== null) && (define.amd != null)) {

   245   define([], function() {

   246     return saveAs;

   247   });

   248 }