├── .gitignore
├── LICENSE.md
├── README.md
├── app
├── .gitignore
├── build.gradle
├── proguard-rules.pro
└── src
│ └── main
│ ├── AndroidManifest.xml
│ ├── java
│ └── com
│ │ └── lazygeniouz
│ │ └── filecompat
│ │ └── example
│ │ ├── MainActivity.kt
│ │ └── performance
│ │ ├── DirectoryPerformance.kt
│ │ ├── FilesPerformance.kt
│ │ └── Performance.kt
│ └── res
│ ├── drawable-v24
│ └── ic_launcher_foreground.xml
│ ├── drawable
│ └── ic_launcher_background.xml
│ ├── layout
│ └── activity_main.xml
│ ├── mipmap-anydpi-v26
│ ├── ic_launcher.xml
│ └── ic_launcher_round.xml
│ ├── mipmap-hdpi
│ ├── ic_launcher.webp
│ └── ic_launcher_round.webp
│ ├── mipmap-mdpi
│ ├── ic_launcher.webp
│ └── ic_launcher_round.webp
│ ├── mipmap-xhdpi
│ ├── ic_launcher.webp
│ └── ic_launcher_round.webp
│ ├── mipmap-xxhdpi
│ ├── ic_launcher.webp
│ └── ic_launcher_round.webp
│ ├── mipmap-xxxhdpi
│ ├── ic_launcher.webp
│ └── ic_launcher_round.webp
│ └── values
│ ├── colors.xml
│ ├── strings.xml
│ └── themes.xml
├── build.gradle
├── dfc
├── .gitignore
├── build.gradle
├── proguard-rules.pro
└── src
│ └── main
│ ├── AndroidManifest.xml
│ └── java
│ └── com
│ └── lazygeniouz
│ └── dfc
│ ├── controller
│ └── DocumentController.kt
│ ├── file
│ ├── DocumentFileCompat.kt
│ ├── SerializedFile.kt
│ └── internals
│ │ ├── RawDocumentFileCompat.kt
│ │ ├── SingleDocumentFileCompat.kt
│ │ └── TreeDocumentFileCompat.kt
│ ├── logger
│ └── ErrorLogger.kt
│ └── resolver
│ └── ResolverCompat.kt
├── gradle.properties
├── gradlew
├── gradlew.bat
├── screenshots
├── filecompat_directory_perf.jpeg
└── filecompat_file_perf.jpeg
└── settings.gradle
/.gitignore:
--------------------------------------------------------------------------------
1 | *.iml
2 | *.txt
3 | *.sh
4 | .DS_Store
5 |
6 | .idea
7 | build
8 | gradle
9 | .gradle
10 | local.properties
11 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # DocumentFileCompat
2 |
3 | A faster alternative to AndroidX's DocumentFile.
4 |
5 | ### The Problem with DocumentFile
6 |
7 | It is horribly slow!\
8 | For **almost** every method, there is a query to **ContentResolver**.
9 |
10 | The most common one is `DocumentFile.findFile()`, `DocumentFile.getName()` and other is building a
11 | Custom Data Model with multiple parameters.\
12 | This can take like a horrible amount of time.
13 |
14 | ### Solution
15 |
16 | `DocumentFileCompat` is a drop-in replacement which gathers relevant parameters when querying for
17 | files.\
18 | The performance can sometimes peak to 2x or quite higher, depending on the size of the folder.
19 |
20 | Check the screenshots below:
21 |
22 | [
](/screenshots/filecompat_directory_perf.jpeg)
23 |
24 | [
](/screenshots/filecompat_file_perf.jpeg)
25 |
26 | **48 whopping seconds for directory listing compared to 3.5!** (Obviously, No competition with the
27 | Native File API).\
28 | Also extracting file information does not take that much time but the improvement is still
29 | significant.
30 |
31 | **Note:** `DocumentFileCompat` is something that I used internally for some projects & therefore I
32 | didn't do much of file manipulation with it (only delete files) and therefore this API does
33 | not offer too much out of the box.\
34 | This is now a completely usable alternative to `DocumentFile`.
35 |
36 | ### Installation
37 |
38 | #### Gradle
39 |
40 | ```gradle
41 | dependencies {
42 | implementation "com.lazygeniouz:dfc:$latest_version"
43 | }
44 | ```
45 |
46 | #### Maven
47 |
48 | ```xml
49 |
50 |
51 | com.lazygeniouz
52 | dfc
53 | $latest_version
54 | aar
55 |
56 | ```
57 |
58 | ### Usage
59 |
60 | Almost all of the methods & getters are identical to `DocumentFile`, you'll just have to replace the
61 | imports.\
62 | Additional methods like `copyTo(destination: Uri)` & `copyFrom(source: Uri)` are added as well.
63 |
64 | #### Reference:
65 |
66 | 1. https://stackoverflow.com/a/42187419/6819340
67 | 2. https://stackoverflow.com/a/63466997/6819340
68 |
69 | ### Issues & Suggestions
70 |
71 | Create a new issue if you experience any problem or have any suggestions.\
72 | I'll appreciate if you create a PR as well (if possible).
73 |
74 | Finally, don't forget to ⭐️ the library! :)
--------------------------------------------------------------------------------
/app/.gitignore:
--------------------------------------------------------------------------------
1 | /build
--------------------------------------------------------------------------------
/app/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'com.android.application'
3 | id 'kotlin-android'
4 | }
5 |
6 | android {
7 | compileSdk 33
8 | namespace 'com.lazygeniouz.filecompat.example'
9 |
10 | defaultConfig {
11 | applicationId "com.lazygeniouz.filecompat.example"
12 | minSdk 21
13 | targetSdk 33
14 | versionCode 1
15 | versionName "1.0"
16 |
17 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
18 | }
19 |
20 | buildTypes {
21 | release {
22 | minifyEnabled false
23 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
24 | }
25 | }
26 |
27 | compileOptions {
28 | sourceCompatibility JavaVersion.VERSION_1_8
29 | targetCompatibility JavaVersion.VERSION_1_8
30 | }
31 |
32 | kotlinOptions {
33 | jvmTarget = '1.8'
34 | freeCompilerArgs += "-Xopt-in=kotlin.RequiresOptIn"
35 | }
36 | }
37 |
38 | dependencies {
39 | implementation project(':dfc')
40 |
41 | implementation 'androidx.appcompat:appcompat:1.6.0'
42 | implementation 'androidx.activity:activity-ktx:1.6.1'
43 | implementation 'com.google.android.material:material:1.7.0'
44 | }
--------------------------------------------------------------------------------
/app/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
8 |
9 |
10 |
11 |
12 |
13 |
20 |
21 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
--------------------------------------------------------------------------------
/app/src/main/java/com/lazygeniouz/filecompat/example/MainActivity.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.filecompat.example
2 |
3 | import android.annotation.SuppressLint
4 | import android.app.Activity
5 | import android.content.Context
6 | import android.content.Intent
7 | import android.os.Build.VERSION.SDK_INT
8 | import android.os.Bundle
9 | import android.os.storage.StorageManager
10 | import android.widget.Button
11 | import android.widget.ProgressBar
12 | import android.widget.TextView
13 | import androidx.activity.result.contract.ActivityResultContracts
14 | import androidx.appcompat.app.AppCompatActivity
15 | import androidx.core.view.isVisible
16 | import androidx.lifecycle.lifecycleScope
17 | import com.lazygeniouz.filecompat.example.performance.Performance
18 | import kotlinx.coroutines.Dispatchers
19 | import kotlinx.coroutines.launch
20 | import kotlinx.coroutines.withContext
21 |
22 | class MainActivity : AppCompatActivity(R.layout.activity_main) {
23 |
24 | private lateinit var buttonDir: Button
25 | private lateinit var buttonFile: Button
26 |
27 | private lateinit var textView: TextView
28 | private lateinit var progress: ProgressBar
29 |
30 | private val folderResultLauncher =
31 | registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
32 | if (result.resultCode == Activity.RESULT_OK) {
33 | val documentUri = result.data?.data
34 | if (documentUri != null) {
35 | textView.text = ""
36 |
37 | lifecycleScope.launch {
38 | progress.isVisible = true
39 | buttonDir.isVisible = false
40 | buttonFile.isVisible = false
41 | val performanceResult = withContext(Dispatchers.IO) {
42 | Performance.calculateDirectoryPerformance(
43 | this@MainActivity, documentUri
44 | )
45 | }
46 |
47 | progress.isVisible = false
48 | buttonDir.isVisible = true
49 | buttonFile.isVisible = true
50 | textView.text = performanceResult
51 | }
52 | }
53 | }
54 | }
55 |
56 |
57 | @SuppressLint("SetTextI18n")
58 | private val fileResultLauncher =
59 | registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
60 | if (result.resultCode == Activity.RESULT_OK) {
61 | val documentUri = result.data?.data
62 | if (documentUri != null) {
63 | textView.text = ""
64 |
65 | lifecycleScope.launch {
66 | val performance = withContext(Dispatchers.IO) {
67 | Performance.calculateFilesPerformance(
68 | this@MainActivity, documentUri
69 | )
70 | }
71 |
72 | textView.text = performance
73 | }
74 | }
75 | }
76 | }
77 |
78 | override fun onCreate(savedInstanceState: Bundle?) {
79 | super.onCreate(savedInstanceState)
80 |
81 | buttonDir = findViewById(R.id.buttonDir)
82 | buttonFile = findViewById(R.id.buttonFile)
83 | textView = findViewById(R.id.fileNames)
84 | progress = findViewById(R.id.progress)
85 |
86 | buttonDir.setOnClickListener {
87 | folderResultLauncher.launch(getStorageIntent())
88 | }
89 |
90 | buttonFile.setOnClickListener {
91 | fileResultLauncher.launch(getStorageIntent(true))
92 | }
93 | }
94 |
95 | private fun getStorageIntent(single: Boolean = false): Intent {
96 | return if (single) Intent(Intent.ACTION_GET_CONTENT).setType("*/*") else {
97 | if (SDK_INT >= 30) {
98 | val storageManager = getSystemService(Context.STORAGE_SERVICE) as StorageManager
99 | storageManager.primaryStorageVolume.createOpenDocumentTreeIntent()
100 | } else Intent(Intent.ACTION_OPEN_DOCUMENT_TREE)
101 | }
102 | }
103 |
104 | @Suppress("override_deprecation")
105 | // this is just a sample app, ignore this.
106 | override fun onBackPressed() = finishAffinity()
107 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/lazygeniouz/filecompat/example/performance/DirectoryPerformance.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.filecompat.example.performance
2 |
3 | import android.content.Context
4 | import android.net.Uri
5 | import android.os.Build
6 | import android.os.Environment
7 | import androidx.documentfile.provider.DocumentFile
8 | import com.lazygeniouz.dfc.file.DocumentFileCompat
9 | import com.lazygeniouz.filecompat.example.performance.Performance.measureTimeSeconds
10 | import java.io.File
11 |
12 | object DirectoryPerformance {
13 |
14 | fun calculateDirectorySidePerformance(context: Context, uri: Uri): String {
15 | var results = ""
16 | results += calculateNativeFilePerformance(uri) + "\n\n"
17 | results += calculateRawFileCompatPerformance(context, uri) + "\n\n"
18 |
19 | results += "=".repeat(48).plus("\n\n")
20 | results += calculateDocumentFileCompatPerformance(context, uri) + "\n"
21 | results += calculateDocumentFilePerformance(context, uri) + "\n\n"
22 |
23 | results += "=".repeat(48).plus("\n\n")
24 | results += "Fetching only Uris will always be faster (after File)" + "\nBut try fetching the Documents' Names.\n\n"
25 | results += calculateDocumentFileCompatPerformanceWithName(context, uri) + "\n"
26 | results += calculateDocumentFilePerformanceOnlyUri(context, uri) + "\n"
27 | results += calculateDocumentFilePerformanceWithName(context, uri)
28 | return results
29 | }
30 |
31 |
32 | // Nothing beats this.
33 | // This test also requires the File Access Permission
34 | private fun calculateNativeFilePerformance(uri: Uri): String {
35 | return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
36 | if (Environment.isExternalStorageManager()) {
37 | runFilesPerformance(uri)
38 | } else {
39 | "Android R+ requires All Files Access for this test to run."
40 | }
41 | } else {
42 | runFilesPerformance(uri)
43 | }
44 | }
45 |
46 | // This test also requires the File Access Permission.
47 | // Comes Second to the Native File API due to building internal objects.
48 | private fun calculateRawFileCompatPerformance(context: Context, uri: Uri): String {
49 | return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
50 | if (Environment.isExternalStorageManager()) {
51 | runFilesCompatPerformance(context, uri)
52 | } else {
53 | "Android R+ requires All Files Access for this test to run."
54 | }
55 | } else {
56 | runFilesCompatPerformance(context, uri)
57 | }
58 | }
59 |
60 | private fun runFilesPerformance(uri: Uri): String {
61 | var size: Int = -1
62 | measureTimeSeconds {
63 | // If the paths file for tests, just hardcode with a fixed directory.
64 | val formattedPath = Performance.getUsablePath(uri)
65 | val files = File(Environment.getExternalStorageDirectory(), formattedPath).listFiles()
66 | size = files?.size ?: -1
67 | }.also { time ->
68 | val message = "Folder has $size items.\nNative File Performance = ${time}s"
69 | return (message)
70 | }
71 | }
72 |
73 | private fun runFilesCompatPerformance(context: Context, uri: Uri): String {
74 | var size: Int = -1
75 | measureTimeSeconds {
76 | // If the paths file for tests, just hardcode with a fixed directory.
77 | val formattedPath = Performance.getUsablePath(uri)
78 | val file = File(Environment.getExternalStorageDirectory(), formattedPath)
79 | val files = DocumentFileCompat.fromFile(context, file).listFiles()
80 | size = files.size
81 | }.also { time ->
82 | // building a DFC model with File will take a few ms against the native perf.
83 | val message = "Folder has $size items.\nDFC (File API) Performance = ${time}s"
84 | return (message)
85 | }
86 | }
87 |
88 | private fun calculateDocumentFileCompatPerformance(context: Context, uri: Uri): String {
89 | measureTimeSeconds {
90 | val documentFile = DocumentFileCompat.fromTreeUri(context, uri)
91 | documentFile?.listFiles()
92 | }.also { time ->
93 | // This files have Uri, Name, Last Modified time for easy accessibility
94 | return ("DFC Performance = ${time}s")
95 | }
96 | }
97 |
98 | private fun calculateDocumentFilePerformance(context: Context, uri: Uri): String {
99 | measureTimeSeconds {
100 | val listOfUsableElements = arrayListOf()
101 | DocumentFile.fromTreeUri(context, uri)?.listFiles()?.forEach { documentFile ->
102 | listOfUsableElements.add(
103 | Performance.FileHolderPojo(
104 | documentFile.uri,
105 | // Each of this will call ContentResolver
106 | documentFile.name.orEmpty(),
107 | documentFile.length().toInt(),
108 | documentFile.lastModified(),
109 | documentFile.type.orEmpty(),
110 | )
111 | )
112 | }
113 | }.also { time -> return ("DocumentFile Performance = ${time}s") }
114 | }
115 |
116 | private fun calculateDocumentFilePerformanceOnlyUri(context: Context, uri: Uri): String {
117 | measureTimeSeconds {
118 | DocumentFile.fromTreeUri(context, uri)?.listFiles()
119 | }.also { time ->
120 | // These files only have a Uri, so this operation is kinda faster
121 | return ("DocumentFile Performance (Uri Only) = ${time}s")
122 | }
123 | }
124 |
125 | private fun calculateDocumentFilePerformanceWithName(context: Context, uri: Uri): String {
126 | measureTimeSeconds {
127 | val listOfUsableElements = arrayListOf()
128 | DocumentFile.fromTreeUri(context, uri)?.listFiles()?.forEach { documentFile ->
129 | listOfUsableElements.add(documentFile.name.orEmpty())
130 | }
131 | }.also { time -> return ("DocumentFile Performance (With Names) = ${time}s") }
132 | }
133 |
134 | private fun calculateDocumentFileCompatPerformanceWithName(context: Context, uri: Uri): String {
135 | measureTimeSeconds {
136 | val listOfUsableElements = arrayListOf()
137 | DocumentFileCompat.fromTreeUri(context, uri)?.listFiles()?.forEach { documentFile ->
138 | listOfUsableElements.add(documentFile.name)
139 | }
140 | }.also { time ->
141 | return ("DFC Performance (With Names) = ${time}s")
142 | }
143 | }
144 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/lazygeniouz/filecompat/example/performance/FilesPerformance.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.filecompat.example.performance
2 |
3 | import android.content.Context
4 | import android.net.Uri
5 | import android.os.Environment
6 | import androidx.documentfile.provider.DocumentFile
7 | import com.lazygeniouz.dfc.file.DocumentFileCompat
8 | import com.lazygeniouz.filecompat.example.performance.Performance.getSizeInMb
9 | import com.lazygeniouz.filecompat.example.performance.Performance.measureTimeSeconds
10 | import java.io.File
11 | import java.text.SimpleDateFormat
12 | import java.util.*
13 |
14 | object FilesPerformance {
15 |
16 | fun calculateFileSidePerformance(context: Context, uri: Uri): String {
17 | var results = ""
18 | results += calculateFilePerformance(uri) + "\n\n\n"
19 | results += calculateFileCompatPerformance(context, uri) + "\n\n\n"
20 | results += calculateDocumentFilePerformance(context, uri) + "\n"
21 | return results
22 | }
23 |
24 | // Native File
25 | private fun calculateFilePerformance(uri: Uri): String {
26 | var message = ""
27 | measureTimeSeconds {
28 | val usableUri = Performance.getUsablePath(uri)
29 | val file = File(Environment.getExternalStorageDirectory(), usableUri)
30 | message = buildString(file.name, file.extension, file.lastModified(), file.length())
31 | }.also { time ->
32 | message = "$message\nNative File Performance = ${time}s"
33 | return (message)
34 | }
35 | }
36 |
37 | // FileCompat
38 | private fun calculateFileCompatPerformance(context: Context, uri: Uri): String {
39 | var message = ""
40 | measureTimeSeconds {
41 | val file = DocumentFileCompat.fromSingleUri(context, uri) ?: return@measureTimeSeconds
42 | message = buildString(
43 | file.name, file.extension,
44 | file.lastModified, file.length
45 | )
46 | }.also { time ->
47 | message = "$message\nDFC Performance = ${time}s"
48 | return (message)
49 | }
50 | }
51 |
52 | // DocumentFile
53 | private fun calculateDocumentFilePerformance(context: Context, uri: Uri): String {
54 | var message = ""
55 | measureTimeSeconds {
56 | val documentFile = DocumentFile.fromSingleUri(context, uri)
57 | message = buildString(
58 | documentFile?.name!!,
59 | documentFile.name!!.substringAfterLast("."),
60 | documentFile.lastModified(),
61 | documentFile.length()
62 | )
63 | }.also { time ->
64 | message = "$message\nDocumentFile Performance = ${time}s"
65 | return (message)
66 | }
67 | }
68 |
69 | private fun buildString(
70 | name: String, extension: String,
71 | lastModified: Long, fileSize: Long,
72 | ): String {
73 | return "Name: ${name}," +
74 | "\nSize: ${getSizeInMb(fileSize)}, " +
75 | "Extension: ${extension}, " +
76 | "\nLast modified: ${
77 | SimpleDateFormat("dd-MM-yyyy", Locale.getDefault())
78 | .format(Date(lastModified))
79 | }"
80 | }
81 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/lazygeniouz/filecompat/example/performance/Performance.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.filecompat.example.performance
2 |
3 | import android.content.Context
4 | import android.net.Uri
5 | import kotlin.system.measureTimeMillis
6 |
7 | object Performance {
8 |
9 | private val Long.toSeconds get() = (this / 1000.00)
10 |
11 | fun calculateDirectoryPerformance(context: Context, uri: Uri): String {
12 | return DirectoryPerformance.calculateDirectorySidePerformance(context, uri)
13 | }
14 |
15 | fun calculateFilesPerformance(context: Context, uri: Uri): String {
16 | return FilesPerformance.calculateFileSidePerformance(context, uri)
17 | }
18 |
19 | fun getUsablePath(uri: Uri): String {
20 | val path = uri.path!!
21 | return when {
22 | path.contains(":") -> path.split(":")[1]
23 | path.contains("tree") -> path.substringAfter("tree/")
24 | else -> path
25 | }
26 | }
27 |
28 | fun measureTimeSeconds(block: () -> Unit): Double {
29 | return measureTimeMillis(block).toSeconds
30 | }
31 |
32 | fun getSizeInMb(size: Long): String {
33 | return String.format("%.2f Mb", (size / 1024) / 1024.00f)
34 | }
35 |
36 | data class FileHolderPojo(
37 | val documentUri: Uri,
38 | val documentName: String = "",
39 | val documentSize: Int = 0,
40 | val lastModifiedTime: Long = -1L,
41 | val documentMimeType: String = "",
42 | )
43 | }
--------------------------------------------------------------------------------
/app/src/main/res/drawable-v24/ic_launcher_foreground.xml:
--------------------------------------------------------------------------------
1 |
7 |
8 |
9 |
15 |
18 |
21 |
22 |
23 |
24 |
30 |
--------------------------------------------------------------------------------
/app/src/main/res/drawable/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
10 |
15 |
20 |
25 |
30 |
35 |
40 |
45 |
50 |
55 |
60 |
65 |
70 |
75 |
80 |
85 |
90 |
95 |
100 |
105 |
110 |
115 |
120 |
125 |
130 |
135 |
140 |
145 |
150 |
155 |
160 |
165 |
170 |
171 |
--------------------------------------------------------------------------------
/app/src/main/res/layout/activity_main.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
8 |
13 |
14 |
20 |
21 |
28 |
29 |
36 |
37 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/app/src/main/res/mipmap-hdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/app/src/main/res/mipmap-mdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/app/src/main/res/mipmap-xhdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/values/colors.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | #FFBB86FC
4 | #FF6200EE
5 | #FF3700B3
6 | #FF03DAC5
7 | #FF018786
8 | #FF000000
9 | #FFFFFFFF
10 |
--------------------------------------------------------------------------------
/app/src/main/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 | FileCompat
3 | Select Directory
4 | Select a File
5 |
--------------------------------------------------------------------------------
/app/src/main/res/values/themes.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
16 |
--------------------------------------------------------------------------------
/build.gradle:
--------------------------------------------------------------------------------
1 | import com.vanniktech.maven.publish.AndroidSingleVariantLibrary
2 | import com.vanniktech.maven.publish.SonatypeHost
3 |
4 | buildscript {
5 | repositories {
6 | google()
7 | mavenCentral()
8 | }
9 |
10 | dependencies {
11 | classpath 'com.android.tools.build:gradle:8.7.3'
12 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23"
13 |
14 | classpath 'org.jetbrains.dokka:dokka-gradle-plugin:1.9.20'
15 | classpath 'com.vanniktech:gradle-maven-publish-plugin:0.30.0'
16 | }
17 | }
18 |
19 | allprojects {
20 | repositories {
21 | google()
22 | mavenCentral()
23 | }
24 |
25 | plugins.withId("com.vanniktech.maven.publish.base") {
26 | version "1.2"
27 | group "com.lazygeniouz"
28 |
29 | mavenPublishing {
30 | signAllPublications()
31 | pomFromGradleProperties()
32 | publishToMavenCentral(SonatypeHost.S01, true)
33 | configure(new AndroidSingleVariantLibrary("release", true, true))
34 | }
35 | }
36 | }
37 |
38 | tasks.register('clean', Delete) {
39 | delete rootProject.layout.buildDirectory
40 | }
--------------------------------------------------------------------------------
/dfc/.gitignore:
--------------------------------------------------------------------------------
1 | /build
--------------------------------------------------------------------------------
/dfc/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'com.android.library'
3 | id 'kotlin-android'
4 | id 'org.jetbrains.dokka'
5 | id 'com.vanniktech.maven.publish.base'
6 | }
7 |
8 | android {
9 | compileSdk 35
10 | namespace 'com.lazygeniouz.dfc'
11 |
12 | defaultConfig {
13 | minSdk 21
14 | targetSdk 35
15 | }
16 |
17 | buildTypes {
18 | release {
19 | minifyEnabled false
20 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
21 | }
22 | }
23 |
24 | compileOptions {
25 | sourceCompatibility JavaVersion.VERSION_17
26 | targetCompatibility JavaVersion.VERSION_17
27 | }
28 |
29 | kotlinOptions {
30 | jvmTarget = JavaVersion.VERSION_17.toString()
31 | }
32 | }
--------------------------------------------------------------------------------
/dfc/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
--------------------------------------------------------------------------------
/dfc/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
--------------------------------------------------------------------------------
/dfc/src/main/java/com/lazygeniouz/dfc/controller/DocumentController.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.dfc.controller
2 |
3 | import android.content.ContentResolver
4 | import android.content.Context
5 | import android.content.Intent
6 | import android.content.pm.PackageManager
7 | import android.net.Uri
8 | import android.provider.DocumentsContract
9 | import android.provider.DocumentsContract.Document.MIME_TYPE_DIR
10 | import com.lazygeniouz.dfc.file.DocumentFileCompat
11 | import com.lazygeniouz.dfc.resolver.ResolverCompat
12 |
13 |
14 | /**
15 | * This controller handles [Uri] & [DocumentFileCompat] building via [ResolverCompat].
16 | *
17 | * @param context Required for queries to [ContentResolver]
18 | * @param fileCompat For accessing DocumentFileCompat data
19 | */
20 | internal class DocumentController(
21 | private val context: Context,
22 | private val fileCompat: DocumentFileCompat,
23 | ) {
24 |
25 | // DocumentsContract API level 24.
26 | private val flagVirtualDocument = 1 shl 9
27 |
28 | // Uri of the given [DocumentFileCompat]
29 | private val fileUri get() = fileCompat.uri
30 |
31 | /**
32 | * This will return a list of [DocumentFileCompat] with all the defined fields.
33 | */
34 | internal fun listFiles(): List {
35 | return if (!isDirectory())
36 | throw UnsupportedOperationException("Selected document is not a Directory.")
37 | else ResolverCompat.listFiles(context, fileCompat)
38 | }
39 |
40 | /**
41 | * This will return the children count in the directory.
42 | *
43 | * More optimised than using [List.size] via [listFiles].
44 | */
45 | internal fun count(): Int {
46 | return if (!isDirectory()) 0
47 | else ResolverCompat.count(context, fileUri)
48 | }
49 |
50 | /**
51 | * Returns True if the Document Folder / File exists, False otherwise.
52 | */
53 | internal fun exists(): Boolean {
54 | return ResolverCompat.exists(context, fileUri)
55 | }
56 |
57 | /**
58 | * Returns True if the Document Folder / File is Virtual, False otherwise.
59 | *
60 | * Indicates that a document is virtual,
61 | * and doesn't have byte representation in the MIME type specified as COLUMN_MIME_TYPE.
62 | */
63 | internal fun isVirtual(): Boolean {
64 | if (!DocumentsContract.isDocumentUri(context, fileUri)) return false
65 |
66 | return fileCompat.documentFlags and flagVirtualDocument != 0
67 | }
68 |
69 | /**
70 | * Returns True if the Document is a File.
71 | */
72 | internal fun isFile(): Boolean {
73 | return !(MIME_TYPE_DIR == fileCompat.documentMimeType || fileCompat.documentMimeType.isEmpty())
74 | }
75 |
76 | /**
77 | * Returns True if the Document is a Directory
78 | */
79 | internal fun isDirectory(): Boolean {
80 | return MIME_TYPE_DIR == fileCompat.documentMimeType
81 | }
82 |
83 | /**
84 | * Returns True if the Document Folder / File is Readable.
85 | */
86 | internal fun canRead(): Boolean {
87 | if (context.checkCallingOrSelfUriPermission(
88 | fileUri, Intent.FLAG_GRANT_READ_URI_PERMISSION
89 | ) != PackageManager.PERMISSION_GRANTED
90 | ) return false
91 |
92 | if (fileCompat.documentMimeType.isEmpty()) return false
93 |
94 | return true
95 | }
96 |
97 | /**
98 | * Returns True if the Document Folder / File is Writable.
99 | */
100 | internal fun canWrite(): Boolean {
101 | if (context.checkCallingOrSelfUriPermission(
102 | fileUri, Intent.FLAG_GRANT_WRITE_URI_PERMISSION
103 | ) != PackageManager.PERMISSION_GRANTED
104 | ) return false
105 |
106 | if (fileCompat.documentMimeType.isEmpty()) return false
107 |
108 | if (fileCompat.documentFlags and DocumentsContract.Document.FLAG_SUPPORTS_DELETE != 0)
109 | return true
110 |
111 | if (MIME_TYPE_DIR == fileCompat.documentMimeType &&
112 | fileCompat.documentFlags and DocumentsContract.Document.FLAG_DIR_SUPPORTS_CREATE != 0
113 | ) return true
114 |
115 | else if (fileCompat.documentMimeType.isNotEmpty() &&
116 | fileCompat.documentFlags and DocumentsContract.Document.FLAG_SUPPORTS_WRITE != 0
117 | ) return true
118 |
119 | return false
120 | }
121 |
122 | /**
123 | * Create a document file.
124 | *
125 | * @param mimeType Type of the file, e.g: text/plain.
126 | * @param name The name of the file.
127 | *
128 | * @return A Uri if file was created successfully, **null** otherwise.
129 | */
130 | internal fun createFile(mimeType: String, name: String): Uri? {
131 | return ResolverCompat.createFile(context, fileUri, mimeType, name)
132 | }
133 |
134 | /**
135 | * Rename a Document File / Folder.
136 | *
137 | * Returns True if the rename was successful, False otherwise.
138 | */
139 | internal fun renameTo(name: String): Uri? {
140 | return ResolverCompat.renameTo(context, fileUri, name)
141 | }
142 |
143 | /**
144 | * Delete a document.
145 | */
146 | internal fun delete(): Boolean {
147 | return ResolverCompat.deleteDocument(context, fileUri)
148 | }
149 | }
--------------------------------------------------------------------------------
/dfc/src/main/java/com/lazygeniouz/dfc/file/DocumentFileCompat.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.dfc.file
2 |
3 | import android.content.ContentResolver
4 | import android.content.Context
5 | import android.net.Uri
6 | import android.provider.DocumentsContract.Document.COLUMN_MIME_TYPE
7 | import android.provider.DocumentsContract.Document.MIME_TYPE_DIR
8 | import android.provider.DocumentsContract.isDocumentUri
9 | import com.lazygeniouz.dfc.controller.DocumentController
10 | import com.lazygeniouz.dfc.file.internals.RawDocumentFileCompat
11 | import com.lazygeniouz.dfc.file.internals.SingleDocumentFileCompat
12 | import com.lazygeniouz.dfc.file.internals.TreeDocumentFileCompat
13 | import java.io.File
14 |
15 | /**
16 | * The base class that handles multiple URI cases like SingleDocumentUri,
17 | * TreeDocumentUri & even File API support.
18 | *
19 | * Use [DocumentFileCompat.serialize] to get a [Serializable] object.
20 | */
21 | abstract class DocumentFileCompat constructor(
22 | internal val context: Context,
23 | uri: Uri, val name: String = "",
24 | open val length: Long = 0,
25 | val lastModified: Long = -1L,
26 | internal val documentFlags: Int = -1,
27 | internal val documentMimeType: String = "",
28 | ) {
29 |
30 | // Secondary constructor for java.io.File type
31 | constructor(context: Context, file: File) : this(
32 | context, Uri.fromFile(file), file.name, file.length(),
33 | file.lastModified(), -1, RawDocumentFileCompat.getMimeType(file)
34 | )
35 |
36 | /**
37 | * Context is asserted as **NonNull** here because it is only required
38 | * by the [DocumentController] which is initialized **lazily** & would
39 | * never be initialized in the [RawDocumentFileCompat] as it uses the [File] api completely.
40 | */
41 | internal val fileController by lazy { DocumentController(context, this) }
42 |
43 | /**
44 | * Create a document file.
45 | *
46 | * @param mimeType Type of the file, e.g: text/plain.
47 | * @param name The name of the file.
48 | *
49 | * @return A DocumentFileCompat object if file was created successfully, **null** otherwise.
50 | */
51 | abstract fun createFile(mimeType: String, name: String): DocumentFileCompat?
52 |
53 | /**
54 | * Create a Directory.
55 | *
56 | * @param name The name of the file.
57 | *
58 | * @return A DocumentFileCompat object if directory was created successfully, **null** otherwise.
59 | */
60 | abstract fun createDirectory(name: String): DocumentFileCompat?
61 |
62 | /**
63 | * This will return a list of [DocumentFileCompat] with all the defined fields
64 | * only when the current document is a **Directory**.
65 | *
66 | * A [UnsupportedOperationException] is thrown if the uri is not a directory.
67 | */
68 | abstract fun listFiles(): List
69 |
70 | /**
71 | * This will return the children count inside a **Directory** without creating [DocumentFileCompat] objects.
72 | *
73 | * Returns **0** if the uri is not a directory or if the object at uri is null.
74 | *
75 | * **Note: You should use [listFiles] if you are going to need the elements later.**
76 | */
77 | abstract fun count(): Int
78 |
79 | /**
80 | * Find a File against the given name.
81 | *
82 | * Do not use this if you are going to call `listFiles()` again on the same
83 | * [DocumentFileCompat] object because this method internally searches same list.
84 | *
85 | * Multiple calls to `listFiles()` can have a performance hit.
86 | */
87 | abstract fun findFile(name: String, ignoreCase: Boolean = false): DocumentFileCompat?
88 |
89 | /**
90 | * Copy a document to a given Uri.
91 | */
92 | abstract fun copyTo(destination: Uri)
93 |
94 | /**
95 | * Copy a document to this Uri from source.
96 | */
97 | abstract fun copyFrom(source: Uri)
98 |
99 | /**
100 | * Rename a Document File / Folder.
101 | *
102 | * Will throw [UnsupportedOperationException] when called on a [SingleDocumentFileCompat].
103 | *
104 | * @return True if the rename was successful, False otherwise.
105 | * @throws UnsupportedOperationException
106 | */
107 | abstract fun renameTo(name: String): Boolean
108 |
109 | var uri: Uri = uri
110 | internal set
111 |
112 | /**
113 | * Return the parent file of this document.
114 | *
115 | * This will be null if called inside the selected directory.\
116 | * Should return the correct parent file for child items inside the selected directory.
117 | */
118 | var parentFile: DocumentFileCompat? = null
119 | internal set
120 |
121 | /**
122 | * Get the extension of the Document **File**.
123 | */
124 | open val extension: String
125 | // taken from Kotlin extension
126 | get() = name.substringAfterLast('.', "")
127 |
128 | /**
129 | * Return the MIME type of this document.
130 | *
131 | * @return A concrete mime type from [COLUMN_MIME_TYPE] column.
132 | */
133 | @Suppress("unused")
134 | fun getType(): String? {
135 | return if (documentMimeType == MIME_TYPE_DIR) null else documentMimeType
136 | }
137 |
138 | /**
139 | * Delete the file.
140 | *
141 | * @return True if deletion succeeded, False otherwise.
142 | */
143 | open fun delete(): Boolean {
144 | return fileController.delete()
145 | }
146 |
147 | /**
148 | * Returns True if the Document Folder / File exists, False otherwise.
149 | */
150 | open fun exists(): Boolean {
151 | return fileController.exists()
152 | }
153 |
154 | /**
155 | * Returns True if the Document Folder / File is Virtual, False otherwise.
156 | *
157 | * Indicates that a document is virtual,
158 | * and doesn't have byte representation in the MIME type specified as COLUMN_MIME_TYPE.
159 | */
160 | open fun isVirtual(): Boolean {
161 | return fileController.isVirtual()
162 | }
163 |
164 | /**
165 | * Returns True if the Document Folder / File is Readable.
166 | */
167 | open fun canRead(): Boolean {
168 | return fileController.canRead()
169 | }
170 |
171 | /**
172 | * Returns True if the Document Folder / File is Writable.
173 | */
174 | open fun canWrite(): Boolean {
175 | return fileController.canWrite()
176 | }
177 |
178 | /**
179 | * Returns True if the Document is a File.
180 | */
181 | open fun isFile(): Boolean {
182 | return fileController.isFile()
183 | }
184 |
185 | /**
186 | * Returns True if the Document is a Directory
187 | */
188 | open fun isDirectory(): Boolean {
189 | return fileController.isDirectory()
190 | }
191 |
192 | /**
193 | * Converts a non serializable [DocumentFileCompat] to a serializable [SerializedFile].
194 | */
195 | @Suppress("MemberVisibilityCanBePrivate")
196 | fun serialize(): SerializedFile {
197 | return SerializedFile.from(this)
198 | }
199 |
200 | companion object {
201 |
202 | /**
203 | * Build a Document Tree with this helper.
204 | *
205 | * @param context Required for queries to [ContentResolver]
206 | * @param uri uri which will be queried
207 | */
208 | @JvmStatic
209 | fun fromTreeUri(context: Context, uri: Uri): DocumentFileCompat? {
210 | return TreeDocumentFileCompat.make(context, uri, true)
211 | }
212 |
213 | /**
214 | * Build a Document File with this helper.
215 | *
216 | * @param context Required for queries to [ContentResolver]
217 | * @param uri Uri which will be queried
218 | */
219 | @JvmStatic
220 | fun fromSingleUri(context: Context, uri: Uri): DocumentFileCompat? {
221 | return SingleDocumentFileCompat.make(context, uri)
222 | }
223 |
224 | /**
225 | * Build an initial File with this helper.
226 | *
227 | * RawDocumentFileCompat serves as an alternative to the **RawDocumentFile**
228 | * which handles Documents using the native [File] api.
229 | */
230 | @JvmStatic
231 | fun fromFile(context: Context, file: File): DocumentFileCompat {
232 | return RawDocumentFileCompat(context, file)
233 | }
234 |
235 | /**
236 | * Test if given Uri is backed by a [android.provider.DocumentsProvider].
237 | */
238 | @JvmStatic
239 | @Suppress("unused")
240 | fun isDocument(context: Context, uri: Uri): Boolean {
241 | return isDocumentUri(context, uri)
242 | }
243 | }
244 | }
--------------------------------------------------------------------------------
/dfc/src/main/java/com/lazygeniouz/dfc/file/SerializedFile.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.dfc.file
2 |
3 | import java.io.Serializable
4 |
5 | /**
6 | * This can be used as a [Serializable] object to pass around the app
7 | * without creating your own Models as this only holds references to Primitive types.
8 | */
9 | class SerializedFile private constructor(
10 | val uriPath: String, val name: String,
11 | val length: Long, val lastModified: Long,
12 | val mimeType: String, val flags: Int
13 | ) : Serializable {
14 |
15 | val extension: String
16 | get() = name.substringAfterLast('.', "")
17 |
18 | companion object {
19 |
20 | /**
21 | * Copy fields from a [DocumentFileCompat] object.
22 | *
23 | * This is a **Read Only** object.
24 | *
25 | * @param file [DocumentFileCompat] object for copying primitive data types.
26 | * @return A Serializable object.
27 | */
28 | internal fun from(file: DocumentFileCompat): SerializedFile {
29 | with(file) {
30 | return SerializedFile(
31 | uri.toString(), name, length,
32 | lastModified, documentMimeType, documentFlags
33 | )
34 | }
35 | }
36 | }
37 | }
--------------------------------------------------------------------------------
/dfc/src/main/java/com/lazygeniouz/dfc/file/internals/RawDocumentFileCompat.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.dfc.file.internals
2 |
3 | import android.content.Context
4 | import android.net.Uri
5 | import android.webkit.MimeTypeMap
6 | import com.lazygeniouz.dfc.file.DocumentFileCompat
7 | import com.lazygeniouz.dfc.logger.ErrorLogger.logError
8 | import java.io.File
9 |
10 | /**
11 | * RawDocumentFileCompat serves as an alternative to the **RawDocumentFile**
12 | * which handles Documents using the native [File] api.
13 | */
14 | internal class RawDocumentFileCompat constructor(context: Context, var file: File) :
15 | DocumentFileCompat(context, file) {
16 |
17 | // Get file extension.
18 | override val extension: String
19 | get() = file.extension
20 |
21 | // Get file size.
22 | override val length: Long
23 | get() = file.length()
24 |
25 | /**
26 | * Delete the file & return the result.
27 | */
28 | override fun delete(): Boolean {
29 | return file.delete()
30 | }
31 |
32 | // Check if the file exists.
33 | override fun exists(): Boolean {
34 | return file.exists()
35 | }
36 |
37 | // File is not virtual & is an openable.
38 | override fun isVirtual(): Boolean {
39 | return false
40 | }
41 |
42 | // Check if the file can be read
43 | override fun canRead(): Boolean {
44 | return file.canRead()
45 | }
46 |
47 | // Check if the file can be modified.
48 | override fun canWrite(): Boolean {
49 | return file.canWrite()
50 | }
51 |
52 | // Check if the file is a File & not a Directory
53 | override fun isFile(): Boolean {
54 | return file.isFile
55 | }
56 |
57 | // Check if the file is a Directory
58 | override fun isDirectory(): Boolean {
59 | return file.isDirectory
60 | }
61 |
62 | // Rename a file & return the result & assign the new file to the current one.
63 | override fun renameTo(name: String): Boolean {
64 | val target = File(file.parentFile, name)
65 | val renameResult = file.renameTo(target)
66 | return if (renameResult) {
67 | file = target
68 | true
69 | } else false
70 | }
71 |
72 | // Create file & return a DocumentFileCompat (RawFileCompat),
73 | // can be null if there was an Exception.
74 | override fun createFile(mimeType: String, name: String): DocumentFileCompat? {
75 | var displayName = name
76 | val extension = MimeTypeMap.getSingleton().getExtensionFromMimeType(mimeType)
77 | if (extension != null) {
78 | displayName += ".$extension"
79 | }
80 |
81 | val target = File(file, displayName)
82 | return try {
83 | if (target.createNewFile()) fromFile(context, target)
84 | else null
85 | } catch (exception: Exception) {
86 | logError("Exception while creating a document", exception)
87 | null
88 | }
89 | }
90 |
91 | // Create a Directory & return a DocumentFileCompat (RawFileCompat),
92 | // can be null if there was an Exception.
93 | override fun createDirectory(name: String): DocumentFileCompat? {
94 | val target = File(file, name)
95 | return if (target.isDirectory || target.mkdir()) fromFile(context, target)
96 | else null
97 | }
98 |
99 | // Performance of File api is pretty great as compared to others.
100 | override fun listFiles(): List {
101 | return file.listFiles()?.map { child -> fromFile(context, child) } ?: emptyList()
102 | }
103 |
104 | /**
105 | * This will return the children count in the directory.
106 | *
107 | * [File] api is usually fast but may slow down if there are a lot of children in the directory..
108 | *
109 | */
110 | override fun count(): Int {
111 | return file.listFiles()?.size ?: 0
112 | }
113 |
114 | // Return a file if exists, else **null**
115 | override fun findFile(name: String, ignoreCase: Boolean): DocumentFileCompat? {
116 | return listFiles().firstOrNull { file -> file.name.isNotEmpty() && file.name == name }
117 | }
118 |
119 | // Copies current file to the provided destination uri.
120 | override fun copyTo(destination: Uri) {
121 | val outPutStream = context.contentResolver.openOutputStream(destination)!!
122 | file.inputStream().use { inputStream -> inputStream.copyTo(outPutStream) }
123 | }
124 |
125 | // Copies current source file at current uri's location.
126 | override fun copyFrom(source: Uri) {
127 | val inputStream = context.contentResolver.openInputStream(source)!!
128 | inputStream.use { stream -> stream.copyTo(file.outputStream()) }
129 | }
130 |
131 | internal companion object {
132 | internal fun getMimeType(file: File): String {
133 | if (file.isDirectory) return ""
134 |
135 | val mimeTypeMap = MimeTypeMap.getSingleton()
136 | val mimeType = mimeTypeMap.getMimeTypeFromExtension(file.extension)
137 | if (mimeType != null) return mimeType
138 |
139 | return "application/octet-stream"
140 | }
141 | }
142 | }
--------------------------------------------------------------------------------
/dfc/src/main/java/com/lazygeniouz/dfc/file/internals/SingleDocumentFileCompat.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.dfc.file.internals
2 |
3 | import android.content.Context
4 | import android.net.Uri
5 | import com.lazygeniouz.dfc.file.DocumentFileCompat
6 | import com.lazygeniouz.dfc.resolver.ResolverCompat
7 |
8 | /**
9 | * SingleFileCompat serves as an alternative to the **SingleDocumentFile**
10 | * which handles Documents having **NO** Tree structure, i.e. Just Files.
11 | *
12 | *
13 | * @param context Context required by the DocumentFileCompat internally.
14 | *
15 | * Other params same as [DocumentFileCompat].
16 | */
17 | internal class SingleDocumentFileCompat(
18 | context: Context, documentUri: Uri, documentName: String = "", documentSize: Long = 0,
19 | lastModifiedTime: Long = -1L, documentMimeType: String = "", documentFlags: Int = -1,
20 | ) : DocumentFileCompat(
21 | context, documentUri, documentName, documentSize,
22 | lastModifiedTime, documentFlags, documentMimeType
23 | ) {
24 |
25 | /**
26 | * Cannot create a File without a Parent Directory Uri.
27 | *
28 | * @throws UnsupportedOperationException
29 | */
30 | override fun createFile(mimeType: String, name: String): DocumentFileCompat? {
31 | throw UnsupportedOperationException()
32 | }
33 |
34 | /**
35 | * Cannot create a Directory without a Parent Directory Uri.
36 | *
37 | * @throws UnsupportedOperationException
38 | */
39 | override fun createDirectory(name: String): DocumentFileCompat? {
40 | throw UnsupportedOperationException()
41 | }
42 |
43 | /**
44 | * Cannot iterate a single document.
45 | *
46 | * @throws UnsupportedOperationException
47 | */
48 | override fun listFiles(): List {
49 | throw UnsupportedOperationException()
50 | }
51 |
52 | /**
53 | * No [listFiles], no children, no count.
54 | *
55 | * @throws UnsupportedOperationException
56 | */
57 | override fun count(): Int {
58 | throw UnsupportedOperationException()
59 | }
60 |
61 | /**
62 | * No [listFiles] so no iterating to search for something..
63 | *
64 | * @throws UnsupportedOperationException
65 | */
66 | override fun findFile(name: String, ignoreCase: Boolean): DocumentFileCompat? {
67 | throw UnsupportedOperationException()
68 | }
69 |
70 | /**
71 | * [SingleDocumentFileCompat] has limited access and permissions to the [uri].
72 | *
73 | * @throws UnsupportedOperationException
74 | */
75 | override fun renameTo(name: String): Boolean {
76 | throw UnsupportedOperationException()
77 | }
78 |
79 | // Copies current file to the destination uri.
80 | override fun copyTo(destination: Uri) {
81 | val inputStream = context.contentResolver.openInputStream(uri)!!
82 | val outputStream = context.contentResolver.openOutputStream(destination)!!
83 | inputStream.use { stream -> stream.copyTo(outputStream) }
84 | }
85 |
86 | // Copies current source uri at this uri's location.
87 | override fun copyFrom(source: Uri) {
88 | val inputStream = context.contentResolver.openInputStream(source)!!
89 | val outputStream = context.contentResolver.openOutputStream(uri)!!
90 | inputStream.use { stream -> stream.copyTo(outputStream) }
91 | }
92 |
93 | internal companion object {
94 |
95 | /**
96 | * Build a [SingleDocumentFileCompat] from a given [uri].
97 | */
98 | internal fun make(context: Context, self: Uri): SingleDocumentFileCompat? {
99 | ResolverCompat.getCursor(context, self, ResolverCompat.fullProjection)
100 | ?.use { cursor ->
101 | if (cursor.moveToFirst()) {
102 | val documentName: String = cursor.getString(1)
103 | val documentSize: Long = cursor.getLong(2)
104 | val documentLastModified: Long = cursor.getLong(3)
105 | val documentMimeType: String = cursor.getString(4)
106 | val documentFlags: Int = cursor.getLong(5).toInt()
107 |
108 | return SingleDocumentFileCompat(
109 | context, self,
110 | documentName, documentSize,
111 | documentLastModified, documentMimeType, documentFlags
112 | )
113 | }
114 | }
115 |
116 | return null
117 | }
118 | }
119 | }
--------------------------------------------------------------------------------
/dfc/src/main/java/com/lazygeniouz/dfc/file/internals/TreeDocumentFileCompat.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.dfc.file.internals
2 |
3 | import android.content.Context
4 | import android.net.Uri
5 | import android.provider.DocumentsContract
6 | import android.provider.DocumentsContract.Document.MIME_TYPE_DIR
7 | import com.lazygeniouz.dfc.file.DocumentFileCompat
8 | import com.lazygeniouz.dfc.resolver.ResolverCompat
9 |
10 | /**
11 | * TreeFileCompat serves as an alternative to the **TreeDocumentFile**
12 | * which handles Documents having a Tree structure.
13 | *
14 | * For example: Listing files in a Directory, Creating Files & Directories, etc.
15 | *
16 | * @param context Context required by the DocumentFileCompat internally.
17 | *
18 | * Other params same as [DocumentFileCompat].
19 | */
20 | internal class TreeDocumentFileCompat constructor(
21 | context: Context, documentUri: Uri, documentName: String = "", documentSize: Long = 0,
22 | lastModifiedTime: Long = -1L, documentMimeType: String = "", documentFlags: Int = -1,
23 | ) : DocumentFileCompat(
24 | context, documentUri, documentName, documentSize,
25 | lastModifiedTime, documentFlags, documentMimeType
26 | ) {
27 |
28 | /**
29 | * Create a document file.
30 | *
31 | * @param mimeType Type of the file, e.g: text/plain.
32 | * @param name The name of the file.
33 | *
34 | * @return A DocumentFileCompat object if file was created successfully, **null** otherwise.
35 | */
36 | override fun createFile(mimeType: String, name: String): DocumentFileCompat? {
37 | val treeFileUri = fileController.createFile(mimeType, name)
38 | return treeFileUri?.let { make(context, treeFileUri, false) }
39 | }
40 |
41 | /**
42 | * Create a Directory.
43 | *
44 | * @param name The name of the file.
45 | *
46 | * @return A DocumentFileCompat object if directory was created successfully, **null** otherwise.
47 | */
48 | override fun createDirectory(name: String): DocumentFileCompat? {
49 | val treeFileUri = fileController.createFile(MIME_TYPE_DIR, name)
50 | return treeFileUri?.let { make(context, treeFileUri, false) }
51 | }
52 |
53 | /**
54 | * This will return a list of [DocumentFileCompat] with all the defined fields.
55 | */
56 | override fun listFiles(): List {
57 | return fileController.listFiles()
58 | }
59 |
60 | /**
61 | * This will return the children count in the directory.
62 | *
63 | * More optimised than using [List.size] via [listFiles].
64 | *
65 | */
66 | override fun count(): Int {
67 | return fileController.count()
68 | }
69 |
70 | /**
71 | * Return a file if exists, else **null**.
72 | */
73 | override fun findFile(name: String, ignoreCase: Boolean): DocumentFileCompat? {
74 | return listFiles().firstOrNull { file ->
75 | file.name.equals(name, ignoreCase = ignoreCase)
76 | }
77 | }
78 |
79 | /**
80 | * A [TreeDocumentFileCompat] has a wider range of permissions & hence supports rename.
81 | *
82 | * @return True if the rename was successful, False otherwise.
83 | */
84 | override fun renameTo(name: String): Boolean {
85 | val newUri = fileController.renameTo(name)
86 | if (newUri != null) uri = newUri
87 | return newUri != null
88 | }
89 |
90 | /**
91 | * Copy would work only if the underlying Uri is a SingleDocumentFile or a File.
92 | */
93 | override fun copyTo(destination: Uri) {
94 | throw UnsupportedOperationException("Cannot open a stream on a tree")
95 | }
96 |
97 | /**
98 | * Copy would work only if the underlying Uri is a SingleDocumentFile or a File.
99 | */
100 | override fun copyFrom(source: Uri) {
101 | throw UnsupportedOperationException("Cannot open a stream on a tree")
102 | }
103 |
104 | internal companion object {
105 |
106 | /**
107 | * Return whether the given [uri] is a tree uri.
108 | */
109 | private fun isTreeUri(uri: Uri): Boolean {
110 | val paths = uri.pathSegments
111 | return paths.size >= 2 && "tree" == paths[0]
112 | }
113 |
114 | /**
115 | * Build the initial [TreeDocumentFileCompat] from a given [uri].
116 | */
117 | internal fun make(context: Context, uri: Uri, isInitial: Boolean): TreeDocumentFileCompat? {
118 | if (!isTreeUri(uri)) {
119 | throw UnsupportedOperationException("Document Uri is not a Tree uri.")
120 | }
121 |
122 | // build a new tree uri if this is a first tree doc creation...
123 | val treeUri = if (isInitial) DocumentsContract.buildDocumentUriUsingTree(
124 | uri, DocumentsContract.getTreeDocumentId(uri)
125 | ) else uri
126 |
127 | ResolverCompat.getCursor(context, treeUri, ResolverCompat.fullProjection)
128 | ?.use { cursor ->
129 | if (cursor.moveToFirst()) {
130 | val documentName: String = cursor.getString(1)
131 | val documentSize: Long = cursor.getLong(2)
132 | val documentLastModified: Long = cursor.getLong(3)
133 | val documentMimeType: String = cursor.getString(4)
134 | val documentFlags: Int = cursor.getLong(5).toInt()
135 |
136 | return TreeDocumentFileCompat(
137 | context, treeUri,
138 | documentName, documentSize,
139 | documentLastModified, documentMimeType, documentFlags
140 | )
141 | }
142 | }
143 |
144 | return null
145 | }
146 | }
147 | }
--------------------------------------------------------------------------------
/dfc/src/main/java/com/lazygeniouz/dfc/logger/ErrorLogger.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.dfc.logger
2 |
3 | import android.util.Log
4 |
5 | /**
6 | * A logging utility class.
7 | */
8 | object ErrorLogger {
9 |
10 | /**
11 | * Log error to the logcat to let the developer know if something went wrong.
12 | */
13 | internal fun logError(message: String, throwable: Throwable?) {
14 | Log.e("DocumentFileCompat", "$message: ${throwable?.message}")
15 | }
16 | }
--------------------------------------------------------------------------------
/dfc/src/main/java/com/lazygeniouz/dfc/resolver/ResolverCompat.kt:
--------------------------------------------------------------------------------
1 | package com.lazygeniouz.dfc.resolver
2 |
3 | import android.content.ContentResolver
4 | import android.content.Context
5 | import android.database.Cursor
6 | import android.net.Uri
7 | import android.provider.DocumentsContract
8 | import com.lazygeniouz.dfc.file.DocumentFileCompat
9 | import com.lazygeniouz.dfc.file.internals.TreeDocumentFileCompat
10 | import com.lazygeniouz.dfc.logger.ErrorLogger
11 |
12 | /**
13 | * Helper class for calling relevant methods on [DocumentsContract] & queries via [ContentResolver].
14 | */
15 | internal object ResolverCompat {
16 |
17 | private val iconProjection = arrayOf(DocumentsContract.Document.COLUMN_ICON)
18 | private val idProjection = arrayOf(DocumentsContract.Document.COLUMN_DOCUMENT_ID)
19 | val fullProjection = arrayOf(
20 | DocumentsContract.Document.COLUMN_DOCUMENT_ID,
21 | DocumentsContract.Document.COLUMN_DISPLAY_NAME,
22 | DocumentsContract.Document.COLUMN_SIZE,
23 | DocumentsContract.Document.COLUMN_LAST_MODIFIED,
24 | DocumentsContract.Document.COLUMN_MIME_TYPE,
25 | DocumentsContract.Document.COLUMN_FLAGS
26 | )
27 |
28 | /**
29 | * Delete the file.
30 | *
31 | * @return True if deletion succeeded, False otherwise
32 | */
33 | internal fun deleteDocument(context: Context, uri: Uri): Boolean {
34 | return try {
35 | DocumentsContract.deleteDocument(context.contentResolver, uri)
36 | } catch (exception: Exception) {
37 | ErrorLogger.logError("Exception while deleting document", exception)
38 | false
39 | }
40 | }
41 |
42 | /**
43 | * Rename a Document File / Folder.
44 | *
45 | * Returns True if the rename was successful, False otherwise.
46 | */
47 | internal fun renameTo(context: Context, uri: Uri, name: String): Uri? {
48 | return try {
49 | return DocumentsContract.renameDocument(context.contentResolver, uri, name)
50 | } catch (exception: Exception) {
51 | ErrorLogger.logError("Exception while renaming document", exception)
52 | null
53 | }
54 | }
55 |
56 | /**
57 | * Create a document file.
58 | *
59 | * @param mimeType Type of the file, e.g: text/plain.
60 | * @param name The name of the file.
61 | *
62 | * @return A Uri if file was created successfully, **null** if any exception was caught.
63 | */
64 | internal fun createFile(context: Context, uri: Uri, mimeType: String, name: String): Uri? {
65 | return try {
66 | DocumentsContract.createDocument(context.contentResolver, uri, mimeType, name)
67 | } catch (exception: Exception) {
68 | ErrorLogger.logError("Exception while creating a document", exception)
69 | null
70 | }
71 | }
72 |
73 | /**
74 | * Returns the children count without creating [DocumentFileCompat] objects.
75 | *
76 | * **Local Test Result**: [DocumentsContract.Document.COLUMN_ICON] was the fastest on a directory
77 | * of 824 items, more than 2x against `listFiles().size`.
78 | *
79 | * - Min: 0.275, Max: 0.613 (listFiles().size)
80 | * - Avg: 0.444, Diff: 0.338, % Change: 55.14
81 | */
82 | internal fun count(context: Context, uri: Uri): Int {
83 | val childrenUri = createChildrenUri(uri)
84 | return getCursor(
85 | context,
86 | childrenUri,
87 | iconProjection
88 | )?.use { cursor -> return cursor.count } ?: 0
89 | }
90 |
91 | /**
92 | * Returns True if the Document Folder / File exists, False otherwise.
93 | */
94 | internal fun exists(context: Context, uri: Uri): Boolean {
95 | return try {
96 | getCursor(context, uri, idProjection)?.use { cursor ->
97 | cursor.count > 0
98 | } ?: false
99 | } catch (exception: Exception) {
100 | ErrorLogger.logError("Exception while checking if the uri exists", exception)
101 | false
102 | }
103 | }
104 |
105 | /**
106 | * Queries the ContentResolver & builds a list of [DocumentFileCompat] with all the required fields.
107 | */
108 | internal fun listFiles(context: Context, file: DocumentFileCompat): List {
109 | val uri = file.uri
110 | val childrenUri = createChildrenUri(uri)
111 | val listOfDocuments = arrayListOf()
112 |
113 | getCursor(context, childrenUri, fullProjection)?.use { cursor ->
114 | val itemCount = cursor.count
115 | /**
116 | * Pre-sizing the list to avoid resizing overhead.
117 | * This is especially beneficial for directories with a large number of files.
118 | *
119 | * Memory comparison for 8192 files:
120 | * 1. With pre-sizing: 3.10 MB
121 | * 2. Without pre-sizing: 9.60 MB
122 | */
123 | if (itemCount > 10) listOfDocuments.ensureCapacity(itemCount)
124 |
125 | while (cursor.moveToNext()) {
126 | val documentId: String = cursor.getString(0)
127 | val documentUri = DocumentsContract.buildDocumentUriUsingTree(uri, documentId)
128 |
129 | val documentName: String = cursor.getString(1)
130 | val documentSize: Long = cursor.getLong(2)
131 | val documentLastModified: Long = cursor.getLong(3)
132 | val documentMimeType: String = cursor.getString(4)
133 | val documentFlags: Int = cursor.getLong(5).toInt()
134 |
135 | TreeDocumentFileCompat(
136 | context, documentUri, documentName,
137 | documentSize, documentLastModified,
138 | documentMimeType, documentFlags
139 | ).also { childFile ->
140 | childFile.parentFile = file
141 | listOfDocuments.add(childFile)
142 | }
143 | }
144 | }
145 |
146 | return listOfDocuments
147 | }
148 |
149 | /**
150 | * Get [Cursor] from [ContentResolver.query] with given [projection] on a given [uri].
151 | */
152 | fun getCursor(context: Context, uri: Uri, projection: Array): Cursor? {
153 | return try {
154 | context.contentResolver.query(
155 | uri, projection, null, null, null
156 | )
157 | } catch (exception: Exception) {
158 | /**
159 | * This exception can occur in scenarios such as -
160 | *
161 | * - The Uri became invalid due to external changes (e.g., permissions revoked, storage unmounted, etc).
162 | * - The file or directory represented by this Uri was probably deleted or became `inaccessible` after the Uri was obtained but before this operation was performed.
163 | */
164 | ErrorLogger.logError("Exception while building the Cursor", exception)
165 | null
166 | }
167 | }
168 |
169 | // Make children uri for query.
170 | private fun createChildrenUri(uri: Uri): Uri {
171 | return DocumentsContract.buildChildDocumentsUriUsingTree(
172 | uri, DocumentsContract.getDocumentId(uri)
173 | )
174 | }
175 | }
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | android.useAndroidX=true
2 | kotlin.code.style=official
3 | android.enableJetifier=true
4 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
5 |
6 | android.nonFinalResIds=false
7 | android.nonTransitiveRClass=false
8 | android.defaults.buildfeatures.buildconfig=true
9 |
10 | POM_PACKAGING=aar
11 | POM_NAME=dfc
12 | POM_ARTIFACT_ID=dfc
13 | POM_DESCRIPTION=A faster alternative to AndroidX's DocumentFile
14 | POM_INCEPTION_YEAR=2021
15 | POM_URL=https://github.com/ItzNotABug/DocumentFileCompat
16 | POM_SCM_URL=https://github.com/ItzNotABug/DocumentFileCompat
17 | POM_SCM_CONNECTION=scm:git@github.com:itznotabug/DocumentFileCompat.git
18 | POM_SCM_DEV_CONNECTION=scm:git@github.com:itznotabug/DocumentFileCompat.git
19 |
20 | POM_LICENCE_NAME=The Apache Software License, Version 2.0
21 | POM_LICENCE_URL=http://www.apache.org/licenses/LICENSE-2.0.txt
22 | POM_LICENCE_DIST=repo
23 |
24 | POM_DEVELOPER_ID=itznotabug
25 | POM_DEVELOPER_NAME=Darshan Pandya
26 | POM_DEVELOPER_URL=https://github.com/itznotabug
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | #
4 | # Copyright © 2015-2021 the original authors.
5 | #
6 | # Licensed under the Apache License, Version 2.0 (the "License");
7 | # you may not use this file except in compliance with the License.
8 | # You may obtain a copy of the License at
9 | #
10 | # https://www.apache.org/licenses/LICENSE-2.0
11 | #
12 | # Unless required by applicable law or agreed to in writing, software
13 | # distributed under the License is distributed on an "AS IS" BASIS,
14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | # See the License for the specific language governing permissions and
16 | # limitations under the License.
17 | #
18 | # SPDX-License-Identifier: Apache-2.0
19 | #
20 |
21 | ##############################################################################
22 | #
23 | # Gradle start up script for POSIX generated by Gradle.
24 | #
25 | # Important for running:
26 | #
27 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
28 | # noncompliant, but you have some other compliant shell such as ksh or
29 | # bash, then to run this script, type that shell name before the whole
30 | # command line, like:
31 | #
32 | # ksh Gradle
33 | #
34 | # Busybox and similar reduced shells will NOT work, because this script
35 | # requires all of these POSIX shell features:
36 | # * functions;
37 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
38 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»;
39 | # * compound commands having a testable exit status, especially «case»;
40 | # * various built-in commands including «command», «set», and «ulimit».
41 | #
42 | # Important for patching:
43 | #
44 | # (2) This script targets any POSIX shell, so it avoids extensions provided
45 | # by Bash, Ksh, etc; in particular arrays are avoided.
46 | #
47 | # The "traditional" practice of packing multiple parameters into a
48 | # space-separated string is a well documented source of bugs and security
49 | # problems, so this is (mostly) avoided, by progressively accumulating
50 | # options in "$@", and eventually passing that to Java.
51 | #
52 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
53 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
54 | # see the in-line comments for details.
55 | #
56 | # There are tweaks for specific operating systems such as AIX, CygWin,
57 | # Darwin, MinGW, and NonStop.
58 | #
59 | # (3) This script is generated from the Groovy template
60 | # https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
61 | # within the Gradle project.
62 | #
63 | # You can find Gradle at https://github.com/gradle/gradle/.
64 | #
65 | ##############################################################################
66 |
67 | # Attempt to set APP_HOME
68 |
69 | # Resolve links: $0 may be a link
70 | app_path=$0
71 |
72 | # Need this for daisy-chained symlinks.
73 | while
74 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
75 | [ -h "$app_path" ]
76 | do
77 | ls=$( ls -ld "$app_path" )
78 | link=${ls#*' -> '}
79 | case $link in #(
80 | /*) app_path=$link ;; #(
81 | *) app_path=$APP_HOME$link ;;
82 | esac
83 | done
84 |
85 | # This is normally unused
86 | # shellcheck disable=SC2034
87 | APP_BASE_NAME=${0##*/}
88 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
89 | APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
90 | ' "$PWD" ) || exit
91 |
92 | # Use the maximum available, or set MAX_FD != -1 to use that value.
93 | MAX_FD=maximum
94 |
95 | warn () {
96 | echo "$*"
97 | } >&2
98 |
99 | die () {
100 | echo
101 | echo "$*"
102 | echo
103 | exit 1
104 | } >&2
105 |
106 | # OS specific support (must be 'true' or 'false').
107 | cygwin=false
108 | msys=false
109 | darwin=false
110 | nonstop=false
111 | case "$( uname )" in #(
112 | CYGWIN* ) cygwin=true ;; #(
113 | Darwin* ) darwin=true ;; #(
114 | MSYS* | MINGW* ) msys=true ;; #(
115 | NONSTOP* ) nonstop=true ;;
116 | esac
117 |
118 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
119 |
120 |
121 | # Determine the Java command to use to start the JVM.
122 | if [ -n "$JAVA_HOME" ] ; then
123 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
124 | # IBM's JDK on AIX uses strange locations for the executables
125 | JAVACMD=$JAVA_HOME/jre/sh/java
126 | else
127 | JAVACMD=$JAVA_HOME/bin/java
128 | fi
129 | if [ ! -x "$JAVACMD" ] ; then
130 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
131 |
132 | Please set the JAVA_HOME variable in your environment to match the
133 | location of your Java installation."
134 | fi
135 | else
136 | JAVACMD=java
137 | if ! command -v java >/dev/null 2>&1
138 | then
139 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
140 |
141 | Please set the JAVA_HOME variable in your environment to match the
142 | location of your Java installation."
143 | fi
144 | fi
145 |
146 | # Increase the maximum file descriptors if we can.
147 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
148 | case $MAX_FD in #(
149 | max*)
150 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
151 | # shellcheck disable=SC2039,SC3045
152 | MAX_FD=$( ulimit -H -n ) ||
153 | warn "Could not query maximum file descriptor limit"
154 | esac
155 | case $MAX_FD in #(
156 | '' | soft) :;; #(
157 | *)
158 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
159 | # shellcheck disable=SC2039,SC3045
160 | ulimit -n "$MAX_FD" ||
161 | warn "Could not set maximum file descriptor limit to $MAX_FD"
162 | esac
163 | fi
164 |
165 | # Collect all arguments for the java command, stacking in reverse order:
166 | # * args from the command line
167 | # * the main class name
168 | # * -classpath
169 | # * -D...appname settings
170 | # * --module-path (only if needed)
171 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
172 |
173 | # For Cygwin or MSYS, switch paths to Windows format before running java
174 | if "$cygwin" || "$msys" ; then
175 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
176 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
177 |
178 | JAVACMD=$( cygpath --unix "$JAVACMD" )
179 |
180 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
181 | for arg do
182 | if
183 | case $arg in #(
184 | -*) false ;; # don't mess with options #(
185 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
186 | [ -e "$t" ] ;; #(
187 | *) false ;;
188 | esac
189 | then
190 | arg=$( cygpath --path --ignore --mixed "$arg" )
191 | fi
192 | # Roll the args list around exactly as many times as the number of
193 | # args, so each arg winds up back in the position where it started, but
194 | # possibly modified.
195 | #
196 | # NB: a `for` loop captures its iteration list before it begins, so
197 | # changing the positional parameters here affects neither the number of
198 | # iterations, nor the values presented in `arg`.
199 | shift # remove old arg
200 | set -- "$@" "$arg" # push replacement arg
201 | done
202 | fi
203 |
204 |
205 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
206 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
207 |
208 | # Collect all arguments for the java command:
209 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
210 | # and any embedded shellness will be escaped.
211 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
212 | # treated as '${Hostname}' itself on the command line.
213 |
214 | set -- \
215 | "-Dorg.gradle.appname=$APP_BASE_NAME" \
216 | -classpath "$CLASSPATH" \
217 | org.gradle.wrapper.GradleWrapperMain \
218 | "$@"
219 |
220 | # Stop when "xargs" is not available.
221 | if ! command -v xargs >/dev/null 2>&1
222 | then
223 | die "xargs is not available"
224 | fi
225 |
226 | # Use "xargs" to parse quoted args.
227 | #
228 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
229 | #
230 | # In Bash we could simply go:
231 | #
232 | # readarray ARGS < <( xargs -n1 <<<"$var" ) &&
233 | # set -- "${ARGS[@]}" "$@"
234 | #
235 | # but POSIX shell has neither arrays nor command substitution, so instead we
236 | # post-process each arg (as a line of input to sed) to backslash-escape any
237 | # character that might be a shell metacharacter, then use eval to reverse
238 | # that process (while maintaining the separation between arguments), and wrap
239 | # the whole thing up as a single "set" statement.
240 | #
241 | # This will of course break if any of these variables contains a newline or
242 | # an unmatched quote.
243 | #
244 |
245 | eval "set -- $(
246 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
247 | xargs -n1 |
248 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
249 | tr '\n' ' '
250 | )" '"$@"'
251 |
252 | exec "$JAVACMD" "$@"
253 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @rem
2 | @rem Copyright 2015 the original author or authors.
3 | @rem
4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
5 | @rem you may not use this file except in compliance with the License.
6 | @rem You may obtain a copy of the License at
7 | @rem
8 | @rem https://www.apache.org/licenses/LICENSE-2.0
9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 | @rem SPDX-License-Identifier: Apache-2.0
17 | @rem
18 |
19 | @if "%DEBUG%"=="" @echo off
20 | @rem ##########################################################################
21 | @rem
22 | @rem Gradle startup script for Windows
23 | @rem
24 | @rem ##########################################################################
25 |
26 | @rem Set local scope for the variables with windows NT shell
27 | if "%OS%"=="Windows_NT" setlocal
28 |
29 | set DIRNAME=%~dp0
30 | if "%DIRNAME%"=="" set DIRNAME=.
31 | @rem This is normally unused
32 | set APP_BASE_NAME=%~n0
33 | set APP_HOME=%DIRNAME%
34 |
35 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
36 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
37 |
38 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
39 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
40 |
41 | @rem Find java.exe
42 | if defined JAVA_HOME goto findJavaFromJavaHome
43 |
44 | set JAVA_EXE=java.exe
45 | %JAVA_EXE% -version >NUL 2>&1
46 | if %ERRORLEVEL% equ 0 goto execute
47 |
48 | echo. 1>&2
49 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
50 | echo. 1>&2
51 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2
52 | echo location of your Java installation. 1>&2
53 |
54 | goto fail
55 |
56 | :findJavaFromJavaHome
57 | set JAVA_HOME=%JAVA_HOME:"=%
58 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
59 |
60 | if exist "%JAVA_EXE%" goto execute
61 |
62 | echo. 1>&2
63 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
64 | echo. 1>&2
65 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2
66 | echo location of your Java installation. 1>&2
67 |
68 | goto fail
69 |
70 | :execute
71 | @rem Setup the command line
72 |
73 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
74 |
75 |
76 | @rem Execute Gradle
77 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
78 |
79 | :end
80 | @rem End local scope for the variables with windows NT shell
81 | if %ERRORLEVEL% equ 0 goto mainEnd
82 |
83 | :fail
84 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
85 | rem the _cmd.exe /c_ return code!
86 | set EXIT_CODE=%ERRORLEVEL%
87 | if %EXIT_CODE% equ 0 set EXIT_CODE=1
88 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
89 | exit /b %EXIT_CODE%
90 |
91 | :mainEnd
92 | if "%OS%"=="Windows_NT" endlocal
93 |
94 | :omega
95 |
--------------------------------------------------------------------------------
/screenshots/filecompat_directory_perf.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/screenshots/filecompat_directory_perf.jpeg
--------------------------------------------------------------------------------
/screenshots/filecompat_file_perf.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ItzNotABug/DocumentFileCompat/d814b43605c6cae45514ada1ac87a4e26660a4f5/screenshots/filecompat_file_perf.jpeg
--------------------------------------------------------------------------------
/settings.gradle:
--------------------------------------------------------------------------------
1 | include ':app'
2 | include ':dfc'
3 | rootProject.name = "FileCompat"
4 |
--------------------------------------------------------------------------------