ApplicationInfo.java revision df6e980e3f63eb0f6f9eb437fa925d5009cd9c44
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 17package android.content.pm; 18 19import android.content.pm.PackageManager.NameNotFoundException; 20import android.content.res.Resources; 21import android.graphics.drawable.Drawable; 22import android.os.Parcel; 23import android.os.Parcelable; 24import android.util.Printer; 25 26import java.text.Collator; 27import java.util.Comparator; 28 29/** 30 * Information you can retrieve about a particular application. This 31 * corresponds to information collected from the AndroidManifest.xml's 32 * <application> tag. 33 */ 34public class ApplicationInfo extends PackageItemInfo implements Parcelable { 35 36 /** 37 * Default task affinity of all activities in this application. See 38 * {@link ActivityInfo#taskAffinity} for more information. This comes 39 * from the "taskAffinity" attribute. 40 */ 41 public String taskAffinity; 42 43 /** 44 * Optional name of a permission required to be able to access this 45 * application's components. From the "permission" attribute. 46 */ 47 public String permission; 48 49 /** 50 * The name of the process this application should run in. From the 51 * "process" attribute or, if not set, the same as 52 * <var>packageName</var>. 53 */ 54 public String processName; 55 56 /** 57 * Class implementing the Application object. From the "class" 58 * attribute. 59 */ 60 public String className; 61 62 /** 63 * A style resource identifier (in the package's resources) of the 64 * description of an application. From the "description" attribute 65 * or, if not set, 0. 66 */ 67 public int descriptionRes; 68 69 /** 70 * A style resource identifier (in the package's resources) of the 71 * default visual theme of the application. From the "theme" attribute 72 * or, if not set, 0. 73 */ 74 public int theme; 75 76 /** 77 * Class implementing the Application's manage space 78 * functionality. From the "manageSpaceActivity" 79 * attribute. This is an optional attribute and will be null if 80 * applications don't specify it in their manifest 81 */ 82 public String manageSpaceActivityName; 83 84 /** 85 * Class implementing the Application's backup functionality. From 86 * the "backupAgent" attribute. This is an optional attribute and 87 * will be null if the application does not specify it in its manifest. 88 * 89 * <p>If android:allowBackup is set to false, this attribute is ignored. 90 */ 91 public String backupAgentName; 92 93 /** 94 * Value for {@link #flags}: if set, this application is installed in the 95 * device's system image. 96 */ 97 public static final int FLAG_SYSTEM = 1<<0; 98 99 /** 100 * Value for {@link #flags}: set to true if this application would like to 101 * allow debugging of its 102 * code, even when installed on a non-development system. Comes 103 * from {@link android.R.styleable#AndroidManifestApplication_debuggable 104 * android:debuggable} of the <application> tag. 105 */ 106 public static final int FLAG_DEBUGGABLE = 1<<1; 107 108 /** 109 * Value for {@link #flags}: set to true if this application has code 110 * associated with it. Comes 111 * from {@link android.R.styleable#AndroidManifestApplication_hasCode 112 * android:hasCode} of the <application> tag. 113 */ 114 public static final int FLAG_HAS_CODE = 1<<2; 115 116 /** 117 * Value for {@link #flags}: set to true if this application is persistent. 118 * Comes from {@link android.R.styleable#AndroidManifestApplication_persistent 119 * android:persistent} of the <application> tag. 120 */ 121 public static final int FLAG_PERSISTENT = 1<<3; 122 123 /** 124 * Value for {@link #flags}: set to true if this application holds the 125 * {@link android.Manifest.permission#FACTORY_TEST} permission and the 126 * device is running in factory test mode. 127 */ 128 public static final int FLAG_FACTORY_TEST = 1<<4; 129 130 /** 131 * Value for {@link #flags}: default value for the corresponding ActivityInfo flag. 132 * Comes from {@link android.R.styleable#AndroidManifestApplication_allowTaskReparenting 133 * android:allowTaskReparenting} of the <application> tag. 134 */ 135 public static final int FLAG_ALLOW_TASK_REPARENTING = 1<<5; 136 137 /** 138 * Value for {@link #flags}: default value for the corresponding ActivityInfo flag. 139 * Comes from {@link android.R.styleable#AndroidManifestApplication_allowClearUserData 140 * android:allowClearUserData} of the <application> tag. 141 */ 142 public static final int FLAG_ALLOW_CLEAR_USER_DATA = 1<<6; 143 144 /** 145 * Value for {@link #flags}: this is set if this application has been 146 * install as an update to a built-in system application. 147 */ 148 public static final int FLAG_UPDATED_SYSTEM_APP = 1<<7; 149 150 /** 151 * Value for {@link #flags}: this is set of the application has specified 152 * {@link android.R.styleable#AndroidManifestApplication_testOnly 153 * android:testOnly} to be true. 154 */ 155 public static final int FLAG_TEST_ONLY = 1<<8; 156 157 /** 158 * Value for {@link #flags}: true when the application's window can be 159 * reduced in size for smaller screens. Corresponds to 160 * {@link android.R.styleable#AndroidManifestSupportsScreens_smallScreens 161 * android:smallScreens}. 162 */ 163 public static final int FLAG_SUPPORTS_SMALL_SCREENS = 1<<9; 164 165 /** 166 * Value for {@link #flags}: true when the application's window can be 167 * displayed on normal screens. Corresponds to 168 * {@link android.R.styleable#AndroidManifestSupportsScreens_normalScreens 169 * android:normalScreens}. 170 */ 171 public static final int FLAG_SUPPORTS_NORMAL_SCREENS = 1<<10; 172 173 /** 174 * Value for {@link #flags}: true when the application's window can be 175 * increased in size for larger screens. Corresponds to 176 * {@link android.R.styleable#AndroidManifestSupportsScreens_largeScreens 177 * android:largeScreens}. 178 */ 179 public static final int FLAG_SUPPORTS_LARGE_SCREENS = 1<<11; 180 181 /** 182 * Value for {@link #flags}: true when the application knows how to adjust 183 * its UI for different screen sizes. Corresponds to 184 * {@link android.R.styleable#AndroidManifestSupportsScreens_resizeable 185 * android:resizeable}. 186 */ 187 public static final int FLAG_RESIZEABLE_FOR_SCREENS = 1<<12; 188 189 /** 190 * Value for {@link #flags}: true when the application knows how to 191 * accomodate different screen densities. Corresponds to 192 * {@link android.R.styleable#AndroidManifestSupportsScreens_anyDensity 193 * android:anyDensity}. 194 */ 195 public static final int FLAG_SUPPORTS_SCREEN_DENSITIES = 1<<13; 196 197 /** 198 * Value for {@link #flags}: set to true if this application would like to 199 * request the VM to operate under the safe mode. Comes from 200 * {@link android.R.styleable#AndroidManifestApplication_vmSafeMode 201 * android:vmSafeMode} of the <application> tag. 202 */ 203 public static final int FLAG_VM_SAFE_MODE = 1<<14; 204 205 /** 206 * Value for {@link #flags}: set to <code>false</code> if the application does not wish 207 * to permit any OS-driven backups of its data; <code>true</code> otherwise. 208 * 209 * <p>Comes from the 210 * {@link android.R.styleable#AndroidManifestApplication_allowBackup android:allowBackup} 211 * attribute of the <application> tag. 212 */ 213 public static final int FLAG_ALLOW_BACKUP = 1<<15; 214 215 /** 216 * Value for {@link #flags}: set to <code>false</code> if the application must be kept 217 * in memory following a full-system restore operation; <code>true</code> otherwise. 218 * Ordinarily, during a full system restore operation each application is shut down 219 * following execution of its agent's onRestore() method. Setting this attribute to 220 * <code>false</code> prevents this. Most applications will not need to set this attribute. 221 * 222 * <p>If 223 * {@link android.R.styleable#AndroidManifestApplication_allowBackup android:allowBackup} 224 * is set to <code>false</code> or no 225 * {@link android.R.styleable#AndroidManifestApplication_backupAgent android:backupAgent} 226 * is specified, this flag will be ignored. 227 * 228 * <p>Comes from the 229 * {@link android.R.styleable#AndroidManifestApplication_killAfterRestore android:killAfterRestore} 230 * attribute of the <application> tag. 231 */ 232 public static final int FLAG_KILL_AFTER_RESTORE = 1<<16; 233 234 /** 235 * Value for {@link #flags}: Set to <code>true</code> if the application's backup 236 * agent claims to be able to handle restore data even "from the future," 237 * i.e. from versions of the application with a versionCode greater than 238 * the one currently installed on the device. <i>Use with caution!</i> By default 239 * this attribute is <code>false</code> and the Backup Manager will ensure that data 240 * from "future" versions of the application are never supplied during a restore operation. 241 * 242 * <p>If 243 * {@link android.R.styleable#AndroidManifestApplication_allowBackup android:allowBackup} 244 * is set to <code>false</code> or no 245 * {@link android.R.styleable#AndroidManifestApplication_backupAgent android:backupAgent} 246 * is specified, this flag will be ignored. 247 * 248 * <p>Comes from the 249 * {@link android.R.styleable#AndroidManifestApplication_restoreAnyVersion android:restoreAnyVersion} 250 * attribute of the <application> tag. 251 */ 252 public static final int FLAG_RESTORE_ANY_VERSION = 1<<17; 253 254 /** 255 * Value for {@link #flags}: Set to true if the application is 256 * currently installed on external/removable/unprotected storage. Such 257 * applications may not be available if their storage is not currently 258 * mounted. When the storage it is on is not available, it will look like 259 * the application has been uninstalled (its .apk is no longer available) 260 * but its persistent data is not removed. 261 */ 262 public static final int FLAG_EXTERNAL_STORAGE = 1<<18; 263 264 /** 265 * Value for {@link #flags}: true when the application's window can be 266 * increased in size for extra large screens. Corresponds to 267 * {@link android.R.styleable#AndroidManifestSupportsScreens_xlargeScreens 268 * android:xlargeScreens}. 269 */ 270 public static final int FLAG_SUPPORTS_XLARGE_SCREENS = 1<<19; 271 272 /** 273 * Value for {@link #flags}: true when the application has requested a 274 * large heap for its processes. Corresponds to 275 * {@link android.R.styleable#AndroidManifestApplication_largeHeap 276 * android:largeHeap}. 277 */ 278 public static final int FLAG_LARGE_HEAP = 1<<20; 279 280 /** 281 * Value for {@link #flags}: true if this application's package is in 282 * the stopped state. 283 */ 284 public static final int FLAG_STOPPED = 1<<21; 285 286 /** 287 * Value for {@link #flags}: Set to true if the application has been 288 * installed using the forward lock option. 289 * 290 * NOTE: DO NOT CHANGE THIS VALUE! It is saved in packages.xml. 291 * 292 * {@hide} 293 */ 294 public static final int FLAG_FORWARD_LOCK = 1<<29; 295 296 /** 297 * Value for {@link #flags}: set to <code>true</code> if the application 298 * has reported that it is heavy-weight, and thus can not participate in 299 * the normal application lifecycle. 300 * 301 * <p>Comes from the 302 * {@link android.R.styleable#AndroidManifestApplication_cantSaveState android:cantSaveState} 303 * attribute of the <application> tag. 304 * 305 * {@hide} 306 */ 307 public static final int FLAG_CANT_SAVE_STATE = 1<<28; 308 309 /** 310 * Flags associated with the application. Any combination of 311 * {@link #FLAG_SYSTEM}, {@link #FLAG_DEBUGGABLE}, {@link #FLAG_HAS_CODE}, 312 * {@link #FLAG_PERSISTENT}, {@link #FLAG_FACTORY_TEST}, and 313 * {@link #FLAG_ALLOW_TASK_REPARENTING} 314 * {@link #FLAG_ALLOW_CLEAR_USER_DATA}, {@link #FLAG_UPDATED_SYSTEM_APP}, 315 * {@link #FLAG_TEST_ONLY}, {@link #FLAG_SUPPORTS_SMALL_SCREENS}, 316 * {@link #FLAG_SUPPORTS_NORMAL_SCREENS}, 317 * {@link #FLAG_SUPPORTS_LARGE_SCREENS}, {@link #FLAG_SUPPORTS_XLARGE_SCREENS}, 318 * {@link #FLAG_RESIZEABLE_FOR_SCREENS}, 319 * {@link #FLAG_SUPPORTS_SCREEN_DENSITIES}, {@link #FLAG_VM_SAFE_MODE} 320 */ 321 public int flags = 0; 322 323 /** 324 * The required smallest screen width the application can run on. If 0, 325 * nothing has been specified. Comes from 326 * {@link android.R.styleable#AndroidManifestSupportsScreens_requiresSmallestWidthDp 327 * android:requiresSmallestWidthDp} attribute of the <supports-screens> tag. 328 */ 329 public int requiresSmallestWidthDp = 0; 330 331 /** 332 * The maximum smallest screen width the application is designed for. If 0, 333 * nothing has been specified. Comes from 334 * {@link android.R.styleable#AndroidManifestSupportsScreens_compatibleWidthLimitDp 335 * android:compatibleWidthLimitDp} attribute of the <supports-screens> tag. 336 */ 337 public int compatibleWidthLimitDp = 0; 338 339 /** 340 * Full path to the location of this package. 341 */ 342 public String sourceDir; 343 344 /** 345 * Full path to the location of the publicly available parts of this 346 * package (i.e. the primary resource package and manifest). For 347 * non-forward-locked apps this will be the same as {@link #sourceDir). 348 */ 349 public String publicSourceDir; 350 351 /** 352 * Full paths to the locations of extra resource packages this application 353 * uses. This field is only used if there are extra resource packages, 354 * otherwise it is null. 355 * 356 * {@hide} 357 */ 358 public String[] resourceDirs; 359 360 /** 361 * Paths to all shared libraries this application is linked against. This 362 * field is only set if the {@link PackageManager#GET_SHARED_LIBRARY_FILES 363 * PackageManager.GET_SHARED_LIBRARY_FILES} flag was used when retrieving 364 * the structure. 365 */ 366 public String[] sharedLibraryFiles; 367 368 /** 369 * Full path to a directory assigned to the package for its persistent 370 * data. 371 */ 372 public String dataDir; 373 374 /** 375 * Full path to the directory where native JNI libraries are stored. 376 */ 377 public String nativeLibraryDir; 378 379 /** 380 * The kernel user-ID that has been assigned to this application; 381 * currently this is not a unique ID (multiple applications can have 382 * the same uid). 383 */ 384 public int uid; 385 386 /** 387 * The minimum SDK version this application targets. It may run on earlier 388 * versions, but it knows how to work with any new behavior added at this 389 * version. Will be {@link android.os.Build.VERSION_CODES#CUR_DEVELOPMENT} 390 * if this is a development build and the app is targeting that. You should 391 * compare that this number is >= the SDK version number at which your 392 * behavior was introduced. 393 */ 394 public int targetSdkVersion; 395 396 /** 397 * When false, indicates that all components within this application are 398 * considered disabled, regardless of their individually set enabled status. 399 */ 400 public boolean enabled = true; 401 402 /** 403 * For convenient access to package's install location. 404 * @hide 405 */ 406 public int installLocation = PackageInfo.INSTALL_LOCATION_UNSPECIFIED; 407 408 public void dump(Printer pw, String prefix) { 409 super.dumpFront(pw, prefix); 410 if (className != null) { 411 pw.println(prefix + "className=" + className); 412 } 413 if (permission != null) { 414 pw.println(prefix + "permission=" + permission); 415 } 416 pw.println(prefix + "processName=" + processName); 417 pw.println(prefix + "taskAffinity=" + taskAffinity); 418 pw.println(prefix + "uid=" + uid + " flags=0x" + Integer.toHexString(flags) 419 + " theme=0x" + Integer.toHexString(theme)); 420 pw.println(prefix + "requiresSmallestWidthDp=" + requiresSmallestWidthDp 421 + " compatibleWidthLimitDp=" + compatibleWidthLimitDp); 422 pw.println(prefix + "sourceDir=" + sourceDir); 423 if (sourceDir == null) { 424 if (publicSourceDir != null) { 425 pw.println(prefix + "publicSourceDir=" + publicSourceDir); 426 } 427 } else if (!sourceDir.equals(publicSourceDir)) { 428 pw.println(prefix + "publicSourceDir=" + publicSourceDir); 429 } 430 if (resourceDirs != null) { 431 pw.println(prefix + "resourceDirs=" + resourceDirs); 432 } 433 pw.println(prefix + "dataDir=" + dataDir); 434 if (sharedLibraryFiles != null) { 435 pw.println(prefix + "sharedLibraryFiles=" + sharedLibraryFiles); 436 } 437 pw.println(prefix + "enabled=" + enabled + " targetSdkVersion=" + targetSdkVersion); 438 if (manageSpaceActivityName != null) { 439 pw.println(prefix + "manageSpaceActivityName="+manageSpaceActivityName); 440 } 441 if (descriptionRes != 0) { 442 pw.println(prefix + "description=0x"+Integer.toHexString(descriptionRes)); 443 } 444 super.dumpBack(pw, prefix); 445 } 446 447 public static class DisplayNameComparator 448 implements Comparator<ApplicationInfo> { 449 public DisplayNameComparator(PackageManager pm) { 450 mPM = pm; 451 } 452 453 public final int compare(ApplicationInfo aa, ApplicationInfo ab) { 454 CharSequence sa = mPM.getApplicationLabel(aa); 455 if (sa == null) { 456 sa = aa.packageName; 457 } 458 CharSequence sb = mPM.getApplicationLabel(ab); 459 if (sb == null) { 460 sb = ab.packageName; 461 } 462 463 return sCollator.compare(sa.toString(), sb.toString()); 464 } 465 466 private final Collator sCollator = Collator.getInstance(); 467 private PackageManager mPM; 468 } 469 470 public ApplicationInfo() { 471 } 472 473 public ApplicationInfo(ApplicationInfo orig) { 474 super(orig); 475 taskAffinity = orig.taskAffinity; 476 permission = orig.permission; 477 processName = orig.processName; 478 className = orig.className; 479 theme = orig.theme; 480 flags = orig.flags; 481 requiresSmallestWidthDp = orig.requiresSmallestWidthDp; 482 compatibleWidthLimitDp = orig.compatibleWidthLimitDp; 483 sourceDir = orig.sourceDir; 484 publicSourceDir = orig.publicSourceDir; 485 nativeLibraryDir = orig.nativeLibraryDir; 486 resourceDirs = orig.resourceDirs; 487 sharedLibraryFiles = orig.sharedLibraryFiles; 488 dataDir = orig.dataDir; 489 uid = orig.uid; 490 targetSdkVersion = orig.targetSdkVersion; 491 enabled = orig.enabled; 492 installLocation = orig.installLocation; 493 manageSpaceActivityName = orig.manageSpaceActivityName; 494 descriptionRes = orig.descriptionRes; 495 } 496 497 498 public String toString() { 499 return "ApplicationInfo{" 500 + Integer.toHexString(System.identityHashCode(this)) 501 + " " + packageName + "}"; 502 } 503 504 public int describeContents() { 505 return 0; 506 } 507 508 public void writeToParcel(Parcel dest, int parcelableFlags) { 509 super.writeToParcel(dest, parcelableFlags); 510 dest.writeString(taskAffinity); 511 dest.writeString(permission); 512 dest.writeString(processName); 513 dest.writeString(className); 514 dest.writeInt(theme); 515 dest.writeInt(flags); 516 dest.writeInt(requiresSmallestWidthDp); 517 dest.writeInt(compatibleWidthLimitDp); 518 dest.writeString(sourceDir); 519 dest.writeString(publicSourceDir); 520 dest.writeString(nativeLibraryDir); 521 dest.writeStringArray(resourceDirs); 522 dest.writeStringArray(sharedLibraryFiles); 523 dest.writeString(dataDir); 524 dest.writeInt(uid); 525 dest.writeInt(targetSdkVersion); 526 dest.writeInt(enabled ? 1 : 0); 527 dest.writeInt(installLocation); 528 dest.writeString(manageSpaceActivityName); 529 dest.writeString(backupAgentName); 530 dest.writeInt(descriptionRes); 531 } 532 533 public static final Parcelable.Creator<ApplicationInfo> CREATOR 534 = new Parcelable.Creator<ApplicationInfo>() { 535 public ApplicationInfo createFromParcel(Parcel source) { 536 return new ApplicationInfo(source); 537 } 538 public ApplicationInfo[] newArray(int size) { 539 return new ApplicationInfo[size]; 540 } 541 }; 542 543 private ApplicationInfo(Parcel source) { 544 super(source); 545 taskAffinity = source.readString(); 546 permission = source.readString(); 547 processName = source.readString(); 548 className = source.readString(); 549 theme = source.readInt(); 550 flags = source.readInt(); 551 requiresSmallestWidthDp = source.readInt(); 552 compatibleWidthLimitDp = source.readInt(); 553 sourceDir = source.readString(); 554 publicSourceDir = source.readString(); 555 nativeLibraryDir = source.readString(); 556 resourceDirs = source.readStringArray(); 557 sharedLibraryFiles = source.readStringArray(); 558 dataDir = source.readString(); 559 uid = source.readInt(); 560 targetSdkVersion = source.readInt(); 561 enabled = source.readInt() != 0; 562 installLocation = source.readInt(); 563 manageSpaceActivityName = source.readString(); 564 backupAgentName = source.readString(); 565 descriptionRes = source.readInt(); 566 } 567 568 /** 569 * Retrieve the textual description of the application. This 570 * will call back on the given PackageManager to load the description from 571 * the application. 572 * 573 * @param pm A PackageManager from which the label can be loaded; usually 574 * the PackageManager from which you originally retrieved this item. 575 * 576 * @return Returns a CharSequence containing the application's description. 577 * If there is no description, null is returned. 578 */ 579 public CharSequence loadDescription(PackageManager pm) { 580 if (descriptionRes != 0) { 581 CharSequence label = pm.getText(packageName, descriptionRes, this); 582 if (label != null) { 583 return label; 584 } 585 } 586 return null; 587 } 588 589 /** 590 * Disable compatibility mode 591 * 592 * @hide 593 */ 594 public void disableCompatibilityMode() { 595 flags |= (FLAG_SUPPORTS_LARGE_SCREENS | FLAG_SUPPORTS_NORMAL_SCREENS | 596 FLAG_SUPPORTS_SMALL_SCREENS | FLAG_RESIZEABLE_FOR_SCREENS | 597 FLAG_SUPPORTS_SCREEN_DENSITIES | FLAG_SUPPORTS_XLARGE_SCREENS); 598 } 599 600 /** 601 * @hide 602 */ 603 @Override protected Drawable loadDefaultIcon(PackageManager pm) { 604 if ((flags & FLAG_EXTERNAL_STORAGE) != 0 605 && isPackageUnavailable(pm)) { 606 return Resources.getSystem().getDrawable( 607 com.android.internal.R.drawable.sym_app_on_sd_unavailable_icon); 608 } 609 return pm.getDefaultActivityIcon(); 610 } 611 612 private boolean isPackageUnavailable(PackageManager pm) { 613 try { 614 return pm.getPackageInfo(packageName, 0) == null; 615 } catch (NameNotFoundException ex) { 616 return true; 617 } 618 } 619 620 /** 621 * @hide 622 */ 623 @Override protected ApplicationInfo getApplicationInfo() { 624 return this; 625 } 626} 627