7 Commits
Author SHA1 Message Date
Jimmy Wärting 3eeddf1145 1.3.0 2016-05-31 09:30:32 +02:00
Jimmy Karl Roland Wärting bc0ba24aaa Added failsafe
Closes #216
2016-05-31 09:15:12 +02:00
Jimmy Karl Roland Wärting ae387dbbac Merge pull request #233 from eligrey/remove_filesystem
Removed filesystem and support saving with file name
2016-05-31 09:12:32 +02:00
Jimmy Karl Roland Wärting b610731175 Merge pull request #234 from sjurba/patch-1
Don't ignore the minified file in bower.json
2016-05-30 15:39:07 +02:00
Sjur Bakka 9aee871752 Don't ignore the minified file 2016-05-30 15:36:36 +02:00
Jimmy Wärting 1bb6b90443 closes #174
fixs #231
2016-05-27 23:25:24 +02:00
Jimmy Wärting a5a0ae83db updated versions 2016-05-27 09:31:19 +02:00
4 changed files with 35 additions and 120 deletions
+19 -116
View File
@@ -1,6 +1,6 @@
/* FileSaver.js /* FileSaver.js
* A saveAs() FileSaver implementation. * A saveAs() FileSaver implementation.
* 1.2.2 * 1.3.0
* *
* By Eli Grey, http://eligrey.com * By Eli Grey, http://eligrey.com
* License: MIT * License: MIT
@@ -15,7 +15,7 @@
var saveAs = saveAs || (function(view) { var saveAs = saveAs || (function(view) {
"use strict"; "use strict";
// IE <10 is explicitly unsupported // IE <10 is explicitly unsupported
if (typeof navigator !== "undefined" && /MSIE [1-9]\./.test(navigator.userAgent)) { if (typeof view === "undefined" || typeof navigator !== "undefined" && /MSIE [1-9]\./.test(navigator.userAgent)) {
return; return;
} }
var var
@@ -30,16 +30,13 @@ var saveAs = saveAs || (function(view) {
var event = new MouseEvent("click"); var event = new MouseEvent("click");
node.dispatchEvent(event); node.dispatchEvent(event);
} }
, is_safari = /Version\/[\d\.]+.*Safari/.test(navigator.userAgent) , is_safari = /constructor/i.test(view.HTMLElement)
, webkit_req_fs = view.webkitRequestFileSystem
, req_fs = view.requestFileSystem || webkit_req_fs || view.mozRequestFileSystem
, throw_outside = function(ex) { , throw_outside = function(ex) {
(view.setImmediate || view.setTimeout)(function() { (view.setImmediate || view.setTimeout)(function() {
throw ex; throw ex;
}, 0); }, 0);
} }
, force_saveable_type = "application/octet-stream" , force_saveable_type = "application/octet-stream"
, fs_min_size = 0
// the Blob API is fundamentally broken as there is no "downloadfinished" event to subscribe to // the Blob API is fundamentally broken as there is no "downloadfinished" event to subscribe to
, arbitrary_revoke_timeout = 1000 * 40 // in ms , arbitrary_revoke_timeout = 1000 * 40 // in ms
, revoke = function(file) { , revoke = function(file) {
@@ -50,22 +47,6 @@ var saveAs = saveAs || (function(view) {
file.remove(); file.remove();
} }
}; };
/* // Take note W3C:
var
uri = typeof file === "string" ? file : file.toURL()
, revoker = function(evt) {
// idealy DownloadFinishedEvent.data would be the URL requested
if (evt.data === uri) {
if (typeof file === "string") { // file is an object URL
get_URL().revokeObjectURL(file);
} else { // file is a File
file.remove();
}
}
}
;
view.addEventListener("downloadfinished", revoker);
*/
setTimeout(revoker, arbitrary_revoke_timeout); setTimeout(revoker, arbitrary_revoke_timeout);
} }
, dispatch = function(filesaver, event_types, event) { , dispatch = function(filesaver, event_types, event) {
@@ -98,20 +79,19 @@ var saveAs = saveAs || (function(view) {
var var
filesaver = this filesaver = this
, type = blob.type , type = blob.type
, blob_changed = false , force = type === force_saveable_type
, object_url , object_url
, target_view
, dispatch_all = function() { , dispatch_all = function() {
dispatch(filesaver, "writestart progress write writeend".split(" ")); dispatch(filesaver, "writestart progress write writeend".split(" "));
} }
// on any filesys errors revert to saving with object URLs // on any filesys errors revert to saving with object URLs
, fs_error = function() { , fs_error = function() {
if (target_view && is_safari && typeof FileReader !== "undefined") { if (force && is_safari && view.FileReader) {
// Safari doesn't allow downloading of blob urls // Safari doesn't allow downloading of blob urls
var reader = new FileReader(); var reader = new FileReader();
reader.onloadend = function() { reader.onloadend = function() {
var base64Data = reader.result; var base64Data = reader.result;
target_view.location.href = "data:attachment/file" + base64Data.slice(base64Data.search(/[,;]/)); view.location.href = "data:attachment/file" + base64Data.slice(base64Data.search(/[,;]/));
filesaver.readyState = filesaver.DONE; filesaver.readyState = filesaver.DONE;
dispatch_all(); dispatch_all();
}; };
@@ -120,14 +100,14 @@ var saveAs = saveAs || (function(view) {
return; return;
} }
// don't create more object URLs than needed // don't create more object URLs than needed
if (blob_changed || !object_url) { if (!object_url) {
object_url = get_URL().createObjectURL(blob); object_url = get_URL().createObjectURL(blob);
} }
if (target_view) { if (force) {
target_view.location.href = object_url; view.location.href = object_url;
} else { } else {
var new_tab = view.open(object_url, "_blank"); var opened = view.open(object_url, "_blank");
if (new_tab === undefined && is_safari) { if (!opened) {
// Apple does not allow window.open, see https://developer.apple.com/library/safari/documentation/Tools/Conceptual/SafariExtensionGuide/WorkingwithWindowsandTabs/WorkingwithWindowsandTabs.html // Apple does not allow window.open, see https://developer.apple.com/library/safari/documentation/Tools/Conceptual/SafariExtensionGuide/WorkingwithWindowsandTabs/WorkingwithWindowsandTabs.html
view.location.href = object_url; view.location.href = object_url;
} }
@@ -136,20 +116,9 @@ var saveAs = saveAs || (function(view) {
dispatch_all(); dispatch_all();
revoke(object_url); revoke(object_url);
} }
, abortable = function(func) {
return function() {
if (filesaver.readyState !== filesaver.DONE) {
return func.apply(this, arguments);
}
};
}
, create_if_not_found = {create: true, exclusive: false}
, slice
; ;
filesaver.readyState = filesaver.INIT; filesaver.readyState = filesaver.INIT;
if (!name) {
name = "download";
}
if (can_use_save_link) { if (can_use_save_link) {
object_url = get_URL().createObjectURL(blob); object_url = get_URL().createObjectURL(blob);
setTimeout(function() { setTimeout(function() {
@@ -162,93 +131,27 @@ var saveAs = saveAs || (function(view) {
}); });
return; return;
} }
// Object and web filesystem URLs have a problem saving in Google Chrome when
// viewed in a tab, so I force save with application/octet-stream fs_error();
// http://code.google.com/p/chromium/issues/detail?id=91158
// Update: Google errantly closed 91158, I submitted it again:
// https://code.google.com/p/chromium/issues/detail?id=389642
if (view.chrome && type && type !== force_saveable_type) {
slice = blob.slice || blob.webkitSlice;
blob = slice.call(blob, 0, blob.size, force_saveable_type);
blob_changed = true;
}
// Since I can't be sure that the guessed media type will trigger a download
// in WebKit, I append .download to the filename.
// https://bugs.webkit.org/show_bug.cgi?id=65440
if (webkit_req_fs && name !== "download") {
name += ".download";
}
if (type === force_saveable_type || webkit_req_fs) {
target_view = view;
}
if (!req_fs) {
fs_error();
return;
}
fs_min_size += blob.size;
req_fs(view.TEMPORARY, fs_min_size, abortable(function(fs) {
fs.root.getDirectory("saved", create_if_not_found, abortable(function(dir) {
var save = function() {
dir.getFile(name, create_if_not_found, abortable(function(file) {
file.createWriter(abortable(function(writer) {
writer.onwriteend = function(event) {
target_view.location.href = file.toURL();
filesaver.readyState = filesaver.DONE;
dispatch(filesaver, "writeend", event);
revoke(file);
};
writer.onerror = function() {
var error = writer.error;
if (error.code !== error.ABORT_ERR) {
fs_error();
}
};
"writestart progress write abort".split(" ").forEach(function(event) {
writer["on" + event] = filesaver["on" + event];
});
writer.write(blob);
filesaver.abort = function() {
writer.abort();
filesaver.readyState = filesaver.DONE;
};
filesaver.readyState = filesaver.WRITING;
}), fs_error);
}), fs_error);
};
dir.getFile(name, {create: false}, abortable(function(file) {
// delete file if it already exists
file.remove();
save();
}), abortable(function(ex) {
if (ex.code === ex.NOT_FOUND_ERR) {
save();
} else {
fs_error();
}
}));
}), fs_error);
}), fs_error);
} }
, FS_proto = FileSaver.prototype , FS_proto = FileSaver.prototype
, saveAs = function(blob, name, no_auto_bom) { , saveAs = function(blob, name, no_auto_bom) {
return new FileSaver(blob, name, no_auto_bom); return new FileSaver(blob, name || blob.name || "download", no_auto_bom);
} }
; ;
// IE 10+ (native saveAs) // IE 10+ (native saveAs)
if (typeof navigator !== "undefined" && navigator.msSaveOrOpenBlob) { if (typeof navigator !== "undefined" && navigator.msSaveOrOpenBlob) {
return function(blob, name, no_auto_bom) { return function(blob, name, no_auto_bom) {
name = name || blob.name || "download";
if (!no_auto_bom) { if (!no_auto_bom) {
blob = auto_bom(blob); blob = auto_bom(blob);
} }
return navigator.msSaveOrOpenBlob(blob, name || "download"); return navigator.msSaveOrOpenBlob(blob, name);
}; };
} }
FS_proto.abort = function() { FS_proto.abort = function(){};
var filesaver = this;
filesaver.readyState = filesaver.DONE;
dispatch(filesaver, "abort");
};
FS_proto.readyState = FS_proto.INIT = 0; FS_proto.readyState = FS_proto.INIT = 0;
FS_proto.WRITING = 1; FS_proto.WRITING = 1;
FS_proto.DONE = 2; FS_proto.DONE = 2;
+13 -1
View File
@@ -54,7 +54,7 @@ Syntax
------ ------
```js ```js
FileSaver saveAs(Blob data, DOMString filename, optional Boolean disableAutoBOM) FileSaver saveAs(Blob/File data, optional DOMString filename, optional Boolean disableAutoBOM)
``` ```
Pass `true` for `disableAutoBOM` if you don't want FileSaver.js to automatically provide Unicode text encoding hints (see: [byte order mark](https://en.wikipedia.org/wiki/Byte_order_mark)). Pass `true` for `disableAutoBOM` if you don't want FileSaver.js to automatically provide Unicode text encoding hints (see: [byte order mark](https://en.wikipedia.org/wiki/Byte_order_mark)).
@@ -82,6 +82,18 @@ canvas.toBlob(function(blob) {
}); });
``` ```
### Saving File
You can save a File constructor without specifying a filename. The
File itself already contains a name, There is a hand full of ways to get a file
instance (from storage, file input, new constructor)
But if you still want to change the name, then you can change it in the 2nd argument
```js
var file = new File(["Hello, world!"], "hello world.txt", {type: "text/plain;charset=utf-8"});
saveAs(file);
```
Note: The standard HTML5 `canvas.toBlob()` method is not available in all browsers. Note: The standard HTML5 `canvas.toBlob()` method is not available in all browsers.
[canvas-toBlob.js][6] is a cross-browser `canvas.toBlob()` that polyfills this. [canvas-toBlob.js][6] is a cross-browser `canvas.toBlob()` that polyfills this.
+2 -2
View File
@@ -1,7 +1,7 @@
{ {
"name": "file-saver", "name": "file-saver",
"main": "FileSaver.js", "main": "FileSaver.js",
"version": "1.2.0", "version": "1.3.0",
"homepage": "https://github.com/eligrey/FileSaver.js", "homepage": "https://github.com/eligrey/FileSaver.js",
"authors": [ "authors": [
"Eli Grey <[email protected]>" "Eli Grey <[email protected]>"
@@ -15,7 +15,7 @@
"license": "MIT", "license": "MIT",
"ignore": [ "ignore": [
"*", "*",
"!FileSaver.js", "!FileSaver.*js",
"!LICENSE.md" "!LICENSE.md"
] ]
} }
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "file-saver", "name": "file-saver",
"version": "1.2.0", "version": "1.3.0",
"description": "An HTML5 saveAs() FileSaver implementation", "description": "An HTML5 saveAs() FileSaver implementation",
"main": "FileSaver.js", "main": "FileSaver.js",
"scripts": { "scripts": {