Initial checkin of OfflineContentProvider.

components/offline_content/core/offline_content_aggregator.h

+// Copyright 2017 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_CONTENT_CORE_OFFLINE_CONTENT_AGGREGATOR_H_
+#define COMPONENTS_OFFLINE_CONTENT_CORE_OFFLINE_CONTENT_AGGREGATOR_H_
+
+#include <map>
+#include <string>
+
+#include "base/callback_forward.h"
+#include "base/macros.h"
+#include "base/memory/weak_ptr.h"
+#include "base/observer_list.h"
+#include "base/supports_user_data.h"
+#include "components/offline_content/core/offline_content_provider.h"
+#include "url/gurl.h"
+
+namespace offline_content {
+
+struct OfflineItem;
+
+// An implementation of OfflineContentProvider that aggregates multiple other
+// providers into a single set of data.  See the OfflineContentProvider header
+// for comments on expected behavior of the interface.  This implementation has
+// a few caveats:
+// - Once all currently registered providers are initialized this provider will
+//   trigger OnItemsAvailable on all observers.  Until then the provider will
+//   not be initialized.
+// - If a provider is added after OnItemsAvailable was sent, it's initialization
+//   will act as a notification for OnItemsAdded.  This provider will still be
+//   in the initialized state.
+// - Calling any modification method on this provider (Open, Update, Delete,
+//   etc.) on an OfflineItem belonging to an uninitialized
+//   OfflineContentProvider will be queued until that provider is initialized.
+//   NOTE: Any actions taken will be propagated to the provider *before* the
+//   observers are notified that the provider is initialized.  This is meant to
+//   try to guarantee that the data set incorporates the results of those
+//   actions.
+//
+// Routing to the correct provider:
+// - Providers must be registered with a unique namespace.  The OfflineItems
+//   created by the provider must also be tagged with the same namespace so that
+//   actions taken on the OfflineItem can be routed to the correct internal
+//   provider.  The namespace must also be consistent across startups.
+class OfflineContentAggregator : public OfflineContentProvider,
+                                 public OfflineContentProvider::Observer,
+                                 public base::SupportsUserData,
+                                 public base::SupportsUserData::Data {
+ public:
+  OfflineContentAggregator();
+  ~OfflineContentAggregator() override;
+
+  // Registers a provider and associates it with all OfflineItems with
+  // |name_space|.  UI actions taken on OfflineItems with |name_space| will be
+  // routed to |provider|.  |provider| is expected to only expose OfflineItems
+  // with |name_space| set.
+  void RegisterProvider(const std::string& name_space,
+                        OfflineContentProvider* provider);
+
+  // Removes the OfflineContentProvider associated with |name_space| from this
+  // aggregator.
+  void UnregisterProvider(const std::string& name_space);
+
+  // OfflineContentProvider implementation.
+  bool AreItemsAvailable() override;
+  void OpenItem(const ContentId& id) override;
+  void RemoveItem(const ContentId& id) override;
+  void CancelDownload(const ContentId& id) override;
+  void PauseDownload(const ContentId& id) override;
+  void ResumeDownload(const ContentId& id) override;
+  const OfflineItem* GetItemById(const ContentId& id) override;
+  OfflineItemList GetAllItems() override;
+  void AddObserver(OfflineContentProvider::Observer* observer) override;
+  void RemoveObserver(OfflineContentProvider::Observer* observer) override;
+
+ private:
+  // OfflineContentProvider::Observer implementation.
+  void OnItemsAvailable(OfflineContentProvider* provider) override;
+  void OnItemsAdded(const OfflineItemList& items) override;
+  void OnItemRemoved(const ContentId& id) override;
+  void OnItemUpdated(const OfflineItem& item) override;
+
+  // Checks if the underlying OfflineContentProviders are available.  If so,
+  // it calls OnItemsAvailable on all observers that haven't yet been notified
+  // of this.
+  void CheckAndNotifyItemsAvailable();
+
+  // Checks to see if |provider| is initialized.  If so, this flushes any
+  // pending actions taken on OfflineItems that belong to |provider|.
+  void FlushPendingActionsIfReady(OfflineContentProvider* provider);
+
+  // Checks if |provider| is initialized.  If so, runs |action|, otherwise
+  // queues it to run once |provider| triggers that it is ready.
+  void RunIfReady(OfflineContentProvider* provider,
+                  const base::Closure& action);
+
+  // Stores a map of name_space -> OfflineContentProvider.  These
+  // OfflineContentProviders are all aggregated by this class and exposed to the
+  // consumer as a single list.
+  // TODO(me): Add a WeakPtrFactory to this map?

[David Trainor- moved to gerrit, 2017/02/22 01:23:13]

TODO(me): Remove comment!

+  using OfflineProviderMap = std::map<std::string, OfflineContentProvider*>;
+  OfflineProviderMap providers_;
+
+  // Stores a map of OfflineContentProvider -> list of closures that represent
+  // all actions that need to be taken on the associated OfflineContentProvider
+  // when it becomes initialized.
+  using CallbackList = std::vector<base::Closure>;
+  using PendingActionMap = std::map<OfflineContentProvider*, CallbackList>;
+  PendingActionMap pending_actions_;
+
+  // A list of all currently registered observers.
+  base::ObserverList<OfflineContentProvider::Observer> observers_;
+
+  // A list of observers that have been notified that this class is initialized.
+  // We do not want to notify them of this initialization more than once, so
+  // we track them here.
+  using ObserverVector = std::vector<OfflineContentProvider::Observer*>;
+  ObserverVector signaled_observers_;
+
+  // Whether or not this class currently identifies itself as available and has
+  // notified the observers.
+  bool sent_on_items_available_;
+
+  base::WeakPtrFactory<OfflineContentAggregator> weak_ptr_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(OfflineContentAggregator);
+};
+
+}  // namespace offline_content
+
+#endif  // COMPONENTS_OFFLINE_CONTENT_CORE_OFFLINE_CONTENT_AGGREGATOR_H_