-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
47 changed files
with
803 additions
and
441 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
184 changes: 43 additions & 141 deletions
184
commons/src/main/java/fr/geonature/commons/util/FileUtils.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,155 +1,57 @@ | ||
| package fr.geonature.commons.util | ||
|
|
||
| import android.content.Context | ||
| import android.os.Environment | ||
| import android.util.Log | ||
| import fr.geonature.commons.model.MountPoint | ||
| import fr.geonature.commons.util.MountPointUtils.getExternalStorage | ||
| import fr.geonature.commons.util.MountPointUtils.getInternalStorage | ||
| import fr.geonature.mountpoint.model.MountPoint | ||
| import fr.geonature.mountpoint.util.FileUtils | ||
| import fr.geonature.mountpoint.util.MountPointUtils.getInternalStorage | ||
| import java.io.File | ||
|
|
||
| /** | ||
| * Helpers for [File] utilities. | ||
| * | ||
| * @author [S. Grimault](mailto:[email protected]) | ||
| */ | ||
| object FileUtils { | ||
|
|
||
| private val TAG = FileUtils::class.java.name | ||
|
|
||
| /** | ||
| * Construct a file from the set of name elements. | ||
| * | ||
| * @param directory the parent directory | ||
| * @param names the name elements | ||
| * | ||
| * @return the corresponding file | ||
| */ | ||
| fun getFile( | ||
| directory: File, | ||
| vararg names: String | ||
| ): File { | ||
|
|
||
| var file = directory | ||
|
|
||
| for (name in names) { | ||
| file = File( | ||
| file, | ||
| name | ||
| ) | ||
| } | ||
|
|
||
| return file | ||
| } | ||
|
|
||
| /** | ||
| * Gets the relative path used by given package ID. | ||
| * | ||
| * @param packageId the package ID | ||
| * | ||
| * @return the relative path | ||
| */ | ||
| fun getRelativeSharedPath(packageId: String): String { | ||
| return arrayOf( | ||
| "Android", | ||
| "data", | ||
| packageId | ||
| ).joinToString( | ||
| File.separator, | ||
| "", | ||
| File.separator | ||
| ) | ||
| } | ||
| /** | ||
| * Gets the `inputs/` folder as `File` from given package ID. | ||
| * If package ID is `null` use given context. | ||
| * The relative path used is `inputs/<package_name>` | ||
| * | ||
| * @param context the current `Context` | ||
| * @param packageId the package ID (may be `null`) | ||
| * | ||
| * @return the `inputs/` folder as `File` | ||
| */ | ||
| fun FileUtils.getInputsFolder( | ||
| context: Context, | ||
| packageId: String? = null | ||
| ): File { | ||
|
|
||
| return getFile( | ||
| getInternalStorage().mountPath, | ||
| getRelativeSharedPath(if (packageId.isNullOrBlank()) context.packageName else packageId), | ||
| "inputs" | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Tries to find the mount point used by external storage as `File`. | ||
| * If not, returns the default `Environment.getExternalStorageDirectory()`. | ||
| * | ||
| * @param context the current `Context` | ||
| * | ||
| * @return the mount point as `File` used by external storage if available | ||
| */ | ||
| fun getExternalStorageDirectory(context: Context): File { | ||
| /** | ||
| * Gets the `databases/` folder as `File` used by this context. | ||
| * | ||
| * @param context the current `Context` | ||
| * @param storageType the [MountPoint.StorageType] to use | ||
| * | ||
| * @return the `databases/` folder | ||
| */ | ||
| fun FileUtils.getDatabaseFolder( | ||
| context: Context, | ||
| storageType: MountPoint.StorageType | ||
| ): File { | ||
|
|
||
| val externalMountPoint = getExternalStorage( | ||
| return getFile( | ||
| getRootFolder( | ||
| context, | ||
| Environment.MEDIA_MOUNTED, | ||
| Environment.MEDIA_MOUNTED_READ_ONLY | ||
| ) | ||
|
|
||
| if (externalMountPoint == null) { | ||
| Log.w( | ||
| TAG, | ||
| "getExternalStorageDirectory: external mount point is not available. Use default: " + getInternalStorage() | ||
| ) | ||
|
|
||
| return getInternalStorage().mountPath | ||
| } | ||
|
|
||
| return externalMountPoint.mountPath | ||
| } | ||
|
|
||
| /** | ||
| * Gets the root folder as `File` used by this context. | ||
| * | ||
| * @param context the current `Context` | ||
| * @param storageType the [MountPoint.StorageType] to use | ||
| * | ||
| * @return the root folder as `File` | ||
| */ | ||
| fun getRootFolder( | ||
| context: Context, | ||
| storageType: MountPoint.StorageType | ||
| ): File { | ||
|
|
||
| return getFile( | ||
| if (storageType === MountPoint.StorageType.EXTERNAL) getExternalStorageDirectory(context) | ||
| else getInternalStorage().mountPath, | ||
| getRelativeSharedPath(context.packageName) | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Gets the `inputs/` folder as `File` from given package ID. | ||
| * If package ID is `null` use given context. | ||
| * The relative path used is `inputs/<package_name>` | ||
| * | ||
| * @param context the current `Context` | ||
| * @param packageId the package ID (may be `null`) | ||
| * | ||
| * @return the `inputs/` folder as `File` | ||
| */ | ||
| fun getInputsFolder( | ||
| context: Context, | ||
| packageId: String? = null | ||
| ): File { | ||
|
|
||
| return getFile( | ||
| getInternalStorage().mountPath, | ||
| getRelativeSharedPath(if (packageId.isNullOrBlank()) context.packageName else packageId), | ||
| "inputs" | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Gets the `databases/` folder as `File` used by this context. | ||
| * | ||
| * @param context the current `Context` | ||
| * @param storageType the [MountPoint.StorageType] to use | ||
| * | ||
| * @return the `databases/` folder | ||
| */ | ||
| fun getDatabaseFolder( | ||
| context: Context, | ||
| storageType: MountPoint.StorageType | ||
| ): File { | ||
|
|
||
| return getFile( | ||
| getRootFolder( | ||
| context, | ||
| storageType | ||
| ), | ||
| "databases" | ||
| ) | ||
| } | ||
| } | ||
| storageType | ||
| ), | ||
| "databases" | ||
| ) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.