Move some sync/notifier to components/invalidation

Moves many of the files in sync/notifier to components/invalidation.

This change does not introduce any new dependencies.  The relevant
dependency rules both before and after this change should be:
- chrome/browser/invalidation and chrome in general depend on
  components/invalidation.
- components/invalidation depends on sync/notifier and sync in
  general.
- sync/notifier, components/invalidation, and various parts of
  chrome all depend on sync/internal_api/public.

The eventual goal is to move all of sync/notifier into
components/invalidation.  The invalidation-related parts of
sync/internal_api/public should be moved to components/invalidation,
too.  This will allow us to remove the deopendencies from
components/invalidation to sync, and remove sync's dependencies on
cacheinvalidation and libjingle.

This change is a regression in terms of shared library componentization.
the files in the sync/notifier folder could be built as a shared
library.  The files in compononents/invalidation do not support this
yet.  The SYNC_EXPORT declarations in the moved files have been changed
to INVALIDATION_EXPORT so as to not lose this information, but the
macros are currently #defined to no-ops.

This change does not attempt to rename any classes or namespaces.
Many of the files ported from sync/notifier still use the syncer
namespace.  Some, like SyncSystemResources, still have names tied
to their sync heritage.  This will be addressed in future CLs.

Some non-trivial or non-obvious changes include:
- invalidator_state.h was moved to sync/internal_api/public/base so it
could be shared by both sync/ and components/invalidation.  This should
be fixed in a future CL.
- FromNotifierReason was split out of invalidator_state.h and moved to
the newly-created components/invalidator_reason_util.h

TBR=zea,rtenneti,mallinath,dcheng
BUG=259559

Review URL: https://codereview.chromium.org/294123004

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@274350 0039d316-1c4b-4281-b951-d872f2087c98

1 files changed, 241 insertions, 0 deletions

diff --git a/components/invalidation/sync_system_resources.h b/components/invalidation/sync_system_resources.h
new file mode 100644
index 0000000..cbc0dc2
--- /dev/null
+++ b/components/invalidation/sync_system_resources.h
@@ -0,0 +1,241 @@
+// Copyright 2014 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.
+//
+// Simple system resources class that uses the current message loop
+// for scheduling.  Assumes the current message loop is already
+// running.
+
+#ifndef COMPONENTS_INVALIDATION_SYNC_SYSTEM_RESOURCES_H_
+#define COMPONENTS_INVALIDATION_SYNC_SYSTEM_RESOURCES_H_
+
+#include <set>
+#include <string>
+#include <vector>
+
+#include "base/compiler_specific.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/memory/weak_ptr.h"
+#include "base/message_loop/message_loop.h"
+#include "base/threading/non_thread_safe.h"
+#include "base/values.h"
+#include "components/invalidation/invalidation_export.h"
+#include "components/invalidation/state_writer.h"
+#include "google/cacheinvalidation/include/system-resources.h"
+#include "jingle/notifier/base/notifier_options.h"
+#include "sync/internal_api/public/base/invalidator_state.h"
+
+namespace syncer {
+
+class GCMNetworkChannelDelegate;
+
+class SyncLogger : public invalidation::Logger {
+ public:
+  SyncLogger();
+
+  virtual ~SyncLogger();
+
+  // invalidation::Logger implementation.
+  virtual void Log(LogLevel level, const char* file, int line,
+                   const char* format, ...) OVERRIDE;
+
+  virtual void SetSystemResources(
+      invalidation::SystemResources* resources) OVERRIDE;
+};
+
+class SyncInvalidationScheduler : public invalidation::Scheduler {
+ public:
+  SyncInvalidationScheduler();
+
+  virtual ~SyncInvalidationScheduler();
+
+  // Start and stop the scheduler.
+  void Start();
+  void Stop();
+
+  // invalidation::Scheduler implementation.
+  virtual void Schedule(invalidation::TimeDelta delay,
+                        invalidation::Closure* task) OVERRIDE;
+
+  virtual bool IsRunningOnThread() const OVERRIDE;
+
+  virtual invalidation::Time GetCurrentTime() const OVERRIDE;
+
+  virtual void SetSystemResources(
+      invalidation::SystemResources* resources) OVERRIDE;
+
+ private:
+  // Runs the task, deletes it, and removes it from |posted_tasks_|.
+  void RunPostedTask(invalidation::Closure* task);
+
+  // Holds all posted tasks that have not yet been run.
+  std::set<invalidation::Closure*> posted_tasks_;
+
+  const base::MessageLoop* created_on_loop_;
+  bool is_started_;
+  bool is_stopped_;
+
+  base::WeakPtrFactory<SyncInvalidationScheduler> weak_factory_;
+};
+
+// SyncNetworkChannel implements common tasks needed to interact with
+// invalidation library:
+//  - registering message and network status callbacks
+//  - notifying observers about network channel state change
+// Implementation of particular network protocol should implement
+// SendMessage and call NotifyStateChange and DeliverIncomingMessage.
+class INVALIDATION_EXPORT_PRIVATE SyncNetworkChannel
+    : public NON_EXPORTED_BASE(invalidation::NetworkChannel) {
+ public:
+  class Observer {
+   public:
+    // Called when network channel state changes. Possible states are:
+    //  - INVALIDATIONS_ENABLED : connection is established and working
+    //  - TRANSIENT_INVALIDATION_ERROR : no network, connection lost, etc.
+    //  - INVALIDATION_CREDENTIALS_REJECTED : Issues with auth token
+    virtual void OnNetworkChannelStateChanged(
+        InvalidatorState invalidator_state) = 0;
+  };
+
+  SyncNetworkChannel();
+
+  virtual ~SyncNetworkChannel();
+
+  // invalidation::NetworkChannel implementation.
+  // SyncNetworkChannel doesn't implement SendMessage. It is responsibility of
+  // subclass to implement it.
+  virtual void SetMessageReceiver(
+      invalidation::MessageCallback* incoming_receiver) OVERRIDE;
+  virtual void AddNetworkStatusReceiver(
+      invalidation::NetworkStatusCallback* network_status_receiver) OVERRIDE;
+  virtual void SetSystemResources(
+      invalidation::SystemResources* resources) OVERRIDE;
+
+  // Subclass should implement UpdateCredentials to pass new token to channel
+  // library.
+  virtual void UpdateCredentials(const std::string& email,
+      const std::string& token) = 0;
+
+  // Return value from GetInvalidationClientType will be passed to
+  // invalidation::CreateInvalidationClient. Subclass should return one of the
+  // values from ipc::invalidation::ClientType enum from types.proto.
+  virtual int GetInvalidationClientType() = 0;
+
+  // Subclass should implement RequestDetailedStatus to provide debugging
+  // information.
+  virtual void RequestDetailedStatus(
+      base::Callback<void(const base::DictionaryValue&)> callback) = 0;
+
+  // Classes interested in network channel state changes should implement
+  // SyncNetworkChannel::Observer and register here.
+  void AddObserver(Observer* observer);
+  void RemoveObserver(Observer* observer);
+
+  // Helper functions that know how to construct network channels from channel
+  // specific parameters.
+  static scoped_ptr<SyncNetworkChannel> CreatePushClientChannel(
+      const notifier::NotifierOptions& notifier_options);
+  static scoped_ptr<SyncNetworkChannel> CreateGCMNetworkChannel(
+      scoped_refptr<net::URLRequestContextGetter> request_context_getter,
+      scoped_ptr<GCMNetworkChannelDelegate> delegate);
+
+  // Get the count of how many valid received messages were received.
+  int GetReceivedMessagesCount() const;
+
+ protected:
+  // Subclass should notify about connection state through NotifyStateChange.
+  void NotifyStateChange(InvalidatorState invalidator_state);
+  // Subclass should call DeliverIncomingMessage for message to reach
+  // invalidations library.
+  bool DeliverIncomingMessage(const std::string& message);
+
+ private:
+  typedef std::vector<invalidation::NetworkStatusCallback*>
+      NetworkStatusReceiverList;
+
+  // Callbacks into invalidation library
+  scoped_ptr<invalidation::MessageCallback> incoming_receiver_;
+  NetworkStatusReceiverList network_status_receivers_;
+
+  // Last channel state for new network status receivers.
+  InvalidatorState invalidator_state_;
+
+  int received_messages_count_;
+
+  ObserverList<Observer> observers_;
+};
+
+class SyncStorage : public invalidation::Storage {
+ public:
+  SyncStorage(StateWriter* state_writer, invalidation::Scheduler* scheduler);
+
+  virtual ~SyncStorage();
+
+  void SetInitialState(const std::string& value) {
+    cached_state_ = value;
+  }
+
+  // invalidation::Storage implementation.
+  virtual void WriteKey(const std::string& key, const std::string& value,
+                        invalidation::WriteKeyCallback* done) OVERRIDE;
+
+  virtual void ReadKey(const std::string& key,
+                       invalidation::ReadKeyCallback* done) OVERRIDE;
+
+  virtual void DeleteKey(const std::string& key,
+                         invalidation::DeleteKeyCallback* done) OVERRIDE;
+
+  virtual void ReadAllKeys(
+      invalidation::ReadAllKeysCallback* key_callback) OVERRIDE;
+
+  virtual void SetSystemResources(
+      invalidation::SystemResources* resources) OVERRIDE;
+
+ private:
+  // Runs the given storage callback with SUCCESS status and deletes it.
+  void RunAndDeleteWriteKeyCallback(
+      invalidation::WriteKeyCallback* callback);
+
+  // Runs the given callback with the given value and deletes it.
+  void RunAndDeleteReadKeyCallback(
+      invalidation::ReadKeyCallback* callback, const std::string& value);
+
+  StateWriter* state_writer_;
+  invalidation::Scheduler* scheduler_;
+  std::string cached_state_;
+};
+
+class INVALIDATION_EXPORT_PRIVATE SyncSystemResources
+    : public NON_EXPORTED_BASE(invalidation::SystemResources) {
+ public:
+  SyncSystemResources(SyncNetworkChannel* sync_network_channel,
+                      StateWriter* state_writer);
+
+  virtual ~SyncSystemResources();
+
+  // invalidation::SystemResources implementation.
+  virtual void Start() OVERRIDE;
+  virtual void Stop() OVERRIDE;
+  virtual bool IsStarted() const OVERRIDE;
+  virtual void set_platform(const std::string& platform);
+  virtual std::string platform() const OVERRIDE;
+  virtual SyncLogger* logger() OVERRIDE;
+  virtual SyncStorage* storage() OVERRIDE;
+  virtual SyncNetworkChannel* network() OVERRIDE;
+  virtual SyncInvalidationScheduler* internal_scheduler() OVERRIDE;
+  virtual SyncInvalidationScheduler* listener_scheduler() OVERRIDE;
+
+ private:
+  bool is_started_;
+  std::string platform_;
+  scoped_ptr<SyncLogger> logger_;
+  scoped_ptr<SyncInvalidationScheduler> internal_scheduler_;
+  scoped_ptr<SyncInvalidationScheduler> listener_scheduler_;
+  scoped_ptr<SyncStorage> storage_;
+  // sync_network_channel_ is owned by SyncInvalidationListener.
+  SyncNetworkChannel* sync_network_channel_;
+};
+
+}  // namespace syncer
+
+#endif  // COMPONENTS_INVALIDATION_SYNC_SYSTEM_RESOURCES_H_