/*
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.
*/
package org.apache.cordova.file;
import android.app.Activity;
import android.content.Context;
import android.net.Uri;
import android.os.Environment;
import android.util.Base64;
import android.util.Log;
import org.apache.cordova.CallbackContext;
import org.apache.cordova.CordovaInterface;
import org.apache.cordova.CordovaPlugin;
import org.apache.cordova.CordovaWebView;
import org.apache.cordova.PluginResult;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URLDecoder;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
/**
* This class provides file and directory services to JavaScript.
*/
public class FileUtils extends CordovaPlugin {
private static final String LOG_TAG = "FileUtils";
public static int NOT_FOUND_ERR = 1;
public static int SECURITY_ERR = 2;
public static int ABORT_ERR = 3;
public static int NOT_READABLE_ERR = 4;
public static int ENCODING_ERR = 5;
public static int NO_MODIFICATION_ALLOWED_ERR = 6;
public static int INVALID_STATE_ERR = 7;
public static int SYNTAX_ERR = 8;
public static int INVALID_MODIFICATION_ERR = 9;
public static int QUOTA_EXCEEDED_ERR = 10;
public static int TYPE_MISMATCH_ERR = 11;
public static int PATH_EXISTS_ERR = 12;
public static int UNKNOWN_ERR = 1000;
private boolean configured = false;
// This field exists only to support getEntry, below, which has been deprecated
private static FileUtils filePlugin;
private interface FileOp {
void run( ) throws Exception;
}
private ArrayList<Filesystem> filesystems;
public void registerFilesystem(Filesystem fs) {
if (fs != null && filesystemForName(fs.name)== null) {
this.filesystems.add(fs);
}
}
private Filesystem filesystemForName(String name) {
for (Filesystem fs:filesystems) {
if (fs != null && fs.name != null && fs.name.equals(name)) {
return fs;
}
}
return null;
}
protected String[] getExtraFileSystemsPreference(Activity activity) {
String fileSystemsStr = activity.getIntent().getStringExtra("androidextrafilesystems");
if (fileSystemsStr == null) {
fileSystemsStr = "files,files-external,documents,sdcard,cache,cache-external,root";
}
return fileSystemsStr.split(",");
}
protected void registerExtraFileSystems(String[] filesystems, HashMap<String, String> availableFileSystems) {
HashSet<String> installedFileSystems = new HashSet<String>();
/* Register filesystems in order */
for (String fsName : filesystems) {
if (!installedFileSystems.contains(fsName)) {
String fsRoot = availableFileSystems.get(fsName);
if (fsRoot != null) {
File newRoot = new File(fsRoot);
if (newRoot.mkdirs() || newRoot.isDirectory()) {
registerFilesystem(new LocalFilesystem(fsName, cordova, fsRoot));
installedFileSystems.add(fsName);
} else {
Log.d(LOG_TAG, "Unable to create root dir for fileystem \"" + fsName + "\", skipping");
}
} else {
Log.d(LOG_TAG, "Unrecognized extra filesystem identifier: " + fsName);
}
}
}
}
protected HashMap<String, String> getAvailableFileSystems(Activity activity) {
Context context = activity.getApplicationContext();
HashMap<String, String> availableFileSystems = new HashMap<String,String>();
availableFileSystems.put("files", context.getFilesDir().getAbsolutePath());
availableFileSystems.put("files-external", context.getExternalFilesDir(null).getAbsolutePath());
availableFileSystems.put("documents", new File(context.getFilesDir(), "Documents").getAbsolutePath());
availableFileSystems.put("sdcard", Environment.getExternalStorageDirectory().getAbsolutePath());
availableFileSystems.put("cache", context.getCacheDir().getAbsolutePath());
availableFileSystems.put("cache-external", context.getExternalCacheDir().getAbsolutePath());
availableFileSystems.put("root", "/");
return availableFileSystems;
}
@Override
public void initialize(CordovaInterface cordova, CordovaWebView webView) {
super.initialize(cordova, webView);
this.filesystems = new ArrayList<Filesystem>();
String tempRoot = null;
String persistentRoot = null;
Activity activity = cordova.getActivity();
String packageName = activity.getPackageName();
String location = activity.getIntent().getStringExtra("androidpersistentfilelocation");
if (location == null) {
location = "compatibility";
}
tempRoot = activity.getCacheDir().getAbsolutePath();
if ("internal".equalsIgnoreCase(location)) {
persistentRoot = activity.getFilesDir().getAbsolutePath() + "/files/";
this.configured = true;
} else if ("compatibility".equalsIgnoreCase(location)) {
/*
* Fall-back to compatibility mode -- this is the logic implemented in
* earlier versions of this plugin, and should be maintained here so
* that apps which were originally deployed with older versions of the
* plugin can continue to provide access to files stored under those
* versions.
*/
if (Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)) {
persistentRoot = Environment.getExternalStorageDirectory().getAbsolutePath();
tempRoot = Environment.getExternalStorageDirectory().getAbsolutePath() +
"/Android/data/" + packageName + "/cache/";
} else {
persistentRoot = "/data/data/" + packageName;
}
this.configured = true;
}
if (this.configured) {
// Create the directories if they don't exist.
new File(tempRoot).mkdirs();
new File(persistentRoot).mkdirs();
// Register initial filesystems
// Note: The temporary and persistent filesystems need to be the first two
// registered, so that they will match window.TEMPORARY and window.PERSISTENT,
// per spec.
this.registerFilesystem(new LocalFilesystem("temporary", cordova, tempRoot));
this.registerFilesystem(new LocalFilesystem("persistent", cordova, persistentRoot));
this.registerFilesystem(new ContentFilesystem("content", cordova, webView));
registerExtraFileSystems(getExtraFileSystemsPreference(activity), getAvailableFileSystems(activity));
// Initialize static plugin reference for deprecated getEntry method
if (filePlugin == null) {
FileUtils.filePlugin = this;
}
} else {
Log.e(LOG_TAG, "File plugin configuration error: Please set AndroidPersistentFileLocation in config.xml to one of \"internal\" (for new applications) or \"compatibility\" (for compatibility with previous versions)");
activity.finish();
}
}
public static FileUtils getFilePlugin() {
return filePlugin;
}
private Filesystem filesystemForURL(LocalFilesystemURL localURL) {
if (localURL == null) return null;
return filesystemForName(localURL.filesystemName);
}
@Override
public Uri remapUri(Uri uri) {
try {
LocalFilesystemURL inputURL = new LocalFilesystemURL(uri);
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
return null;
}
String path = fs.filesystemPathForURL(inputURL);
if (path != null) {
return Uri.parse("file:///" + fs.filesystemPathForURL(inputURL));
}
return null;
} catch (IllegalArgumentException e) {
return null;
}
}
/**
* Executes the request and returns whether the action was valid.
*
* @param action The action to execute.
* @param args JSONArray of arguments for the plugin.
* @param callbackContext The callback context used when calling back into JavaScript.
* @return True if the action was valid, false otherwise.
*/
public boolean execute(String action, final JSONArray args, final CallbackContext callbackContext) throws JSONException {
if (!configured) {
callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.ERROR, "File plugin is not configured. Please see the README.md file for details on how to update config.xml"));
return true;
}
if (action.equals("testSaveLocationExists")) {
threadhelper( new FileOp( ){
public void run() {
boolean b = DirectoryManager.testSaveLocationExists();
callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.OK, b));
}
},callbackContext);
}
else if (action.equals("getFreeDiskSpace")) {
threadhelper( new FileOp( ){
public void run() {
long l = DirectoryManager.getFreeDiskSpace(false);
callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.OK, l));
}
},callbackContext);
}
else if (action.equals("testFileExists")) {
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() {
boolean b = DirectoryManager.testFileExists(fname);
callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.OK, b));
}
}, callbackContext);
}
else if (action.equals("testDirectoryExists")) {
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() {
boolean b = DirectoryManager.testFileExists(fname);
callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.OK, b));
}
}, callbackContext);
}
else if (action.equals("readAsText")) {
final String encoding = args.getString(1);
final int start = args.getInt(2);
final int end = args.getInt(3);
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() throws MalformedURLException {
readFileAs(fname, start, end, callbackContext, encoding, PluginResult.MESSAGE_TYPE_STRING);
}
}, callbackContext);
}
else if (action.equals("readAsDataURL")) {
final int start = args.getInt(1);
final int end = args.getInt(2);
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() throws MalformedURLException {
readFileAs(fname, start, end, callbackContext, null, -1);
}
}, callbackContext);
}
else if (action.equals("readAsArrayBuffer")) {
final int start = args.getInt(1);
final int end = args.getInt(2);
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() throws MalformedURLException {
readFileAs(fname, start, end, callbackContext, null, PluginResult.MESSAGE_TYPE_ARRAYBUFFER);
}
},callbackContext);
}
else if (action.equals("readAsBinaryString")) {
final int start = args.getInt(1);
final int end = args.getInt(2);
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() throws MalformedURLException {
readFileAs(fname, start, end, callbackContext, null, PluginResult.MESSAGE_TYPE_BINARYSTRING);
}
}, callbackContext);
}
else if (action.equals("write")) {
final String fname=args.getString(0);
final String data=args.getString(1);
final int offset=args.getInt(2);
final Boolean isBinary=args.getBoolean(3);
threadhelper( new FileOp( ){
public void run() throws FileNotFoundException, IOException, NoModificationAllowedException {
long fileSize = write(fname, data, offset, isBinary);
callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.OK, fileSize));
}
}, callbackContext);
}
else if (action.equals("truncate")) {
final String fname=args.getString(0);
final int offset=args.getInt(1);
threadhelper( new FileOp( ){
public void run( ) throws FileNotFoundException, IOException, NoModificationAllowedException {
long fileSize = truncateFile(fname, offset);
callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.OK, fileSize));
}
}, callbackContext);
}
else if (action.equals("requestFileSystem")) {
final int fstype=args.getInt(0);
final long size = args.optLong(1);
threadhelper( new FileOp( ){
public void run() throws IOException, JSONException {
if (size != 0 && size > (DirectoryManager.getFreeDiskSpace(true) * 1024)) {
callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.ERROR, FileUtils.QUOTA_EXCEEDED_ERR));
} else {
JSONObject obj = requestFileSystem(fstype);
callbackContext.success(obj);
}
}
}, callbackContext);
}
else if (action.equals("resolveLocalFileSystemURI")) {
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() throws IOException, JSONException {
JSONObject obj = resolveLocalFileSystemURI(fname);
callbackContext.success(obj);
}
},callbackContext);
}
else if (action.equals("getMetadata") || action.equals("getFileMetadata")) {
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() throws FileNotFoundException, JSONException, MalformedURLException {
JSONObject obj = getFileMetadata(fname);
callbackContext.success(obj);
}
}, callbackContext);
}
else if (action.equals("getParent")) {
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() throws JSONException, IOException {
JSONObject obj = getParent(fname);
callbackContext.success(obj);
}
},callbackContext);
}
else if (action.equals("getDirectory")) {
final String dirname=args.getString(0);
final String path=args.getString(1);
threadhelper( new FileOp( ){
public void run() throws FileExistsException, IOException, TypeMismatchException, EncodingException, JSONException {
JSONObject obj = getFile(dirname, path, args.optJSONObject(2), true);
callbackContext.success(obj);
}
},callbackContext);
}
else if (action.equals("getFile")) {
final String dirname=args.getString(0);
final String path=args.getString(1);
threadhelper( new FileOp( ){
public void run() throws FileExistsException, IOException, TypeMismatchException, EncodingException, JSONException {
JSONObject obj = getFile(dirname, path, args.optJSONObject(2), false);
callbackContext.success(obj);
}
},callbackContext);
}
else if (action.equals("remove")) {
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() throws NoModificationAllowedException, InvalidModificationException, MalformedURLException {
boolean success = remove(fname);
if (success) {
callbackContext.success();
} else {
callbackContext.error(FileUtils.NO_MODIFICATION_ALLOWED_ERR);
}
}
},callbackContext);
}
else if (action.equals("removeRecursively")) {
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() throws FileExistsException, MalformedURLException, NoModificationAllowedException {
boolean success = removeRecursively(fname);
if (success) {
callbackContext.success();
} else {
callbackContext.error(FileUtils.NO_MODIFICATION_ALLOWED_ERR);
}
}
},callbackContext);
}
else if (action.equals("moveTo")) {
final String fname=args.getString(0);
final String newParent=args.getString(1);
final String newName=args.getString(2);
threadhelper( new FileOp( ){
public void run() throws JSONException, NoModificationAllowedException, IOException, InvalidModificationException, EncodingException, FileExistsException {
JSONObject entry = transferTo(fname, newParent, newName, true);
callbackContext.success(entry);
}
},callbackContext);
}
else if (action.equals("copyTo")) {
final String fname=args.getString(0);
final String newParent=args.getString(1);
final String newName=args.getString(2);
threadhelper( new FileOp( ){
public void run() throws JSONException, NoModificationAllowedException, IOException, InvalidModificationException, EncodingException, FileExistsException {
JSONObject entry = transferTo(fname, newParent, newName, false);
callbackContext.success(entry);
}
},callbackContext);
}
else if (action.equals("readEntries")) {
final String fname=args.getString(0);
threadhelper( new FileOp( ){
public void run() throws FileNotFoundException, JSONException, MalformedURLException {
JSONArray entries = readEntries(fname);
callbackContext.success(entries);
}
},callbackContext);
}
else if (action.equals("_getLocalFilesystemPath")) {
// Internal method for testing: Get the on-disk location of a local filesystem url.
// [Currently used for testing file-transfer]
final String localURLstr = args.getString(0);
threadhelper( new FileOp( ){
public void run() throws FileNotFoundException, JSONException, MalformedURLException {
String fname = filesystemPathForURL(localURLstr);
callbackContext.success(fname);
}
},callbackContext);
}
else {
return false;
}
return true;
}
/*
* These two native-only methods can be used by other plugins to translate between
* device file system paths and URLs. By design, there is no direct JavaScript
* interface to these methods.
*/
public String filesystemPathForURL(String localURLstr) throws MalformedURLException {
try {
LocalFilesystemURL inputURL = new LocalFilesystemURL(localURLstr);
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
throw new MalformedURLException("No installed handlers for this URL");
}
return fs.filesystemPathForURL(inputURL);
} catch (IllegalArgumentException e) {
throw new MalformedURLException("Unrecognized filesystem URL");
}
}
public LocalFilesystemURL filesystemURLforLocalPath(String localPath) {
LocalFilesystemURL localURL = null;
int shortestFullPath = 0;
// Try all installed filesystems. Return the best matching URL
// (determined by the shortest resulting URL)
for (Filesystem fs: filesystems) {
if (fs != null) {
LocalFilesystemURL url = fs.URLforFilesystemPath(localPath);
if (url != null) {
// A shorter fullPath implies that the filesystem is a better
// match for the local path than the previous best.
if (localURL == null || (url.fullPath.length() < shortestFullPath)) {
localURL = url;
shortestFullPath = url.fullPath.length();
}
}
}
}
return localURL;
}
/* helper to execute functions async and handle the result codes
*
*/
private void threadhelper(final FileOp f, final CallbackContext callbackContext){
cordova.getThreadPool().execute(new Runnable() {
public void run() {
try {
f.run();
} catch ( Exception e) {
e.printStackTrace();
if( e instanceof EncodingException){
callbackContext.error(FileUtils.ENCODING_ERR);
} else if(e instanceof FileNotFoundException) {
callbackContext.error(FileUtils.NOT_FOUND_ERR);
} else if(e instanceof FileExistsException) {
callbackContext.error(FileUtils.PATH_EXISTS_ERR);
} else if(e instanceof NoModificationAllowedException ) {
callbackContext.error(FileUtils.NO_MODIFICATION_ALLOWED_ERR);
} else if(e instanceof InvalidModificationException ) {
callbackContext.error(FileUtils.INVALID_MODIFICATION_ERR);
} else if(e instanceof MalformedURLException ) {
callbackContext.error(FileUtils.ENCODING_ERR);
} else if(e instanceof IOException ) {
callbackContext.error(FileUtils.INVALID_MODIFICATION_ERR);
} else if(e instanceof EncodingException ) {
callbackContext.error(FileUtils.ENCODING_ERR);
} else if(e instanceof TypeMismatchException ) {
callbackContext.error(FileUtils.TYPE_MISMATCH_ERR);
} else {
callbackContext.error(FileUtils.UNKNOWN_ERR);
}
}
}
});
}
/**
* Allows the user to look up the Entry for a file or directory referred to by a local URI.
*
* @param url of the file/directory to look up
* @return a JSONObject representing a Entry from the filesystem
* @throws MalformedURLException if the url is not valid
* @throws FileNotFoundException if the file does not exist
* @throws IOException if the user can't read the file
* @throws JSONException
*/
private JSONObject resolveLocalFileSystemURI(String url) throws IOException, JSONException {
LocalFilesystemURL inputURL;
if (url == null) {
throw new MalformedURLException("Unrecognized filesystem URL");
}
/* Backwards-compatibility: Check for file:// urls */
if (url.startsWith("file:/")) {
if (!url.startsWith("file://")) {
url = "file:///" + url.substring(6);
}
String decoded = URLDecoder.decode(url, "UTF-8");
/* This looks like a file url. Get the path, and see if any handlers recognize it. */
String path;
int questionMark = decoded.indexOf("?");
int pathEnd;
if (questionMark < 0) {
pathEnd = decoded.length();
} else {
pathEnd = questionMark;
}
int thirdSlash = decoded.indexOf("/", 7);
if (thirdSlash < 0 || thirdSlash > pathEnd) {
path = "";
} else {
path = decoded.substring(thirdSlash, pathEnd);
}
inputURL = this.filesystemURLforLocalPath(path);
} else {
inputURL = new LocalFilesystemURL(url);
}
try {
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
throw new MalformedURLException("No installed handlers for this URL");
}
return fs.getEntryForLocalURL(inputURL);
} catch (IllegalArgumentException e) {
throw new MalformedURLException("Unrecognized filesystem URL");
}
}
/**
* Read the list of files from this directory.
*
* @param fileName the directory to read from
* @return a JSONArray containing JSONObjects that represent Entry objects.
* @throws FileNotFoundException if the directory is not found.
* @throws JSONException
* @throws MalformedURLException
*/
private JSONArray readEntries(String baseURLstr) throws FileNotFoundException, JSONException, MalformedURLException {
try {
LocalFilesystemURL inputURL = new LocalFilesystemURL(baseURLstr);
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
throw new MalformedURLException("No installed handlers for this URL");
}
return fs.readEntriesAtLocalURL(inputURL);
} catch (IllegalArgumentException e) {
throw new MalformedURLException("Unrecognized filesystem URL");
}
}
/**
* A setup method that handles the move/copy of files/directories
*
* @param fileName to be copied/moved
* @param newParent is the location where the file will be copied/moved to
* @param newName for the file directory to be called, if null use existing file name
* @param move if false do a copy, if true do a move
* @return a Entry object
* @throws NoModificationAllowedException
* @throws IOException
* @throws InvalidModificationException
* @throws EncodingException
* @throws JSONException
* @throws FileExistsException
*/
private JSONObject transferTo(String srcURLstr, String destURLstr, String newName, boolean move) throws JSONException, NoModificationAllowedException, IOException, InvalidModificationException, EncodingException, FileExistsException {
if (srcURLstr == null || destURLstr == null) {
// either no source or no destination provided
throw new FileNotFoundException();
}
LocalFilesystemURL srcURL = new LocalFilesystemURL(srcURLstr);
LocalFilesystemURL destURL = new LocalFilesystemURL(destURLstr);
Filesystem srcFs = this.filesystemForURL(srcURL);
Filesystem destFs = this.filesystemForURL(destURL);
// Check for invalid file name
if (newName != null && newName.contains(":")) {
throw new EncodingException("Bad file name");
}
return destFs.copyFileToURL(destURL, newName, srcFs, srcURL, move);
}
/**
* Deletes a directory and all of its contents, if any. In the event of an error
* [e.g. trying to delete a directory that contains a file that cannot be removed],
* some of the contents of the directory may be deleted.
* It is an error to attempt to delete the root directory of a filesystem.
*
* @param filePath the directory to be removed
* @return a boolean representing success of failure
* @throws FileExistsException
* @throws NoModificationAllowedException
* @throws MalformedURLException
*/
private boolean removeRecursively(String baseURLstr) throws FileExistsException, NoModificationAllowedException, MalformedURLException {
try {
LocalFilesystemURL inputURL = new LocalFilesystemURL(baseURLstr);
// You can't delete the root directory.
if ("".equals(inputURL.fullPath) || "/".equals(inputURL.fullPath)) {
throw new NoModificationAllowedException("You can't delete the root directory");
}
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
throw new MalformedURLException("No installed handlers for this URL");
}
return fs.recursiveRemoveFileAtLocalURL(inputURL);
} catch (IllegalArgumentException e) {
throw new MalformedURLException("Unrecognized filesystem URL");
}
}
/**
* Deletes a file or directory. It is an error to attempt to delete a directory that is not empty.
* It is an error to attempt to delete the root directory of a filesystem.
*
* @param filePath file or directory to be removed
* @return a boolean representing success of failure
* @throws NoModificationAllowedException
* @throws InvalidModificationException
* @throws MalformedURLException
*/
private boolean remove(String baseURLstr) throws NoModificationAllowedException, InvalidModificationException, MalformedURLException {
try {
LocalFilesystemURL inputURL = new LocalFilesystemURL(baseURLstr);
// You can't delete the root directory.
if ("".equals(inputURL.fullPath) || "/".equals(inputURL.fullPath)) {
throw new NoModificationAllowedException("You can't delete the root directory");
}
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
throw new MalformedURLException("No installed handlers for this URL");
}
return fs.removeFileAtLocalURL(inputURL);
} catch (IllegalArgumentException e) {
throw new MalformedURLException("Unrecognized filesystem URL");
}
}
/**
* Creates or looks up a file.
*
* @param baseURLstr base directory
* @param path file/directory to lookup or create
* @param options specify whether to create or not
* @param directory if true look up directory, if false look up file
* @return a Entry object
* @throws FileExistsException
* @throws IOException
* @throws TypeMismatchException
* @throws EncodingException
* @throws JSONException
*/
private JSONObject getFile(String baseURLstr, String path, JSONObject options, boolean directory) throws FileExistsException, IOException, TypeMismatchException, EncodingException, JSONException {
try {
LocalFilesystemURL inputURL = new LocalFilesystemURL(baseURLstr);
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
throw new MalformedURLException("No installed handlers for this URL");
}
return fs.getFileForLocalURL(inputURL, path, options, directory);
} catch (IllegalArgumentException e) {
throw new MalformedURLException("Unrecognized filesystem URL");
}
}
/**
* Look up the parent DirectoryEntry containing this Entry.
* If this Entry is the root of its filesystem, its parent is itself.
*
* @param filePath
* @return
* @throws JSONException
* @throws IOException
*/
private JSONObject getParent(String baseURLstr) throws JSONException, IOException {
try {
LocalFilesystemURL inputURL = new LocalFilesystemURL(baseURLstr);
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
throw new MalformedURLException("No installed handlers for this URL");
}
return fs.getParentForLocalURL(inputURL);
} catch (IllegalArgumentException e) {
throw new MalformedURLException("Unrecognized filesystem URL");
}
}
/**
* Returns a File that represents the current state of the file that this FileEntry represents.
*
* @param filePath to entry
* @return returns a JSONObject represent a W3C File object
* @throws FileNotFoundException
* @throws JSONException
* @throws MalformedURLException
*/
private JSONObject getFileMetadata(String baseURLstr) throws FileNotFoundException, JSONException, MalformedURLException {
try {
LocalFilesystemURL inputURL = new LocalFilesystemURL(baseURLstr);
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
throw new MalformedURLException("No installed handlers for this URL");
}
return fs.getFileMetadataForLocalURL(inputURL);
} catch (IllegalArgumentException e) {
throw new MalformedURLException("Unrecognized filesystem URL");
}
}
/**
* Requests a filesystem in which to store application data.
*
* @param type of file system requested
* @return a JSONObject representing the file system
* @throws IOException
* @throws JSONException
*/
private JSONObject requestFileSystem(int type) throws IOException, JSONException {
JSONObject fs = new JSONObject();
Filesystem rootFs = null;
try {
rootFs = this.filesystems.get(type);
} catch (ArrayIndexOutOfBoundsException e) {
// Pass null through
}
if (rootFs == null) {
throw new IOException("No filesystem of type requested");
}
fs.put("name", rootFs.name);
fs.put("root", Filesystem.makeEntryForPath("/", rootFs.name, true));
return fs;
}
/**
* Returns a JSON object representing the given File. Internal APIs should be modified
* to use URLs instead of raw FS paths wherever possible, when interfacing with this plugin.
*
* @param file the File to convert
* @return a JSON representation of the given File
* @throws JSONException
*/
public JSONObject getEntryForFile(File file) throws JSONException {
JSONObject entry;
for (Filesystem fs : filesystems) {
entry = fs.makeEntryForFile(file);
if (entry != null) {
return entry;
}
}
return null;
}
/**
* Returns a JSON object representing the given File. Deprecated, as this is only used by
* FileTransfer, and because it is a static method that should really be an instance method,
* since it depends on the actual filesystem roots in use. Internal APIs should be modified
* to use URLs instead of raw FS paths wherever possible, when interfacing with this plugin.
*
* @param file the File to convert
* @return a JSON representation of the given File
* @throws JSONException
*/
@Deprecated
public static JSONObject getEntry(File file) throws JSONException {
if (getFilePlugin() != null) {
return getFilePlugin().getEntryForFile(file);
}
return null;
}
/**
* Read the contents of a file.
* This is done in a background thread; the result is sent to the callback.
*
* @param filename The name of the file.
* @param start Start position in the file.
* @param end End position to stop at (exclusive).
* @param callbackContext The context through which to send the result.
* @param encoding The encoding to return contents as. Typical value is UTF-8. (see http://www.iana.org/assignments/character-sets)
* @param resultType The desired type of data to send to the callback.
* @return Contents of file.
* @throws MalformedURLException
*/
public void readFileAs(final String srcURLstr, final int start, final int end, final CallbackContext callbackContext, final String encoding, final int resultType) throws MalformedURLException {
try {
LocalFilesystemURL inputURL = new LocalFilesystemURL(srcURLstr);
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
throw new MalformedURLException("No installed handlers for this URL");
}
fs.readFileAtURL(inputURL, start, end, new Filesystem.ReadFileCallback() {
public void handleData(InputStream inputStream, String contentType) {
try {
ByteArrayOutputStream os = new ByteArrayOutputStream();
final int BUFFER_SIZE = 8192;
byte[] buffer = new byte[BUFFER_SIZE];
for (;;) {
int bytesRead = inputStream.read(buffer, 0, BUFFER_SIZE);
if (bytesRead <= 0) {
break;
}
os.write(buffer, 0, bytesRead);
}
PluginResult result;
switch (resultType) {
case PluginResult.MESSAGE_TYPE_STRING:
result = new PluginResult(PluginResult.Status.OK, os.toString(encoding));
break;
case PluginResult.MESSAGE_TYPE_ARRAYBUFFER:
result = new PluginResult(PluginResult.Status.OK, os.toByteArray());
break;
case PluginResult.MESSAGE_TYPE_BINARYSTRING:
result = new PluginResult(PluginResult.Status.OK, os.toByteArray(), true);
break;
default: // Base64.
byte[] base64 = Base64.encode(os.toByteArray(), Base64.NO_WRAP);
String s = "data:" + contentType + ";base64," + new String(base64, "US-ASCII");
result = new PluginResult(PluginResult.Status.OK, s);
}
callbackContext.sendPluginResult(result);
} catch (IOException e) {
Log.d(LOG_TAG, e.getLocalizedMessage());
callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.IO_EXCEPTION, NOT_READABLE_ERR));
}
}
});
} catch (IllegalArgumentException e) {
throw new MalformedURLException("Unrecognized filesystem URL");
} catch (FileNotFoundException e) {
callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.IO_EXCEPTION, NOT_FOUND_ERR));
} catch (IOException e) {
Log.d(LOG_TAG, e.getLocalizedMessage());
callbackContext.sendPluginResult(new PluginResult(PluginResult.Status.IO_EXCEPTION, NOT_READABLE_ERR));
}
}
/**
* Write contents of file.
*
* @param filename The name of the file.
* @param data The contents of the file.
* @param offset The position to begin writing the file.
* @param isBinary True if the file contents are base64-encoded binary data
* @throws FileNotFoundException, IOException
* @throws NoModificationAllowedException
*/
/**/
public long write(String srcURLstr, String data, int offset, boolean isBinary) throws FileNotFoundException, IOException, NoModificationAllowedException {
try {
LocalFilesystemURL inputURL = new LocalFilesystemURL(srcURLstr);
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
throw new MalformedURLException("No installed handlers for this URL");
}
long x = fs.writeToFileAtURL(inputURL, data, offset, isBinary); Log.d("TEST",srcURLstr + ": "+x); return x;
} catch (IllegalArgumentException e) {
throw new MalformedURLException("Unrecognized filesystem URL");
}
}
/**
* Truncate the file to size
*
* @param filename
* @param size
* @throws FileNotFoundException, IOException
* @throws NoModificationAllowedException
*/
private long truncateFile(String srcURLstr, long size) throws FileNotFoundException, IOException, NoModificationAllowedException {
try {
LocalFilesystemURL inputURL = new LocalFilesystemURL(srcURLstr);
Filesystem fs = this.filesystemForURL(inputURL);
if (fs == null) {
throw new MalformedURLException("No installed handlers for this URL");
}
return fs.truncateFileAtURL(inputURL, size);
} catch (IllegalArgumentException e) {
throw new MalformedURLException("Unrecognized filesystem URL");
}
}
}