chrome/browser/extensions/api/bookmarks/bookmarks_api.h

   1 // Copyright (c) 2012 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_EXTENSIONS_API_BOOKMARKS_BOOKMARKS_API_H_
   6 #define CHROME_BROWSER_EXTENSIONS_API_BOOKMARKS_BOOKMARKS_API_H_
   7
   8 #include <list>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "base/compiler_specific.h"
  13 #include "base/memory/ref_counted.h"
  14 #include "chrome/browser/extensions/chrome_extension_function.h"
  15 #include "components/bookmarks/browser/base_bookmark_model_observer.h"
  16 #include "components/bookmarks/browser/bookmark_node.h"
  17 #include "extensions/browser/browser_context_keyed_api_factory.h"
  18 #include "extensions/browser/event_router.h"
  19 #include "ui/shell_dialogs/select_file_dialog.h"
  20
  21 namespace base {
  22 class FilePath;
  23 class ListValue;
  24 }
  25
  26 namespace bookmarks {
  27 class BookmarkModel;
  28 class ManagedBookmarkService;
  29 }
  30
  31 namespace content {
  32 class BrowserContext;
  33 }
  34
  35 namespace extensions {
  36
  37 namespace api {
  38 namespace bookmarks {
  39 struct CreateDetails;
  40 }
  41 }
  42
  43 // Observes BookmarkModel and then routes the notifications as events to
  44 // the extension system.
  45 class BookmarkEventRouter : public bookmarks::BookmarkModelObserver {
  46  public:
  47   explicit BookmarkEventRouter(Profile* profile);
  48   ~BookmarkEventRouter() override;
  49
  50   // bookmarks::BookmarkModelObserver:
  51   void BookmarkModelLoaded(bookmarks::BookmarkModel* model,
  52                            bool ids_reassigned) override;
  53   void BookmarkModelBeingDeleted(bookmarks::BookmarkModel* model) override;
  54   void BookmarkNodeMoved(bookmarks::BookmarkModel* model,
  55                          const bookmarks::BookmarkNode* old_parent,
  56                          int old_index,
  57                          const bookmarks::BookmarkNode* new_parent,
  58                          int new_index) override;
  59   void BookmarkNodeAdded(bookmarks::BookmarkModel* model,
  60                          const bookmarks::BookmarkNode* parent,
  61                          int index) override;
  62   void BookmarkNodeRemoved(bookmarks::BookmarkModel* model,
  63                            const bookmarks::BookmarkNode* parent,
  64                            int old_index,
  65                            const bookmarks::BookmarkNode* node,
  66                            const std::set<GURL>& removed_urls) override;
  67   void BookmarkAllUserNodesRemoved(bookmarks::BookmarkModel* model,
  68                                    const std::set<GURL>& removed_urls) override;
  69   void BookmarkNodeChanged(bookmarks::BookmarkModel* model,
  70                            const bookmarks::BookmarkNode* node) override;
  71   void BookmarkNodeFaviconChanged(bookmarks::BookmarkModel* model,
  72                                   const bookmarks::BookmarkNode* node) override;
  73   void BookmarkNodeChildrenReordered(
  74       bookmarks::BookmarkModel* model,
  75       const bookmarks::BookmarkNode* node) override;
  76   void ExtensiveBookmarkChangesBeginning(
  77       bookmarks::BookmarkModel* model) override;
  78   void ExtensiveBookmarkChangesEnded(bookmarks::BookmarkModel* model) override;
  79
  80  private:
  81   // Helper to actually dispatch an event to extension listeners.
  82   void DispatchEvent(events::HistogramValue histogram_value,
  83                      const std::string& event_name,
  84                      scoped_ptr<base::ListValue> event_args);
  85
  86   content::BrowserContext* browser_context_;
  87   bookmarks::BookmarkModel* model_;
  88   bookmarks::ManagedBookmarkService* managed_;
  89
  90   DISALLOW_COPY_AND_ASSIGN(BookmarkEventRouter);
  91 };
  92
  93 class BookmarksAPI : public BrowserContextKeyedAPI,
  94                      public EventRouter::Observer {
  95  public:
  96   explicit BookmarksAPI(content::BrowserContext* context);
  97   ~BookmarksAPI() override;
  98
  99   // KeyedService implementation.
 100   void Shutdown() override;
 101
 102   // BrowserContextKeyedAPI implementation.
 103   static BrowserContextKeyedAPIFactory<BookmarksAPI>* GetFactoryInstance();
 104
 105   // EventRouter::Observer implementation.
 106   void OnListenerAdded(const EventListenerInfo& details) override;
 107
 108  private:
 109   friend class BrowserContextKeyedAPIFactory<BookmarksAPI>;
 110
 111   content::BrowserContext* browser_context_;
 112
 113   // BrowserContextKeyedAPI implementation.
 114   static const char* service_name() {
 115     return "BookmarksAPI";
 116   }
 117   static const bool kServiceIsNULLWhileTesting = true;
 118
 119   // Created lazily upon OnListenerAdded.
 120   scoped_ptr<BookmarkEventRouter> bookmark_event_router_;
 121 };
 122
 123 class BookmarksFunction : public ChromeAsyncExtensionFunction,
 124                           public bookmarks::BaseBookmarkModelObserver {
 125  public:
 126   // AsyncExtensionFunction:
 127   bool RunAsync() override;
 128
 129  protected:
 130   ~BookmarksFunction() override {}
 131
 132   // RunAsync semantic equivalent called when the bookmarks are ready.
 133   virtual bool RunOnReady() = 0;
 134
 135   // Helper to get the BookmarkModel.
 136   bookmarks::BookmarkModel* GetBookmarkModel();
 137
 138   // Helper to get the ManagedBookmarkService.
 139   bookmarks::ManagedBookmarkService* GetManagedBookmarkService();
 140
 141   // Helper to get the bookmark id as int64 from the given string id.
 142   // Sets error_ to an error string if the given id string can't be parsed
 143   // as an int64. In case of error, doesn't change id and returns false.
 144   bool GetBookmarkIdAsInt64(const std::string& id_string, int64* id);
 145
 146   // Helper to get the bookmark node from a given string id.
 147   // If the given id can't be parsed or doesn't refer to a valid node, sets
 148   // error_ and returns NULL.
 149   const bookmarks::BookmarkNode* GetBookmarkNodeFromId(
 150       const std::string& id_string);
 151
 152   // Helper to create a bookmark node from a CreateDetails object. If a node
 153   // can't be created based on the given details, sets error_ and returns NULL.
 154   const bookmarks::BookmarkNode* CreateBookmarkNode(
 155       bookmarks::BookmarkModel* model,
 156       const api::bookmarks::CreateDetails& details,
 157       const bookmarks::BookmarkNode::MetaInfoMap* meta_info);
 158
 159   // Helper that checks if bookmark editing is enabled. If it's not, this sets
 160   // error_ to the appropriate error string.
 161   bool EditBookmarksEnabled();
 162
 163   // Helper that checks if |node| can be modified. Returns false if |node|
 164   // is NULL, or a managed node, or the root node. In these cases the node
 165   // can't be edited, can't have new child nodes appended, and its direct
 166   // children can't be moved or reordered.
 167   bool CanBeModified(const bookmarks::BookmarkNode* node);
 168
 169  private:
 170   // bookmarks::BaseBookmarkModelObserver:
 171   void BookmarkModelChanged() override;
 172   void BookmarkModelLoaded(bookmarks::BookmarkModel* model,
 173                            bool ids_reassigned) override;
 174
 175   void RunAndSendResponse();
 176 };
 177
 178 class BookmarksGetFunction : public BookmarksFunction {
 179  public:
 180   DECLARE_EXTENSION_FUNCTION("bookmarks.get", BOOKMARKS_GET)
 181
 182  protected:
 183   ~BookmarksGetFunction() override {}
 184
 185   // BookmarksFunction:
 186   bool RunOnReady() override;
 187 };
 188
 189 class BookmarksGetChildrenFunction : public BookmarksFunction {
 190  public:
 191   DECLARE_EXTENSION_FUNCTION("bookmarks.getChildren", BOOKMARKS_GETCHILDREN)
 192
 193  protected:
 194   ~BookmarksGetChildrenFunction() override {}
 195
 196   // BookmarksFunction:
 197   bool RunOnReady() override;
 198 };
 199
 200 class BookmarksGetRecentFunction : public BookmarksFunction {
 201  public:
 202   DECLARE_EXTENSION_FUNCTION("bookmarks.getRecent", BOOKMARKS_GETRECENT)
 203
 204  protected:
 205   ~BookmarksGetRecentFunction() override {}
 206
 207   // BookmarksFunction:
 208   bool RunOnReady() override;
 209 };
 210
 211 class BookmarksGetTreeFunction : public BookmarksFunction {
 212  public:
 213   DECLARE_EXTENSION_FUNCTION("bookmarks.getTree", BOOKMARKS_GETTREE)
 214
 215  protected:
 216   ~BookmarksGetTreeFunction() override {}
 217
 218   // BookmarksFunction:
 219   bool RunOnReady() override;
 220 };
 221
 222 class BookmarksGetSubTreeFunction : public BookmarksFunction {
 223  public:
 224   DECLARE_EXTENSION_FUNCTION("bookmarks.getSubTree", BOOKMARKS_GETSUBTREE)
 225
 226  protected:
 227   ~BookmarksGetSubTreeFunction() override {}
 228
 229   // BookmarksFunction:
 230   bool RunOnReady() override;
 231 };
 232
 233 class BookmarksSearchFunction : public BookmarksFunction {
 234  public:
 235   DECLARE_EXTENSION_FUNCTION("bookmarks.search", BOOKMARKS_SEARCH)
 236
 237  protected:
 238   ~BookmarksSearchFunction() override {}
 239
 240   // BookmarksFunction:
 241   bool RunOnReady() override;
 242 };
 243
 244 class BookmarksRemoveFunction : public BookmarksFunction {
 245  public:
 246   DECLARE_EXTENSION_FUNCTION("bookmarks.remove", BOOKMARKS_REMOVE)
 247
 248   // Returns true on successful parse and sets invalid_id to true if conversion
 249   // from id string to int64 failed.
 250   static bool ExtractIds(const base::ListValue* args,
 251                          std::list<int64>* ids,
 252                          bool* invalid_id);
 253
 254  protected:
 255   ~BookmarksRemoveFunction() override {}
 256
 257   // BookmarksFunction:
 258   bool RunOnReady() override;
 259 };
 260
 261 class BookmarksRemoveTreeFunction : public BookmarksRemoveFunction {
 262  public:
 263   DECLARE_EXTENSION_FUNCTION("bookmarks.removeTree", BOOKMARKS_REMOVETREE)
 264
 265  protected:
 266   ~BookmarksRemoveTreeFunction() override {}
 267 };
 268
 269 class BookmarksCreateFunction : public BookmarksFunction {
 270  public:
 271   DECLARE_EXTENSION_FUNCTION("bookmarks.create", BOOKMARKS_CREATE)
 272
 273  protected:
 274   ~BookmarksCreateFunction() override {}
 275
 276   // BookmarksFunction:
 277   bool RunOnReady() override;
 278 };
 279
 280 class BookmarksMoveFunction : public BookmarksFunction {
 281  public:
 282   DECLARE_EXTENSION_FUNCTION("bookmarks.move", BOOKMARKS_MOVE)
 283
 284   static bool ExtractIds(const base::ListValue* args,
 285                          std::list<int64>* ids,
 286                          bool* invalid_id);
 287
 288  protected:
 289   ~BookmarksMoveFunction() override {}
 290
 291   // BookmarksFunction:
 292   bool RunOnReady() override;
 293 };
 294
 295 class BookmarksUpdateFunction : public BookmarksFunction {
 296  public:
 297   DECLARE_EXTENSION_FUNCTION("bookmarks.update", BOOKMARKS_UPDATE)
 298
 299   static bool ExtractIds(const base::ListValue* args,
 300                          std::list<int64>* ids,
 301                          bool* invalid_id);
 302
 303  protected:
 304   ~BookmarksUpdateFunction() override {}
 305
 306   // BookmarksFunction:
 307   bool RunOnReady() override;
 308 };
 309
 310 class BookmarksIOFunction : public BookmarksFunction,
 311                             public ui::SelectFileDialog::Listener {
 312  public:
 313   BookmarksIOFunction();
 314
 315   void FileSelected(const base::FilePath& path,
 316                     int index,
 317                     void* params) override = 0;
 318
 319   // ui::SelectFileDialog::Listener:
 320   void MultiFilesSelected(const std::vector<base::FilePath>& files,
 321                           void* params) override;
 322   void FileSelectionCanceled(void* params) override;
 323
 324   void SelectFile(ui::SelectFileDialog::Type type);
 325
 326  protected:
 327   ~BookmarksIOFunction() override;
 328
 329  private:
 330   void ShowSelectFileDialog(
 331       ui::SelectFileDialog::Type type,
 332       const base::FilePath& default_path);
 333
 334  protected:
 335   scoped_refptr<ui::SelectFileDialog> select_file_dialog_;
 336 };
 337
 338 class BookmarksImportFunction : public BookmarksIOFunction {
 339  public:
 340   DECLARE_EXTENSION_FUNCTION("bookmarks.import", BOOKMARKS_IMPORT)
 341
 342   // BookmarkManagerIOFunction:
 343   void FileSelected(const base::FilePath& path,
 344                     int index,
 345                     void* params) override;
 346
 347  private:
 348   ~BookmarksImportFunction() override {}
 349
 350   // BookmarksFunction:
 351   bool RunOnReady() override;
 352 };
 353
 354 class BookmarksExportFunction : public BookmarksIOFunction {
 355  public:
 356   DECLARE_EXTENSION_FUNCTION("bookmarks.export", BOOKMARKS_EXPORT)
 357
 358   // BookmarkManagerIOFunction:
 359   void FileSelected(const base::FilePath& path,
 360                     int index,
 361                     void* params) override;
 362
 363  private:
 364   ~BookmarksExportFunction() override {}
 365
 366   // BookmarksFunction:
 367   bool RunOnReady() override;
 368 };
 369
 370 }  // namespace extensions
 371
 372 #endif  // CHROME_BROWSER_EXTENSIONS_API_BOOKMARKS_BOOKMARKS_API_H_