| /* |
| * Copyright (C) 2007 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package android.os; |
| |
| import android.Manifest; |
| import android.annotation.FlaggedApi; |
| import android.annotation.NonNull; |
| import android.annotation.Nullable; |
| import android.annotation.SuppressLint; |
| import android.annotation.SystemApi; |
| import android.annotation.TestApi; |
| import android.app.AppGlobals; |
| import android.app.AppOpsManager; |
| import android.app.admin.DevicePolicyManager; |
| import android.compat.Compatibility; |
| import android.compat.annotation.ChangeId; |
| import android.compat.annotation.Disabled; |
| import android.compat.annotation.UnsupportedAppUsage; |
| import android.content.Context; |
| import android.content.pm.ApplicationInfo; |
| import android.content.pm.PackageManager; |
| import android.os.storage.StorageManager; |
| import android.os.storage.StorageVolume; |
| import android.provider.MediaStore; |
| import android.text.TextUtils; |
| import android.util.Log; |
| |
| import java.io.File; |
| import java.io.IOException; |
| import java.util.ArrayDeque; |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.List; |
| import java.util.Objects; |
| import java.util.UUID; |
| |
| /** |
| * Provides access to environment variables. |
| */ |
| public class Environment { |
| private static final String TAG = "Environment"; |
| |
| // NOTE: keep credential-protected paths in sync with StrictMode.java |
| |
| private static final String ENV_EXTERNAL_STORAGE = "EXTERNAL_STORAGE"; |
| private static final String ENV_ANDROID_ROOT = "ANDROID_ROOT"; |
| private static final String ENV_ANDROID_DATA = "ANDROID_DATA"; |
| private static final String ENV_ANDROID_EXPAND = "ANDROID_EXPAND"; |
| private static final String ENV_ANDROID_STORAGE = "ANDROID_STORAGE"; |
| private static final String ENV_DOWNLOAD_CACHE = "DOWNLOAD_CACHE"; |
| private static final String ENV_OEM_ROOT = "OEM_ROOT"; |
| private static final String ENV_ODM_ROOT = "ODM_ROOT"; |
| private static final String ENV_VENDOR_ROOT = "VENDOR_ROOT"; |
| private static final String ENV_PRODUCT_ROOT = "PRODUCT_ROOT"; |
| private static final String ENV_SYSTEM_EXT_ROOT = "SYSTEM_EXT_ROOT"; |
| private static final String ENV_APEX_ROOT = "APEX_ROOT"; |
| |
| /** {@hide} */ |
| public static final String DIR_ANDROID = "Android"; |
| private static final String DIR_DATA = "data"; |
| private static final String DIR_MEDIA = "media"; |
| private static final String DIR_OBB = "obb"; |
| private static final String DIR_FILES = "files"; |
| private static final String DIR_CACHE = "cache"; |
| |
| /** |
| * The folder name prefix for the user credential protected data directory. This is exposed for |
| * use in string path caching for {@link ApplicationInfo} objects, and should not be accessed |
| * directly otherwise. Prefer {@link #getDataUserCeDirectory(String, int)}. |
| * {@hide} |
| */ |
| public static final String DIR_USER_CE = "user"; |
| |
| /** |
| * The folder name prefix for the user device protected data directory. This is exposed for use |
| * in string path caching for {@link ApplicationInfo} objects, and should not be accessed |
| * directly otherwise. Prefer {@link #getDataUserDeDirectory(String, int)}. |
| * {@hide} |
| */ |
| public static final String DIR_USER_DE = "user_de"; |
| |
| /** {@hide} */ |
| @Deprecated |
| public static final String DIRECTORY_ANDROID = DIR_ANDROID; |
| |
| private static final File DIR_ANDROID_ROOT = getDirectory(ENV_ANDROID_ROOT, "/system"); |
| private static final String DIR_ANDROID_DATA_PATH = getDirectoryPath(ENV_ANDROID_DATA, "/data"); |
| private static final File DIR_ANDROID_DATA = new File(DIR_ANDROID_DATA_PATH); |
| private static final File DIR_ANDROID_EXPAND = getDirectory(ENV_ANDROID_EXPAND, "/mnt/expand"); |
| private static final File DIR_ANDROID_STORAGE = getDirectory(ENV_ANDROID_STORAGE, "/storage"); |
| private static final File DIR_DOWNLOAD_CACHE = getDirectory(ENV_DOWNLOAD_CACHE, "/cache"); |
| private static final File DIR_METADATA = new File("/metadata"); |
| private static final File DIR_OEM_ROOT = getDirectory(ENV_OEM_ROOT, "/oem"); |
| private static final File DIR_ODM_ROOT = getDirectory(ENV_ODM_ROOT, "/odm"); |
| private static final File DIR_VENDOR_ROOT = getDirectory(ENV_VENDOR_ROOT, "/vendor"); |
| private static final File DIR_PRODUCT_ROOT = getDirectory(ENV_PRODUCT_ROOT, "/product"); |
| private static final File DIR_SYSTEM_EXT_ROOT = getDirectory(ENV_SYSTEM_EXT_ROOT, |
| "/system_ext"); |
| private static final File DIR_APEX_ROOT = getDirectory(ENV_APEX_ROOT, |
| "/apex"); |
| |
| /** |
| * Scoped Storage is on by default. However, it is not strictly enforced and there are multiple |
| * ways to opt out of scoped storage: |
| * <ul> |
| * <li>Target Sdk < Q</li> |
| * <li>Target Sdk = Q and has `requestLegacyExternalStorage` set in AndroidManifest.xml</li> |
| * <li>Target Sdk > Q: Upgrading from an app that was opted out of scoped storage and has |
| * `preserveLegacyExternalStorage` set in AndroidManifest.xml</li> |
| * </ul> |
| * This flag is enabled for all apps by default as Scoped Storage is enabled by default. |
| * Developers can disable this flag to opt out of Scoped Storage and have legacy storage |
| * workflow. |
| * |
| * Note: {@code FORCE_ENABLE_SCOPED_STORAGE} should also be disabled for apps to opt out of |
| * scoped storage. |
| * Note: This flag is also used in {@code com.android.providers.media.LocalCallingIdentity}. |
| * Any modifications to this flag should be reflected there as well. |
| * See https://developer.android.com/training/data-storage#scoped-storage for more information. |
| */ |
| @ChangeId |
| private static final long DEFAULT_SCOPED_STORAGE = 149924527L; |
| |
| /** |
| * See definition in com.android.providers.media.LocalCallingIdentity |
| */ |
| /** |
| * Setting this flag strictly enforces Scoped Storage regardless of: |
| * <ul> |
| * <li>The value of Target Sdk</li> |
| * <li>The value of `requestLegacyExternalStorage` in AndroidManifest.xml</li> |
| * <li>The value of `preserveLegacyExternalStorage` in AndroidManifest.xml</li> |
| * </ul> |
| * |
| * Note: {@code DEFAULT_SCOPED_STORAGE} should also be enabled for apps to be enforced into |
| * scoped storage. |
| * Note: This flag is also used in {@code com.android.providers.media.LocalCallingIdentity}. |
| * Any modifications to this flag should be reflected there as well. |
| * See https://developer.android.com/training/data-storage#scoped-storage for more information. |
| */ |
| @ChangeId |
| @Disabled |
| private static final long FORCE_ENABLE_SCOPED_STORAGE = 132649864L; |
| |
| @UnsupportedAppUsage |
| private static UserEnvironment sCurrentUser; |
| private static boolean sUserRequired; |
| |
| static { |
| initForCurrentUser(); |
| } |
| |
| /** {@hide} */ |
| @UnsupportedAppUsage |
| public static void initForCurrentUser() { |
| final int userId = UserHandle.myUserId(); |
| sCurrentUser = new UserEnvironment(userId); |
| } |
| |
| /** {@hide} */ |
| public static class UserEnvironment { |
| private final int mUserId; |
| |
| @UnsupportedAppUsage |
| public UserEnvironment(int userId) { |
| mUserId = userId; |
| } |
| |
| @UnsupportedAppUsage |
| public File[] getExternalDirs() { |
| final StorageVolume[] volumes = StorageManager.getVolumeList(mUserId, |
| StorageManager.FLAG_FOR_WRITE); |
| final File[] files = new File[volumes.length]; |
| for (int i = 0; i < volumes.length; i++) { |
| files[i] = volumes[i].getPathFile(); |
| } |
| return files; |
| } |
| |
| @UnsupportedAppUsage |
| public File getExternalStorageDirectory() { |
| return getExternalDirs()[0]; |
| } |
| |
| @UnsupportedAppUsage |
| public File getExternalStoragePublicDirectory(String type) { |
| return buildExternalStoragePublicDirs(type)[0]; |
| } |
| |
| public File[] buildExternalStoragePublicDirs(String type) { |
| return buildPaths(getExternalDirs(), type); |
| } |
| |
| public File[] buildExternalStorageAndroidDataDirs() { |
| return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA); |
| } |
| |
| public File[] buildExternalStorageAndroidObbDirs() { |
| return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_OBB); |
| } |
| |
| public File[] buildExternalStorageAppDataDirs(String packageName) { |
| return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA, packageName); |
| } |
| |
| public File[] buildExternalStorageAppMediaDirs(String packageName) { |
| return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_MEDIA, packageName); |
| } |
| |
| public File[] buildExternalStorageAppObbDirs(String packageName) { |
| return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_OBB, packageName); |
| } |
| |
| public File[] buildExternalStorageAppFilesDirs(String packageName) { |
| return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA, packageName, DIR_FILES); |
| } |
| |
| public File[] buildExternalStorageAppCacheDirs(String packageName) { |
| return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA, packageName, DIR_CACHE); |
| } |
| } |
| |
| /** |
| * Return root of the "system" partition holding the core Android OS. |
| * Always present and mounted read-only. |
| */ |
| public static @NonNull File getRootDirectory() { |
| return DIR_ANDROID_ROOT; |
| } |
| |
| /** |
| * Return root directory where all external storage devices will be mounted. |
| * For example, {@link #getExternalStorageDirectory()} will appear under |
| * this location. |
| */ |
| public static @NonNull File getStorageDirectory() { |
| return DIR_ANDROID_STORAGE; |
| } |
| |
| /** |
| * Return root directory of the "oem" partition holding OEM customizations, |
| * if any. If present, the partition is mounted read-only. |
| * |
| * @hide |
| */ |
| @SystemApi |
| public static @NonNull File getOemDirectory() { |
| return DIR_OEM_ROOT; |
| } |
| |
| /** |
| * Return root directory of the "odm" partition holding ODM customizations, |
| * if any. If present, the partition is mounted read-only. |
| * |
| * @hide |
| */ |
| @SystemApi |
| public static @NonNull File getOdmDirectory() { |
| return DIR_ODM_ROOT; |
| } |
| |
| /** |
| * Return root directory of the "vendor" partition that holds vendor-provided |
| * software that should persist across simple reflashing of the "system" partition. |
| * @hide |
| */ |
| @SystemApi |
| public static @NonNull File getVendorDirectory() { |
| return DIR_VENDOR_ROOT; |
| } |
| |
| /** |
| * Return root directory of the "product" partition holding product-specific |
| * customizations if any. If present, the partition is mounted read-only. |
| * |
| * @hide |
| */ |
| @SystemApi |
| public static @NonNull File getProductDirectory() { |
| return DIR_PRODUCT_ROOT; |
| } |
| |
| /** |
| * Return root directory of the "product_services" partition holding middleware |
| * services if any. If present, the partition is mounted read-only. |
| * |
| * @deprecated This directory is not guaranteed to exist. |
| * Its name is changed to "system_ext" because the partition's purpose is changed. |
| * {@link #getSystemExtDirectory()} |
| * @hide |
| */ |
| @SystemApi |
| @Deprecated |
| public static @NonNull File getProductServicesDirectory() { |
| return getDirectory("PRODUCT_SERVICES_ROOT", "/product_services"); |
| } |
| |
| /** |
| * Return root directory of the "system_ext" partition holding system partition's extension |
| * If present, the partition is mounted read-only. |
| * |
| * @hide |
| */ |
| @SystemApi |
| public static @NonNull File getSystemExtDirectory() { |
| return DIR_SYSTEM_EXT_ROOT; |
| } |
| |
| /** |
| * Return root directory of the apex mount point, where all the apex modules are made available |
| * to the rest of the system. |
| * |
| * @hide |
| */ |
| public static @NonNull File getApexDirectory() { |
| return DIR_APEX_ROOT; |
| } |
| |
| /** |
| * Return the system directory for a user. This is for use by system |
| * services to store files relating to the user. This directory will be |
| * automatically deleted when the user is removed. |
| * |
| * @deprecated This directory is valid and still exists, but but callers |
| * should <em>strongly</em> consider switching to using either |
| * {@link #getDataSystemCeDirectory(int)} or |
| * {@link #getDataSystemDeDirectory(int)}, both of which support |
| * fast user wipe. |
| * @hide |
| */ |
| @Deprecated |
| public static File getUserSystemDirectory(int userId) { |
| return new File(new File(getDataSystemDirectory(), "users"), Integer.toString(userId)); |
| } |
| |
| /** |
| * Returns the config directory for a user. This is for use by system |
| * services to store files relating to the user which should be readable by |
| * any app running as that user. |
| * |
| * @deprecated This directory is valid and still exists, but callers should |
| * <em>strongly</em> consider switching to |
| * {@link #getDataMiscCeDirectory(int)} which is protected with |
| * user credentials or {@link #getDataMiscDeDirectory(int)} |
| * which supports fast user wipe. |
| * @hide |
| */ |
| @Deprecated |
| public static File getUserConfigDirectory(int userId) { |
| return new File(new File(new File( |
| getDataDirectory(), "misc"), "user"), Integer.toString(userId)); |
| } |
| |
| /** |
| * Return the user data directory. |
| */ |
| public static File getDataDirectory() { |
| return DIR_ANDROID_DATA; |
| } |
| |
| /** |
| * @see #getDataDirectory() |
| * @hide |
| */ |
| public static String getDataDirectoryPath() { |
| return DIR_ANDROID_DATA_PATH; |
| } |
| |
| /** {@hide} */ |
| public static File getDataDirectory(String volumeUuid) { |
| if (TextUtils.isEmpty(volumeUuid)) { |
| return DIR_ANDROID_DATA; |
| } else { |
| return new File("/mnt/expand/" + volumeUuid); |
| } |
| } |
| |
| /** @hide */ |
| public static String getDataDirectoryPath(String volumeUuid) { |
| if (TextUtils.isEmpty(volumeUuid)) { |
| return DIR_ANDROID_DATA_PATH; |
| } else { |
| return getExpandDirectory().getAbsolutePath() + File.separator + volumeUuid; |
| } |
| } |
| |
| /** {@hide} */ |
| public static File getExpandDirectory() { |
| return DIR_ANDROID_EXPAND; |
| } |
| |
| /** {@hide} */ |
| @UnsupportedAppUsage |
| public static File getDataSystemDirectory() { |
| return new File(getDataDirectory(), "system"); |
| } |
| |
| /** |
| * Returns the base directory for per-user system directory, device encrypted. |
| * {@hide} |
| */ |
| @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES) |
| @FlaggedApi(android.crashrecovery.flags.Flags.FLAG_ENABLE_CRASHRECOVERY) |
| public static @NonNull File getDataSystemDeDirectory() { |
| return buildPath(getDataDirectory(), "system_de"); |
| } |
| |
| /** |
| * Returns the base directory for per-user system directory, credential encrypted. |
| * {@hide} |
| */ |
| public static File getDataSystemCeDirectory() { |
| return buildPath(getDataDirectory(), "system_ce"); |
| } |
| |
| /** |
| * Return the "credential encrypted" system directory for a user. This is |
| * for use by system services to store files relating to the user. This |
| * directory supports fast user wipe, and will be automatically deleted when |
| * the user is removed. |
| * <p> |
| * Data stored under this path is "credential encrypted", which uses an |
| * encryption key that is entangled with user credentials, such as a PIN or |
| * password. The contents will only be available once the user has been |
| * unlocked, as reported by {@code SystemService.onUnlockUser()}. |
| * <p> |
| * New code should <em>strongly</em> prefer storing sensitive data in these |
| * credential encrypted areas. |
| * |
| * @hide |
| */ |
| public static File getDataSystemCeDirectory(int userId) { |
| return buildPath(getDataDirectory(), "system_ce", String.valueOf(userId)); |
| } |
| |
| /** |
| * Return the "device encrypted" system directory for a user. This is for |
| * use by system services to store files relating to the user. This |
| * directory supports fast user wipe, and will be automatically deleted when |
| * the user is removed. |
| * <p> |
| * Data stored under this path is "device encrypted", which uses an |
| * encryption key that is tied to the physical device. The contents will |
| * only be available once the device has finished a {@code dm-verity} |
| * protected boot. |
| * <p> |
| * New code should <em>strongly</em> avoid storing sensitive data in these |
| * device encrypted areas. |
| * |
| * @hide |
| */ |
| public static File getDataSystemDeDirectory(int userId) { |
| return buildPath(getDataDirectory(), "system_de", String.valueOf(userId)); |
| } |
| |
| /** {@hide} */ |
| public static File getDataMiscDirectory() { |
| return new File(getDataDirectory(), "misc"); |
| } |
| |
| /** {@hide} */ |
| public static File getDataMiscCeDirectory() { |
| return buildPath(getDataDirectory(), "misc_ce"); |
| } |
| |
| /** {@hide} */ |
| public static File getDataMiscCeDirectory(int userId) { |
| return buildPath(getDataDirectory(), "misc_ce", String.valueOf(userId)); |
| } |
| |
| /** {@hide} */ |
| private static File getDataMiscCeDirectory(String volumeUuid, int userId) { |
| return buildPath(getDataDirectory(volumeUuid), "misc_ce", String.valueOf(userId)); |
| } |
| |
| /** {@hide} */ |
| public static File getDataMiscCeSharedSdkSandboxDirectory(String volumeUuid, int userId, |
| String packageName) { |
| return buildPath(getDataMiscCeDirectory(volumeUuid, userId), "sdksandbox", |
| packageName, "shared"); |
| } |
| |
| /** {@hide} */ |
| public static File getDataMiscDeDirectory(int userId) { |
| return buildPath(getDataDirectory(), "misc_de", String.valueOf(userId)); |
| } |
| |
| /** {@hide} */ |
| private static File getDataMiscDeDirectory(String volumeUuid, int userId) { |
| return buildPath(getDataDirectory(volumeUuid), "misc_de", String.valueOf(userId)); |
| } |
| |
| /** {@hide} */ |
| public static File getDataMiscDeSharedSdkSandboxDirectory(String volumeUuid, int userId, |
| String packageName) { |
| return buildPath(getDataMiscDeDirectory(volumeUuid, userId), "sdksandbox", |
| packageName, "shared"); |
| } |
| |
| private static File getDataProfilesDeDirectory(int userId) { |
| return buildPath(getDataDirectory(), "misc", "profiles", "cur", String.valueOf(userId)); |
| } |
| |
| /** {@hide} */ |
| public static File getDataVendorCeDirectory(int userId) { |
| return buildPath(getDataDirectory(), "vendor_ce", String.valueOf(userId)); |
| } |
| |
| /** {@hide} */ |
| public static File getDataVendorDeDirectory(int userId) { |
| return buildPath(getDataDirectory(), "vendor_de", String.valueOf(userId)); |
| } |
| |
| /** {@hide} */ |
| public static File getDataRefProfilesDePackageDirectory(String packageName) { |
| return buildPath(getDataDirectory(), "misc", "profiles", "ref", packageName); |
| } |
| |
| /** {@hide} */ |
| public static File getDataProfilesDePackageDirectory(int userId, String packageName) { |
| return buildPath(getDataProfilesDeDirectory(userId), packageName); |
| } |
| |
| /** {@hide} */ |
| public static File getDataAppDirectory(String volumeUuid) { |
| return new File(getDataDirectory(volumeUuid), "app"); |
| } |
| |
| /** {@hide} */ |
| public static File getDataStagingDirectory(String volumeUuid) { |
| return new File(getDataDirectory(volumeUuid), "app-staging"); |
| } |
| |
| /** {@hide} */ |
| public static File getDataUserCeDirectory(String volumeUuid) { |
| return new File(getDataDirectory(volumeUuid), DIR_USER_CE); |
| } |
| |
| /** {@hide} */ |
| public static File getDataUserCeDirectory(String volumeUuid, int userId) { |
| return new File(getDataUserCeDirectory(volumeUuid), String.valueOf(userId)); |
| } |
| |
| /** {@hide} */ |
| @NonNull |
| public static File getDataUserCePackageDirectory(@Nullable String volumeUuid, int userId, |
| @NonNull String packageName) { |
| // TODO: keep consistent with installd |
| return new File(getDataUserCeDirectory(volumeUuid, userId), packageName); |
| } |
| |
| /** |
| * Retrieve the credential encrypted data directory for a specific package of a specific user. |
| * This is equivalent to {@link ApplicationInfo#credentialProtectedDataDir}, exposed because |
| * fetching a full {@link ApplicationInfo} instance may be expensive if all the caller needs |
| * is this directory. |
| * |
| * @param storageUuid The storage volume for this directory, usually retrieved from a |
| * {@link StorageManager} API or {@link ApplicationInfo#storageUuid}. |
| * @param user The user this directory is for. |
| * @param packageName The app this directory is for. |
| * |
| * @see ApplicationInfo#credentialProtectedDataDir |
| * @return A file to the directory. |
| * |
| * @hide |
| */ |
| @SystemApi |
| @NonNull |
| public static File getDataCePackageDirectoryForUser(@NonNull UUID storageUuid, |
| @NonNull UserHandle user, @NonNull String packageName) { |
| var volumeUuid = StorageManager.convert(storageUuid); |
| return getDataUserCePackageDirectory(volumeUuid, user.getIdentifier(), packageName); |
| } |
| |
| /** {@hide} */ |
| public static File getDataUserDeDirectory(String volumeUuid) { |
| return new File(getDataDirectory(volumeUuid), DIR_USER_DE); |
| } |
| |
| /** {@hide} */ |
| public static File getDataUserDeDirectory(String volumeUuid, int userId) { |
| return new File(getDataUserDeDirectory(volumeUuid), String.valueOf(userId)); |
| } |
| |
| /** {@hide} */ |
| @NonNull |
| public static File getDataUserDePackageDirectory(@Nullable String volumeUuid, int userId, |
| @NonNull String packageName) { |
| // TODO: keep consistent with installd |
| return new File(getDataUserDeDirectory(volumeUuid, userId), packageName); |
| } |
| |
| /** |
| * Retrieve the device encrypted data directory for a specific package of a specific user. This |
| * is equivalent to {@link ApplicationInfo#deviceProtectedDataDir}, exposed because fetching a |
| * full {@link ApplicationInfo} instance may be expensive if all the caller needs is this |
| * directory. |
| * |
| * @param storageUuid The storage volume for this directory, usually retrieved from a |
| * {@link StorageManager} API or {@link ApplicationInfo#storageUuid}. |
| * @param user The user this directory is for. |
| * @param packageName The app this directory is for. |
| * |
| * @see ApplicationInfo#deviceProtectedDataDir |
| * @return A file to the directory. |
| * |
| * @hide |
| */ |
| @SystemApi |
| @NonNull |
| public static File getDataDePackageDirectoryForUser(@NonNull UUID storageUuid, |
| @NonNull UserHandle user, @NonNull String packageName) { |
| var volumeUuid = StorageManager.convert(storageUuid); |
| return getDataUserDePackageDirectory(volumeUuid, user.getIdentifier(), packageName); |
| } |
| |
| /** |
| * Return preloads directory. |
| * <p>This directory may contain pre-loaded content such as |
| * {@link #getDataPreloadsDemoDirectory() demo videos} and |
| * {@link #getDataPreloadsAppsDirectory() APK files} . |
| * {@hide} |
| */ |
| public static File getDataPreloadsDirectory() { |
| return new File(getDataDirectory(), "preloads"); |
| } |
| |
| /** |
| * @see #getDataPreloadsDirectory() |
| * {@hide} |
| */ |
| public static File getDataPreloadsDemoDirectory() { |
| return new File(getDataPreloadsDirectory(), "demo"); |
| } |
| |
| /** |
| * @see #getDataPreloadsDirectory() |
| * {@hide} |
| */ |
| public static File getDataPreloadsAppsDirectory() { |
| return new File(getDataPreloadsDirectory(), "apps"); |
| } |
| |
| /** |
| * @see #getDataPreloadsDirectory() |
| * {@hide} |
| */ |
| public static File getDataPreloadsMediaDirectory() { |
| return new File(getDataPreloadsDirectory(), "media"); |
| } |
| |
| /** |
| * Returns location of preloaded cache directory for package name |
| * @see #getDataPreloadsDirectory() |
| * {@hide} |
| */ |
| public static File getDataPreloadsFileCacheDirectory(String packageName) { |
| return new File(getDataPreloadsFileCacheDirectory(), packageName); |
| } |
| |
| /** |
| * Returns location of preloaded cache directory. |
| * @see #getDataPreloadsDirectory() |
| * {@hide} |
| */ |
| public static File getDataPreloadsFileCacheDirectory() { |
| return new File(getDataPreloadsDirectory(), "file_cache"); |
| } |
| |
| /** |
| * Returns location of packages cache directory. |
| * {@hide} |
| */ |
| public static File getPackageCacheDirectory() { |
| return new File(getDataSystemDirectory(), "package_cache"); |
| } |
| |
| /** |
| * Return locations where media files (such as ringtones, notification |
| * sounds, or alarm sounds) may be located on internal storage. These are |
| * typically indexed under {@link MediaStore#VOLUME_INTERNAL}. |
| * |
| * @hide |
| */ |
| @SystemApi |
| public static @NonNull Collection<File> getInternalMediaDirectories() { |
| final ArrayList<File> res = new ArrayList<>(); |
| addCanonicalFile(res, new File(Environment.getRootDirectory(), "media")); |
| addCanonicalFile(res, new File(Environment.getOemDirectory(), "media")); |
| addCanonicalFile(res, new File(Environment.getProductDirectory(), "media")); |
| return res; |
| } |
| |
| private static void addCanonicalFile(List<File> list, File file) { |
| try { |
| list.add(file.getCanonicalFile()); |
| } catch (IOException e) { |
| Log.w(TAG, "Failed to resolve " + file + ": " + e); |
| list.add(file); |
| } |
| } |
| |
| /** |
| * Return the primary shared/external storage directory. This directory may |
| * not currently be accessible if it has been mounted by the user on their |
| * computer, has been removed from the device, or some other problem has |
| * happened. You can determine its current state with |
| * {@link #getExternalStorageState()}. |
| * <p> |
| * <em>Note: don't be confused by the word "external" here. This directory |
| * can better be thought as media/shared storage. It is a filesystem that |
| * can hold a relatively large amount of data and that is shared across all |
| * applications (does not enforce permissions). Traditionally this is an SD |
| * card, but it may also be implemented as built-in storage in a device that |
| * is distinct from the protected internal storage and can be mounted as a |
| * filesystem on a computer.</em> |
| * <p> |
| * On devices with multiple users (as described by {@link UserManager}), |
| * each user has their own isolated shared storage. Applications only have |
| * access to the shared storage for the user they're running as. |
| * <p> |
| * In devices with multiple shared/external storage directories, this |
| * directory represents the primary storage that the user will interact |
| * with. Access to secondary storage is available through |
| * {@link Context#getExternalFilesDirs(String)}, |
| * {@link Context#getExternalCacheDirs()}, and |
| * {@link Context#getExternalMediaDirs()}. |
| * <p> |
| * Applications should not directly use this top-level directory, in order |
| * to avoid polluting the user's root namespace. Any files that are private |
| * to the application should be placed in a directory returned by |
| * {@link android.content.Context#getExternalFilesDir |
| * Context.getExternalFilesDir}, which the system will take care of deleting |
| * if the application is uninstalled. Other shared files should be placed in |
| * one of the directories returned by |
| * {@link #getExternalStoragePublicDirectory}. |
| * <p> |
| * Writing to this path requires the |
| * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} permission, |
| * and starting in {@link android.os.Build.VERSION_CODES#KITKAT}, read |
| * access requires the |
| * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} permission, |
| * which is automatically granted if you hold the write permission. |
| * <p> |
| * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, if your |
| * application only needs to store internal data, consider using |
| * {@link Context#getExternalFilesDir(String)}, |
| * {@link Context#getExternalCacheDir()}, or |
| * {@link Context#getExternalMediaDirs()}, which require no permissions to |
| * read or write. |
| * <p> |
| * This path may change between platform versions, so applications should |
| * only persist relative paths. |
| * <p> |
| * Here is an example of typical code to monitor the state of external |
| * storage: |
| * <p> |
| * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java |
| * monitor_storage} |
| * <p> |
| * Note that alternatives such as {@link Context#getExternalFilesDir(String)} or |
| * {@link MediaStore} offer better performance. |
| * |
| * @see #getExternalStorageState() |
| * @see #isExternalStorageRemovable() |
| */ |
| public static File getExternalStorageDirectory() { |
| throwIfUserRequired(); |
| return sCurrentUser.getExternalDirs()[0]; |
| } |
| |
| /** {@hide} */ |
| @UnsupportedAppUsage |
| public static File getLegacyExternalStorageDirectory() { |
| return new File(System.getenv(ENV_EXTERNAL_STORAGE)); |
| } |
| |
| /** {@hide} */ |
| @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| public static File getLegacyExternalStorageObbDirectory() { |
| return buildPath(getLegacyExternalStorageDirectory(), DIR_ANDROID, DIR_OBB); |
| } |
| |
| /** |
| * Standard directory in which to place any audio files that should be |
| * in the regular list of music for the user. |
| * This may be combined with {@link #DIRECTORY_AUDIOBOOKS}, |
| * {@link #DIRECTORY_PODCASTS}, {@link #DIRECTORY_NOTIFICATIONS}, |
| * {@link #DIRECTORY_ALARMS}, {@link #DIRECTORY_RINGTONES}, and |
| * {@link #DIRECTORY_RECORDINGS} as a series of directories to |
| * categorize a particular audio file as more than one type. |
| */ |
| public static String DIRECTORY_MUSIC = "Music"; |
| |
| /** |
| * Standard directory in which to place any audio files that should be |
| * in the list of podcasts that the user can select (not as regular |
| * music). |
| * This may be combined with {@link #DIRECTORY_MUSIC}, |
| * {@link #DIRECTORY_AUDIOBOOKS}, {@link #DIRECTORY_NOTIFICATIONS}, |
| * {@link #DIRECTORY_ALARMS}, {@link #DIRECTORY_RINGTONES}, and |
| * {@link #DIRECTORY_RECORDINGS} as a series of directories to |
| * categorize a particular audio file as more than one type. |
| */ |
| public static String DIRECTORY_PODCASTS = "Podcasts"; |
| |
| /** |
| * Standard directory in which to place any audio files that should be |
| * in the list of ringtones that the user can select (not as regular |
| * music). |
| * This may be combined with {@link #DIRECTORY_MUSIC}, |
| * {@link #DIRECTORY_AUDIOBOOKS}, {@link #DIRECTORY_PODCASTS}, |
| * {@link #DIRECTORY_NOTIFICATIONS}, {@link #DIRECTORY_ALARMS}, |
| * and {@link #DIRECTORY_RECORDINGS} as a series of directories |
| * to categorize a particular audio file as more than one type. |
| */ |
| public static String DIRECTORY_RINGTONES = "Ringtones"; |
| |
| /** |
| * Standard directory in which to place any audio files that should be |
| * in the list of alarms that the user can select (not as regular |
| * music). |
| * This may be combined with {@link #DIRECTORY_MUSIC}, |
| * {@link #DIRECTORY_AUDIOBOOKS}, {@link #DIRECTORY_PODCASTS}, |
| * {@link #DIRECTORY_NOTIFICATIONS}, {@link #DIRECTORY_RINGTONES}, |
| * and {@link #DIRECTORY_RECORDINGS} as a series of directories |
| * to categorize a particular audio file as more than one type. |
| */ |
| public static String DIRECTORY_ALARMS = "Alarms"; |
| |
| /** |
| * Standard directory in which to place any audio files that should be |
| * in the list of notifications that the user can select (not as regular |
| * music). |
| * This may be combined with {@link #DIRECTORY_MUSIC}, |
| * {@link #DIRECTORY_AUDIOBOOKS}, {@link #DIRECTORY_PODCASTS}, |
| * {@link #DIRECTORY_ALARMS}, {@link #DIRECTORY_RINGTONES}, and |
| * {@link #DIRECTORY_RECORDINGS} as a series of directories to |
| * categorize a particular audio file as more than one type. |
| */ |
| public static String DIRECTORY_NOTIFICATIONS = "Notifications"; |
| |
| /** |
| * Standard directory in which to place pictures that are available to |
| * the user. Note that this is primarily a convention for the top-level |
| * public directory, as the media scanner will find and collect pictures |
| * in any directory. |
| */ |
| public static String DIRECTORY_PICTURES = "Pictures"; |
| |
| /** |
| * Standard directory in which to place movies that are available to |
| * the user. Note that this is primarily a convention for the top-level |
| * public directory, as the media scanner will find and collect movies |
| * in any directory. |
| */ |
| public static String DIRECTORY_MOVIES = "Movies"; |
| |
| /** |
| * Standard directory in which to place files that have been downloaded by |
| * the user. Note that this is primarily a convention for the top-level |
| * public directory, you are free to download files anywhere in your own |
| * private directories. Also note that though the constant here is |
| * named DIRECTORY_DOWNLOADS (plural), the actual file name is non-plural for |
| * backwards compatibility reasons. |
| */ |
| public static String DIRECTORY_DOWNLOADS = "Download"; |
| |
| /** |
| * The traditional location for pictures and videos when mounting the |
| * device as a camera. Note that this is primarily a convention for the |
| * top-level public directory, as this convention makes no sense elsewhere. |
| */ |
| public static String DIRECTORY_DCIM = "DCIM"; |
| |
| /** |
| * Standard directory in which to place documents that have been created by |
| * the user. |
| */ |
| public static String DIRECTORY_DOCUMENTS = "Documents"; |
| |
| /** |
| * Standard directory in which to place screenshots that have been taken by |
| * the user. Typically used as a secondary directory under |
| * {@link #DIRECTORY_PICTURES}. |
| */ |
| public static String DIRECTORY_SCREENSHOTS = "Screenshots"; |
| |
| /** |
| * Standard directory in which to place any audio files that should be |
| * in the list of audiobooks that the user can select (not as regular |
| * music). |
| * This may be combined with {@link #DIRECTORY_MUSIC}, |
| * {@link #DIRECTORY_PODCASTS}, {@link #DIRECTORY_NOTIFICATIONS}, |
| * {@link #DIRECTORY_ALARMS}, {@link #DIRECTORY_RINGTONES}, |
| * and {@link #DIRECTORY_RECORDINGS} as a series of directories |
| * to categorize a particular audio file as more than one type. |
| */ |
| public static String DIRECTORY_AUDIOBOOKS = "Audiobooks"; |
| |
| /** |
| * Standard directory in which to place any audio files that should be |
| * in the list of voice recordings recorded by voice recorder apps that |
| * the user can select (not as regular music). |
| * This may be combined with {@link #DIRECTORY_MUSIC}, |
| * {@link #DIRECTORY_AUDIOBOOKS}, {@link #DIRECTORY_PODCASTS}, |
| * {@link #DIRECTORY_NOTIFICATIONS}, {@link #DIRECTORY_ALARMS}, |
| * and {@link #DIRECTORY_RINGTONES} as a series of directories |
| * to categorize a particular audio file as more than one type. |
| */ |
| @NonNull |
| // The better way is that expose a static method getRecordingDirectories. |
| // But since it's an existing API surface and developers already |
| // used to DIRECTORY_* constants, we should keep using this pattern |
| // for consistency. We use SuppressLint here to avoid exposing a final |
| // field. A final field will prevent us from ever changing the value of |
| // DIRECTORY_RECORDINGS. Not that it's likely that we will ever need to |
| // change it, but it's better to have such option. |
| @SuppressLint({"MutableBareField", "AllUpper"}) |
| public static String DIRECTORY_RECORDINGS = "Recordings"; |
| |
| /** |
| * List of standard storage directories. |
| * <p> |
| * Each of its values have its own constant: |
| * <ul> |
| * <li>{@link #DIRECTORY_MUSIC} |
| * <li>{@link #DIRECTORY_PODCASTS} |
| * <li>{@link #DIRECTORY_ALARMS} |
| * <li>{@link #DIRECTORY_RINGTONES} |
| * <li>{@link #DIRECTORY_NOTIFICATIONS} |
| * <li>{@link #DIRECTORY_PICTURES} |
| * <li>{@link #DIRECTORY_MOVIES} |
| * <li>{@link #DIRECTORY_DOWNLOADS} |
| * <li>{@link #DIRECTORY_DCIM} |
| * <li>{@link #DIRECTORY_DOCUMENTS} |
| * <li>{@link #DIRECTORY_AUDIOBOOKS} |
| * <li>{@link #DIRECTORY_RECORDINGS} |
| * </ul> |
| * @hide |
| */ |
| public static final String[] STANDARD_DIRECTORIES = { |
| DIRECTORY_MUSIC, |
| DIRECTORY_PODCASTS, |
| DIRECTORY_RINGTONES, |
| DIRECTORY_ALARMS, |
| DIRECTORY_NOTIFICATIONS, |
| DIRECTORY_PICTURES, |
| DIRECTORY_MOVIES, |
| DIRECTORY_DOWNLOADS, |
| DIRECTORY_DCIM, |
| DIRECTORY_DOCUMENTS, |
| DIRECTORY_AUDIOBOOKS, |
| DIRECTORY_RECORDINGS, |
| }; |
| |
| /** |
| * @hide |
| */ |
| public static boolean isStandardDirectory(String dir) { |
| for (String valid : STANDARD_DIRECTORIES) { |
| if (valid.equals(dir)) { |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| /** {@hide} */ public static final int HAS_MUSIC = 1 << 0; |
| /** {@hide} */ public static final int HAS_PODCASTS = 1 << 1; |
| /** {@hide} */ public static final int HAS_RINGTONES = 1 << 2; |
| /** {@hide} */ public static final int HAS_ALARMS = 1 << 3; |
| /** {@hide} */ public static final int HAS_NOTIFICATIONS = 1 << 4; |
| /** {@hide} */ public static final int HAS_PICTURES = 1 << 5; |
| /** {@hide} */ public static final int HAS_MOVIES = 1 << 6; |
| /** {@hide} */ public static final int HAS_DOWNLOADS = 1 << 7; |
| /** {@hide} */ public static final int HAS_DCIM = 1 << 8; |
| /** {@hide} */ public static final int HAS_DOCUMENTS = 1 << 9; |
| /** {@hide} */ public static final int HAS_AUDIOBOOKS = 1 << 10; |
| /** {@hide} */ public static final int HAS_RECORDINGS = 1 << 11; |
| |
| /** {@hide} */ public static final int HAS_ANDROID = 1 << 16; |
| /** {@hide} */ public static final int HAS_OTHER = 1 << 17; |
| |
| /** |
| * Classify the content types present on the given external storage device. |
| * <p> |
| * This is typically useful for deciding if an inserted SD card is empty, or |
| * if it contains content like photos that should be preserved. |
| * |
| * @hide |
| */ |
| public static int classifyExternalStorageDirectory(File dir) { |
| int res = 0; |
| for (File f : FileUtils.listFilesOrEmpty(dir)) { |
| if (f.isFile() && isInterestingFile(f)) { |
| res |= HAS_OTHER; |
| } else if (f.isDirectory() && hasInterestingFiles(f)) { |
| final String name = f.getName(); |
| if (DIRECTORY_MUSIC.equals(name)) res |= HAS_MUSIC; |
| else if (DIRECTORY_PODCASTS.equals(name)) res |= HAS_PODCASTS; |
| else if (DIRECTORY_RINGTONES.equals(name)) res |= HAS_RINGTONES; |
| else if (DIRECTORY_ALARMS.equals(name)) res |= HAS_ALARMS; |
| else if (DIRECTORY_NOTIFICATIONS.equals(name)) res |= HAS_NOTIFICATIONS; |
| else if (DIRECTORY_PICTURES.equals(name)) res |= HAS_PICTURES; |
| else if (DIRECTORY_MOVIES.equals(name)) res |= HAS_MOVIES; |
| else if (DIRECTORY_DOWNLOADS.equals(name)) res |= HAS_DOWNLOADS; |
| else if (DIRECTORY_DCIM.equals(name)) res |= HAS_DCIM; |
| else if (DIRECTORY_DOCUMENTS.equals(name)) res |= HAS_DOCUMENTS; |
| else if (DIRECTORY_AUDIOBOOKS.equals(name)) res |= HAS_AUDIOBOOKS; |
| else if (DIRECTORY_RECORDINGS.equals(name)) res |= HAS_RECORDINGS; |
| else if (DIRECTORY_ANDROID.equals(name)) res |= HAS_ANDROID; |
| else res |= HAS_OTHER; |
| } |
| } |
| return res; |
| } |
| |
| private static boolean hasInterestingFiles(File dir) { |
| final ArrayDeque<File> explore = new ArrayDeque<>(); |
| explore.add(dir); |
| while (!explore.isEmpty()) { |
| dir = explore.pop(); |
| for (File f : FileUtils.listFilesOrEmpty(dir)) { |
| if (isInterestingFile(f)) return true; |
| if (f.isDirectory()) explore.add(f); |
| } |
| } |
| return false; |
| } |
| |
| private static boolean isInterestingFile(File file) { |
| if (file.isFile()) { |
| final String name = file.getName().toLowerCase(); |
| if (name.endsWith(".exe") || name.equals("autorun.inf") |
| || name.equals("launchpad.zip") || name.equals(".nomedia")) { |
| return false; |
| } else { |
| return true; |
| } |
| } else { |
| return false; |
| } |
| } |
| |
| /** |
| * Get a top-level shared/external storage directory for placing files of a |
| * particular type. This is where the user will typically place and manage |
| * their own files, so you should be careful about what you put here to |
| * ensure you don't erase their files or get in the way of their own |
| * organization. |
| * <p> |
| * On devices with multiple users (as described by {@link UserManager}), |
| * each user has their own isolated shared storage. Applications only have |
| * access to the shared storage for the user they're running as. |
| * </p> |
| * <p> |
| * Here is an example of typical code to manipulate a picture on the public |
| * shared storage: |
| * </p> |
| * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java |
| * public_picture} |
| * <p> |
| * Note that alternatives such as {@link Context#getExternalFilesDir(String)} or |
| * {@link MediaStore} offer better performance. |
| * |
| * @param type The type of storage directory to return. Should be one of |
| * {@link #DIRECTORY_MUSIC}, {@link #DIRECTORY_PODCASTS}, |
| * {@link #DIRECTORY_RINGTONES}, {@link #DIRECTORY_ALARMS}, |
| * {@link #DIRECTORY_NOTIFICATIONS}, {@link #DIRECTORY_PICTURES}, |
| * {@link #DIRECTORY_MOVIES}, {@link #DIRECTORY_DOWNLOADS}, |
| * {@link #DIRECTORY_DCIM}, or {@link #DIRECTORY_DOCUMENTS}. May not be null. |
| * @return Returns the File path for the directory. Note that this directory |
| * may not yet exist, so you must make sure it exists before using |
| * it such as with {@link File#mkdirs File.mkdirs()}. |
| */ |
| public static File getExternalStoragePublicDirectory(String type) { |
| throwIfUserRequired(); |
| return sCurrentUser.buildExternalStoragePublicDirs(type)[0]; |
| } |
| |
| /** |
| * Returns the path for android-specific data on the SD card. |
| * @hide |
| */ |
| @UnsupportedAppUsage |
| public static File[] buildExternalStorageAndroidDataDirs() { |
| throwIfUserRequired(); |
| return sCurrentUser.buildExternalStorageAndroidDataDirs(); |
| } |
| |
| /** |
| * Returns the path for android-specific OBB data on the SD card. |
| * @hide |
| */ |
| public static File[] buildExternalStorageAndroidObbDirs() { |
| throwIfUserRequired(); |
| return sCurrentUser.buildExternalStorageAndroidObbDirs(); |
| } |
| |
| /** |
| * Generates the raw path to an application's data |
| * @hide |
| */ |
| @UnsupportedAppUsage |
| public static File[] buildExternalStorageAppDataDirs(String packageName) { |
| throwIfUserRequired(); |
| return sCurrentUser.buildExternalStorageAppDataDirs(packageName); |
| } |
| |
| /** |
| * Generates the raw path to an application's media |
| * @hide |
| */ |
| @UnsupportedAppUsage |
| public static File[] buildExternalStorageAppMediaDirs(String packageName) { |
| throwIfUserRequired(); |
| return sCurrentUser.buildExternalStorageAppMediaDirs(packageName); |
| } |
| |
| /** |
| * Generates the raw path to an application's OBB files |
| * @hide |
| */ |
| @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) |
| public static File[] buildExternalStorageAppObbDirs(String packageName) { |
| throwIfUserRequired(); |
| return sCurrentUser.buildExternalStorageAppObbDirs(packageName); |
| } |
| |
| /** |
| * Generates the path to an application's files. |
| * @hide |
| */ |
| @UnsupportedAppUsage |
| public static File[] buildExternalStorageAppFilesDirs(String packageName) { |
| throwIfUserRequired(); |
| return sCurrentUser.buildExternalStorageAppFilesDirs(packageName); |
| } |
| |
| /** |
| * Generates the path to an application's cache. |
| * @hide |
| */ |
| @UnsupportedAppUsage |
| public static File[] buildExternalStorageAppCacheDirs(String packageName) { |
| throwIfUserRequired(); |
| return sCurrentUser.buildExternalStorageAppCacheDirs(packageName); |
| } |
| |
| /** @hide */ |
| public static File[] buildExternalStoragePublicDirs(@NonNull String dirType) { |
| throwIfUserRequired(); |
| return sCurrentUser.buildExternalStoragePublicDirs(dirType); |
| } |
| |
| /** |
| * Return the download/cache content directory. |
| */ |
| public static File getDownloadCacheDirectory() { |
| return DIR_DOWNLOAD_CACHE; |
| } |
| |
| /** |
| * Return the metadata directory. |
| * |
| * @hide |
| */ |
| public static @NonNull File getMetadataDirectory() { |
| return DIR_METADATA; |
| } |
| |
| /** |
| * Unknown storage state, such as when a path isn't backed by known storage |
| * media. |
| * |
| * @see #getExternalStorageState(File) |
| */ |
| public static final String MEDIA_UNKNOWN = "unknown"; |
| |
| /** |
| * Storage state if the media is not present. |
| * |
| * @see #getExternalStorageState(File) |
| */ |
| public static final String MEDIA_REMOVED = "removed"; |
| |
| /** |
| * Storage state if the media is present but not mounted. |
| * |
| * @see #getExternalStorageState(File) |
| */ |
| public static final String MEDIA_UNMOUNTED = "unmounted"; |
| |
| /** |
| * Storage state if the media is present and being disk-checked. |
| * |
| * @see #getExternalStorageState(File) |
| */ |
| public static final String MEDIA_CHECKING = "checking"; |
| |
| /** |
| * Storage state if the media is present but is blank or is using an |
| * unsupported filesystem. |
| * |
| * @see #getExternalStorageState(File) |
| */ |
| public static final String MEDIA_NOFS = "nofs"; |
| |
| /** |
| * Storage state if the media is present and mounted at its mount point with |
| * read/write access. |
| * |
| * @see #getExternalStorageState(File) |
| */ |
| public static final String MEDIA_MOUNTED = "mounted"; |
| |
| /** |
| * Storage state if the media is present and mounted at its mount point with |
| * read-only access. |
| * |
| * @see #getExternalStorageState(File) |
| */ |
| public static final String MEDIA_MOUNTED_READ_ONLY = "mounted_ro"; |
| |
| /** |
| * Storage state if the media is present not mounted, and shared via USB |
| * mass storage. |
| * |
| * @see #getExternalStorageState(File) |
| */ |
| public static final String MEDIA_SHARED = "shared"; |
| |
| /** |
| * Storage state if the media was removed before it was unmounted. |
| * |
| * @see #getExternalStorageState(File) |
| */ |
| public static final String MEDIA_BAD_REMOVAL = "bad_removal"; |
| |
| /** |
| * Storage state if the media is present but cannot be mounted. Typically |
| * this happens if the file system on the media is corrupted. |
| * |
| * @see #getExternalStorageState(File) |
| */ |
| public static final String MEDIA_UNMOUNTABLE = "unmountable"; |
| |
| /** |
| * Storage state if the media is in the process of being ejected. |
| * |
| * @see #getExternalStorageState(File) |
| */ |
| public static final String MEDIA_EJECTING = "ejecting"; |
| |
| /** |
| * Returns the current state of the primary shared/external storage media. |
| * |
| * @see #getExternalStorageDirectory() |
| * @return one of {@link #MEDIA_UNKNOWN}, {@link #MEDIA_REMOVED}, |
| * {@link #MEDIA_UNMOUNTED}, {@link #MEDIA_CHECKING}, |
| * {@link #MEDIA_NOFS}, {@link #MEDIA_MOUNTED}, |
| * {@link #MEDIA_MOUNTED_READ_ONLY}, {@link #MEDIA_SHARED}, |
| * {@link #MEDIA_BAD_REMOVAL}, or {@link #MEDIA_UNMOUNTABLE}. |
| */ |
| public static String getExternalStorageState() { |
| final File externalDir = sCurrentUser.getExternalDirs()[0]; |
| return getExternalStorageState(externalDir); |
| } |
| |
| /** |
| * @deprecated use {@link #getExternalStorageState(File)} |
| */ |
| @Deprecated |
| public static String getStorageState(File path) { |
| return getExternalStorageState(path); |
| } |
| |
| /** |
| * Returns the current state of the shared/external storage media at the |
| * given path. |
| * |
| * @return one of {@link #MEDIA_UNKNOWN}, {@link #MEDIA_REMOVED}, |
| * {@link #MEDIA_UNMOUNTED}, {@link #MEDIA_CHECKING}, |
| * {@link #MEDIA_NOFS}, {@link #MEDIA_MOUNTED}, |
| * {@link #MEDIA_MOUNTED_READ_ONLY}, {@link #MEDIA_SHARED}, |
| * {@link #MEDIA_BAD_REMOVAL}, or {@link #MEDIA_UNMOUNTABLE}. |
| */ |
| public static String getExternalStorageState(File path) { |
| final StorageVolume volume = StorageManager.getStorageVolume(path, UserHandle.myUserId()); |
| if (volume != null) { |
| return volume.getState(); |
| } else { |
| return MEDIA_UNKNOWN; |
| } |
| } |
| |
| /** |
| * Returns whether the primary shared/external storage media is physically |
| * removable. |
| * |
| * @return true if the storage device can be removed (such as an SD card), |
| * or false if the storage device is built in and cannot be |
| * physically removed. |
| */ |
| public static boolean isExternalStorageRemovable() { |
| final File externalDir = sCurrentUser.getExternalDirs()[0]; |
| return isExternalStorageRemovable(externalDir); |
| } |
| |
| /** |
| * Returns whether the shared/external storage media at the given path is |
| * physically removable. |
| * |
| * @return true if the storage device can be removed (such as an SD card), |
| * or false if the storage device is built in and cannot be |
| * physically removed. |
| * @throws IllegalArgumentException if the path is not a valid storage |
| * device. |
| */ |
| public static boolean isExternalStorageRemovable(@NonNull File path) { |
| final StorageVolume volume = StorageManager.getStorageVolume(path, UserHandle.myUserId()); |
| if (volume != null) { |
| return volume.isRemovable(); |
| } else { |
| throw new IllegalArgumentException("Failed to find storage device at " + path); |
| } |
| } |
| |
| /** |
| * Returns whether the primary shared/external storage media is emulated. |
| * <p> |
| * The contents of emulated storage devices are backed by a private user |
| * data partition, which means there is little benefit to apps storing data |
| * here instead of the private directories returned by |
| * {@link Context#getFilesDir()}, etc. |
| * <p> |
| * This returns true when emulated storage is backed by either internal |
| * storage or an adopted storage device. |
| * |
| * @see DevicePolicyManager#setStorageEncryption(android.content.ComponentName, |
| * boolean) |
| */ |
| public static boolean isExternalStorageEmulated() { |
| final File externalDir = sCurrentUser.getExternalDirs()[0]; |
| return isExternalStorageEmulated(externalDir); |
| } |
| |
| /** |
| * Returns whether the shared/external storage media at the given path is |
| * emulated. |
| * <p> |
| * The contents of emulated storage devices are backed by a private user |
| * data partition, which means there is little benefit to apps storing data |
| * here instead of the private directories returned by |
| * {@link Context#getFilesDir()}, etc. |
| * <p> |
| * This returns true when emulated storage is backed by either internal |
| * storage or an adopted storage device. |
| * |
| * @throws IllegalArgumentException if the path is not a valid storage |
| * device. |
| */ |
| public static boolean isExternalStorageEmulated(@NonNull File path) { |
| final StorageVolume volume = StorageManager.getStorageVolume(path, UserHandle.myUserId()); |
| if (volume != null) { |
| return volume.isEmulated(); |
| } else { |
| throw new IllegalArgumentException("Failed to find storage device at " + path); |
| } |
| } |
| |
| /** |
| * Returns whether the shared/external storage media is a |
| * legacy view that includes files not owned by the app. |
| * <p> |
| * This value may be different from the value requested by |
| * {@code requestLegacyExternalStorage} in the app's manifest, since an app |
| * may inherit its legacy state based on when it was first installed, target sdk and other |
| * factors. |
| * <p> |
| * Non-legacy apps can continue to discover and read media belonging to |
| * other apps via {@link android.provider.MediaStore}. |
| */ |
| public static boolean isExternalStorageLegacy() { |
| final File externalDir = sCurrentUser.getExternalDirs()[0]; |
| return isExternalStorageLegacy(externalDir); |
| } |
| |
| /** |
| * Returns whether the shared/external storage media is a |
| * legacy view that includes files not owned by the app. |
| * <p> |
| * This value may be different from the value requested by |
| * {@code requestLegacyExternalStorage} in the app's manifest, since an app |
| * may inherit its legacy state based on when it was first installed, target sdk and other |
| * factors. |
| * <p> |
| * Non-legacy apps can continue to discover and read media belonging to |
| * other apps via {@link android.provider.MediaStore}. |
| * |
| * @throws IllegalArgumentException if the path is not a valid storage |
| * device. |
| */ |
| public static boolean isExternalStorageLegacy(@NonNull File path) { |
| final Context context = AppGlobals.getInitialApplication(); |
| final int uid = context.getApplicationInfo().uid; |
| // Isolated processes and Instant apps are never allowed to be in scoped storage |
| if (Process.isIsolated(uid) || Process.isSdkSandboxUid(uid)) { |
| return false; |
| } |
| |
| final PackageManager packageManager = context.getPackageManager(); |
| if (packageManager.isInstantApp()) { |
| return false; |
| } |
| |
| // Apps with PROPERTY_NO_APP_DATA_STORAGE should not be allowed in scoped storage |
| final String packageName = AppGlobals.getInitialPackage(); |
| try { |
| final PackageManager.Property noAppStorageProp = packageManager.getProperty( |
| PackageManager.PROPERTY_NO_APP_DATA_STORAGE, packageName); |
| if (noAppStorageProp != null && noAppStorageProp.getBoolean()) { |
| return false; |
| } |
| } catch (PackageManager.NameNotFoundException ignore) { |
| // Property not defined for the package |
| } |
| |
| boolean defaultScopedStorage = Compatibility.isChangeEnabled(DEFAULT_SCOPED_STORAGE); |
| boolean forceEnableScopedStorage = Compatibility.isChangeEnabled( |
| FORCE_ENABLE_SCOPED_STORAGE); |
| // if Scoped Storage is strictly enforced, the app does *not* have legacy storage access |
| // Note: does not require packagename/uid as this is directly called from an app process |
| if (isScopedStorageEnforced(defaultScopedStorage, forceEnableScopedStorage)) { |
| return false; |
| } |
| // if Scoped Storage is strictly disabled, the app has legacy storage access |
| // Note: does not require packagename/uid as this is directly called from an app process |
| if (isScopedStorageDisabled(defaultScopedStorage, forceEnableScopedStorage)) { |
| return true; |
| } |
| |
| final AppOpsManager appOps = context.getSystemService(AppOpsManager.class); |
| final String opPackageName = context.getOpPackageName(); |
| |
| if (appOps.noteOpNoThrow(AppOpsManager.OP_LEGACY_STORAGE, uid, |
| opPackageName) == AppOpsManager.MODE_ALLOWED) { |
| return true; |
| } |
| |
| // Legacy external storage access is granted to instrumentations invoked with |
| // "--no-isolated-storage" flag. |
| return appOps.noteOpNoThrow(AppOpsManager.OP_NO_ISOLATED_STORAGE, uid, |
| opPackageName) == AppOpsManager.MODE_ALLOWED; |
| } |
| |
| private static boolean isScopedStorageEnforced(boolean defaultScopedStorage, |
| boolean forceEnableScopedStorage) { |
| return defaultScopedStorage && forceEnableScopedStorage; |
| } |
| |
| private static boolean isScopedStorageDisabled(boolean defaultScopedStorage, |
| boolean forceEnableScopedStorage) { |
| return !defaultScopedStorage && !forceEnableScopedStorage; |
| } |
| |
| /** |
| * Returns whether the calling app has All Files Access on the primary shared/external storage |
| * media. |
| * <p>Declaring the permission {@link android.Manifest.permission#MANAGE_EXTERNAL_STORAGE} isn't |
| * enough to gain the access. |
| * <p>To request access, use |
| * {@link android.provider.Settings#ACTION_MANAGE_APP_ALL_FILES_ACCESS_PERMISSION}. |
| */ |
| public static boolean isExternalStorageManager() { |
| final File externalDir = sCurrentUser.getExternalDirs()[0]; |
| return isExternalStorageManager(externalDir); |
| } |
| |
| /** |
| * Returns whether the calling app has All Files Access at the given {@code path} |
| * <p>Declaring the permission {@link android.Manifest.permission#MANAGE_EXTERNAL_STORAGE} isn't |
| * enough to gain the access. |
| * <p>To request access, use |
| * {@link android.provider.Settings#ACTION_MANAGE_APP_ALL_FILES_ACCESS_PERMISSION}. |
| */ |
| public static boolean isExternalStorageManager(@NonNull File path) { |
| final Context context = Objects.requireNonNull(AppGlobals.getInitialApplication()); |
| String packageName = Objects.requireNonNull(context.getPackageName()); |
| int uid = context.getApplicationInfo().uid; |
| |
| final AppOpsManager appOps = context.getSystemService(AppOpsManager.class); |
| final int opMode = |
| appOps.checkOpNoThrow(AppOpsManager.OP_MANAGE_EXTERNAL_STORAGE, uid, packageName); |
| |
| switch (opMode) { |
| case AppOpsManager.MODE_DEFAULT: |
| return PackageManager.PERMISSION_GRANTED |
| == context.checkPermission( |
| Manifest.permission.MANAGE_EXTERNAL_STORAGE, Process.myPid(), uid); |
| case AppOpsManager.MODE_ALLOWED: |
| return true; |
| case AppOpsManager.MODE_ERRORED: |
| case AppOpsManager.MODE_IGNORED: |
| return false; |
| default: |
| throw new IllegalStateException("Unknown AppOpsManager mode " + opMode); |
| } |
| } |
| |
| static File getDirectory(String variableName, String defaultPath) { |
| String path = System.getenv(variableName); |
| return path == null ? new File(defaultPath) : new File(path); |
| } |
| |
| @NonNull |
| static String getDirectoryPath(@NonNull String variableName, @NonNull String defaultPath) { |
| String path = System.getenv(variableName); |
| return path == null ? defaultPath : path; |
| } |
| |
| /** {@hide} */ |
| public static void setUserRequired(boolean userRequired) { |
| sUserRequired = userRequired; |
| } |
| |
| private static void throwIfUserRequired() { |
| if (sUserRequired) { |
| Log.wtf(TAG, "Path requests must specify a user by using UserEnvironment", |
| new Throwable()); |
| } |
| } |
| |
| /** |
| * Append path segments to each given base path, returning result. |
| * |
| * @hide |
| */ |
| @UnsupportedAppUsage |
| public static File[] buildPaths(File[] base, String... segments) { |
| File[] result = new File[base.length]; |
| for (int i = 0; i < base.length; i++) { |
| result[i] = buildPath(base[i], segments); |
| } |
| return result; |
| } |
| |
| /** |
| * Append path segments to given base path, returning result. |
| * |
| * @hide |
| */ |
| @TestApi |
| public static File buildPath(File base, String... segments) { |
| File cur = base; |
| for (String segment : segments) { |
| if (cur == null) { |
| cur = new File(segment); |
| } else { |
| cur = new File(cur, segment); |
| } |
| } |
| return cur; |
| } |
| |
| /** |
| * If the given path exists on emulated external storage, return the |
| * translated backing path hosted on internal storage. This bypasses any |
| * emulation later, improving performance. This is <em>only</em> suitable |
| * for read-only access. |
| * <p> |
| * Returns original path if given path doesn't meet these criteria. Callers |
| * must hold {@link android.Manifest.permission#WRITE_MEDIA_STORAGE} |
| * permission. |
| * |
| * @deprecated disabled now that FUSE has been replaced by sdcardfs |
| * @hide |
| */ |
| @UnsupportedAppUsage |
| @Deprecated |
| public static File maybeTranslateEmulatedPathToInternal(File path) { |
| return StorageManager.maybeTranslateEmulatedPathToInternal(path); |
| } |
| } |
