blob: c38423ad25f23a345db3df13f97a2e9f84002b88 [file] [log] [blame]
The Android Open Source Project31dd5032009-03-03 19:32:27 -08001/*
2 * Copyright (C) 2008 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
Daniel Sandler325dc232013-06-05 22:57:57 -040017package com.android.launcher3;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080018
Sunny Goyal29947f02017-12-18 13:49:44 -080019import static com.android.launcher3.LauncherAppState.ACTION_FORCE_ROLOAD;
20import static com.android.launcher3.config.FeatureFlags.IS_DOGFOOD_BUILD;
21
Sunny Goyalf599ccf2014-07-08 13:01:29 -070022import android.content.BroadcastReceiver;
Sunny Goyalf599ccf2014-07-08 13:01:29 -070023import android.content.Context;
24import android.content.Intent;
Joe Onorato36115782010-06-17 13:28:48 -040025import android.os.Handler;
26import android.os.HandlerThread;
Sunny Goyal756adbc2015-04-16 15:20:51 -070027import android.os.Looper;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080028import android.os.Process;
Sunny Goyal7c74e4a2016-12-15 15:53:17 -080029import android.os.UserHandle;
Winson Chunga90303b2013-11-15 13:05:06 -080030import android.text.TextUtils;
Winson Chungaafa03c2010-06-11 17:34:16 -070031import android.util.Log;
Sunny Goyala474a9b2017-05-04 16:47:11 -070032import android.util.Pair;
Michael Jurka34c2e6c2013-12-13 16:07:45 +010033
Kenny Guyed131872014-04-30 03:02:21 +010034import com.android.launcher3.compat.LauncherAppsCompat;
Sunny Goyale755d462014-07-22 13:48:29 -070035import com.android.launcher3.compat.PackageInstallerCompat.PackageInstallInfo;
Kenny Guyed131872014-04-30 03:02:21 +010036import com.android.launcher3.compat.UserManagerCompat;
Sunny Goyalf840f102018-09-21 14:41:05 -070037import com.android.launcher3.icons.IconCache;
Sunny Goyalc5939392018-12-07 11:43:47 -080038import com.android.launcher3.icons.LauncherIcons;
Sunny Goyalf0ba8b72016-09-09 15:47:55 -070039import com.android.launcher3.model.AddWorkspaceItemsTask;
Sunny Goyale75d9f12018-01-31 11:59:00 -080040import com.android.launcher3.model.BaseModelUpdateTask;
Sunny Goyale9956a72016-09-01 17:24:47 -070041import com.android.launcher3.model.BgDataModel;
Sunny Goyalf0ba8b72016-09-09 15:47:55 -070042import com.android.launcher3.model.CacheDataUpdatedTask;
Sunny Goyalf8d6ed22017-06-01 14:26:38 -070043import com.android.launcher3.model.LoaderResults;
Sunny Goyalb434fde2017-06-06 10:46:59 -070044import com.android.launcher3.model.LoaderTask;
Sunny Goyal43bf11d2017-02-02 13:52:53 -080045import com.android.launcher3.model.ModelWriter;
Sunny Goyalf0ba8b72016-09-09 15:47:55 -070046import com.android.launcher3.model.PackageInstallStateChangedTask;
47import com.android.launcher3.model.PackageUpdatedTask;
48import com.android.launcher3.model.ShortcutsChangedTask;
49import com.android.launcher3.model.UserLockStateChangedTask;
Tony Wickhambfbf7f92016-05-19 11:19:39 -070050import com.android.launcher3.shortcuts.DeepShortcutManager;
51import com.android.launcher3.shortcuts.ShortcutInfoCompat;
Robin Lee26ace122015-03-16 19:41:43 +000052import com.android.launcher3.util.ComponentKey;
Sunny Goyalefb7e842018-10-04 15:11:00 -070053import com.android.launcher3.util.IntArray;
Sunny Goyal6e13dd32017-08-17 03:01:19 -070054import com.android.launcher3.util.ItemInfoMatcher;
Tony Wickham86222d22017-03-29 15:30:43 -070055import com.android.launcher3.util.PackageUserKey;
Sunny Goyalaaf7d1d2016-05-17 13:38:54 -070056import com.android.launcher3.util.Preconditions;
Adam Cohen091440a2015-03-18 14:16:05 -070057import com.android.launcher3.util.Thunk;
Sunny Goyal527c7d32015-08-28 15:19:36 -070058import com.android.launcher3.util.ViewOnDrawExecutor;
Sunny Goyalf1fbc3f2017-10-10 15:21:15 -070059import com.android.launcher3.widget.WidgetListRowEntry;
Romain Guyedcce092010-03-04 13:03:17 -080060
Hyunyoung Song3c7d9cb2017-01-30 15:11:27 -080061import java.io.FileDescriptor;
62import java.io.PrintWriter;
Michael Jurkac2f801e2011-07-12 14:19:46 -070063import java.lang.ref.WeakReference;
Michael Jurkac2f801e2011-07-12 14:19:46 -070064import java.util.ArrayList;
Zak Cohen658c67a2018-10-19 14:21:05 -070065import java.util.HashMap;
Winson Chungb8b2a5a2012-07-12 17:55:31 -070066import java.util.HashSet;
Michael Jurkac2f801e2011-07-12 14:19:46 -070067import java.util.List;
Sunny Goyaldd96a5e2017-02-17 11:22:34 -080068import java.util.concurrent.CancellationException;
Sunny Goyal527c7d32015-08-28 15:19:36 -070069import java.util.concurrent.Executor;
Sunny Goyal8c48d8b2019-01-25 15:10:18 -080070import java.util.function.Supplier;
Michael Jurkac2f801e2011-07-12 14:19:46 -070071
Sunny Goyald2303072018-08-14 15:21:45 -070072import androidx.annotation.Nullable;
73
The Android Open Source Project31dd5032009-03-03 19:32:27 -080074/**
75 * Maintains in-memory state of the Launcher. It is expected that there should be only one
76 * LauncherModel object held in a static. Also provide APIs for updating the database state
The Android Open Source Projectbc219c32009-03-09 11:52:14 -070077 * for the Launcher.
The Android Open Source Project31dd5032009-03-03 19:32:27 -080078 */
Kenny Guyed131872014-04-30 03:02:21 +010079public class LauncherModel extends BroadcastReceiver
Kenny Guyc2bd8102014-06-30 12:30:31 +010080 implements LauncherAppsCompat.OnAppsChangedCallbackCompat {
Chris Wrenee523362014-09-09 10:09:02 -040081 private static final boolean DEBUG_RECEIVER = false;
Chris Wrenb358f812014-04-16 13:37:00 -040082
Joe Onorato9c1289c2009-08-17 11:03:03 -040083 static final String TAG = "Launcher.Model";
The Android Open Source Projectf96811c2009-03-18 17:39:48 -070084
Sunny Goyalb265ba72017-02-14 15:03:45 -080085 private final MainThreadExecutor mUiExecutor = new MainThreadExecutor();
Adam Cohen091440a2015-03-18 14:16:05 -070086 @Thunk final LauncherAppState mApp;
87 @Thunk final Object mLock = new Object();
Sunny Goyalb434fde2017-06-06 10:46:59 -070088 @Thunk
89 LoaderTask mLoaderTask;
Adam Cohen091440a2015-03-18 14:16:05 -070090 @Thunk boolean mIsLoaderTaskRunning;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080091
Adam Cohen091440a2015-03-18 14:16:05 -070092 @Thunk static final HandlerThread sWorkerThread = new HandlerThread("launcher-loader");
Sunny Goyal06a07e92018-11-07 16:54:02 -080093 private static final Looper mWorkerLooper;
Brad Fitzpatrick700889f2010-10-11 09:40:44 -070094 static {
95 sWorkerThread.start();
Sunny Goyal06a07e92018-11-07 16:54:02 -080096 mWorkerLooper = sWorkerThread.getLooper();
Brad Fitzpatrick700889f2010-10-11 09:40:44 -070097 }
Sunny Goyal06a07e92018-11-07 16:54:02 -080098 @Thunk static final Handler sWorker = new Handler(mWorkerLooper);
Brad Fitzpatrick700889f2010-10-11 09:40:44 -070099
Sunny Goyaldd96a5e2017-02-17 11:22:34 -0800100 // Indicates whether the current model data is valid or not.
101 // We start off with everything not loaded. After that, we assume that
Joe Onoratocc67f472010-06-08 10:54:30 -0700102 // our monitoring of the package manager provides all updates and we never
Sunny Goyaldd96a5e2017-02-17 11:22:34 -0800103 // need to do a requery. This is only ever touched from the loader thread.
104 private boolean mModelLoaded;
Hyunyoung Song6aa37292017-02-06 10:46:24 -0800105 public boolean isModelLoaded() {
106 synchronized (mLock) {
107 return mModelLoaded && mLoaderTask == null;
108 }
109 }
Joe Onoratocc67f472010-06-08 10:54:30 -0700110
Adam Cohen091440a2015-03-18 14:16:05 -0700111 @Thunk WeakReference<Callbacks> mCallbacks;
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800112
Michael Jurkaa8c760d2011-04-28 14:59:33 -0700113 // < only access in worker thread >
Sunny Goyal2e1efb42016-03-03 16:58:55 -0800114 private final AllAppsList mBgAllAppsList;
Sunny Goyal95f3d6b2016-08-10 16:09:29 -0700115
Sunny Goyale9956a72016-09-01 17:24:47 -0700116 /**
117 * All the static data should be accessed on the background thread, A lock should be acquired
118 * on this object when accessing any data from this model.
119 */
120 static final BgDataModel sBgDataModel = new BgDataModel();
Tony Wickhambfbf7f92016-05-19 11:19:39 -0700121
Sunny Goyalc6e97692017-06-02 13:46:55 -0700122 // Runnable to check if the shortcuts permission has changed.
123 private final Runnable mShortcutPermissionCheckRunnable = new Runnable() {
124 @Override
125 public void run() {
126 if (mModelLoaded) {
127 boolean hasShortcutHostPermission =
128 DeepShortcutManager.getInstance(mApp.getContext()).hasHostPermission();
129 if (hasShortcutHostPermission != sBgDataModel.hasShortcutHostPermission) {
130 forceReload();
131 }
132 }
133 }
134 };
Kenny Guyed131872014-04-30 03:02:21 +0100135
Sunny Goyalaeb16432017-10-16 11:46:41 -0700136 public interface Callbacks {
Sunny Goyal605bcf32018-03-02 15:16:12 -0800137 public void rebindModel();
138
Joe Onorato9c1289c2009-08-17 11:03:03 -0400139 public int getCurrentWorkspaceScreen();
Sunny Goyal527c7d32015-08-28 15:19:36 -0700140 public void clearPendingBinds();
Joe Onorato9c1289c2009-08-17 11:03:03 -0400141 public void startBinding();
Sunny Goyalb23980c2017-08-17 07:45:25 -0700142 public void bindItems(List<ItemInfo> shortcuts, boolean forceAnimateIcons);
Sunny Goyalefb7e842018-10-04 15:11:00 -0700143 public void bindScreens(IntArray orderedScreenIds);
Sunny Goyalb5b9ad62016-04-02 11:23:39 -0700144 public void finishFirstPageBind(ViewOnDrawExecutor executor);
Tonyf80e8932018-12-21 11:58:04 -0800145 public void finishBindingItems(int pageBoundFirst);
Michael Jurkaeadbfc52013-09-04 00:45:37 +0200146 public void bindAllApplications(ArrayList<AppInfo> apps);
Sunny Goyalb23980c2017-08-17 07:45:25 -0700147 public void bindAppsAddedOrUpdated(ArrayList<AppInfo> apps);
Tony Wickham6a71a5b2018-08-21 11:40:23 -0700148 public void preAddApps();
Sunny Goyalefb7e842018-10-04 15:11:00 -0700149 public void bindAppsAdded(IntArray newScreens,
150 ArrayList<ItemInfo> addNotAnimated, ArrayList<ItemInfo> addAnimated);
Mario Bertschler08ffaae2017-03-20 11:30:27 -0700151 public void bindPromiseAppProgressUpdated(PromiseAppInfo app);
Sunny Goyal6e13dd32017-08-17 03:01:19 -0700152 public void bindShortcutsChanged(ArrayList<ShortcutInfo> updated, UserHandle user);
Sunny Goyal4390ace2014-10-13 11:33:11 -0700153 public void bindWidgetsRestored(ArrayList<LauncherAppWidgetInfo> widgets);
Sunny Goyal756adbc2015-04-16 15:20:51 -0700154 public void bindRestoreItemsChange(HashSet<ItemInfo> updates);
Sunny Goyal6e13dd32017-08-17 03:01:19 -0700155 public void bindWorkspaceComponentsRemoved(ItemInfoMatcher matcher);
Sunny Goyal3bbbabc2016-03-15 09:16:30 -0700156 public void bindAppInfosRemoved(ArrayList<AppInfo> appInfos);
Sunny Goyalf1fbc3f2017-10-10 15:21:15 -0700157 public void bindAllWidgets(ArrayList<WidgetListRowEntry> widgets);
Adam Cohen1462de32012-07-24 22:34:36 -0700158 public void onPageBoundSynchronously(int page);
Sunny Goyal527c7d32015-08-28 15:19:36 -0700159 public void executeOnNextDraw(ViewOnDrawExecutor executor);
Zak Cohen658c67a2018-10-19 14:21:05 -0700160 public void bindDeepShortcutMap(HashMap<ComponentKey, Integer> deepShortcutMap);
Joe Onorato9c1289c2009-08-17 11:03:03 -0400161 }
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800162
Sunny Goyaldde4fd92016-11-21 16:02:39 +0530163 LauncherModel(LauncherAppState app, IconCache iconCache, AppFilter appFilter) {
Daniel Sandlere4f98912013-06-25 15:13:26 -0400164 mApp = app;
Bjorn Bringert1307f632013-10-03 22:31:03 +0100165 mBgAllAppsList = new AllAppsList(iconCache, appFilter);
Joe Onorato0589f0f2010-02-08 13:44:00 -0800166 }
167
Winson Chungb8b2a5a2012-07-12 17:55:31 -0700168 /** Runs the specified runnable immediately if called from the worker thread, otherwise it is
169 * posted on the worker thread handler. */
Tony Wickham80f57872016-06-29 18:12:15 -0700170 private static void runOnWorkerThread(Runnable r) {
Winson Chungb8b2a5a2012-07-12 17:55:31 -0700171 if (sWorkerThread.getThreadId() == Process.myTid()) {
172 r.run();
173 } else {
174 // If we are not on the worker thread, then post to the worker handler
175 sWorker.post(r);
176 }
177 }
178
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700179 public void setPackageState(PackageInstallInfo installInfo) {
180 enqueueModelUpdateTask(new PackageInstallStateChangedTask(installInfo));
Chris Wrenaeff7ea2014-02-14 16:59:24 -0500181 }
182
Sunny Goyal756adbc2015-04-16 15:20:51 -0700183 /**
184 * Updates the icons and label of all pending icons for the provided package name.
185 */
186 public void updateSessionDisplayInfo(final String packageName) {
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700187 HashSet<String> packages = new HashSet<>();
188 packages.add(packageName);
189 enqueueModelUpdateTask(new CacheDataUpdatedTask(
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800190 CacheDataUpdatedTask.OP_SESSION_UPDATE, Process.myUserHandle(), packages));
Sunny Goyal71b5c0b2015-01-08 16:59:04 -0800191 }
192
193 /**
194 * Adds the provided items to the workspace.
Sunny Goyal71b5c0b2015-01-08 16:59:04 -0800195 */
Sunny Goyal91498ab2017-10-05 15:57:40 -0700196 public void addAndBindAddedWorkspaceItems(List<Pair<ItemInfo, Object>> itemList) {
Tony Wickham6a71a5b2018-08-21 11:40:23 -0700197 Callbacks callbacks = getCallback();
198 if (callbacks != null) {
199 callbacks.preAddApps();
200 }
Sunny Goyal91498ab2017-10-05 15:57:40 -0700201 enqueueModelUpdateTask(new AddWorkspaceItemsTask(itemList));
Winson Chung64359a52013-07-08 17:17:08 -0700202 }
203
Sunny Goyal605bcf32018-03-02 15:16:12 -0800204 public ModelWriter getWriter(boolean hasVerticalHotseat, boolean verifyChanges) {
205 return new ModelWriter(mApp.getContext(), this, sBgDataModel,
206 hasVerticalHotseat, verifyChanges);
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800207 }
208
Michael Jurkab2ae8ac2012-09-21 12:06:06 -0700209 static void checkItemInfoLocked(
Sunny Goyalefb7e842018-10-04 15:11:00 -0700210 final int itemId, final ItemInfo item, StackTraceElement[] stackTrace) {
Vadim Tryshevc052e4e2018-10-05 15:17:42 -0700211 if (com.android.launcher3.Utilities.IS_RUNNING_IN_TEST_HARNESS
212 && com.android.launcher3.Utilities.IS_DEBUG_DEVICE) {
213 android.util.Log.d("b/117332845",
214 "Checking item: " + android.util.Log.getStackTraceString(new Throwable()));
215 }
Sunny Goyale9956a72016-09-01 17:24:47 -0700216 ItemInfo modelItem = sBgDataModel.itemsIdMap.get(itemId);
Michael Jurkab2ae8ac2012-09-21 12:06:06 -0700217 if (modelItem != null && item != modelItem) {
218 // check all the data is consistent
219 if (modelItem instanceof ShortcutInfo && item instanceof ShortcutInfo) {
220 ShortcutInfo modelShortcut = (ShortcutInfo) modelItem;
221 ShortcutInfo shortcut = (ShortcutInfo) item;
222 if (modelShortcut.title.toString().equals(shortcut.title.toString()) &&
223 modelShortcut.intent.filterEquals(shortcut.intent) &&
224 modelShortcut.id == shortcut.id &&
225 modelShortcut.itemType == shortcut.itemType &&
226 modelShortcut.container == shortcut.container &&
Adam Cohendcd297f2013-06-18 13:13:40 -0700227 modelShortcut.screenId == shortcut.screenId &&
Michael Jurkab2ae8ac2012-09-21 12:06:06 -0700228 modelShortcut.cellX == shortcut.cellX &&
229 modelShortcut.cellY == shortcut.cellY &&
230 modelShortcut.spanX == shortcut.spanX &&
Sunny Goyalaa8ef112015-06-12 20:04:41 -0700231 modelShortcut.spanY == shortcut.spanY) {
Michael Jurkab2ae8ac2012-09-21 12:06:06 -0700232 // For all intents and purposes, this is the same object
233 return;
234 }
235 }
236
237 // the modelItem needs to match up perfectly with item if our model is
238 // to be consistent with the database-- for now, just require
239 // modelItem == item or the equality check above
240 String msg = "item: " + ((item != null) ? item.toString() : "null") +
241 "modelItem: " +
242 ((modelItem != null) ? modelItem.toString() : "null") +
243 "Error: ItemInfo passed to checkItemInfo doesn't match original";
244 RuntimeException e = new RuntimeException(msg);
245 if (stackTrace != null) {
246 e.setStackTrace(stackTrace);
247 }
Adam Cohenb9ada652013-11-08 08:25:08 -0800248 throw e;
Michael Jurkab2ae8ac2012-09-21 12:06:06 -0700249 }
250 }
251
Michael Jurka816474f2012-06-25 14:49:02 -0700252 static void checkItemInfo(final ItemInfo item) {
253 final StackTraceElement[] stackTrace = new Throwable().getStackTrace();
Sunny Goyalefb7e842018-10-04 15:11:00 -0700254 final int itemId = item.id;
Michael Jurka816474f2012-06-25 14:49:02 -0700255 Runnable r = new Runnable() {
Michael Jurkab2ae8ac2012-09-21 12:06:06 -0700256 public void run() {
Sunny Goyale9956a72016-09-01 17:24:47 -0700257 synchronized (sBgDataModel) {
Michael Jurkab2ae8ac2012-09-21 12:06:06 -0700258 checkItemInfoLocked(itemId, item, stackTrace);
Michael Jurka816474f2012-06-25 14:49:02 -0700259 }
Michael Jurkab2ae8ac2012-09-21 12:06:06 -0700260 }
261 };
Winson Chungb8b2a5a2012-07-12 17:55:31 -0700262 runOnWorkerThread(r);
Michael Jurka816474f2012-06-25 14:49:02 -0700263 }
264
Joe Onorato9c1289c2009-08-17 11:03:03 -0400265 /**
Joe Onorato9c1289c2009-08-17 11:03:03 -0400266 * Set this as the current Launcher activity object for the loader.
267 */
268 public void initialize(Callbacks callbacks) {
269 synchronized (mLock) {
Sunny Goyalaaf7d1d2016-05-17 13:38:54 -0700270 Preconditions.assertUIThread();
Sunny Goyalaaf7d1d2016-05-17 13:38:54 -0700271 mCallbacks = new WeakReference<>(callbacks);
Joe Onorato9c1289c2009-08-17 11:03:03 -0400272 }
273 }
274
Kenny Guyed131872014-04-30 03:02:21 +0100275 @Override
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800276 public void onPackageChanged(String packageName, UserHandle user) {
Kenny Guyed131872014-04-30 03:02:21 +0100277 int op = PackageUpdatedTask.OP_UPDATE;
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700278 enqueueModelUpdateTask(new PackageUpdatedTask(op, user, packageName));
Kenny Guyed131872014-04-30 03:02:21 +0100279 }
280
281 @Override
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800282 public void onPackageRemoved(String packageName, UserHandle user) {
Sunny Goyalc2936bc2016-09-01 15:50:36 -0700283 onPackagesRemoved(user, packageName);
284 }
285
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800286 public void onPackagesRemoved(UserHandle user, String... packages) {
Kenny Guyed131872014-04-30 03:02:21 +0100287 int op = PackageUpdatedTask.OP_REMOVE;
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700288 enqueueModelUpdateTask(new PackageUpdatedTask(op, user, packages));
Kenny Guyed131872014-04-30 03:02:21 +0100289 }
290
291 @Override
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800292 public void onPackageAdded(String packageName, UserHandle user) {
Kenny Guyed131872014-04-30 03:02:21 +0100293 int op = PackageUpdatedTask.OP_ADD;
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700294 enqueueModelUpdateTask(new PackageUpdatedTask(op, user, packageName));
Kenny Guyed131872014-04-30 03:02:21 +0100295 }
296
297 @Override
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800298 public void onPackagesAvailable(String[] packageNames, UserHandle user,
Kenny Guyed131872014-04-30 03:02:21 +0100299 boolean replacing) {
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700300 enqueueModelUpdateTask(
301 new PackageUpdatedTask(PackageUpdatedTask.OP_UPDATE, user, packageNames));
Kenny Guyed131872014-04-30 03:02:21 +0100302 }
303
304 @Override
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800305 public void onPackagesUnavailable(String[] packageNames, UserHandle user,
Kenny Guyed131872014-04-30 03:02:21 +0100306 boolean replacing) {
307 if (!replacing) {
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700308 enqueueModelUpdateTask(new PackageUpdatedTask(
309 PackageUpdatedTask.OP_UNAVAILABLE, user, packageNames));
Kenny Guyed131872014-04-30 03:02:21 +0100310 }
Kenny Guyed131872014-04-30 03:02:21 +0100311 }
312
Kenny Guy44cba692016-01-21 19:50:02 +0000313 @Override
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800314 public void onPackagesSuspended(String[] packageNames, UserHandle user) {
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700315 enqueueModelUpdateTask(new PackageUpdatedTask(
316 PackageUpdatedTask.OP_SUSPEND, user, packageNames));
Kenny Guy44cba692016-01-21 19:50:02 +0000317 }
318
319 @Override
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800320 public void onPackagesUnsuspended(String[] packageNames, UserHandle user) {
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700321 enqueueModelUpdateTask(new PackageUpdatedTask(
322 PackageUpdatedTask.OP_UNSUSPEND, user, packageNames));
Kenny Guy44cba692016-01-21 19:50:02 +0000323 }
324
Tony Wickhambfbf7f92016-05-19 11:19:39 -0700325 @Override
326 public void onShortcutsChanged(String packageName, List<ShortcutInfoCompat> shortcuts,
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800327 UserHandle user) {
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700328 enqueueModelUpdateTask(new ShortcutsChangedTask(packageName, shortcuts, user, true));
Sunny Goyal50941fb2016-08-04 12:03:52 -0700329 }
330
331 public void updatePinnedShortcuts(String packageName, List<ShortcutInfoCompat> shortcuts,
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800332 UserHandle user) {
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700333 enqueueModelUpdateTask(new ShortcutsChangedTask(packageName, shortcuts, user, false));
Tony Wickhambfbf7f92016-05-19 11:19:39 -0700334 }
335
Joe Onorato1d8e7bb2009-10-15 19:49:43 -0700336 /**
Joe Onorato9c1289c2009-08-17 11:03:03 -0400337 * Call from the handler for ACTION_PACKAGE_ADDED, ACTION_PACKAGE_REMOVED and
338 * ACTION_PACKAGE_CHANGED.
339 */
Narayan Kamathcb1a4772011-06-28 13:46:59 +0100340 @Override
Joe Onoratof99f8c12009-10-31 17:27:36 -0400341 public void onReceive(Context context, Intent intent) {
Chris Wrenb358f812014-04-16 13:37:00 -0400342 if (DEBUG_RECEIVER) Log.d(TAG, "onReceive intent=" + intent);
Winson Chungaafa03c2010-06-11 17:34:16 -0700343
Joe Onorato36115782010-06-17 13:28:48 -0400344 final String action = intent.getAction();
Kenny Guyed131872014-04-30 03:02:21 +0100345 if (Intent.ACTION_LOCALE_CHANGED.equals(action)) {
Reena Lee93f824a2011-09-23 17:20:28 -0700346 // If we have changed locale we need to clear out the labels in all apps/workspace.
347 forceReload();
Sunny Goyald3b87ef2016-07-28 12:11:54 -0700348 } else if (Intent.ACTION_MANAGED_PROFILE_ADDED.equals(action)
349 || Intent.ACTION_MANAGED_PROFILE_REMOVED.equals(action)) {
Sunny Goyal823fd502015-08-04 11:40:13 -0700350 UserManagerCompat.getInstance(context).enableAndResetCache();
Sunny Goyal957c13f2015-05-01 13:02:20 -0700351 forceReload();
Sunny Goyald3b87ef2016-07-28 12:11:54 -0700352 } else if (Intent.ACTION_MANAGED_PROFILE_AVAILABLE.equals(action) ||
353 Intent.ACTION_MANAGED_PROFILE_UNAVAILABLE.equals(action) ||
354 Intent.ACTION_MANAGED_PROFILE_UNLOCKED.equals(action)) {
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800355 UserHandle user = intent.getParcelableExtra(Intent.EXTRA_USER);
Sunny Goyalda891c12016-03-18 18:29:24 -0700356 if (user != null) {
Sunny Goyald3b87ef2016-07-28 12:11:54 -0700357 if (Intent.ACTION_MANAGED_PROFILE_AVAILABLE.equals(action) ||
358 Intent.ACTION_MANAGED_PROFILE_UNAVAILABLE.equals(action)) {
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700359 enqueueModelUpdateTask(new PackageUpdatedTask(
360 PackageUpdatedTask.OP_USER_AVAILABILITY_CHANGE, user));
Sunny Goyald3b87ef2016-07-28 12:11:54 -0700361 }
362
363 // ACTION_MANAGED_PROFILE_UNAVAILABLE sends the profile back to locked mode, so
364 // we need to run the state change task again.
365 if (Intent.ACTION_MANAGED_PROFILE_UNAVAILABLE.equals(action) ||
366 Intent.ACTION_MANAGED_PROFILE_UNLOCKED.equals(action)) {
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700367 enqueueModelUpdateTask(new UserLockStateChangedTask(user));
Sunny Goyald3b87ef2016-07-28 12:11:54 -0700368 }
Sunny Goyalda891c12016-03-18 18:29:24 -0700369 }
Sunny Goyal29947f02017-12-18 13:49:44 -0800370 } else if (IS_DOGFOOD_BUILD && ACTION_FORCE_ROLOAD.equals(action)) {
371 forceReload();
Joe Onoratoe9ad59e2010-10-29 17:35:36 -0700372 }
373 }
374
Tonyf80e8932018-12-21 11:58:04 -0800375 public void forceReload() {
376 forceReload(-1);
377 }
378
Sunny Goyaldd96a5e2017-02-17 11:22:34 -0800379 /**
380 * Reloads the workspace items from the DB and re-binds the workspace. This should generally
381 * not be called as DB updates are automatically followed by UI update
Tonyf80e8932018-12-21 11:58:04 -0800382 * @param synchronousBindPage The page to bind first. Can pass -1 to use the current page.
Sunny Goyaldd96a5e2017-02-17 11:22:34 -0800383 */
Tonyf80e8932018-12-21 11:58:04 -0800384 public void forceReload(int synchronousBindPage) {
Sunny Goyaldd96a5e2017-02-17 11:22:34 -0800385 synchronized (mLock) {
386 // Stop any existing loaders first, so they don't set mModelLoaded to true later
Sunny Goyale86f11f2017-06-06 14:33:18 -0700387 stopLoader();
Sunny Goyaldd96a5e2017-02-17 11:22:34 -0800388 mModelLoaded = false;
389 }
Winson Chungf0c6ae02012-03-21 16:10:31 -0700390
Sunny Goyal29947f02017-12-18 13:49:44 -0800391 // Start the loader if launcher is already running, otherwise the loader will run,
392 // the next time launcher starts
Sunny Goyale0f58d72014-11-10 18:05:31 -0800393 Callbacks callbacks = getCallback();
394 if (callbacks != null) {
Tonyf80e8932018-12-21 11:58:04 -0800395 if (synchronousBindPage < 0) {
396 synchronousBindPage = callbacks.getCurrentWorkspaceScreen();
397 }
398 startLoader(synchronousBindPage);
Joe Onoratoe9ad59e2010-10-29 17:35:36 -0700399 }
Joe Onorato36115782010-06-17 13:28:48 -0400400 }
Joe Onoratof99f8c12009-10-31 17:27:36 -0400401
Adam Cohen1a85c582014-09-30 09:48:49 -0700402 public boolean isCurrentCallbacks(Callbacks callbacks) {
403 return (mCallbacks != null && mCallbacks.get() == callbacks);
404 }
405
Sunny Goyalb5b9ad62016-04-02 11:23:39 -0700406 /**
407 * Starts the loader. Tries to bind {@params synchronousBindPage} synchronously if possible.
408 * @return true if the page could be bound synchronously.
409 */
410 public boolean startLoader(int synchronousBindPage) {
Vadim Tryshev14c6c8c2018-10-09 18:46:45 -0700411 if (com.android.launcher3.Utilities.IS_RUNNING_IN_TEST_HARNESS
412 && com.android.launcher3.Utilities.IS_DEBUG_DEVICE) {
413 android.util.Log.d("b/117332845",
414 android.util.Log.getStackTraceString(new Throwable()));
415 }
Sunny Goyal756adbc2015-04-16 15:20:51 -0700416 // Enable queue before starting loader. It will get disabled in Launcher#finishBindingItems
Sunny Goyala474a9b2017-05-04 16:47:11 -0700417 InstallShortcutReceiver.enableInstallQueue(InstallShortcutReceiver.FLAG_LOADER_RUNNING);
Joe Onorato36115782010-06-17 13:28:48 -0400418 synchronized (mLock) {
Joe Onorato36115782010-06-17 13:28:48 -0400419 // Don't bother to start the thread if we know it's not going to do anything
420 if (mCallbacks != null && mCallbacks.get() != null) {
Sunny Goyal527c7d32015-08-28 15:19:36 -0700421 final Callbacks oldCallbacks = mCallbacks.get();
422 // Clear any pending bind-runnables from the synchronized load process.
Sunny Goyal0e7724c2018-02-22 13:22:21 -0800423 mUiExecutor.execute(oldCallbacks::clearPendingBinds);
Sunny Goyal527c7d32015-08-28 15:19:36 -0700424
Joe Onorato36115782010-06-17 13:28:48 -0400425 // If there is already one running, tell it to stop.
Sunny Goyale86f11f2017-06-06 14:33:18 -0700426 stopLoader();
Sunny Goyalf8d6ed22017-06-01 14:26:38 -0700427 LoaderResults loaderResults = new LoaderResults(mApp, sBgDataModel,
428 mBgAllAppsList, synchronousBindPage, mCallbacks);
Sunny Goyale86f11f2017-06-06 14:33:18 -0700429 if (mModelLoaded && !mIsLoaderTaskRunning) {
Sunny Goyalf8d6ed22017-06-01 14:26:38 -0700430 // Divide the set of loaded items into those that we are binding synchronously,
431 // and everything else that is to be bound normally (asynchronously).
432 loaderResults.bindWorkspace();
433 // For now, continue posting the binding of AllApps as there are other
434 // issues that arise from that.
435 loaderResults.bindAllApps();
436 loaderResults.bindDeepShortcuts();
Sunny Goyalc6e97692017-06-02 13:46:55 -0700437 loaderResults.bindWidgets();
Sunny Goyalb5b9ad62016-04-02 11:23:39 -0700438 return true;
Winson Chungb8b2a5a2012-07-12 17:55:31 -0700439 } else {
Sunny Goyale86f11f2017-06-06 14:33:18 -0700440 startLoaderForResults(loaderResults);
Winson Chungb8b2a5a2012-07-12 17:55:31 -0700441 }
Joe Onorato9c1289c2009-08-17 11:03:03 -0400442 }
Joe Onorato9c1289c2009-08-17 11:03:03 -0400443 }
Sunny Goyalb5b9ad62016-04-02 11:23:39 -0700444 return false;
Joe Onorato9c1289c2009-08-17 11:03:03 -0400445 }
446
Sunny Goyale86f11f2017-06-06 14:33:18 -0700447 /**
448 * If there is already a loader task running, tell it to stop.
449 */
Joe Onorato36115782010-06-17 13:28:48 -0400450 public void stopLoader() {
451 synchronized (mLock) {
Sunny Goyale86f11f2017-06-06 14:33:18 -0700452 LoaderTask oldTask = mLoaderTask;
453 mLoaderTask = null;
454 if (oldTask != null) {
455 oldTask.stopLocked();
Joe Onorato9c1289c2009-08-17 11:03:03 -0400456 }
457 }
Joe Onorato36115782010-06-17 13:28:48 -0400458 }
Joe Onorato9c1289c2009-08-17 11:03:03 -0400459
Sunny Goyale86f11f2017-06-06 14:33:18 -0700460 public void startLoaderForResults(LoaderResults results) {
461 synchronized (mLock) {
462 stopLoader();
463 mLoaderTask = new LoaderTask(mApp, mBgAllAppsList, sBgDataModel, results);
464 runOnWorkerThread(mLoaderTask);
465 }
466 }
467
Winson Chungd6519662018-02-16 03:23:51 +0000468 public void startLoaderForResultsIfNotLoaded(LoaderResults results) {
469 synchronized (mLock) {
470 if (!isModelLoaded()) {
471 Log.d(TAG, "Workspace not loaded, loading now");
472 startLoaderForResults(results);
473 }
474 }
475 }
476
Mario Bertschler817afa32017-03-15 11:56:47 -0700477 public void onInstallSessionCreated(final PackageInstallInfo sessionInfo) {
Sunny Goyale86f11f2017-06-06 14:33:18 -0700478 enqueueModelUpdateTask(new BaseModelUpdateTask() {
Mario Bertschler817afa32017-03-15 11:56:47 -0700479 @Override
480 public void execute(LauncherAppState app, BgDataModel dataModel, AllAppsList apps) {
481 apps.addPromiseApp(app.getContext(), sessionInfo);
482 if (!apps.added.isEmpty()) {
483 final ArrayList<AppInfo> arrayList = new ArrayList<>(apps.added);
484 apps.added.clear();
485 scheduleCallbackTask(new CallbackTask() {
486 @Override
487 public void execute(Callbacks callbacks) {
Sunny Goyalb23980c2017-08-17 07:45:25 -0700488 callbacks.bindAppsAddedOrUpdated(arrayList);
Mario Bertschler817afa32017-03-15 11:56:47 -0700489 }
490 });
491 }
492 }
493 });
494 }
495
Sunny Goyalc6e97692017-06-02 13:46:55 -0700496 public class LoaderTransaction implements AutoCloseable {
497
498 private final LoaderTask mTask;
499
500 private LoaderTransaction(LoaderTask task) throws CancellationException {
501 synchronized (mLock) {
502 if (mLoaderTask != task) {
503 throw new CancellationException("Loader already stopped");
504 }
505 mTask = task;
506 mIsLoaderTaskRunning = true;
507 mModelLoaded = false;
508 }
509 }
510
511 public void commit() {
512 synchronized (mLock) {
513 // Everything loaded bind the data.
514 mModelLoaded = true;
Vadim Trysheva7da86e2018-10-05 20:03:57 -0700515 if (com.android.launcher3.Utilities.IS_RUNNING_IN_TEST_HARNESS
516 && com.android.launcher3.Utilities.IS_DEBUG_DEVICE) {
517 android.util.Log.d("b/117332845",
518 android.util.Log.getStackTraceString(new Throwable()));
519 }
Sunny Goyalc6e97692017-06-02 13:46:55 -0700520 }
521 }
522
523 @Override
524 public void close() {
525 synchronized (mLock) {
526 // If we are still the last one to be scheduled, remove ourselves.
527 if (mLoaderTask == mTask) {
528 mLoaderTask = null;
529 }
530 mIsLoaderTaskRunning = false;
531 }
532 }
533 }
534
535 public LoaderTransaction beginLoader(LoaderTask task) throws CancellationException {
536 return new LoaderTransaction(task);
537 }
538
Joe Onorato36115782010-06-17 13:28:48 -0400539 /**
Sunny Goyal95f3d6b2016-08-10 16:09:29 -0700540 * Refreshes the cached shortcuts if the shortcut permission has changed.
541 * Current implementation simply reloads the workspace, but it can be optimized to
542 * use partial updates similar to {@link UserManagerCompat}
543 */
544 public void refreshShortcutsIfRequired() {
Sunny Goyal8c48d8b2019-01-25 15:10:18 -0800545 sWorker.removeCallbacks(mShortcutPermissionCheckRunnable);
546 sWorker.post(mShortcutPermissionCheckRunnable);
Sunny Goyal95f3d6b2016-08-10 16:09:29 -0700547 }
548
549 /**
Sunny Goyal75b0f552015-05-20 21:57:06 -0700550 * Called when the icons for packages have been updated in the icon cache.
551 */
Sunny Goyal7c74e4a2016-12-15 15:53:17 -0800552 public void onPackageIconsUpdated(HashSet<String> updatedPackages, UserHandle user) {
Sunny Goyal75b0f552015-05-20 21:57:06 -0700553 // If any package icon has changed (app was updated while launcher was dead),
554 // update the corresponding shortcuts.
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700555 enqueueModelUpdateTask(new CacheDataUpdatedTask(
556 CacheDataUpdatedTask.OP_CACHE_UPDATE, user, updatedPackages));
Sunny Goyal75b0f552015-05-20 21:57:06 -0700557 }
558
Sunny Goyalac8154a2018-09-26 12:00:30 -0700559 /**
560 * Called when the labels for the widgets has updated in the icon cache.
561 */
562 public void onWidgetLabelsUpdated(HashSet<String> updatedPackages, UserHandle user) {
563 enqueueModelUpdateTask(new BaseModelUpdateTask() {
564 @Override
565 public void execute(LauncherAppState app, BgDataModel dataModel, AllAppsList apps) {
566 dataModel.widgetsModel.onPackageIconsUpdated(updatedPackages, user, app);
567 bindUpdatedWidgets(dataModel);
568 }
569 });
570 }
571
Sunny Goyale86f11f2017-06-06 14:33:18 -0700572 public void enqueueModelUpdateTask(ModelUpdateTask task) {
573 task.init(mApp, this, sBgDataModel, mBgAllAppsList, mUiExecutor);
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700574 runOnWorkerThread(task);
Sunny Goyald3b87ef2016-07-28 12:11:54 -0700575 }
576
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700577 /**
578 * A task to be executed on the current callbacks on the UI thread.
579 * If there is no current callbacks, the task is ignored.
580 */
581 public interface CallbackTask {
Tony Wickhambfbf7f92016-05-19 11:19:39 -0700582
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700583 void execute(Callbacks callbacks);
Tony Wickhambfbf7f92016-05-19 11:19:39 -0700584 }
585
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700586 /**
587 * A runnable which changes/updates the data model of the launcher based on certain events.
588 */
Sunny Goyale86f11f2017-06-06 14:33:18 -0700589 public interface ModelUpdateTask extends Runnable {
Joe Onorato36115782010-06-17 13:28:48 -0400590
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700591 /**
Sunny Goyale86f11f2017-06-06 14:33:18 -0700592 * Called before the task is posted to initialize the internal state.
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700593 */
Sunny Goyale86f11f2017-06-06 14:33:18 -0700594 void init(LauncherAppState app, LauncherModel model,
595 BgDataModel dataModel, AllAppsList allAppsList, Executor uiExecutor);
Sunny Goyale0f58d72014-11-10 18:05:31 -0800596
Sunny Goyal2e1efb42016-03-03 16:58:55 -0800597 }
598
Sunny Goyal1b072632017-01-18 11:30:23 -0800599 public void updateAndBindShortcutInfo(final ShortcutInfo si, final ShortcutInfoCompat info) {
Sunny Goyal83fd25e2018-07-09 16:47:01 -0700600 updateAndBindShortcutInfo(() -> {
601 si.updateFromDeepShortcutInfo(info, mApp.getContext());
602 LauncherIcons li = LauncherIcons.obtain(mApp.getContext());
Hyunyoung Songcda96a52018-10-18 15:05:45 -0700603 si.applyFrom(li.createShortcutIcon(info));
Sunny Goyal83fd25e2018-07-09 16:47:01 -0700604 li.recycle();
605 return si;
Sunny Goyal1b072632017-01-18 11:30:23 -0800606 });
607 }
608
Sunny Goyal10923b32016-07-20 15:42:44 -0700609 /**
Sunny Goyal1cc1c9a2017-01-06 16:32:57 -0800610 * Utility method to update a shortcut on the background thread.
Sunny Goyal10923b32016-07-20 15:42:44 -0700611 */
Sunny Goyal8c48d8b2019-01-25 15:10:18 -0800612 public void updateAndBindShortcutInfo(final Supplier<ShortcutInfo> shortcutProvider) {
Sunny Goyale86f11f2017-06-06 14:33:18 -0700613 enqueueModelUpdateTask(new BaseModelUpdateTask() {
Sunny Goyal10923b32016-07-20 15:42:44 -0700614 @Override
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700615 public void execute(LauncherAppState app, BgDataModel dataModel, AllAppsList apps) {
Sunny Goyal1cc1c9a2017-01-06 16:32:57 -0800616 ShortcutInfo info = shortcutProvider.get();
Sunny Goyalf266deb2018-06-21 09:59:08 -0700617 getModelWriter().updateItemInDatabase(info);
Sunny Goyalf0ba8b72016-09-09 15:47:55 -0700618 ArrayList<ShortcutInfo> update = new ArrayList<>();
Sunny Goyal10923b32016-07-20 15:42:44 -0700619 update.add(info);
Sunny Goyal1cc1c9a2017-01-06 16:32:57 -0800620 bindUpdatedShortcuts(update, info.user);
Sunny Goyal10923b32016-07-20 15:42:44 -0700621 }
622 });
623 }
624
Sunny Goyalc6e97692017-06-02 13:46:55 -0700625 public void refreshAndBindWidgetsAndShortcuts(@Nullable final PackageUserKey packageUser) {
Sunny Goyale86f11f2017-06-06 14:33:18 -0700626 enqueueModelUpdateTask(new BaseModelUpdateTask() {
Sunny Goyal2e1efb42016-03-03 16:58:55 -0800627 @Override
Sunny Goyalc6e97692017-06-02 13:46:55 -0700628 public void execute(LauncherAppState app, BgDataModel dataModel, AllAppsList apps) {
629 dataModel.widgetsModel.update(app, packageUser);
630 bindUpdatedWidgets(dataModel);
Sunny Goyal31860582015-09-18 08:38:57 -0700631 }
Sunny Goyal2e1efb42016-03-03 16:58:55 -0800632 });
Michael Jurkac402cd92013-05-20 15:49:32 +0200633 }
634
Hyunyoung Song3c7d9cb2017-01-30 15:11:27 -0800635 public void dumpState(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) {
636 if (args.length > 0 && TextUtils.equals(args[0], "--all")) {
637 writer.println(prefix + "All apps list: size=" + mBgAllAppsList.data.size());
638 for (AppInfo info : mBgAllAppsList.data) {
639 writer.println(prefix + " title=\"" + info.title + "\" iconBitmap=" + info.iconBitmap
640 + " componentName=" + info.componentName.getPackageName());
641 }
Joe Onorato36115782010-06-17 13:28:48 -0400642 }
Hyunyoung Song3c7d9cb2017-01-30 15:11:27 -0800643 sBgDataModel.dump(prefix, fd, writer, args);
Joe Onoratobe386092009-11-17 17:32:16 -0800644 }
Sunny Goyale0f58d72014-11-10 18:05:31 -0800645
646 public Callbacks getCallback() {
647 return mCallbacks != null ? mCallbacks.get() : null;
648 }
Sunny Goyal18bf8e22015-04-08 18:13:46 -0700649
650 /**
Sunny Goyal756adbc2015-04-16 15:20:51 -0700651 * @return the looper for the worker thread which can be used to start background tasks.
652 */
653 public static Looper getWorkerLooper() {
Sunny Goyal06a07e92018-11-07 16:54:02 -0800654 return mWorkerLooper;
Sunny Goyal756adbc2015-04-16 15:20:51 -0700655 }
Tony2917a8b2017-07-31 23:29:42 -0700656
657 public static void setWorkerPriority(final int priority) {
658 Process.setThreadPriority(sWorkerThread.getThreadId(), priority);
659 }
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800660}