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