ShortcutService.java revision b6d3523dfb5d73ddda4b750a82c059cdc42acf8e
1/* 2 * Copyright (C) 2016 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 */ 16package com.android.server.pm; 17 18import android.annotation.NonNull; 19import android.annotation.Nullable; 20import android.annotation.UserIdInt; 21import android.app.ActivityManager; 22import android.app.AppGlobals; 23import android.content.ComponentName; 24import android.content.ContentProvider; 25import android.content.Context; 26import android.content.Intent; 27import android.content.pm.ApplicationInfo; 28import android.content.pm.IPackageManager; 29import android.content.pm.IShortcutService; 30import android.content.pm.LauncherApps; 31import android.content.pm.LauncherApps.ShortcutQuery; 32import android.content.pm.PackageInfo; 33import android.content.pm.PackageManager; 34import android.content.pm.PackageManagerInternal; 35import android.content.pm.ParceledListSlice; 36import android.content.pm.ResolveInfo; 37import android.content.pm.ShortcutInfo; 38import android.content.pm.ShortcutServiceInternal; 39import android.content.pm.ShortcutServiceInternal.ShortcutChangeListener; 40import android.graphics.Bitmap; 41import android.graphics.Bitmap.CompressFormat; 42import android.graphics.BitmapFactory; 43import android.graphics.Canvas; 44import android.graphics.RectF; 45import android.graphics.drawable.Icon; 46import android.net.Uri; 47import android.os.Binder; 48import android.os.Environment; 49import android.os.FileUtils; 50import android.os.Handler; 51import android.os.Looper; 52import android.os.ParcelFileDescriptor; 53import android.os.PersistableBundle; 54import android.os.Process; 55import android.os.RemoteException; 56import android.os.ResultReceiver; 57import android.os.SELinux; 58import android.os.ShellCommand; 59import android.os.UserHandle; 60import android.os.UserManager; 61import android.text.TextUtils; 62import android.text.format.Time; 63import android.util.ArrayMap; 64import android.util.ArraySet; 65import android.util.AtomicFile; 66import android.util.KeyValueListParser; 67import android.util.Slog; 68import android.util.SparseArray; 69import android.util.TypedValue; 70import android.util.Xml; 71 72import com.android.internal.annotations.GuardedBy; 73import com.android.internal.annotations.VisibleForTesting; 74import com.android.internal.content.PackageMonitor; 75import com.android.internal.os.BackgroundThread; 76import com.android.internal.util.FastXmlSerializer; 77import com.android.internal.util.Preconditions; 78import com.android.server.LocalServices; 79import com.android.server.SystemService; 80import com.android.server.pm.ShortcutUser.PackageWithUser; 81 82import libcore.io.IoUtils; 83 84import org.xmlpull.v1.XmlPullParser; 85import org.xmlpull.v1.XmlPullParserException; 86import org.xmlpull.v1.XmlSerializer; 87 88import java.io.BufferedInputStream; 89import java.io.BufferedOutputStream; 90import java.io.ByteArrayInputStream; 91import java.io.ByteArrayOutputStream; 92import java.io.File; 93import java.io.FileDescriptor; 94import java.io.FileInputStream; 95import java.io.FileNotFoundException; 96import java.io.FileOutputStream; 97import java.io.IOException; 98import java.io.InputStream; 99import java.io.OutputStream; 100import java.io.PrintWriter; 101import java.net.URISyntaxException; 102import java.nio.charset.StandardCharsets; 103import java.util.ArrayList; 104import java.util.List; 105import java.util.function.Consumer; 106import java.util.function.Predicate; 107 108/** 109 * TODO: 110 * 111 * - Default launcher check does take a few ms. Worth caching. 112 * 113 * - Clear data -> remove all dynamic? but not the pinned? 114 * 115 * - Scan and remove orphan bitmaps (just in case). 116 * 117 * - Detect when already registered instances are passed to APIs again, which might break 118 * internal bitmap handling. 119 * 120 * - Add more call stats. 121 */ 122public class ShortcutService extends IShortcutService.Stub { 123 static final String TAG = "ShortcutService"; 124 125 static final boolean DEBUG = false; // STOPSHIP if true 126 static final boolean DEBUG_LOAD = false; // STOPSHIP if true 127 128 @VisibleForTesting 129 static final long DEFAULT_RESET_INTERVAL_SEC = 60 * 60; // 1 hour 130 131 @VisibleForTesting 132 static final int DEFAULT_MAX_UPDATES_PER_INTERVAL = 2; 133 134 @VisibleForTesting 135 static final int DEFAULT_MAX_SHORTCUTS_PER_APP = 5; 136 137 @VisibleForTesting 138 static final int DEFAULT_MAX_ICON_DIMENSION_DP = 96; 139 140 @VisibleForTesting 141 static final int DEFAULT_MAX_ICON_DIMENSION_LOWRAM_DP = 48; 142 143 @VisibleForTesting 144 static final String DEFAULT_ICON_PERSIST_FORMAT = CompressFormat.PNG.name(); 145 146 @VisibleForTesting 147 static final int DEFAULT_ICON_PERSIST_QUALITY = 100; 148 149 @VisibleForTesting 150 static final int DEFAULT_SAVE_DELAY_MS = 3000; 151 152 @VisibleForTesting 153 static final String FILENAME_BASE_STATE = "shortcut_service.xml"; 154 155 @VisibleForTesting 156 static final String DIRECTORY_PER_USER = "shortcut_service"; 157 158 @VisibleForTesting 159 static final String FILENAME_USER_PACKAGES = "shortcuts.xml"; 160 161 static final String DIRECTORY_BITMAPS = "bitmaps"; 162 163 private static final String TAG_ROOT = "root"; 164 private static final String TAG_LAST_RESET_TIME = "last_reset_time"; 165 166 private static final String ATTR_VALUE = "value"; 167 168 @VisibleForTesting 169 interface ConfigConstants { 170 /** 171 * Key name for the save delay, in milliseconds. (int) 172 */ 173 String KEY_SAVE_DELAY_MILLIS = "save_delay_ms"; 174 175 /** 176 * Key name for the throttling reset interval, in seconds. (long) 177 */ 178 String KEY_RESET_INTERVAL_SEC = "reset_interval_sec"; 179 180 /** 181 * Key name for the max number of modifying API calls per app for every interval. (int) 182 */ 183 String KEY_MAX_UPDATES_PER_INTERVAL = "max_updates_per_interval"; 184 185 /** 186 * Key name for the max icon dimensions in DP, for non-low-memory devices. 187 */ 188 String KEY_MAX_ICON_DIMENSION_DP = "max_icon_dimension_dp"; 189 190 /** 191 * Key name for the max icon dimensions in DP, for low-memory devices. 192 */ 193 String KEY_MAX_ICON_DIMENSION_DP_LOWRAM = "max_icon_dimension_dp_lowram"; 194 195 /** 196 * Key name for the max dynamic shortcuts per app. (int) 197 */ 198 String KEY_MAX_SHORTCUTS = "max_shortcuts"; 199 200 /** 201 * Key name for icon compression quality, 0-100. 202 */ 203 String KEY_ICON_QUALITY = "icon_quality"; 204 205 /** 206 * Key name for icon compression format: "PNG", "JPEG" or "WEBP" 207 */ 208 String KEY_ICON_FORMAT = "icon_format"; 209 } 210 211 final Context mContext; 212 213 private final Object mLock = new Object(); 214 215 private final Handler mHandler; 216 217 @GuardedBy("mLock") 218 private final ArrayList<ShortcutChangeListener> mListeners = new ArrayList<>(1); 219 220 @GuardedBy("mLock") 221 private long mRawLastResetTime; 222 223 /** 224 * User ID -> UserShortcuts 225 */ 226 @GuardedBy("mLock") 227 private final SparseArray<ShortcutUser> mUsers = new SparseArray<>(); 228 229 /** 230 * Max number of dynamic shortcuts that each application can have at a time. 231 */ 232 private int mMaxDynamicShortcuts; 233 234 /** 235 * Max number of updating API calls that each application can make during the interval. 236 */ 237 int mMaxUpdatesPerInterval; 238 239 /** 240 * Actual throttling-reset interval. By default it's a day. 241 */ 242 private long mResetInterval; 243 244 /** 245 * Icon max width/height in pixels. 246 */ 247 private int mMaxIconDimension; 248 249 private CompressFormat mIconPersistFormat; 250 private int mIconPersistQuality; 251 252 private int mSaveDelayMillis; 253 254 private final IPackageManager mIPackageManager; 255 private final PackageManagerInternal mPackageManagerInternal; 256 private final UserManager mUserManager; 257 258 @GuardedBy("mLock") 259 private List<Integer> mDirtyUserIds = new ArrayList<>(); 260 261 private static final int PACKAGE_MATCH_FLAGS = 262 PackageManager.MATCH_DIRECT_BOOT_AWARE 263 | PackageManager.MATCH_DIRECT_BOOT_UNAWARE 264 | PackageManager.MATCH_UNINSTALLED_PACKAGES; 265 266 // Stats 267 @VisibleForTesting 268 interface Stats { 269 int GET_DEFAULT_HOME = 0; 270 int GET_PACKAGE_INFO = 1; 271 int GET_PACKAGE_INFO_WITH_SIG = 2; 272 int GET_APPLICATION_INFO = 3; 273 int LAUNCHER_PERMISSION_CHECK = 4; 274 275 int COUNT = LAUNCHER_PERMISSION_CHECK + 1; 276 } 277 278 final Object mStatLock = new Object(); 279 280 @GuardedBy("mStatLock") 281 private final int[] mCountStats = new int[Stats.COUNT]; 282 283 @GuardedBy("mStatLock") 284 private final long[] mDurationStats = new long[Stats.COUNT]; 285 286 public ShortcutService(Context context) { 287 this(context, BackgroundThread.get().getLooper()); 288 } 289 290 @VisibleForTesting 291 ShortcutService(Context context, Looper looper) { 292 mContext = Preconditions.checkNotNull(context); 293 LocalServices.addService(ShortcutServiceInternal.class, new LocalService()); 294 mHandler = new Handler(looper); 295 mIPackageManager = AppGlobals.getPackageManager(); 296 mPackageManagerInternal = LocalServices.getService(PackageManagerInternal.class); 297 mUserManager = context.getSystemService(UserManager.class); 298 299 mPackageMonitor.register(context, looper, UserHandle.ALL, /* externalStorage= */ false); 300 } 301 302 void logDurationStat(int statId, long start) { 303 synchronized (mStatLock) { 304 mCountStats[statId]++; 305 mDurationStats[statId] += (System.currentTimeMillis() - start); 306 } 307 } 308 309 /** 310 * System service lifecycle. 311 */ 312 public static final class Lifecycle extends SystemService { 313 final ShortcutService mService; 314 315 public Lifecycle(Context context) { 316 super(context); 317 mService = new ShortcutService(context); 318 } 319 320 @Override 321 public void onStart() { 322 publishBinderService(Context.SHORTCUT_SERVICE, mService); 323 } 324 325 @Override 326 public void onBootPhase(int phase) { 327 mService.onBootPhase(phase); 328 } 329 330 @Override 331 public void onCleanupUser(int userHandle) { 332 mService.handleCleanupUser(userHandle); 333 } 334 335 @Override 336 public void onUnlockUser(int userId) { 337 mService.handleUnlockUser(userId); 338 } 339 } 340 341 /** lifecycle event */ 342 void onBootPhase(int phase) { 343 if (DEBUG) { 344 Slog.d(TAG, "onBootPhase: " + phase); 345 } 346 switch (phase) { 347 case SystemService.PHASE_LOCK_SETTINGS_READY: 348 initialize(); 349 break; 350 } 351 } 352 353 /** lifecycle event */ 354 void handleUnlockUser(int userId) { 355 synchronized (mLock) { 356 // Preload 357 getUserShortcutsLocked(userId); 358 359 cleanupGonePackages(userId); 360 } 361 } 362 363 /** lifecycle event */ 364 void handleCleanupUser(int userId) { 365 synchronized (mLock) { 366 unloadUserLocked(userId); 367 } 368 } 369 370 private void unloadUserLocked(int userId) { 371 if (DEBUG) { 372 Slog.d(TAG, "unloadUserLocked: user=" + userId); 373 } 374 // Save all dirty information. 375 saveDirtyInfo(); 376 377 // Unload 378 mUsers.delete(userId); 379 } 380 381 /** Return the base state file name */ 382 private AtomicFile getBaseStateFile() { 383 final File path = new File(injectSystemDataPath(), FILENAME_BASE_STATE); 384 path.mkdirs(); 385 return new AtomicFile(path); 386 } 387 388 /** 389 * Init the instance. (load the state file, etc) 390 */ 391 private void initialize() { 392 synchronized (mLock) { 393 loadConfigurationLocked(); 394 loadBaseStateLocked(); 395 } 396 } 397 398 /** 399 * Load the configuration from Settings. 400 */ 401 private void loadConfigurationLocked() { 402 updateConfigurationLocked(injectShortcutManagerConstants()); 403 } 404 405 /** 406 * Load the configuration from Settings. 407 */ 408 @VisibleForTesting 409 boolean updateConfigurationLocked(String config) { 410 boolean result = true; 411 412 final KeyValueListParser parser = new KeyValueListParser(','); 413 try { 414 parser.setString(config); 415 } catch (IllegalArgumentException e) { 416 // Failed to parse the settings string, log this and move on 417 // with defaults. 418 Slog.e(TAG, "Bad shortcut manager settings", e); 419 result = false; 420 } 421 422 mSaveDelayMillis = Math.max(0, (int) parser.getLong(ConfigConstants.KEY_SAVE_DELAY_MILLIS, 423 DEFAULT_SAVE_DELAY_MS)); 424 425 mResetInterval = Math.max(1, parser.getLong( 426 ConfigConstants.KEY_RESET_INTERVAL_SEC, DEFAULT_RESET_INTERVAL_SEC) 427 * 1000L); 428 429 mMaxUpdatesPerInterval = Math.max(0, (int) parser.getLong( 430 ConfigConstants.KEY_MAX_UPDATES_PER_INTERVAL, DEFAULT_MAX_UPDATES_PER_INTERVAL)); 431 432 mMaxDynamicShortcuts = Math.max(0, (int) parser.getLong( 433 ConfigConstants.KEY_MAX_SHORTCUTS, DEFAULT_MAX_SHORTCUTS_PER_APP)); 434 435 final int iconDimensionDp = Math.max(1, injectIsLowRamDevice() 436 ? (int) parser.getLong( 437 ConfigConstants.KEY_MAX_ICON_DIMENSION_DP_LOWRAM, 438 DEFAULT_MAX_ICON_DIMENSION_LOWRAM_DP) 439 : (int) parser.getLong( 440 ConfigConstants.KEY_MAX_ICON_DIMENSION_DP, 441 DEFAULT_MAX_ICON_DIMENSION_DP)); 442 443 mMaxIconDimension = injectDipToPixel(iconDimensionDp); 444 445 mIconPersistFormat = CompressFormat.valueOf( 446 parser.getString(ConfigConstants.KEY_ICON_FORMAT, DEFAULT_ICON_PERSIST_FORMAT)); 447 448 mIconPersistQuality = (int) parser.getLong( 449 ConfigConstants.KEY_ICON_QUALITY, 450 DEFAULT_ICON_PERSIST_QUALITY); 451 452 return result; 453 } 454 455 @VisibleForTesting 456 String injectShortcutManagerConstants() { 457 return android.provider.Settings.Global.getString( 458 mContext.getContentResolver(), 459 android.provider.Settings.Global.SHORTCUT_MANAGER_CONSTANTS); 460 } 461 462 @VisibleForTesting 463 int injectDipToPixel(int dip) { 464 return (int) TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, dip, 465 mContext.getResources().getDisplayMetrics()); 466 } 467 468 // === Persisting === 469 470 @Nullable 471 static String parseStringAttribute(XmlPullParser parser, String attribute) { 472 return parser.getAttributeValue(null, attribute); 473 } 474 475 static boolean parseBooleanAttribute(XmlPullParser parser, String attribute) { 476 return parseLongAttribute(parser, attribute) == 1; 477 } 478 479 static int parseIntAttribute(XmlPullParser parser, String attribute) { 480 return (int) parseLongAttribute(parser, attribute); 481 } 482 483 static int parseIntAttribute(XmlPullParser parser, String attribute, int def) { 484 return (int) parseLongAttribute(parser, attribute, def); 485 } 486 487 static long parseLongAttribute(XmlPullParser parser, String attribute) { 488 return parseLongAttribute(parser, attribute, 0); 489 } 490 491 static long parseLongAttribute(XmlPullParser parser, String attribute, long def) { 492 final String value = parseStringAttribute(parser, attribute); 493 if (TextUtils.isEmpty(value)) { 494 return def; 495 } 496 try { 497 return Long.parseLong(value); 498 } catch (NumberFormatException e) { 499 Slog.e(TAG, "Error parsing long " + value); 500 return def; 501 } 502 } 503 504 @Nullable 505 static ComponentName parseComponentNameAttribute(XmlPullParser parser, String attribute) { 506 final String value = parseStringAttribute(parser, attribute); 507 if (TextUtils.isEmpty(value)) { 508 return null; 509 } 510 return ComponentName.unflattenFromString(value); 511 } 512 513 @Nullable 514 static Intent parseIntentAttribute(XmlPullParser parser, String attribute) { 515 final String value = parseStringAttribute(parser, attribute); 516 if (TextUtils.isEmpty(value)) { 517 return null; 518 } 519 try { 520 return Intent.parseUri(value, /* flags =*/ 0); 521 } catch (URISyntaxException e) { 522 Slog.e(TAG, "Error parsing intent", e); 523 return null; 524 } 525 } 526 527 static void writeTagValue(XmlSerializer out, String tag, String value) throws IOException { 528 if (TextUtils.isEmpty(value)) return; 529 530 out.startTag(null, tag); 531 out.attribute(null, ATTR_VALUE, value); 532 out.endTag(null, tag); 533 } 534 535 static void writeTagValue(XmlSerializer out, String tag, long value) throws IOException { 536 writeTagValue(out, tag, Long.toString(value)); 537 } 538 539 static void writeTagValue(XmlSerializer out, String tag, ComponentName name) throws IOException { 540 if (name == null) return; 541 writeTagValue(out, tag, name.flattenToString()); 542 } 543 544 static void writeTagExtra(XmlSerializer out, String tag, PersistableBundle bundle) 545 throws IOException, XmlPullParserException { 546 if (bundle == null) return; 547 548 out.startTag(null, tag); 549 bundle.saveToXml(out); 550 out.endTag(null, tag); 551 } 552 553 static void writeAttr(XmlSerializer out, String name, String value) throws IOException { 554 if (TextUtils.isEmpty(value)) return; 555 556 out.attribute(null, name, value); 557 } 558 559 static void writeAttr(XmlSerializer out, String name, long value) throws IOException { 560 writeAttr(out, name, String.valueOf(value)); 561 } 562 563 static void writeAttr(XmlSerializer out, String name, boolean value) throws IOException { 564 if (value) { 565 writeAttr(out, name, "1"); 566 } 567 } 568 569 static void writeAttr(XmlSerializer out, String name, ComponentName comp) throws IOException { 570 if (comp == null) return; 571 writeAttr(out, name, comp.flattenToString()); 572 } 573 574 static void writeAttr(XmlSerializer out, String name, Intent intent) throws IOException { 575 if (intent == null) return; 576 577 writeAttr(out, name, intent.toUri(/* flags =*/ 0)); 578 } 579 580 @VisibleForTesting 581 void saveBaseStateLocked() { 582 final AtomicFile file = getBaseStateFile(); 583 if (DEBUG) { 584 Slog.d(TAG, "Saving to " + file.getBaseFile()); 585 } 586 587 FileOutputStream outs = null; 588 try { 589 outs = file.startWrite(); 590 591 // Write to XML 592 XmlSerializer out = new FastXmlSerializer(); 593 out.setOutput(outs, StandardCharsets.UTF_8.name()); 594 out.startDocument(null, true); 595 out.startTag(null, TAG_ROOT); 596 597 // Body. 598 writeTagValue(out, TAG_LAST_RESET_TIME, mRawLastResetTime); 599 600 // Epilogue. 601 out.endTag(null, TAG_ROOT); 602 out.endDocument(); 603 604 // Close. 605 file.finishWrite(outs); 606 } catch (IOException e) { 607 Slog.e(TAG, "Failed to write to file " + file.getBaseFile(), e); 608 file.failWrite(outs); 609 } 610 } 611 612 private void loadBaseStateLocked() { 613 mRawLastResetTime = 0; 614 615 final AtomicFile file = getBaseStateFile(); 616 if (DEBUG) { 617 Slog.d(TAG, "Loading from " + file.getBaseFile()); 618 } 619 try (FileInputStream in = file.openRead()) { 620 XmlPullParser parser = Xml.newPullParser(); 621 parser.setInput(in, StandardCharsets.UTF_8.name()); 622 623 int type; 624 while ((type = parser.next()) != XmlPullParser.END_DOCUMENT) { 625 if (type != XmlPullParser.START_TAG) { 626 continue; 627 } 628 final int depth = parser.getDepth(); 629 // Check the root tag 630 final String tag = parser.getName(); 631 if (depth == 1) { 632 if (!TAG_ROOT.equals(tag)) { 633 Slog.e(TAG, "Invalid root tag: " + tag); 634 return; 635 } 636 continue; 637 } 638 // Assume depth == 2 639 switch (tag) { 640 case TAG_LAST_RESET_TIME: 641 mRawLastResetTime = parseLongAttribute(parser, ATTR_VALUE); 642 break; 643 default: 644 Slog.e(TAG, "Invalid tag: " + tag); 645 break; 646 } 647 } 648 } catch (FileNotFoundException e) { 649 // Use the default 650 } catch (IOException|XmlPullParserException e) { 651 Slog.e(TAG, "Failed to read file " + file.getBaseFile(), e); 652 653 mRawLastResetTime = 0; 654 } 655 // Adjust the last reset time. 656 getLastResetTimeLocked(); 657 } 658 659 private void saveUserLocked(@UserIdInt int userId) { 660 final File path = new File(injectUserDataPath(userId), FILENAME_USER_PACKAGES); 661 if (DEBUG) { 662 Slog.d(TAG, "Saving to " + path); 663 } 664 path.mkdirs(); 665 final AtomicFile file = new AtomicFile(path); 666 FileOutputStream os = null; 667 try { 668 os = file.startWrite(); 669 670 saveUserInternalLocked(userId, os, /* forBackup= */ false); 671 672 file.finishWrite(os); 673 } catch (XmlPullParserException|IOException e) { 674 Slog.e(TAG, "Failed to write to file " + file.getBaseFile(), e); 675 file.failWrite(os); 676 } 677 } 678 679 private void saveUserInternalLocked(@UserIdInt int userId, OutputStream os, 680 boolean forBackup) throws IOException, XmlPullParserException { 681 682 final BufferedOutputStream bos = new BufferedOutputStream(os); 683 684 // Write to XML 685 XmlSerializer out = new FastXmlSerializer(); 686 out.setOutput(bos, StandardCharsets.UTF_8.name()); 687 out.startDocument(null, true); 688 689 getUserShortcutsLocked(userId).saveToXml(this, out, forBackup); 690 691 out.endDocument(); 692 693 bos.flush(); 694 os.flush(); 695 } 696 697 static IOException throwForInvalidTag(int depth, String tag) throws IOException { 698 throw new IOException(String.format("Invalid tag '%s' found at depth %d", tag, depth)); 699 } 700 701 static void warnForInvalidTag(int depth, String tag) throws IOException { 702 Slog.w(TAG, String.format("Invalid tag '%s' found at depth %d", tag, depth)); 703 } 704 705 @Nullable 706 private ShortcutUser loadUserLocked(@UserIdInt int userId) { 707 final File path = new File(injectUserDataPath(userId), FILENAME_USER_PACKAGES); 708 if (DEBUG) { 709 Slog.d(TAG, "Loading from " + path); 710 } 711 final AtomicFile file = new AtomicFile(path); 712 713 final FileInputStream in; 714 try { 715 in = file.openRead(); 716 } catch (FileNotFoundException e) { 717 if (DEBUG) { 718 Slog.d(TAG, "Not found " + path); 719 } 720 return null; 721 } 722 try { 723 return loadUserInternal(userId, in, /* forBackup= */ false); 724 } catch (IOException|XmlPullParserException e) { 725 Slog.e(TAG, "Failed to read file " + file.getBaseFile(), e); 726 return null; 727 } finally { 728 IoUtils.closeQuietly(in); 729 } 730 } 731 732 private ShortcutUser loadUserInternal(@UserIdInt int userId, InputStream is, 733 boolean fromBackup) throws XmlPullParserException, IOException { 734 735 final BufferedInputStream bis = new BufferedInputStream(is); 736 737 ShortcutUser ret = null; 738 XmlPullParser parser = Xml.newPullParser(); 739 parser.setInput(bis, StandardCharsets.UTF_8.name()); 740 741 int type; 742 while ((type = parser.next()) != XmlPullParser.END_DOCUMENT) { 743 if (type != XmlPullParser.START_TAG) { 744 continue; 745 } 746 final int depth = parser.getDepth(); 747 748 final String tag = parser.getName(); 749 if (DEBUG_LOAD) { 750 Slog.d(TAG, String.format("depth=%d type=%d name=%s", 751 depth, type, tag)); 752 } 753 if ((depth == 1) && ShortcutUser.TAG_ROOT.equals(tag)) { 754 ret = ShortcutUser.loadFromXml(this, parser, userId, fromBackup); 755 continue; 756 } 757 throwForInvalidTag(depth, tag); 758 } 759 return ret; 760 } 761 762 private void scheduleSaveBaseState() { 763 scheduleSaveInner(UserHandle.USER_NULL); // Special case -- use USER_NULL for base state. 764 } 765 766 void scheduleSaveUser(@UserIdInt int userId) { 767 scheduleSaveInner(userId); 768 } 769 770 // In order to re-schedule, we need to reuse the same instance, so keep it in final. 771 private final Runnable mSaveDirtyInfoRunner = this::saveDirtyInfo; 772 773 private void scheduleSaveInner(@UserIdInt int userId) { 774 if (DEBUG) { 775 Slog.d(TAG, "Scheduling to save for " + userId); 776 } 777 synchronized (mLock) { 778 if (!mDirtyUserIds.contains(userId)) { 779 mDirtyUserIds.add(userId); 780 } 781 } 782 // If already scheduled, remove that and re-schedule in N seconds. 783 mHandler.removeCallbacks(mSaveDirtyInfoRunner); 784 mHandler.postDelayed(mSaveDirtyInfoRunner, mSaveDelayMillis); 785 } 786 787 @VisibleForTesting 788 void saveDirtyInfo() { 789 if (DEBUG) { 790 Slog.d(TAG, "saveDirtyInfo"); 791 } 792 synchronized (mLock) { 793 for (int i = mDirtyUserIds.size() - 1; i >= 0; i--) { 794 final int userId = mDirtyUserIds.get(i); 795 if (userId == UserHandle.USER_NULL) { // USER_NULL for base state. 796 saveBaseStateLocked(); 797 } else { 798 saveUserLocked(userId); 799 } 800 } 801 mDirtyUserIds.clear(); 802 } 803 } 804 805 /** Return the last reset time. */ 806 long getLastResetTimeLocked() { 807 updateTimesLocked(); 808 return mRawLastResetTime; 809 } 810 811 /** Return the next reset time. */ 812 long getNextResetTimeLocked() { 813 updateTimesLocked(); 814 return mRawLastResetTime + mResetInterval; 815 } 816 817 static boolean isClockValid(long time) { 818 return time >= 1420070400; // Thu, 01 Jan 2015 00:00:00 GMT 819 } 820 821 /** 822 * Update the last reset time. 823 */ 824 private void updateTimesLocked() { 825 826 final long now = injectCurrentTimeMillis(); 827 828 final long prevLastResetTime = mRawLastResetTime; 829 830 if (mRawLastResetTime == 0) { // first launch. 831 // TODO Randomize?? 832 mRawLastResetTime = now; 833 } else if (now < mRawLastResetTime) { 834 // Clock rewound. 835 if (isClockValid(now)) { 836 Slog.w(TAG, "Clock rewound"); 837 // TODO Randomize?? 838 mRawLastResetTime = now; 839 } 840 } else { 841 if ((mRawLastResetTime + mResetInterval) <= now) { 842 final long offset = mRawLastResetTime % mResetInterval; 843 mRawLastResetTime = ((now / mResetInterval) * mResetInterval) + offset; 844 } 845 } 846 if (prevLastResetTime != mRawLastResetTime) { 847 scheduleSaveBaseState(); 848 } 849 } 850 851 @GuardedBy("mLock") 852 @NonNull 853 private boolean isUserLoadedLocked(@UserIdInt int userId) { 854 return mUsers.get(userId) != null; 855 } 856 857 /** Return the per-user state. */ 858 @GuardedBy("mLock") 859 @NonNull 860 ShortcutUser getUserShortcutsLocked(@UserIdInt int userId) { 861 ShortcutUser userPackages = mUsers.get(userId); 862 if (userPackages == null) { 863 userPackages = loadUserLocked(userId); 864 if (userPackages == null) { 865 userPackages = new ShortcutUser(userId); 866 } 867 mUsers.put(userId, userPackages); 868 } 869 return userPackages; 870 } 871 872 void forEachLoadedUserLocked(@NonNull Consumer<ShortcutUser> c) { 873 for (int i = mUsers.size() - 1; i >= 0; i--) { 874 c.accept(mUsers.valueAt(i)); 875 } 876 } 877 878 /** Return the per-user per-package state. */ 879 @GuardedBy("mLock") 880 @NonNull 881 ShortcutPackage getPackageShortcutsLocked( 882 @NonNull String packageName, @UserIdInt int userId) { 883 return getUserShortcutsLocked(userId).getPackageShortcuts(this, packageName); 884 } 885 886 @GuardedBy("mLock") 887 @NonNull 888 ShortcutLauncher getLauncherShortcutsLocked( 889 @NonNull String packageName, @UserIdInt int ownerUserId, 890 @UserIdInt int launcherUserId) { 891 return getUserShortcutsLocked(ownerUserId) 892 .getLauncherShortcuts(this, packageName, launcherUserId); 893 } 894 895 // === Caller validation === 896 897 void removeIcon(@UserIdInt int userId, ShortcutInfo shortcut) { 898 if (shortcut.getBitmapPath() != null) { 899 if (DEBUG) { 900 Slog.d(TAG, "Removing " + shortcut.getBitmapPath()); 901 } 902 new File(shortcut.getBitmapPath()).delete(); 903 904 shortcut.setBitmapPath(null); 905 shortcut.setIconResourceId(0); 906 shortcut.clearFlags(ShortcutInfo.FLAG_HAS_ICON_FILE | ShortcutInfo.FLAG_HAS_ICON_RES); 907 } 908 } 909 910 @VisibleForTesting 911 static class FileOutputStreamWithPath extends FileOutputStream { 912 private final File mFile; 913 914 public FileOutputStreamWithPath(File file) throws FileNotFoundException { 915 super(file); 916 mFile = file; 917 } 918 919 public File getFile() { 920 return mFile; 921 } 922 } 923 924 /** 925 * Build the cached bitmap filename for a shortcut icon. 926 * 927 * The filename will be based on the ID, except certain characters will be escaped. 928 */ 929 @VisibleForTesting 930 FileOutputStreamWithPath openIconFileForWrite(@UserIdInt int userId, ShortcutInfo shortcut) 931 throws IOException { 932 final File packagePath = new File(getUserBitmapFilePath(userId), 933 shortcut.getPackageName()); 934 if (!packagePath.isDirectory()) { 935 packagePath.mkdirs(); 936 if (!packagePath.isDirectory()) { 937 throw new IOException("Unable to create directory " + packagePath); 938 } 939 SELinux.restorecon(packagePath); 940 } 941 942 final String baseName = String.valueOf(injectCurrentTimeMillis()); 943 for (int suffix = 0;; suffix++) { 944 final String filename = (suffix == 0 ? baseName : baseName + "_" + suffix) + ".png"; 945 final File file = new File(packagePath, filename); 946 if (!file.exists()) { 947 if (DEBUG) { 948 Slog.d(TAG, "Saving icon to " + file.getAbsolutePath()); 949 } 950 return new FileOutputStreamWithPath(file); 951 } 952 } 953 } 954 955 void saveIconAndFixUpShortcut(@UserIdInt int userId, ShortcutInfo shortcut) { 956 if (shortcut.hasIconFile() || shortcut.hasIconResource()) { 957 return; 958 } 959 960 final long token = injectClearCallingIdentity(); 961 try { 962 // Clear icon info on the shortcut. 963 shortcut.setIconResourceId(0); 964 shortcut.setBitmapPath(null); 965 966 final Icon icon = shortcut.getIcon(); 967 if (icon == null) { 968 return; // has no icon 969 } 970 971 Bitmap bitmap; 972 Bitmap bitmapToRecycle = null; 973 try { 974 switch (icon.getType()) { 975 case Icon.TYPE_RESOURCE: { 976 injectValidateIconResPackage(shortcut, icon); 977 978 shortcut.setIconResourceId(icon.getResId()); 979 shortcut.addFlags(ShortcutInfo.FLAG_HAS_ICON_RES); 980 return; 981 } 982 case Icon.TYPE_BITMAP: { 983 bitmap = icon.getBitmap(); // Don't recycle in this case. 984 break; 985 } 986 case Icon.TYPE_URI: { 987 final Uri uri = ContentProvider.maybeAddUserId(icon.getUri(), userId); 988 989 try (InputStream is = mContext.getContentResolver().openInputStream(uri)) { 990 991 bitmapToRecycle = BitmapFactory.decodeStream(is); 992 bitmap = bitmapToRecycle; 993 994 } catch (IOException e) { 995 Slog.e(TAG, "Unable to load icon from " + uri); 996 return; 997 } 998 break; 999 } 1000 default: 1001 // This shouldn't happen because we've already validated the icon, but 1002 // just in case. 1003 throw ShortcutInfo.getInvalidIconException(); 1004 } 1005 if (bitmap == null) { 1006 Slog.e(TAG, "Null bitmap detected"); 1007 return; 1008 } 1009 // Shrink and write to the file. 1010 File path = null; 1011 try { 1012 final FileOutputStreamWithPath out = openIconFileForWrite(userId, shortcut); 1013 try { 1014 path = out.getFile(); 1015 1016 Bitmap shrunk = shrinkBitmap(bitmap, mMaxIconDimension); 1017 try { 1018 shrunk.compress(mIconPersistFormat, mIconPersistQuality, out); 1019 } finally { 1020 if (bitmap != shrunk) { 1021 shrunk.recycle(); 1022 } 1023 } 1024 1025 shortcut.setBitmapPath(out.getFile().getAbsolutePath()); 1026 shortcut.addFlags(ShortcutInfo.FLAG_HAS_ICON_FILE); 1027 } finally { 1028 IoUtils.closeQuietly(out); 1029 } 1030 } catch (IOException|RuntimeException e) { 1031 // STOPSHIP Change wtf to e 1032 Slog.wtf(ShortcutService.TAG, "Unable to write bitmap to file", e); 1033 if (path != null && path.exists()) { 1034 path.delete(); 1035 } 1036 } 1037 } finally { 1038 if (bitmapToRecycle != null) { 1039 bitmapToRecycle.recycle(); 1040 } 1041 // Once saved, we won't use the original icon information, so null it out. 1042 shortcut.clearIcon(); 1043 } 1044 } finally { 1045 injectRestoreCallingIdentity(token); 1046 } 1047 } 1048 1049 // Unfortunately we can't do this check in unit tests because we fake creator package names, 1050 // so override in unit tests. 1051 // TODO CTS this case. 1052 void injectValidateIconResPackage(ShortcutInfo shortcut, Icon icon) { 1053 if (!shortcut.getPackageName().equals(icon.getResPackage())) { 1054 throw new IllegalArgumentException( 1055 "Icon resource must reside in shortcut owner package"); 1056 } 1057 } 1058 1059 @VisibleForTesting 1060 static Bitmap shrinkBitmap(Bitmap in, int maxSize) { 1061 // Original width/height. 1062 final int ow = in.getWidth(); 1063 final int oh = in.getHeight(); 1064 if ((ow <= maxSize) && (oh <= maxSize)) { 1065 if (DEBUG) { 1066 Slog.d(TAG, String.format("Icon size %dx%d, no need to shrink", ow, oh)); 1067 } 1068 return in; 1069 } 1070 final int longerDimension = Math.max(ow, oh); 1071 1072 // New width and height. 1073 final int nw = ow * maxSize / longerDimension; 1074 final int nh = oh * maxSize / longerDimension; 1075 if (DEBUG) { 1076 Slog.d(TAG, String.format("Icon size %dx%d, shrinking to %dx%d", 1077 ow, oh, nw, nh)); 1078 } 1079 1080 final Bitmap scaledBitmap = Bitmap.createBitmap(nw, nh, Bitmap.Config.ARGB_8888); 1081 final Canvas c = new Canvas(scaledBitmap); 1082 1083 final RectF dst = new RectF(0, 0, nw, nh); 1084 1085 c.drawBitmap(in, /*src=*/ null, dst, /* paint =*/ null); 1086 1087 return scaledBitmap; 1088 } 1089 1090 // === Caller validation === 1091 1092 private boolean isCallerSystem() { 1093 final int callingUid = injectBinderCallingUid(); 1094 return UserHandle.isSameApp(callingUid, Process.SYSTEM_UID); 1095 } 1096 1097 private boolean isCallerShell() { 1098 final int callingUid = injectBinderCallingUid(); 1099 return callingUid == Process.SHELL_UID || callingUid == Process.ROOT_UID; 1100 } 1101 1102 private void enforceSystemOrShell() { 1103 Preconditions.checkState(isCallerSystem() || isCallerShell(), 1104 "Caller must be system or shell"); 1105 } 1106 1107 private void enforceShell() { 1108 Preconditions.checkState(isCallerShell(), "Caller must be shell"); 1109 } 1110 1111 private void enforceSystem() { 1112 Preconditions.checkState(isCallerSystem(), "Caller must be system"); 1113 } 1114 1115 private void verifyCaller(@NonNull String packageName, @UserIdInt int userId) { 1116 Preconditions.checkStringNotEmpty(packageName, "packageName"); 1117 1118 if (isCallerSystem()) { 1119 return; // no check 1120 } 1121 1122 final int callingUid = injectBinderCallingUid(); 1123 1124 // Otherwise, make sure the arguments are valid. 1125 if (UserHandle.getUserId(callingUid) != userId) { 1126 throw new SecurityException("Invalid user-ID"); 1127 } 1128 if (injectGetPackageUid(packageName, userId) == injectBinderCallingUid()) { 1129 return; // Caller is valid. 1130 } 1131 throw new SecurityException("Calling package name mismatch"); 1132 } 1133 1134 void postToHandler(Runnable r) { 1135 mHandler.post(r); 1136 } 1137 1138 /** 1139 * Throw if {@code numShortcuts} is bigger than {@link #mMaxDynamicShortcuts}. 1140 */ 1141 void enforceMaxDynamicShortcuts(int numShortcuts) { 1142 if (numShortcuts > mMaxDynamicShortcuts) { 1143 throw new IllegalArgumentException("Max number of dynamic shortcuts exceeded"); 1144 } 1145 } 1146 1147 /** 1148 * - Sends a notification to LauncherApps 1149 * - Write to file 1150 */ 1151 private void userPackageChanged(@NonNull String packageName, @UserIdInt int userId) { 1152 notifyListeners(packageName, userId); 1153 scheduleSaveUser(userId); 1154 } 1155 1156 private void notifyListeners(@NonNull String packageName, @UserIdInt int userId) { 1157 if (!mUserManager.isUserRunning(userId)) { 1158 return; 1159 } 1160 postToHandler(() -> { 1161 final ArrayList<ShortcutChangeListener> copy; 1162 synchronized (mLock) { 1163 copy = new ArrayList<>(mListeners); 1164 } 1165 // Note onShortcutChanged() needs to be called with the system service permissions. 1166 for (int i = copy.size() - 1; i >= 0; i--) { 1167 copy.get(i).onShortcutChanged(packageName, userId); 1168 } 1169 }); 1170 } 1171 1172 /** 1173 * Clean up / validate an incoming shortcut. 1174 * - Make sure all mandatory fields are set. 1175 * - Make sure the intent's extras are persistable, and them to set 1176 * {@link ShortcutInfo#mIntentPersistableExtras}. Also clear its extras. 1177 * - Clear flags. 1178 * 1179 * TODO Detailed unit tests 1180 */ 1181 private void fixUpIncomingShortcutInfo(@NonNull ShortcutInfo shortcut, boolean forUpdate) { 1182 Preconditions.checkNotNull(shortcut, "Null shortcut detected"); 1183 if (shortcut.getActivityComponent() != null) { 1184 Preconditions.checkState( 1185 shortcut.getPackageName().equals( 1186 shortcut.getActivityComponent().getPackageName()), 1187 "Activity package name mismatch"); 1188 } 1189 1190 if (!forUpdate) { 1191 shortcut.enforceMandatoryFields(); 1192 } 1193 if (shortcut.getIcon() != null) { 1194 ShortcutInfo.validateIcon(shortcut.getIcon()); 1195 } 1196 1197 validateForXml(shortcut.getId()); 1198 validateForXml(shortcut.getTitle()); 1199 validatePersistableBundleForXml(shortcut.getIntentPersistableExtras()); 1200 validatePersistableBundleForXml(shortcut.getExtras()); 1201 1202 shortcut.replaceFlags(0); 1203 } 1204 1205 // KXmlSerializer is strict and doesn't allow certain characters, so we disallow those 1206 // characters. 1207 1208 private static void validatePersistableBundleForXml(PersistableBundle b) { 1209 if (b == null || b.size() == 0) { 1210 return; 1211 } 1212 for (String key : b.keySet()) { 1213 validateForXml(key); 1214 final Object value = b.get(key); 1215 if (value == null) { 1216 continue; 1217 } else if (value instanceof String) { 1218 validateForXml((String) value); 1219 } else if (value instanceof String[]) { 1220 for (String v : (String[]) value) { 1221 validateForXml(v); 1222 } 1223 } else if (value instanceof PersistableBundle) { 1224 validatePersistableBundleForXml((PersistableBundle) value); 1225 } 1226 } 1227 } 1228 1229 private static void validateForXml(String s) { 1230 if (TextUtils.isEmpty(s)) { 1231 return; 1232 } 1233 for (int i = s.length() - 1; i >= 0; i--) { 1234 if (!isAllowedInXml(s.charAt(i))) { 1235 throw new IllegalArgumentException("Unsupported character detected in: " + s); 1236 } 1237 } 1238 } 1239 1240 private static boolean isAllowedInXml(char c) { 1241 return (c >= 0x20 && c <= 0xd7ff) || (c >= 0xe000 && c <= 0xfffd); 1242 } 1243 1244 // === APIs === 1245 1246 @Override 1247 public boolean setDynamicShortcuts(String packageName, ParceledListSlice shortcutInfoList, 1248 @UserIdInt int userId) { 1249 verifyCaller(packageName, userId); 1250 1251 final List<ShortcutInfo> newShortcuts = (List<ShortcutInfo>) shortcutInfoList.getList(); 1252 final int size = newShortcuts.size(); 1253 1254 synchronized (mLock) { 1255 final ShortcutPackage ps = getPackageShortcutsLocked(packageName, userId); 1256 1257 // Throttling. 1258 if (!ps.tryApiCall(this)) { 1259 return false; 1260 } 1261 enforceMaxDynamicShortcuts(size); 1262 1263 // Validate the shortcuts. 1264 for (int i = 0; i < size; i++) { 1265 fixUpIncomingShortcutInfo(newShortcuts.get(i), /* forUpdate= */ false); 1266 } 1267 1268 // First, remove all un-pinned; dynamic shortcuts 1269 ps.deleteAllDynamicShortcuts(this); 1270 1271 // Then, add/update all. We need to make sure to take over "pinned" flag. 1272 for (int i = 0; i < size; i++) { 1273 final ShortcutInfo newShortcut = newShortcuts.get(i); 1274 ps.addDynamicShortcut(this, newShortcut); 1275 } 1276 } 1277 userPackageChanged(packageName, userId); 1278 return true; 1279 } 1280 1281 @Override 1282 public boolean updateShortcuts(String packageName, ParceledListSlice shortcutInfoList, 1283 @UserIdInt int userId) { 1284 verifyCaller(packageName, userId); 1285 1286 final List<ShortcutInfo> newShortcuts = (List<ShortcutInfo>) shortcutInfoList.getList(); 1287 final int size = newShortcuts.size(); 1288 1289 synchronized (mLock) { 1290 final ShortcutPackage ps = getPackageShortcutsLocked(packageName, userId); 1291 1292 // Throttling. 1293 if (!ps.tryApiCall(this)) { 1294 return false; 1295 } 1296 1297 for (int i = 0; i < size; i++) { 1298 final ShortcutInfo source = newShortcuts.get(i); 1299 fixUpIncomingShortcutInfo(source, /* forUpdate= */ true); 1300 1301 final ShortcutInfo target = ps.findShortcutById(source.getId()); 1302 if (target != null) { 1303 final boolean replacingIcon = (source.getIcon() != null); 1304 if (replacingIcon) { 1305 removeIcon(userId, target); 1306 } 1307 1308 target.copyNonNullFieldsFrom(source); 1309 1310 if (replacingIcon) { 1311 saveIconAndFixUpShortcut(userId, target); 1312 } 1313 } 1314 } 1315 } 1316 userPackageChanged(packageName, userId); 1317 1318 return true; 1319 } 1320 1321 @Override 1322 public boolean addDynamicShortcuts(String packageName, ParceledListSlice shortcutInfoList, 1323 @UserIdInt int userId) { 1324 verifyCaller(packageName, userId); 1325 1326 final List<ShortcutInfo> newShortcuts = (List<ShortcutInfo>) shortcutInfoList.getList(); 1327 final int size = newShortcuts.size(); 1328 1329 synchronized (mLock) { 1330 final ShortcutPackage ps = getPackageShortcutsLocked(packageName, userId); 1331 1332 // Throttling. 1333 if (!ps.tryApiCall(this)) { 1334 return false; 1335 } 1336 for (int i = 0; i < size; i++) { 1337 final ShortcutInfo newShortcut = newShortcuts.get(i); 1338 1339 // Validate the shortcut. 1340 fixUpIncomingShortcutInfo(newShortcut, /* forUpdate= */ false); 1341 1342 // Add it. 1343 ps.addDynamicShortcut(this, newShortcut); 1344 } 1345 } 1346 userPackageChanged(packageName, userId); 1347 1348 return true; 1349 } 1350 1351 @Override 1352 public void removeDynamicShortcuts(String packageName, List shortcutIds, 1353 @UserIdInt int userId) { 1354 verifyCaller(packageName, userId); 1355 Preconditions.checkNotNull(shortcutIds, "shortcutIds must be provided"); 1356 1357 synchronized (mLock) { 1358 for (int i = shortcutIds.size() - 1; i >= 0; i--) { 1359 getPackageShortcutsLocked(packageName, userId).deleteDynamicWithId(this, 1360 Preconditions.checkStringNotEmpty((String) shortcutIds.get(i))); 1361 } 1362 } 1363 userPackageChanged(packageName, userId); 1364 } 1365 1366 @Override 1367 public void removeAllDynamicShortcuts(String packageName, @UserIdInt int userId) { 1368 verifyCaller(packageName, userId); 1369 1370 synchronized (mLock) { 1371 getPackageShortcutsLocked(packageName, userId).deleteAllDynamicShortcuts(this); 1372 } 1373 userPackageChanged(packageName, userId); 1374 } 1375 1376 @Override 1377 public ParceledListSlice<ShortcutInfo> getDynamicShortcuts(String packageName, 1378 @UserIdInt int userId) { 1379 verifyCaller(packageName, userId); 1380 synchronized (mLock) { 1381 return getShortcutsWithQueryLocked( 1382 packageName, userId, ShortcutInfo.CLONE_REMOVE_FOR_CREATOR, 1383 ShortcutInfo::isDynamic); 1384 } 1385 } 1386 1387 @Override 1388 public ParceledListSlice<ShortcutInfo> getPinnedShortcuts(String packageName, 1389 @UserIdInt int userId) { 1390 verifyCaller(packageName, userId); 1391 synchronized (mLock) { 1392 return getShortcutsWithQueryLocked( 1393 packageName, userId, ShortcutInfo.CLONE_REMOVE_FOR_CREATOR, 1394 ShortcutInfo::isPinned); 1395 } 1396 } 1397 1398 private ParceledListSlice<ShortcutInfo> getShortcutsWithQueryLocked(@NonNull String packageName, 1399 @UserIdInt int userId, int cloneFlags, @NonNull Predicate<ShortcutInfo> query) { 1400 1401 final ArrayList<ShortcutInfo> ret = new ArrayList<>(); 1402 1403 getPackageShortcutsLocked(packageName, userId).findAll(this, ret, query, cloneFlags); 1404 1405 return new ParceledListSlice<>(ret); 1406 } 1407 1408 @Override 1409 public int getMaxDynamicShortcutCount(String packageName, @UserIdInt int userId) 1410 throws RemoteException { 1411 verifyCaller(packageName, userId); 1412 1413 return mMaxDynamicShortcuts; 1414 } 1415 1416 @Override 1417 public int getRemainingCallCount(String packageName, @UserIdInt int userId) { 1418 verifyCaller(packageName, userId); 1419 1420 synchronized (mLock) { 1421 return mMaxUpdatesPerInterval 1422 - getPackageShortcutsLocked(packageName, userId).getApiCallCount(this); 1423 } 1424 } 1425 1426 @Override 1427 public long getRateLimitResetTime(String packageName, @UserIdInt int userId) { 1428 verifyCaller(packageName, userId); 1429 1430 synchronized (mLock) { 1431 return getNextResetTimeLocked(); 1432 } 1433 } 1434 1435 @Override 1436 public int getIconMaxDimensions(String packageName, int userId) throws RemoteException { 1437 verifyCaller(packageName, userId); 1438 1439 synchronized (mLock) { 1440 return mMaxIconDimension; 1441 } 1442 } 1443 1444 /** 1445 * Reset all throttling, for developer options and command line. Only system/shell can call it. 1446 */ 1447 @Override 1448 public void resetThrottling() { 1449 enforceSystemOrShell(); 1450 1451 resetThrottlingInner(getCallingUserId()); 1452 } 1453 1454 void resetThrottlingInner(@UserIdInt int userId) { 1455 synchronized (mLock) { 1456 getUserShortcutsLocked(userId).resetThrottling(); 1457 } 1458 scheduleSaveUser(userId); 1459 Slog.i(TAG, "ShortcutManager: throttling counter reset for user " + userId); 1460 } 1461 1462 void resetAllThrottlingInner() { 1463 synchronized (mLock) { 1464 mRawLastResetTime = injectCurrentTimeMillis(); 1465 } 1466 scheduleSaveBaseState(); 1467 Slog.i(TAG, "ShortcutManager: throttling counter reset for all users"); 1468 } 1469 1470 // We override this method in unit tests to do a simpler check. 1471 boolean hasShortcutHostPermission(@NonNull String callingPackage, int userId) { 1472 return hasShortcutHostPermissionInner(callingPackage, userId); 1473 } 1474 1475 // This method is extracted so we can directly call this method from unit tests, 1476 // even when hasShortcutPermission() is overridden. 1477 @VisibleForTesting 1478 boolean hasShortcutHostPermissionInner(@NonNull String callingPackage, int userId) { 1479 synchronized (mLock) { 1480 final long start = System.currentTimeMillis(); 1481 1482 final ShortcutUser user = getUserShortcutsLocked(userId); 1483 1484 final List<ResolveInfo> allHomeCandidates = new ArrayList<>(); 1485 1486 // Default launcher from package manager. 1487 final long startGetHomeActivitiesAsUser = System.currentTimeMillis(); 1488 final ComponentName defaultLauncher = injectPackageManagerInternal() 1489 .getHomeActivitiesAsUser(allHomeCandidates, userId); 1490 logDurationStat(Stats.GET_DEFAULT_HOME, startGetHomeActivitiesAsUser); 1491 1492 ComponentName detected; 1493 if (defaultLauncher != null) { 1494 detected = defaultLauncher; 1495 if (DEBUG) { 1496 Slog.v(TAG, "Default launcher from PM: " + detected); 1497 } 1498 } else { 1499 detected = user.getLauncherComponent(); 1500 1501 // TODO: Make sure it's still enabled. 1502 if (DEBUG) { 1503 Slog.v(TAG, "Cached launcher: " + detected); 1504 } 1505 } 1506 1507 if (detected == null) { 1508 // If we reach here, that means it's the first check since the user was created, 1509 // and there's already multiple launchers and there's no default set. 1510 // Find the system one with the highest priority. 1511 // (We need to check the priority too because of FallbackHome in Settings.) 1512 // If there's no system launcher yet, then no one can access shortcuts, until 1513 // the user explicitly 1514 final int size = allHomeCandidates.size(); 1515 1516 int lastPriority = Integer.MIN_VALUE; 1517 for (int i = 0; i < size; i++) { 1518 final ResolveInfo ri = allHomeCandidates.get(i); 1519 if (!ri.activityInfo.applicationInfo.isSystemApp()) { 1520 continue; 1521 } 1522 if (DEBUG) { 1523 Slog.d(TAG, String.format("hasShortcutPermissionInner: pkg=%s prio=%d", 1524 ri.activityInfo.getComponentName(), ri.priority)); 1525 } 1526 if (ri.priority < lastPriority) { 1527 continue; 1528 } 1529 detected = ri.activityInfo.getComponentName(); 1530 lastPriority = ri.priority; 1531 } 1532 } 1533 logDurationStat(Stats.LAUNCHER_PERMISSION_CHECK, start); 1534 1535 if (detected != null) { 1536 if (DEBUG) { 1537 Slog.v(TAG, "Detected launcher: " + detected); 1538 } 1539 user.setLauncherComponent(this, detected); 1540 return detected.getPackageName().equals(callingPackage); 1541 } else { 1542 // Default launcher not found. 1543 return false; 1544 } 1545 } 1546 } 1547 1548 // === House keeping === 1549 1550 @VisibleForTesting 1551 void cleanUpPackageLocked(String packageName, int owningUserId, int packageUserId) { 1552 cleanUpPackageLocked(packageName, owningUserId, packageUserId, 1553 /* forceForCommandLine= */ false); 1554 } 1555 1556 /** 1557 * Remove all the information associated with a package. This will really remove all the 1558 * information, including the restore information (i.e. it'll remove packages even if they're 1559 * shadow). 1560 */ 1561 private void cleanUpPackageLocked(String packageName, int owningUserId, int packageUserId, 1562 boolean forceForCommandLine) { 1563 if (!forceForCommandLine && isPackageInstalled(packageName, packageUserId)) { 1564 wtf("Package " + packageName + " is still installed for user " + packageUserId); 1565 return; 1566 } 1567 1568 final boolean wasUserLoaded = isUserLoadedLocked(owningUserId); 1569 1570 final ShortcutUser mUser = getUserShortcutsLocked(owningUserId); 1571 boolean doNotify = false; 1572 1573 // First, remove the package from the package list (if the package is a publisher). 1574 if (packageUserId == owningUserId) { 1575 if (mUser.removePackage(packageName) != null) { 1576 doNotify = true; 1577 } 1578 } 1579 1580 // Also remove from the launcher list (if the package is a launcher). 1581 mUser.removeLauncher(packageUserId, packageName); 1582 1583 // Then remove pinned shortcuts from all launchers. 1584 final ArrayMap<PackageWithUser, ShortcutLauncher> launchers = mUser.getAllLaunchers(); 1585 for (int i = launchers.size() - 1; i >= 0; i--) { 1586 launchers.valueAt(i).cleanUpPackage(packageName, packageUserId); 1587 } 1588 // Now there may be orphan shortcuts because we removed pinned shortucts at the previous 1589 // step. Remove them too. 1590 for (int i = mUser.getAllPackages().size() - 1; i >= 0; i--) { 1591 mUser.getAllPackages().valueAt(i).refreshPinnedFlags(this); 1592 } 1593 1594 scheduleSaveUser(owningUserId); 1595 1596 if (doNotify) { 1597 notifyListeners(packageName, owningUserId); 1598 } 1599 1600 if (!wasUserLoaded) { 1601 // Note this will execute the scheduled save. 1602 unloadUserLocked(owningUserId); 1603 } 1604 } 1605 1606 /** 1607 * Entry point from {@link LauncherApps}. 1608 */ 1609 private class LocalService extends ShortcutServiceInternal { 1610 1611 @Override 1612 public List<ShortcutInfo> getShortcuts(int launcherUserId, 1613 @NonNull String callingPackage, long changedSince, 1614 @Nullable String packageName, @Nullable List<String> shortcutIds, 1615 @Nullable ComponentName componentName, 1616 int queryFlags, int userId) { 1617 final ArrayList<ShortcutInfo> ret = new ArrayList<>(); 1618 final int cloneFlag = 1619 ((queryFlags & ShortcutQuery.FLAG_GET_KEY_FIELDS_ONLY) == 0) 1620 ? ShortcutInfo.CLONE_REMOVE_FOR_LAUNCHER 1621 : ShortcutInfo.CLONE_REMOVE_NON_KEY_INFO; 1622 if (packageName == null) { 1623 shortcutIds = null; // LauncherAppsService already threw for it though. 1624 } 1625 1626 synchronized (mLock) { 1627 getLauncherShortcutsLocked(callingPackage, userId, launcherUserId) 1628 .attemptToRestoreIfNeededAndSave(ShortcutService.this); 1629 1630 if (packageName != null) { 1631 getShortcutsInnerLocked(launcherUserId, 1632 callingPackage, packageName, shortcutIds, changedSince, 1633 componentName, queryFlags, userId, ret, cloneFlag); 1634 } else { 1635 final ArrayMap<String, ShortcutPackage> packages = 1636 getUserShortcutsLocked(userId).getAllPackages(); 1637 for (int i = packages.size() - 1; i >= 0; i--) { 1638 getShortcutsInnerLocked(launcherUserId, 1639 callingPackage, packages.keyAt(i), shortcutIds, changedSince, 1640 componentName, queryFlags, userId, ret, cloneFlag); 1641 } 1642 } 1643 } 1644 return ret; 1645 } 1646 1647 private void getShortcutsInnerLocked(int launcherUserId, @NonNull String callingPackage, 1648 @Nullable String packageName, @Nullable List<String> shortcutIds, long changedSince, 1649 @Nullable ComponentName componentName, int queryFlags, 1650 int userId, ArrayList<ShortcutInfo> ret, int cloneFlag) { 1651 final ArraySet<String> ids = shortcutIds == null ? null 1652 : new ArraySet<>(shortcutIds); 1653 1654 getPackageShortcutsLocked(packageName, userId).findAll(ShortcutService.this, ret, 1655 (ShortcutInfo si) -> { 1656 if (si.getLastChangedTimestamp() < changedSince) { 1657 return false; 1658 } 1659 if (ids != null && !ids.contains(si.getId())) { 1660 return false; 1661 } 1662 if (componentName != null 1663 && !componentName.equals(si.getActivityComponent())) { 1664 return false; 1665 } 1666 final boolean matchDynamic = 1667 ((queryFlags & ShortcutQuery.FLAG_GET_DYNAMIC) != 0) 1668 && si.isDynamic(); 1669 final boolean matchPinned = 1670 ((queryFlags & ShortcutQuery.FLAG_GET_PINNED) != 0) 1671 && si.isPinned(); 1672 return matchDynamic || matchPinned; 1673 }, cloneFlag, callingPackage, launcherUserId); 1674 } 1675 1676 @Override 1677 public boolean isPinnedByCaller(int launcherUserId, @NonNull String callingPackage, 1678 @NonNull String packageName, @NonNull String shortcutId, int userId) { 1679 Preconditions.checkStringNotEmpty(packageName, "packageName"); 1680 Preconditions.checkStringNotEmpty(shortcutId, "shortcutId"); 1681 1682 synchronized (mLock) { 1683 getLauncherShortcutsLocked(callingPackage, userId, launcherUserId) 1684 .attemptToRestoreIfNeededAndSave(ShortcutService.this); 1685 1686 final ShortcutInfo si = getShortcutInfoLocked( 1687 launcherUserId, callingPackage, packageName, shortcutId, userId); 1688 return si != null && si.isPinned(); 1689 } 1690 } 1691 1692 private ShortcutInfo getShortcutInfoLocked( 1693 int launcherUserId, @NonNull String callingPackage, 1694 @NonNull String packageName, @NonNull String shortcutId, int userId) { 1695 Preconditions.checkStringNotEmpty(packageName, "packageName"); 1696 Preconditions.checkStringNotEmpty(shortcutId, "shortcutId"); 1697 1698 final ArrayList<ShortcutInfo> list = new ArrayList<>(1); 1699 getPackageShortcutsLocked(packageName, userId).findAll( 1700 ShortcutService.this, list, 1701 (ShortcutInfo si) -> shortcutId.equals(si.getId()), 1702 /* clone flags=*/ 0, callingPackage, launcherUserId); 1703 return list.size() == 0 ? null : list.get(0); 1704 } 1705 1706 @Override 1707 public void pinShortcuts(int launcherUserId, 1708 @NonNull String callingPackage, @NonNull String packageName, 1709 @NonNull List<String> shortcutIds, int userId) { 1710 // Calling permission must be checked by LauncherAppsImpl. 1711 Preconditions.checkStringNotEmpty(packageName, "packageName"); 1712 Preconditions.checkNotNull(shortcutIds, "shortcutIds"); 1713 1714 synchronized (mLock) { 1715 final ShortcutLauncher launcher = 1716 getLauncherShortcutsLocked(callingPackage, userId, launcherUserId); 1717 launcher.attemptToRestoreIfNeededAndSave(ShortcutService.this); 1718 1719 launcher.pinShortcuts( 1720 ShortcutService.this, userId, packageName, shortcutIds); 1721 } 1722 userPackageChanged(packageName, userId); 1723 } 1724 1725 @Override 1726 public Intent createShortcutIntent(int launcherUserId, 1727 @NonNull String callingPackage, 1728 @NonNull String packageName, @NonNull String shortcutId, int userId) { 1729 // Calling permission must be checked by LauncherAppsImpl. 1730 Preconditions.checkStringNotEmpty(packageName, "packageName can't be empty"); 1731 Preconditions.checkStringNotEmpty(shortcutId, "shortcutId can't be empty"); 1732 1733 synchronized (mLock) { 1734 getLauncherShortcutsLocked(callingPackage, userId, launcherUserId) 1735 .attemptToRestoreIfNeededAndSave(ShortcutService.this); 1736 1737 // Make sure the shortcut is actually visible to the launcher. 1738 final ShortcutInfo si = getShortcutInfoLocked( 1739 launcherUserId, callingPackage, packageName, shortcutId, userId); 1740 // "si == null" should suffice here, but check the flags too just to make sure. 1741 if (si == null || !(si.isDynamic() || si.isPinned())) { 1742 return null; 1743 } 1744 return si.getIntent(); 1745 } 1746 } 1747 1748 @Override 1749 public void addListener(@NonNull ShortcutChangeListener listener) { 1750 synchronized (mLock) { 1751 mListeners.add(Preconditions.checkNotNull(listener)); 1752 } 1753 } 1754 1755 @Override 1756 public int getShortcutIconResId(int launcherUserId, @NonNull String callingPackage, 1757 @NonNull String packageName, @NonNull String shortcutId, int userId) { 1758 Preconditions.checkNotNull(callingPackage, "callingPackage"); 1759 Preconditions.checkNotNull(packageName, "packageName"); 1760 Preconditions.checkNotNull(shortcutId, "shortcutId"); 1761 1762 synchronized (mLock) { 1763 getLauncherShortcutsLocked(callingPackage, userId, launcherUserId) 1764 .attemptToRestoreIfNeededAndSave(ShortcutService.this); 1765 1766 final ShortcutInfo shortcutInfo = getPackageShortcutsLocked( 1767 packageName, userId).findShortcutById(shortcutId); 1768 return (shortcutInfo != null && shortcutInfo.hasIconResource()) 1769 ? shortcutInfo.getIconResourceId() : 0; 1770 } 1771 } 1772 1773 @Override 1774 public ParcelFileDescriptor getShortcutIconFd(int launcherUserId, 1775 @NonNull String callingPackage, @NonNull String packageName, 1776 @NonNull String shortcutId, int userId) { 1777 Preconditions.checkNotNull(callingPackage, "callingPackage"); 1778 Preconditions.checkNotNull(packageName, "packageName"); 1779 Preconditions.checkNotNull(shortcutId, "shortcutId"); 1780 1781 synchronized (mLock) { 1782 getLauncherShortcutsLocked(callingPackage, userId, launcherUserId) 1783 .attemptToRestoreIfNeededAndSave(ShortcutService.this); 1784 1785 final ShortcutInfo shortcutInfo = getPackageShortcutsLocked( 1786 packageName, userId).findShortcutById(shortcutId); 1787 if (shortcutInfo == null || !shortcutInfo.hasIconFile()) { 1788 return null; 1789 } 1790 try { 1791 if (shortcutInfo.getBitmapPath() == null) { 1792 Slog.w(TAG, "null bitmap detected in getShortcutIconFd()"); 1793 return null; 1794 } 1795 return ParcelFileDescriptor.open( 1796 new File(shortcutInfo.getBitmapPath()), 1797 ParcelFileDescriptor.MODE_READ_ONLY); 1798 } catch (FileNotFoundException e) { 1799 Slog.e(TAG, "Icon file not found: " + shortcutInfo.getBitmapPath()); 1800 return null; 1801 } 1802 } 1803 } 1804 1805 @Override 1806 public boolean hasShortcutHostPermission(int launcherUserId, 1807 @NonNull String callingPackage) { 1808 return ShortcutService.this.hasShortcutHostPermission(callingPackage, launcherUserId); 1809 } 1810 } 1811 1812 /** 1813 * Package event callbacks. 1814 */ 1815 @VisibleForTesting 1816 final PackageMonitor mPackageMonitor = new PackageMonitor() { 1817 @Override 1818 public void onPackageAdded(String packageName, int uid) { 1819 handlePackageAdded(packageName, getChangingUserId()); 1820 } 1821 1822 @Override 1823 public void onPackageUpdateFinished(String packageName, int uid) { 1824 handlePackageUpdateFinished(packageName, getChangingUserId()); 1825 } 1826 1827 @Override 1828 public void onPackageRemoved(String packageName, int uid) { 1829 handlePackageRemoved(packageName, getChangingUserId()); 1830 } 1831 }; 1832 1833 /** 1834 * Called when a user is unlocked. Check all known packages still exist, and otherwise 1835 * perform cleanup. 1836 */ 1837 @VisibleForTesting 1838 void cleanupGonePackages(@UserIdInt int ownerUserId) { 1839 if (DEBUG) { 1840 Slog.d(TAG, "cleanupGonePackages() ownerUserId=" + ownerUserId); 1841 } 1842 final ArrayList<PackageWithUser> gonePackages = new ArrayList<>(); 1843 1844 synchronized (mLock) { 1845 final ShortcutUser user = getUserShortcutsLocked(ownerUserId); 1846 1847 user.forAllPackageItems(spi -> { 1848 if (spi.getPackageInfo().isShadow()) { 1849 return; // Don't delete shadow information. 1850 } 1851 if (isPackageInstalled(spi.getPackageName(), spi.getPackageUserId())) { 1852 return; // Package not gone. 1853 } 1854 gonePackages.add(PackageWithUser.of(spi)); 1855 }); 1856 if (gonePackages.size() > 0) { 1857 for (int i = gonePackages.size() - 1; i >= 0; i--) { 1858 final PackageWithUser pu = gonePackages.get(i); 1859 cleanUpPackageLocked(pu.packageName, ownerUserId, pu.userId); 1860 } 1861 } 1862 } 1863 } 1864 1865 private void handlePackageAdded(String packageName, @UserIdInt int userId) { 1866 if (DEBUG) { 1867 Slog.d(TAG, String.format("handlePackageAdded: %s user=%d", packageName, userId)); 1868 } 1869 synchronized (mLock) { 1870 forEachLoadedUserLocked(user -> 1871 user.attemptToRestoreIfNeededAndSave(this, packageName, userId)); 1872 } 1873 } 1874 1875 private void handlePackageUpdateFinished(String packageName, @UserIdInt int userId) { 1876 if (DEBUG) { 1877 Slog.d(TAG, String.format("handlePackageUpdateFinished: %s user=%d", 1878 packageName, userId)); 1879 } 1880 synchronized (mLock) { 1881 forEachLoadedUserLocked(user -> 1882 user.attemptToRestoreIfNeededAndSave(this, packageName, userId)); 1883 } 1884 } 1885 1886 private void handlePackageRemoved(String packageName, @UserIdInt int packageUserId) { 1887 if (DEBUG) { 1888 Slog.d(TAG, String.format("handlePackageRemoved: %s user=%d", packageName, 1889 packageUserId)); 1890 } 1891 handlePackageRemovedInner(packageName, packageUserId, /* forceForCommandLine =*/ false); 1892 } 1893 1894 private void handlePackageRemovedInner(String packageName, @UserIdInt int packageUserId, 1895 boolean forceForCommandLine) { 1896 synchronized (mLock) { 1897 forEachLoadedUserLocked(user -> 1898 cleanUpPackageLocked(packageName, user.getUserId(), packageUserId, 1899 forceForCommandLine)); 1900 } 1901 } 1902 1903 // === PackageManager interaction === 1904 1905 PackageInfo getPackageInfoWithSignatures(String packageName, @UserIdInt int userId) { 1906 return injectPackageInfo(packageName, userId, true); 1907 } 1908 1909 int injectGetPackageUid(@NonNull String packageName, @UserIdInt int userId) { 1910 final long token = injectClearCallingIdentity(); 1911 try { 1912 return mIPackageManager.getPackageUid(packageName, PACKAGE_MATCH_FLAGS 1913 , userId); 1914 } catch (RemoteException e) { 1915 // Shouldn't happen. 1916 Slog.wtf(TAG, "RemoteException", e); 1917 return -1; 1918 } finally { 1919 injectRestoreCallingIdentity(token); 1920 } 1921 } 1922 1923 @VisibleForTesting 1924 PackageInfo injectPackageInfo(String packageName, @UserIdInt int userId, 1925 boolean getSignatures) { 1926 final long start = System.currentTimeMillis(); 1927 final long token = injectClearCallingIdentity(); 1928 try { 1929 return mIPackageManager.getPackageInfo(packageName, PACKAGE_MATCH_FLAGS 1930 | (getSignatures ? PackageManager.GET_SIGNATURES : 0) 1931 , userId); 1932 } catch (RemoteException e) { 1933 // Shouldn't happen. 1934 Slog.wtf(TAG, "RemoteException", e); 1935 return null; 1936 } finally { 1937 injectRestoreCallingIdentity(token); 1938 1939 logDurationStat( 1940 (getSignatures ? Stats.GET_PACKAGE_INFO_WITH_SIG : Stats.GET_PACKAGE_INFO), 1941 start); 1942 } 1943 } 1944 1945 @VisibleForTesting 1946 ApplicationInfo injectApplicationInfo(String packageName, @UserIdInt int userId) { 1947 final long start = System.currentTimeMillis(); 1948 final long token = injectClearCallingIdentity(); 1949 try { 1950 return mIPackageManager.getApplicationInfo(packageName, PACKAGE_MATCH_FLAGS, userId); 1951 } catch (RemoteException e) { 1952 // Shouldn't happen. 1953 Slog.wtf(TAG, "RemoteException", e); 1954 return null; 1955 } finally { 1956 injectRestoreCallingIdentity(token); 1957 1958 logDurationStat(Stats.GET_APPLICATION_INFO, start); 1959 } 1960 } 1961 1962 private boolean isApplicationFlagSet(String packageName, int userId, int flags) { 1963 final ApplicationInfo ai = injectApplicationInfo(packageName, userId); 1964 return (ai != null) && ((ai.flags & flags) == flags); 1965 } 1966 1967 boolean isPackageInstalled(String packageName, int userId) { 1968 return isApplicationFlagSet(packageName, userId, ApplicationInfo.FLAG_INSTALLED); 1969 } 1970 1971 // === Backup & restore === 1972 1973 boolean shouldBackupApp(String packageName, int userId) { 1974 return isApplicationFlagSet(packageName, userId, ApplicationInfo.FLAG_ALLOW_BACKUP); 1975 } 1976 1977 boolean shouldBackupApp(PackageInfo pi) { 1978 return (pi.applicationInfo.flags & ApplicationInfo.FLAG_ALLOW_BACKUP) != 0; 1979 } 1980 1981 @Override 1982 public byte[] getBackupPayload(@UserIdInt int userId) { 1983 enforceSystem(); 1984 if (DEBUG) { 1985 Slog.d(TAG, "Backing up user " + userId); 1986 } 1987 synchronized (mLock) { 1988 final ShortcutUser user = getUserShortcutsLocked(userId); 1989 if (user == null) { 1990 Slog.w(TAG, "Can't backup: user not found: id=" + userId); 1991 return null; 1992 } 1993 1994 user.forAllPackageItems(spi -> spi.refreshPackageInfoAndSave(this)); 1995 1996 // Then save. 1997 final ByteArrayOutputStream os = new ByteArrayOutputStream(32 * 1024); 1998 try { 1999 saveUserInternalLocked(userId, os, /* forBackup */ true); 2000 } catch (XmlPullParserException|IOException e) { 2001 // Shouldn't happen. 2002 Slog.w(TAG, "Backup failed.", e); 2003 return null; 2004 } 2005 return os.toByteArray(); 2006 } 2007 } 2008 2009 @Override 2010 public void applyRestore(byte[] payload, @UserIdInt int userId) { 2011 enforceSystem(); 2012 if (DEBUG) { 2013 Slog.d(TAG, "Restoring user " + userId); 2014 } 2015 final ShortcutUser user; 2016 final ByteArrayInputStream is = new ByteArrayInputStream(payload); 2017 try { 2018 user = loadUserInternal(userId, is, /* fromBackup */ true); 2019 } catch (XmlPullParserException|IOException e) { 2020 Slog.w(TAG, "Restoration failed.", e); 2021 return; 2022 } 2023 synchronized (mLock) { 2024 mUsers.put(userId, user); 2025 2026 // Then purge all the save images. 2027 final File bitmapPath = getUserBitmapFilePath(userId); 2028 final boolean success = FileUtils.deleteContents(bitmapPath); 2029 if (!success) { 2030 Slog.w(TAG, "Failed to delete " + bitmapPath); 2031 } 2032 2033 saveUserLocked(userId); 2034 } 2035 } 2036 2037 // === Dump === 2038 2039 @Override 2040 public void dump(FileDescriptor fd, PrintWriter pw, String[] args) { 2041 if (mContext.checkCallingOrSelfPermission(android.Manifest.permission.DUMP) 2042 != PackageManager.PERMISSION_GRANTED) { 2043 pw.println("Permission Denial: can't dump UserManager from from pid=" 2044 + Binder.getCallingPid() 2045 + ", uid=" + Binder.getCallingUid() 2046 + " without permission " 2047 + android.Manifest.permission.DUMP); 2048 return; 2049 } 2050 dumpInner(pw); 2051 } 2052 2053 @VisibleForTesting 2054 void dumpInner(PrintWriter pw) { 2055 synchronized (mLock) { 2056 final long now = injectCurrentTimeMillis(); 2057 pw.print("Now: ["); 2058 pw.print(now); 2059 pw.print("] "); 2060 pw.print(formatTime(now)); 2061 2062 pw.print(" Raw last reset: ["); 2063 pw.print(mRawLastResetTime); 2064 pw.print("] "); 2065 pw.print(formatTime(mRawLastResetTime)); 2066 2067 final long last = getLastResetTimeLocked(); 2068 pw.print(" Last reset: ["); 2069 pw.print(last); 2070 pw.print("] "); 2071 pw.print(formatTime(last)); 2072 2073 final long next = getNextResetTimeLocked(); 2074 pw.print(" Next reset: ["); 2075 pw.print(next); 2076 pw.print("] "); 2077 pw.print(formatTime(next)); 2078 pw.println(); 2079 2080 pw.print(" Config:"); 2081 pw.print(" Max icon dim: "); 2082 pw.println(mMaxIconDimension); 2083 pw.print(" Icon format: "); 2084 pw.println(mIconPersistFormat); 2085 pw.print(" Icon quality: "); 2086 pw.println(mIconPersistQuality); 2087 pw.print(" saveDelayMillis:"); 2088 pw.println(mSaveDelayMillis); 2089 pw.print(" resetInterval:"); 2090 pw.println(mResetInterval); 2091 pw.print(" maxUpdatesPerInterval:"); 2092 pw.println(mMaxUpdatesPerInterval); 2093 pw.print(" maxDynamicShortcuts:"); 2094 pw.println(mMaxDynamicShortcuts); 2095 pw.println(); 2096 2097 pw.println(" Stats:"); 2098 synchronized (mStatLock) { 2099 final String p = " "; 2100 dumpStatLS(pw, p, Stats.GET_DEFAULT_HOME, "getHomeActivities()"); 2101 dumpStatLS(pw, p, Stats.LAUNCHER_PERMISSION_CHECK, "Launcher permission check"); 2102 2103 dumpStatLS(pw, p, Stats.GET_PACKAGE_INFO, "getPackageInfo()"); 2104 dumpStatLS(pw, p, Stats.GET_PACKAGE_INFO_WITH_SIG, "getPackageInfo(SIG)"); 2105 dumpStatLS(pw, p, Stats.GET_APPLICATION_INFO, "getApplicationInfo"); 2106 } 2107 2108 for (int i = 0; i < mUsers.size(); i++) { 2109 pw.println(); 2110 mUsers.valueAt(i).dump(this, pw, " "); 2111 } 2112 } 2113 } 2114 2115 static String formatTime(long time) { 2116 Time tobj = new Time(); 2117 tobj.set(time); 2118 return tobj.format("%Y-%m-%d %H:%M:%S"); 2119 } 2120 2121 private void dumpStatLS(PrintWriter pw, String prefix, int statId, String label) { 2122 pw.print(prefix); 2123 final int count = mCountStats[statId]; 2124 final long dur = mDurationStats[statId]; 2125 pw.println(String.format("%s: count=%d, total=%dms, avg=%.1fms", 2126 label, count, dur, 2127 (count == 0 ? 0 : ((double) dur) / count))); 2128 } 2129 2130 // === Shell support === 2131 2132 @Override 2133 public void onShellCommand(FileDescriptor in, FileDescriptor out, FileDescriptor err, 2134 String[] args, ResultReceiver resultReceiver) throws RemoteException { 2135 2136 enforceShell(); 2137 2138 (new MyShellCommand()).exec(this, in, out, err, args, resultReceiver); 2139 } 2140 2141 static class CommandException extends Exception { 2142 public CommandException(String message) { 2143 super(message); 2144 } 2145 } 2146 2147 /** 2148 * Handle "adb shell cmd". 2149 */ 2150 private class MyShellCommand extends ShellCommand { 2151 2152 private int mUserId = UserHandle.USER_SYSTEM; 2153 2154 private void parseOptions(boolean takeUser) 2155 throws CommandException { 2156 String opt; 2157 while ((opt = getNextOption()) != null) { 2158 switch (opt) { 2159 case "--user": 2160 if (takeUser) { 2161 mUserId = UserHandle.parseUserArg(getNextArgRequired()); 2162 break; 2163 } 2164 // fallthrough 2165 default: 2166 throw new CommandException("Unknown option: " + opt); 2167 } 2168 } 2169 } 2170 2171 @Override 2172 public int onCommand(String cmd) { 2173 if (cmd == null) { 2174 return handleDefaultCommands(cmd); 2175 } 2176 final PrintWriter pw = getOutPrintWriter(); 2177 try { 2178 switch (cmd) { 2179 case "reset-package-throttling": 2180 handleResetPackageThrottling(); 2181 break; 2182 case "reset-throttling": 2183 handleResetThrottling(); 2184 break; 2185 case "reset-all-throttling": 2186 handleResetAllThrottling(); 2187 break; 2188 case "override-config": 2189 handleOverrideConfig(); 2190 break; 2191 case "reset-config": 2192 handleResetConfig(); 2193 break; 2194 case "clear-default-launcher": 2195 handleClearDefaultLauncher(); 2196 break; 2197 case "get-default-launcher": 2198 handleGetDefaultLauncher(); 2199 break; 2200 case "refresh-default-launcher": 2201 handleRefreshDefaultLauncher(); 2202 break; 2203 case "unload-user": 2204 handleUnloadUser(); 2205 break; 2206 case "clear-shortcuts": 2207 handleClearShortcuts(); 2208 break; 2209 default: 2210 return handleDefaultCommands(cmd); 2211 } 2212 } catch (CommandException e) { 2213 pw.println("Error: " + e.getMessage()); 2214 return 1; 2215 } 2216 pw.println("Success"); 2217 return 0; 2218 } 2219 2220 @Override 2221 public void onHelp() { 2222 final PrintWriter pw = getOutPrintWriter(); 2223 pw.println("Usage: cmd shortcut COMMAND [options ...]"); 2224 pw.println(); 2225 pw.println("cmd shortcut reset-package-throttling [--user USER_ID] PACKAGE"); 2226 pw.println(" Reset throttling for a package"); 2227 pw.println(); 2228 pw.println("cmd shortcut reset-throttling [--user USER_ID]"); 2229 pw.println(" Reset throttling for all packages and users"); 2230 pw.println(); 2231 pw.println("cmd shortcut reset-all-throttling"); 2232 pw.println(" Reset the throttling state for all users"); 2233 pw.println(); 2234 pw.println("cmd shortcut override-config CONFIG"); 2235 pw.println(" Override the configuration for testing (will last until reboot)"); 2236 pw.println(); 2237 pw.println("cmd shortcut reset-config"); 2238 pw.println(" Reset the configuration set with \"update-config\""); 2239 pw.println(); 2240 pw.println("cmd shortcut clear-default-launcher [--user USER_ID]"); 2241 pw.println(" Clear the cached default launcher"); 2242 pw.println(); 2243 pw.println("cmd shortcut get-default-launcher [--user USER_ID]"); 2244 pw.println(" Show the cached default launcher"); 2245 pw.println(); 2246 pw.println("cmd shortcut refresh-default-launcher [--user USER_ID]"); 2247 pw.println(" Refresh the cached default launcher"); 2248 pw.println(); 2249 pw.println("cmd shortcut unload-user [--user USER_ID]"); 2250 pw.println(" Unload a user from the memory"); 2251 pw.println(" (This should not affect any observable behavior)"); 2252 pw.println(); 2253 pw.println("cmd shortcut clear-shortcuts [--user USER_ID] PACKAGE"); 2254 pw.println(" Remove all shortcuts from a package, including pinned shortcuts"); 2255 pw.println(); 2256 } 2257 2258 private void handleResetThrottling() throws CommandException { 2259 parseOptions(/* takeUser =*/ true); 2260 2261 Slog.i(TAG, "cmd: handleResetThrottling"); 2262 2263 resetThrottlingInner(mUserId); 2264 } 2265 2266 private void handleResetAllThrottling() { 2267 Slog.i(TAG, "cmd: handleResetAllThrottling"); 2268 2269 resetAllThrottlingInner(); 2270 } 2271 2272 private void handleResetPackageThrottling() throws CommandException { 2273 parseOptions(/* takeUser =*/ true); 2274 2275 final String packageName = getNextArgRequired(); 2276 2277 Slog.i(TAG, "cmd: handleResetPackageThrottling: " + packageName); 2278 2279 synchronized (mLock) { 2280 getPackageShortcutsLocked(packageName, mUserId).resetRateLimitingForCommandLine(); 2281 saveUserLocked(mUserId); 2282 } 2283 } 2284 2285 private void handleOverrideConfig() throws CommandException { 2286 final String config = getNextArgRequired(); 2287 2288 Slog.i(TAG, "cmd: handleOverrideConfig: " + config); 2289 2290 synchronized (mLock) { 2291 if (!updateConfigurationLocked(config)) { 2292 throw new CommandException("override-config failed. See logcat for details."); 2293 } 2294 } 2295 } 2296 2297 private void handleResetConfig() { 2298 Slog.i(TAG, "cmd: handleResetConfig"); 2299 2300 synchronized (mLock) { 2301 loadConfigurationLocked(); 2302 } 2303 } 2304 2305 private void clearLauncher() { 2306 synchronized (mLock) { 2307 getUserShortcutsLocked(mUserId).setLauncherComponent( 2308 ShortcutService.this, null); 2309 } 2310 } 2311 2312 private void showLauncher() { 2313 synchronized (mLock) { 2314 // This ensures to set the cached launcher. Package name doesn't matter. 2315 hasShortcutHostPermissionInner("-", mUserId); 2316 2317 getOutPrintWriter().println("Launcher: " 2318 + getUserShortcutsLocked(mUserId).getLauncherComponent()); 2319 } 2320 } 2321 2322 private void handleClearDefaultLauncher() throws CommandException { 2323 parseOptions(/* takeUser =*/ true); 2324 2325 clearLauncher(); 2326 } 2327 2328 private void handleGetDefaultLauncher() throws CommandException { 2329 parseOptions(/* takeUser =*/ true); 2330 2331 showLauncher(); 2332 } 2333 2334 private void handleRefreshDefaultLauncher() throws CommandException { 2335 parseOptions(/* takeUser =*/ true); 2336 2337 clearLauncher(); 2338 showLauncher(); 2339 } 2340 2341 private void handleUnloadUser() throws CommandException { 2342 parseOptions(/* takeUser =*/ true); 2343 2344 Slog.i(TAG, "cmd: handleUnloadUser: " + mUserId); 2345 2346 ShortcutService.this.handleCleanupUser(mUserId); 2347 } 2348 2349 private void handleClearShortcuts() throws CommandException { 2350 parseOptions(/* takeUser =*/ true); 2351 final String packageName = getNextArgRequired(); 2352 2353 Slog.i(TAG, "cmd: handleClearShortcuts: " + mUserId + ", " + packageName); 2354 2355 ShortcutService.this.handlePackageRemovedInner(packageName, mUserId, 2356 /* forceForCommandLine= */ true); 2357 } 2358 } 2359 2360 // === Unit test support === 2361 2362 // Injection point. 2363 @VisibleForTesting 2364 long injectCurrentTimeMillis() { 2365 return System.currentTimeMillis(); 2366 } 2367 2368 // Injection point. 2369 @VisibleForTesting 2370 int injectBinderCallingUid() { 2371 return getCallingUid(); 2372 } 2373 2374 private int getCallingUserId() { 2375 return UserHandle.getUserId(injectBinderCallingUid()); 2376 } 2377 2378 // Injection point. 2379 @VisibleForTesting 2380 long injectClearCallingIdentity() { 2381 return Binder.clearCallingIdentity(); 2382 } 2383 2384 // Injection point. 2385 @VisibleForTesting 2386 void injectRestoreCallingIdentity(long token) { 2387 Binder.restoreCallingIdentity(token); 2388 } 2389 2390 final void wtf(String message) { 2391 wtf( message, /* exception= */ null); 2392 } 2393 2394 // Injection point. 2395 void wtf(String message, Exception e) { 2396 Slog.wtf(TAG, message, e); 2397 } 2398 2399 @VisibleForTesting 2400 File injectSystemDataPath() { 2401 return Environment.getDataSystemDirectory(); 2402 } 2403 2404 @VisibleForTesting 2405 File injectUserDataPath(@UserIdInt int userId) { 2406 return new File(Environment.getDataSystemCeDirectory(userId), DIRECTORY_PER_USER); 2407 } 2408 2409 @VisibleForTesting 2410 boolean injectIsLowRamDevice() { 2411 return ActivityManager.isLowRamDeviceStatic(); 2412 } 2413 2414 @VisibleForTesting 2415 PackageManagerInternal injectPackageManagerInternal() { 2416 return mPackageManagerInternal; 2417 } 2418 2419 @VisibleForTesting 2420 File getUserBitmapFilePath(@UserIdInt int userId) { 2421 return new File(injectUserDataPath(userId), DIRECTORY_BITMAPS); 2422 } 2423 2424 @VisibleForTesting 2425 SparseArray<ShortcutUser> getShortcutsForTest() { 2426 return mUsers; 2427 } 2428 2429 @VisibleForTesting 2430 int getMaxDynamicShortcutsForTest() { 2431 return mMaxDynamicShortcuts; 2432 } 2433 2434 @VisibleForTesting 2435 int getMaxUpdatesPerIntervalForTest() { 2436 return mMaxUpdatesPerInterval; 2437 } 2438 2439 @VisibleForTesting 2440 long getResetIntervalForTest() { 2441 return mResetInterval; 2442 } 2443 2444 @VisibleForTesting 2445 int getMaxIconDimensionForTest() { 2446 return mMaxIconDimension; 2447 } 2448 2449 @VisibleForTesting 2450 CompressFormat getIconPersistFormatForTest() { 2451 return mIconPersistFormat; 2452 } 2453 2454 @VisibleForTesting 2455 int getIconPersistQualityForTest() { 2456 return mIconPersistQuality; 2457 } 2458 2459 @VisibleForTesting 2460 ShortcutInfo getPackageShortcutForTest(String packageName, String shortcutId, int userId) { 2461 synchronized (mLock) { 2462 final ShortcutUser user = mUsers.get(userId); 2463 if (user == null) return null; 2464 2465 final ShortcutPackage pkg = user.getAllPackages().get(packageName); 2466 if (pkg == null) return null; 2467 2468 return pkg.findShortcutById(shortcutId); 2469 } 2470 } 2471} 2472