The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2007 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.os; |
| 18 | |
Jeff Sharkey | 70eb34a | 2018-09-13 11:57:03 -0600 | [diff] [blame] | 19 | import android.annotation.SystemApi; |
Philip P. Moltmann | f80809f | 2018-04-04 11:20:44 -0700 | [diff] [blame] | 20 | import android.annotation.TestApi; |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 21 | import android.app.admin.DevicePolicyManager; |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 22 | import android.content.Context; |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 23 | import android.os.storage.StorageManager; |
Mike Lockwood | 2f6a388 | 2011-05-09 19:08:06 -0700 | [diff] [blame] | 24 | import android.os.storage.StorageVolume; |
Jeff Sharkey | bd0e9e4 | 2015-04-30 16:04:50 -0700 | [diff] [blame] | 25 | import android.text.TextUtils; |
Kenny Root | b2278dc | 2011-01-18 13:03:28 -0800 | [diff] [blame] | 26 | import android.util.Log; |
San Mehat | 7fd0fee | 2009-12-17 07:12:23 -0800 | [diff] [blame] | 27 | |
Gilles Debunne | ee1d630 | 2011-05-13 10:09:32 -0700 | [diff] [blame] | 28 | import java.io.File; |
Jeff Sharkey | 2035614 | 2017-12-06 15:22:05 -0700 | [diff] [blame] | 29 | import java.util.LinkedList; |
Gilles Debunne | ee1d630 | 2011-05-13 10:09:32 -0700 | [diff] [blame] | 30 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 31 | /** |
| 32 | * Provides access to environment variables. |
| 33 | */ |
| 34 | public class Environment { |
Kenny Root | b2278dc | 2011-01-18 13:03:28 -0800 | [diff] [blame] | 35 | private static final String TAG = "Environment"; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 36 | |
Jeff Sharkey | dd02e33 | 2018-06-27 14:41:57 -0600 | [diff] [blame] | 37 | // NOTE: keep credential-protected paths in sync with StrictMode.java |
| 38 | |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 39 | private static final String ENV_EXTERNAL_STORAGE = "EXTERNAL_STORAGE"; |
Jeff Sharkey | 63d0a06 | 2013-03-01 16:12:55 -0800 | [diff] [blame] | 40 | private static final String ENV_ANDROID_ROOT = "ANDROID_ROOT"; |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 41 | private static final String ENV_ANDROID_DATA = "ANDROID_DATA"; |
Jeff Sharkey | cf3f0a1 | 2016-03-17 19:57:58 -0600 | [diff] [blame] | 42 | private static final String ENV_ANDROID_EXPAND = "ANDROID_EXPAND"; |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 43 | private static final String ENV_ANDROID_STORAGE = "ANDROID_STORAGE"; |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 44 | private static final String ENV_DOWNLOAD_CACHE = "DOWNLOAD_CACHE"; |
Jeff Sharkey | 1be762c | 2014-03-06 09:56:23 -0800 | [diff] [blame] | 45 | private static final String ENV_OEM_ROOT = "OEM_ROOT"; |
Hung-ying Tyan | bdc9d58 | 2015-11-20 11:53:39 +0800 | [diff] [blame] | 46 | private static final String ENV_ODM_ROOT = "ODM_ROOT"; |
Christopher Tate | 740888f | 2014-04-18 12:24:57 -0700 | [diff] [blame] | 47 | private static final String ENV_VENDOR_ROOT = "VENDOR_ROOT"; |
Jaekyun Seok | 1713d9e | 2018-01-12 21:47:26 +0900 | [diff] [blame] | 48 | private static final String ENV_PRODUCT_ROOT = "PRODUCT_ROOT"; |
Dario Freni | 2bef176 | 2018-06-01 14:02:08 +0100 | [diff] [blame] | 49 | private static final String ENV_PRODUCT_SERVICES_ROOT = "PRODUCT_SERVICES_ROOT"; |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 50 | |
Jeff Sharkey | dfa4530 | 2012-09-12 16:25:22 -0700 | [diff] [blame] | 51 | /** {@hide} */ |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 52 | public static final String DIR_ANDROID = "Android"; |
Sudheer Shanka | e93db51 | 2019-01-11 16:05:28 -0800 | [diff] [blame] | 53 | private static final String DIR_SANDBOX = "sandbox"; |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 54 | private static final String DIR_DATA = "data"; |
| 55 | private static final String DIR_MEDIA = "media"; |
| 56 | private static final String DIR_OBB = "obb"; |
| 57 | private static final String DIR_FILES = "files"; |
| 58 | private static final String DIR_CACHE = "cache"; |
| 59 | |
| 60 | /** {@hide} */ |
| 61 | @Deprecated |
| 62 | public static final String DIRECTORY_ANDROID = DIR_ANDROID; |
Jeff Sharkey | dfa4530 | 2012-09-12 16:25:22 -0700 | [diff] [blame] | 63 | |
Jeff Sharkey | 63d0a06 | 2013-03-01 16:12:55 -0800 | [diff] [blame] | 64 | private static final File DIR_ANDROID_ROOT = getDirectory(ENV_ANDROID_ROOT, "/system"); |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 65 | private static final File DIR_ANDROID_DATA = getDirectory(ENV_ANDROID_DATA, "/data"); |
Jeff Sharkey | cf3f0a1 | 2016-03-17 19:57:58 -0600 | [diff] [blame] | 66 | private static final File DIR_ANDROID_EXPAND = getDirectory(ENV_ANDROID_EXPAND, "/mnt/expand"); |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 67 | private static final File DIR_ANDROID_STORAGE = getDirectory(ENV_ANDROID_STORAGE, "/storage"); |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 68 | private static final File DIR_DOWNLOAD_CACHE = getDirectory(ENV_DOWNLOAD_CACHE, "/cache"); |
Jeff Sharkey | 1be762c | 2014-03-06 09:56:23 -0800 | [diff] [blame] | 69 | private static final File DIR_OEM_ROOT = getDirectory(ENV_OEM_ROOT, "/oem"); |
Hung-ying Tyan | bdc9d58 | 2015-11-20 11:53:39 +0800 | [diff] [blame] | 70 | private static final File DIR_ODM_ROOT = getDirectory(ENV_ODM_ROOT, "/odm"); |
Christopher Tate | 740888f | 2014-04-18 12:24:57 -0700 | [diff] [blame] | 71 | private static final File DIR_VENDOR_ROOT = getDirectory(ENV_VENDOR_ROOT, "/vendor"); |
Jaekyun Seok | 1713d9e | 2018-01-12 21:47:26 +0900 | [diff] [blame] | 72 | private static final File DIR_PRODUCT_ROOT = getDirectory(ENV_PRODUCT_ROOT, "/product"); |
Dario Freni | 2bef176 | 2018-06-01 14:02:08 +0100 | [diff] [blame] | 73 | private static final File DIR_PRODUCT_SERVICES_ROOT = getDirectory(ENV_PRODUCT_SERVICES_ROOT, |
| 74 | "/product_services"); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 75 | |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 76 | private static UserEnvironment sCurrentUser; |
| 77 | private static boolean sUserRequired; |
Kenny Root | e1ff214 | 2010-10-12 11:20:01 -0700 | [diff] [blame] | 78 | |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 79 | static { |
| 80 | initForCurrentUser(); |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 81 | } |
| 82 | |
| 83 | /** {@hide} */ |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 84 | public static void initForCurrentUser() { |
| 85 | final int userId = UserHandle.myUserId(); |
| 86 | sCurrentUser = new UserEnvironment(userId); |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 87 | } |
| 88 | |
| 89 | /** {@hide} */ |
| 90 | public static class UserEnvironment { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 91 | private final int mUserId; |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 92 | |
| 93 | public UserEnvironment(int userId) { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 94 | mUserId = userId; |
| 95 | } |
Jeff Sharkey | 44cbdec | 2013-10-07 16:49:47 -0700 | [diff] [blame] | 96 | |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 97 | public File[] getExternalDirs() { |
Jeff Sharkey | 4634987 | 2015-07-28 10:49:47 -0700 | [diff] [blame] | 98 | final StorageVolume[] volumes = StorageManager.getVolumeList(mUserId, |
| 99 | StorageManager.FLAG_FOR_WRITE); |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 100 | final File[] files = new File[volumes.length]; |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 101 | for (int i = 0; i < volumes.length; i++) { |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 102 | files[i] = volumes[i].getPathFile(); |
Jeff Sharkey | 3fe5bf6 | 2012-09-18 15:54:52 -0700 | [diff] [blame] | 103 | } |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 104 | return files; |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 105 | } |
| 106 | |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 107 | @Deprecated |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 108 | public File getExternalStorageDirectory() { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 109 | return getExternalDirs()[0]; |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 110 | } |
| 111 | |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 112 | @Deprecated |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 113 | public File getExternalStoragePublicDirectory(String type) { |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 114 | return buildExternalStoragePublicDirs(type)[0]; |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 115 | } |
| 116 | |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 117 | public File[] buildExternalStoragePublicDirs(String type) { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 118 | return buildPaths(getExternalDirs(), type); |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 119 | } |
| 120 | |
Sudheer Shanka | e93db51 | 2019-01-11 16:05:28 -0800 | [diff] [blame] | 121 | public File[] buildExternalStorageAndroidSandboxDirs() { |
| 122 | return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_SANDBOX); |
| 123 | } |
| 124 | |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 125 | public File[] buildExternalStorageAndroidDataDirs() { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 126 | return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA); |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 127 | } |
| 128 | |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 129 | public File[] buildExternalStorageAndroidObbDirs() { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 130 | return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_OBB); |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 131 | } |
| 132 | |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 133 | public File[] buildExternalStorageAppDataDirs(String packageName) { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 134 | return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA, packageName); |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 135 | } |
Jeff Sharkey | 3fe5bf6 | 2012-09-18 15:54:52 -0700 | [diff] [blame] | 136 | |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 137 | public File[] buildExternalStorageAppMediaDirs(String packageName) { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 138 | return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_MEDIA, packageName); |
Jeff Sharkey | 2ee3c1e | 2014-05-30 15:38:35 -0700 | [diff] [blame] | 139 | } |
| 140 | |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 141 | public File[] buildExternalStorageAppObbDirs(String packageName) { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 142 | return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_OBB, packageName); |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 143 | } |
| 144 | |
| 145 | public File[] buildExternalStorageAppFilesDirs(String packageName) { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 146 | return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA, packageName, DIR_FILES); |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 147 | } |
| 148 | |
| 149 | public File[] buildExternalStorageAppCacheDirs(String packageName) { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 150 | return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA, packageName, DIR_CACHE); |
Jeff Sharkey | 3fe5bf6 | 2012-09-18 15:54:52 -0700 | [diff] [blame] | 151 | } |
Mike Lockwood | 2f6a388 | 2011-05-09 19:08:06 -0700 | [diff] [blame] | 152 | } |
San Mehat | 7fd0fee | 2009-12-17 07:12:23 -0800 | [diff] [blame] | 153 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 154 | /** |
Jeff Sharkey | 1be762c | 2014-03-06 09:56:23 -0800 | [diff] [blame] | 155 | * Return root of the "system" partition holding the core Android OS. |
| 156 | * Always present and mounted read-only. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 157 | */ |
| 158 | public static File getRootDirectory() { |
Jeff Sharkey | 63d0a06 | 2013-03-01 16:12:55 -0800 | [diff] [blame] | 159 | return DIR_ANDROID_ROOT; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 160 | } |
| 161 | |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 162 | /** {@hide} */ |
Jeff Sharkey | c609116 | 2018-06-29 17:15:40 -0600 | [diff] [blame] | 163 | @TestApi |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 164 | public static File getStorageDirectory() { |
| 165 | return DIR_ANDROID_STORAGE; |
| 166 | } |
| 167 | |
Jason parks | a3cdaa5 | 2011-01-13 14:15:43 -0600 | [diff] [blame] | 168 | /** |
Jeff Sharkey | 1be762c | 2014-03-06 09:56:23 -0800 | [diff] [blame] | 169 | * Return root directory of the "oem" partition holding OEM customizations, |
| 170 | * if any. If present, the partition is mounted read-only. |
| 171 | * |
| 172 | * @hide |
| 173 | */ |
Jeff Sharkey | 70eb34a | 2018-09-13 11:57:03 -0600 | [diff] [blame] | 174 | @SystemApi |
Jeff Sharkey | 1be762c | 2014-03-06 09:56:23 -0800 | [diff] [blame] | 175 | public static File getOemDirectory() { |
| 176 | return DIR_OEM_ROOT; |
| 177 | } |
| 178 | |
| 179 | /** |
Hung-ying Tyan | bdc9d58 | 2015-11-20 11:53:39 +0800 | [diff] [blame] | 180 | * Return root directory of the "odm" partition holding ODM customizations, |
| 181 | * if any. If present, the partition is mounted read-only. |
| 182 | * |
| 183 | * @hide |
| 184 | */ |
Jeff Sharkey | 70eb34a | 2018-09-13 11:57:03 -0600 | [diff] [blame] | 185 | @SystemApi |
Hung-ying Tyan | bdc9d58 | 2015-11-20 11:53:39 +0800 | [diff] [blame] | 186 | public static File getOdmDirectory() { |
| 187 | return DIR_ODM_ROOT; |
| 188 | } |
| 189 | |
| 190 | /** |
Christopher Tate | 740888f | 2014-04-18 12:24:57 -0700 | [diff] [blame] | 191 | * Return root directory of the "vendor" partition that holds vendor-provided |
| 192 | * software that should persist across simple reflashing of the "system" partition. |
| 193 | * @hide |
| 194 | */ |
Jeff Sharkey | 70eb34a | 2018-09-13 11:57:03 -0600 | [diff] [blame] | 195 | @SystemApi |
Christopher Tate | 740888f | 2014-04-18 12:24:57 -0700 | [diff] [blame] | 196 | public static File getVendorDirectory() { |
| 197 | return DIR_VENDOR_ROOT; |
| 198 | } |
| 199 | |
Jason parks | a3cdaa5 | 2011-01-13 14:15:43 -0600 | [diff] [blame] | 200 | /** |
Jaekyun Seok | 1713d9e | 2018-01-12 21:47:26 +0900 | [diff] [blame] | 201 | * Return root directory of the "product" partition holding product-specific |
| 202 | * customizations if any. If present, the partition is mounted read-only. |
| 203 | * |
| 204 | * @hide |
| 205 | */ |
Jeff Sharkey | 70eb34a | 2018-09-13 11:57:03 -0600 | [diff] [blame] | 206 | @SystemApi |
Anton Hansson | 09e47be | 2018-11-08 12:56:18 +0000 | [diff] [blame] | 207 | @TestApi |
Jaekyun Seok | 1713d9e | 2018-01-12 21:47:26 +0900 | [diff] [blame] | 208 | public static File getProductDirectory() { |
| 209 | return DIR_PRODUCT_ROOT; |
| 210 | } |
| 211 | |
| 212 | /** |
Dario Freni | 2bef176 | 2018-06-01 14:02:08 +0100 | [diff] [blame] | 213 | * Return root directory of the "product_services" partition holding middleware |
| 214 | * services if any. If present, the partition is mounted read-only. |
| 215 | * |
| 216 | * @hide |
| 217 | */ |
Jeff Sharkey | 70eb34a | 2018-09-13 11:57:03 -0600 | [diff] [blame] | 218 | @SystemApi |
Dario Freni | 2bef176 | 2018-06-01 14:02:08 +0100 | [diff] [blame] | 219 | public static File getProductServicesDirectory() { |
| 220 | return DIR_PRODUCT_SERVICES_ROOT; |
| 221 | } |
| 222 | |
| 223 | /** |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 224 | * Return the system directory for a user. This is for use by system |
| 225 | * services to store files relating to the user. This directory will be |
| 226 | * automatically deleted when the user is removed. |
Amith Yamasani | 61f5737 | 2012-08-31 12:12:28 -0700 | [diff] [blame] | 227 | * |
Jeff Sharkey | 3a6a61e | 2018-10-03 10:45:51 -0600 | [diff] [blame] | 228 | * @deprecated This directory is valid and still exists, but but callers |
| 229 | * should <em>strongly</em> consider switching to using either |
| 230 | * {@link #getDataSystemCeDirectory(int)} or |
| 231 | * {@link #getDataSystemDeDirectory(int)}, both of which support |
| 232 | * fast user wipe. |
Amith Yamasani | 61f5737 | 2012-08-31 12:12:28 -0700 | [diff] [blame] | 233 | * @hide |
| 234 | */ |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 235 | @Deprecated |
Amith Yamasani | 61f5737 | 2012-08-31 12:12:28 -0700 | [diff] [blame] | 236 | public static File getUserSystemDirectory(int userId) { |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 237 | return new File(new File(getDataSystemDirectory(), "users"), Integer.toString(userId)); |
Amith Yamasani | 61f5737 | 2012-08-31 12:12:28 -0700 | [diff] [blame] | 238 | } |
| 239 | |
| 240 | /** |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 241 | * Returns the config directory for a user. This is for use by system |
| 242 | * services to store files relating to the user which should be readable by |
| 243 | * any app running as that user. |
Robin Lee | 6959133 | 2014-04-28 16:03:22 +0100 | [diff] [blame] | 244 | * |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 245 | * @deprecated This directory is valid and still exists, but callers should |
| 246 | * <em>strongly</em> consider switching to |
| 247 | * {@link #getDataMiscCeDirectory(int)} which is protected with |
| 248 | * user credentials or {@link #getDataMiscDeDirectory(int)} |
| 249 | * which supports fast user wipe. |
Robin Lee | 6959133 | 2014-04-28 16:03:22 +0100 | [diff] [blame] | 250 | * @hide |
| 251 | */ |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 252 | @Deprecated |
Robin Lee | 6959133 | 2014-04-28 16:03:22 +0100 | [diff] [blame] | 253 | public static File getUserConfigDirectory(int userId) { |
| 254 | return new File(new File(new File( |
| 255 | getDataDirectory(), "misc"), "user"), Integer.toString(userId)); |
| 256 | } |
| 257 | |
| 258 | /** |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 259 | * Return the user data directory. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 260 | */ |
| 261 | public static File getDataDirectory() { |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 262 | return DIR_ANDROID_DATA; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 263 | } |
| 264 | |
Jeff Sharkey | bd0e9e4 | 2015-04-30 16:04:50 -0700 | [diff] [blame] | 265 | /** {@hide} */ |
Jeff Sharkey | 6dce496 | 2015-07-03 18:08:41 -0700 | [diff] [blame] | 266 | public static File getDataDirectory(String volumeUuid) { |
Jeff Sharkey | bd0e9e4 | 2015-04-30 16:04:50 -0700 | [diff] [blame] | 267 | if (TextUtils.isEmpty(volumeUuid)) { |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 268 | return DIR_ANDROID_DATA; |
Jeff Sharkey | bd0e9e4 | 2015-04-30 16:04:50 -0700 | [diff] [blame] | 269 | } else { |
Jeff Sharkey | 6dce496 | 2015-07-03 18:08:41 -0700 | [diff] [blame] | 270 | return new File("/mnt/expand/" + volumeUuid); |
Jeff Sharkey | bd0e9e4 | 2015-04-30 16:04:50 -0700 | [diff] [blame] | 271 | } |
| 272 | } |
| 273 | |
Jeff Sharkey | 6dce496 | 2015-07-03 18:08:41 -0700 | [diff] [blame] | 274 | /** {@hide} */ |
Jeff Sharkey | cf3f0a1 | 2016-03-17 19:57:58 -0600 | [diff] [blame] | 275 | public static File getExpandDirectory() { |
| 276 | return DIR_ANDROID_EXPAND; |
| 277 | } |
| 278 | |
| 279 | /** {@hide} */ |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 280 | public static File getDataSystemDirectory() { |
| 281 | return new File(getDataDirectory(), "system"); |
| 282 | } |
| 283 | |
Amith Yamasani | d04aaa3 | 2016-06-13 12:09:36 -0700 | [diff] [blame] | 284 | /** |
| 285 | * Returns the base directory for per-user system directory, device encrypted. |
| 286 | * {@hide} |
| 287 | */ |
| 288 | public static File getDataSystemDeDirectory() { |
| 289 | return buildPath(getDataDirectory(), "system_de"); |
| 290 | } |
| 291 | |
| 292 | /** |
| 293 | * Returns the base directory for per-user system directory, credential encrypted. |
| 294 | * {@hide} |
| 295 | */ |
| 296 | public static File getDataSystemCeDirectory() { |
| 297 | return buildPath(getDataDirectory(), "system_ce"); |
| 298 | } |
| 299 | |
Jeff Sharkey | 3a6a61e | 2018-10-03 10:45:51 -0600 | [diff] [blame] | 300 | /** |
| 301 | * Return the "credential encrypted" system directory for a user. This is |
| 302 | * for use by system services to store files relating to the user. This |
| 303 | * directory supports fast user wipe, and will be automatically deleted when |
| 304 | * the user is removed. |
| 305 | * <p> |
| 306 | * Data stored under this path is "credential encrypted", which uses an |
| 307 | * encryption key that is entangled with user credentials, such as a PIN or |
| 308 | * password. The contents will only be available once the user has been |
| 309 | * unlocked, as reported by {@code SystemService.onUnlockUser()}. |
| 310 | * <p> |
| 311 | * New code should <em>strongly</em> prefer storing sensitive data in these |
| 312 | * credential encrypted areas. |
| 313 | * |
| 314 | * @hide |
| 315 | */ |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 316 | public static File getDataSystemCeDirectory(int userId) { |
| 317 | return buildPath(getDataDirectory(), "system_ce", String.valueOf(userId)); |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 318 | } |
| 319 | |
Jeff Sharkey | 3a6a61e | 2018-10-03 10:45:51 -0600 | [diff] [blame] | 320 | /** |
| 321 | * Return the "device encrypted" system directory for a user. This is for |
| 322 | * use by system services to store files relating to the user. This |
| 323 | * directory supports fast user wipe, and will be automatically deleted when |
| 324 | * the user is removed. |
| 325 | * <p> |
| 326 | * Data stored under this path is "device encrypted", which uses an |
| 327 | * encryption key that is tied to the physical device. The contents will |
| 328 | * only be available once the device has finished a {@code dm-verity} |
| 329 | * protected boot. |
| 330 | * <p> |
| 331 | * New code should <em>strongly</em> avoid storing sensitive data in these |
| 332 | * device encrypted areas. |
| 333 | * |
| 334 | * @hide |
| 335 | */ |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 336 | public static File getDataSystemDeDirectory(int userId) { |
| 337 | return buildPath(getDataDirectory(), "system_de", String.valueOf(userId)); |
| 338 | } |
| 339 | |
| 340 | /** {@hide} */ |
| 341 | public static File getDataMiscDirectory() { |
| 342 | return new File(getDataDirectory(), "misc"); |
| 343 | } |
| 344 | |
| 345 | /** {@hide} */ |
Amith Yamasani | a280713 | 2017-01-26 12:35:14 -0800 | [diff] [blame] | 346 | public static File getDataMiscCeDirectory() { |
| 347 | return buildPath(getDataDirectory(), "misc_ce"); |
| 348 | } |
| 349 | |
| 350 | /** {@hide} */ |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 351 | public static File getDataMiscCeDirectory(int userId) { |
| 352 | return buildPath(getDataDirectory(), "misc_ce", String.valueOf(userId)); |
| 353 | } |
| 354 | |
| 355 | /** {@hide} */ |
| 356 | public static File getDataMiscDeDirectory(int userId) { |
| 357 | return buildPath(getDataDirectory(), "misc_de", String.valueOf(userId)); |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 358 | } |
| 359 | |
Calin Juravle | d479b52 | 2016-02-24 16:22:03 +0000 | [diff] [blame] | 360 | private static File getDataProfilesDeDirectory(int userId) { |
| 361 | return buildPath(getDataDirectory(), "misc", "profiles", "cur", String.valueOf(userId)); |
| 362 | } |
| 363 | |
| 364 | /** {@hide} */ |
Andreas Huber | 7fe2053 | 2018-01-22 11:26:44 -0800 | [diff] [blame] | 365 | public static File getDataVendorCeDirectory(int userId) { |
| 366 | return buildPath(getDataDirectory(), "vendor_ce", String.valueOf(userId)); |
| 367 | } |
| 368 | |
| 369 | /** {@hide} */ |
| 370 | public static File getDataVendorDeDirectory(int userId) { |
| 371 | return buildPath(getDataDirectory(), "vendor_de", String.valueOf(userId)); |
| 372 | } |
| 373 | |
| 374 | /** {@hide} */ |
Calin Juravle | 6ae39fc | 2018-01-19 20:32:47 -0800 | [diff] [blame] | 375 | public static File getDataRefProfilesDePackageDirectory(String packageName) { |
| 376 | return buildPath(getDataDirectory(), "misc", "profiles", "ref", packageName); |
Calin Juravle | 0bd7762 | 2016-07-12 15:56:41 +0100 | [diff] [blame] | 377 | } |
| 378 | |
| 379 | /** {@hide} */ |
Calin Juravle | d479b52 | 2016-02-24 16:22:03 +0000 | [diff] [blame] | 380 | public static File getDataProfilesDePackageDirectory(int userId, String packageName) { |
| 381 | return buildPath(getDataProfilesDeDirectory(userId), packageName); |
| 382 | } |
| 383 | |
| 384 | /** {@hide} */ |
Jeff Sharkey | 6dce496 | 2015-07-03 18:08:41 -0700 | [diff] [blame] | 385 | public static File getDataAppDirectory(String volumeUuid) { |
| 386 | return new File(getDataDirectory(volumeUuid), "app"); |
| 387 | } |
| 388 | |
| 389 | /** {@hide} */ |
Dario Freni | a8f4b13 | 2018-12-30 00:36:49 +0000 | [diff] [blame] | 390 | public static File getDataStagingDirectory(String volumeUuid) { |
Gavin Corkery | 5ae3856 | 2019-02-18 14:11:57 +0000 | [diff] [blame] | 391 | return new File(getDataDirectory(volumeUuid), "pkg_staging"); |
Dario Freni | a8f4b13 | 2018-12-30 00:36:49 +0000 | [diff] [blame] | 392 | } |
| 393 | |
| 394 | /** {@hide} */ |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 395 | public static File getDataUserCeDirectory(String volumeUuid) { |
Jeff Sharkey | 6dce496 | 2015-07-03 18:08:41 -0700 | [diff] [blame] | 396 | return new File(getDataDirectory(volumeUuid), "user"); |
| 397 | } |
| 398 | |
| 399 | /** {@hide} */ |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 400 | public static File getDataUserCeDirectory(String volumeUuid, int userId) { |
| 401 | return new File(getDataUserCeDirectory(volumeUuid), String.valueOf(userId)); |
Jeff Sharkey | 6dce496 | 2015-07-03 18:08:41 -0700 | [diff] [blame] | 402 | } |
| 403 | |
| 404 | /** {@hide} */ |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 405 | public static File getDataUserCePackageDirectory(String volumeUuid, int userId, |
Jeff Sharkey | 6dce496 | 2015-07-03 18:08:41 -0700 | [diff] [blame] | 406 | String packageName) { |
| 407 | // TODO: keep consistent with installd |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 408 | return new File(getDataUserCeDirectory(volumeUuid, userId), packageName); |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 409 | } |
| 410 | |
| 411 | /** {@hide} */ |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 412 | public static File getDataUserDeDirectory(String volumeUuid) { |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 413 | return new File(getDataDirectory(volumeUuid), "user_de"); |
| 414 | } |
| 415 | |
| 416 | /** {@hide} */ |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 417 | public static File getDataUserDeDirectory(String volumeUuid, int userId) { |
| 418 | return new File(getDataUserDeDirectory(volumeUuid), String.valueOf(userId)); |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 419 | } |
| 420 | |
| 421 | /** {@hide} */ |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 422 | public static File getDataUserDePackageDirectory(String volumeUuid, int userId, |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 423 | String packageName) { |
| 424 | // TODO: keep consistent with installd |
Jeff Sharkey | 8212ae0 | 2016-02-10 14:46:43 -0700 | [diff] [blame] | 425 | return new File(getDataUserDeDirectory(volumeUuid, userId), packageName); |
Jeff Sharkey | 6dce496 | 2015-07-03 18:08:41 -0700 | [diff] [blame] | 426 | } |
| 427 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 428 | /** |
Fyodor Kupolov | 8825758 | 2016-05-24 16:06:56 -0700 | [diff] [blame] | 429 | * Return preloads directory. |
| 430 | * <p>This directory may contain pre-loaded content such as |
| 431 | * {@link #getDataPreloadsDemoDirectory() demo videos} and |
| 432 | * {@link #getDataPreloadsAppsDirectory() APK files} . |
| 433 | * {@hide} |
| 434 | */ |
| 435 | public static File getDataPreloadsDirectory() { |
| 436 | return new File(getDataDirectory(), "preloads"); |
| 437 | } |
| 438 | |
| 439 | /** |
| 440 | * @see #getDataPreloadsDirectory() |
| 441 | * {@hide} |
| 442 | */ |
| 443 | public static File getDataPreloadsDemoDirectory() { |
| 444 | return new File(getDataPreloadsDirectory(), "demo"); |
| 445 | } |
| 446 | |
| 447 | /** |
| 448 | * @see #getDataPreloadsDirectory() |
| 449 | * {@hide} |
| 450 | */ |
| 451 | public static File getDataPreloadsAppsDirectory() { |
| 452 | return new File(getDataPreloadsDirectory(), "apps"); |
| 453 | } |
| 454 | |
| 455 | /** |
Fyodor Kupolov | 19551a8 | 2016-08-22 14:46:08 -0700 | [diff] [blame] | 456 | * @see #getDataPreloadsDirectory() |
| 457 | * {@hide} |
| 458 | */ |
| 459 | public static File getDataPreloadsMediaDirectory() { |
| 460 | return new File(getDataPreloadsDirectory(), "media"); |
| 461 | } |
| 462 | |
| 463 | /** |
Fyodor Kupolov | 6e68706 | 2016-09-09 17:42:12 -0700 | [diff] [blame] | 464 | * Returns location of preloaded cache directory for package name |
| 465 | * @see #getDataPreloadsDirectory() |
| 466 | * {@hide} |
| 467 | */ |
| 468 | public static File getDataPreloadsFileCacheDirectory(String packageName) { |
| 469 | return new File(getDataPreloadsFileCacheDirectory(), packageName); |
| 470 | } |
| 471 | |
| 472 | /** |
| 473 | * Returns location of preloaded cache directory. |
| 474 | * @see #getDataPreloadsDirectory() |
| 475 | * {@hide} |
| 476 | */ |
| 477 | public static File getDataPreloadsFileCacheDirectory() { |
| 478 | return new File(getDataPreloadsDirectory(), "file_cache"); |
| 479 | } |
| 480 | |
| 481 | /** |
Sudheer Shanka | be0febe | 2018-11-07 18:24:37 -0800 | [diff] [blame] | 482 | * Returns location of packages cache directory. |
| 483 | * {@hide} |
| 484 | */ |
| 485 | public static File getPackageCacheDirectory() { |
| 486 | return new File(getDataSystemDirectory(), "package_cache"); |
| 487 | } |
| 488 | |
| 489 | /** |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 490 | * Return the primary shared/external storage directory. This directory may |
| 491 | * not currently be accessible if it has been mounted by the user on their |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 492 | * computer, has been removed from the device, or some other problem has |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 493 | * happened. You can determine its current state with |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 494 | * {@link #getExternalStorageState()}. |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 495 | * <p> |
| 496 | * <em>Note: don't be confused by the word "external" here. This directory |
| 497 | * can better be thought as media/shared storage. It is a filesystem that |
| 498 | * can hold a relatively large amount of data and that is shared across all |
| 499 | * applications (does not enforce permissions). Traditionally this is an SD |
| 500 | * card, but it may also be implemented as built-in storage in a device that |
| 501 | * is distinct from the protected internal storage and can be mounted as a |
| 502 | * filesystem on a computer.</em> |
| 503 | * <p> |
| 504 | * On devices with multiple users (as described by {@link UserManager}), |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 505 | * each user has their own isolated shared storage. Applications only have |
| 506 | * access to the shared storage for the user they're running as. |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 507 | * <p> |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 508 | * In devices with multiple shared/external storage directories, this |
| 509 | * directory represents the primary storage that the user will interact |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 510 | * with. Access to secondary storage is available through |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 511 | * {@link Context#getExternalFilesDirs(String)}, |
| 512 | * {@link Context#getExternalCacheDirs()}, and |
| 513 | * {@link Context#getExternalMediaDirs()}. |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 514 | * <p> |
| 515 | * Applications should not directly use this top-level directory, in order |
| 516 | * to avoid polluting the user's root namespace. Any files that are private |
| 517 | * to the application should be placed in a directory returned by |
| 518 | * {@link android.content.Context#getExternalFilesDir |
Dianne Hackborn | acaf028 | 2010-03-30 14:39:35 -0700 | [diff] [blame] | 519 | * Context.getExternalFilesDir}, which the system will take care of deleting |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 520 | * if the application is uninstalled. Other shared files should be placed in |
| 521 | * one of the directories returned by |
| 522 | * {@link #getExternalStoragePublicDirectory}. |
| 523 | * <p> |
| 524 | * Writing to this path requires the |
| 525 | * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} permission, |
Felipe Leme | 04a5d40 | 2016-02-08 16:44:06 -0800 | [diff] [blame] | 526 | * and starting in {@link android.os.Build.VERSION_CODES#KITKAT}, read access requires the |
Jeff Sharkey | 8c16579 | 2012-10-22 14:08:29 -0700 | [diff] [blame] | 527 | * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} permission, |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 528 | * which is automatically granted if you hold the write permission. |
| 529 | * <p> |
Chet Haase | e8222dd | 2013-09-05 07:44:18 -0700 | [diff] [blame] | 530 | * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, if your |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 531 | * application only needs to store internal data, consider using |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 532 | * {@link Context#getExternalFilesDir(String)}, |
| 533 | * {@link Context#getExternalCacheDir()}, or |
| 534 | * {@link Context#getExternalMediaDirs()}, which require no permissions to |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 535 | * read or write. |
| 536 | * <p> |
| 537 | * This path may change between platform versions, so applications should |
| 538 | * only persist relative paths. |
| 539 | * <p> |
| 540 | * Here is an example of typical code to monitor the state of external |
| 541 | * storage: |
| 542 | * <p> |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 543 | * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 544 | * monitor_storage} |
Dianne Hackborn | 407f625 | 2010-10-04 11:31:17 -0700 | [diff] [blame] | 545 | * |
| 546 | * @see #getExternalStorageState() |
| 547 | * @see #isExternalStorageRemovable() |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 548 | */ |
| 549 | public static File getExternalStorageDirectory() { |
Jeff Sharkey | 48749fc | 2013-04-19 13:25:04 -0700 | [diff] [blame] | 550 | throwIfUserRequired(); |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 551 | return sCurrentUser.getExternalDirs()[0]; |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 552 | } |
| 553 | |
| 554 | /** {@hide} */ |
| 555 | public static File getLegacyExternalStorageDirectory() { |
| 556 | return new File(System.getenv(ENV_EXTERNAL_STORAGE)); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 557 | } |
| 558 | |
Jeff Sharkey | 4fbbda4 | 2012-09-24 18:34:07 -0700 | [diff] [blame] | 559 | /** {@hide} */ |
| 560 | public static File getLegacyExternalStorageObbDirectory() { |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 561 | return buildPath(getLegacyExternalStorageDirectory(), DIR_ANDROID, DIR_OBB); |
Jeff Sharkey | 4fbbda4 | 2012-09-24 18:34:07 -0700 | [diff] [blame] | 562 | } |
| 563 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 564 | /** |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 565 | * Standard directory in which to place any audio files that should be |
| 566 | * in the regular list of music for the user. |
| 567 | * This may be combined with |
| 568 | * {@link #DIRECTORY_PODCASTS}, {@link #DIRECTORY_NOTIFICATIONS}, |
| 569 | * {@link #DIRECTORY_ALARMS}, and {@link #DIRECTORY_RINGTONES} as a series |
| 570 | * of directories to categories a particular audio file as more than one |
| 571 | * type. |
| 572 | */ |
| 573 | public static String DIRECTORY_MUSIC = "Music"; |
Felipe Leme | c7b1f89 | 2016-01-15 15:02:31 -0800 | [diff] [blame] | 574 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 575 | /** |
| 576 | * Standard directory in which to place any audio files that should be |
| 577 | * in the list of podcasts that the user can select (not as regular |
| 578 | * music). |
| 579 | * This may be combined with {@link #DIRECTORY_MUSIC}, |
| 580 | * {@link #DIRECTORY_NOTIFICATIONS}, |
| 581 | * {@link #DIRECTORY_ALARMS}, and {@link #DIRECTORY_RINGTONES} as a series |
| 582 | * of directories to categories a particular audio file as more than one |
| 583 | * type. |
| 584 | */ |
| 585 | public static String DIRECTORY_PODCASTS = "Podcasts"; |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 586 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 587 | /** |
| 588 | * Standard directory in which to place any audio files that should be |
| 589 | * in the list of ringtones that the user can select (not as regular |
| 590 | * music). |
| 591 | * This may be combined with {@link #DIRECTORY_MUSIC}, |
| 592 | * {@link #DIRECTORY_PODCASTS}, {@link #DIRECTORY_NOTIFICATIONS}, and |
| 593 | * {@link #DIRECTORY_ALARMS} as a series |
| 594 | * of directories to categories a particular audio file as more than one |
| 595 | * type. |
| 596 | */ |
| 597 | public static String DIRECTORY_RINGTONES = "Ringtones"; |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 598 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 599 | /** |
| 600 | * Standard directory in which to place any audio files that should be |
| 601 | * in the list of alarms that the user can select (not as regular |
| 602 | * music). |
| 603 | * This may be combined with {@link #DIRECTORY_MUSIC}, |
| 604 | * {@link #DIRECTORY_PODCASTS}, {@link #DIRECTORY_NOTIFICATIONS}, |
| 605 | * and {@link #DIRECTORY_RINGTONES} as a series |
| 606 | * of directories to categories a particular audio file as more than one |
| 607 | * type. |
| 608 | */ |
| 609 | public static String DIRECTORY_ALARMS = "Alarms"; |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 610 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 611 | /** |
| 612 | * Standard directory in which to place any audio files that should be |
| 613 | * in the list of notifications that the user can select (not as regular |
| 614 | * music). |
| 615 | * This may be combined with {@link #DIRECTORY_MUSIC}, |
| 616 | * {@link #DIRECTORY_PODCASTS}, |
| 617 | * {@link #DIRECTORY_ALARMS}, and {@link #DIRECTORY_RINGTONES} as a series |
| 618 | * of directories to categories a particular audio file as more than one |
| 619 | * type. |
| 620 | */ |
| 621 | public static String DIRECTORY_NOTIFICATIONS = "Notifications"; |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 622 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 623 | /** |
| 624 | * Standard directory in which to place pictures that are available to |
| 625 | * the user. Note that this is primarily a convention for the top-level |
| 626 | * public directory, as the media scanner will find and collect pictures |
| 627 | * in any directory. |
| 628 | */ |
| 629 | public static String DIRECTORY_PICTURES = "Pictures"; |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 630 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 631 | /** |
| 632 | * Standard directory in which to place movies that are available to |
| 633 | * the user. Note that this is primarily a convention for the top-level |
| 634 | * public directory, as the media scanner will find and collect movies |
| 635 | * in any directory. |
| 636 | */ |
| 637 | public static String DIRECTORY_MOVIES = "Movies"; |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 638 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 639 | /** |
| 640 | * Standard directory in which to place files that have been downloaded by |
| 641 | * the user. Note that this is primarily a convention for the top-level |
| 642 | * public directory, you are free to download files anywhere in your own |
Dianne Hackborn | ce59fb8 | 2010-04-07 17:19:04 -0700 | [diff] [blame] | 643 | * private directories. Also note that though the constant here is |
| 644 | * named DIRECTORY_DOWNLOADS (plural), the actual file name is non-plural for |
| 645 | * backwards compatibility reasons. |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 646 | */ |
Dianne Hackborn | ce59fb8 | 2010-04-07 17:19:04 -0700 | [diff] [blame] | 647 | public static String DIRECTORY_DOWNLOADS = "Download"; |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 648 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 649 | /** |
| 650 | * The traditional location for pictures and videos when mounting the |
| 651 | * device as a camera. Note that this is primarily a convention for the |
| 652 | * top-level public directory, as this convention makes no sense elsewhere. |
| 653 | */ |
| 654 | public static String DIRECTORY_DCIM = "DCIM"; |
Jeff Sharkey | 3e1189b | 2013-09-12 21:59:06 -0700 | [diff] [blame] | 655 | |
| 656 | /** |
| 657 | * Standard directory in which to place documents that have been created by |
| 658 | * the user. |
| 659 | */ |
| 660 | public static String DIRECTORY_DOCUMENTS = "Documents"; |
| 661 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 662 | /** |
Jeff Sharkey | c8e4924 | 2018-11-02 14:34:44 -0600 | [diff] [blame] | 663 | * Standard directory in which to place screenshots that have been taken by |
| 664 | * the user. Typically used as a secondary directory under |
| 665 | * {@link #DIRECTORY_PICTURES}. |
| 666 | */ |
| 667 | public static String DIRECTORY_SCREENSHOTS = "Screenshots"; |
| 668 | |
| 669 | /** |
Jeff Sharkey | 10887d5 | 2018-11-30 13:44:41 -0700 | [diff] [blame] | 670 | * Standard directory in which to place any audio files which are |
| 671 | * audiobooks. |
| 672 | */ |
| 673 | public static String DIRECTORY_AUDIOBOOKS = "Audiobooks"; |
| 674 | |
| 675 | /** |
Felipe Leme | c7b1f89 | 2016-01-15 15:02:31 -0800 | [diff] [blame] | 676 | * List of standard storage directories. |
| 677 | * <p> |
| 678 | * Each of its values have its own constant: |
| 679 | * <ul> |
| 680 | * <li>{@link #DIRECTORY_MUSIC} |
| 681 | * <li>{@link #DIRECTORY_PODCASTS} |
| 682 | * <li>{@link #DIRECTORY_ALARMS} |
| 683 | * <li>{@link #DIRECTORY_RINGTONES} |
| 684 | * <li>{@link #DIRECTORY_NOTIFICATIONS} |
| 685 | * <li>{@link #DIRECTORY_PICTURES} |
| 686 | * <li>{@link #DIRECTORY_MOVIES} |
| 687 | * <li>{@link #DIRECTORY_DOWNLOADS} |
| 688 | * <li>{@link #DIRECTORY_DCIM} |
| 689 | * <li>{@link #DIRECTORY_DOCUMENTS} |
Jeff Sharkey | 10887d5 | 2018-11-30 13:44:41 -0700 | [diff] [blame] | 690 | * <li>{@link #DIRECTORY_AUDIOBOOKS} |
Felipe Leme | c7b1f89 | 2016-01-15 15:02:31 -0800 | [diff] [blame] | 691 | * </ul> |
| 692 | * @hide |
| 693 | */ |
Felipe Leme | 3e166b2 | 2016-02-24 10:17:41 -0800 | [diff] [blame] | 694 | public static final String[] STANDARD_DIRECTORIES = { |
Felipe Leme | c7b1f89 | 2016-01-15 15:02:31 -0800 | [diff] [blame] | 695 | DIRECTORY_MUSIC, |
| 696 | DIRECTORY_PODCASTS, |
| 697 | DIRECTORY_RINGTONES, |
| 698 | DIRECTORY_ALARMS, |
| 699 | DIRECTORY_NOTIFICATIONS, |
| 700 | DIRECTORY_PICTURES, |
| 701 | DIRECTORY_MOVIES, |
| 702 | DIRECTORY_DOWNLOADS, |
| 703 | DIRECTORY_DCIM, |
Jeff Sharkey | 10887d5 | 2018-11-30 13:44:41 -0700 | [diff] [blame] | 704 | DIRECTORY_DOCUMENTS, |
| 705 | DIRECTORY_AUDIOBOOKS, |
Felipe Leme | c7b1f89 | 2016-01-15 15:02:31 -0800 | [diff] [blame] | 706 | }; |
| 707 | |
| 708 | /** |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 709 | * @hide |
| 710 | */ |
| 711 | public static boolean isStandardDirectory(String dir) { |
| 712 | for (String valid : STANDARD_DIRECTORIES) { |
| 713 | if (valid.equals(dir)) { |
| 714 | return true; |
| 715 | } |
| 716 | } |
| 717 | return false; |
| 718 | } |
| 719 | |
Jeff Sharkey | 2035614 | 2017-12-06 15:22:05 -0700 | [diff] [blame] | 720 | /** {@hide} */ public static final int HAS_MUSIC = 1 << 0; |
| 721 | /** {@hide} */ public static final int HAS_PODCASTS = 1 << 1; |
| 722 | /** {@hide} */ public static final int HAS_RINGTONES = 1 << 2; |
| 723 | /** {@hide} */ public static final int HAS_ALARMS = 1 << 3; |
| 724 | /** {@hide} */ public static final int HAS_NOTIFICATIONS = 1 << 4; |
| 725 | /** {@hide} */ public static final int HAS_PICTURES = 1 << 5; |
| 726 | /** {@hide} */ public static final int HAS_MOVIES = 1 << 6; |
| 727 | /** {@hide} */ public static final int HAS_DOWNLOADS = 1 << 7; |
| 728 | /** {@hide} */ public static final int HAS_DCIM = 1 << 8; |
| 729 | /** {@hide} */ public static final int HAS_DOCUMENTS = 1 << 9; |
Jeff Sharkey | 10887d5 | 2018-11-30 13:44:41 -0700 | [diff] [blame] | 730 | /** {@hide} */ public static final int HAS_AUDIOBOOKS = 1 << 10; |
Jeff Sharkey | 2035614 | 2017-12-06 15:22:05 -0700 | [diff] [blame] | 731 | |
| 732 | /** {@hide} */ public static final int HAS_ANDROID = 1 << 16; |
| 733 | /** {@hide} */ public static final int HAS_OTHER = 1 << 17; |
| 734 | |
| 735 | /** |
| 736 | * Classify the content types present on the given external storage device. |
| 737 | * <p> |
| 738 | * This is typically useful for deciding if an inserted SD card is empty, or |
| 739 | * if it contains content like photos that should be preserved. |
| 740 | * |
| 741 | * @hide |
| 742 | */ |
| 743 | public static int classifyExternalStorageDirectory(File dir) { |
| 744 | int res = 0; |
| 745 | for (File f : FileUtils.listFilesOrEmpty(dir)) { |
| 746 | if (f.isFile() && isInterestingFile(f)) { |
| 747 | res |= HAS_OTHER; |
| 748 | } else if (f.isDirectory() && hasInterestingFiles(f)) { |
| 749 | final String name = f.getName(); |
| 750 | if (DIRECTORY_MUSIC.equals(name)) res |= HAS_MUSIC; |
| 751 | else if (DIRECTORY_PODCASTS.equals(name)) res |= HAS_PODCASTS; |
| 752 | else if (DIRECTORY_RINGTONES.equals(name)) res |= HAS_RINGTONES; |
| 753 | else if (DIRECTORY_ALARMS.equals(name)) res |= HAS_ALARMS; |
| 754 | else if (DIRECTORY_NOTIFICATIONS.equals(name)) res |= HAS_NOTIFICATIONS; |
| 755 | else if (DIRECTORY_PICTURES.equals(name)) res |= HAS_PICTURES; |
| 756 | else if (DIRECTORY_MOVIES.equals(name)) res |= HAS_MOVIES; |
| 757 | else if (DIRECTORY_DOWNLOADS.equals(name)) res |= HAS_DOWNLOADS; |
| 758 | else if (DIRECTORY_DCIM.equals(name)) res |= HAS_DCIM; |
| 759 | else if (DIRECTORY_DOCUMENTS.equals(name)) res |= HAS_DOCUMENTS; |
Jeff Sharkey | 10887d5 | 2018-11-30 13:44:41 -0700 | [diff] [blame] | 760 | else if (DIRECTORY_AUDIOBOOKS.equals(name)) res |= HAS_AUDIOBOOKS; |
Jeff Sharkey | 2035614 | 2017-12-06 15:22:05 -0700 | [diff] [blame] | 761 | else if (DIRECTORY_ANDROID.equals(name)) res |= HAS_ANDROID; |
| 762 | else res |= HAS_OTHER; |
| 763 | } |
| 764 | } |
| 765 | return res; |
| 766 | } |
| 767 | |
| 768 | private static boolean hasInterestingFiles(File dir) { |
| 769 | final LinkedList<File> explore = new LinkedList<>(); |
| 770 | explore.add(dir); |
| 771 | while (!explore.isEmpty()) { |
| 772 | dir = explore.pop(); |
| 773 | for (File f : FileUtils.listFilesOrEmpty(dir)) { |
| 774 | if (isInterestingFile(f)) return true; |
| 775 | if (f.isDirectory()) explore.add(f); |
| 776 | } |
| 777 | } |
| 778 | return false; |
| 779 | } |
| 780 | |
| 781 | private static boolean isInterestingFile(File file) { |
| 782 | if (file.isFile()) { |
| 783 | final String name = file.getName().toLowerCase(); |
| 784 | if (name.endsWith(".exe") || name.equals("autorun.inf") |
| 785 | || name.equals("launchpad.zip") || name.equals(".nomedia")) { |
| 786 | return false; |
| 787 | } else { |
| 788 | return true; |
| 789 | } |
| 790 | } else { |
| 791 | return false; |
| 792 | } |
| 793 | } |
| 794 | |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 795 | /** |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 796 | * Get a top-level shared/external storage directory for placing files of a |
| 797 | * particular type. This is where the user will typically place and manage |
| 798 | * their own files, so you should be careful about what you put here to |
| 799 | * ensure you don't erase their files or get in the way of their own |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 800 | * organization. |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 801 | * <p> |
| 802 | * On devices with multiple users (as described by {@link UserManager}), |
| 803 | * each user has their own isolated shared storage. Applications only have |
| 804 | * access to the shared storage for the user they're running as. |
| 805 | * </p> |
| 806 | * <p> |
| 807 | * Here is an example of typical code to manipulate a picture on the public |
| 808 | * shared storage: |
| 809 | * </p> |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 810 | * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java |
| 811 | * public_picture} |
Felipe Leme | c7b1f89 | 2016-01-15 15:02:31 -0800 | [diff] [blame] | 812 | * |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 813 | * @param type The type of storage directory to return. Should be one of |
| 814 | * {@link #DIRECTORY_MUSIC}, {@link #DIRECTORY_PODCASTS}, |
| 815 | * {@link #DIRECTORY_RINGTONES}, {@link #DIRECTORY_ALARMS}, |
| 816 | * {@link #DIRECTORY_NOTIFICATIONS}, {@link #DIRECTORY_PICTURES}, |
Felipe Leme | c7b1f89 | 2016-01-15 15:02:31 -0800 | [diff] [blame] | 817 | * {@link #DIRECTORY_MOVIES}, {@link #DIRECTORY_DOWNLOADS}, |
| 818 | * {@link #DIRECTORY_DCIM}, or {@link #DIRECTORY_DOCUMENTS}. May not be null. |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 819 | * @return Returns the File path for the directory. Note that this directory |
| 820 | * may not yet exist, so you must make sure it exists before using |
| 821 | * it such as with {@link File#mkdirs File.mkdirs()}. |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 822 | */ |
| 823 | public static File getExternalStoragePublicDirectory(String type) { |
Jeff Sharkey | 48749fc | 2013-04-19 13:25:04 -0700 | [diff] [blame] | 824 | throwIfUserRequired(); |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 825 | return sCurrentUser.buildExternalStoragePublicDirs(type)[0]; |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 826 | } |
| 827 | |
| 828 | /** |
| 829 | * Returns the path for android-specific data on the SD card. |
| 830 | * @hide |
| 831 | */ |
Sudheer Shanka | e93db51 | 2019-01-11 16:05:28 -0800 | [diff] [blame] | 832 | public static File[] buildExternalStorageAndroidSandboxDirs() { |
| 833 | throwIfUserRequired(); |
| 834 | return sCurrentUser.buildExternalStorageAndroidSandboxDirs(); |
| 835 | } |
| 836 | |
| 837 | /** |
| 838 | * Returns the path for android-specific data on the SD card. |
| 839 | * @hide |
| 840 | */ |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 841 | public static File[] buildExternalStorageAndroidDataDirs() { |
Jeff Sharkey | 48749fc | 2013-04-19 13:25:04 -0700 | [diff] [blame] | 842 | throwIfUserRequired(); |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 843 | return sCurrentUser.buildExternalStorageAndroidDataDirs(); |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 844 | } |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 845 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 846 | /** |
| 847 | * Generates the raw path to an application's data |
| 848 | * @hide |
| 849 | */ |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 850 | public static File[] buildExternalStorageAppDataDirs(String packageName) { |
Jeff Sharkey | 48749fc | 2013-04-19 13:25:04 -0700 | [diff] [blame] | 851 | throwIfUserRequired(); |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 852 | return sCurrentUser.buildExternalStorageAppDataDirs(packageName); |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 853 | } |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 854 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 855 | /** |
| 856 | * Generates the raw path to an application's media |
| 857 | * @hide |
| 858 | */ |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 859 | public static File[] buildExternalStorageAppMediaDirs(String packageName) { |
Jeff Sharkey | 48749fc | 2013-04-19 13:25:04 -0700 | [diff] [blame] | 860 | throwIfUserRequired(); |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 861 | return sCurrentUser.buildExternalStorageAppMediaDirs(packageName); |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 862 | } |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 863 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 864 | /** |
Dianne Hackborn | 805fd7e | 2011-01-16 18:30:29 -0800 | [diff] [blame] | 865 | * Generates the raw path to an application's OBB files |
| 866 | * @hide |
| 867 | */ |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 868 | public static File[] buildExternalStorageAppObbDirs(String packageName) { |
Jeff Sharkey | 48749fc | 2013-04-19 13:25:04 -0700 | [diff] [blame] | 869 | throwIfUserRequired(); |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 870 | return sCurrentUser.buildExternalStorageAppObbDirs(packageName); |
Dianne Hackborn | 805fd7e | 2011-01-16 18:30:29 -0800 | [diff] [blame] | 871 | } |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 872 | |
Dianne Hackborn | 805fd7e | 2011-01-16 18:30:29 -0800 | [diff] [blame] | 873 | /** |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 874 | * Generates the path to an application's files. |
| 875 | * @hide |
| 876 | */ |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 877 | public static File[] buildExternalStorageAppFilesDirs(String packageName) { |
Jeff Sharkey | 48749fc | 2013-04-19 13:25:04 -0700 | [diff] [blame] | 878 | throwIfUserRequired(); |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 879 | return sCurrentUser.buildExternalStorageAppFilesDirs(packageName); |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 880 | } |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 881 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 882 | /** |
| 883 | * Generates the path to an application's cache. |
| 884 | * @hide |
| 885 | */ |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 886 | public static File[] buildExternalStorageAppCacheDirs(String packageName) { |
Jeff Sharkey | 48749fc | 2013-04-19 13:25:04 -0700 | [diff] [blame] | 887 | throwIfUserRequired(); |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 888 | return sCurrentUser.buildExternalStorageAppCacheDirs(packageName); |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 889 | } |
Felipe Leme | b012f91 | 2016-01-22 16:49:55 -0800 | [diff] [blame] | 890 | |
Dianne Hackborn | e83cefce | 2010-02-04 17:38:14 -0800 | [diff] [blame] | 891 | /** |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 892 | * Return the download/cache content directory. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 893 | */ |
| 894 | public static File getDownloadCacheDirectory() { |
Jeff Sharkey | 1544779 | 2015-11-05 16:18:51 -0800 | [diff] [blame] | 895 | return DIR_DOWNLOAD_CACHE; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 896 | } |
| 897 | |
| 898 | /** |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 899 | * Unknown storage state, such as when a path isn't backed by known storage |
| 900 | * media. |
| 901 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 902 | * @see #getExternalStorageState(File) |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 903 | */ |
| 904 | public static final String MEDIA_UNKNOWN = "unknown"; |
| 905 | |
| 906 | /** |
| 907 | * Storage state if the media is not present. |
| 908 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 909 | * @see #getExternalStorageState(File) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 910 | */ |
| 911 | public static final String MEDIA_REMOVED = "removed"; |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 912 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 913 | /** |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 914 | * Storage state if the media is present but not mounted. |
| 915 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 916 | * @see #getExternalStorageState(File) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 917 | */ |
| 918 | public static final String MEDIA_UNMOUNTED = "unmounted"; |
| 919 | |
| 920 | /** |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 921 | * Storage state if the media is present and being disk-checked. |
| 922 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 923 | * @see #getExternalStorageState(File) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 924 | */ |
| 925 | public static final String MEDIA_CHECKING = "checking"; |
| 926 | |
| 927 | /** |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 928 | * Storage state if the media is present but is blank or is using an |
| 929 | * unsupported filesystem. |
| 930 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 931 | * @see #getExternalStorageState(File) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 932 | */ |
| 933 | public static final String MEDIA_NOFS = "nofs"; |
| 934 | |
| 935 | /** |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 936 | * Storage state if the media is present and mounted at its mount point with |
| 937 | * read/write access. |
| 938 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 939 | * @see #getExternalStorageState(File) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 940 | */ |
| 941 | public static final String MEDIA_MOUNTED = "mounted"; |
| 942 | |
| 943 | /** |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 944 | * Storage state if the media is present and mounted at its mount point with |
| 945 | * read-only access. |
| 946 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 947 | * @see #getExternalStorageState(File) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 948 | */ |
| 949 | public static final String MEDIA_MOUNTED_READ_ONLY = "mounted_ro"; |
| 950 | |
| 951 | /** |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 952 | * Storage state if the media is present not mounted, and shared via USB |
| 953 | * mass storage. |
| 954 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 955 | * @see #getExternalStorageState(File) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 956 | */ |
| 957 | public static final String MEDIA_SHARED = "shared"; |
| 958 | |
| 959 | /** |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 960 | * Storage state if the media was removed before it was unmounted. |
| 961 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 962 | * @see #getExternalStorageState(File) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 963 | */ |
| 964 | public static final String MEDIA_BAD_REMOVAL = "bad_removal"; |
| 965 | |
| 966 | /** |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 967 | * Storage state if the media is present but cannot be mounted. Typically |
| 968 | * this happens if the file system on the media is corrupted. |
| 969 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 970 | * @see #getExternalStorageState(File) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 971 | */ |
| 972 | public static final String MEDIA_UNMOUNTABLE = "unmountable"; |
| 973 | |
| 974 | /** |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 975 | * Storage state if the media is in the process of being ejected. |
| 976 | * |
| 977 | * @see #getExternalStorageState(File) |
| 978 | */ |
| 979 | public static final String MEDIA_EJECTING = "ejecting"; |
| 980 | |
| 981 | /** |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 982 | * Returns the current state of the primary shared/external storage media. |
Felipe Leme | c7b1f89 | 2016-01-15 15:02:31 -0800 | [diff] [blame] | 983 | * |
Jeff Sharkey | 8c16579 | 2012-10-22 14:08:29 -0700 | [diff] [blame] | 984 | * @see #getExternalStorageDirectory() |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 985 | * @return one of {@link #MEDIA_UNKNOWN}, {@link #MEDIA_REMOVED}, |
| 986 | * {@link #MEDIA_UNMOUNTED}, {@link #MEDIA_CHECKING}, |
| 987 | * {@link #MEDIA_NOFS}, {@link #MEDIA_MOUNTED}, |
| 988 | * {@link #MEDIA_MOUNTED_READ_ONLY}, {@link #MEDIA_SHARED}, |
| 989 | * {@link #MEDIA_BAD_REMOVAL}, or {@link #MEDIA_UNMOUNTABLE}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 990 | */ |
| 991 | public static String getExternalStorageState() { |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 992 | final File externalDir = sCurrentUser.getExternalDirs()[0]; |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 993 | return getExternalStorageState(externalDir); |
| 994 | } |
| 995 | |
| 996 | /** |
| 997 | * @deprecated use {@link #getExternalStorageState(File)} |
| 998 | */ |
| 999 | @Deprecated |
| 1000 | public static String getStorageState(File path) { |
| 1001 | return getExternalStorageState(path); |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 1002 | } |
| 1003 | |
| 1004 | /** |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 1005 | * Returns the current state of the shared/external storage media at the |
| 1006 | * given path. |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 1007 | * |
| 1008 | * @return one of {@link #MEDIA_UNKNOWN}, {@link #MEDIA_REMOVED}, |
| 1009 | * {@link #MEDIA_UNMOUNTED}, {@link #MEDIA_CHECKING}, |
| 1010 | * {@link #MEDIA_NOFS}, {@link #MEDIA_MOUNTED}, |
| 1011 | * {@link #MEDIA_MOUNTED_READ_ONLY}, {@link #MEDIA_SHARED}, |
| 1012 | * {@link #MEDIA_BAD_REMOVAL}, or {@link #MEDIA_UNMOUNTABLE}. |
| 1013 | */ |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 1014 | public static String getExternalStorageState(File path) { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 1015 | final StorageVolume volume = StorageManager.getStorageVolume(path, UserHandle.myUserId()); |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 1016 | if (volume != null) { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 1017 | return volume.getState(); |
| 1018 | } else { |
| 1019 | return MEDIA_UNKNOWN; |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 1020 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1021 | } |
| 1022 | |
Dianne Hackborn | 407f625 | 2010-10-04 11:31:17 -0700 | [diff] [blame] | 1023 | /** |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 1024 | * Returns whether the primary shared/external storage media is physically |
| 1025 | * removable. |
Dianne Hackborn | 407f625 | 2010-10-04 11:31:17 -0700 | [diff] [blame] | 1026 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 1027 | * @return true if the storage device can be removed (such as an SD card), |
| 1028 | * or false if the storage device is built in and cannot be |
| 1029 | * physically removed. |
Dianne Hackborn | 407f625 | 2010-10-04 11:31:17 -0700 | [diff] [blame] | 1030 | */ |
| 1031 | public static boolean isExternalStorageRemovable() { |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 1032 | final File externalDir = sCurrentUser.getExternalDirs()[0]; |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 1033 | return isExternalStorageRemovable(externalDir); |
Dianne Hackborn | 407f625 | 2010-10-04 11:31:17 -0700 | [diff] [blame] | 1034 | } |
| 1035 | |
Kenny Root | e1ff214 | 2010-10-12 11:20:01 -0700 | [diff] [blame] | 1036 | /** |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 1037 | * Returns whether the shared/external storage media at the given path is |
| 1038 | * physically removable. |
Andy Stadler | 50c294f | 2011-03-07 19:13:42 -0800 | [diff] [blame] | 1039 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 1040 | * @return true if the storage device can be removed (such as an SD card), |
| 1041 | * or false if the storage device is built in and cannot be |
| 1042 | * physically removed. |
| 1043 | * @throws IllegalArgumentException if the path is not a valid storage |
| 1044 | * device. |
| 1045 | */ |
| 1046 | public static boolean isExternalStorageRemovable(File path) { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 1047 | final StorageVolume volume = StorageManager.getStorageVolume(path, UserHandle.myUserId()); |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 1048 | if (volume != null) { |
| 1049 | return volume.isRemovable(); |
| 1050 | } else { |
| 1051 | throw new IllegalArgumentException("Failed to find storage device at " + path); |
| 1052 | } |
| 1053 | } |
| 1054 | |
| 1055 | /** |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 1056 | * Returns whether the primary shared/external storage media is emulated. |
| 1057 | * <p> |
| 1058 | * The contents of emulated storage devices are backed by a private user |
| 1059 | * data partition, which means there is little benefit to apps storing data |
| 1060 | * here instead of the private directories returned by |
| 1061 | * {@link Context#getFilesDir()}, etc. |
| 1062 | * <p> |
| 1063 | * This returns true when emulated storage is backed by either internal |
| 1064 | * storage or an adopted storage device. |
Andy Stadler | 50c294f | 2011-03-07 19:13:42 -0800 | [diff] [blame] | 1065 | * |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 1066 | * @see DevicePolicyManager#setStorageEncryption(android.content.ComponentName, |
| 1067 | * boolean) |
Kenny Root | e1ff214 | 2010-10-12 11:20:01 -0700 | [diff] [blame] | 1068 | */ |
| 1069 | public static boolean isExternalStorageEmulated() { |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 1070 | final File externalDir = sCurrentUser.getExternalDirs()[0]; |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 1071 | return isExternalStorageEmulated(externalDir); |
| 1072 | } |
| 1073 | |
| 1074 | /** |
Jeff Sharkey | 59d28dc8 | 2015-10-14 13:56:23 -0700 | [diff] [blame] | 1075 | * Returns whether the shared/external storage media at the given path is |
| 1076 | * emulated. |
| 1077 | * <p> |
| 1078 | * The contents of emulated storage devices are backed by a private user |
| 1079 | * data partition, which means there is little benefit to apps storing data |
| 1080 | * here instead of the private directories returned by |
| 1081 | * {@link Context#getFilesDir()}, etc. |
| 1082 | * <p> |
| 1083 | * This returns true when emulated storage is backed by either internal |
| 1084 | * storage or an adopted storage device. |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 1085 | * |
| 1086 | * @throws IllegalArgumentException if the path is not a valid storage |
| 1087 | * device. |
| 1088 | */ |
| 1089 | public static boolean isExternalStorageEmulated(File path) { |
Jeff Sharkey | 4887789 | 2015-03-18 11:27:19 -0700 | [diff] [blame] | 1090 | final StorageVolume volume = StorageManager.getStorageVolume(path, UserHandle.myUserId()); |
Jeff Sharkey | 4ca728c | 2014-01-10 16:27:19 -0800 | [diff] [blame] | 1091 | if (volume != null) { |
| 1092 | return volume.isEmulated(); |
| 1093 | } else { |
| 1094 | throw new IllegalArgumentException("Failed to find storage device at " + path); |
| 1095 | } |
Kenny Root | e1ff214 | 2010-10-12 11:20:01 -0700 | [diff] [blame] | 1096 | } |
| 1097 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1098 | static File getDirectory(String variableName, String defaultPath) { |
| 1099 | String path = System.getenv(variableName); |
| 1100 | return path == null ? new File(defaultPath) : new File(path); |
| 1101 | } |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 1102 | |
Jeff Sharkey | 48749fc | 2013-04-19 13:25:04 -0700 | [diff] [blame] | 1103 | /** {@hide} */ |
| 1104 | public static void setUserRequired(boolean userRequired) { |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 1105 | sUserRequired = userRequired; |
Jeff Sharkey | 48749fc | 2013-04-19 13:25:04 -0700 | [diff] [blame] | 1106 | } |
| 1107 | |
| 1108 | private static void throwIfUserRequired() { |
Andreas Gampe | d281b42 | 2016-07-08 03:50:27 +0000 | [diff] [blame] | 1109 | if (sUserRequired) { |
Jeff Sharkey | 48749fc | 2013-04-19 13:25:04 -0700 | [diff] [blame] | 1110 | Log.wtf(TAG, "Path requests must specify a user by using UserEnvironment", |
| 1111 | new Throwable()); |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 1112 | } |
| 1113 | } |
| 1114 | |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 1115 | /** |
| 1116 | * Append path segments to each given base path, returning result. |
| 1117 | * |
| 1118 | * @hide |
| 1119 | */ |
| 1120 | public static File[] buildPaths(File[] base, String... segments) { |
| 1121 | File[] result = new File[base.length]; |
| 1122 | for (int i = 0; i < base.length; i++) { |
| 1123 | result[i] = buildPath(base[i], segments); |
| 1124 | } |
| 1125 | return result; |
| 1126 | } |
| 1127 | |
| 1128 | /** |
| 1129 | * Append path segments to given base path, returning result. |
| 1130 | * |
| 1131 | * @hide |
| 1132 | */ |
Philip P. Moltmann | f80809f | 2018-04-04 11:20:44 -0700 | [diff] [blame] | 1133 | @TestApi |
Jeff Sharkey | 1abdb71 | 2013-08-11 16:28:14 -0700 | [diff] [blame] | 1134 | public static File buildPath(File base, String... segments) { |
Jeff Sharkey | b049e21 | 2012-09-07 23:16:01 -0700 | [diff] [blame] | 1135 | File cur = base; |
| 1136 | for (String segment : segments) { |
| 1137 | if (cur == null) { |
| 1138 | cur = new File(segment); |
| 1139 | } else { |
| 1140 | cur = new File(cur, segment); |
| 1141 | } |
| 1142 | } |
| 1143 | return cur; |
| 1144 | } |
Jeff Sharkey | 63d0a06 | 2013-03-01 16:12:55 -0800 | [diff] [blame] | 1145 | |
| 1146 | /** |
| 1147 | * If the given path exists on emulated external storage, return the |
| 1148 | * translated backing path hosted on internal storage. This bypasses any |
| 1149 | * emulation later, improving performance. This is <em>only</em> suitable |
| 1150 | * for read-only access. |
| 1151 | * <p> |
| 1152 | * Returns original path if given path doesn't meet these criteria. Callers |
| 1153 | * must hold {@link android.Manifest.permission#WRITE_MEDIA_STORAGE} |
| 1154 | * permission. |
| 1155 | * |
Jeff Sharkey | 70eb34a | 2018-09-13 11:57:03 -0600 | [diff] [blame] | 1156 | * @deprecated disabled now that FUSE has been replaced by sdcardfs |
Jeff Sharkey | 63d0a06 | 2013-03-01 16:12:55 -0800 | [diff] [blame] | 1157 | * @hide |
| 1158 | */ |
Jeff Sharkey | 70eb34a | 2018-09-13 11:57:03 -0600 | [diff] [blame] | 1159 | @Deprecated |
Jeff Sharkey | 63d0a06 | 2013-03-01 16:12:55 -0800 | [diff] [blame] | 1160 | public static File maybeTranslateEmulatedPathToInternal(File path) { |
Jeff Sharkey | 50a0545 | 2015-04-29 11:24:52 -0700 | [diff] [blame] | 1161 | return StorageManager.maybeTranslateEmulatedPathToInternal(path); |
Jeff Sharkey | 63d0a06 | 2013-03-01 16:12:55 -0800 | [diff] [blame] | 1162 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1163 | } |