Tweet
Tweet

Slide 1

Slide 1 text

INTRODUCTION TO HTML FILESYSTEM API Pascal Precht / @PascalPrecht

Slide 2

Slide 2 text

hi there. Pascal Precht Front-end Engineer, Neoskop GmbH

Slide 3

Slide 3 text

HTML5 Filesystem API

Slide 4

Slide 4 text

HTML5 Filesystem API

Slide 5

Slide 5 text

HTML5 Filesystem API

Slide 6

Slide 6 text

HTML5 Filesystem API FileWriter

Slide 7

Slide 7 text

HTML5 Filesystem API FileWriter File/Blob, FileList, FileReader

Slide 8

Slide 8 text

HTML5 Filesystem API FileWriter File/Blob, FileList, FileReader DirectoryReader, FileEntry/ DirectoryEntry, LocalFileSystem

Slide 9

Slide 9 text

Use cases?

Slide 10

Slide 10 text

Use cases?

Slide 11

Slide 11 text

• Persistent Uploader Local Sandbox, uploading a chunk at a time Use cases?

Slide 12

Slide 12 text

• Persistent Uploader Local Sandbox, uploading a chunk at a time • Video Game, Music, Apps with media assets Using assets from local cache Use cases?

Slide 13

Slide 13 text

• Persistent Uploader Local Sandbox, uploading a chunk at a time • Video Game, Music, Apps with media assets Using assets from local cache • Offline web mail client Storing attachments locally Use cases?

Slide 14

Slide 14 text

No content

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

Let’s dive in!

Slide 18

Slide 18 text

3 Storage Types • Temporary Storage No prompt, reasonable amount of storage is granted by default

Slide 19

Slide 19 text

3 Storage Types • Temporary Storage No prompt, reasonable amount of storage is granted by default • Persistent Storage Browser prompt, zero quota granted by default, more storage can be requested

Slide 20

Slide 20 text

3 Storage Types • Temporary Storage No prompt, reasonable amount of storage is granted by default • Persistent Storage Browser prompt, zero quota granted by default, more storage can be requested • Unlimited Storage Chrome Apps and Extensions, no prompt

Slide 21

Slide 21 text

window.webkitStorageInfo

Slide 22

Slide 22 text

webkitStorageInfo.queryUsageAndQuota(TEMPORARY, function (usage, quota) { console.log(“Using “+(usage/quota)*100+”% of temporary storage”); }, function (e) { console.log(“Error: “+ e); });

Slide 23

Slide 23 text

webkitStorageInfo.queryUsageAndQuota(TEMPORARY, function (usage, quota) { console.log(“Using “+(usage/quota)*100+”% of temporary storage”); }, function (e) { console.log(“Error: “+ e); });

Slide 24

Slide 24 text

webkitStorageInfo.queryUsageAndQuota(TEMPORARY, function (usage, quota) { console.log(“Using “+(usage/quota)*100+”% of temporary storage”); }, function (e) { console.log(“Error: “+ e); });

Slide 25

Slide 25 text

webkitStorageInfo.queryUsageAndQuota(TEMPORARY, function (usage, quota) { console.log(“Using “+(usage/quota)*100+”% of temporary storage”); }, function (e) { console.log(“Error: “+ e); });

Slide 26

Slide 26 text

webkitStorageInfo.queryUsageAndQuota(TEMPORARY, function (usage, quota) { console.log(“Using “+(usage/quota)*100+”% of temporary storage”); }, function (e) { console.log(“Error: “+ e); });

Slide 27

Slide 27 text

webkitStorageInfo.requestQuota(TEMPORARY, 2*1024*1024, function (bytes) { console.log(“Granted “+bytes+” bytes in temporary storage”); }, function (e) { console.log(“Error: “+ e); });

Slide 28

Slide 28 text

webkitStorageInfo.requestQuota(TEMPORARY, 2*1024*1024, function (bytes) { console.log(“Granted “+bytes+” bytes in temporary storage”); }, function (e) { console.log(“Error: “+ e); });

Slide 29

Slide 29 text

webkitStorageInfo.requestQuota(TEMPORARY, 2*1024*1024, function (bytes) { console.log(“Granted “+bytes+” bytes in temporary storage”); }, function (e) { console.log(“Error: “+ e); });

Slide 30

Slide 30 text

webkitStorageInfo.requestQuota(TEMPORARY, 2*1024*1024, function (bytes) { console.log(“Granted “+bytes+” bytes in temporary storage”); }, function (e) { console.log(“Error: “+ e); });

Slide 31

Slide 31 text

webkitStorageInfo.requestQuota(TEMPORARY, 2*1024*1024, function (bytes) { console.log(“Granted “+bytes+” bytes in temporary storage”); }, function (e) { console.log(“Error: “+ e); });

Slide 32

Slide 32 text

webkitStorageInfo.requestQuota(TEMPORARY, 2*1024*1024, function (bytes) { console.log(“Granted “+bytes+” bytes in temporary storage”); }, function (e) { console.log(“Error: “+ e); });

Slide 33

Slide 33 text

webkitStorageInfo.requestQuota(PERSISTENT, bytes, onSuccess, onError);

Slide 34

Slide 34 text

window.requestFileSystem

Slide 35

Slide 35 text

window.webkitRequestFileSystem(type, size, onSuccess, onError); webkitStorageInfo.requestQuota(PERSISTENT, bytes, function (bytes) { webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { console.log(“Opened filesystem: “+fs.name”); }, function (e) { console.log(“Error: “+ e); }); }, onError);

Slide 36

Slide 36 text

Working with Files

Slide 37

Slide 37 text

FileEntry.isFile FileEntry.isDirectory FileEntry.fullPath FileEntry.filesystem FileEntry.getMetadata(onSuccess, onError); FileEntry.moveTo(parentDirEntry, newName, onSuccess, onError); FileEntry.copyTo(parentDirEntry, newName, onSuccess, onError); FileEntry.toUrl(); FileEntry.remove(onSuccess, onError); FileEntry.getParent(onSuccess, onError); FileEntry.createWriter(onSuccess, onError); FileEntry.file(onSuccess, onError); The FileEntry

Slide 38

Slide 38 text

FileEntry.isFile FileEntry.isDirectory FileEntry.fullPath FileEntry.filesystem // filesystem on which the entry resides FileEntry.getMetadata(onSuccess, onError); FileEntry.moveTo(parentDirEntry, newName, onSuccess, onError); FileEntry.copyTo(parentDirEntry, newName, onSuccess, onError); FileEntry.toUrl(); FileEntry.remove(onSuccess, onError); FileEntry.getParent(onSuccess, onError); FileEntry.createWriter(onSuccess, onError); FileEntry.file(onSuccess, onError); The FileEntry

Slide 39

Slide 39 text

FileEntry.isFile FileEntry.isDirectory FileEntry.fullPath FileEntry.filesystem FileEntry.getMetadata(onSuccess, onError); FileEntry.moveTo(parentDirEntry, newName, onSuccess, onError); FileEntry.copyTo(parentDirEntry, newName, onSuccess, onError); FileEntry.toUrl(); // Returns a filesystem: URL FileEntry.remove(onSuccess, onError); FileEntry.getParent(onSuccess, onError); FileEntry.createWriter(onSuccess, onError); FileEntry.file(onSuccess, onError); The FileEntry

Slide 40

Slide 40 text

FileEntry.isFile FileEntry.isDirectory FileEntry.fullPath FileEntry.filesystem FileEntry.getMetadata(onSuccess, onError); FileEntry.moveTo(parentDirEntry, newName, onSuccess, onError); FileEntry.copyTo(parentDirEntry, newName, onSuccess, onError); FileEntry.toUrl(); FileEntry.remove(onSuccess, onError); FileEntry.getParent(onSuccess, onError); FileEntry.createWriter(onSuccess, onError); // new FileWriter FileEntry.file(onSuccess, onError); The FileEntry

Slide 41

Slide 41 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {create: true}, function (fileEntry) { fileEntry.getMetadata(function (md) { console.log(md.modificationTime.toDateString()); }); }); }); Creating a File

Slide 42

Slide 42 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {create: true}, function (fileEntry) { fileEntry.getMetadata(function (md) { console.log(md.modificationTime.toDateString()); }); }); }); Creating a File

Slide 43

Slide 43 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {create: true}, function (fileEntry) { fileEntry.getMetadata(function (md) { console.log(md.modificationTime.toDateString()); }); }); }); Creating a File

Slide 44

Slide 44 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {create: true}, function (fileEntry) { fileEntry.getMetadata(function (md) { console.log(md.modificationTime.toDateString()); }); }); }); Creating a File

Slide 45

Slide 45 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {create: true}, function (fileEntry) { fileEntry.getMetadata(function (md) { console.log(md.modificationTime.toDateString()); }); }); }); Creating a File

Slide 46

Slide 46 text

FileReader.error FileReader.readyState FileReader.result FileReader.abort(blob); FileReader.readAsArrayBuffer(blob); FileReader.readAsBinaryString(blob); FileReader.readAsDataUrl(blob); FileReader.readAsText(file); FileReader.onabort FileReader.onload FileReader.onloadstart FileReader.onloadend FileReader.onprogress The FileReader

Slide 47

Slide 47 text

FileReader.error FileReader.readyState FileReader.result // file’s contents FileReader.abort(blob); FileReader.readAsArrayBuffer(blob); FileReader.readAsBinaryString(blob); FileReader.readAsDataUrl(blob); FileReader.readAsText(file); FileReader.onabort FileReader.onload FileReader.onloadstart FileReader.onloadend FileReader.onprogress The FileReader

Slide 48

Slide 48 text

FileReader.error FileReader.readyState FileReader.result FileReader.abort(blob); FileReader.readAsArrayBuffer(blob); FileReader.readAsBinaryString(blob); FileReader.readAsDataUrl(blob); FileReader.readAsText(file); FileReader.onabort FileReader.onload // Read operation successfully completed FileReader.onloadstart FileReader.onloadend FileReader.onprogress The FileReader

Slide 49

Slide 49 text

FileReader.error FileReader.readyState FileReader.result FileReader.abort(blob); FileReader.readAsArrayBuffer(blob); FileReader.readAsBinaryString(blob); FileReader.readAsDataUrl(blob); FileReader.readAsText(file); FileReader.onabort FileReader.onload FileReader.onloadstart FileReader.onloadend // Read completed, whether successfully or not FileReader.onprogress The FileReader

Slide 50

Slide 50 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {}, function (fileEntry) { fileEntry.file(function (file) { var reader = new FileReader(); reader.onloadend = function (e) { var textarea = document.createElement(‘textarea’); textarea.value = this.result; document.body.appendChild(textarea); }; reader.readAsText(file); }); }); }); Reading a File

Slide 51

Slide 51 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {}, function (fileEntry) { fileEntry.file(function (file) { var reader = new FileReader(); reader.onloadend = function (e) { var textarea = document.createElement(‘textarea’); textarea.value = this.result; document.body.appendChild(textarea); }; reader.readAsText(file); }); }); }); Reading a File

Slide 52

Slide 52 text

FileReader.position FileReader.length FileReader.error FileReader.readyState FileReader.abort(); FileReader.write(blob); FileReader.seek(offset); FileReader.truncate(size); FileReader.onabort FileReader.onerror FileReader.onprogress FileReader.onwrite FileReader.onwritestart FileReader.onwriteend The FileWriter

Slide 53

Slide 53 text

FileReader.position FileReader.length FileReader.error FileReader.readyState // One of 3 states: INIT, WRITING, DONE FileReader.abort(); FileReader.write(blob); FileReader.seek(offset); FileReader.truncate(size); FileReader.onabort FileReader.onerror FileReader.onprogress FileReader.onwrite FileReader.onwritestart FileReader.onwriteend The FileWriter

Slide 54

Slide 54 text

FileReader.position FileReader.length FileReader.error FileReader.readyState FileReader.abort(); FileReader.write(blob); FileReader.seek(offset); FileReader.truncate(size); // Changes the length of a file FileReader.onabort FileReader.onerror FileReader.onprogress FileReader.onwrite FileReader.onwritestart FileReader.onwriteend The FileWriter

Slide 55

Slide 55 text

FileReader.position FileReader.length FileReader.error FileReader.readyState FileReader.abort(); FileReader.write(blob); FileReader.seek(offset); FileReader.truncate(size); FileReader.onabort FileReader.onerror FileReader.onprogress FileReader.onwrite // write operation successfully completed FileReader.onwritestart FileReader.onwriteend The FileWriter

Slide 56

Slide 56 text

FileReader.position FileReader.length FileReader.error FileReader.readyState FileReader.abort(); FileReader.write(blob); FileReader.seek(offset); FileReader.truncate(size); FileReader.onabort FileReader.onerror FileReader.onprogress FileReader.onwrite FileReader.onwritestart // before writing is about to start FileReader.onwriteend The FileWriter

Slide 57

Slide 57 text

FileReader.position FileReader.length FileReader.error FileReader.readyState FileReader.abort(); FileReader.write(blob); FileReader.seek(offset); FileReader.truncate(size); FileReader.onabort FileReader.onerror FileReader.onprogress FileReader.onwrite FileReader.onwritestart FileReader.onwriteend // write complete, whether successful or not The FileWriter

Slide 58

Slide 58 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {}, function (fileEntry) { fileEntry.createWriter(function (fileWriter) { var blob = new Blob( [“Hello World”], {“type”:”text/plain”}); fileWriter.write(blob); }); }); }); Writing a File

Slide 59

Slide 59 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {}, function (fileEntry) { fileEntry.createWriter(function (fileWriter) { var blob = new Blob( [“Hello World”], {“type”:”text/plain”}); fileWriter.write(blob); }); }); }); Writing a File

Slide 60

Slide 60 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {}, function (fileEntry) { fileEntry.createWriter(function (fileWriter) { var toAppend = new Blob([“Appended sentence”], { “type”:”text/plain” }); fileWriter.seek(fileWriter.length); fileWriter.write(toAppend); }); }); }); Appending Data

Slide 61

Slide 61 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {}, function (fileEntry) { fileEntry.createWriter(function (fileWriter) { var toAppend = new Blob([“Appended sentence”], { “type”:”text/plain” }); fileWriter.seek(fileWriter.length); fileWriter.write(toAppend); }); }); }); Appending Data

Slide 62

Slide 62 text

webkitRequestFileSystem(PERSISTENT, bytes, function (fs) { fs.root.getFile('example.txt', {}, function (fileEntry) { fileEntry.createWriter(function (fileWriter) { var toAppend = new Blob([“Appended sentence”], { “type”:”text/plain” }); fileWriter.seek(fileWriter.length); fileWriter.write(toAppend); }); }); }); Appending Data

Slide 63

Slide 63 text

Importing Files

Slide 64

Slide 64 text

Importing Files

Slide 65

Slide 65 text

• Use User selects files from hard drive Importing Files

Slide 66

Slide 66 text

• Use User selects files from hard drive • HTML5 Drag And Drop Nearly the same. (Checkout Dnd.js!) Importing Files

Slide 67

Slide 67 text

• Use User selects files from hard drive • HTML5 Drag And Drop Nearly the same. (Checkout Dnd.js!) • XHR2 Fetching remote binary data Importing Files

Slide 68

Slide 68 text

• Use User selects files from hard drive • HTML5 Drag And Drop Nearly the same. (Checkout Dnd.js!) • XHR2 Fetching remote binary data • Copy and Paste Events Apps can read clipboard information Importing Files

Slide 69

Slide 69 text

Slide 70

Slide 70 text

Slide 71

Slide 71 text

document.querySelector(“input[type=file]”).onchange = function (e) { var files = this.files; webkitRequestFileSystem(TEMPORARY, 1024*1024, function (fs) { var i = 0, file; for(; file = files[i]; i++) { fs.root.getFile(file.name, {create: true}, function (fileEntry) { fileEntry.createWriter(function(fileWriter) { fileWriter.write(file); }); }); } }); });

Slide 72

Slide 72 text

document.querySelector(“input[type=file]”).onchange = function (e) { var files = this.files; webkitRequestFileSystem(TEMPORARY, 1024*1024, function (fs) { var i = 0, file; for(; file = files[i]; i++) { fs.root.getFile(file.name, {create: true}, function (fileEntry) { fileEntry.createWriter(function(fileWriter) { fileWriter.write(file); }); }); } }); });

Slide 73

Slide 73 text

document.querySelector(“input[type=file]”).onchange = function (e) { var files = this.files; webkitRequestFileSystem(TEMPORARY, 1024*1024, function (fs) { var i = 0, file; for(; file = files[i]; i++) { fs.root.getFile(file.name, {create: true}, function (fileEntry) { fileEntry.createWriter(function(fileWriter) { fileWriter.write(file); }); }); } }); });

Slide 74

Slide 74 text

document.querySelector(“input[type=file]”).onchange = function (e) { var files = this.files; webkitRequestFileSystem(TEMPORARY, 1024*1024, function (fs) { var i = 0, file; for(; file = files[i]; i++) { fs.root.getFile(file.name, {create: true}, function (fileEntry) { fileEntry.createWriter(function(fileWriter) { fileWriter.write(file); }); }); } }); });

Slide 75

Slide 75 text

document.querySelector(“input[type=file]”).onchange = function (e) { var files = this.files; webkitRequestFileSystem(TEMPORARY, 1024*1024, function (fs) { var i = 0, file; for(; file = files[i]; i++) { fs.root.getFile(file.name, {create: true}, function (fileEntry) { fileEntry.createWriter(function(fileWriter) { fileWriter.write(file); }); }); } }); });

Slide 76

Slide 76 text

document.querySelector(“input[type=file]”).onchange = function (e) { var files = this.files; webkitRequestFileSystem(TEMPORARY, 1024*1024, function (fs) { var i = 0, file; for(; file = files[i]; i++) { fs.root.getFile(file.name, {create: true}, function (fileEntry) { fileEntry.createWriter(function(fileWriter) { fileWriter.write(file); }); }); } }); });

Slide 77

Slide 77 text

HTML5 Drag And Drop (using DnD.js)

Slide 78

Slide 78 text

No content

Slide 79

Slide 79 text

No content

Slide 80

Slide 80 text

dnd.on(‘#dropArea’, { ‘enter’: function (element) { element.classList.add(‘dropping’); }, ‘leave’: function (element) { element.classList.remove(‘dropping’); }, ‘drop’: function (element, files) { [].forEach.call(files, function (file, i) { webkitRequestFileSystem(TEMPORARY, 1024*1024, function (fs) { fs.root.getFile(file.name, {create: true}, function (fileEntry) { fileEntry.createWriter(function (writer) { writer.write(file); }); }); }); } });

Slide 81

Slide 81 text

dnd.on(‘#dropArea’, { ‘enter’: function (element) { element.classList.add(‘dropping’); }, ‘leave’: function (element) { element.classList.remove(‘dropping’); }, ‘drop’: function (element, files) { [].forEach.call(files, function (file, i) { webkitRequestFileSystem(TEMPORARY, 1024*1024, function (fs) { fs.root.getFile(file.name, {create: true}, function (fileEntry) { fileEntry.createWriter(function (writer) { writer.write(file); }); }); }); } });

Slide 82

Slide 82 text

Filesystem URLS

Slide 83

Slide 83 text

filesystem:// fileEntry.toURL(); e.g. “filesystem:http://localhost/TEMPORARY/foo.txt”

Slide 84

Slide 84 text

window.resolveLocalFileSystemURL

Slide 85

Slide 85 text

window.resolveLocalFileSystemURL(URL, function (fileEntry) { // fileEntry.isFile === true }, onError);

Slide 86

Slide 86 text

window.resolveLocalFileSystemURL(URL, function (fileEntry) { // fileEntry.isFile === true }, onError);

Slide 87

Slide 87 text

window.resolveLocalFileSystemURL(URL, function (fileEntry) { // fileEntry.isFile === true }, onError);

Slide 88

Slide 88 text

window.resolveLocalFileSystemURL(URL, function (fileEntry) { // fileEntry.isFile === true }, onError);

Slide 89

Slide 89 text

Further Reading

Slide 90

Slide 90 text

Further Reading

Slide 91

Slide 91 text

Further Reading

Slide 92

Slide 92 text

• HTML5ROCKS.COM http://www.html5rocks.com/en/tutorials/file/ filesystem/ Further Reading

Slide 93

Slide 93 text

• HTML5ROCKS.COM http://www.html5rocks.com/en/tutorials/file/ filesystem/ • MDN https://developer.mozilla.org/en/DOM/File_API/ File_System_API/FileSystem Further Reading

Slide 94

Slide 94 text

INTRODUCTION TO HTML FILESYSTEM API Pascal Precht Twitter: @PascalPrecht Blog: hopelessart.com Slides: speakerdeck.com/u/pascalprecht/p/introduction-to-html5- filesystem-api

Slide 95

Slide 95 text

Thanks!