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 19 import android.app.admin.DevicePolicyManager; 20 import android.content.Context; 21 import android.os.storage.StorageManager; 22 import android.os.storage.StorageVolume; 23 import android.text.TextUtils; 24 import android.util.Log; 25 26 import java.io.File; 27 28 /** 29 * Provides access to environment variables. 30 */ 31 public class Environment { 32 private static final String TAG = "Environment"; 33 34 private static final String ENV_EXTERNAL_STORAGE = "EXTERNAL_STORAGE"; 35 private static final String ENV_ANDROID_ROOT = "ANDROID_ROOT"; 36 private static final String ENV_ANDROID_DATA = "ANDROID_DATA"; 37 private static final String ENV_ANDROID_EXPAND = "ANDROID_EXPAND"; 38 private static final String ENV_ANDROID_STORAGE = "ANDROID_STORAGE"; 39 private static final String ENV_DOWNLOAD_CACHE = "DOWNLOAD_CACHE"; 40 private static final String ENV_OEM_ROOT = "OEM_ROOT"; 41 private static final String ENV_ODM_ROOT = "ODM_ROOT"; 42 private static final String ENV_VENDOR_ROOT = "VENDOR_ROOT"; 43 44 /** {@hide} */ 45 public static final String DIR_ANDROID = "Android"; 46 private static final String DIR_DATA = "data"; 47 private static final String DIR_MEDIA = "media"; 48 private static final String DIR_OBB = "obb"; 49 private static final String DIR_FILES = "files"; 50 private static final String DIR_CACHE = "cache"; 51 52 /** {@hide} */ 53 @Deprecated 54 public static final String DIRECTORY_ANDROID = DIR_ANDROID; 55 56 private static final File DIR_ANDROID_ROOT = getDirectory(ENV_ANDROID_ROOT, "/system"); 57 private static final File DIR_ANDROID_DATA = getDirectory(ENV_ANDROID_DATA, "/data"); 58 private static final File DIR_ANDROID_EXPAND = getDirectory(ENV_ANDROID_EXPAND, "/mnt/expand"); 59 private static final File DIR_ANDROID_STORAGE = getDirectory(ENV_ANDROID_STORAGE, "/storage"); 60 private static final File DIR_DOWNLOAD_CACHE = getDirectory(ENV_DOWNLOAD_CACHE, "/cache"); 61 private static final File DIR_OEM_ROOT = getDirectory(ENV_OEM_ROOT, "/oem"); 62 private static final File DIR_ODM_ROOT = getDirectory(ENV_ODM_ROOT, "/odm"); 63 private static final File DIR_VENDOR_ROOT = getDirectory(ENV_VENDOR_ROOT, "/vendor"); 64 65 private static UserEnvironment sCurrentUser; 66 private static boolean sUserRequired; 67 68 static { 69 initForCurrentUser(); 70 } 71 72 /** {@hide} */ 73 public static void initForCurrentUser() { 74 final int userId = UserHandle.myUserId(); 75 sCurrentUser = new UserEnvironment(userId); 76 } 77 78 /** {@hide} */ 79 public static class UserEnvironment { 80 private final int mUserId; 81 82 public UserEnvironment(int userId) { 83 mUserId = userId; 84 } 85 86 public File[] getExternalDirs() { 87 final StorageVolume[] volumes = StorageManager.getVolumeList(mUserId, 88 StorageManager.FLAG_FOR_WRITE); 89 final File[] files = new File[volumes.length]; 90 for (int i = 0; i < volumes.length; i++) { 91 files[i] = volumes[i].getPathFile(); 92 } 93 return files; 94 } 95 96 @Deprecated 97 public File getExternalStorageDirectory() { 98 return getExternalDirs()[0]; 99 } 100 101 @Deprecated 102 public File getExternalStoragePublicDirectory(String type) { 103 return buildExternalStoragePublicDirs(type)[0]; 104 } 105 106 public File[] buildExternalStoragePublicDirs(String type) { 107 return buildPaths(getExternalDirs(), type); 108 } 109 110 public File[] buildExternalStorageAndroidDataDirs() { 111 return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA); 112 } 113 114 public File[] buildExternalStorageAndroidObbDirs() { 115 return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_OBB); 116 } 117 118 public File[] buildExternalStorageAppDataDirs(String packageName) { 119 return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA, packageName); 120 } 121 122 public File[] buildExternalStorageAppMediaDirs(String packageName) { 123 return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_MEDIA, packageName); 124 } 125 126 public File[] buildExternalStorageAppObbDirs(String packageName) { 127 return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_OBB, packageName); 128 } 129 130 public File[] buildExternalStorageAppFilesDirs(String packageName) { 131 return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA, packageName, DIR_FILES); 132 } 133 134 public File[] buildExternalStorageAppCacheDirs(String packageName) { 135 return buildPaths(getExternalDirs(), DIR_ANDROID, DIR_DATA, packageName, DIR_CACHE); 136 } 137 } 138 139 /** 140 * Return root of the "system" partition holding the core Android OS. 141 * Always present and mounted read-only. 142 */ 143 public static File getRootDirectory() { 144 return DIR_ANDROID_ROOT; 145 } 146 147 /** {@hide} */ 148 public static File getStorageDirectory() { 149 return DIR_ANDROID_STORAGE; 150 } 151 152 /** 153 * Return root directory of the "oem" partition holding OEM customizations, 154 * if any. If present, the partition is mounted read-only. 155 * 156 * @hide 157 */ 158 public static File getOemDirectory() { 159 return DIR_OEM_ROOT; 160 } 161 162 /** 163 * Return root directory of the "odm" partition holding ODM customizations, 164 * if any. If present, the partition is mounted read-only. 165 * 166 * @hide 167 */ 168 public static File getOdmDirectory() { 169 return DIR_ODM_ROOT; 170 } 171 172 /** 173 * Return root directory of the "vendor" partition that holds vendor-provided 174 * software that should persist across simple reflashing of the "system" partition. 175 * @hide 176 */ 177 public static File getVendorDirectory() { 178 return DIR_VENDOR_ROOT; 179 } 180 181 /** 182 * Return the system directory for a user. This is for use by system 183 * services to store files relating to the user. This directory will be 184 * automatically deleted when the user is removed. 185 * 186 * @deprecated This directory is valid and still exists, but callers should 187 * <em>strongly</em> consider switching to 188 * {@link #getDataSystemCeDirectory(int)} which is protected 189 * with user credentials or 190 * {@link #getDataSystemDeDirectory(int)} which supports fast 191 * user wipe. 192 * @hide 193 */ 194 @Deprecated 195 public static File getUserSystemDirectory(int userId) { 196 return new File(new File(getDataSystemDirectory(), "users"), Integer.toString(userId)); 197 } 198 199 /** 200 * Returns the config directory for a user. This is for use by system 201 * services to store files relating to the user which should be readable by 202 * any app running as that user. 203 * 204 * @deprecated This directory is valid and still exists, but callers should 205 * <em>strongly</em> consider switching to 206 * {@link #getDataMiscCeDirectory(int)} which is protected with 207 * user credentials or {@link #getDataMiscDeDirectory(int)} 208 * which supports fast user wipe. 209 * @hide 210 */ 211 @Deprecated 212 public static File getUserConfigDirectory(int userId) { 213 return new File(new File(new File( 214 getDataDirectory(), "misc"), "user"), Integer.toString(userId)); 215 } 216 217 /** 218 * Return the user data directory. 219 */ 220 public static File getDataDirectory() { 221 return DIR_ANDROID_DATA; 222 } 223 224 /** {@hide} */ 225 public static File getDataDirectory(String volumeUuid) { 226 if (TextUtils.isEmpty(volumeUuid)) { 227 return DIR_ANDROID_DATA; 228 } else { 229 return new File("/mnt/expand/" + volumeUuid); 230 } 231 } 232 233 /** {@hide} */ 234 public static File getExpandDirectory() { 235 return DIR_ANDROID_EXPAND; 236 } 237 238 /** {@hide} */ 239 public static File getDataSystemDirectory() { 240 return new File(getDataDirectory(), "system"); 241 } 242 243 /** 244 * Returns the base directory for per-user system directory, device encrypted. 245 * {@hide} 246 */ 247 public static File getDataSystemDeDirectory() { 248 return buildPath(getDataDirectory(), "system_de"); 249 } 250 251 /** 252 * Returns the base directory for per-user system directory, credential encrypted. 253 * {@hide} 254 */ 255 public static File getDataSystemCeDirectory() { 256 return buildPath(getDataDirectory(), "system_ce"); 257 } 258 259 /** {@hide} */ 260 public static File getDataSystemCeDirectory(int userId) { 261 return buildPath(getDataDirectory(), "system_ce", String.valueOf(userId)); 262 } 263 264 /** {@hide} */ 265 public static File getDataSystemDeDirectory(int userId) { 266 return buildPath(getDataDirectory(), "system_de", String.valueOf(userId)); 267 } 268 269 /** {@hide} */ 270 public static File getDataMiscDirectory() { 271 return new File(getDataDirectory(), "misc"); 272 } 273 274 /** {@hide} */ 275 public static File getDataMiscCeDirectory(int userId) { 276 return buildPath(getDataDirectory(), "misc_ce", String.valueOf(userId)); 277 } 278 279 /** {@hide} */ 280 public static File getDataMiscDeDirectory(int userId) { 281 return buildPath(getDataDirectory(), "misc_de", String.valueOf(userId)); 282 } 283 284 private static File getDataProfilesDeDirectory(int userId) { 285 return buildPath(getDataDirectory(), "misc", "profiles", "cur", String.valueOf(userId)); 286 } 287 288 /** {@hide} */ 289 public static File getDataProfilesDePackageDirectory(int userId, String packageName) { 290 return buildPath(getDataProfilesDeDirectory(userId), packageName); 291 } 292 293 /** {@hide} */ 294 public static File getDataProfilesDeForeignDexDirectory(int userId) { 295 return buildPath(getDataProfilesDeDirectory(userId), "foreign-dex"); 296 } 297 298 /** {@hide} */ 299 public static File getDataAppDirectory(String volumeUuid) { 300 return new File(getDataDirectory(volumeUuid), "app"); 301 } 302 303 /** {@hide} */ 304 public static File getDataAppEphemeralDirectory(String volumeUuid) { 305 return new File(getDataDirectory(volumeUuid), "app-ephemeral"); 306 } 307 308 /** {@hide} */ 309 public static File getDataUserCeDirectory(String volumeUuid) { 310 return new File(getDataDirectory(volumeUuid), "user"); 311 } 312 313 /** {@hide} */ 314 public static File getDataUserCeDirectory(String volumeUuid, int userId) { 315 return new File(getDataUserCeDirectory(volumeUuid), String.valueOf(userId)); 316 } 317 318 /** {@hide} */ 319 public static File getDataUserCePackageDirectory(String volumeUuid, int userId, 320 String packageName) { 321 // TODO: keep consistent with installd 322 return new File(getDataUserCeDirectory(volumeUuid, userId), packageName); 323 } 324 325 /** {@hide} */ 326 public static File getDataUserDeDirectory(String volumeUuid) { 327 return new File(getDataDirectory(volumeUuid), "user_de"); 328 } 329 330 /** {@hide} */ 331 public static File getDataUserDeDirectory(String volumeUuid, int userId) { 332 return new File(getDataUserDeDirectory(volumeUuid), String.valueOf(userId)); 333 } 334 335 /** {@hide} */ 336 public static File getDataUserDePackageDirectory(String volumeUuid, int userId, 337 String packageName) { 338 // TODO: keep consistent with installd 339 return new File(getDataUserDeDirectory(volumeUuid, userId), packageName); 340 } 341 342 /** 343 * Return the primary shared/external storage directory. This directory may 344 * not currently be accessible if it has been mounted by the user on their 345 * computer, has been removed from the device, or some other problem has 346 * happened. You can determine its current state with 347 * {@link #getExternalStorageState()}. 348 * <p> 349 * <em>Note: don't be confused by the word "external" here. This directory 350 * can better be thought as media/shared storage. It is a filesystem that 351 * can hold a relatively large amount of data and that is shared across all 352 * applications (does not enforce permissions). Traditionally this is an SD 353 * card, but it may also be implemented as built-in storage in a device that 354 * is distinct from the protected internal storage and can be mounted as a 355 * filesystem on a computer.</em> 356 * <p> 357 * On devices with multiple users (as described by {@link UserManager}), 358 * each user has their own isolated shared storage. Applications only have 359 * access to the shared storage for the user they're running as. 360 * <p> 361 * In devices with multiple shared/external storage directories, this 362 * directory represents the primary storage that the user will interact 363 * with. Access to secondary storage is available through 364 * {@link Context#getExternalFilesDirs(String)}, 365 * {@link Context#getExternalCacheDirs()}, and 366 * {@link Context#getExternalMediaDirs()}. 367 * <p> 368 * Applications should not directly use this top-level directory, in order 369 * to avoid polluting the user's root namespace. Any files that are private 370 * to the application should be placed in a directory returned by 371 * {@link android.content.Context#getExternalFilesDir 372 * Context.getExternalFilesDir}, which the system will take care of deleting 373 * if the application is uninstalled. Other shared files should be placed in 374 * one of the directories returned by 375 * {@link #getExternalStoragePublicDirectory}. 376 * <p> 377 * Writing to this path requires the 378 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} permission, 379 * and starting in {@link android.os.Build.VERSION_CODES#KITKAT}, read access requires the 380 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} permission, 381 * which is automatically granted if you hold the write permission. 382 * <p> 383 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, if your 384 * application only needs to store internal data, consider using 385 * {@link Context#getExternalFilesDir(String)}, 386 * {@link Context#getExternalCacheDir()}, or 387 * {@link Context#getExternalMediaDirs()}, which require no permissions to 388 * read or write. 389 * <p> 390 * This path may change between platform versions, so applications should 391 * only persist relative paths. 392 * <p> 393 * Here is an example of typical code to monitor the state of external 394 * storage: 395 * <p> 396 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java 397 * monitor_storage} 398 * 399 * @see #getExternalStorageState() 400 * @see #isExternalStorageRemovable() 401 */ 402 public static File getExternalStorageDirectory() { 403 throwIfUserRequired(); 404 return sCurrentUser.getExternalDirs()[0]; 405 } 406 407 /** {@hide} */ 408 public static File getLegacyExternalStorageDirectory() { 409 return new File(System.getenv(ENV_EXTERNAL_STORAGE)); 410 } 411 412 /** {@hide} */ 413 public static File getLegacyExternalStorageObbDirectory() { 414 return buildPath(getLegacyExternalStorageDirectory(), DIR_ANDROID, DIR_OBB); 415 } 416 417 /** 418 * Standard directory in which to place any audio files that should be 419 * in the regular list of music for the user. 420 * This may be combined with 421 * {@link #DIRECTORY_PODCASTS}, {@link #DIRECTORY_NOTIFICATIONS}, 422 * {@link #DIRECTORY_ALARMS}, and {@link #DIRECTORY_RINGTONES} as a series 423 * of directories to categories a particular audio file as more than one 424 * type. 425 */ 426 public static String DIRECTORY_MUSIC = "Music"; 427 428 /** 429 * Standard directory in which to place any audio files that should be 430 * in the list of podcasts that the user can select (not as regular 431 * music). 432 * This may be combined with {@link #DIRECTORY_MUSIC}, 433 * {@link #DIRECTORY_NOTIFICATIONS}, 434 * {@link #DIRECTORY_ALARMS}, and {@link #DIRECTORY_RINGTONES} as a series 435 * of directories to categories a particular audio file as more than one 436 * type. 437 */ 438 public static String DIRECTORY_PODCASTS = "Podcasts"; 439 440 /** 441 * Standard directory in which to place any audio files that should be 442 * in the list of ringtones that the user can select (not as regular 443 * music). 444 * This may be combined with {@link #DIRECTORY_MUSIC}, 445 * {@link #DIRECTORY_PODCASTS}, {@link #DIRECTORY_NOTIFICATIONS}, and 446 * {@link #DIRECTORY_ALARMS} as a series 447 * of directories to categories a particular audio file as more than one 448 * type. 449 */ 450 public static String DIRECTORY_RINGTONES = "Ringtones"; 451 452 /** 453 * Standard directory in which to place any audio files that should be 454 * in the list of alarms that the user can select (not as regular 455 * music). 456 * This may be combined with {@link #DIRECTORY_MUSIC}, 457 * {@link #DIRECTORY_PODCASTS}, {@link #DIRECTORY_NOTIFICATIONS}, 458 * and {@link #DIRECTORY_RINGTONES} as a series 459 * of directories to categories a particular audio file as more than one 460 * type. 461 */ 462 public static String DIRECTORY_ALARMS = "Alarms"; 463 464 /** 465 * Standard directory in which to place any audio files that should be 466 * in the list of notifications that the user can select (not as regular 467 * music). 468 * This may be combined with {@link #DIRECTORY_MUSIC}, 469 * {@link #DIRECTORY_PODCASTS}, 470 * {@link #DIRECTORY_ALARMS}, and {@link #DIRECTORY_RINGTONES} as a series 471 * of directories to categories a particular audio file as more than one 472 * type. 473 */ 474 public static String DIRECTORY_NOTIFICATIONS = "Notifications"; 475 476 /** 477 * Standard directory in which to place pictures that are available to 478 * the user. Note that this is primarily a convention for the top-level 479 * public directory, as the media scanner will find and collect pictures 480 * in any directory. 481 */ 482 public static String DIRECTORY_PICTURES = "Pictures"; 483 484 /** 485 * Standard directory in which to place movies that are available to 486 * the user. Note that this is primarily a convention for the top-level 487 * public directory, as the media scanner will find and collect movies 488 * in any directory. 489 */ 490 public static String DIRECTORY_MOVIES = "Movies"; 491 492 /** 493 * Standard directory in which to place files that have been downloaded by 494 * the user. Note that this is primarily a convention for the top-level 495 * public directory, you are free to download files anywhere in your own 496 * private directories. Also note that though the constant here is 497 * named DIRECTORY_DOWNLOADS (plural), the actual file name is non-plural for 498 * backwards compatibility reasons. 499 */ 500 public static String DIRECTORY_DOWNLOADS = "Download"; 501 502 /** 503 * The traditional location for pictures and videos when mounting the 504 * device as a camera. Note that this is primarily a convention for the 505 * top-level public directory, as this convention makes no sense elsewhere. 506 */ 507 public static String DIRECTORY_DCIM = "DCIM"; 508 509 /** 510 * Standard directory in which to place documents that have been created by 511 * the user. 512 */ 513 public static String DIRECTORY_DOCUMENTS = "Documents"; 514 515 /** 516 * List of standard storage directories. 517 * <p> 518 * Each of its values have its own constant: 519 * <ul> 520 * <li>{@link #DIRECTORY_MUSIC} 521 * <li>{@link #DIRECTORY_PODCASTS} 522 * <li>{@link #DIRECTORY_ALARMS} 523 * <li>{@link #DIRECTORY_RINGTONES} 524 * <li>{@link #DIRECTORY_NOTIFICATIONS} 525 * <li>{@link #DIRECTORY_PICTURES} 526 * <li>{@link #DIRECTORY_MOVIES} 527 * <li>{@link #DIRECTORY_DOWNLOADS} 528 * <li>{@link #DIRECTORY_DCIM} 529 * <li>{@link #DIRECTORY_DOCUMENTS} 530 * </ul> 531 * @hide 532 */ 533 public static final String[] STANDARD_DIRECTORIES = { 534 DIRECTORY_MUSIC, 535 DIRECTORY_PODCASTS, 536 DIRECTORY_RINGTONES, 537 DIRECTORY_ALARMS, 538 DIRECTORY_NOTIFICATIONS, 539 DIRECTORY_PICTURES, 540 DIRECTORY_MOVIES, 541 DIRECTORY_DOWNLOADS, 542 DIRECTORY_DCIM, 543 DIRECTORY_DOCUMENTS 544 }; 545 546 /** 547 * @hide 548 */ 549 public static boolean isStandardDirectory(String dir) { 550 for (String valid : STANDARD_DIRECTORIES) { 551 if (valid.equals(dir)) { 552 return true; 553 } 554 } 555 return false; 556 } 557 558 /** 559 * Get a top-level shared/external storage directory for placing files of a 560 * particular type. This is where the user will typically place and manage 561 * their own files, so you should be careful about what you put here to 562 * ensure you don't erase their files or get in the way of their own 563 * organization. 564 * <p> 565 * On devices with multiple users (as described by {@link UserManager}), 566 * each user has their own isolated shared storage. Applications only have 567 * access to the shared storage for the user they're running as. 568 * </p> 569 * <p> 570 * Here is an example of typical code to manipulate a picture on the public 571 * shared storage: 572 * </p> 573 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java 574 * public_picture} 575 * 576 * @param type The type of storage directory to return. Should be one of 577 * {@link #DIRECTORY_MUSIC}, {@link #DIRECTORY_PODCASTS}, 578 * {@link #DIRECTORY_RINGTONES}, {@link #DIRECTORY_ALARMS}, 579 * {@link #DIRECTORY_NOTIFICATIONS}, {@link #DIRECTORY_PICTURES}, 580 * {@link #DIRECTORY_MOVIES}, {@link #DIRECTORY_DOWNLOADS}, 581 * {@link #DIRECTORY_DCIM}, or {@link #DIRECTORY_DOCUMENTS}. May not be null. 582 * @return Returns the File path for the directory. Note that this directory 583 * may not yet exist, so you must make sure it exists before using 584 * it such as with {@link File#mkdirs File.mkdirs()}. 585 */ 586 public static File getExternalStoragePublicDirectory(String type) { 587 throwIfUserRequired(); 588 return sCurrentUser.buildExternalStoragePublicDirs(type)[0]; 589 } 590 591 /** 592 * Returns the path for android-specific data on the SD card. 593 * @hide 594 */ 595 public static File[] buildExternalStorageAndroidDataDirs() { 596 throwIfUserRequired(); 597 return sCurrentUser.buildExternalStorageAndroidDataDirs(); 598 } 599 600 /** 601 * Generates the raw path to an application's data 602 * @hide 603 */ 604 public static File[] buildExternalStorageAppDataDirs(String packageName) { 605 throwIfUserRequired(); 606 return sCurrentUser.buildExternalStorageAppDataDirs(packageName); 607 } 608 609 /** 610 * Generates the raw path to an application's media 611 * @hide 612 */ 613 public static File[] buildExternalStorageAppMediaDirs(String packageName) { 614 throwIfUserRequired(); 615 return sCurrentUser.buildExternalStorageAppMediaDirs(packageName); 616 } 617 618 /** 619 * Generates the raw path to an application's OBB files 620 * @hide 621 */ 622 public static File[] buildExternalStorageAppObbDirs(String packageName) { 623 throwIfUserRequired(); 624 return sCurrentUser.buildExternalStorageAppObbDirs(packageName); 625 } 626 627 /** 628 * Generates the path to an application's files. 629 * @hide 630 */ 631 public static File[] buildExternalStorageAppFilesDirs(String packageName) { 632 throwIfUserRequired(); 633 return sCurrentUser.buildExternalStorageAppFilesDirs(packageName); 634 } 635 636 /** 637 * Generates the path to an application's cache. 638 * @hide 639 */ 640 public static File[] buildExternalStorageAppCacheDirs(String packageName) { 641 throwIfUserRequired(); 642 return sCurrentUser.buildExternalStorageAppCacheDirs(packageName); 643 } 644 645 /** 646 * Return the download/cache content directory. 647 */ 648 public static File getDownloadCacheDirectory() { 649 return DIR_DOWNLOAD_CACHE; 650 } 651 652 /** 653 * Unknown storage state, such as when a path isn't backed by known storage 654 * media. 655 * 656 * @see #getExternalStorageState(File) 657 */ 658 public static final String MEDIA_UNKNOWN = "unknown"; 659 660 /** 661 * Storage state if the media is not present. 662 * 663 * @see #getExternalStorageState(File) 664 */ 665 public static final String MEDIA_REMOVED = "removed"; 666 667 /** 668 * Storage state if the media is present but not mounted. 669 * 670 * @see #getExternalStorageState(File) 671 */ 672 public static final String MEDIA_UNMOUNTED = "unmounted"; 673 674 /** 675 * Storage state if the media is present and being disk-checked. 676 * 677 * @see #getExternalStorageState(File) 678 */ 679 public static final String MEDIA_CHECKING = "checking"; 680 681 /** 682 * Storage state if the media is present but is blank or is using an 683 * unsupported filesystem. 684 * 685 * @see #getExternalStorageState(File) 686 */ 687 public static final String MEDIA_NOFS = "nofs"; 688 689 /** 690 * Storage state if the media is present and mounted at its mount point with 691 * read/write access. 692 * 693 * @see #getExternalStorageState(File) 694 */ 695 public static final String MEDIA_MOUNTED = "mounted"; 696 697 /** 698 * Storage state if the media is present and mounted at its mount point with 699 * read-only access. 700 * 701 * @see #getExternalStorageState(File) 702 */ 703 public static final String MEDIA_MOUNTED_READ_ONLY = "mounted_ro"; 704 705 /** 706 * Storage state if the media is present not mounted, and shared via USB 707 * mass storage. 708 * 709 * @see #getExternalStorageState(File) 710 */ 711 public static final String MEDIA_SHARED = "shared"; 712 713 /** 714 * Storage state if the media was removed before it was unmounted. 715 * 716 * @see #getExternalStorageState(File) 717 */ 718 public static final String MEDIA_BAD_REMOVAL = "bad_removal"; 719 720 /** 721 * Storage state if the media is present but cannot be mounted. Typically 722 * this happens if the file system on the media is corrupted. 723 * 724 * @see #getExternalStorageState(File) 725 */ 726 public static final String MEDIA_UNMOUNTABLE = "unmountable"; 727 728 /** 729 * Storage state if the media is in the process of being ejected. 730 * 731 * @see #getExternalStorageState(File) 732 */ 733 public static final String MEDIA_EJECTING = "ejecting"; 734 735 /** 736 * Returns the current state of the primary shared/external storage media. 737 * 738 * @see #getExternalStorageDirectory() 739 * @return one of {@link #MEDIA_UNKNOWN}, {@link #MEDIA_REMOVED}, 740 * {@link #MEDIA_UNMOUNTED}, {@link #MEDIA_CHECKING}, 741 * {@link #MEDIA_NOFS}, {@link #MEDIA_MOUNTED}, 742 * {@link #MEDIA_MOUNTED_READ_ONLY}, {@link #MEDIA_SHARED}, 743 * {@link #MEDIA_BAD_REMOVAL}, or {@link #MEDIA_UNMOUNTABLE}. 744 */ 745 public static String getExternalStorageState() { 746 final File externalDir = sCurrentUser.getExternalDirs()[0]; 747 return getExternalStorageState(externalDir); 748 } 749 750 /** 751 * @deprecated use {@link #getExternalStorageState(File)} 752 */ 753 @Deprecated 754 public static String getStorageState(File path) { 755 return getExternalStorageState(path); 756 } 757 758 /** 759 * Returns the current state of the shared/external storage media at the 760 * given path. 761 * 762 * @return one of {@link #MEDIA_UNKNOWN}, {@link #MEDIA_REMOVED}, 763 * {@link #MEDIA_UNMOUNTED}, {@link #MEDIA_CHECKING}, 764 * {@link #MEDIA_NOFS}, {@link #MEDIA_MOUNTED}, 765 * {@link #MEDIA_MOUNTED_READ_ONLY}, {@link #MEDIA_SHARED}, 766 * {@link #MEDIA_BAD_REMOVAL}, or {@link #MEDIA_UNMOUNTABLE}. 767 */ 768 public static String getExternalStorageState(File path) { 769 final StorageVolume volume = StorageManager.getStorageVolume(path, UserHandle.myUserId()); 770 if (volume != null) { 771 return volume.getState(); 772 } else { 773 return MEDIA_UNKNOWN; 774 } 775 } 776 777 /** 778 * Returns whether the primary shared/external storage media is physically 779 * removable. 780 * 781 * @return true if the storage device can be removed (such as an SD card), 782 * or false if the storage device is built in and cannot be 783 * physically removed. 784 */ 785 public static boolean isExternalStorageRemovable() { 786 if (isStorageDisabled()) return false; 787 final File externalDir = sCurrentUser.getExternalDirs()[0]; 788 return isExternalStorageRemovable(externalDir); 789 } 790 791 /** 792 * Returns whether the shared/external storage media at the given path is 793 * physically removable. 794 * 795 * @return true if the storage device can be removed (such as an SD card), 796 * or false if the storage device is built in and cannot be 797 * physically removed. 798 * @throws IllegalArgumentException if the path is not a valid storage 799 * device. 800 */ 801 public static boolean isExternalStorageRemovable(File path) { 802 final StorageVolume volume = StorageManager.getStorageVolume(path, UserHandle.myUserId()); 803 if (volume != null) { 804 return volume.isRemovable(); 805 } else { 806 throw new IllegalArgumentException("Failed to find storage device at " + path); 807 } 808 } 809 810 /** 811 * Returns whether the primary shared/external storage media is emulated. 812 * <p> 813 * The contents of emulated storage devices are backed by a private user 814 * data partition, which means there is little benefit to apps storing data 815 * here instead of the private directories returned by 816 * {@link Context#getFilesDir()}, etc. 817 * <p> 818 * This returns true when emulated storage is backed by either internal 819 * storage or an adopted storage device. 820 * 821 * @see DevicePolicyManager#setStorageEncryption(android.content.ComponentName, 822 * boolean) 823 */ 824 public static boolean isExternalStorageEmulated() { 825 if (isStorageDisabled()) return false; 826 final File externalDir = sCurrentUser.getExternalDirs()[0]; 827 return isExternalStorageEmulated(externalDir); 828 } 829 830 /** 831 * Returns whether the shared/external storage media at the given path is 832 * emulated. 833 * <p> 834 * The contents of emulated storage devices are backed by a private user 835 * data partition, which means there is little benefit to apps storing data 836 * here instead of the private directories returned by 837 * {@link Context#getFilesDir()}, etc. 838 * <p> 839 * This returns true when emulated storage is backed by either internal 840 * storage or an adopted storage device. 841 * 842 * @throws IllegalArgumentException if the path is not a valid storage 843 * device. 844 */ 845 public static boolean isExternalStorageEmulated(File path) { 846 final StorageVolume volume = StorageManager.getStorageVolume(path, UserHandle.myUserId()); 847 if (volume != null) { 848 return volume.isEmulated(); 849 } else { 850 throw new IllegalArgumentException("Failed to find storage device at " + path); 851 } 852 } 853 854 static File getDirectory(String variableName, String defaultPath) { 855 String path = System.getenv(variableName); 856 return path == null ? new File(defaultPath) : new File(path); 857 } 858 859 /** {@hide} */ 860 public static void setUserRequired(boolean userRequired) { 861 sUserRequired = userRequired; 862 } 863 864 private static void throwIfUserRequired() { 865 if (sUserRequired) { 866 Log.wtf(TAG, "Path requests must specify a user by using UserEnvironment", 867 new Throwable()); 868 } 869 } 870 871 /** 872 * Append path segments to each given base path, returning result. 873 * 874 * @hide 875 */ 876 public static File[] buildPaths(File[] base, String... segments) { 877 File[] result = new File[base.length]; 878 for (int i = 0; i < base.length; i++) { 879 result[i] = buildPath(base[i], segments); 880 } 881 return result; 882 } 883 884 /** 885 * Append path segments to given base path, returning result. 886 * 887 * @hide 888 */ 889 public static File buildPath(File base, String... segments) { 890 File cur = base; 891 for (String segment : segments) { 892 if (cur == null) { 893 cur = new File(segment); 894 } else { 895 cur = new File(cur, segment); 896 } 897 } 898 return cur; 899 } 900 901 private static boolean isStorageDisabled() { 902 return SystemProperties.getBoolean("config.disable_storage", false); 903 } 904 905 /** 906 * If the given path exists on emulated external storage, return the 907 * translated backing path hosted on internal storage. This bypasses any 908 * emulation later, improving performance. This is <em>only</em> suitable 909 * for read-only access. 910 * <p> 911 * Returns original path if given path doesn't meet these criteria. Callers 912 * must hold {@link android.Manifest.permission#WRITE_MEDIA_STORAGE} 913 * permission. 914 * 915 * @hide 916 */ 917 public static File maybeTranslateEmulatedPathToInternal(File path) { 918 return StorageManager.maybeTranslateEmulatedPathToInternal(path); 919 } 920 } 921
