components/offline_pages/offline_page_model.h

   1 // Copyright 2015 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 COMPONENTS_OFFLINE_PAGES_OFFLINE_PAGE_MODEL_H_
   6 #define COMPONENTS_OFFLINE_PAGES_OFFLINE_PAGE_MODEL_H_
   7
   8 #include <map>
   9 #include <vector>
  10
  11 #include "base/callback.h"
  12 #include "base/macros.h"
  13 #include "base/memory/ref_counted.h"
  14 #include "base/memory/scoped_ptr.h"
  15 #include "base/memory/scoped_vector.h"
  16 #include "base/memory/weak_ptr.h"
  17 #include "base/observer_list.h"
  18 #include "base/scoped_observer.h"
  19 #include "components/bookmarks/browser/base_bookmark_model_observer.h"
  20 #include "components/keyed_service/core/keyed_service.h"
  21 #include "components/offline_pages/offline_page_archiver.h"
  22
  23 class GURL;
  24 namespace base {
  25 class SequencedTaskRunner;
  26 }
  27 namespace bookmarks {
  28 class BookmarkModel;
  29 }
  30
  31 namespace offline_pages {
  32
  33 struct OfflinePageItem;
  34 class OfflinePageMetadataStore;
  35
  36 // Service for saving pages offline, storing the offline copy and metadata, and
  37 // retrieving them upon request.
  38 //
  39 // Example usage:
  40 //   class ArchiverImpl : public OfflinePageArchiver {
  41 //     // This is a class that knows how to create archiver
  42 //     void CreateArchiver(...) override;
  43 //     ...
  44 //   }
  45 //
  46 //   // In code using the OfflinePagesModel to save a page:
  47 //   scoped_ptr<ArchiverImpl> archiver(new ArchiverImpl());
  48 //   // Callback is of type SavePageCallback.
  49 //   model->SavePage(url, archiver.Pass(), callback);
  50 //
  51 // TODO(fgorski): Things to describe:
  52 // * how to cancel requests and what to expect
  53 class OfflinePageModel : public KeyedService,
  54                          public bookmarks::BaseBookmarkModelObserver {
  55  public:
  56   // Result of saving a page offline.
  57   // A Java counterpart will be generated for this enum.
  58   // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.components.offlinepages
  59   enum class SavePageResult {
  60     SUCCESS,
  61     CANCELLED,
  62     DEVICE_FULL,
  63     CONTENT_UNAVAILABLE,
  64     ARCHIVE_CREATION_FAILED,
  65     STORE_FAILURE,
  66     ALREADY_EXISTS,
  67     // NOTE: always keep this entry at the end. Add new result types only
  68     // immediately above this line. Make sure to update the corresponding
  69     // histogram enum accordingly.
  70     RESULT_COUNT,
  71   };
  72
  73   // Result of deleting an offline page.
  74   // A Java counterpart will be generated for this enum.
  75   // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.components.offlinepages
  76   enum class DeletePageResult {
  77     SUCCESS,
  78     CANCELLED,
  79     STORE_FAILURE,
  80     DEVICE_FAILURE,
  81     NOT_FOUND,
  82     // NOTE: always keep this entry at the end. Add new result types only
  83     // immediately above this line. Make sure to update the corresponding
  84     // histogram enum accordingly.
  85     RESULT_COUNT,
  86   };
  87
  88   // Result of loading all pages.
  89   enum class LoadResult {
  90     SUCCESS,
  91     CANCELLED,
  92     STORE_FAILURE,
  93   };
  94
  95   // Observer of the OfflinePageModel.
  96   class Observer {
  97    public:
  98     // Invoked when the model has finished loading.
  99     virtual void OfflinePageModelLoaded(OfflinePageModel* model) = 0;
 100
 101    protected:
 102     virtual ~Observer() {}
 103   };
 104
 105   typedef base::Callback<void(SavePageResult)> SavePageCallback;
 106   typedef base::Callback<void(DeletePageResult)> DeletePageCallback;
 107
 108   // All blocking calls/disk access will happen on the provided |task_runner|.
 109   OfflinePageModel(
 110       scoped_ptr<OfflinePageMetadataStore> store,
 111       const scoped_refptr<base::SequencedTaskRunner>& task_runner);
 112   ~OfflinePageModel() override;
 113
 114   // Starts the OfflinePageModel and registers it as a BookmarkModelObserver.
 115   // Calling this method is optional, but offline pages will not be deleted
 116   // when the bookmark is deleted, i.e. due to sync, until this method is
 117   // called.
 118   void Start(bookmarks::BookmarkModel* model);
 119
 120   // KeyedService implementation.
 121   void Shutdown() override;
 122
 123   void AddObserver(Observer* observer);
 124   void RemoveObserver(Observer* observer);
 125
 126   // Attempts to save a page addressed by |url| offline. Requires that the model
 127   // is loaded.
 128   void SavePage(const GURL& url,
 129                 int64 bookmark_id,
 130                 scoped_ptr<OfflinePageArchiver> archiver,
 131                 const SavePageCallback& callback);
 132
 133   // Deletes an offline page related to the passed |bookmark_id|. Requires that
 134   // the model is loaded.
 135   void DeletePageByBookmarkId(int64 bookmark_id,
 136                               const DeletePageCallback& callback);
 137
 138   // Deletes offline pages related to the passed |bookmark_ids|. Requires that
 139   // the model is loaded.
 140   void DeletePagesByBookmarkId(const std::vector<int64>& bookmark_ids,
 141                                const DeletePageCallback& callback);
 142
 143   // Gets all available offline pages. Requires that the model is loaded.
 144   const std::vector<OfflinePageItem> GetAllPages() const;
 145
 146   // Gets pages that should be removed to clean up storage. Requires that the
 147   // model is loaded.
 148   const std::vector<OfflinePageItem> GetPagesToCleanUp() const;
 149
 150   // Gets an offline page associated with a specified |bookmark_id|. Returns
 151   // true if a matching offline page exists, and |offline_page| will be updated
 152   // with corresponding value, or false, if no offline page was found.
 153   bool GetPageByBookmarkId(int64 bookmark_id,
 154                            OfflinePageItem* offline_page) const;
 155
 156   // Returns an offline page that is stored as |offline_url|. nullptr is
 157   // returned if not found.
 158   const OfflinePageItem* GetPageByOfflineURL(const GURL& offline_url) const;
 159
 160   // Methods for testing only:
 161   OfflinePageMetadataStore* GetStoreForTesting();
 162
 163   bool is_loaded() const { return is_loaded_; }
 164
 165  private:
 166   typedef ScopedVector<OfflinePageArchiver> PendingArchivers;
 167
 168   // BaseBookmarkModelObserver:
 169   void BookmarkModelChanged() override;
 170   void BookmarkNodeRemoved(bookmarks::BookmarkModel* model,
 171                            const bookmarks::BookmarkNode* parent,
 172                            int old_index,
 173                            const bookmarks::BookmarkNode* node,
 174                            const std::set<GURL>& removed_urls) override;
 175
 176   // Callback for loading pages from the offline page metadata store.
 177   void OnLoadDone(bool success,
 178                   const std::vector<OfflinePageItem>& offline_pages);
 179
 180   // Steps for saving a page offline.
 181   void OnCreateArchiveDone(const GURL& requested_url,
 182                            int64 bookmark_id,
 183                            const SavePageCallback& callback,
 184                            OfflinePageArchiver* archiver,
 185                            OfflinePageArchiver::ArchiverResult result,
 186                            const GURL& url,
 187                            const base::FilePath& file_path,
 188                            int64 file_size);
 189   void OnAddOfflinePageDone(OfflinePageArchiver* archiver,
 190                             const SavePageCallback& callback,
 191                             const OfflinePageItem& offline_page,
 192                             bool success);
 193   void InformSavePageDone(const SavePageCallback& callback,
 194                           SavePageResult result);
 195   void DeletePendingArchiver(OfflinePageArchiver* archiver);
 196
 197   // Steps for deleting files and data for an offline page.
 198   void OnDeleteArchiveFilesDone(
 199       const std::vector<int64>& bookmark_ids,
 200       const DeletePageCallback& callback,
 201       const bool* success);
 202   void OnRemoveOfflinePagesDone(const std::vector<int64>& bookmark_ids,
 203                                 const DeletePageCallback& callback,
 204                                 bool success);
 205   void InformDeletePageDone(const DeletePageCallback& callback,
 206                             DeletePageResult result);
 207
 208   // Persistent store for offline page metadata.
 209   scoped_ptr<OfflinePageMetadataStore> store_;
 210
 211   // The observers.
 212   base::ObserverList<Observer> observers_;
 213
 214   bool is_loaded_;
 215
 216   // In memory copy of the offline page metadata, keyed by bookmark IDs.
 217   std::map<int64, OfflinePageItem> offline_pages_;
 218
 219   scoped_refptr<base::SequencedTaskRunner> task_runner_;
 220
 221   // Pending archivers owned by this model.
 222   PendingArchivers pending_archivers_;
 223
 224   // Delayed tasks that should be invoked after the loading is done.
 225   std::vector<base::Closure> delayed_tasks_;
 226
 227   ScopedObserver<bookmarks::BookmarkModel, bookmarks::BookmarkModelObserver>
 228       scoped_observer_;
 229
 230   base::WeakPtrFactory<OfflinePageModel> weak_ptr_factory_;
 231
 232   DISALLOW_COPY_AND_ASSIGN(OfflinePageModel);
 233 };
 234
 235 }  // namespace offline_pages
 236
 237 #endif  // COMPONENTS_OFFLINE_PAGES_OFFLINE_PAGE_MODEL_H_