1 /* 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 17 package com.android.launcher3; 18 19 import android.appwidget.AppWidgetHost; 20 import android.content.ComponentName; 21 import android.content.ContentValues; 22 import android.content.Context; 23 import android.content.Intent; 24 import android.content.pm.ActivityInfo; 25 import android.content.pm.PackageManager; 26 import android.content.res.Resources; 27 import android.database.sqlite.SQLiteDatabase; 28 import android.graphics.drawable.Drawable; 29 import android.net.Uri; 30 import android.os.Build.VERSION; 31 import android.os.Bundle; 32 import android.os.Process; 33 import android.text.TextUtils; 34 import android.util.ArrayMap; 35 import android.util.AttributeSet; 36 import android.util.Log; 37 import android.util.Pair; 38 import android.util.Patterns; 39 import android.util.Xml; 40 41 import androidx.annotation.Nullable; 42 43 import com.android.launcher3.LauncherProvider.SqlArguments; 44 import com.android.launcher3.LauncherSettings.Favorites; 45 import com.android.launcher3.icons.GraphicsUtils; 46 import com.android.launcher3.icons.LauncherIcons; 47 import com.android.launcher3.qsb.QsbContainerView; 48 import com.android.launcher3.util.IntArray; 49 import com.android.launcher3.util.PackageManagerHelper; 50 import com.android.launcher3.util.Thunk; 51 52 import org.xmlpull.v1.XmlPullParser; 53 import org.xmlpull.v1.XmlPullParserException; 54 55 import java.io.IOException; 56 import java.util.Locale; 57 import java.util.function.Supplier; 58 59 /** 60 * Layout parsing code for auto installs layout 61 */ 62 public class AutoInstallsLayout { 63 private static final String TAG = "AutoInstalls"; 64 private static final boolean LOGD = false; 65 66 /** Marker action used to discover a package which defines launcher customization */ 67 static final String ACTION_LAUNCHER_CUSTOMIZATION = 68 "android.autoinstalls.config.action.PLAY_AUTO_INSTALL"; 69 70 /** 71 * Layout resource which also includes grid size and hotseat count, e.g., default_layout_6x6_h5 72 */ 73 private static final String FORMATTED_LAYOUT_RES_WITH_HOSTEAT = "default_layout_%dx%d_h%s"; 74 private static final String FORMATTED_LAYOUT_RES = "default_layout_%dx%d"; 75 private static final String LAYOUT_RES = "default_layout"; 76 get(Context context, AppWidgetHost appWidgetHost, LayoutParserCallback callback)77 static AutoInstallsLayout get(Context context, AppWidgetHost appWidgetHost, 78 LayoutParserCallback callback) { 79 Pair<String, Resources> customizationApkInfo = PackageManagerHelper.findSystemApk( 80 ACTION_LAUNCHER_CUSTOMIZATION, context.getPackageManager()); 81 if (customizationApkInfo == null) { 82 return null; 83 } 84 String pkg = customizationApkInfo.first; 85 Resources targetRes = customizationApkInfo.second; 86 InvariantDeviceProfile grid = LauncherAppState.getIDP(context); 87 88 // Try with grid size and hotseat count 89 String layoutName = String.format(Locale.ENGLISH, FORMATTED_LAYOUT_RES_WITH_HOSTEAT, 90 grid.numColumns, grid.numRows, grid.numHotseatIcons); 91 int layoutId = targetRes.getIdentifier(layoutName, "xml", pkg); 92 93 // Try with only grid size 94 if (layoutId == 0) { 95 Log.d(TAG, "Formatted layout: " + layoutName 96 + " not found. Trying layout without hosteat"); 97 layoutName = String.format(Locale.ENGLISH, FORMATTED_LAYOUT_RES, 98 grid.numColumns, grid.numRows); 99 layoutId = targetRes.getIdentifier(layoutName, "xml", pkg); 100 } 101 102 // Try the default layout 103 if (layoutId == 0) { 104 Log.d(TAG, "Formatted layout: " + layoutName + " not found. Trying the default layout"); 105 layoutId = targetRes.getIdentifier(LAYOUT_RES, "xml", pkg); 106 } 107 108 if (layoutId == 0) { 109 Log.e(TAG, "Layout definition not found in package: " + pkg); 110 return null; 111 } 112 return new AutoInstallsLayout(context, appWidgetHost, callback, targetRes, layoutId, 113 TAG_WORKSPACE); 114 } 115 116 // Object Tags 117 private static final String TAG_INCLUDE = "include"; 118 public static final String TAG_WORKSPACE = "workspace"; 119 private static final String TAG_APP_ICON = "appicon"; 120 private static final String TAG_AUTO_INSTALL = "autoinstall"; 121 private static final String TAG_FOLDER = "folder"; 122 private static final String TAG_APPWIDGET = "appwidget"; 123 protected static final String TAG_SEARCH_WIDGET = "searchwidget"; 124 private static final String TAG_SHORTCUT = "shortcut"; 125 private static final String TAG_EXTRA = "extra"; 126 127 private static final String ATTR_CONTAINER = "container"; 128 private static final String ATTR_RANK = "rank"; 129 130 private static final String ATTR_PACKAGE_NAME = "packageName"; 131 private static final String ATTR_CLASS_NAME = "className"; 132 private static final String ATTR_TITLE = "title"; 133 private static final String ATTR_SCREEN = "screen"; 134 135 // x and y can be specified as negative integers, in which case -1 represents the 136 // last row / column, -2 represents the second last, and so on. 137 private static final String ATTR_X = "x"; 138 private static final String ATTR_Y = "y"; 139 140 private static final String ATTR_SPAN_X = "spanX"; 141 private static final String ATTR_SPAN_Y = "spanY"; 142 private static final String ATTR_ICON = "icon"; 143 private static final String ATTR_URL = "url"; 144 145 // Attrs for "Include" 146 private static final String ATTR_WORKSPACE = "workspace"; 147 148 // Style attrs -- "Extra" 149 private static final String ATTR_KEY = "key"; 150 private static final String ATTR_VALUE = "value"; 151 152 private static final String HOTSEAT_CONTAINER_NAME = 153 Favorites.containerToString(Favorites.CONTAINER_HOTSEAT); 154 155 @Thunk 156 final Context mContext; 157 @Thunk 158 final AppWidgetHost mAppWidgetHost; 159 protected final LayoutParserCallback mCallback; 160 161 protected final PackageManager mPackageManager; 162 protected final Resources mSourceRes; 163 protected final Supplier<XmlPullParser> mInitialLayoutSupplier; 164 165 private final InvariantDeviceProfile mIdp; 166 private final int mRowCount; 167 private final int mColumnCount; 168 169 private final int[] mTemp = new int[2]; 170 @Thunk 171 final ContentValues mValues; 172 protected final String mRootTag; 173 174 protected SQLiteDatabase mDb; 175 AutoInstallsLayout(Context context, AppWidgetHost appWidgetHost, LayoutParserCallback callback, Resources res, int layoutId, String rootTag)176 public AutoInstallsLayout(Context context, AppWidgetHost appWidgetHost, 177 LayoutParserCallback callback, Resources res, 178 int layoutId, String rootTag) { 179 this(context, appWidgetHost, callback, res, () -> res.getXml(layoutId), rootTag); 180 } 181 AutoInstallsLayout(Context context, AppWidgetHost appWidgetHost, LayoutParserCallback callback, Resources res, Supplier<XmlPullParser> initialLayoutSupplier, String rootTag)182 public AutoInstallsLayout(Context context, AppWidgetHost appWidgetHost, 183 LayoutParserCallback callback, Resources res, 184 Supplier<XmlPullParser> initialLayoutSupplier, String rootTag) { 185 mContext = context; 186 mAppWidgetHost = appWidgetHost; 187 mCallback = callback; 188 189 mPackageManager = context.getPackageManager(); 190 mValues = new ContentValues(); 191 mRootTag = rootTag; 192 193 mSourceRes = res; 194 mInitialLayoutSupplier = initialLayoutSupplier; 195 196 mIdp = LauncherAppState.getIDP(context); 197 mRowCount = mIdp.numRows; 198 mColumnCount = mIdp.numColumns; 199 } 200 201 /** 202 * Loads the layout in the db and returns the number of entries added on the desktop. 203 */ loadLayout(SQLiteDatabase db, IntArray screenIds)204 public int loadLayout(SQLiteDatabase db, IntArray screenIds) { 205 mDb = db; 206 try { 207 return parseLayout(mInitialLayoutSupplier.get(), screenIds); 208 } catch (Exception e) { 209 Log.e(TAG, "Error parsing layout: ", e); 210 return -1; 211 } 212 } 213 214 /** 215 * Parses the layout and returns the number of elements added on the homescreen. 216 */ parseLayout(XmlPullParser parser, IntArray screenIds)217 protected int parseLayout(XmlPullParser parser, IntArray screenIds) 218 throws XmlPullParserException, IOException { 219 beginDocument(parser, mRootTag); 220 final int depth = parser.getDepth(); 221 int type; 222 ArrayMap<String, TagParser> tagParserMap = getLayoutElementsMap(); 223 int count = 0; 224 225 while (((type = parser.next()) != XmlPullParser.END_TAG || 226 parser.getDepth() > depth) && type != XmlPullParser.END_DOCUMENT) { 227 if (type != XmlPullParser.START_TAG) { 228 continue; 229 } 230 count += parseAndAddNode(parser, tagParserMap, screenIds); 231 } 232 return count; 233 } 234 235 /** 236 * Parses container and screenId attribute from the current tag, and puts it in the out. 237 * @param out array of size 2. 238 */ parseContainerAndScreen(XmlPullParser parser, int[] out)239 protected void parseContainerAndScreen(XmlPullParser parser, int[] out) { 240 if (HOTSEAT_CONTAINER_NAME.equals(getAttributeValue(parser, ATTR_CONTAINER))) { 241 out[0] = Favorites.CONTAINER_HOTSEAT; 242 // Hack: hotseat items are stored using screen ids 243 out[1] = Integer.parseInt(getAttributeValue(parser, ATTR_RANK)); 244 } else { 245 out[0] = Favorites.CONTAINER_DESKTOP; 246 out[1] = Integer.parseInt(getAttributeValue(parser, ATTR_SCREEN)); 247 } 248 } 249 250 /** 251 * Parses the current node and returns the number of elements added. 252 */ parseAndAddNode( XmlPullParser parser, ArrayMap<String, TagParser> tagParserMap, IntArray screenIds)253 protected int parseAndAddNode( 254 XmlPullParser parser, ArrayMap<String, TagParser> tagParserMap, IntArray screenIds) 255 throws XmlPullParserException, IOException { 256 257 if (TAG_INCLUDE.equals(parser.getName())) { 258 final int resId = getAttributeResourceValue(parser, ATTR_WORKSPACE, 0); 259 if (resId != 0) { 260 // recursively load some more favorites, why not? 261 return parseLayout(mSourceRes.getXml(resId), screenIds); 262 } else { 263 return 0; 264 } 265 } 266 267 mValues.clear(); 268 parseContainerAndScreen(parser, mTemp); 269 final int container = mTemp[0]; 270 final int screenId = mTemp[1]; 271 272 mValues.put(Favorites.CONTAINER, container); 273 mValues.put(Favorites.SCREEN, screenId); 274 275 mValues.put(Favorites.CELLX, 276 convertToDistanceFromEnd(getAttributeValue(parser, ATTR_X), mColumnCount)); 277 mValues.put(Favorites.CELLY, 278 convertToDistanceFromEnd(getAttributeValue(parser, ATTR_Y), mRowCount)); 279 280 TagParser tagParser = tagParserMap.get(parser.getName()); 281 if (tagParser == null) { 282 if (LOGD) Log.d(TAG, "Ignoring unknown element tag: " + parser.getName()); 283 return 0; 284 } 285 int newElementId = tagParser.parseAndAdd(parser); 286 if (newElementId >= 0) { 287 // Keep track of the set of screens which need to be added to the db. 288 if (!screenIds.contains(screenId) && 289 container == Favorites.CONTAINER_DESKTOP) { 290 screenIds.add(screenId); 291 } 292 return 1; 293 } 294 return 0; 295 } 296 addShortcut(String title, Intent intent, int type)297 protected int addShortcut(String title, Intent intent, int type) { 298 int id = mCallback.generateNewItemId(); 299 mValues.put(Favorites.INTENT, intent.toUri(0)); 300 mValues.put(Favorites.TITLE, title); 301 mValues.put(Favorites.ITEM_TYPE, type); 302 mValues.put(Favorites.SPANX, 1); 303 mValues.put(Favorites.SPANY, 1); 304 mValues.put(Favorites._ID, id); 305 if (mCallback.insertAndCheck(mDb, mValues) < 0) { 306 return -1; 307 } else { 308 return id; 309 } 310 } 311 getFolderElementsMap()312 protected ArrayMap<String, TagParser> getFolderElementsMap() { 313 ArrayMap<String, TagParser> parsers = new ArrayMap<>(); 314 parsers.put(TAG_APP_ICON, new AppShortcutParser()); 315 parsers.put(TAG_AUTO_INSTALL, new AutoInstallParser()); 316 parsers.put(TAG_SHORTCUT, new ShortcutParser(mSourceRes)); 317 return parsers; 318 } 319 getLayoutElementsMap()320 protected ArrayMap<String, TagParser> getLayoutElementsMap() { 321 ArrayMap<String, TagParser> parsers = new ArrayMap<>(); 322 parsers.put(TAG_APP_ICON, new AppShortcutParser()); 323 parsers.put(TAG_AUTO_INSTALL, new AutoInstallParser()); 324 parsers.put(TAG_FOLDER, new FolderParser()); 325 parsers.put(TAG_APPWIDGET, new PendingWidgetParser()); 326 parsers.put(TAG_SEARCH_WIDGET, new SearchWidgetParser()); 327 parsers.put(TAG_SHORTCUT, new ShortcutParser(mSourceRes)); 328 return parsers; 329 } 330 331 protected interface TagParser { 332 /** 333 * Parses the tag and adds to the db 334 * @return the id of the row added or -1; 335 */ parseAndAdd(XmlPullParser parser)336 int parseAndAdd(XmlPullParser parser) 337 throws XmlPullParserException, IOException; 338 } 339 340 /** 341 * App shortcuts: required attributes packageName and className 342 */ 343 protected class AppShortcutParser implements TagParser { 344 345 @Override parseAndAdd(XmlPullParser parser)346 public int parseAndAdd(XmlPullParser parser) { 347 final String packageName = getAttributeValue(parser, ATTR_PACKAGE_NAME); 348 final String className = getAttributeValue(parser, ATTR_CLASS_NAME); 349 350 if (!TextUtils.isEmpty(packageName) && !TextUtils.isEmpty(className)) { 351 ActivityInfo info; 352 try { 353 ComponentName cn; 354 try { 355 cn = new ComponentName(packageName, className); 356 info = mPackageManager.getActivityInfo(cn, 0); 357 } catch (PackageManager.NameNotFoundException nnfe) { 358 String[] packages = mPackageManager.currentToCanonicalPackageNames( 359 new String[]{packageName}); 360 cn = new ComponentName(packages[0], className); 361 info = mPackageManager.getActivityInfo(cn, 0); 362 } 363 final Intent intent = new Intent(Intent.ACTION_MAIN, null) 364 .addCategory(Intent.CATEGORY_LAUNCHER) 365 .setComponent(cn) 366 .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK 367 | Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED); 368 369 return addShortcut(info.loadLabel(mPackageManager).toString(), 370 intent, Favorites.ITEM_TYPE_APPLICATION); 371 } catch (PackageManager.NameNotFoundException e) { 372 Log.e(TAG, "Favorite not found: " + packageName + "/" + className); 373 } 374 return -1; 375 } else { 376 return invalidPackageOrClass(parser); 377 } 378 } 379 380 /** 381 * Helper method to allow extending the parser capabilities 382 */ invalidPackageOrClass(XmlPullParser parser)383 protected int invalidPackageOrClass(XmlPullParser parser) { 384 Log.w(TAG, "Skipping invalid <favorite> with no component"); 385 return -1; 386 } 387 } 388 389 /** 390 * AutoInstall: required attributes packageName and className 391 */ 392 protected class AutoInstallParser implements TagParser { 393 394 @Override parseAndAdd(XmlPullParser parser)395 public int parseAndAdd(XmlPullParser parser) { 396 final String packageName = getAttributeValue(parser, ATTR_PACKAGE_NAME); 397 final String className = getAttributeValue(parser, ATTR_CLASS_NAME); 398 if (TextUtils.isEmpty(packageName) || TextUtils.isEmpty(className)) { 399 if (LOGD) Log.d(TAG, "Skipping invalid <favorite> with no component"); 400 return -1; 401 } 402 403 mValues.put(Favorites.RESTORED, WorkspaceItemInfo.FLAG_AUTOINSTALL_ICON); 404 final Intent intent = new Intent(Intent.ACTION_MAIN, null) 405 .addCategory(Intent.CATEGORY_LAUNCHER) 406 .setComponent(new ComponentName(packageName, className)) 407 .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK 408 | Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED); 409 return addShortcut(mContext.getString(R.string.package_state_unknown), intent, 410 Favorites.ITEM_TYPE_APPLICATION); 411 } 412 } 413 414 /** 415 * Parses a web shortcut. Required attributes url, icon, title 416 */ 417 protected class ShortcutParser implements TagParser { 418 419 private final Resources mIconRes; 420 ShortcutParser(Resources iconRes)421 public ShortcutParser(Resources iconRes) { 422 mIconRes = iconRes; 423 } 424 425 @Override parseAndAdd(XmlPullParser parser)426 public int parseAndAdd(XmlPullParser parser) { 427 final int titleResId = getAttributeResourceValue(parser, ATTR_TITLE, 0); 428 final int iconId = getAttributeResourceValue(parser, ATTR_ICON, 0); 429 430 if (titleResId == 0 || iconId == 0) { 431 if (LOGD) Log.d(TAG, "Ignoring shortcut"); 432 return -1; 433 } 434 435 final Intent intent = parseIntent(parser); 436 if (intent == null) { 437 return -1; 438 } 439 440 Drawable icon = mIconRes.getDrawable(iconId); 441 if (icon == null) { 442 if (LOGD) Log.d(TAG, "Ignoring shortcut, can't load icon"); 443 return -1; 444 } 445 446 // Auto installs should always support the current platform version. 447 LauncherIcons li = LauncherIcons.obtain(mContext); 448 mValues.put(LauncherSettings.Favorites.ICON, GraphicsUtils.flattenBitmap( 449 li.createBadgedIconBitmap(icon, Process.myUserHandle(), VERSION.SDK_INT).icon)); 450 li.recycle(); 451 452 mValues.put(Favorites.ICON_PACKAGE, mIconRes.getResourcePackageName(iconId)); 453 mValues.put(Favorites.ICON_RESOURCE, mIconRes.getResourceName(iconId)); 454 455 intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK | 456 Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED); 457 return addShortcut(mSourceRes.getString(titleResId), 458 intent, Favorites.ITEM_TYPE_SHORTCUT); 459 } 460 parseIntent(XmlPullParser parser)461 protected Intent parseIntent(XmlPullParser parser) { 462 final String url = getAttributeValue(parser, ATTR_URL); 463 if (TextUtils.isEmpty(url) || !Patterns.WEB_URL.matcher(url).matches()) { 464 if (LOGD) Log.d(TAG, "Ignoring shortcut, invalid url: " + url); 465 return null; 466 } 467 return new Intent(Intent.ACTION_VIEW, null).setData(Uri.parse(url)); 468 } 469 } 470 471 /** 472 * AppWidget parser: Required attributes packageName, className, spanX and spanY. 473 * Options child nodes: <extra key=... value=... /> 474 * It adds a pending widget which allows the widget to come later. If there are extras, those 475 * are passed to widget options during bind. 476 * The config activity for the widget (if present) is not shown, so any optional configurations 477 * should be passed as extras and the widget should support reading these widget options. 478 */ 479 protected class PendingWidgetParser implements TagParser { 480 481 @Nullable getComponentName(XmlPullParser parser)482 public ComponentName getComponentName(XmlPullParser parser) { 483 final String packageName = getAttributeValue(parser, ATTR_PACKAGE_NAME); 484 final String className = getAttributeValue(parser, ATTR_CLASS_NAME); 485 if (TextUtils.isEmpty(packageName) || TextUtils.isEmpty(className)) { 486 return null; 487 } 488 return new ComponentName(packageName, className); 489 } 490 491 492 @Override parseAndAdd(XmlPullParser parser)493 public int parseAndAdd(XmlPullParser parser) 494 throws XmlPullParserException, IOException { 495 ComponentName cn = getComponentName(parser); 496 if (cn == null) { 497 if (LOGD) Log.d(TAG, "Skipping invalid <appwidget> with no component"); 498 return -1; 499 } 500 501 mValues.put(Favorites.SPANX, getAttributeValue(parser, ATTR_SPAN_X)); 502 mValues.put(Favorites.SPANY, getAttributeValue(parser, ATTR_SPAN_Y)); 503 mValues.put(Favorites.ITEM_TYPE, Favorites.ITEM_TYPE_APPWIDGET); 504 505 // Read the extras 506 Bundle extras = new Bundle(); 507 int widgetDepth = parser.getDepth(); 508 int type; 509 while ((type = parser.next()) != XmlPullParser.END_TAG || 510 parser.getDepth() > widgetDepth) { 511 if (type != XmlPullParser.START_TAG) { 512 continue; 513 } 514 515 if (TAG_EXTRA.equals(parser.getName())) { 516 String key = getAttributeValue(parser, ATTR_KEY); 517 String value = getAttributeValue(parser, ATTR_VALUE); 518 if (key != null && value != null) { 519 extras.putString(key, value); 520 } else { 521 throw new RuntimeException("Widget extras must have a key and value"); 522 } 523 } else { 524 throw new RuntimeException("Widgets can contain only extras"); 525 } 526 } 527 return verifyAndInsert(cn, extras); 528 } 529 verifyAndInsert(ComponentName cn, Bundle extras)530 protected int verifyAndInsert(ComponentName cn, Bundle extras) { 531 mValues.put(Favorites.APPWIDGET_PROVIDER, cn.flattenToString()); 532 mValues.put(Favorites.RESTORED, 533 LauncherAppWidgetInfo.FLAG_ID_NOT_VALID 534 | LauncherAppWidgetInfo.FLAG_PROVIDER_NOT_READY 535 | LauncherAppWidgetInfo.FLAG_DIRECT_CONFIG); 536 mValues.put(Favorites._ID, mCallback.generateNewItemId()); 537 if (!extras.isEmpty()) { 538 mValues.put(Favorites.INTENT, new Intent().putExtras(extras).toUri(0)); 539 } 540 541 int insertedId = mCallback.insertAndCheck(mDb, mValues); 542 if (insertedId < 0) { 543 return -1; 544 } else { 545 return insertedId; 546 } 547 } 548 } 549 550 protected class SearchWidgetParser extends PendingWidgetParser { 551 @Override 552 @Nullable getComponentName(XmlPullParser parser)553 public ComponentName getComponentName(XmlPullParser parser) { 554 return QsbContainerView.getSearchComponentName(mContext); 555 } 556 557 @Override verifyAndInsert(ComponentName cn, Bundle extras)558 protected int verifyAndInsert(ComponentName cn, Bundle extras) { 559 mValues.put(Favorites.OPTIONS, LauncherAppWidgetInfo.OPTION_SEARCH_WIDGET); 560 int flags = mValues.getAsInteger(Favorites.RESTORED) 561 | WorkspaceItemInfo.FLAG_RESTORE_STARTED; 562 mValues.put(Favorites.RESTORED, flags); 563 return super.verifyAndInsert(cn, extras); 564 } 565 } 566 567 protected class FolderParser implements TagParser { 568 private final ArrayMap<String, TagParser> mFolderElements; 569 FolderParser()570 public FolderParser() { 571 this(getFolderElementsMap()); 572 } 573 FolderParser(ArrayMap<String, TagParser> elements)574 public FolderParser(ArrayMap<String, TagParser> elements) { 575 mFolderElements = elements; 576 } 577 578 @Override parseAndAdd(XmlPullParser parser)579 public int parseAndAdd(XmlPullParser parser) 580 throws XmlPullParserException, IOException { 581 final String title; 582 final int titleResId = getAttributeResourceValue(parser, ATTR_TITLE, 0); 583 if (titleResId != 0) { 584 title = mSourceRes.getString(titleResId); 585 } else { 586 title = ""; 587 } 588 589 mValues.put(Favorites.TITLE, title); 590 mValues.put(Favorites.ITEM_TYPE, Favorites.ITEM_TYPE_FOLDER); 591 mValues.put(Favorites.SPANX, 1); 592 mValues.put(Favorites.SPANY, 1); 593 mValues.put(Favorites._ID, mCallback.generateNewItemId()); 594 int folderId = mCallback.insertAndCheck(mDb, mValues); 595 if (folderId < 0) { 596 if (LOGD) Log.e(TAG, "Unable to add folder"); 597 return -1; 598 } 599 600 final ContentValues myValues = new ContentValues(mValues); 601 IntArray folderItems = new IntArray(); 602 603 int type; 604 int folderDepth = parser.getDepth(); 605 int rank = 0; 606 while ((type = parser.next()) != XmlPullParser.END_TAG || 607 parser.getDepth() > folderDepth) { 608 if (type != XmlPullParser.START_TAG) { 609 continue; 610 } 611 mValues.clear(); 612 mValues.put(Favorites.CONTAINER, folderId); 613 mValues.put(Favorites.RANK, rank); 614 615 TagParser tagParser = mFolderElements.get(parser.getName()); 616 if (tagParser != null) { 617 final int id = tagParser.parseAndAdd(parser); 618 if (id >= 0) { 619 folderItems.add(id); 620 rank++; 621 } 622 } else { 623 throw new RuntimeException("Invalid folder item " + parser.getName()); 624 } 625 } 626 627 int addedId = folderId; 628 629 // We can only have folders with >= 2 items, so we need to remove the 630 // folder and clean up if less than 2 items were included, or some 631 // failed to add, and less than 2 were actually added 632 if (folderItems.size() < 2) { 633 // Delete the folder 634 Uri uri = Favorites.getContentUri(folderId); 635 SqlArguments args = new SqlArguments(uri, null, null); 636 mDb.delete(args.table, args.where, args.args); 637 addedId = -1; 638 639 // If we have a single item, promote it to where the folder 640 // would have been. 641 if (folderItems.size() == 1) { 642 final ContentValues childValues = new ContentValues(); 643 copyInteger(myValues, childValues, Favorites.CONTAINER); 644 copyInteger(myValues, childValues, Favorites.SCREEN); 645 copyInteger(myValues, childValues, Favorites.CELLX); 646 copyInteger(myValues, childValues, Favorites.CELLY); 647 648 addedId = folderItems.get(0); 649 mDb.update(Favorites.TABLE_NAME, childValues, 650 Favorites._ID + "=" + addedId, null); 651 } 652 } 653 return addedId; 654 } 655 } 656 beginDocument(XmlPullParser parser, String firstElementName)657 protected static void beginDocument(XmlPullParser parser, String firstElementName) 658 throws XmlPullParserException, IOException { 659 int type; 660 while ((type = parser.next()) != XmlPullParser.START_TAG 661 && type != XmlPullParser.END_DOCUMENT); 662 663 if (type != XmlPullParser.START_TAG) { 664 throw new XmlPullParserException("No start tag found"); 665 } 666 667 if (!parser.getName().equals(firstElementName)) { 668 throw new XmlPullParserException("Unexpected start tag: found " + parser.getName() + 669 ", expected " + firstElementName); 670 } 671 } 672 convertToDistanceFromEnd(String value, int endValue)673 private static String convertToDistanceFromEnd(String value, int endValue) { 674 if (!TextUtils.isEmpty(value)) { 675 int x = Integer.parseInt(value); 676 if (x < 0) { 677 return Integer.toString(endValue + x); 678 } 679 } 680 return value; 681 } 682 683 /** 684 * Return attribute value, attempting launcher-specific namespace first 685 * before falling back to anonymous attribute. 686 */ getAttributeValue(XmlPullParser parser, String attribute)687 protected static String getAttributeValue(XmlPullParser parser, String attribute) { 688 String value = parser.getAttributeValue( 689 "http://schemas.android.com/apk/res-auto/com.android.launcher3", attribute); 690 if (value == null) { 691 value = parser.getAttributeValue(null, attribute); 692 } 693 return value; 694 } 695 696 /** 697 * Return attribute resource value, attempting launcher-specific namespace 698 * first before falling back to anonymous attribute. 699 */ getAttributeResourceValue(XmlPullParser parser, String attribute, int defaultValue)700 protected static int getAttributeResourceValue(XmlPullParser parser, String attribute, 701 int defaultValue) { 702 AttributeSet attrs = Xml.asAttributeSet(parser); 703 int value = attrs.getAttributeResourceValue( 704 "http://schemas.android.com/apk/res-auto/com.android.launcher3", attribute, 705 defaultValue); 706 if (value == defaultValue) { 707 value = attrs.getAttributeResourceValue(null, attribute, defaultValue); 708 } 709 return value; 710 } 711 712 public interface LayoutParserCallback { generateNewItemId()713 int generateNewItemId(); 714 insertAndCheck(SQLiteDatabase db, ContentValues values)715 int insertAndCheck(SQLiteDatabase db, ContentValues values); 716 } 717 718 @Thunk copyInteger(ContentValues from, ContentValues to, String key)719 static void copyInteger(ContentValues from, ContentValues to, String key) { 720 to.put(key, from.getAsInteger(key)); 721 } 722 } 723