Persist offline page info in a navigation entry if needed

components/sessions/core/serialized_navigation_driver.h

 // 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.
 
 #ifndef COMPONENTS_SESSIONS_CORE_SERIALIZED_NAVIGATION_DRIVER_H_
 #define COMPONENTS_SESSIONS_CORE_SERIALIZED_NAVIGATION_DRIVER_H_
 
+#include <map>
 #include <string>
 
 #include "components/sessions/core/sessions_export.h"
 
+namespace content {
+class NavigationEntry;
+}
+
 namespace sessions {
 
 class SerializedNavigationEntry;
 
 // The SerializedNavigationDriver interface allows SerializedNavigationEntry to
 // obtain information from a singleton driver object. A concrete implementation
 // must be provided by the driver on each platform.
 class SESSIONS_EXPORT SerializedNavigationDriver {

[sky, 2016/09/27 22:30:27]

This code can't depend upon content. Your changes should be in the content side
only.

[jianli, 2016/09/27 23:30:32]

Done.

  public:
+  // The interface that handles how the extended info is converted betweened the

[sky, 2016/09/27 22:30:27]

How about:
This interface is used to store and retrieve arbitrary key/value pairs for a
NavigationEntry that are not a core part of NavigationEntry. WARNING:
implementations must deal with versioning. In particular RestoreExtendedInfo()
may be called with data from a previous version of Chrome.

[jianli, 2016/09/27 23:30:32]

Done.

+  // one stored in SerializedNavigationEntry and the one used in
+  // NavigationEntry.
+  class SESSIONS_EXPORT ExtendedInfoHandler {

[sky, 2016/09/27 22:30:27]

Move this into it's own header.

[jianli, 2016/09/27 23:30:32]

Done.

+   public:
+    virtual ~ExtendedInfoHandler() {}
+
+    // Returns the extended info from NavigationEntry for
+    // SerializedNavigationEntry to save it.
+    virtual std::string GetExtendedInfo(
+        const content::NavigationEntry& entry) const = 0;
+
+    // Puts the extended info, extracted from SerializedNavigationEntry, into
+    // NavigationEntry.
+    virtual void RestoreExtendedInfo(
+        const std::string& info, content::NavigationEntry* entry) = 0;
+  };
+
   virtual ~SerializedNavigationDriver() {}
 
   // Returns the singleton SerializedNavigationDriver.
   static SerializedNavigationDriver* Get();
 
   // Returns the default referrer policy.
   virtual int GetDefaultReferrerPolicy() const = 0;
 
   // Maps current referrer policies to old values to work around
   // crbug.com/450589. Returns false if the referrer should be stripped.
@@ skipping 12 matching lines @@
   virtual std::string GetSanitizedPageStateForPickle(
       const SerializedNavigationEntry* navigation) const = 0;
 
   // Sanitizes the data in the given |navigation| to be more robust against
   // faulty data written by older versions.
   virtual void Sanitize(SerializedNavigationEntry* navigation) const = 0;
 
   // Removes the referrer from the encoded page state.
   virtual std::string StripReferrerFromPageState(
       const std::string& page_state) const = 0;
+
+  // Registers a handler that could be used to read and write the extended

[sky, 2016/09/27 22:30:27]

'could be' -> is 

[jianli, 2016/09/27 23:30:32]

Done.

+  // info stored in SerializedNavigationEntry.
+  virtual void RegisterExtendedInfoHandler(
+      const std::string& key,
+      std::unique_ptr<ExtendedInfoHandler> handler) = 0;
+
+  typedef std::map<std::string, std::unique_ptr<ExtendedInfoHandler>>

[sky, 2016/09/27 22:30:27]

using.

[jianli, 2016/09/27 23:30:32]

Done.

+      ExtendedInfoHandlerMap;
+
+  // Returns all the registered handlers to deal with the extended info.
+  virtual const ExtendedInfoHandlerMap& GetAllExtendedInfoHandlers() const = 0;
 };
 
 }  // namespace sessions
 
 #endif  // COMPONENTS_SESSIONS_CORE_SERIALIZED_NAVIGATION_DRIVER_H_