blob: 9db694944970b27eefa4a32c632a64b21dc4db08 [file] [log] [blame]
Sunny Goyal0fe505b2014-08-06 09:55:36 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.launcher3;
18
19import android.appwidget.AppWidgetHost;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070020import android.content.ComponentName;
21import android.content.ContentValues;
22import android.content.Context;
23import android.content.Intent;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.res.Resources;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070027import android.database.sqlite.SQLiteDatabase;
28import android.graphics.drawable.Drawable;
29import android.net.Uri;
Sunny Goyal179249d2017-12-19 16:49:24 -080030import android.os.Build.VERSION;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070031import android.os.Bundle;
Sunny Goyalad7ff442017-09-12 12:42:26 -070032import android.os.Process;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070033import android.text.TextUtils;
Rajeev Kumar26453a22017-06-09 16:02:25 -070034import android.util.ArrayMap;
Sunny Goyal0d742312019-03-04 20:22:26 -080035import android.util.AttributeSet;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070036import android.util.Log;
37import android.util.Pair;
38import android.util.Patterns;
Sunny Goyal0d742312019-03-04 20:22:26 -080039import android.util.Xml;
Sunny Goyal36b54222018-07-10 13:50:50 -070040
Sunny Goyal0fe505b2014-08-06 09:55:36 -070041import com.android.launcher3.LauncherProvider.SqlArguments;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070042import com.android.launcher3.LauncherSettings.Favorites;
Sunny Goyale62d2bb2018-11-06 10:28:37 -080043import com.android.launcher3.icons.GraphicsUtils;
Hyunyoung Song48cb7bc2018-09-25 17:03:34 -070044import com.android.launcher3.icons.LauncherIcons;
Sunny Goyalefb7e842018-10-04 15:11:00 -070045import com.android.launcher3.util.IntArray;
Sunny Goyal9dbb27c2019-07-17 15:12:56 -070046import com.android.launcher3.util.PackageManagerHelper;
Adam Cohen091440a2015-03-18 14:16:05 -070047import com.android.launcher3.util.Thunk;
Sunny Goyal36b54222018-07-10 13:50:50 -070048
49import org.xmlpull.v1.XmlPullParser;
50import org.xmlpull.v1.XmlPullParserException;
51
Sunny Goyal0fe505b2014-08-06 09:55:36 -070052import java.io.IOException;
Sunny Goyalb2d46ce2015-03-26 11:32:11 -070053import java.util.Locale;
Sunny Goyalc0f03d92019-03-22 14:13:36 -070054import java.util.function.Supplier;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070055
56/**
Sunny Goyal3a5a9d12014-10-01 15:33:41 -070057 * Layout parsing code for auto installs layout
Sunny Goyal0fe505b2014-08-06 09:55:36 -070058 */
Sunny Goyal3a5a9d12014-10-01 15:33:41 -070059public class AutoInstallsLayout {
Sunny Goyal0fe505b2014-08-06 09:55:36 -070060 private static final String TAG = "AutoInstalls";
Sunny Goyal3a5a9d12014-10-01 15:33:41 -070061 private static final boolean LOGD = false;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070062
63 /** Marker action used to discover a package which defines launcher customization */
64 static final String ACTION_LAUNCHER_CUSTOMIZATION =
Sunny Goyal2233c882014-09-18 14:36:48 -070065 "android.autoinstalls.config.action.PLAY_AUTO_INSTALL";
Sunny Goyal0fe505b2014-08-06 09:55:36 -070066
Sunny Goyalb2d46ce2015-03-26 11:32:11 -070067 /**
68 * Layout resource which also includes grid size and hotseat count, e.g., default_layout_6x6_h5
69 */
70 private static final String FORMATTED_LAYOUT_RES_WITH_HOSTEAT = "default_layout_%dx%d_h%s";
71 private static final String FORMATTED_LAYOUT_RES = "default_layout_%dx%d";
Sunny Goyal0fe505b2014-08-06 09:55:36 -070072 private static final String LAYOUT_RES = "default_layout";
73
74 static AutoInstallsLayout get(Context context, AppWidgetHost appWidgetHost,
75 LayoutParserCallback callback) {
Sunny Goyal9dbb27c2019-07-17 15:12:56 -070076 Pair<String, Resources> customizationApkInfo = PackageManagerHelper.findSystemApk(
Sunny Goyal0fe505b2014-08-06 09:55:36 -070077 ACTION_LAUNCHER_CUSTOMIZATION, context.getPackageManager());
78 if (customizationApkInfo == null) {
79 return null;
80 }
Sunny Goyalc0f03d92019-03-22 14:13:36 -070081 String pkg = customizationApkInfo.first;
82 Resources targetRes = customizationApkInfo.second;
Sunny Goyal87f784c2017-01-11 10:48:34 -080083 InvariantDeviceProfile grid = LauncherAppState.getIDP(context);
Sunny Goyalb2d46ce2015-03-26 11:32:11 -070084
85 // Try with grid size and hotseat count
86 String layoutName = String.format(Locale.ENGLISH, FORMATTED_LAYOUT_RES_WITH_HOSTEAT,
Rajeev Kumar26453a22017-06-09 16:02:25 -070087 grid.numColumns, grid.numRows, grid.numHotseatIcons);
Sunny Goyalb2d46ce2015-03-26 11:32:11 -070088 int layoutId = targetRes.getIdentifier(layoutName, "xml", pkg);
89
90 // Try with only grid size
91 if (layoutId == 0) {
92 Log.d(TAG, "Formatted layout: " + layoutName
93 + " not found. Trying layout without hosteat");
94 layoutName = String.format(Locale.ENGLISH, FORMATTED_LAYOUT_RES,
Rajeev Kumar26453a22017-06-09 16:02:25 -070095 grid.numColumns, grid.numRows);
Sunny Goyalb2d46ce2015-03-26 11:32:11 -070096 layoutId = targetRes.getIdentifier(layoutName, "xml", pkg);
97 }
98
99 // Try the default layout
100 if (layoutId == 0) {
101 Log.d(TAG, "Formatted layout: " + layoutName + " not found. Trying the default layout");
102 layoutId = targetRes.getIdentifier(LAYOUT_RES, "xml", pkg);
103 }
104
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700105 if (layoutId == 0) {
106 Log.e(TAG, "Layout definition not found in package: " + pkg);
107 return null;
108 }
Sunny Goyalb2d46ce2015-03-26 11:32:11 -0700109 return new AutoInstallsLayout(context, appWidgetHost, callback, targetRes, layoutId,
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700110 TAG_WORKSPACE);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700111 }
112
113 // Object Tags
Sunny Goyalb564efb2015-01-23 13:45:20 -0800114 private static final String TAG_INCLUDE = "include";
Sunny Goyalc0f03d92019-03-22 14:13:36 -0700115 public static final String TAG_WORKSPACE = "workspace";
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700116 private static final String TAG_APP_ICON = "appicon";
117 private static final String TAG_AUTO_INSTALL = "autoinstall";
118 private static final String TAG_FOLDER = "folder";
119 private static final String TAG_APPWIDGET = "appwidget";
120 private static final String TAG_SHORTCUT = "shortcut";
121 private static final String TAG_EXTRA = "extra";
122
123 private static final String ATTR_CONTAINER = "container";
124 private static final String ATTR_RANK = "rank";
125
126 private static final String ATTR_PACKAGE_NAME = "packageName";
127 private static final String ATTR_CLASS_NAME = "className";
128 private static final String ATTR_TITLE = "title";
129 private static final String ATTR_SCREEN = "screen";
Sunny Goyal96a09632015-12-16 11:32:54 -0800130
131 // x and y can be specified as negative integers, in which case -1 represents the
132 // last row / column, -2 represents the second last, and so on.
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700133 private static final String ATTR_X = "x";
134 private static final String ATTR_Y = "y";
Sunny Goyal96a09632015-12-16 11:32:54 -0800135
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700136 private static final String ATTR_SPAN_X = "spanX";
137 private static final String ATTR_SPAN_Y = "spanY";
138 private static final String ATTR_ICON = "icon";
139 private static final String ATTR_URL = "url";
140
Sunny Goyalb564efb2015-01-23 13:45:20 -0800141 // Attrs for "Include"
142 private static final String ATTR_WORKSPACE = "workspace";
143
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700144 // Style attrs -- "Extra"
145 private static final String ATTR_KEY = "key";
146 private static final String ATTR_VALUE = "value";
147
148 private static final String HOTSEAT_CONTAINER_NAME =
149 Favorites.containerToString(Favorites.CONTAINER_HOTSEAT);
150
Adam Cohen091440a2015-03-18 14:16:05 -0700151 @Thunk final Context mContext;
152 @Thunk final AppWidgetHost mAppWidgetHost;
Sunny Goyalbb3b02f2015-01-15 12:00:14 -0800153 protected final LayoutParserCallback mCallback;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700154
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700155 protected final PackageManager mPackageManager;
156 protected final Resources mSourceRes;
Sunny Goyalc0f03d92019-03-22 14:13:36 -0700157 protected final Supplier<XmlPullParser> mInitialLayoutSupplier;
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700158
Sunny Goyalbb011da2016-06-15 15:42:29 -0700159 private final InvariantDeviceProfile mIdp;
Sunny Goyal96a09632015-12-16 11:32:54 -0800160 private final int mRowCount;
161 private final int mColumnCount;
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700162
Sunny Goyalefb7e842018-10-04 15:11:00 -0700163 private final int[] mTemp = new int[2];
Adam Cohen091440a2015-03-18 14:16:05 -0700164 @Thunk final ContentValues mValues;
Sunny Goyalbb3b02f2015-01-15 12:00:14 -0800165 protected final String mRootTag;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700166
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700167 protected SQLiteDatabase mDb;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700168
169 public AutoInstallsLayout(Context context, AppWidgetHost appWidgetHost,
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700170 LayoutParserCallback callback, Resources res,
171 int layoutId, String rootTag) {
Sunny Goyalc0f03d92019-03-22 14:13:36 -0700172 this(context, appWidgetHost, callback, res, () -> res.getXml(layoutId), rootTag);
173 }
174
175 public AutoInstallsLayout(Context context, AppWidgetHost appWidgetHost,
176 LayoutParserCallback callback, Resources res,
177 Supplier<XmlPullParser> initialLayoutSupplier, String rootTag) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700178 mContext = context;
179 mAppWidgetHost = appWidgetHost;
180 mCallback = callback;
181
182 mPackageManager = context.getPackageManager();
183 mValues = new ContentValues();
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700184 mRootTag = rootTag;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700185
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700186 mSourceRes = res;
Sunny Goyalc0f03d92019-03-22 14:13:36 -0700187 mInitialLayoutSupplier = initialLayoutSupplier;
Sunny Goyal96a09632015-12-16 11:32:54 -0800188
Sunny Goyal87f784c2017-01-11 10:48:34 -0800189 mIdp = LauncherAppState.getIDP(context);
Sunny Goyalbb011da2016-06-15 15:42:29 -0700190 mRowCount = mIdp.numRows;
191 mColumnCount = mIdp.numColumns;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700192 }
193
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700194 /**
195 * Loads the layout in the db and returns the number of entries added on the desktop.
196 */
Sunny Goyalefb7e842018-10-04 15:11:00 -0700197 public int loadLayout(SQLiteDatabase db, IntArray screenIds) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700198 mDb = db;
199 try {
Sunny Goyalc0f03d92019-03-22 14:13:36 -0700200 return parseLayout(mInitialLayoutSupplier.get(), screenIds);
Sameer Padala8fd74832014-09-08 16:00:29 -0700201 } catch (Exception e) {
Sunny Goyalc0f03d92019-03-22 14:13:36 -0700202 Log.e(TAG, "Error parsing layout: ", e);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700203 return -1;
204 }
205 }
206
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700207 /**
208 * Parses the layout and returns the number of elements added on the homescreen.
209 */
Sunny Goyalc0f03d92019-03-22 14:13:36 -0700210 protected int parseLayout(XmlPullParser parser, IntArray screenIds)
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700211 throws XmlPullParserException, IOException {
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700212 beginDocument(parser, mRootTag);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700213 final int depth = parser.getDepth();
214 int type;
Rajeev Kumar26453a22017-06-09 16:02:25 -0700215 ArrayMap<String, TagParser> tagParserMap = getLayoutElementsMap();
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700216 int count = 0;
217
218 while (((type = parser.next()) != XmlPullParser.END_TAG ||
219 parser.getDepth() > depth) && type != XmlPullParser.END_DOCUMENT) {
220 if (type != XmlPullParser.START_TAG) {
221 continue;
222 }
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700223 count += parseAndAddNode(parser, tagParserMap, screenIds);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700224 }
225 return count;
226 }
227
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700228 /**
229 * Parses container and screenId attribute from the current tag, and puts it in the out.
230 * @param out array of size 2.
231 */
Sunny Goyal0d742312019-03-04 20:22:26 -0800232 protected void parseContainerAndScreen(XmlPullParser parser, int[] out) {
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700233 if (HOTSEAT_CONTAINER_NAME.equals(getAttributeValue(parser, ATTR_CONTAINER))) {
234 out[0] = Favorites.CONTAINER_HOTSEAT;
235 // Hack: hotseat items are stored using screen ids
Sunny Goyalefb7e842018-10-04 15:11:00 -0700236 out[1] = Integer.parseInt(getAttributeValue(parser, ATTR_RANK));
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700237 } else {
238 out[0] = Favorites.CONTAINER_DESKTOP;
Sunny Goyalefb7e842018-10-04 15:11:00 -0700239 out[1] = Integer.parseInt(getAttributeValue(parser, ATTR_SCREEN));
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700240 }
241 }
242
243 /**
244 * Parses the current node and returns the number of elements added.
245 */
246 protected int parseAndAddNode(
Sunny Goyal0d742312019-03-04 20:22:26 -0800247 XmlPullParser parser, ArrayMap<String, TagParser> tagParserMap, IntArray screenIds)
Rajeev Kumar26453a22017-06-09 16:02:25 -0700248 throws XmlPullParserException, IOException {
Sunny Goyalb564efb2015-01-23 13:45:20 -0800249
250 if (TAG_INCLUDE.equals(parser.getName())) {
251 final int resId = getAttributeResourceValue(parser, ATTR_WORKSPACE, 0);
252 if (resId != 0) {
253 // recursively load some more favorites, why not?
Sunny Goyalc0f03d92019-03-22 14:13:36 -0700254 return parseLayout(mSourceRes.getXml(resId), screenIds);
Sunny Goyalb564efb2015-01-23 13:45:20 -0800255 } else {
256 return 0;
257 }
258 }
259
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700260 mValues.clear();
261 parseContainerAndScreen(parser, mTemp);
Sunny Goyalefb7e842018-10-04 15:11:00 -0700262 final int container = mTemp[0];
263 final int screenId = mTemp[1];
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700264
265 mValues.put(Favorites.CONTAINER, container);
266 mValues.put(Favorites.SCREEN, screenId);
Sunny Goyal96a09632015-12-16 11:32:54 -0800267
268 mValues.put(Favorites.CELLX,
Sunny Goyalf82e5472016-01-06 15:09:22 -0800269 convertToDistanceFromEnd(getAttributeValue(parser, ATTR_X), mColumnCount));
Sunny Goyal96a09632015-12-16 11:32:54 -0800270 mValues.put(Favorites.CELLY,
Sunny Goyalf82e5472016-01-06 15:09:22 -0800271 convertToDistanceFromEnd(getAttributeValue(parser, ATTR_Y), mRowCount));
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700272
273 TagParser tagParser = tagParserMap.get(parser.getName());
274 if (tagParser == null) {
275 if (LOGD) Log.d(TAG, "Ignoring unknown element tag: " + parser.getName());
276 return 0;
277 }
Sunny Goyalefb7e842018-10-04 15:11:00 -0700278 int newElementId = tagParser.parseAndAdd(parser);
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700279 if (newElementId >= 0) {
280 // Keep track of the set of screens which need to be added to the db.
281 if (!screenIds.contains(screenId) &&
282 container == Favorites.CONTAINER_DESKTOP) {
283 screenIds.add(screenId);
284 }
285 return 1;
286 }
287 return 0;
288 }
289
Sunny Goyalefb7e842018-10-04 15:11:00 -0700290 protected int addShortcut(String title, Intent intent, int type) {
291 int id = mCallback.generateNewItemId();
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700292 mValues.put(Favorites.INTENT, intent.toUri(0));
293 mValues.put(Favorites.TITLE, title);
294 mValues.put(Favorites.ITEM_TYPE, type);
295 mValues.put(Favorites.SPANX, 1);
296 mValues.put(Favorites.SPANY, 1);
297 mValues.put(Favorites._ID, id);
298 if (mCallback.insertAndCheck(mDb, mValues) < 0) {
299 return -1;
300 } else {
301 return id;
302 }
303 }
304
Rajeev Kumar26453a22017-06-09 16:02:25 -0700305 protected ArrayMap<String, TagParser> getFolderElementsMap() {
306 ArrayMap<String, TagParser> parsers = new ArrayMap<>();
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700307 parsers.put(TAG_APP_ICON, new AppShortcutParser());
308 parsers.put(TAG_AUTO_INSTALL, new AutoInstallParser());
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700309 parsers.put(TAG_SHORTCUT, new ShortcutParser(mSourceRes));
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700310 return parsers;
311 }
312
Rajeev Kumar26453a22017-06-09 16:02:25 -0700313 protected ArrayMap<String, TagParser> getLayoutElementsMap() {
314 ArrayMap<String, TagParser> parsers = new ArrayMap<>();
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700315 parsers.put(TAG_APP_ICON, new AppShortcutParser());
316 parsers.put(TAG_AUTO_INSTALL, new AutoInstallParser());
317 parsers.put(TAG_FOLDER, new FolderParser());
Sunny Goyal86df1382016-08-10 15:03:22 -0700318 parsers.put(TAG_APPWIDGET, new PendingWidgetParser());
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700319 parsers.put(TAG_SHORTCUT, new ShortcutParser(mSourceRes));
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700320 return parsers;
321 }
322
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700323 protected interface TagParser {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700324 /**
325 * Parses the tag and adds to the db
326 * @return the id of the row added or -1;
327 */
Sunny Goyal0d742312019-03-04 20:22:26 -0800328 int parseAndAdd(XmlPullParser parser)
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700329 throws XmlPullParserException, IOException;
330 }
331
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700332 /**
333 * App shortcuts: required attributes packageName and className
334 */
335 protected class AppShortcutParser implements TagParser {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700336
337 @Override
Sunny Goyal0d742312019-03-04 20:22:26 -0800338 public int parseAndAdd(XmlPullParser parser) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700339 final String packageName = getAttributeValue(parser, ATTR_PACKAGE_NAME);
340 final String className = getAttributeValue(parser, ATTR_CLASS_NAME);
341
342 if (!TextUtils.isEmpty(packageName) && !TextUtils.isEmpty(className)) {
343 ActivityInfo info;
344 try {
345 ComponentName cn;
346 try {
347 cn = new ComponentName(packageName, className);
348 info = mPackageManager.getActivityInfo(cn, 0);
349 } catch (PackageManager.NameNotFoundException nnfe) {
350 String[] packages = mPackageManager.currentToCanonicalPackageNames(
351 new String[] { packageName });
352 cn = new ComponentName(packages[0], className);
353 info = mPackageManager.getActivityInfo(cn, 0);
354 }
355 final Intent intent = new Intent(Intent.ACTION_MAIN, null)
356 .addCategory(Intent.CATEGORY_LAUNCHER)
357 .setComponent(cn)
358 .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK |
359 Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
360
361 return addShortcut(info.loadLabel(mPackageManager).toString(),
362 intent, Favorites.ITEM_TYPE_APPLICATION);
363 } catch (PackageManager.NameNotFoundException e) {
Sunny Goyaleb3ba0f2017-03-27 11:22:36 -0700364 Log.e(TAG, "Favorite not found: " + packageName + "/" + className);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700365 }
366 return -1;
367 } else {
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700368 return invalidPackageOrClass(parser);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700369 }
370 }
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700371
372 /**
373 * Helper method to allow extending the parser capabilities
374 */
Sunny Goyal0d742312019-03-04 20:22:26 -0800375 protected int invalidPackageOrClass(XmlPullParser parser) {
Adam Cohencf0c7462015-08-06 14:02:23 -0700376 Log.w(TAG, "Skipping invalid <favorite> with no component");
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700377 return -1;
378 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700379 }
380
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700381 /**
382 * AutoInstall: required attributes packageName and className
383 */
384 protected class AutoInstallParser implements TagParser {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700385
386 @Override
Sunny Goyal0d742312019-03-04 20:22:26 -0800387 public int parseAndAdd(XmlPullParser parser) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700388 final String packageName = getAttributeValue(parser, ATTR_PACKAGE_NAME);
389 final String className = getAttributeValue(parser, ATTR_CLASS_NAME);
390 if (TextUtils.isEmpty(packageName) || TextUtils.isEmpty(className)) {
391 if (LOGD) Log.d(TAG, "Skipping invalid <favorite> with no component");
392 return -1;
393 }
394
Sunny Goyal95899162019-03-27 16:03:06 -0700395 mValues.put(Favorites.RESTORED, WorkspaceItemInfo.FLAG_AUTOINSTALL_ICON);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700396 final Intent intent = new Intent(Intent.ACTION_MAIN, null)
397 .addCategory(Intent.CATEGORY_LAUNCHER)
398 .setComponent(new ComponentName(packageName, className))
399 .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK |
400 Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
401 return addShortcut(mContext.getString(R.string.package_state_unknown), intent,
402 Favorites.ITEM_TYPE_APPLICATION);
403 }
404 }
405
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700406 /**
407 * Parses a web shortcut. Required attributes url, icon, title
408 */
409 protected class ShortcutParser implements TagParser {
410
411 private final Resources mIconRes;
412
413 public ShortcutParser(Resources iconRes) {
414 mIconRes = iconRes;
415 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700416
417 @Override
Sunny Goyal0d742312019-03-04 20:22:26 -0800418 public int parseAndAdd(XmlPullParser parser) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700419 final int titleResId = getAttributeResourceValue(parser, ATTR_TITLE, 0);
420 final int iconId = getAttributeResourceValue(parser, ATTR_ICON, 0);
421
422 if (titleResId == 0 || iconId == 0) {
423 if (LOGD) Log.d(TAG, "Ignoring shortcut");
424 return -1;
425 }
426
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700427 final Intent intent = parseIntent(parser);
428 if (intent == null) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700429 return -1;
430 }
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700431
432 Drawable icon = mIconRes.getDrawable(iconId);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700433 if (icon == null) {
434 if (LOGD) Log.d(TAG, "Ignoring shortcut, can't load icon");
435 return -1;
436 }
437
Sunny Goyalad7ff442017-09-12 12:42:26 -0700438 // Auto installs should always support the current platform version.
Sunny Goyal18a4e5a2018-01-09 15:34:38 -0800439 LauncherIcons li = LauncherIcons.obtain(mContext);
Sunny Goyale62d2bb2018-11-06 10:28:37 -0800440 mValues.put(LauncherSettings.Favorites.ICON, GraphicsUtils.flattenBitmap(
Sunny Goyal18a4e5a2018-01-09 15:34:38 -0800441 li.createBadgedIconBitmap(icon, Process.myUserHandle(), VERSION.SDK_INT).icon));
442 li.recycle();
443
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700444 mValues.put(Favorites.ICON_PACKAGE, mIconRes.getResourcePackageName(iconId));
445 mValues.put(Favorites.ICON_RESOURCE, mIconRes.getResourceName(iconId));
446
447 intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK |
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700448 Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700449 return addShortcut(mSourceRes.getString(titleResId),
450 intent, Favorites.ITEM_TYPE_SHORTCUT);
451 }
452
Sunny Goyal0d742312019-03-04 20:22:26 -0800453 protected Intent parseIntent(XmlPullParser parser) {
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700454 final String url = getAttributeValue(parser, ATTR_URL);
455 if (TextUtils.isEmpty(url) || !Patterns.WEB_URL.matcher(url).matches()) {
456 if (LOGD) Log.d(TAG, "Ignoring shortcut, invalid url: " + url);
457 return null;
458 }
459 return new Intent(Intent.ACTION_VIEW, null).setData(Uri.parse(url));
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700460 }
461 }
462
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700463 /**
464 * AppWidget parser: Required attributes packageName, className, spanX and spanY.
465 * Options child nodes: <extra key=... value=... />
Sunny Goyal86df1382016-08-10 15:03:22 -0700466 * It adds a pending widget which allows the widget to come later. If there are extras, those
467 * are passed to widget options during bind.
468 * The config activity for the widget (if present) is not shown, so any optional configurations
469 * should be passed as extras and the widget should support reading these widget options.
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700470 */
Sunny Goyal86df1382016-08-10 15:03:22 -0700471 protected class PendingWidgetParser implements TagParser {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700472
473 @Override
Sunny Goyal0d742312019-03-04 20:22:26 -0800474 public int parseAndAdd(XmlPullParser parser)
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700475 throws XmlPullParserException, IOException {
476 final String packageName = getAttributeValue(parser, ATTR_PACKAGE_NAME);
477 final String className = getAttributeValue(parser, ATTR_CLASS_NAME);
478 if (TextUtils.isEmpty(packageName) || TextUtils.isEmpty(className)) {
Sunny Goyal86df1382016-08-10 15:03:22 -0700479 if (LOGD) Log.d(TAG, "Skipping invalid <appwidget> with no component");
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700480 return -1;
481 }
482
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700483 mValues.put(Favorites.SPANX, getAttributeValue(parser, ATTR_SPAN_X));
484 mValues.put(Favorites.SPANY, getAttributeValue(parser, ATTR_SPAN_Y));
Sunny Goyal86df1382016-08-10 15:03:22 -0700485 mValues.put(Favorites.ITEM_TYPE, Favorites.ITEM_TYPE_APPWIDGET);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700486
487 // Read the extras
488 Bundle extras = new Bundle();
489 int widgetDepth = parser.getDepth();
490 int type;
491 while ((type = parser.next()) != XmlPullParser.END_TAG ||
492 parser.getDepth() > widgetDepth) {
493 if (type != XmlPullParser.START_TAG) {
494 continue;
495 }
496
497 if (TAG_EXTRA.equals(parser.getName())) {
498 String key = getAttributeValue(parser, ATTR_KEY);
499 String value = getAttributeValue(parser, ATTR_VALUE);
500 if (key != null && value != null) {
501 extras.putString(key, value);
502 } else {
503 throw new RuntimeException("Widget extras must have a key and value");
504 }
505 } else {
506 throw new RuntimeException("Widgets can contain only extras");
507 }
508 }
509
Sunny Goyal86df1382016-08-10 15:03:22 -0700510 return verifyAndInsert(new ComponentName(packageName, className), extras);
511 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700512
Sunny Goyalefb7e842018-10-04 15:11:00 -0700513 protected int verifyAndInsert(ComponentName cn, Bundle extras) {
Sunny Goyal86df1382016-08-10 15:03:22 -0700514 mValues.put(Favorites.APPWIDGET_PROVIDER, cn.flattenToString());
515 mValues.put(Favorites.RESTORED,
516 LauncherAppWidgetInfo.FLAG_ID_NOT_VALID |
517 LauncherAppWidgetInfo.FLAG_PROVIDER_NOT_READY |
518 LauncherAppWidgetInfo.FLAG_DIRECT_CONFIG);
519 mValues.put(Favorites._ID, mCallback.generateNewItemId());
520 if (!extras.isEmpty()) {
521 mValues.put(Favorites.INTENT, new Intent().putExtras(extras).toUri(0));
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700522 }
Sunny Goyal86df1382016-08-10 15:03:22 -0700523
Sunny Goyalefb7e842018-10-04 15:11:00 -0700524 int insertedId = mCallback.insertAndCheck(mDb, mValues);
Sunny Goyal86df1382016-08-10 15:03:22 -0700525 if (insertedId < 0) {
526 return -1;
527 } else {
528 return insertedId;
529 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700530 }
531 }
532
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700533 protected class FolderParser implements TagParser {
Rajeev Kumar26453a22017-06-09 16:02:25 -0700534 private final ArrayMap<String, TagParser> mFolderElements;
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700535
536 public FolderParser() {
537 this(getFolderElementsMap());
538 }
539
Rajeev Kumar26453a22017-06-09 16:02:25 -0700540 public FolderParser(ArrayMap<String, TagParser> elements) {
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700541 mFolderElements = elements;
542 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700543
544 @Override
Sunny Goyal0d742312019-03-04 20:22:26 -0800545 public int parseAndAdd(XmlPullParser parser)
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700546 throws XmlPullParserException, IOException {
547 final String title;
548 final int titleResId = getAttributeResourceValue(parser, ATTR_TITLE, 0);
549 if (titleResId != 0) {
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700550 title = mSourceRes.getString(titleResId);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700551 } else {
552 title = mContext.getResources().getString(R.string.folder_name);
553 }
554
555 mValues.put(Favorites.TITLE, title);
556 mValues.put(Favorites.ITEM_TYPE, Favorites.ITEM_TYPE_FOLDER);
557 mValues.put(Favorites.SPANX, 1);
558 mValues.put(Favorites.SPANY, 1);
559 mValues.put(Favorites._ID, mCallback.generateNewItemId());
Sunny Goyalefb7e842018-10-04 15:11:00 -0700560 int folderId = mCallback.insertAndCheck(mDb, mValues);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700561 if (folderId < 0) {
562 if (LOGD) Log.e(TAG, "Unable to add folder");
563 return -1;
564 }
565
566 final ContentValues myValues = new ContentValues(mValues);
Sunny Goyalefb7e842018-10-04 15:11:00 -0700567 IntArray folderItems = new IntArray();
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700568
569 int type;
570 int folderDepth = parser.getDepth();
Sunny Goyal56a57bb2015-07-06 11:15:45 -0700571 int rank = 0;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700572 while ((type = parser.next()) != XmlPullParser.END_TAG ||
573 parser.getDepth() > folderDepth) {
574 if (type != XmlPullParser.START_TAG) {
575 continue;
576 }
577 mValues.clear();
578 mValues.put(Favorites.CONTAINER, folderId);
Sunny Goyal56a57bb2015-07-06 11:15:45 -0700579 mValues.put(Favorites.RANK, rank);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700580
581 TagParser tagParser = mFolderElements.get(parser.getName());
582 if (tagParser != null) {
Sunny Goyalefb7e842018-10-04 15:11:00 -0700583 final int id = tagParser.parseAndAdd(parser);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700584 if (id >= 0) {
585 folderItems.add(id);
Sunny Goyal56a57bb2015-07-06 11:15:45 -0700586 rank++;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700587 }
588 } else {
589 throw new RuntimeException("Invalid folder item " + parser.getName());
590 }
591 }
592
Sunny Goyalefb7e842018-10-04 15:11:00 -0700593 int addedId = folderId;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700594
595 // We can only have folders with >= 2 items, so we need to remove the
596 // folder and clean up if less than 2 items were included, or some
597 // failed to add, and less than 2 were actually added
598 if (folderItems.size() < 2) {
599 // Delete the folder
Sunny Goyal1d4a2df2015-03-30 11:11:46 -0700600 Uri uri = Favorites.getContentUri(folderId);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700601 SqlArguments args = new SqlArguments(uri, null, null);
602 mDb.delete(args.table, args.where, args.args);
603 addedId = -1;
604
605 // If we have a single item, promote it to where the folder
606 // would have been.
607 if (folderItems.size() == 1) {
608 final ContentValues childValues = new ContentValues();
609 copyInteger(myValues, childValues, Favorites.CONTAINER);
610 copyInteger(myValues, childValues, Favorites.SCREEN);
611 copyInteger(myValues, childValues, Favorites.CELLX);
612 copyInteger(myValues, childValues, Favorites.CELLY);
613
614 addedId = folderItems.get(0);
Sunny Goyalb5b55c82016-05-10 12:28:59 -0700615 mDb.update(Favorites.TABLE_NAME, childValues,
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700616 Favorites._ID + "=" + addedId, null);
617 }
618 }
619 return addedId;
620 }
621 }
622
Rajeev Kumar26453a22017-06-09 16:02:25 -0700623 protected static void beginDocument(XmlPullParser parser, String firstElementName)
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700624 throws XmlPullParserException, IOException {
625 int type;
626 while ((type = parser.next()) != XmlPullParser.START_TAG
627 && type != XmlPullParser.END_DOCUMENT);
628
629 if (type != XmlPullParser.START_TAG) {
630 throw new XmlPullParserException("No start tag found");
631 }
632
633 if (!parser.getName().equals(firstElementName)) {
634 throw new XmlPullParserException("Unexpected start tag: found " + parser.getName() +
635 ", expected " + firstElementName);
636 }
637 }
638
Sunny Goyal96a09632015-12-16 11:32:54 -0800639 private static String convertToDistanceFromEnd(String value, int endValue) {
640 if (!TextUtils.isEmpty(value)) {
641 int x = Integer.parseInt(value);
642 if (x < 0) {
643 return Integer.toString(endValue + x);
644 }
645 }
646 return value;
647 }
648
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700649 /**
650 * Return attribute value, attempting launcher-specific namespace first
651 * before falling back to anonymous attribute.
652 */
Sunny Goyal0d742312019-03-04 20:22:26 -0800653 protected static String getAttributeValue(XmlPullParser parser, String attribute) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700654 String value = parser.getAttributeValue(
655 "http://schemas.android.com/apk/res-auto/com.android.launcher3", attribute);
656 if (value == null) {
657 value = parser.getAttributeValue(null, attribute);
658 }
659 return value;
660 }
661
662 /**
663 * Return attribute resource value, attempting launcher-specific namespace
664 * first before falling back to anonymous attribute.
665 */
Sunny Goyal0d742312019-03-04 20:22:26 -0800666 protected static int getAttributeResourceValue(XmlPullParser parser, String attribute,
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700667 int defaultValue) {
Sunny Goyal0d742312019-03-04 20:22:26 -0800668 AttributeSet attrs = Xml.asAttributeSet(parser);
669 int value = attrs.getAttributeResourceValue(
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700670 "http://schemas.android.com/apk/res-auto/com.android.launcher3", attribute,
671 defaultValue);
672 if (value == defaultValue) {
Sunny Goyal0d742312019-03-04 20:22:26 -0800673 value = attrs.getAttributeResourceValue(null, attribute, defaultValue);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700674 }
675 return value;
676 }
677
Rajeev Kumar26453a22017-06-09 16:02:25 -0700678 public interface LayoutParserCallback {
Sunny Goyalefb7e842018-10-04 15:11:00 -0700679 int generateNewItemId();
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700680
Sunny Goyalefb7e842018-10-04 15:11:00 -0700681 int insertAndCheck(SQLiteDatabase db, ContentValues values);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700682 }
683
Adam Cohen091440a2015-03-18 14:16:05 -0700684 @Thunk static void copyInteger(ContentValues from, ContentValues to, String key) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700685 to.put(key, from.getAsInteger(key));
686 }
687}