[ON HOLD] Implement pull-based design for content decoding

net/filter/sdch_policy_delegate.h

+// Copyright 2016 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 NET_FILTER_SDCH_POLICY_DELEGATE_H
+#define NET_FILTER_SDCH_POLICY_DELEGATE_H
+
+#include "base/supports_user_data.h"
+#include "net/base/sdch_manager.h"
+#include "net/filter/sdch_stream_source_delegate.h"
+#include "net/log/net_log.h"
+#include "url/gurl.h"
+
+namespace net {
+
+class SdchStreamSource;
+
+// This class ascribes to the SdchStreamSourceDelegate interface to implement
+// the SDCH
+// error-handling and stats-gathering policy. The Context object supplies
+// details about the request needed for this object to make error-handling
+// decisions. See the |SdchStreamSourceDelegate| documentation for more details.
+class SdchPolicyDelegate : public SdchStreamSourceDelegate {
+ public:
+  class Context {
+   public:
+    enum StatisticSelector {
+      SDCH_DECODE,
+      SDCH_PASSTHROUGH,
+      SDCH_EXPERIMENT_DECODE,
+      SDCH_EXPERIMENT_HOLDBACK,
+    };
+
+    virtual ~Context() {}
+    virtual bool GetMimeType(std::string* mime_type) const = 0;
+    virtual bool GetURL(GURL* url) const = 0;
+    virtual base::Time GetRequestTime() const = 0;
+    virtual bool IsCachedContent() const = 0;
+    virtual SdchManager* GetSdchManager() const = 0;
+    virtual SdchManager::DictionarySet* SdchDictionariesAdvertised() const = 0;
+    virtual int64_t GetByteReadCount() const = 0;
+    virtual int GetResponseCode() const = 0;
+    virtual void RecordPacketStats(StatisticSelector statistic) const = 0;
+    virtual const BoundNetLog& GetNetLog() const = 0;
+  };
+
+  // We need: MIME type, URL, GetByteReadCount, IsCachedContent,
+  // RecordPacketStats, GetResponseCode, SdchDictionariesAdvertised, netlog
+  SdchPolicyDelegate(scoped_ptr<Context> context);
+
+  ~SdchPolicyDelegate() override;
+
+  // SdchStreamSourceDelegate overrides.
+  bool HandleDictionaryError(SdchStreamSource* source) override;
+  bool HandleDecodingError(SdchStreamSource* source) override;
+  bool GetDictionary(const std::string& server_id,
+                     const std::string** text) override;
+  void NotifyStreamDone() override;
+
+ private:
+  // Issues a meta-refresh if the context's MIME type supports it, and returns
+  // whether a refresh was issued. As a side-effect, blacklists the context's
+  // domain either temporarily or permanently.
+  bool IssueMetaRefreshIfPossible(SdchStreamSource* source);
+
+  // Logs an SDCH failure. This logs events in UMA and the net log in
+  // |context_|, but has no side-effects on this class or the stream.
+  void LogSdchDictionaryError();
+  void LogSdchDecodingError();
+
+  bool dictionary_requested_;
+  scoped_ptr<Context> context_;
+
+  bool did_meta_refresh_;
+  bool did_stop_decoding_;
+  bool did_fail_request_;
+
+  scoped_ptr<SdchManager::DictionarySet> unexpected_dictionary_set_;
+};
+
+}  // namespace net
+
+#endif  // !NET_FILTER_SDCH_POLICY_DELEGATE_H