/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ if (!Cordova.hasResource("file")) { Cordova.addResource("file"); /** * This class provides some useful information about a file. * @constructor */ var FileProperties = function(filePath) { this.filePath = filePath; this.size = 0; this.lastModifiedDate = null; }; /** * Represents a single file. * * @constructor * @param name {DOMString} name of the file, without path information * @param fullPath {DOMString} the full path of the file, including the name * @param type {DOMString} mime type * @param lastModifiedDate {Date} last modified date * @param size {Number} size of the file in bytes */ var File = function(name, fullPath, type, lastModifiedDate, size) { this.name = name || null; this.fullPath = fullPath || null; this.type = type || null; this.lastModifiedDate = lastModifiedDate || null; this.size = size || 0; }; /** @constructor */ var FileError = function() { this.code = null; }; // File error codes // Found in DOMException FileError.NOT_FOUND_ERR = 1; FileError.SECURITY_ERR = 2; FileError.ABORT_ERR = 3; // Added by this specification FileError.NOT_READABLE_ERR = 4; FileError.ENCODING_ERR = 5; FileError.NO_MODIFICATION_ALLOWED_ERR = 6; FileError.INVALID_STATE_ERR = 7; FileError.SYNTAX_ERR = 8; FileError.INVALID_MODIFICATION_ERR = 9; FileError.QUOTA_EXCEEDED_ERR = 10; FileError.TYPE_MISMATCH_ERR = 11; FileError.PATH_EXISTS_ERR = 12; //----------------------------------------------------------------------------- // File Reader //----------------------------------------------------------------------------- /** * This class reads the mobile device file system. * * For Android: * The root directory is the root of the file system. * To read from the SD card, the file name is "sdcard/my_file.txt" * @constructor */ var FileReader = function() { this.fileName = ""; this.readyState = 0; // File data this.result = null; // Error this.error = null; // Event handlers this.onloadstart = null; // When the read starts. this.onprogress = null; // While reading (and decoding) file or fileBlob data, and reporting partial file data (progess.loaded/progress.total) this.onload = null; // When the read has successfully completed. this.onerror = null; // When the read has failed (see errors). this.onloadend = null; // When the request has completed (either in success or failure). this.onabort = null; // When the read has been aborted. For instance, by invoking the abort() method. }; // States FileReader.EMPTY = 0; FileReader.LOADING = 1; FileReader.DONE = 2; /** * Abort reading file. */ FileReader.prototype.abort = function() { var evt; this.readyState = FileReader.DONE; this.result = null; // set error var error = new FileError(); error.code = error.ABORT_ERR; this.error = error; // If error callback if (typeof this.onerror === "function") { this.onerror({"type":"error", "target":this}); } // If abort callback if (typeof this.onabort === "function") { this.onabort({"type":"abort", "target":this}); } // If load end callback if (typeof this.onloadend === "function") { this.onloadend({"type":"loadend", "target":this}); } }; /** * Read text file. * * @param file {File} File object containing file properties * @param encoding [Optional] (see http://www.iana.org/assignments/character-sets) */ FileReader.prototype.readAsText = function(file, encoding) { this.fileName = ""; if (typeof file.fullPath === "undefined") { this.fileName = file; } else { this.fileName = file.fullPath; } // LOADING state this.readyState = FileReader.LOADING; // If loadstart callback if (typeof this.onloadstart === "function") { this.onloadstart({"type":"loadstart", "target":this}); } // Default encoding is UTF-8 var enc = encoding ? encoding : "UTF-8"; var me = this; // Read file Cordova.exec( // Success callback function(r) { var evt; // If DONE (cancelled), then don't do anything if (me.readyState === FileReader.DONE) { return; } // Save result me.result = r; // If onload callback if (typeof me.onload === "function") { me.onload({"type":"load", "target":me}); } // DONE state me.readyState = FileReader.DONE; // If onloadend callback if (typeof me.onloadend === "function") { me.onloadend({"type":"loadend", "target":me}); } }, // Error callback function(e) { var evt; // If DONE (cancelled), then don't do anything if (me.readyState === FileReader.DONE) { return; } // Save error me.error = e; // If onerror callback if (typeof me.onerror === "function") { me.onerror({"type":"error", "target":me}); } // DONE state me.readyState = FileReader.DONE; // If onloadend callback if (typeof me.onloadend === "function") { me.onloadend({"type":"loadend", "target":me}); } }, "File", "readAsText", [this.fileName, enc]); }; /** * Read file and return data as a base64 encoded data url. * A data url is of the form: * data:[][;base64], * * @param file {File} File object containing file properties */ FileReader.prototype.readAsDataURL = function(file) { this.fileName = ""; if (typeof file.fullPath === "undefined") { this.fileName = file; } else { this.fileName = file.fullPath; } // LOADING state this.readyState = FileReader.LOADING; // If loadstart callback if (typeof this.onloadstart === "function") { this.onloadstart({"type":"loadstart", "target":this}); } var me = this; // Read file Cordova.exec( // Success callback function(r) { var evt; // If DONE (cancelled), then don't do anything if (me.readyState === FileReader.DONE) { return; } // Save result me.result = r; // If onload callback if (typeof me.onload === "function") { me.onload({"type":"load", "target":me}); } // DONE state me.readyState = FileReader.DONE; // If onloadend callback if (typeof me.onloadend === "function") { me.onloadend({"type":"loadend", "target":me}); } }, // Error callback function(e) { var evt; // If DONE (cancelled), then don't do anything if (me.readyState === FileReader.DONE) { return; } // Save error me.error = e; // If onerror callback if (typeof me.onerror === "function") { me.onerror({"type":"error", "target":me}); } // DONE state me.readyState = FileReader.DONE; // If onloadend callback if (typeof me.onloadend === "function") { me.onloadend({"type":"loadend", "target":me}); } }, "File", "readAsDataURL", [this.fileName]); }; /** * Read file and return data as a binary data. * * @param file {File} File object containing file properties */ FileReader.prototype.readAsBinaryString = function(file) { // TODO - Can't return binary data to browser. this.fileName = file; }; /** * Read file and return data as a binary data. * * @param file {File} File object containing file properties */ FileReader.prototype.readAsArrayBuffer = function(file) { // TODO - Can't return binary data to browser. this.fileName = file; }; //----------------------------------------------------------------------------- // File Writer //----------------------------------------------------------------------------- /** * This class writes to the mobile device file system. * * For Android: * The root directory is the root of the file system. * To write to the SD card, the file name is "sdcard/my_file.txt" * * @constructor * @param file {File} File object containing file properties * @param append if true write to the end of the file, otherwise overwrite the file */ var FileWriter = function(file) { this.fileName = ""; this.length = 0; if (file) { this.fileName = file.fullPath || file; this.length = file.size || 0; } // default is to write at the beginning of the file this.position = 0; this.readyState = 0; // EMPTY this.result = null; // Error this.error = null; // Event handlers this.onwritestart = null; // When writing starts this.onprogress = null; // While writing the file, and reporting partial file data this.onwrite = null; // When the write has successfully completed. this.onwriteend = null; // When the request has completed (either in success or failure). this.onabort = null; // When the write has been aborted. For instance, by invoking the abort() method. this.onerror = null; // When the write has failed (see errors). }; // States FileWriter.INIT = 0; FileWriter.WRITING = 1; FileWriter.DONE = 2; /** * Abort writing file. */ FileWriter.prototype.abort = function() { // check for invalid state if (this.readyState === FileWriter.DONE || this.readyState === FileWriter.INIT) { throw FileError.INVALID_STATE_ERR; } // set error var error = new FileError(), evt; error.code = error.ABORT_ERR; this.error = error; // If error callback if (typeof this.onerror === "function") { this.onerror({"type":"error", "target":this}); } // If abort callback if (typeof this.onabort === "function") { this.onabort({"type":"abort", "target":this}); } this.readyState = FileWriter.DONE; // If write end callback if (typeof this.onwriteend === "function") { this.onwriteend({"type":"writeend", "target":this}); } }; /** * Writes data to the file * * @param text to be written */ FileWriter.prototype.write = function(text) { // Throw an exception if we are already writing a file if (this.readyState === FileWriter.WRITING) { throw FileError.INVALID_STATE_ERR; } // WRITING state this.readyState = FileWriter.WRITING; var me = this; // If onwritestart callback if (typeof me.onwritestart === "function") { me.onwritestart({"type":"writestart", "target":me}); } // Write file Cordova.exec( // Success callback function(r) { var evt; // If DONE (cancelled), then don't do anything if (me.readyState === FileWriter.DONE) { return; } // position always increases by bytes written because file would be extended me.position += r; // The length of the file is now where we are done writing. me.length = me.position; // If onwrite callback if (typeof me.onwrite === "function") { me.onwrite({"type":"write", "target":me}); } // DONE state me.readyState = FileWriter.DONE; // If onwriteend callback if (typeof me.onwriteend === "function") { me.onwriteend({"type":"writeend", "target":me}); } }, // Error callback function(e) { var evt; // If DONE (cancelled), then don't do anything if (me.readyState === FileWriter.DONE) { return; } // Save error me.error = e; // If onerror callback if (typeof me.onerror === "function") { me.onerror({"type":"error", "target":me}); } // DONE state me.readyState = FileWriter.DONE; // If onwriteend callback if (typeof me.onwriteend === "function") { me.onwriteend({"type":"writeend", "target":me}); } }, "File", "write", [this.fileName, text, this.position]); }; /** * Moves the file pointer to the location specified. * * If the offset is a negative number the position of the file * pointer is rewound. If the offset is greater than the file * size the position is set to the end of the file. * * @param offset is the location to move the file pointer to. */ FileWriter.prototype.seek = function(offset) { // Throw an exception if we are already writing a file if (this.readyState === FileWriter.WRITING) { throw FileError.INVALID_STATE_ERR; } if (!offset) { return; } // See back from end of file. if (offset < 0) { this.position = Math.max(offset + this.length, 0); } // Offset is bigger then file size so set position // to the end of the file. else if (offset > this.length) { this.position = this.length; } // Offset is between 0 and file size so set the position // to start writing. else { this.position = offset; } }; /** * Truncates the file to the size specified. * * @param size to chop the file at. */ FileWriter.prototype.truncate = function(size) { // Throw an exception if we are already writing a file if (this.readyState === FileWriter.WRITING) { throw FileError.INVALID_STATE_ERR; } // WRITING state this.readyState = FileWriter.WRITING; var me = this; // If onwritestart callback if (typeof me.onwritestart === "function") { me.onwritestart({"type":"writestart", "target":this}); } // Write file Cordova.exec( // Success callback function(r) { var evt; // If DONE (cancelled), then don't do anything if (me.readyState === FileWriter.DONE) { return; } // Update the length of the file me.length = r; me.position = Math.min(me.position, r); // If onwrite callback if (typeof me.onwrite === "function") { me.onwrite({"type":"write", "target":me}); } // DONE state me.readyState = FileWriter.DONE; // If onwriteend callback if (typeof me.onwriteend === "function") { me.onwriteend({"type":"writeend", "target":me}); } }, // Error callback function(e) { var evt; // If DONE (cancelled), then don't do anything if (me.readyState === FileWriter.DONE) { return; } // Save error me.error = e; // If onerror callback if (typeof me.onerror === "function") { me.onerror({"type":"error", "target":me}); } // DONE state me.readyState = FileWriter.DONE; // If onwriteend callback if (typeof me.onwriteend === "function") { me.onwriteend({"type":"writeend", "target":me}); } }, "File", "truncate", [this.fileName, size]); }; /** * Information about the state of the file or directory * * @constructor * {Date} modificationTime (readonly) */ var Metadata = function() { this.modificationTime=null; }; /** * Supplies arguments to methods that lookup or create files and directories * * @constructor * @param {boolean} create file or directory if it doesn't exist * @param {boolean} exclusive if true the command will fail if the file or directory exists */ var Flags = function(create, exclusive) { this.create = create || false; this.exclusive = exclusive || false; }; /** * An interface representing a file system * * @constructor * {DOMString} name the unique name of the file system (readonly) * {DirectoryEntry} root directory of the file system (readonly) */ var FileSystem = function() { this.name = null; this.root = null; }; /** * An interface that lists the files and directories in a directory. * @constructor */ var DirectoryReader = function(fullPath){ this.fullPath = fullPath || null; }; /** * Returns a list of entries from a directory. * * @param {Function} successCallback is called with a list of entries * @param {Function} errorCallback is called with a FileError */ DirectoryReader.prototype.readEntries = function(successCallback, errorCallback) { var win = function(result) { var retVal = []; for (var i=0; i 3) { if (typeof errorCallback === "function") { errorCallback({ "code": FileError.SYNTAX_ERR }); } } else { var win = function(result){ console.log("in win of requestFileSystem"); console.log("Result: " + JSON.stringify(result)); var entry = null; entry = new DirectoryEntry(); entry.isDirectory = result.root.isDirectory; entry.isFile = result.root.isFile; entry.name = result.root.name; entry.fullPath = result.root.fullPath; result.root = entry; successCallback(result); }; console.log("about to call requestFileSystem"); Cordova.exec(win, errorCallback, "File", "requestFileSystem", [type, size]); } }; /** * * @param {DOMString} uri referring to a local file in a filesystem * @param {Function} successCallback is called with the new entry * @param {Function} errorCallback is called with a FileError */ LocalFileSystem.prototype.resolveLocalFileSystemURI = function(uri, successCallback, errorCallback) { var win = function(result) { console.log("in win of resolveLocalFileSystemURI"); console.log("Result: " + JSON.stringify(result)); var entry = null; if (result.isDirectory) { entry = new DirectoryEntry(); } else if (result.isFile) { entry = new FileEntry(); } entry.isDirectory = result.isDirectory; entry.isFile = result.isFile; entry.name = result.name; entry.fullPath = result.fullPath; successCallback(entry); }; console.log("about to call resolveLocalFileSystemURI"); Cordova.exec(win, errorCallback, "File", "resolveLocalFileSystemURI", [uri]); }; /** * Add the FileSystem interface into the browser. */ Cordova.addConstructor(function() { var pgLocalFileSystem = new LocalFileSystem(); // Needed for cast methods if (typeof window.localFileSystem === "undefined") { window.localFileSystem = pgLocalFileSystem; } if (typeof window.requestFileSystem === "undefined") { window.requestFileSystem = pgLocalFileSystem.requestFileSystem; } if (typeof window.resolveLocalFileSystemURI === "undefined") { window.resolveLocalFileSystemURI = pgLocalFileSystem.resolveLocalFileSystemURI; } }); }