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