blob: d5309b4f063cba24df2c3f290282a06cf607c965 [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;
20import android.appwidget.AppWidgetManager;
21import android.content.ComponentName;
22import android.content.ContentValues;
23import android.content.Context;
24import android.content.Intent;
25import android.content.pm.ActivityInfo;
26import android.content.pm.PackageManager;
27import android.content.res.Resources;
28import android.content.res.XmlResourceParser;
29import android.database.sqlite.SQLiteDatabase;
30import android.graphics.drawable.Drawable;
31import android.net.Uri;
32import android.os.Bundle;
33import android.text.TextUtils;
34import android.util.Log;
35import android.util.Pair;
36import android.util.Patterns;
37
38import com.android.launcher3.LauncherProvider.SqlArguments;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070039import com.android.launcher3.LauncherSettings.Favorites;
Sunny Goyalbb011da2016-06-15 15:42:29 -070040import com.android.launcher3.config.FeatureFlags;
Adam Cohen091440a2015-03-18 14:16:05 -070041import com.android.launcher3.util.Thunk;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070042
43import org.xmlpull.v1.XmlPullParser;
44import org.xmlpull.v1.XmlPullParserException;
45
46import java.io.IOException;
47import java.util.ArrayList;
48import java.util.HashMap;
Sunny Goyalb2d46ce2015-03-26 11:32:11 -070049import java.util.Locale;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070050
51/**
Sunny Goyal3a5a9d12014-10-01 15:33:41 -070052 * Layout parsing code for auto installs layout
Sunny Goyal0fe505b2014-08-06 09:55:36 -070053 */
Sunny Goyal3a5a9d12014-10-01 15:33:41 -070054public class AutoInstallsLayout {
Sunny Goyal0fe505b2014-08-06 09:55:36 -070055 private static final String TAG = "AutoInstalls";
Sunny Goyal3a5a9d12014-10-01 15:33:41 -070056 private static final boolean LOGD = false;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070057
58 /** Marker action used to discover a package which defines launcher customization */
59 static final String ACTION_LAUNCHER_CUSTOMIZATION =
Sunny Goyal2233c882014-09-18 14:36:48 -070060 "android.autoinstalls.config.action.PLAY_AUTO_INSTALL";
Sunny Goyal0fe505b2014-08-06 09:55:36 -070061
Sunny Goyalb2d46ce2015-03-26 11:32:11 -070062 /**
63 * Layout resource which also includes grid size and hotseat count, e.g., default_layout_6x6_h5
64 */
65 private static final String FORMATTED_LAYOUT_RES_WITH_HOSTEAT = "default_layout_%dx%d_h%s";
66 private static final String FORMATTED_LAYOUT_RES = "default_layout_%dx%d";
Sunny Goyal0fe505b2014-08-06 09:55:36 -070067 private static final String LAYOUT_RES = "default_layout";
68
69 static AutoInstallsLayout get(Context context, AppWidgetHost appWidgetHost,
70 LayoutParserCallback callback) {
71 Pair<String, Resources> customizationApkInfo = Utilities.findSystemApk(
72 ACTION_LAUNCHER_CUSTOMIZATION, context.getPackageManager());
73 if (customizationApkInfo == null) {
74 return null;
75 }
Sunny Goyalb2d46ce2015-03-26 11:32:11 -070076 return get(context, customizationApkInfo.first, customizationApkInfo.second,
77 appWidgetHost, callback);
78 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -070079
Sunny Goyalb2d46ce2015-03-26 11:32:11 -070080 static AutoInstallsLayout get(Context context, String pkg, Resources targetRes,
81 AppWidgetHost appWidgetHost, LayoutParserCallback callback) {
Adam Cohen2e6da152015-05-06 11:42:25 -070082 InvariantDeviceProfile grid = LauncherAppState.getInstance().getInvariantDeviceProfile();
Sunny Goyalb2d46ce2015-03-26 11:32:11 -070083
84 // Try with grid size and hotseat count
85 String layoutName = String.format(Locale.ENGLISH, FORMATTED_LAYOUT_RES_WITH_HOSTEAT,
86 (int) grid.numColumns, (int) grid.numRows, (int) grid.numHotseatIcons);
87 int layoutId = targetRes.getIdentifier(layoutName, "xml", pkg);
88
89 // Try with only grid size
90 if (layoutId == 0) {
91 Log.d(TAG, "Formatted layout: " + layoutName
92 + " not found. Trying layout without hosteat");
93 layoutName = String.format(Locale.ENGLISH, FORMATTED_LAYOUT_RES,
94 (int) grid.numColumns, (int) grid.numRows);
95 layoutId = targetRes.getIdentifier(layoutName, "xml", pkg);
96 }
97
98 // Try the default layout
99 if (layoutId == 0) {
100 Log.d(TAG, "Formatted layout: " + layoutName + " not found. Trying the default layout");
101 layoutId = targetRes.getIdentifier(LAYOUT_RES, "xml", pkg);
102 }
103
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700104 if (layoutId == 0) {
105 Log.e(TAG, "Layout definition not found in package: " + pkg);
106 return null;
107 }
Sunny Goyalb2d46ce2015-03-26 11:32:11 -0700108 return new AutoInstallsLayout(context, appWidgetHost, callback, targetRes, layoutId,
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700109 TAG_WORKSPACE);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700110 }
111
112 // Object Tags
Sunny Goyalb564efb2015-01-23 13:45:20 -0800113 private static final String TAG_INCLUDE = "include";
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700114 private static final String TAG_WORKSPACE = "workspace";
115 private static final String TAG_APP_ICON = "appicon";
116 private static final String TAG_AUTO_INSTALL = "autoinstall";
117 private static final String TAG_FOLDER = "folder";
118 private static final String TAG_APPWIDGET = "appwidget";
119 private static final String TAG_SHORTCUT = "shortcut";
120 private static final String TAG_EXTRA = "extra";
121
122 private static final String ATTR_CONTAINER = "container";
123 private static final String ATTR_RANK = "rank";
124
125 private static final String ATTR_PACKAGE_NAME = "packageName";
126 private static final String ATTR_CLASS_NAME = "className";
127 private static final String ATTR_TITLE = "title";
128 private static final String ATTR_SCREEN = "screen";
Sunny Goyal96a09632015-12-16 11:32:54 -0800129
130 // x and y can be specified as negative integers, in which case -1 represents the
131 // last row / column, -2 represents the second last, and so on.
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700132 private static final String ATTR_X = "x";
133 private static final String ATTR_Y = "y";
Sunny Goyal96a09632015-12-16 11:32:54 -0800134
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700135 private static final String ATTR_SPAN_X = "spanX";
136 private static final String ATTR_SPAN_Y = "spanY";
137 private static final String ATTR_ICON = "icon";
138 private static final String ATTR_URL = "url";
139
Sunny Goyalb564efb2015-01-23 13:45:20 -0800140 // Attrs for "Include"
141 private static final String ATTR_WORKSPACE = "workspace";
142
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700143 // Style attrs -- "Extra"
144 private static final String ATTR_KEY = "key";
145 private static final String ATTR_VALUE = "value";
146
147 private static final String HOTSEAT_CONTAINER_NAME =
148 Favorites.containerToString(Favorites.CONTAINER_HOTSEAT);
149
150 private static final String ACTION_APPWIDGET_DEFAULT_WORKSPACE_CONFIGURE =
151 "com.android.launcher.action.APPWIDGET_DEFAULT_WORKSPACE_CONFIGURE";
152
Adam Cohen091440a2015-03-18 14:16:05 -0700153 @Thunk final Context mContext;
154 @Thunk final AppWidgetHost mAppWidgetHost;
Sunny Goyalbb3b02f2015-01-15 12:00:14 -0800155 protected final LayoutParserCallback mCallback;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700156
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700157 protected final PackageManager mPackageManager;
158 protected final Resources mSourceRes;
159 protected final int mLayoutId;
160
Sunny Goyalbb011da2016-06-15 15:42:29 -0700161 private final InvariantDeviceProfile mIdp;
Sunny Goyal96a09632015-12-16 11:32:54 -0800162 private final int mRowCount;
163 private final int mColumnCount;
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700164
165 private final long[] mTemp = new long[2];
Adam Cohen091440a2015-03-18 14:16:05 -0700166 @Thunk final ContentValues mValues;
Sunny Goyalbb3b02f2015-01-15 12:00:14 -0800167 protected final String mRootTag;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700168
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700169 protected SQLiteDatabase mDb;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700170
171 public AutoInstallsLayout(Context context, AppWidgetHost appWidgetHost,
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700172 LayoutParserCallback callback, Resources res,
173 int layoutId, String rootTag) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700174 mContext = context;
175 mAppWidgetHost = appWidgetHost;
176 mCallback = callback;
177
178 mPackageManager = context.getPackageManager();
179 mValues = new ContentValues();
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700180 mRootTag = rootTag;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700181
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700182 mSourceRes = res;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700183 mLayoutId = layoutId;
Sunny Goyal96a09632015-12-16 11:32:54 -0800184
Sunny Goyalbb011da2016-06-15 15:42:29 -0700185 mIdp = LauncherAppState.getInstance().getInvariantDeviceProfile();
186 mRowCount = mIdp.numRows;
187 mColumnCount = mIdp.numColumns;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700188 }
189
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700190 /**
191 * Loads the layout in the db and returns the number of entries added on the desktop.
192 */
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700193 public int loadLayout(SQLiteDatabase db, ArrayList<Long> screenIds) {
194 mDb = db;
195 try {
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700196 return parseLayout(mLayoutId, screenIds);
Sameer Padala8fd74832014-09-08 16:00:29 -0700197 } catch (Exception e) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700198 Log.w(TAG, "Got exception parsing layout.", e);
199 return -1;
200 }
201 }
202
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700203 /**
204 * Parses the layout and returns the number of elements added on the homescreen.
205 */
206 protected int parseLayout(int layoutId, ArrayList<Long> screenIds)
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700207 throws XmlPullParserException, IOException {
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700208 XmlResourceParser parser = mSourceRes.getXml(layoutId);
209 beginDocument(parser, mRootTag);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700210 final int depth = parser.getDepth();
211 int type;
212 HashMap<String, TagParser> tagParserMap = getLayoutElementsMap();
213 int count = 0;
214
215 while (((type = parser.next()) != XmlPullParser.END_TAG ||
216 parser.getDepth() > depth) && type != XmlPullParser.END_DOCUMENT) {
217 if (type != XmlPullParser.START_TAG) {
218 continue;
219 }
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700220 count += parseAndAddNode(parser, tagParserMap, screenIds);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700221 }
222 return count;
223 }
224
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700225 /**
226 * Parses container and screenId attribute from the current tag, and puts it in the out.
227 * @param out array of size 2.
228 */
229 protected void parseContainerAndScreen(XmlResourceParser parser, long[] out) {
230 if (HOTSEAT_CONTAINER_NAME.equals(getAttributeValue(parser, ATTR_CONTAINER))) {
231 out[0] = Favorites.CONTAINER_HOTSEAT;
232 // Hack: hotseat items are stored using screen ids
233 long rank = Long.parseLong(getAttributeValue(parser, ATTR_RANK));
Sunny Goyalbb011da2016-06-15 15:42:29 -0700234 out[1] = (FeatureFlags.NO_ALL_APPS_ICON || rank < mIdp.getAllAppsButtonRank())
235 ? rank : (rank + 1);
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700236 } else {
237 out[0] = Favorites.CONTAINER_DESKTOP;
238 out[1] = Long.parseLong(getAttributeValue(parser, ATTR_SCREEN));
239 }
240 }
241
242 /**
243 * Parses the current node and returns the number of elements added.
244 */
245 protected int parseAndAddNode(
246 XmlResourceParser parser,
247 HashMap<String, TagParser> tagParserMap,
248 ArrayList<Long> screenIds)
249 throws XmlPullParserException, IOException {
Sunny Goyalb564efb2015-01-23 13:45:20 -0800250
251 if (TAG_INCLUDE.equals(parser.getName())) {
252 final int resId = getAttributeResourceValue(parser, ATTR_WORKSPACE, 0);
253 if (resId != 0) {
254 // recursively load some more favorites, why not?
255 return parseLayout(resId, screenIds);
256 } else {
257 return 0;
258 }
259 }
260
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700261 mValues.clear();
262 parseContainerAndScreen(parser, mTemp);
263 final long container = mTemp[0];
264 final long screenId = mTemp[1];
265
266 mValues.put(Favorites.CONTAINER, container);
267 mValues.put(Favorites.SCREEN, screenId);
Sunny Goyal96a09632015-12-16 11:32:54 -0800268
269 mValues.put(Favorites.CELLX,
Sunny Goyalf82e5472016-01-06 15:09:22 -0800270 convertToDistanceFromEnd(getAttributeValue(parser, ATTR_X), mColumnCount));
Sunny Goyal96a09632015-12-16 11:32:54 -0800271 mValues.put(Favorites.CELLY,
Sunny Goyalf82e5472016-01-06 15:09:22 -0800272 convertToDistanceFromEnd(getAttributeValue(parser, ATTR_Y), mRowCount));
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700273
274 TagParser tagParser = tagParserMap.get(parser.getName());
275 if (tagParser == null) {
276 if (LOGD) Log.d(TAG, "Ignoring unknown element tag: " + parser.getName());
277 return 0;
278 }
279 long newElementId = tagParser.parseAndAdd(parser);
280 if (newElementId >= 0) {
281 // Keep track of the set of screens which need to be added to the db.
282 if (!screenIds.contains(screenId) &&
283 container == Favorites.CONTAINER_DESKTOP) {
284 screenIds.add(screenId);
285 }
286 return 1;
287 }
288 return 0;
289 }
290
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700291 protected long addShortcut(String title, Intent intent, int type) {
292 long id = mCallback.generateNewItemId();
293 mValues.put(Favorites.INTENT, intent.toUri(0));
294 mValues.put(Favorites.TITLE, title);
295 mValues.put(Favorites.ITEM_TYPE, type);
296 mValues.put(Favorites.SPANX, 1);
297 mValues.put(Favorites.SPANY, 1);
298 mValues.put(Favorites._ID, id);
299 if (mCallback.insertAndCheck(mDb, mValues) < 0) {
300 return -1;
301 } else {
302 return id;
303 }
304 }
305
306 protected HashMap<String, TagParser> getFolderElementsMap() {
307 HashMap<String, TagParser> parsers = new HashMap<String, TagParser>();
308 parsers.put(TAG_APP_ICON, new AppShortcutParser());
309 parsers.put(TAG_AUTO_INSTALL, new AutoInstallParser());
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700310 parsers.put(TAG_SHORTCUT, new ShortcutParser(mSourceRes));
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700311 return parsers;
312 }
313
314 protected HashMap<String, TagParser> getLayoutElementsMap() {
315 HashMap<String, TagParser> parsers = new HashMap<String, TagParser>();
316 parsers.put(TAG_APP_ICON, new AppShortcutParser());
317 parsers.put(TAG_AUTO_INSTALL, new AutoInstallParser());
318 parsers.put(TAG_FOLDER, new FolderParser());
Sunny Goyal86df1382016-08-10 15:03:22 -0700319 parsers.put(TAG_APPWIDGET, new PendingWidgetParser());
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700320 parsers.put(TAG_SHORTCUT, new ShortcutParser(mSourceRes));
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700321 return parsers;
322 }
323
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700324 protected interface TagParser {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700325 /**
326 * Parses the tag and adds to the db
327 * @return the id of the row added or -1;
328 */
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700329 long parseAndAdd(XmlResourceParser parser)
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700330 throws XmlPullParserException, IOException;
331 }
332
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700333 /**
334 * App shortcuts: required attributes packageName and className
335 */
336 protected class AppShortcutParser implements TagParser {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700337
338 @Override
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700339 public long parseAndAdd(XmlResourceParser parser) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700340 final String packageName = getAttributeValue(parser, ATTR_PACKAGE_NAME);
341 final String className = getAttributeValue(parser, ATTR_CLASS_NAME);
342
343 if (!TextUtils.isEmpty(packageName) && !TextUtils.isEmpty(className)) {
344 ActivityInfo info;
345 try {
346 ComponentName cn;
347 try {
348 cn = new ComponentName(packageName, className);
349 info = mPackageManager.getActivityInfo(cn, 0);
350 } catch (PackageManager.NameNotFoundException nnfe) {
351 String[] packages = mPackageManager.currentToCanonicalPackageNames(
352 new String[] { packageName });
353 cn = new ComponentName(packages[0], className);
354 info = mPackageManager.getActivityInfo(cn, 0);
355 }
356 final Intent intent = new Intent(Intent.ACTION_MAIN, null)
357 .addCategory(Intent.CATEGORY_LAUNCHER)
358 .setComponent(cn)
359 .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK |
360 Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
361
362 return addShortcut(info.loadLabel(mPackageManager).toString(),
363 intent, Favorites.ITEM_TYPE_APPLICATION);
364 } catch (PackageManager.NameNotFoundException e) {
Adam Cohencf0c7462015-08-06 14:02:23 -0700365 Log.e(TAG, "Unable to add favorite: " + packageName + "/" + className, e);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700366 }
367 return -1;
368 } else {
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700369 return invalidPackageOrClass(parser);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700370 }
371 }
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700372
373 /**
374 * Helper method to allow extending the parser capabilities
375 */
376 protected long invalidPackageOrClass(XmlResourceParser parser) {
Adam Cohencf0c7462015-08-06 14:02:23 -0700377 Log.w(TAG, "Skipping invalid <favorite> with no component");
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700378 return -1;
379 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700380 }
381
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700382 /**
383 * AutoInstall: required attributes packageName and className
384 */
385 protected class AutoInstallParser implements TagParser {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700386
387 @Override
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700388 public long parseAndAdd(XmlResourceParser parser) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700389 final String packageName = getAttributeValue(parser, ATTR_PACKAGE_NAME);
390 final String className = getAttributeValue(parser, ATTR_CLASS_NAME);
391 if (TextUtils.isEmpty(packageName) || TextUtils.isEmpty(className)) {
392 if (LOGD) Log.d(TAG, "Skipping invalid <favorite> with no component");
393 return -1;
394 }
395
Sunny Goyal34942622014-08-29 17:20:55 -0700396 mValues.put(Favorites.RESTORED, ShortcutInfo.FLAG_AUTOINTALL_ICON);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700397 final Intent intent = new Intent(Intent.ACTION_MAIN, null)
398 .addCategory(Intent.CATEGORY_LAUNCHER)
399 .setComponent(new ComponentName(packageName, className))
400 .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK |
401 Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
402 return addShortcut(mContext.getString(R.string.package_state_unknown), intent,
403 Favorites.ITEM_TYPE_APPLICATION);
404 }
405 }
406
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700407 /**
408 * Parses a web shortcut. Required attributes url, icon, title
409 */
410 protected class ShortcutParser implements TagParser {
411
412 private final Resources mIconRes;
413
414 public ShortcutParser(Resources iconRes) {
415 mIconRes = iconRes;
416 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700417
418 @Override
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700419 public long parseAndAdd(XmlResourceParser parser) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700420 final int titleResId = getAttributeResourceValue(parser, ATTR_TITLE, 0);
421 final int iconId = getAttributeResourceValue(parser, ATTR_ICON, 0);
422
423 if (titleResId == 0 || iconId == 0) {
424 if (LOGD) Log.d(TAG, "Ignoring shortcut");
425 return -1;
426 }
427
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700428 final Intent intent = parseIntent(parser);
429 if (intent == null) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700430 return -1;
431 }
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700432
433 Drawable icon = mIconRes.getDrawable(iconId);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700434 if (icon == null) {
435 if (LOGD) Log.d(TAG, "Ignoring shortcut, can't load icon");
436 return -1;
437 }
438
439 ItemInfo.writeBitmap(mValues, Utilities.createIconBitmap(icon, mContext));
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700440 mValues.put(Favorites.ICON_PACKAGE, mIconRes.getResourcePackageName(iconId));
441 mValues.put(Favorites.ICON_RESOURCE, mIconRes.getResourceName(iconId));
442
443 intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK |
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700444 Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700445 return addShortcut(mSourceRes.getString(titleResId),
446 intent, Favorites.ITEM_TYPE_SHORTCUT);
447 }
448
449 protected Intent parseIntent(XmlResourceParser parser) {
450 final String url = getAttributeValue(parser, ATTR_URL);
451 if (TextUtils.isEmpty(url) || !Patterns.WEB_URL.matcher(url).matches()) {
452 if (LOGD) Log.d(TAG, "Ignoring shortcut, invalid url: " + url);
453 return null;
454 }
455 return new Intent(Intent.ACTION_VIEW, null).setData(Uri.parse(url));
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700456 }
457 }
458
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700459 /**
460 * AppWidget parser: Required attributes packageName, className, spanX and spanY.
461 * Options child nodes: <extra key=... value=... />
Sunny Goyal86df1382016-08-10 15:03:22 -0700462 * It adds a pending widget which allows the widget to come later. If there are extras, those
463 * are passed to widget options during bind.
464 * The config activity for the widget (if present) is not shown, so any optional configurations
465 * should be passed as extras and the widget should support reading these widget options.
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700466 */
Sunny Goyal86df1382016-08-10 15:03:22 -0700467 protected class PendingWidgetParser implements TagParser {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700468
469 @Override
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700470 public long parseAndAdd(XmlResourceParser parser)
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700471 throws XmlPullParserException, IOException {
472 final String packageName = getAttributeValue(parser, ATTR_PACKAGE_NAME);
473 final String className = getAttributeValue(parser, ATTR_CLASS_NAME);
474 if (TextUtils.isEmpty(packageName) || TextUtils.isEmpty(className)) {
Sunny Goyal86df1382016-08-10 15:03:22 -0700475 if (LOGD) Log.d(TAG, "Skipping invalid <appwidget> with no component");
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700476 return -1;
477 }
478
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700479 mValues.put(Favorites.SPANX, getAttributeValue(parser, ATTR_SPAN_X));
480 mValues.put(Favorites.SPANY, getAttributeValue(parser, ATTR_SPAN_Y));
Sunny Goyal86df1382016-08-10 15:03:22 -0700481 mValues.put(Favorites.ITEM_TYPE, Favorites.ITEM_TYPE_APPWIDGET);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700482
483 // Read the extras
484 Bundle extras = new Bundle();
485 int widgetDepth = parser.getDepth();
486 int type;
487 while ((type = parser.next()) != XmlPullParser.END_TAG ||
488 parser.getDepth() > widgetDepth) {
489 if (type != XmlPullParser.START_TAG) {
490 continue;
491 }
492
493 if (TAG_EXTRA.equals(parser.getName())) {
494 String key = getAttributeValue(parser, ATTR_KEY);
495 String value = getAttributeValue(parser, ATTR_VALUE);
496 if (key != null && value != null) {
497 extras.putString(key, value);
498 } else {
499 throw new RuntimeException("Widget extras must have a key and value");
500 }
501 } else {
502 throw new RuntimeException("Widgets can contain only extras");
503 }
504 }
505
Sunny Goyal86df1382016-08-10 15:03:22 -0700506 return verifyAndInsert(new ComponentName(packageName, className), extras);
507 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700508
Sunny Goyal86df1382016-08-10 15:03:22 -0700509 protected long verifyAndInsert(ComponentName cn, Bundle extras) {
510 mValues.put(Favorites.APPWIDGET_PROVIDER, cn.flattenToString());
511 mValues.put(Favorites.RESTORED,
512 LauncherAppWidgetInfo.FLAG_ID_NOT_VALID |
513 LauncherAppWidgetInfo.FLAG_PROVIDER_NOT_READY |
514 LauncherAppWidgetInfo.FLAG_DIRECT_CONFIG);
515 mValues.put(Favorites._ID, mCallback.generateNewItemId());
516 if (!extras.isEmpty()) {
517 mValues.put(Favorites.INTENT, new Intent().putExtras(extras).toUri(0));
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700518 }
Sunny Goyal86df1382016-08-10 15:03:22 -0700519
520 long insertedId = mCallback.insertAndCheck(mDb, mValues);
521 if (insertedId < 0) {
522 return -1;
523 } else {
524 return insertedId;
525 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700526 }
527 }
528
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700529 protected class FolderParser implements TagParser {
530 private final HashMap<String, TagParser> mFolderElements;
531
532 public FolderParser() {
533 this(getFolderElementsMap());
534 }
535
536 public FolderParser(HashMap<String, TagParser> elements) {
537 mFolderElements = elements;
538 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700539
540 @Override
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700541 public long parseAndAdd(XmlResourceParser parser)
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700542 throws XmlPullParserException, IOException {
543 final String title;
544 final int titleResId = getAttributeResourceValue(parser, ATTR_TITLE, 0);
545 if (titleResId != 0) {
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700546 title = mSourceRes.getString(titleResId);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700547 } else {
548 title = mContext.getResources().getString(R.string.folder_name);
549 }
550
551 mValues.put(Favorites.TITLE, title);
552 mValues.put(Favorites.ITEM_TYPE, Favorites.ITEM_TYPE_FOLDER);
553 mValues.put(Favorites.SPANX, 1);
554 mValues.put(Favorites.SPANY, 1);
555 mValues.put(Favorites._ID, mCallback.generateNewItemId());
556 long folderId = mCallback.insertAndCheck(mDb, mValues);
557 if (folderId < 0) {
558 if (LOGD) Log.e(TAG, "Unable to add folder");
559 return -1;
560 }
561
562 final ContentValues myValues = new ContentValues(mValues);
563 ArrayList<Long> folderItems = new ArrayList<Long>();
564
565 int type;
566 int folderDepth = parser.getDepth();
Sunny Goyal56a57bb2015-07-06 11:15:45 -0700567 int rank = 0;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700568 while ((type = parser.next()) != XmlPullParser.END_TAG ||
569 parser.getDepth() > folderDepth) {
570 if (type != XmlPullParser.START_TAG) {
571 continue;
572 }
573 mValues.clear();
574 mValues.put(Favorites.CONTAINER, folderId);
Sunny Goyal56a57bb2015-07-06 11:15:45 -0700575 mValues.put(Favorites.RANK, rank);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700576
577 TagParser tagParser = mFolderElements.get(parser.getName());
578 if (tagParser != null) {
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700579 final long id = tagParser.parseAndAdd(parser);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700580 if (id >= 0) {
581 folderItems.add(id);
Sunny Goyal56a57bb2015-07-06 11:15:45 -0700582 rank++;
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700583 }
584 } else {
585 throw new RuntimeException("Invalid folder item " + parser.getName());
586 }
587 }
588
589 long addedId = folderId;
590
591 // We can only have folders with >= 2 items, so we need to remove the
592 // folder and clean up if less than 2 items were included, or some
593 // failed to add, and less than 2 were actually added
594 if (folderItems.size() < 2) {
595 // Delete the folder
Sunny Goyal1d4a2df2015-03-30 11:11:46 -0700596 Uri uri = Favorites.getContentUri(folderId);
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700597 SqlArguments args = new SqlArguments(uri, null, null);
598 mDb.delete(args.table, args.where, args.args);
599 addedId = -1;
600
601 // If we have a single item, promote it to where the folder
602 // would have been.
603 if (folderItems.size() == 1) {
604 final ContentValues childValues = new ContentValues();
605 copyInteger(myValues, childValues, Favorites.CONTAINER);
606 copyInteger(myValues, childValues, Favorites.SCREEN);
607 copyInteger(myValues, childValues, Favorites.CELLX);
608 copyInteger(myValues, childValues, Favorites.CELLY);
609
610 addedId = folderItems.get(0);
Sunny Goyalb5b55c82016-05-10 12:28:59 -0700611 mDb.update(Favorites.TABLE_NAME, childValues,
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700612 Favorites._ID + "=" + addedId, null);
613 }
614 }
615 return addedId;
616 }
617 }
618
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700619 protected static final void beginDocument(XmlPullParser parser, String firstElementName)
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700620 throws XmlPullParserException, IOException {
621 int type;
622 while ((type = parser.next()) != XmlPullParser.START_TAG
623 && type != XmlPullParser.END_DOCUMENT);
624
625 if (type != XmlPullParser.START_TAG) {
626 throw new XmlPullParserException("No start tag found");
627 }
628
629 if (!parser.getName().equals(firstElementName)) {
630 throw new XmlPullParserException("Unexpected start tag: found " + parser.getName() +
631 ", expected " + firstElementName);
632 }
633 }
634
Sunny Goyal96a09632015-12-16 11:32:54 -0800635 private static String convertToDistanceFromEnd(String value, int endValue) {
636 if (!TextUtils.isEmpty(value)) {
637 int x = Integer.parseInt(value);
638 if (x < 0) {
639 return Integer.toString(endValue + x);
640 }
641 }
642 return value;
643 }
644
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700645 /**
646 * Return attribute value, attempting launcher-specific namespace first
647 * before falling back to anonymous attribute.
648 */
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700649 protected static String getAttributeValue(XmlResourceParser parser, String attribute) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700650 String value = parser.getAttributeValue(
651 "http://schemas.android.com/apk/res-auto/com.android.launcher3", attribute);
652 if (value == null) {
653 value = parser.getAttributeValue(null, attribute);
654 }
655 return value;
656 }
657
658 /**
659 * Return attribute resource value, attempting launcher-specific namespace
660 * first before falling back to anonymous attribute.
661 */
Sunny Goyal3a5a9d12014-10-01 15:33:41 -0700662 protected static int getAttributeResourceValue(XmlResourceParser parser, String attribute,
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700663 int defaultValue) {
664 int value = parser.getAttributeResourceValue(
665 "http://schemas.android.com/apk/res-auto/com.android.launcher3", attribute,
666 defaultValue);
667 if (value == defaultValue) {
668 value = parser.getAttributeResourceValue(null, attribute, defaultValue);
669 }
670 return value;
671 }
672
673 public static interface LayoutParserCallback {
674 long generateNewItemId();
675
676 long insertAndCheck(SQLiteDatabase db, ContentValues values);
677 }
678
Adam Cohen091440a2015-03-18 14:16:05 -0700679 @Thunk static void copyInteger(ContentValues from, ContentValues to, String key) {
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700680 to.put(key, from.getAsInteger(key));
681 }
682}