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