[Offline pages] Extracting callbacks from the Offline Page Model

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>
 #include <memory>
 #include <set>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/files/file_path.h"
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_vector.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
 #include "base/optional.h"
 #include "base/supports_user_data.h"
 #include "components/keyed_service/core/keyed_service.h"
 #include "components/offline_pages/offline_page_archiver.h"
 #include "components/offline_pages/offline_page_metadata_store.h"
+#include "components/offline_pages/offline_page_types.h"
 
 class GURL;
 namespace base {
 class SequencedTaskRunner;
 class Time;
 class TimeDelta;
 class TimeTicks;
 }
 
 namespace offline_pages {
@@ skipping 20 matching lines @@
 //
 //   // In code using the OfflinePagesModel to save a page:
 //   std::unique_ptr<ArchiverImpl> archiver(new ArchiverImpl());
 //   // Callback is of type SavePageCallback.
 //   model->SavePage(url, std::move(archiver), callback);
 //
 // TODO(fgorski): Things to describe:
 // * how to cancel requests and what to expect
 class OfflinePageModel : public KeyedService, public base::SupportsUserData {
  public:
-  // Result of saving a page offline.
-  // A Java counterpart will be generated for this enum.
-  // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.components.offlinepages
-  enum class SavePageResult {
-    SUCCESS,
-    CANCELLED,
-    DEVICE_FULL,
-    CONTENT_UNAVAILABLE,
-    ARCHIVE_CREATION_FAILED,
-    STORE_FAILURE,
-    ALREADY_EXISTS,
-    // Certain pages, i.e. file URL or NTP, will not be saved because these
-    // are already locally accessible.
-    SKIPPED,
-    SECURITY_CERTIFICATE_ERROR,
-    // NOTE: always keep this entry at the end. Add new result types only
-    // immediately above this line. Make sure to update the corresponding
-    // histogram enum accordingly.
-    RESULT_COUNT,
-  };
-
-  // Result of deleting an offline page.
-  // A Java counterpart will be generated for this enum.
-  // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.components.offlinepages
-  enum class DeletePageResult {
-    SUCCESS,
-    CANCELLED,
-    STORE_FAILURE,
-    DEVICE_FAILURE,
-    NOT_FOUND,
-    // NOTE: always keep this entry at the end. Add new result types only
-    // immediately above this line. Make sure to update the corresponding
-    // histogram enum accordingly.
-    RESULT_COUNT,
-  };
-
-  // Result of loading all pages.
-  enum class LoadResult {
-    SUCCESS,
-    CANCELLED,
-    STORE_FAILURE,
-  };
-
   // 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 |offline_id| was deleted.
     // In can be invoked as a result of |CheckForExternalFileDeletion|, if a
     // deleted page is detected.
     virtual void OfflinePageDeleted(int64_t offline_id,
                                     const ClientId& client_id) = 0;
 
    protected:
     virtual ~Observer() {}
   };
 
-  typedef std::set<GURL> CheckPagesExistOfflineResult;
-  typedef std::vector<int64_t> MultipleOfflineIdResult;
-  typedef base::Optional<OfflinePageItem> SingleOfflinePageItemResult;
-  typedef std::vector<OfflinePageItem> MultipleOfflinePageItemResult;
+  using CheckPagesExistOfflineResult =
+      offline_pages::CheckPagesExistOfflineResult;
+  using MultipleOfflinePageItemResult =
+      offline_pages::MultipleOfflinePageItemResult;
 
-  typedef base::Callback<void(SavePageResult, int64_t)> SavePageCallback;
-  typedef base::Callback<void(DeletePageResult)> DeletePageCallback;
-  typedef base::Callback<void(const CheckPagesExistOfflineResult&)>
-      CheckPagesExistOfflineCallback;
-  typedef base::Callback<void(bool)> HasPagesCallback;
-  typedef base::Callback<void(const MultipleOfflineIdResult&)>
-      MultipleOfflineIdCallback;
-  typedef base::Callback<void(const SingleOfflinePageItemResult&)>
-      SingleOfflinePageItemCallback;
-  typedef base::Callback<void(const MultipleOfflinePageItemResult&)>
-      MultipleOfflinePageItemCallback;
+  //using DeletePageCallback = offline_pages::DeletePageCallback;
+  using DeletePageResult = offline_pages::DeletePageResult;
+  using SavePageResult = offline_pages::SavePageResult;
 
   // Generates a new offline id
   static int64_t GenerateOfflineId();
 
   // Returns true if an offline copy can be saved for the given URL.
   static bool CanSavePage(const GURL& url);
 
   static base::TimeDelta GetFinalDeletionDelayForTesting();
 
   // All blocking calls/disk access will happen on the provided |task_runner|.
@@ skipping 23 matching lines @@
 
   // Deletes offline pages related to the passed |offline_ids|.
   // Making virtual for test purposes.
   virtual 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);
 
   // Deletes offline pages matching the URL predicate.
-  void DeletePagesByURLPredicate(
-      const base::Callback<bool(const GURL&)>& predicate,
-      const DeletePageCallback& callback);
+  void DeletePagesByURLPredicate(const UrlPredicate& predicate,
+                                 const DeletePageCallback& callback);
 
   // Returns true via callback if there are offline pages in the given
   // |name_space|.
   void HasPages(const std::string& name_space,
                 const HasPagesCallback& callback);
 
   // Returns via callback all GURLs in |urls| that are equal to the online URL
   // of any offline page.
   void CheckPagesExistOffline(const std::set<GURL>& urls,
                               const CheckPagesExistOfflineCallback& callback);
@@ skipping 143 matching lines @@
                             DeletePageResult result);
 
   void OnMarkPageAccesseDone(const OfflinePageItem& offline_page_item,
                              bool success);
 
   // Callbacks for checking if offline pages are missing archive files.
   void OnFindPagesMissingArchiveFile(
       const std::vector<int64_t>* ids_of_pages_missing_archive_file);
   void OnRemoveOfflinePagesMissingArchiveFileDone(
       const std::vector<std::pair<int64_t, ClientId>>& offline_client_id_pairs,
-      OfflinePageModel::DeletePageResult result);
+      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);
 
   void CacheLoadedData(const std::vector<OfflinePageItem>& offline_pages);
 
   // Actually does the work of deleting, requires the model is loaded.
   void DoDeletePagesByOfflineId(const std::vector<int64_t>& offline_ids,
                                 const DeletePageCallback& callback);
 
   // Similar to DoDeletePagesByOfflineId, does actual work of deleting, and
   // requires that the model is loaded.
-  void DoDeletePagesByURLPredicate(
-      const base::Callback<bool(const GURL&)>& predicate,
-      const DeletePageCallback& callback);
+  void DoDeletePagesByURLPredicate(const UrlPredicate& predicate,
+                                   const DeletePageCallback& callback);
 
   void RunWhenLoaded(const base::Closure& job);
 
   // Persistent store for offline page metadata.
   std::unique_ptr<OfflinePageMetadataStore> store_;
 
   // Location where all of the archive files will be stored.
   base::FilePath archives_dir_;
 
   // The observers.
@@ skipping 20 matching lines @@
   std::unique_ptr<OfflinePageStorageManager> storage_manager_;
 
   base::WeakPtrFactory<OfflinePageModel> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(OfflinePageModel);
 };
 
 }  // namespace offline_pages
 
 #endif  // COMPONENTS_OFFLINE_PAGES_OFFLINE_PAGE_MODEL_H_