Skip to content

Make COLUMN_DOCUMENT_ID optional when using with listFiles #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexcmgit merged 4 commits into from
May 31, 2022
Merged

Make COLUMN_DOCUMENT_ID optional when using with listFiles #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2881d11
(#50) Query `COLUMN_DOCUMENT_ID` even when not requested
May 30, 2022
ce1d518
(#50) Warn that `DocumentFileColumn.id` is optional on `listFiles` docs
May 31, 2022
4396a8e
(#50) Fix bug by using `projection` var (computed columns) rather raw…
May 31, 2022
a3d426e
(#50) Add comment on `/example` at `listFiles` usage
May 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions .../src/main/kotlin/io/lakscastro/sharedstorage/storageaccessframework/lib/DocumentCommon.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@ import android.os.Build
import android.provider.DocumentsContract
import android.util.Base64
import androidx.annotation.RequiresApi
import androidx.annotation.RestrictTo
import androidx.documentfile.provider.DocumentFile
import io.lakscastro.sharedstorage.plugin.API_19
import io.lakscastro.sharedstorage.plugin.API_21
import io.lakscastro.sharedstorage.plugin.API_24
import java.io.ByteArrayOutputStream
import java.io.Closeable
import java.io.File

/**
* Helper class to make more easy to handle callbacks using Kotlin syntax
Expand Down Expand Up @@ -174,12 +172,17 @@ fun traverseDirectoryEntries(
while (dirNodes.isNotEmpty()) {
val (parent, children) = dirNodes.removeAt(0)

val requiredColumns = if (rootOnly) emptyArray() else arrayOf(
DocumentsContract.Document.COLUMN_MIME_TYPE,
DocumentsContract.Document.COLUMN_DOCUMENT_ID
)
val requiredColumns =
if (rootOnly) emptyArray() else arrayOf(DocumentsContract.Document.COLUMN_MIME_TYPE)

val intrinsicColumns =
arrayOf(DocumentsContract.Document.COLUMN_DOCUMENT_ID)

val projection = arrayOf(*columns, *requiredColumns).toSet().toTypedArray()
val projection = arrayOf(
*columns,
*requiredColumns,
*intrinsicColumns
).toSet().toTypedArray()

val cursor = contentResolver.query(
children,
Expand All @@ -198,7 +201,7 @@ fun traverseDirectoryEntries(
while (cursor.moveToNext()) {
val data = mutableMapOf<String, Any>()

for (column in columns) {
for (column in projection) {
data[column] = cursorHandlerOf(typeOfColumn(column)!!)(
cursor,
cursor.getColumnIndexOrThrow(column)
Expand All @@ -220,7 +223,7 @@ fun traverseDirectoryEntries(
)
)

if (isDirectory != null && isDirectory && !rootOnly) {
if (isDirectory == true && !rootOnly) {
val nextChildren =
DocumentsContract.buildChildDocumentsUriUsingTree(rootUri, id)

Expand Down
4 changes: 3 additions & 1 deletion docs/Usage/Storage Access Framework.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ if (grantedUri != null) {

This method list files lazily **over a granted uri:**

> **Info** `DocumentFileColumn.id` is optional. It is required to fetch the file list from native API. So it is enabled regardless if you include this column or not. And this applies only to this API (`listFiles`).

```dart
/// *Must* be a granted uri from `openDocumentTree`
final Uri myGrantedUri = ...
Expand All @@ -83,7 +85,7 @@ const List<DocumentFileColumn> columns = <DocumentFileColumn>[
DocumentFileColumn.displayName,
DocumentFileColumn.size,
DocumentFileColumn.lastModified,
DocumentFileColumn.id,
DocumentFileColumn.id, // Optional column, will be available/queried regardless if is or not included here
DocumentFileColumn.mimeType,
];

Expand Down
1 change: 1 addition & 0 deletions example/lib/screens/folder_files/folder_file_list.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ class _FolderFileListState extends State<FolderFileList> {
DocumentFileColumn.displayName,
DocumentFileColumn.size,
DocumentFileColumn.lastModified,
// Optional column (this can't be removed because it's required to list files)
DocumentFileColumn.id,
DocumentFileColumn.mimeType,
];
Expand Down