From e56c963435040fff497d92798ebbf2b16d63403f Mon Sep 17 00:00:00 2001 From: YuutaW <17158086+Trumeet@users.noreply.github.com> Date: Thu, 18 Apr 2019 19:36:25 -0700 Subject: First Commit Signed-off-by: YuutaW <17158086+Trumeet@users.noreply.github.com> --- .gitignore | 9 + .travis.yml | 18 ++ README.md | 59 ++++ app/.gitignore | 1 + app/build.gradle | 29 ++ app/proguard-rules.pro | 21 ++ .../yuuta/ohmysafdemo/ExampleInstrumentedTest.java | 27 ++ app/src/main/AndroidManifest.xml | 23 ++ .../java/moe/yuuta/ohmysafdemo/MainActivity.java | 211 +++++++++++++ .../res/drawable-v24/ic_launcher_foreground.xml | 34 ++ .../main/res/drawable/ic_launcher_background.xml | 170 ++++++++++ app/src/main/res/layout/activity_main.xml | 37 +++ app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml | 5 + .../res/mipmap-anydpi-v26/ic_launcher_round.xml | 5 + app/src/main/res/mipmap-hdpi/ic_launcher.png | Bin 0 -> 2963 bytes app/src/main/res/mipmap-hdpi/ic_launcher_round.png | Bin 0 -> 4905 bytes app/src/main/res/mipmap-mdpi/ic_launcher.png | Bin 0 -> 2060 bytes app/src/main/res/mipmap-mdpi/ic_launcher_round.png | Bin 0 -> 2783 bytes app/src/main/res/mipmap-xhdpi/ic_launcher.png | Bin 0 -> 4490 bytes .../main/res/mipmap-xhdpi/ic_launcher_round.png | Bin 0 -> 6895 bytes app/src/main/res/mipmap-xxhdpi/ic_launcher.png | Bin 0 -> 6387 bytes .../main/res/mipmap-xxhdpi/ic_launcher_round.png | Bin 0 -> 10413 bytes app/src/main/res/mipmap-xxxhdpi/ic_launcher.png | Bin 0 -> 9128 bytes .../main/res/mipmap-xxxhdpi/ic_launcher_round.png | Bin 0 -> 15132 bytes app/src/main/res/values/strings.xml | 3 + app/src/main/res/values/styles.xml | 7 + .../moe/yuuta/ohmysafdemo/ExampleUnitTest.java | 17 + build.gradle | 42 +++ deploy_repo.sh | 21 ++ gradle.properties | 20 ++ gradle/wrapper/gradle-wrapper.jar | Bin 0 -> 54329 bytes gradle/wrapper/gradle-wrapper.properties | 6 + gradlew | 172 ++++++++++ gradlew.bat | 84 +++++ ohmysaf/.gitignore | 1 + ohmysaf/build.gradle | 46 +++ ohmysaf/proguard-rules.pro | 21 ++ .../moe/yuuta/ohmysaf/ExampleInstrumentedTest.java | 26 ++ ohmysaf/src/main/AndroidManifest.xml | 1 + .../src/main/java/moe/yuuta/ohmysaf/OhMySAF.java | 26 ++ .../src/main/java/moe/yuuta/ohmysaf/SafFile.java | 345 +++++++++++++++++++++ .../java/moe/yuuta/ohmysaf/ExampleUnitTest.java | 17 + settings.gradle | 1 + 43 files changed, 1505 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 README.md create mode 100644 app/.gitignore create mode 100644 app/build.gradle create mode 100644 app/proguard-rules.pro create mode 100644 app/src/androidTest/java/moe/yuuta/ohmysafdemo/ExampleInstrumentedTest.java create mode 100644 app/src/main/AndroidManifest.xml create mode 100644 app/src/main/java/moe/yuuta/ohmysafdemo/MainActivity.java create mode 100644 app/src/main/res/drawable-v24/ic_launcher_foreground.xml create mode 100644 app/src/main/res/drawable/ic_launcher_background.xml create mode 100644 app/src/main/res/layout/activity_main.xml create mode 100644 app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml create mode 100644 app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml create mode 100644 app/src/main/res/mipmap-hdpi/ic_launcher.png create mode 100644 app/src/main/res/mipmap-hdpi/ic_launcher_round.png create mode 100644 app/src/main/res/mipmap-mdpi/ic_launcher.png create mode 100644 app/src/main/res/mipmap-mdpi/ic_launcher_round.png create mode 100644 app/src/main/res/mipmap-xhdpi/ic_launcher.png create mode 100644 app/src/main/res/mipmap-xhdpi/ic_launcher_round.png create mode 100644 app/src/main/res/mipmap-xxhdpi/ic_launcher.png create mode 100644 app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png create mode 100644 app/src/main/res/mipmap-xxxhdpi/ic_launcher.png create mode 100644 app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png create mode 100644 app/src/main/res/values/strings.xml create mode 100644 app/src/main/res/values/styles.xml create mode 100644 app/src/test/java/moe/yuuta/ohmysafdemo/ExampleUnitTest.java create mode 100644 build.gradle create mode 100755 deploy_repo.sh create mode 100644 gradle.properties create mode 100644 gradle/wrapper/gradle-wrapper.jar create mode 100644 gradle/wrapper/gradle-wrapper.properties create mode 100755 gradlew create mode 100644 gradlew.bat create mode 100644 ohmysaf/.gitignore create mode 100644 ohmysaf/build.gradle create mode 100644 ohmysaf/proguard-rules.pro create mode 100644 ohmysaf/src/androidTest/java/moe/yuuta/ohmysaf/ExampleInstrumentedTest.java create mode 100644 ohmysaf/src/main/AndroidManifest.xml create mode 100644 ohmysaf/src/main/java/moe/yuuta/ohmysaf/OhMySAF.java create mode 100644 ohmysaf/src/main/java/moe/yuuta/ohmysaf/SafFile.java create mode 100644 ohmysaf/src/test/java/moe/yuuta/ohmysaf/ExampleUnitTest.java create mode 100644 settings.gradle diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0f1d137 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +*.iml +.gradle +/local.properties +/.idea +.DS_Store +/build +/captures +.externalNativeBuild +.cxx diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..21b6967 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,18 @@ +jdk: oraclejdk8 +language: android +android: + components: + - build-tools-28.0.3 + - android-28 +before_install: + - git clone https://github.com/Trumeet/Maven.git ./repo + - "./gradlew exportVersion" + - export VERSION=$(cat version.txt) +script: + - "./gradlew :ohmysaf:uploadArchives" +deploy: + provider: script + script: chmod +x ./deploy_repo.sh && ./deploy_repo.sh + on: + repo: Trumeet/OhMySAF + branch: master \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..f918f2a --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# Oh My SAF + +Android [SAF](https://developer.android.com/guide/topics/providers/document-provider) helper. + +# Implement + +1. Add [maven.yuuta.moe](https://maven.yuuta.moe) repo to your module + +2. Add dependency: + +```grooxy +implementation 'moe.yuuta.ohmysaf:ohmysaf:' +``` + +# Main Features + +* Faster migrate - If you have an old project which uses `java.io.File` a lot and you would like to migrate to SAF, OMG. By using OhMySAF, you can just continue using `File` with a little hack. + +# Faster Migrate + +Imagine that you have an old project and its file operation codes look like: + +```java +File theFxxkFile = new File("xxx/xxx"); +if (theFxxkFile.isFile()) { + theFxxkFile.delete(); + theFxxkFile.mkdir(); // In fact, SAF does not support that. +} +``` + +If you want to switch to SAF, the normal code will look like: + +```java +// Assume that you've got the URI +DocumentFile theFxxkFile = DocumentFile.fromTreeUri(context, uri); +if (theFxxkFile.isFile()) { + theFxxkFile.delete(); + // ..... +} +``` + +One day you discovered `OhMySAF`, your problem is solved: + +```java +// Assume that you've got the URI + +// Magic +File theFxxkFile = OhMySAF.ohMyTree(context, uri); + +// Just KEEP these old codes! +if (theFxxkFile.isFile()) { + theFxxkFile.delete(); + theFxxkFile.mkdir(); // In fact, SAF does not support that. +} +``` + +# Licenses + +Apache 2.0 \ No newline at end of file diff --git a/app/.gitignore b/app/.gitignore new file mode 100644 index 0000000..796b96d --- /dev/null +++ b/app/.gitignore @@ -0,0 +1 @@ +/build diff --git a/app/build.gradle b/app/build.gradle new file mode 100644 index 0000000..20b7511 --- /dev/null +++ b/app/build.gradle @@ -0,0 +1,29 @@ +apply plugin: 'com.android.application' + +android { + compileSdkVersion 28 + defaultConfig { + applicationId "moe.yuuta.ohmysafdemo" + minSdkVersion 19 + targetSdkVersion 28 + versionCode rootProject.ext.version + versionName "1.0" + testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" + } + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } +} + +dependencies { + implementation fileTree(dir: 'libs', include: ['*.jar']) + implementation 'androidx.constraintlayout:constraintlayout:1.1.3' + testImplementation 'junit:junit:4.12' + androidTestImplementation 'androidx.test.ext:junit:1.1.0' + androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.1' + implementation 'androidx.documentfile:documentfile:1.0.1' + implementation project(':ohmysaf') +} diff --git a/app/proguard-rules.pro b/app/proguard-rules.pro new file mode 100644 index 0000000..f1b4245 --- /dev/null +++ b/app/proguard-rules.pro @@ -0,0 +1,21 @@ +# Add project specific ProGuard rules here. +# You can control the set of applied configuration files using the +# proguardFiles setting in build.gradle. +# +# For more details, see +# http://developer.android.com/guide/developing/tools/proguard.html + +# If your project uses WebView with JS, uncomment the following +# and specify the fully qualified class name to the JavaScript interface +# class: +#-keepclassmembers class fqcn.of.javascript.interface.for.webview { +# public *; +#} + +# Uncomment this to preserve the line number information for +# debugging stack traces. +#-keepattributes SourceFile,LineNumberTable + +# If you keep the line number information, uncomment this to +# hide the original source file name. +#-renamesourcefileattribute SourceFile diff --git a/app/src/androidTest/java/moe/yuuta/ohmysafdemo/ExampleInstrumentedTest.java b/app/src/androidTest/java/moe/yuuta/ohmysafdemo/ExampleInstrumentedTest.java new file mode 100644 index 0000000..48bd8b8 --- /dev/null +++ b/app/src/androidTest/java/moe/yuuta/ohmysafdemo/ExampleInstrumentedTest.java @@ -0,0 +1,27 @@ +package moe.yuuta.ohmysafdemo; + +import android.content.Context; + +import androidx.test.ext.junit.runners.AndroidJUnit4; +import androidx.test.platform.app.InstrumentationRegistry; + +import org.junit.Test; +import org.junit.runner.RunWith; + +import static org.junit.Assert.assertEquals; + +/** + * Instrumented test, which will execute on an Android device. + * + * @see Testing documentation + */ +@RunWith(AndroidJUnit4.class) +public class ExampleInstrumentedTest { + @Test + public void useAppContext() { + // Context of the app under test. + Context appContext = InstrumentationRegistry.getInstrumentation().getTargetContext(); + + assertEquals("moe.yuuta.ohmysafdemo", appContext.getPackageName()); + } +} diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000..03ab231 --- /dev/null +++ b/app/src/main/AndroidManifest.xml @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app/src/main/java/moe/yuuta/ohmysafdemo/MainActivity.java b/app/src/main/java/moe/yuuta/ohmysafdemo/MainActivity.java new file mode 100644 index 0000000..fbea9ad --- /dev/null +++ b/app/src/main/java/moe/yuuta/ohmysafdemo/MainActivity.java @@ -0,0 +1,211 @@ +package moe.yuuta.ohmysafdemo; + +import android.annotation.NonNull; +import android.annotation.Nullable; +import android.app.Activity; +import android.content.Intent; +import android.graphics.Bitmap; +import android.graphics.BitmapFactory; +import android.net.Uri; +import android.os.Bundle; +import android.os.ParcelFileDescriptor; +import android.provider.DocumentsContract; +import android.util.Log; +import android.view.Menu; +import android.view.MenuItem; +import android.view.View; +import android.widget.ImageView; +import android.widget.Toast; + +import java.io.File; +import java.io.FileDescriptor; +import java.io.IOException; +import java.io.OutputStream; +import java.util.Arrays; + +import moe.yuuta.ohmysaf.OhMySAF; + +public class MainActivity extends Activity implements View.OnClickListener { + private static final int RC_OPEN_DOC = 1; + private static final int RC_CREATE_DOC = 2; + private static final int RC_OPEN_TREE = 3; + + private ImageView mImage; + private volatile Bitmap mBitmap; + private volatile String mFileName; + private Uri mUri; + + @Override + protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + setContentView(R.layout.activity_main); + findViewById(android.R.id.button1).setOnClickListener(this); + findViewById(android.R.id.button2).setOnClickListener(this); + mImage = findViewById(R.id.image); + } + + @Override + public void onClick(View v) { + switch (v.getId()) { + case android.R.id.button1: + runOpenDoc(); + break; + case android.R.id.button2: + runOpenTree(); + break; + } + } + + @Override + protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) { + log("Activity result....."); + if (resultCode != RESULT_OK || data == null) return; + mUri = data.getData(); + log(mUri.toString()); + switch (requestCode) { + case RC_OPEN_DOC: + File dir1 = OhMySAF.ohMyFile(this, mUri); + log("Name: " + dir1.getName() + ", length: " + dir1.length() + + ", canWrite: " + dir1.canWrite()); + mFileName = dir1.getName(); + setTitle(mFileName); + handleDocSelected(mUri); + break; + case RC_CREATE_DOC: + File dir2 = OhMySAF.ohMyFile(this, mUri); + log("Name: " + dir2.getName() + ", length: " + dir2.length() + + ", canWrite: " + dir2.canWrite()); + mFileName = dir2.getName(); + setTitle(mFileName); + handleDocCreated(mUri); + break; + case RC_OPEN_TREE: + File dir = OhMySAF.ohMyTree(this, mUri); + log("Name: " + dir.getName() + ", length: " + dir.length() + + ", files: " + Arrays.toString(dir.listFiles()) + + ", canWrite: " + dir.canWrite()); + mFileName = dir.getName(); + setTitle(mFileName); + break; + } + } + + private void handleDocCreated(@NonNull final Uri uri) { + new Thread(new Runnable() { + @Override + public void run() { + try { + OutputStream stream = getContentResolver().openOutputStream(uri, "w"); + mBitmap.compress(Bitmap.CompressFormat.PNG, 100, stream); + stream.flush(); + stream.close(); + log("Write done"); + handleDocSelected(uri); + } catch (IOException e) { + log("Write: " + e.getMessage()); + } + } + }).start(); + } + + private void handleDocSelected(@NonNull final Uri uri) { + new Thread(new Runnable() { + @Override + public void run() { + try { + ParcelFileDescriptor parcelFileDescriptor = + getContentResolver().openFileDescriptor(uri, "r"); + FileDescriptor fileDescriptor = parcelFileDescriptor.getFileDescriptor(); + mBitmap = BitmapFactory.decodeFileDescriptor(fileDescriptor); + parcelFileDescriptor.close(); + runOnUiThread(new Runnable() { + @Override + public void run() { + mImage.setImageBitmap(mBitmap); + } + }); + } catch (final IOException e) { + log(e.getMessage()); + } + } + }).start(); + } + + private void log(@NonNull final String message) { + Log.i("OhMySAF", message); + runOnUiThread(new Runnable() { + @Override + public void run() { + Toast.makeText(MainActivity.this, message, Toast.LENGTH_SHORT).show(); + } + }); + } + + @Override + public boolean onCreateOptionsMenu(Menu menu) { + menu.add(0, 0, 0, "Make a copy"); + menu.add(0, 1, 0, "Delete (without confirmation!!!)"); + menu.add(0, 2, 0, "Take persistable uri permission"); + return true; + } + + @Override + public boolean onOptionsItemSelected(MenuItem item) { + if (mBitmap == null) { + log("Select a photo and try again"); + return false; + } + switch (item.getItemId()) { + case 0: + runCreateDoc(); + return true; + case 1: + runDeleteDoc(); + return true; + case 2: + runTakePersistablePermission(); + return true; + default: + return false; + } + } + + private void runOpenDoc() { + Intent intentOpenDoc = new Intent(Intent.ACTION_OPEN_DOCUMENT); + intentOpenDoc.addCategory(Intent.CATEGORY_OPENABLE); + intentOpenDoc.setType("image/*"); + startActivityForResult(intentOpenDoc, RC_OPEN_DOC); + } + + private void runCreateDoc() { + Intent intentCreateDoc = new Intent(Intent.ACTION_CREATE_DOCUMENT); + intentCreateDoc.addCategory(Intent.CATEGORY_OPENABLE); + intentCreateDoc.setType("image/*"); + intentCreateDoc.putExtra(Intent.EXTRA_TITLE, "Copy_" + mFileName); + startActivityForResult(intentCreateDoc, RC_CREATE_DOC); + } + + private void runDeleteDoc() { + try { + DocumentsContract.deleteDocument(getContentResolver(), mUri); + log("Delete done"); + mFileName = null; + mBitmap = null; + mUri = null; + mImage.setImageBitmap(null); + setTitle(R.string.app_name); + } catch (IOException e) { + log("Delete: " + e.getMessage()); + } + } + + private void runTakePersistablePermission() { + getContentResolver().takePersistableUriPermission(mUri, Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION); + log("Done"); + } + + private void runOpenTree() { + Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT_TREE); + startActivityForResult(intent, RC_OPEN_TREE); + } +} diff --git a/app/src/main/res/drawable-v24/ic_launcher_foreground.xml b/app/src/main/res/drawable-v24/ic_launcher_foreground.xml new file mode 100644 index 0000000..1f6bb29 --- /dev/null +++ b/app/src/main/res/drawable-v24/ic_launcher_foreground.xml @@ -0,0 +1,34 @@ + + + + + + + + + + + diff --git a/app/src/main/res/drawable/ic_launcher_background.xml b/app/src/main/res/drawable/ic_launcher_background.xml new file mode 100644 index 0000000..0d025f9 --- /dev/null +++ b/app/src/main/res/drawable/ic_launcher_background.xml @@ -0,0 +1,170 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/src/main/res/layout/activity_main.xml b/app/src/main/res/layout/activity_main.xml new file mode 100644 index 0000000..c00a099 --- /dev/null +++ b/app/src/main/res/layout/activity_main.xml @@ -0,0 +1,37 @@ + + + +