-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
20 changed files
with
2,045 additions
and
276 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,253 @@ | ||
/* FileSaver.js | ||
* A saveAs() FileSaver implementation. | ||
* 2015-05-07.2 | ||
* | ||
* By Eli Grey, http://eligrey.com | ||
* License: X11/MIT | ||
* See https://github.com/eligrey/FileSaver.js/blob/master/LICENSE.md | ||
*/ | ||
|
||
/*global self */ | ||
/*jslint bitwise: true, indent: 4, laxbreak: true, laxcomma: true, smarttabs: true, plusplus: true */ | ||
|
||
/*! @source http://purl.eligrey.com/github/FileSaver.js/blob/master/FileSaver.js */ | ||
|
||
var saveAs = saveAs || (function(view) { | ||
"use strict"; | ||
// IE <10 is explicitly unsupported | ||
if (typeof navigator !== "undefined" && /MSIE [1-9]\./.test(navigator.userAgent)) { | ||
return; | ||
} | ||
var | ||
doc = view.document | ||
// only get URL when necessary in case Blob.js hasn't overridden it yet | ||
, get_URL = function() { | ||
return view.URL || view.webkitURL || view; | ||
} | ||
, save_link = doc.createElementNS("http://www.w3.org/1999/xhtml", "a") | ||
, can_use_save_link = "download" in save_link | ||
, click = function(node) { | ||
var event = doc.createEvent("MouseEvents"); | ||
event.initMouseEvent( | ||
"click", true, false, view, 0, 0, 0, 0, 0 | ||
, false, false, false, false, 0, null | ||
); | ||
node.dispatchEvent(event); | ||
} | ||
, webkit_req_fs = view.webkitRequestFileSystem | ||
, req_fs = view.requestFileSystem || webkit_req_fs || view.mozRequestFileSystem | ||
, throw_outside = function(ex) { | ||
(view.setImmediate || view.setTimeout)(function() { | ||
throw ex; | ||
}, 0); | ||
} | ||
, force_saveable_type = "application/octet-stream" | ||
, fs_min_size = 0 | ||
// See https://code.google.com/p/chromium/issues/detail?id=375297#c7 and | ||
// https://github.com/eligrey/FileSaver.js/commit/485930a#commitcomment-8768047 | ||
// for the reasoning behind the timeout and revocation flow | ||
, arbitrary_revoke_timeout = 500 // in ms | ||
, revoke = function(file) { | ||
var revoker = function() { | ||
if (typeof file === "string") { // file is an object URL | ||
get_URL().revokeObjectURL(file); | ||
} else { // file is a File | ||
file.remove(); | ||
} | ||
}; | ||
if (view.chrome) { | ||
revoker(); | ||
} else { | ||
setTimeout(revoker, arbitrary_revoke_timeout); | ||
} | ||
} | ||
, dispatch = function(filesaver, event_types, event) { | ||
event_types = [].concat(event_types); | ||
var i = event_types.length; | ||
while (i--) { | ||
var listener = filesaver["on" + event_types[i]]; | ||
if (typeof listener === "function") { | ||
try { | ||
listener.call(filesaver, event || filesaver); | ||
} catch (ex) { | ||
throw_outside(ex); | ||
} | ||
} | ||
} | ||
} | ||
, auto_bom = function(blob) { | ||
// prepend BOM for UTF-8 XML and text/* types (including HTML) | ||
if (/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(blob.type)) { | ||
return new Blob(["\ufeff", blob], {type: blob.type}); | ||
} | ||
return blob; | ||
} | ||
, FileSaver = function(blob, name) { | ||
blob = auto_bom(blob); | ||
// First try a.download, then web filesystem, then object URLs | ||
var | ||
filesaver = this | ||
, type = blob.type | ||
, blob_changed = false | ||
, object_url | ||
, target_view | ||
, dispatch_all = function() { | ||
dispatch(filesaver, "writestart progress write writeend".split(" ")); | ||
} | ||
// on any filesys errors revert to saving with object URLs | ||
, fs_error = function() { | ||
// don't create more object URLs than needed | ||
if (blob_changed || !object_url) { | ||
object_url = get_URL().createObjectURL(blob); | ||
} | ||
if (target_view) { | ||
target_view.location.href = object_url; | ||
} else { | ||
var new_tab = view.open(object_url, "_blank"); | ||
if (new_tab == undefined && typeof safari !== "undefined") { | ||
//Apple do not allow window.open, see http://bit.ly/1kZffRI | ||
view.location.href = object_url | ||
} | ||
} | ||
filesaver.readyState = filesaver.DONE; | ||
dispatch_all(); | ||
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; | ||
if (!name) { | ||
name = "download"; | ||
} | ||
if (can_use_save_link) { | ||
object_url = get_URL().createObjectURL(blob); | ||
save_link.href = object_url; | ||
save_link.download = name; | ||
click(save_link); | ||
filesaver.readyState = filesaver.DONE; | ||
dispatch_all(); | ||
revoke(object_url); | ||
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 | ||
// 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 | ||
, saveAs = function(blob, name) { | ||
return new FileSaver(blob, name); | ||
} | ||
; | ||
// IE 10+ (native saveAs) | ||
if (typeof navigator !== "undefined" && navigator.msSaveOrOpenBlob) { | ||
return function(blob, name) { | ||
return navigator.msSaveOrOpenBlob(auto_bom(blob), name); | ||
}; | ||
} | ||
|
||
FS_proto.abort = function() { | ||
var filesaver = this; | ||
filesaver.readyState = filesaver.DONE; | ||
dispatch(filesaver, "abort"); | ||
}; | ||
FS_proto.readyState = FS_proto.INIT = 0; | ||
FS_proto.WRITING = 1; | ||
FS_proto.DONE = 2; | ||
|
||
FS_proto.error = | ||
FS_proto.onwritestart = | ||
FS_proto.onprogress = | ||
FS_proto.onwrite = | ||
FS_proto.onabort = | ||
FS_proto.onerror = | ||
FS_proto.onwriteend = | ||
null; | ||
|
||
return saveAs; | ||
}( | ||
typeof self !== "undefined" && self | ||
|| typeof window !== "undefined" && window | ||
|| this.content | ||
)); | ||
// `self` is undefined in Firefox for Android content script context | ||
// while `this` is nsIContentFrameMessageManager | ||
// with an attribute `content` that corresponds to the window | ||
|
||
if (typeof module !== "undefined" && module.exports) { | ||
module.exports.saveAs = saveAs; | ||
} else if ((typeof define !== "undefined" && define !== null) && (define.amd != null)) { | ||
define([], function() { | ||
return saveAs; | ||
}); | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Copyright © 2015 [Eli Grey][1]. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
||
[1]: http://eligrey.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
FileSaver.js | ||
============ | ||
|
||
FileSaver.js implements the HTML5 W3C `saveAs()` FileSaver interface in browsers that do | ||
not natively support it. There is a [FileSaver.js demo][1] that demonstrates saving | ||
various media types. | ||
|
||
FileSaver.js is the solution to saving files on the client-side, and is perfect for | ||
webapps that need to generate files, or for saving sensitive information that shouldn't be | ||
sent to an external server. | ||
|
||
Looking for `canvas.toBlob()` for saving canvases? Check out | ||
[canvas-toBlob.js][2] for a cross-browser implementation. | ||
|
||
Supported browsers | ||
------------------ | ||
|
||
| Browser | Constructs as | Filenames | Max Blob Size | Dependencies | | ||
| -------------- | ------------- | ------------ | ------------- | ------------ | | ||
| Firefox 20+ | Blob | Yes | 800 MiB | None | | ||
| Firefox < 20 | data: URI | No | n/a | [Blob.js](https://github.com/eligrey/Blob.js) | | ||
| Chrome | Blob | Yes | [500 MiB][3] | None | | ||
| Chrome for Android | Blob | Yes | [500 MiB][3] | None | | ||
| IE 10+ | Blob | Yes | 600 MiB | None | | ||
| Opera 15+ | Blob | Yes | 500 MiB | None | | ||
| Opera < 15 | data: URI | No | n/a | [Blob.js](https://github.com/eligrey/Blob.js) | | ||
| Safari 6.1+* | Blob | No | ? | None | | ||
| Safari < 6 | data: URI | No | n/a | [Blob.js](https://github.com/eligrey/Blob.js) | | ||
|
||
Feature detection is possible: | ||
|
||
```js | ||
try { | ||
var isFileSaverSupported = !!new Blob; | ||
} catch (e) {} | ||
``` | ||
|
||
### IE < 10 | ||
|
||
It is possible to save text files in IE < 10 without Flash-based polyfills. | ||
See [ChenWenBrian and koffsyrup's `saveTextAs()`](https://github.com/koffsyrup/FileSaver.js#examples) for more details. | ||
|
||
### Safari 6.1+ | ||
|
||
Blobs may be opened instead of saved sometimes—you may have to direct your Safari users to manually | ||
press <kbd>⌘</kbd>+<kbd>S</kbd> to save the file after it is opened. Using the `application/octet-stream` MIME type to force downloads [can cause issues in Safari](https://github.com/eligrey/FileSaver.js/issues/12#issuecomment-47247096). | ||
|
||
### iOS | ||
|
||
saveAs must be run within a user interaction event such as onTouchDown or onClick; setTimeout will prevent saveAs from triggering. Due to restrictions in iOS saveAs opens in a new window instead of downloading, if you want this fixed please [tell Apple](https://bugs.webkit.org/show_bug.cgi?id=102914) how this bug is affecting you. | ||
|
||
Syntax | ||
------ | ||
|
||
```js | ||
FileSaver saveAs(in Blob data, in DOMString filename) | ||
``` | ||
|
||
Examples | ||
-------- | ||
|
||
### Saving text | ||
|
||
```js | ||
var blob = new Blob(["Hello, world!"], {type: "text/plain;charset=utf-8"}); | ||
saveAs(blob, "hello world.txt"); | ||
``` | ||
|
||
The standard W3C File API [`Blob`][4] interface is not available in all browsers. | ||
[Blob.js][5] is a cross-browser `Blob` implementation that solves this. | ||
|
||
### Saving a canvas | ||
|
||
```js | ||
var canvas = document.getElementById("my-canvas"), ctx = canvas.getContext("2d"); | ||
// draw to canvas... | ||
canvas.toBlob(function(blob) { | ||
saveAs(blob, "pretty image.png"); | ||
}); | ||
``` | ||
|
||
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. | ||
|
||
|
||
![Tracking image](https://in.getclicky.com/212712ns.gif) | ||
|
||
[1]: http://eligrey.com/demos/FileSaver.js/ | ||
[2]: https://github.com/eligrey/canvas-toBlob.js | ||
[3]: https://code.google.com/p/chromium/issues/detail?id=375297 | ||
[4]: https://developer.mozilla.org/en-US/docs/DOM/Blob | ||
[5]: https://github.com/eligrey/Blob.js | ||
[6]: https://github.com/eligrey/canvas-toBlob.js | ||
|
||
Contributing | ||
------------ | ||
|
||
The `FileSaver.js` distribution file is compiled with Uglify.js like so: | ||
|
||
```bash | ||
uglifyjs FileSaver.js --comments /@source/ > FileSaver.min.js | ||
``` | ||
|
||
Please make sure you build a production version before submitting a pull request. | ||
|
||
Bower Installation | ||
------------------ | ||
|
||
Please see the [this repo](http://github.com/Teleborder/FileSaver.js) for a bower-compatible fork of FileSaver.js, available under the package name `file-saver.js`. |
Oops, something went wrong.