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