Add webkit to the repository.

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

1 files changed, 225 insertions, 0 deletions

diff --git a/webkit/glue/resource_loader_bridge.h b/webkit/glue/resource_loader_bridge.h
new file mode 100644
index 0000000..ba2fd0c
--- /dev/null
+++ b/webkit/glue/resource_loader_bridge.h
@@ -0,0 +1,225 @@
+// Copyright 2008, Google Inc.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//    * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//    * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//    * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
+// The intent of this file is to provide a type-neutral abstraction between
+// Chrome and WebKit for resource loading. This pure-virtual interface is
+// implemented by the embedder, which also provides a factory method Create
+// to instantiate this object.
+//
+// One of these objects will be created by WebKit for each request. WebKit
+// will own the pointer to the bridge, and will delete it when the request is
+// no longer needed.
+//
+// In turn, the bridge's owner on the WebKit end will implement the Peer
+// interface, which we will use to communicate notifications back.
+
+#ifndef RESOURCE_LOADER_BRIDGE_H__
+#define RESOURCE_LOADER_BRIDGE_H__
+
+#include <string>
+
+#include "base/basictypes.h"
+#include "base/ref_counted.h"
+#include "base/time.h"
+#include "googleurl/src/gurl.h"
+#include "net/http/http_response_headers.h"
+#include "net/url_request/url_request_status.h"
+#include "webkit/glue/resource_type.h"
+
+class WebFrame;
+
+namespace webkit_glue {
+
+class ResourceLoaderBridge {
+ public:
+  struct ResponseInfo {
+    // The time at which the request was made that resulted in this response.
+    // For cached responses, this time could be "far" in the past.
+    Time request_time;
+
+    // The time at which the response headers were received.  For cached
+    // responses, this time could be "far" in the past.
+    Time response_time;
+
+    // The response headers or NULL if the URL type does not support headers.
+    scoped_refptr<net::HttpResponseHeaders> headers;
+
+    // The mime type of the response.  This may be a derived value.
+    std::string mime_type;
+
+    // The character encoding of the response or none if not applicable to the
+    // response's mime type.  This may be a derived value.
+    std::string charset;
+
+    // An opaque string carrying security information pertaining to this
+    // response.  This may include information about the SSL connection used.
+    std::string security_info;
+
+    // Content length if available. -1 if not available
+    int64 content_length;
+  };
+
+  // generated by the bridge. This is implemented by our custom resource loader
+  // within webkit. The Peer and it's bridge should have identical lifetimes
+  // as they represent each end of a communication channel.
+  //
+  // These callbacks mirror URLRequest::Delegate and the order and conditions
+  // in which they will be called are identical. See url_request.h for more
+  // information.
+  class Peer {
+   public:
+    // Called as upload progress is made.
+    // note: only for requests with LOAD_ENABLE_UPLOAD_PROGRESS set
+    virtual void OnUploadProgress(uint64 position, uint64 size) {};
+
+    // Called when a redirect occurs.
+    virtual void OnReceivedRedirect(const GURL& new_url) = 0;
+
+    // Called when response headers are available (after all redirects have
+    // been followed).
+    virtual void OnReceivedResponse(const ResponseInfo& info) = 0;
+
+    // Called when a chunk of response data is available.  This method may
+    // be called multiple times or not at all if an error occurs.
+    virtual void OnReceivedData(const char* data, int len) = 0;
+
+    // Called when the response is complete.  This method signals completion of
+    // the resource load.
+    virtual void OnCompletedRequest(const URLRequestStatus& status) = 0;
+
+    // Returns the URL of the request, which allows us to display it in
+    // debugging situations.
+    virtual std::string GetURLForDebugging() = 0;
+  };
+
+  // use Create() for construction, but anybody can delete at any time,
+  // INCLUDING during processing of callbacks.
+  virtual ~ResourceLoaderBridge() {}
+
+  // Call this method to make a new instance.  The method name is a HTTP-style
+  // method name (e.g., "GET" or "POST").  The URL should be an absolute URL
+  // encoded in ASCII per the rules of RFC-2396.  The referrer parameter is
+  // optional (may be NULL) and is a URL with similar constraints in how it
+  // must be encoded.
+  //
+  // For HTTP(S) POST requests, the AppendDataToUpload and AppendFileToUpload
+  // methods may be called to construct the body of the request.
+  //
+  // For HTTP(S) requests, the headers parameter can be a \r\n-delimited and
+  // \r\n-terminated list of MIME headers.  They should be ASCII-encoded using
+  // the standard MIME header encoding rules.  The headers parameter can also
+  // be null if no extra request headers need to be set.
+  //
+  // The WebFrame passed to this function provides context about the origin
+  // of the resource request.
+  //
+  // policy_url is the URL of the document in the top-level window, which may be
+  // checked by the third-party cookie blocking policy.
+  //
+  // load_flags is composed of the values defined in url_request_load_flags.h
+  //
+  // mixed_content when true indicates that the resource associated with this
+  // request is over HTTP when the main page was loaded over HTTPS.
+  //
+  // request_type indicates if the current request is the main frame load, a
+  // sub-frame load, or a sub objects load.
+  static ResourceLoaderBridge* Create(WebFrame* frame,
+                                      const std::string& method,
+                                      const GURL& url,
+                                      const GURL& policy_url,
+                                      const GURL& referrer,
+                                      const std::string& headers,
+                                      int load_flags,
+                                      int origin_pid,
+                                      ResourceType::Type request_type,
+                                      bool mixed_content);
+
+  // Call this method before calling Start() to append a chunk of binary data
+  // to the request body.  May only be used with HTTP(S) POST requests.
+  virtual void AppendDataToUpload(const char* data, int data_len) = 0;
+
+  // Call this method before calling Start() to append the contents of a file
+  // to the request body.  May only be used with HTTP(S) POST requests.
+  void AppendFileToUpload(const std::wstring& file_path) {
+    AppendFileRangeToUpload(file_path, 0, kuint64max);
+  }
+
+  // Call this method before calling Start() to append the contents of a file
+  // to the request body.  May only be used with HTTP(S) POST requests.
+  virtual void AppendFileRangeToUpload(const std::wstring& file_path,
+                                       uint64 offset, uint64 length) = 0;
+
+  // Call this method to initiate the request.  If this method succeeds, then
+  // the peer's methods will be called asynchronously to report various events.
+  virtual bool Start(Peer* peer) = 0;
+
+  // Call this method to cancel a request that is in progress.  This method
+  // causes the request to immediately transition into the 'done' state. The
+  // OnCompletedRequest method will be called asynchronously; this assumes
+  // the peer is still valid.
+  virtual void Cancel() = 0;
+
+  // Call this method to suspend or resume a load that is in progress.  This
+  // method may only be called after a successful call to the Start method.
+  virtual void SetDefersLoading(bool value) = 0;
+
+  // See the SyncLoad method declared below.  (The name of this struct is not
+  // suffixed with "Info" because it also contains the response data.)
+  struct SyncLoadResponse : ResponseInfo {
+    // The response status.
+    URLRequestStatus status;
+
+    // The final URL of the response.  This may differ from the request URL in
+    // the case of a server redirect.
+    GURL url;
+
+    // The response data.
+    std::string data;
+  };
+
+  // Call this method to load the resource synchronously (i.e., in one shot).
+  // This is an alternative to the Start method.  Be warned that this method
+  // will block the calling thread until the resource is fully downloaded or an
+  // error occurs.  It could block the calling thread for a long time, so only
+  // use this if you really need it!  There is also no way for the caller to
+  // interrupt this method.  Errors are reported via the status field of the
+  // response parameter.
+  virtual void SyncLoad(SyncLoadResponse* response) = 0;
+
+ protected:
+  // construction must go through Create()
+  ResourceLoaderBridge() {}
+
+ private:
+  DISALLOW_EVIL_CONSTRUCTORS(ResourceLoaderBridge);
+};
+
+}  // namespace webkit_glue
+
+#endif  // RESOURCE_LOADER_BRIDGE__