Refactor the offline page storage to include client namespace and id.

components/offline_pages/offline_page_model.h

 // 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.
 
 #ifndef COMPONENTS_OFFLINE_PAGES_OFFLINE_PAGE_MODEL_H_
 #define COMPONENTS_OFFLINE_PAGES_OFFLINE_PAGE_MODEL_H_
 
 #include <stdint.h>
 
 #include <map>
@@ skipping 19 matching lines @@
 class SequencedTaskRunner;
 class Time;
 class TimeDelta;
 }
 namespace bookmarks {
 class BookmarkModel;
 }
 
 namespace offline_pages {
 
+class ClientId;
+
 struct OfflinePageItem;
 class OfflinePageMetadataStore;
 
 // Service for saving pages offline, storing the offline copy and metadata, and
 // retrieving them upon request.
 //
 // Example usage:
 //   class ArchiverImpl : public OfflinePageArchiver {
 //     // This is a class that knows how to create archiver
 //     void CreateArchiver(...) override;
@@ skipping 55 matching lines @@
   // Observer of the OfflinePageModel.
   class Observer {
    public:
     // Invoked when the model has finished loading.
     virtual void OfflinePageModelLoaded(OfflinePageModel* model) = 0;
 
     // Invoked when the model is being updated, due to adding, removing or
     // updating an offline page.
     virtual void OfflinePageModelChanged(OfflinePageModel* model) = 0;
 
-    // Invoked when an offline copy related to |bookmark_id| was deleted.
+    // Invoked when an offline copy related to |offline_id| was deleted.
     // In can be invoked as a result of |CheckForExternalFileDeletion|, if a
     // deleted page is detected.
-    virtual void OfflinePageDeleted(int64_t bookmark_id) = 0;
+    virtual void OfflinePageDeleted(int64_t offline_id) = 0;
 
    protected:
     virtual ~Observer() {}
   };
 
   typedef base::Callback<void(SavePageResult)> SavePageCallback;
   typedef base::Callback<void(DeletePageResult)> DeletePageCallback;
 
   // Returns true if an offline copy can be saved for the given URL.
   static bool CanSavePage(const GURL& url);
@@ skipping 14 matching lines @@
 
   // KeyedService implementation.
   void Shutdown() override;
 
   void AddObserver(Observer* observer);
   void RemoveObserver(Observer* observer);
 
   // Attempts to save a page addressed by |url| offline. Requires that the model
   // is loaded.
   void SavePage(const GURL& url,
-                int64_t bookmark_id,
+                int64_t offline_id,

[Dmitry Titov, 2016/02/12 21:46:51]

I don't know if you want to remove this parameter in one of the next patches,
but with ClientId there is no need to pass offline_id. It can be cooked up when
a page is saved and perhaps returned in SavePageCallback, right?

[bburns, 2016/02/20 01:14:18]

yes, I will do this in the next CL.

+                const ClientId& client_id,
                 scoped_ptr<OfflinePageArchiver> archiver,
                 const SavePageCallback& callback);
 
-  // Marks that the offline page related to the passed |bookmark_id| has been
+  // Marks that the offline page related to the passed |offline_id| has been
   // accessed. Its access info, including last access time and access count,
   // will be updated. Requires that the model is loaded.
-  void MarkPageAccessed(int64_t bookmark_id);
+  void MarkPageAccessed(int64_t offline_id);
 
-  // Marks that the offline page related to the passed |bookmark_id| was going
+  // Marks that the offline page related to the passed |offline_id| was going
   // to be deleted. The deletion will occur in a short while. The undo can be
   // done before this. Requires that the model is loaded.
-  void MarkPageForDeletion(int64_t bookmark_id,
+  void MarkPageForDeletion(int64_t offline_id,
                            const DeletePageCallback& callback);
 
-  // Deletes an offline page related to the passed |bookmark_id|. Requires that
+  // Deletes an offline page related to the passed |offline_id|. Requires that
   // the model is loaded.
-  void DeletePageByBookmarkId(int64_t bookmark_id,
+  void DeletePageByOfflineId(int64_t offline_id,
                               const DeletePageCallback& callback);
 
-  // Deletes offline pages related to the passed |bookmark_ids|. Requires that
+  // Deletes offline pages related to the passed |offline_ids|. Requires that
   // the model is loaded.
-  void DeletePagesByBookmarkId(const std::vector<int64_t>& bookmark_ids,
-                               const DeletePageCallback& callback);
+  void DeletePagesByOfflineId(const std::vector<int64_t>& offline_ids,
+                              const DeletePageCallback& callback);
 
   // Wipes out all the data by deleting all saved files and clearing the store.
   void ClearAll(const base::Closure& callback);
 
   // Returns true if there're offline pages.
   bool HasOfflinePages() const;
 
   // Gets all available offline pages. Requires that the model is loaded.
   const std::vector<OfflinePageItem> GetAllPages() const;
 
   // Gets pages that should be removed to clean up storage. Requires that the
   // model is loaded.
   const std::vector<OfflinePageItem> GetPagesToCleanUp() const;
 
-  // Returns an offline page associated with a specified |bookmark_id|. nullptr
+  // Returns an offline page associated with a specified |offline_id|. nullptr
   // is returned if not found.
-  const OfflinePageItem* GetPageByBookmarkId(int64_t bookmark_id) const;
+  const OfflinePageItem* GetPageByOfflineId(int64_t offline_id) const;
 
   // Returns an offline page that is stored as |offline_url|. A nullptr is
   // returned if not found.
   const OfflinePageItem* GetPageByOfflineURL(const GURL& offline_url) const;
 
   // Returns an offline page saved for |online_url|. A nullptr is returned if
   // not found.
   const OfflinePageItem* GetPageByOnlineURL(const GURL& online_url) const;
 
   // Checks that all of the offline pages have corresponding offline copies.
@@ skipping 28 matching lines @@
 
   // Callback for ensuring archive directory is created.
   void OnEnsureArchivesDirCreatedDone();
 
   // Callback for loading pages from the offline page metadata store.
   void OnLoadDone(OfflinePageMetadataStore::LoadStatus load_status,
                   const std::vector<OfflinePageItem>& offline_pages);
 
   // Steps for saving a page offline.
   void OnCreateArchiveDone(const GURL& requested_url,
-                           int64_t bookmark_id,
+                           int64_t offline_id,
+                           const ClientId& client_id,
                            const base::Time& start_time,
                            const SavePageCallback& callback,
                            OfflinePageArchiver* archiver,
                            OfflinePageArchiver::ArchiverResult result,
                            const GURL& url,
                            const base::FilePath& file_path,
                            int64_t file_size);
   void OnAddOfflinePageDone(OfflinePageArchiver* archiver,
                             const SavePageCallback& callback,
                             const OfflinePageItem& offline_page,
                             bool success);
   void InformSavePageDone(const SavePageCallback& callback,
                           SavePageResult result);
   void DeletePendingArchiver(OfflinePageArchiver* archiver);
 
   // Steps for deleting files and data for an offline page.
-  void OnDeleteArchiveFilesDone(const std::vector<int64_t>& bookmark_ids,
+  void OnDeleteArchiveFilesDone(const std::vector<int64_t>& offline_ids,
                                 const DeletePageCallback& callback,
                                 const bool* success);
-  void OnRemoveOfflinePagesDone(const std::vector<int64_t>& bookmark_ids,
+  void OnRemoveOfflinePagesDone(const std::vector<int64_t>& offline_ids,
                                 const DeletePageCallback& callback,
                                 bool success);
   void InformDeletePageDone(const DeletePageCallback& callback,
                             DeletePageResult result);
 
   void OnMarkPageAccesseDone(const OfflinePageItem& offline_page_item,
                              bool success);
 
   // Steps for marking an offline page for deletion that can be undone.
   void OnMarkPageForDeletionDone(const OfflinePageItem& offline_page_item,
                                  const DeletePageCallback& callback,
                                  bool success);
   void FinalizePageDeletion();
 
   // Steps for undoing an offline page deletion.
-  void UndoPageDeletion(int64_t bookmark_id);
+  void UndoPageDeletion(int64_t offline_id);
   void OnUndoOfflinePageDone(const OfflinePageItem& offline_page, bool success);
 
   // Callbacks for checking if offline pages are missing archive files.
   void OnFindPagesMissingArchiveFile(
       const std::vector<int64_t>* pages_missing_archive_file);
   void OnRemoveOfflinePagesMissingArchiveFileDone(
-      const std::vector<int64_t>& bookmark_ids,
+      const std::vector<int64_t>& offline_ids,
       OfflinePageModel::DeletePageResult result);
 
   // Steps for clearing all.
   void OnRemoveAllFilesDoneForClearAll(const base::Closure& callback,
                                        DeletePageResult result);
   void OnResetStoreDoneForClearAll(const base::Closure& callback, bool success);
   void OnReloadStoreDoneForClearAll(
       const base::Closure& callback,
       OfflinePageMetadataStore::LoadStatus load_status,
       const std::vector<OfflinePageItem>& offline_pages);
@@ skipping 26 matching lines @@
       scoped_observer_;
 
   base::WeakPtrFactory<OfflinePageModel> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(OfflinePageModel);
 };
 
 }  // namespace offline_pages
 
 #endif  // COMPONENTS_OFFLINE_PAGES_OFFLINE_PAGE_MODEL_H_