ApplicationInfo.java revision a3cdaa5337fa573c4c61770195d6232c2e587090
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}: this is true if the application has set 274 * its android:neverEncrypt to true, false otherwise. It is used to specify 275 * that this package specifically "opts-out" of a secured file system solution, 276 * and will always store its data in-the-clear. 277 * 278 * {@hide} 279 */ 280 public static final int FLAG_NEVER_ENCRYPT = 1<<30; 281 282 /** 283 * Value for {@link #flags}: Set to true if the application has been 284 * installed using the forward lock option. 285 * 286 * {@hide} 287 */ 288 public static final int FLAG_FORWARD_LOCK = 1<<29; 289 290 /** 291 * Value for {@link #flags}: set to <code>true</code> if the application 292 * has reported that it is heavy-weight, and thus can not participate in 293 * the normal application lifecycle. 294 * 295 * <p>Comes from the 296 * {@link android.R.styleable#AndroidManifestApplication_cantSaveState android:cantSaveState} 297 * attribute of the <application> tag. 298 * 299 * {@hide} 300 */ 301 public static final int FLAG_CANT_SAVE_STATE = 1<<27; 302 303 /** 304 * Flags associated with the application. Any combination of 305 * {@link #FLAG_SYSTEM}, {@link #FLAG_DEBUGGABLE}, {@link #FLAG_HAS_CODE}, 306 * {@link #FLAG_PERSISTENT}, {@link #FLAG_FACTORY_TEST}, and 307 * {@link #FLAG_ALLOW_TASK_REPARENTING} 308 * {@link #FLAG_ALLOW_CLEAR_USER_DATA}, {@link #FLAG_UPDATED_SYSTEM_APP}, 309 * {@link #FLAG_TEST_ONLY}, {@link #FLAG_SUPPORTS_SMALL_SCREENS}, 310 * {@link #FLAG_SUPPORTS_NORMAL_SCREENS}, 311 * {@link #FLAG_SUPPORTS_LARGE_SCREENS}, {@link #FLAG_SUPPORTS_XLARGE_SCREENS}, 312 * {@link #FLAG_RESIZEABLE_FOR_SCREENS}, 313 * {@link #FLAG_SUPPORTS_SCREEN_DENSITIES}, {@link #FLAG_VM_SAFE_MODE} 314 */ 315 public int flags = 0; 316 317 /** 318 * Full path to the location of this package. 319 */ 320 public String sourceDir; 321 322 /** 323 * Full path to the location of the publicly available parts of this 324 * package (i.e. the primary resource package and manifest). For 325 * non-forward-locked apps this will be the same as {@link #sourceDir). 326 */ 327 public String publicSourceDir; 328 329 /** 330 * Full paths to the locations of extra resource packages this application 331 * uses. This field is only used if there are extra resource packages, 332 * otherwise it is null. 333 * 334 * {@hide} 335 */ 336 public String[] resourceDirs; 337 338 /** 339 * Paths to all shared libraries this application is linked against. This 340 * field is only set if the {@link PackageManager#GET_SHARED_LIBRARY_FILES 341 * PackageManager.GET_SHARED_LIBRARY_FILES} flag was used when retrieving 342 * the structure. 343 */ 344 public String[] sharedLibraryFiles; 345 346 /** 347 * Full path to a directory assigned to the package for its persistent 348 * data. 349 */ 350 public String dataDir; 351 352 /** 353 * Full path to the directory where native JNI libraries are stored. 354 */ 355 public String nativeLibraryDir; 356 357 /** 358 * The kernel user-ID that has been assigned to this application; 359 * currently this is not a unique ID (multiple applications can have 360 * the same uid). 361 */ 362 public int uid; 363 364 /** 365 * The minimum SDK version this application targets. It may run on earlier 366 * versions, but it knows how to work with any new behavior added at this 367 * version. Will be {@link android.os.Build.VERSION_CODES#CUR_DEVELOPMENT} 368 * if this is a development build and the app is targeting that. You should 369 * compare that this number is >= the SDK version number at which your 370 * behavior was introduced. 371 */ 372 public int targetSdkVersion; 373 374 /** 375 * When false, indicates that all components within this application are 376 * considered disabled, regardless of their individually set enabled status. 377 */ 378 public boolean enabled = true; 379 380 /** 381 * For convenient access to package's install location. 382 * @hide 383 */ 384 public int installLocation = PackageInfo.INSTALL_LOCATION_UNSPECIFIED; 385 386 public void dump(Printer pw, String prefix) { 387 super.dumpFront(pw, prefix); 388 if (className != null) { 389 pw.println(prefix + "className=" + className); 390 } 391 if (permission != null) { 392 pw.println(prefix + "permission=" + permission); 393 } 394 pw.println(prefix + "processName=" + processName); 395 pw.println(prefix + "taskAffinity=" + taskAffinity); 396 pw.println(prefix + "uid=" + uid + " flags=0x" + Integer.toHexString(flags) 397 + " theme=0x" + Integer.toHexString(theme)); 398 pw.println(prefix + "sourceDir=" + sourceDir); 399 if (sourceDir == null) { 400 if (publicSourceDir != null) { 401 pw.println(prefix + "publicSourceDir=" + publicSourceDir); 402 } 403 } else if (!sourceDir.equals(publicSourceDir)) { 404 pw.println(prefix + "publicSourceDir=" + publicSourceDir); 405 } 406 if (resourceDirs != null) { 407 pw.println(prefix + "resourceDirs=" + resourceDirs); 408 } 409 pw.println(prefix + "dataDir=" + dataDir); 410 if (sharedLibraryFiles != null) { 411 pw.println(prefix + "sharedLibraryFiles=" + sharedLibraryFiles); 412 } 413 pw.println(prefix + "enabled=" + enabled + " targetSdkVersion=" + targetSdkVersion); 414 if (manageSpaceActivityName != null) { 415 pw.println(prefix + "manageSpaceActivityName="+manageSpaceActivityName); 416 } 417 if (descriptionRes != 0) { 418 pw.println(prefix + "description=0x"+Integer.toHexString(descriptionRes)); 419 } 420 super.dumpBack(pw, prefix); 421 } 422 423 public static class DisplayNameComparator 424 implements Comparator<ApplicationInfo> { 425 public DisplayNameComparator(PackageManager pm) { 426 mPM = pm; 427 } 428 429 public final int compare(ApplicationInfo aa, ApplicationInfo ab) { 430 CharSequence sa = mPM.getApplicationLabel(aa); 431 if (sa == null) { 432 sa = aa.packageName; 433 } 434 CharSequence sb = mPM.getApplicationLabel(ab); 435 if (sb == null) { 436 sb = ab.packageName; 437 } 438 439 return sCollator.compare(sa.toString(), sb.toString()); 440 } 441 442 private final Collator sCollator = Collator.getInstance(); 443 private PackageManager mPM; 444 } 445 446 public ApplicationInfo() { 447 } 448 449 public ApplicationInfo(ApplicationInfo orig) { 450 super(orig); 451 taskAffinity = orig.taskAffinity; 452 permission = orig.permission; 453 processName = orig.processName; 454 className = orig.className; 455 theme = orig.theme; 456 flags = orig.flags; 457 sourceDir = orig.sourceDir; 458 publicSourceDir = orig.publicSourceDir; 459 nativeLibraryDir = orig.nativeLibraryDir; 460 resourceDirs = orig.resourceDirs; 461 sharedLibraryFiles = orig.sharedLibraryFiles; 462 dataDir = orig.dataDir; 463 uid = orig.uid; 464 targetSdkVersion = orig.targetSdkVersion; 465 enabled = orig.enabled; 466 installLocation = orig.installLocation; 467 manageSpaceActivityName = orig.manageSpaceActivityName; 468 descriptionRes = orig.descriptionRes; 469 } 470 471 472 public String toString() { 473 return "ApplicationInfo{" 474 + Integer.toHexString(System.identityHashCode(this)) 475 + " " + packageName + "}"; 476 } 477 478 public int describeContents() { 479 return 0; 480 } 481 482 public void writeToParcel(Parcel dest, int parcelableFlags) { 483 super.writeToParcel(dest, parcelableFlags); 484 dest.writeString(taskAffinity); 485 dest.writeString(permission); 486 dest.writeString(processName); 487 dest.writeString(className); 488 dest.writeInt(theme); 489 dest.writeInt(flags); 490 dest.writeString(sourceDir); 491 dest.writeString(publicSourceDir); 492 dest.writeString(nativeLibraryDir); 493 dest.writeStringArray(resourceDirs); 494 dest.writeStringArray(sharedLibraryFiles); 495 dest.writeString(dataDir); 496 dest.writeInt(uid); 497 dest.writeInt(targetSdkVersion); 498 dest.writeInt(enabled ? 1 : 0); 499 dest.writeInt(installLocation); 500 dest.writeString(manageSpaceActivityName); 501 dest.writeString(backupAgentName); 502 dest.writeInt(descriptionRes); 503 } 504 505 public static final Parcelable.Creator<ApplicationInfo> CREATOR 506 = new Parcelable.Creator<ApplicationInfo>() { 507 public ApplicationInfo createFromParcel(Parcel source) { 508 return new ApplicationInfo(source); 509 } 510 public ApplicationInfo[] newArray(int size) { 511 return new ApplicationInfo[size]; 512 } 513 }; 514 515 private ApplicationInfo(Parcel source) { 516 super(source); 517 taskAffinity = source.readString(); 518 permission = source.readString(); 519 processName = source.readString(); 520 className = source.readString(); 521 theme = source.readInt(); 522 flags = source.readInt(); 523 sourceDir = source.readString(); 524 publicSourceDir = source.readString(); 525 nativeLibraryDir = source.readString(); 526 resourceDirs = source.readStringArray(); 527 sharedLibraryFiles = source.readStringArray(); 528 dataDir = source.readString(); 529 uid = source.readInt(); 530 targetSdkVersion = source.readInt(); 531 enabled = source.readInt() != 0; 532 installLocation = source.readInt(); 533 manageSpaceActivityName = source.readString(); 534 backupAgentName = source.readString(); 535 descriptionRes = source.readInt(); 536 } 537 538 /** 539 * Retrieve the textual description of the application. This 540 * will call back on the given PackageManager to load the description from 541 * the application. 542 * 543 * @param pm A PackageManager from which the label can be loaded; usually 544 * the PackageManager from which you originally retrieved this item. 545 * 546 * @return Returns a CharSequence containing the application's description. 547 * If there is no description, null is returned. 548 */ 549 public CharSequence loadDescription(PackageManager pm) { 550 if (descriptionRes != 0) { 551 CharSequence label = pm.getText(packageName, descriptionRes, this); 552 if (label != null) { 553 return label; 554 } 555 } 556 return null; 557 } 558 559 /** 560 * Disable compatibility mode 561 * 562 * @hide 563 */ 564 public void disableCompatibilityMode() { 565 flags |= (FLAG_SUPPORTS_LARGE_SCREENS | FLAG_SUPPORTS_NORMAL_SCREENS | 566 FLAG_SUPPORTS_SMALL_SCREENS | FLAG_RESIZEABLE_FOR_SCREENS | 567 FLAG_SUPPORTS_SCREEN_DENSITIES | FLAG_SUPPORTS_XLARGE_SCREENS); 568 } 569 570 /** 571 * @hide 572 */ 573 @Override protected Drawable loadDefaultIcon(PackageManager pm) { 574 if ((flags & FLAG_EXTERNAL_STORAGE) != 0 575 && isPackageUnavailable(pm)) { 576 return Resources.getSystem().getDrawable( 577 com.android.internal.R.drawable.sym_app_on_sd_unavailable_icon); 578 } 579 return pm.getDefaultActivityIcon(); 580 } 581 582 private boolean isPackageUnavailable(PackageManager pm) { 583 try { 584 return pm.getPackageInfo(packageName, 0) == null; 585 } catch (NameNotFoundException ex) { 586 return true; 587 } 588 } 589 590 /** 591 * @hide 592 */ 593 @Override protected ApplicationInfo getApplicationInfo() { 594 return this; 595 } 596} 597