[Android] Add support for Partner bookmarks to Chrome bookmark widget

chrome/android/java/src/org/chromium/chrome/browser/bookmarkswidget/BookmarkWidgetService.java

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.bookmarkswidget;
 
 import android.appwidget.AppWidgetManager;
 import android.content.Context;
 import android.content.Intent;
 import android.content.SharedPreferences;
@@ skipping 17 matching lines @@
 import org.chromium.base.metrics.RecordUserAction;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.bookmarks.BookmarkBridge.BookmarkItem;
 import org.chromium.chrome.browser.bookmarks.BookmarkBridge.BookmarkModelObserver;
 import org.chromium.chrome.browser.bookmarks.BookmarkModel;
 import org.chromium.chrome.browser.favicon.LargeIconBridge;
 import org.chromium.chrome.browser.favicon.LargeIconBridge.LargeIconCallback;
 import org.chromium.chrome.browser.init.ChromeBrowserInitializer;
 import org.chromium.chrome.browser.partnerbookmarks.PartnerBookmarksShim;
 import org.chromium.chrome.browser.profiles.Profile;
-import org.chromium.chrome.browser.tab.Tab;
 import org.chromium.chrome.browser.util.IntentUtils;
 import org.chromium.chrome.browser.widget.RoundedIconGenerator;
 import org.chromium.components.bookmarks.BookmarkId;
-import org.chromium.components.bookmarks.BookmarkType;
 
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
 import java.util.concurrent.LinkedBlockingQueue;
 
 import javax.annotation.Nullable;
 
 /**
  * Service to support the bookmarks widget.
  *
  * This provides the list of bookmarks to show in the widget via a RemoteViewsFactory (the
  * RemoteViews equivalent of an Adapter), and updates the widget when the bookmark model changes.
  *
  * Threading note: Be careful! Android calls some methods in this class on the UI thread and others
  * on (multiple) binder threads. Additionally, all interaction with the BookmarkModel must happen on
  * the UI thread. To keep the situation clear, every non-static method is annotated with either
  * {@link UiThread} or {@link BinderThread}.
  */
 public class BookmarkWidgetService extends RemoteViewsService {
 
     private static final String TAG = "BookmarkWidget";
     private static final String ACTION_CHANGE_FOLDER_SUFFIX = ".CHANGE_FOLDER";
-    private static final String PREF_CURRENT_FOLDER = "current_folder";
+    private static final String PREF_CURRENT_FOLDER = "bookmarkswidget.current_folder";

[Ted C, 2016/06/03 03:16:39]

has this pref ever changed?  did it change when we switched over to the new
widget design? 

if the pref didn't change then, it would be sad to have this be the change that
causes users of this widget to lose their folder state.

I'm wondering if we should change the places where we were getting the previous
"current_folder" and first attempt to get the new one as a string and if it's
null fall back to getting the old one as a long.

     private static final String EXTRA_FOLDER_ID = "folderId";
 
     @UiThread
     @Override
     public RemoteViewsFactory onGetViewFactory(Intent intent) {
         int widgetId = IntentUtils.safeGetIntExtra(intent, AppWidgetManager.EXTRA_APPWIDGET_ID, -1);
         if (widgetId < 0) {
             Log.w(TAG, "Missing EXTRA_APPWIDGET_ID!");
             return null;
         }
@@ skipping 16 matching lines @@
         }
     }
 
     static void deleteWidgetState(Context context, int widgetId) {
         SharedPreferences preferences = getWidgetState(context, widgetId);
         if (preferences != null) preferences.edit().clear().apply();
     }
 
     static void changeFolder(Context context, Intent intent) {
         int widgetId = IntentUtils.safeGetIntExtra(intent, AppWidgetManager.EXTRA_APPWIDGET_ID, -1);
-        long folderId = IntentUtils.safeGetLongExtra(intent, EXTRA_FOLDER_ID, -1);
-        if (widgetId >= 0 && folderId >= 0) {
+        String serializedFolder = IntentUtils.safeGetStringExtra(intent, EXTRA_FOLDER_ID);
+        if (widgetId >= 0 && serializedFolder != null) {
             SharedPreferences prefs = getWidgetState(context, widgetId);
-            prefs.edit().putLong(PREF_CURRENT_FOLDER, folderId).apply();
+            prefs.edit().putString(PREF_CURRENT_FOLDER, serializedFolder).apply();
             AppWidgetManager.getInstance(context)
                     .notifyAppWidgetViewDataChanged(widgetId, R.id.bookmarks_list);
         }
     }
 
     /**
      * Holds data describing a bookmark or bookmark folder.
      */
     private static class Bookmark {
         public String title;
         public String url;
         public BookmarkId id;
         public BookmarkId parentId;
         public boolean isFolder;
         public Bitmap favicon;
 
         public static Bookmark fromBookmarkItem(BookmarkItem item) {
             if (item == null) return null;
 
-            // The bookmarks widget doesn't support showing partner bookmarks. The main hurdle is
-            // that the current folder ID is stored in shared prefs as a long, not a BookmarkId.
-            // This support could be added if there's a strong desire.
-            if (item.getId().getType() == BookmarkType.PARTNER) return null;
-
             Bookmark bookmark = new Bookmark();
             bookmark.title = item.getTitle();
             bookmark.url = item.getUrl();
             bookmark.id = item.getId();
             bookmark.parentId = item.getParentId();
             bookmark.isFolder = item.isFolder();
             return bookmark;
         }
     }
 
@@ skipping 184 matching lines @@
                 public void bookmarkModelChanged() {
                     refreshWidget();
                 }
             });
         }
 
         @UiThread
         private boolean isWidgetNewlyCreated() {
             // This method relies on the fact that PREF_CURRENT_FOLDER is not yet
             // set when onCreate is called for a newly created widget.
-            long currentFolder = mPreferences.getLong(PREF_CURRENT_FOLDER, Tab.INVALID_BOOKMARK_ID);
-            return currentFolder == Tab.INVALID_BOOKMARK_ID;
+            String serializedFolder = mPreferences.getString(PREF_CURRENT_FOLDER, null);
+            return serializedFolder == null;
         }
 
         @UiThread
         private void refreshWidget() {
             mContext.sendBroadcast(new Intent(
                     BookmarkWidgetProvider.getBookmarkAppWidgetUpdateAction(mContext),
                     null, mContext, BookmarkThumbnailWidgetProvider.class)
                     .putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, mWidgetId));
         }
 
@@ skipping 19 matching lines @@
         }
 
         @BinderThread
         @Override
         public void onDataSetChanged() {
             updateBookmarkList();
         }
 
         @BinderThread
         private void updateBookmarkList() {
-            long folderIdLong = mPreferences.getLong(PREF_CURRENT_FOLDER, Tab.INVALID_BOOKMARK_ID);
-            BookmarkId folderId = folderIdLong != Tab.INVALID_BOOKMARK_ID
-                    ? new BookmarkId(folderIdLong, BookmarkType.NORMAL)
-                    : null;
-
+            BookmarkId folderId = BookmarkId
+                    .getBookmarkIdFromString(mPreferences.getString(PREF_CURRENT_FOLDER, null));
             mCurrentFolder = loadBookmarks(folderId);
-
-            mPreferences.edit()
-                .putLong(PREF_CURRENT_FOLDER, mCurrentFolder != null
-                        ? mCurrentFolder.folder.id.getId()
-                        : Tab.INVALID_BOOKMARK_ID)
-                .apply();
+            mPreferences.edit().putString(PREF_CURRENT_FOLDER, mCurrentFolder.folder.id.toString())
+                    .apply();
         }
 
         @BinderThread
         private BookmarkFolder loadBookmarks(final BookmarkId folderId) {
             final LinkedBlockingQueue<BookmarkFolder> resultQueue = new LinkedBlockingQueue<>(1);
             ThreadUtils.runOnUiThread(new Runnable() {
                 @Override
                 public void run() {
                     new BookmarkLoader(mContext, folderId, new BookmarkLoaderCallback() {
                         @Override
@@ skipping 63 matching lines @@
             }
 
             Bookmark bookmark = getBookmarkForPosition(position);
             if (bookmark == null) {
                 Log.w(TAG, "Couldn't get bookmark for position %d", position);
                 return null;
             }
 
             String title = bookmark.title;
             String url = bookmark.url;
-            long id = (bookmark == mCurrentFolder.folder)
-                    ? mCurrentFolder.parent.id.getId()
-                    : bookmark.id.getId();
+            BookmarkId id = (bookmark == mCurrentFolder.folder)
+                    ? mCurrentFolder.parent.id
+                    : bookmark.id;
 
             RemoteViews views = new RemoteViews(mContext.getPackageName(),
                     R.layout.bookmark_widget_item);
 
             // Set the title of the bookmark. Use the url as a backup.
             views.setTextViewText(R.id.title, TextUtils.isEmpty(title) ? url : title);
 
             if (bookmark == mCurrentFolder.folder) {
                 views.setImageViewResource(R.id.favicon, R.drawable.bookmark_back_normal);
             } else if (bookmark.isFolder) {
                 views.setImageViewResource(R.id.favicon, R.drawable.bookmark_folder);
             } else {
                 views.setImageViewBitmap(R.id.favicon, bookmark.favicon);
             }
 
             Intent fillIn;
             if (bookmark.isFolder) {
                 fillIn = new Intent(getChangeFolderAction(mContext))
                         .putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, mWidgetId)
-                        .putExtra(EXTRA_FOLDER_ID, id);
+                        .putExtra(EXTRA_FOLDER_ID, id.toString());
             } else {
                 fillIn = new Intent(Intent.ACTION_VIEW);
                 if (!TextUtils.isEmpty(url)) {
                     fillIn = fillIn.addCategory(Intent.CATEGORY_BROWSABLE)
                             .setData(Uri.parse(url));
                 } else {
                     fillIn = fillIn.addCategory(Intent.CATEGORY_LAUNCHER);
                 }
             }
             views.setOnClickFillInIntent(R.id.list_item, fillIn);
             return views;
         }
     }
 }