chrome/browser/android/bookmarks/bookmarks_bridge.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_ANDROID_BOOKMARKS_BOOKMARKS_BRIDGE_H_
   6 #define CHROME_BROWSER_ANDROID_BOOKMARKS_BOOKMARKS_BRIDGE_H_
   7
   8 #include <jni.h>
   9
  10 #include "base/android/jni_android.h"
  11 #include "base/android/jni_weak_ref.h"
  12 #include "base/basictypes.h"
  13 #include "base/compiler_specific.h"
  14 #include "chrome/browser/android/bookmarks/partner_bookmarks_shim.h"
  15 #include "chrome/browser/bookmarks/chrome_bookmark_client.h"
  16 #include "components/bookmarks/browser/base_bookmark_model_observer.h"
  17 #include "components/bookmarks/common/android/bookmark_id.h"
  18
  19 namespace bookmarks {
  20 class ScopedGroupBookmarkActions;
  21 }
  22
  23 class Profile;
  24
  25 // The delegate to fetch bookmarks information for the Android native
  26 // bookmark page. This fetches the bookmarks, title, urls, folder
  27 // hierarchy.
  28 class BookmarksBridge : public bookmarks::BaseBookmarkModelObserver,
  29                         public PartnerBookmarksShim::Observer {
  30  public:
  31   BookmarksBridge(JNIEnv* env, jobject obj, jobject j_profile);
  32   void Destroy(JNIEnv*, jobject);
  33
  34   static bool RegisterBookmarksBridge(JNIEnv* env);
  35
  36   bool IsDoingExtensiveChanges(JNIEnv* env, jobject obj);
  37
  38   void LoadEmptyPartnerBookmarkShimForTesting(JNIEnv* env, jobject obj);
  39
  40   base::android::ScopedJavaLocalRef<jobject> GetBookmarkByID(
  41       JNIEnv* env,
  42       jobject obj,
  43       jlong id,
  44       jint type);
  45
  46   void GetPermanentNodeIDs(JNIEnv* env,
  47                            jobject obj,
  48                            jobject j_result_obj);
  49
  50   void GetTopLevelFolderParentIDs(JNIEnv* env,
  51                                   jobject obj,
  52                                   jobject j_result_obj);
  53
  54   void GetTopLevelFolderIDs(JNIEnv* env,
  55                             jobject obj,
  56                             jboolean get_special,
  57                             jboolean get_normal,
  58                             jobject j_result_obj);
  59
  60   void GetAllFoldersWithDepths(JNIEnv* env,
  61                                jobject obj,
  62                                jobject j_folders_obj,
  63                                jobject j_depths_obj);
  64
  65   base::android::ScopedJavaLocalRef<jobject> GetRootFolderId(JNIEnv* env,
  66                                                              jobject obj);
  67
  68   base::android::ScopedJavaLocalRef<jobject> GetMobileFolderId(JNIEnv* env,
  69                                                                jobject obj);
  70
  71   base::android::ScopedJavaLocalRef<jobject> GetOtherFolderId(JNIEnv* env,
  72                                                               jobject obj);
  73
  74   base::android::ScopedJavaLocalRef<jobject> GetDesktopFolderId(JNIEnv* env,
  75                                                                 jobject obj);
  76
  77   void GetChildIDs(JNIEnv* env,
  78                    jobject obj,
  79                    jlong id,
  80                    jint type,
  81                    jboolean get_folders,
  82                    jboolean get_bookmarks,
  83                    jobject j_result_obj);
  84
  85   base::android::ScopedJavaLocalRef<jobject> GetChildAt(JNIEnv* env,
  86                                                         jobject obj,
  87                                                         jlong id,
  88                                                         jint type,
  89                                                         jint index);
  90
  91   void GetAllBookmarkIDsOrderedByCreationDate(JNIEnv* env,
  92                                               jobject obj,
  93                                               jobject j_result_obj);
  94
  95   void SetBookmarkTitle(JNIEnv* env,
  96                         jobject obj,
  97                         jlong id,
  98                         jint type,
  99                         jstring title);
 100
 101   void SetBookmarkUrl(JNIEnv* env,
 102                       jobject obj,
 103                       jlong id,
 104                       jint type,
 105                       jstring url);
 106
 107   bool DoesBookmarkExist(JNIEnv* env, jobject obj, jlong id, jint type);
 108
 109   void GetBookmarksForFolder(JNIEnv* env,
 110                              jobject obj,
 111                              jobject j_folder_id_obj,
 112                              jobject j_callback_obj,
 113                              jobject j_result_obj);
 114
 115   jint GetBookmarkCountForFolder(JNIEnv* env,
 116                                  jobject obj,
 117                                  jobject j_folder_id_obj);
 118
 119   void GetCurrentFolderHierarchy(JNIEnv* env,
 120                                  jobject obj,
 121                                  jobject j_folder_id_obj,
 122                                  jobject j_callback_obj,
 123                                  jobject j_result_obj);
 124
 125   void SearchBookmarks(JNIEnv* env,
 126                        jobject obj,
 127                        jobject j_list,
 128                        jstring j_query,
 129                        jint max_results);
 130
 131   base::android::ScopedJavaLocalRef<jobject> AddFolder(JNIEnv* env,
 132                                                        jobject obj,
 133                                                        jobject j_parent_id_obj,
 134                                                        jint index,
 135                                                        jstring j_title);
 136
 137   void DeleteBookmark(JNIEnv* env, jobject obj, jobject j_bookmark_id_obj);
 138
 139   void MoveBookmark(JNIEnv* env,
 140                     jobject obj,
 141                     jobject j_bookmark_id_obj,
 142                     jobject j_parent_id_obj,
 143                     jint index);
 144
 145   base::android::ScopedJavaLocalRef<jobject> AddBookmark(
 146       JNIEnv* env,
 147       jobject obj,
 148       jobject j_parent_id_obj,
 149       jint index,
 150       jstring j_title,
 151       jstring j_url);
 152
 153   void Undo(JNIEnv* env, jobject obj);
 154
 155   void StartGroupingUndos(JNIEnv* env, jobject obj);
 156
 157   void EndGroupingUndos(JNIEnv* env, jobject obj);
 158
 159   base::string16 GetTitle(const bookmarks::BookmarkNode* node) const;
 160
 161  private:
 162   ~BookmarksBridge() override;
 163
 164   base::android::ScopedJavaLocalRef<jobject> CreateJavaBookmark(
 165       const bookmarks::BookmarkNode* node);
 166   void ExtractBookmarkNodeInformation(const bookmarks::BookmarkNode* node,
 167                                       jobject j_result_obj);
 168   const bookmarks::BookmarkNode* GetNodeByID(long node_id, int type);
 169   const bookmarks::BookmarkNode* GetFolderWithFallback(long folder_id,
 170                                                        int type);
 171   // Returns whether |node| can be modified by the user.
 172   bool IsEditable(const bookmarks::BookmarkNode* node) const;
 173   // Returns whether |node| is a managed bookmark.
 174   bool IsManaged(const bookmarks::BookmarkNode* node) const;
 175   const bookmarks::BookmarkNode* GetParentNode(
 176       const bookmarks::BookmarkNode* node);
 177   int GetBookmarkType(const bookmarks::BookmarkNode* node);
 178   bool IsReachable(const bookmarks::BookmarkNode* node) const;
 179   bool IsLoaded() const;
 180   bool IsFolderAvailable(const bookmarks::BookmarkNode* folder) const;
 181   void NotifyIfDoneLoading();
 182
 183   // Override bookmarks::BaseBookmarkModelObserver.
 184   // Called when there are changes to the bookmark model that don't trigger
 185   // any of the other callback methods. For example, this is called when
 186   // partner bookmarks change.
 187   void BookmarkModelChanged() override;
 188   void BookmarkModelLoaded(bookmarks::BookmarkModel* model,
 189                            bool ids_reassigned) override;
 190   void BookmarkModelBeingDeleted(bookmarks::BookmarkModel* model) override;
 191   void BookmarkNodeMoved(bookmarks::BookmarkModel* model,
 192                          const bookmarks::BookmarkNode* old_parent,
 193                          int old_index,
 194                          const bookmarks::BookmarkNode* new_parent,
 195                          int new_index) override;
 196   void BookmarkNodeAdded(bookmarks::BookmarkModel* model,
 197                          const bookmarks::BookmarkNode* parent,
 198                          int index) override;
 199   void BookmarkNodeRemoved(bookmarks::BookmarkModel* model,
 200                            const bookmarks::BookmarkNode* parent,
 201                            int old_index,
 202                            const bookmarks::BookmarkNode* node,
 203                            const std::set<GURL>& removed_urls) override;
 204   void BookmarkAllUserNodesRemoved(bookmarks::BookmarkModel* model,
 205                                    const std::set<GURL>& removed_urls) override;
 206   void BookmarkNodeChanged(bookmarks::BookmarkModel* model,
 207                            const bookmarks::BookmarkNode* node) override;
 208   void BookmarkNodeChildrenReordered(
 209       bookmarks::BookmarkModel* model,
 210       const bookmarks::BookmarkNode* node) override;
 211   void ExtensiveBookmarkChangesBeginning(
 212       bookmarks::BookmarkModel* model) override;
 213   void ExtensiveBookmarkChangesEnded(bookmarks::BookmarkModel* model) override;
 214
 215   // Override PartnerBookmarksShim::Observer
 216   void PartnerShimChanged(PartnerBookmarksShim* shim) override;
 217   void PartnerShimLoaded(PartnerBookmarksShim* shim) override;
 218   void ShimBeingDeleted(PartnerBookmarksShim* shim) override;
 219
 220   Profile* profile_;
 221   JavaObjectWeakGlobalRef weak_java_ref_;
 222   bookmarks::BookmarkModel* bookmark_model_;  // weak
 223   ChromeBookmarkClient* client_;   // weak
 224   scoped_ptr<bookmarks::ScopedGroupBookmarkActions> grouped_bookmark_actions_;
 225
 226   // Information about the Partner bookmarks (must check for IsLoaded()).
 227   // This is owned by profile.
 228   PartnerBookmarksShim* partner_bookmarks_shim_;
 229
 230   DISALLOW_COPY_AND_ASSIGN(BookmarksBridge);
 231 };
 232
 233 #endif  // CHROME_BROWSER_ANDROID_BOOKMARKS_BOOKMARKS_BRIDGE_H_