forked from themadrobot/appinventor-sources
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
File component to store and read files from external storage
Change-Id: I32e344983285f7d589cd6cec183366b56fc76a22
- Loading branch information
Showing
8 changed files
with
376 additions
and
3 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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
318 changes: 318 additions & 0 deletions
318
appinventor/components/src/com/google/appinventor/components/runtime/File.java
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,318 @@ | ||
| // -*- mode: java; c-basic-offset: 2; -*- | ||
| // Copyright 2009-2011 Google, All Rights reserved | ||
| // Copyright 2011-2014 MIT, All rights reserved | ||
| // Released under the MIT License https://raw.github.com/mit-cml/app-inventor/master/mitlicense.txt | ||
|
|
||
| package com.google.appinventor.components.runtime; | ||
|
|
||
| import com.google.appinventor.components.annotations.DesignerComponent; | ||
| import com.google.appinventor.components.annotations.DesignerProperty; | ||
| import com.google.appinventor.components.annotations.PropertyCategory; | ||
| import com.google.appinventor.components.annotations.SimpleEvent; | ||
| import com.google.appinventor.components.annotations.SimpleFunction; | ||
| import com.google.appinventor.components.annotations.SimpleObject; | ||
| import com.google.appinventor.components.annotations.SimpleProperty; | ||
| import com.google.appinventor.components.annotations.UsesPermissions; | ||
| import com.google.appinventor.components.common.ComponentCategory; | ||
| import com.google.appinventor.components.common.PropertyTypeConstants; | ||
| import com.google.appinventor.components.common.YaVersion; | ||
| import com.google.appinventor.components.runtime.util.AsynchUtil; | ||
| import com.google.appinventor.components.runtime.util.ErrorMessages; | ||
| import com.google.appinventor.components.runtime.util.FileUtil; | ||
| import com.google.appinventor.components.runtime.Form; | ||
| import com.google.appinventor.components.runtime.ReplForm; | ||
|
|
||
| import android.app.Activity; | ||
| import android.content.Context; | ||
| import android.os.Environment; | ||
| import android.util.Log; | ||
|
|
||
| import java.io.FileNotFoundException; | ||
| import java.io.FileOutputStream; | ||
| import java.io.FileInputStream; | ||
| import java.io.InputStream; | ||
| import java.io.InputStreamReader; | ||
| import java.io.IOException; | ||
| import java.io.OutputStreamWriter; | ||
| import java.io.StringWriter; | ||
|
|
||
| /** | ||
| * A Component for working with files and directories on the device. | ||
| * | ||
| */ | ||
| @DesignerComponent(version = YaVersion.FILE_COMPONENT_VERSION, | ||
| description = "Non-visible component for storing and retrieving files. Use this component to " + | ||
| "write or read files on your device. The default behaviour is to write files to the " + | ||
| "private data directory associated with your App. The Companion is special cased to write " + | ||
| "files to /sdcard/AppInventor/data to facilitate debugging. " + | ||
| "If the file path starts with a slash (/), then the file is created relative to /sdcard. " + | ||
| "For example writing a file to /myFile.txt will write the file in /sdcard/myFile.txt.", | ||
| category = ComponentCategory.STORAGE, | ||
| nonVisible = true, | ||
| iconName = "images/file.png") | ||
| @SimpleObject | ||
| @UsesPermissions(permissionNames = "android.permission.WRITE_EXTERNAL_STORAGE, android.permission.READ_EXTERNAL_STORAGE") | ||
| public class File extends AndroidNonvisibleComponent implements Component { | ||
| public static final String NO_ASSETS = "No_Assets"; | ||
| private final Activity activity; | ||
| private boolean isRepl = false; | ||
| private final int BUFFER_LENGTH = 4096; | ||
| private static final String LOG_TAG = "FileComponent"; | ||
|
|
||
| /** | ||
| * Creates a new File component. | ||
| * @param container the Form that this component is contained in. | ||
| */ | ||
| public File(ComponentContainer container) { | ||
| super(container.$form()); | ||
| if (form instanceof ReplForm) { // Note: form is defined in our superclass | ||
| isRepl = true; | ||
| } | ||
| activity = (Activity) container.$context(); | ||
| } | ||
|
|
||
| /** | ||
| * Stores the text to a specified file on the phone. | ||
| * Calls the Write function to write to the file asynchronously to prevent | ||
| * the UI from hanging when there is a large write. | ||
| * | ||
| * @param text the text to be stored | ||
| * @param fileName the file to which the text will be stored | ||
| */ | ||
| @SimpleFunction(description = "Saves text to a file. If the filename " + | ||
| "begins with a slash (/) the file is written to the sdcard. For example writing to " + | ||
| "/myFile.txt will write the file to /sdcard/myFile.txt. If the filename does not start " + | ||
| "with a slash, it will be written in the programs private data directory where it will " + | ||
| "not be accessible to other programs on the phone. There is a special exception for the " + | ||
| "AI Companion where these files are written to /sdcard/AppInventor/data to facilitate " + | ||
| "debugging. Note that this block will overwrite a file if it already exists." + | ||
| "\n\nIf you want to add content to a file use the append block.") | ||
| public void SaveFile(String text, String fileName) { | ||
| if (fileName.startsWith("/")) { | ||
| FileUtil.checkExternalStorageWriteable(); // Only check if writing to sdcard | ||
| } | ||
| Write(fileName, text, false); | ||
| } | ||
|
|
||
| /** | ||
| * Appends text to a specified file on the phone. | ||
| * Calls the Write function to write to the file asynchronously to prevent | ||
| * the UI from hanging when there is a large write. | ||
| * | ||
| * @param text the text to be stored | ||
| * @param fileName the file to which the text will be stored | ||
| */ | ||
| @SimpleFunction(description = "Appends text to the end of a file storage, creating the file if it does not exist. " + | ||
| "See the help text under SaveFile for information about where files are written.") | ||
| public void AppendToFile(String text, String fileName) { | ||
| if (fileName.startsWith("/")) { | ||
| FileUtil.checkExternalStorageWriteable(); // Only check if writing to sdcard | ||
| } | ||
| Write(fileName, text, true); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieve the text stored in a specified file. | ||
| * | ||
| * @param fileName the file from which the text is read | ||
| * @throws FileNotFoundException if the file cannot be found | ||
| * @throws IOException if the text cannot be read from the file | ||
| */ | ||
| @SimpleFunction(description = "Reads text from a file in storage. " + | ||
| "Prefix the filename with / to read from a specific file on the SD card. " + | ||
| "for instance /myFile.txt will read the file /sdcard/myFile.txt. To read " + | ||
| "assets packaged with an application (also works for the Companion) start " + | ||
| "the filename with // (two slashes). If a filename does not start with a " + | ||
| "slash, it will be read from the applications private storage (for packaged " + | ||
| "apps) and from /sdcard/AppInventor/data for the Companion.") | ||
| public void ReadFrom(final String fileName) { | ||
| try { | ||
| InputStream inputStream; | ||
| if (fileName.startsWith("//")) { | ||
| if (isRepl) { | ||
| inputStream = new FileInputStream(Environment.getExternalStorageDirectory().getPath() + | ||
| "/AppInventor/assets/" + fileName); | ||
| } else { | ||
| inputStream = form.getAssets().open(fileName.substring(2)); | ||
| } | ||
| } else { | ||
| String filepath = AbsoluteFileName(fileName); | ||
| Log.d(LOG_TAG, "filepath = " + filepath); | ||
| inputStream = new FileInputStream(filepath); | ||
| } | ||
|
|
||
| final InputStream asyncInputStream = inputStream; | ||
| AsynchUtil.runAsynchronously(new Runnable() { | ||
| @Override | ||
| public void run() { | ||
| AsyncRead(asyncInputStream, fileName); | ||
| } | ||
| }); | ||
| } catch (FileNotFoundException e) { | ||
| Log.e(LOG_TAG, "FileNotFoundException", e); | ||
| form.dispatchErrorOccurredEvent(File.this, "ReadFrom", | ||
| ErrorMessages.ERROR_CANNOT_FIND_FILE, fileName); | ||
| } catch (IOException e) { | ||
| Log.e(LOG_TAG, "IOException", e); | ||
| form.dispatchErrorOccurredEvent(File.this, "ReadFrom", | ||
| ErrorMessages.ERROR_CANNOT_FIND_FILE, fileName); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Delete the specified file. | ||
| * | ||
| * @param fileName the file to be deleted | ||
| */ | ||
| @SimpleFunction(description = "Deletes a file from storage. " + | ||
| "Prefix the filename with / to delete a specific file in the SD card, for instance /myFile.txt. " + | ||
| "will delete the file /sdcard/myFile.txt. If the file does not begin with a /, then the file " + | ||
| "located in the programs private storage will be deleted. Starting the file with // is an error " + | ||
| "because assets files cannot be deleted.") | ||
| public void Delete(String fileName) { | ||
| if (fileName.startsWith("//")) { | ||
| form.dispatchErrorOccurredEvent(File.this, "DeleteFile", | ||
| ErrorMessages.ERROR_CANNOT_DELETE_ASSET, fileName); | ||
| return; | ||
| } | ||
| String filepath = AbsoluteFileName(fileName); | ||
| java.io.File file = new java.io.File(filepath); | ||
| file.delete(); | ||
| } | ||
|
|
||
| /** | ||
| * Writes to the specified file. | ||
| * @param filename the file to write | ||
| * @param text to write to the file | ||
| * @param append determines whether text should be appended to the file, | ||
| * or overwrite the file | ||
| */ | ||
| private void Write(final String filename, final String text, final boolean append) { | ||
| if (filename.startsWith("//")) { | ||
| if (append) { | ||
| form.dispatchErrorOccurredEvent(File.this, "AppendTo", | ||
| ErrorMessages.ERROR_CANNOT_WRITE_ASSET, filename); | ||
| } else { | ||
| form.dispatchErrorOccurredEvent(File.this, "SaveFile", | ||
| ErrorMessages.ERROR_CANNOT_WRITE_ASSET, filename); | ||
| } | ||
| return; | ||
| } | ||
| AsynchUtil.runAsynchronously(new Runnable() { | ||
| @Override | ||
| public void run() { | ||
| final String filepath = AbsoluteFileName(filename); | ||
| final java.io.File file = new java.io.File(filepath); | ||
|
|
||
| if(!file.exists()){ | ||
| try { | ||
| file.createNewFile(); | ||
| } catch (IOException e) { | ||
| if (append) { | ||
| form.dispatchErrorOccurredEvent(File.this, "AppendTo", | ||
| ErrorMessages.ERROR_CANNOT_CREATE_FILE, filepath); | ||
| } else { | ||
| form.dispatchErrorOccurredEvent(File.this, "SaveFile", | ||
| ErrorMessages.ERROR_CANNOT_CREATE_FILE, filepath); | ||
| } | ||
| return; | ||
| } | ||
| } | ||
| try { | ||
| FileOutputStream fileWriter = new FileOutputStream(file, append); | ||
| OutputStreamWriter out = new OutputStreamWriter(fileWriter); | ||
| out.write(text); | ||
| out.flush(); | ||
| out.close(); | ||
| fileWriter.close(); | ||
| } catch (IOException e) { | ||
| if (append) { | ||
| form.dispatchErrorOccurredEvent(File.this, "AppendTo", | ||
| ErrorMessages.ERROR_CANNOT_WRITE_TO_FILE, filepath); | ||
| } else { | ||
| form.dispatchErrorOccurredEvent(File.this, "SaveFile", | ||
| ErrorMessages.ERROR_CANNOT_WRITE_TO_FILE, filepath); | ||
| } | ||
| } | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Asynchronously reads from the given file. Calls the main event thread | ||
| * when the function has completed reading from the file. | ||
| * @param filepath the file to read | ||
| * @throws FileNotFoundException | ||
| * @throws IOException when the system cannot read the file | ||
| */ | ||
| private void AsyncRead(InputStream fileInput, final String fileName) { | ||
| InputStreamReader input = null; | ||
| try { | ||
| input = new InputStreamReader(fileInput); | ||
| StringWriter output = new StringWriter(); | ||
| char [] buffer = new char[BUFFER_LENGTH]; | ||
| int offset = 0; | ||
| int length = 0; | ||
| while ((length = input.read(buffer, offset, BUFFER_LENGTH)) > 0) { | ||
| output.write(buffer, 0, length); | ||
| } | ||
| final String text = output.toString(); | ||
| activity.runOnUiThread(new Runnable() { | ||
| @Override | ||
| public void run() { | ||
| GotText(text); | ||
| } | ||
| }); | ||
| } catch (FileNotFoundException e) { | ||
| Log.e(LOG_TAG, "FileNotFoundException", e); | ||
| form.dispatchErrorOccurredEvent(File.this, "ReadFrom", | ||
| ErrorMessages.ERROR_CANNOT_FIND_FILE, fileName); | ||
| } catch (IOException e) { | ||
| Log.e(LOG_TAG, "IOException", e); | ||
| form.dispatchErrorOccurredEvent(File.this, "ReadFrom", | ||
| ErrorMessages.ERROR_CANNOT_READ_FILE, fileName); | ||
| } finally { | ||
| if (input != null) { | ||
| try { | ||
| input.close(); | ||
| } catch (IOException e) { | ||
| // do nothing... | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Event indicating that a request has finished. | ||
| * | ||
| * @param text read from the file | ||
| */ | ||
| @SimpleEvent (description = "Event indicating that the contents from the file have been read.") | ||
| public void GotText(String text) { | ||
| // invoke the application's "GotText" event handler. | ||
| EventDispatcher.dispatchEvent(this, "GotText", text); | ||
| } | ||
|
|
||
| /** | ||
| * Returns absolute file path. | ||
| * | ||
| * @param filename the file used to construct the file path | ||
| */ | ||
| private String AbsoluteFileName(String filename) { | ||
| if (filename.startsWith("/")) { | ||
| return Environment.getExternalStorageDirectory().getPath() + filename; | ||
| } else { | ||
| java.io.File dirPath = activity.getFilesDir(); | ||
| if (isRepl) { | ||
| String path = Environment.getExternalStorageDirectory().getPath() + "/AppInventor/data/"; | ||
| dirPath = new java.io.File(path); | ||
| if (!dirPath.exists()) { | ||
| dirPath.mkdirs(); // Make sure it exists | ||
| } | ||
| } | ||
| return dirPath.getPath() + "/" + filename; | ||
| } | ||
| } | ||
|
|
||
| } |
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
Oops, something went wrong.