cef/libcef/common/response_impl.cc
Marshall Greenblatt 8f240861e3 Implement NetworkService request interception/handling (see issue #2622).
Implementation notes:
- Chromium change: CookieMonster::SetCookieableSchemes needs to be called
  immediately after the CookieMonster is created in NetworkContext::
  ApplyContextParamsToBuilder. Add a Profile::GetCookieableSchemes method and
  NetworkContextParams.cookieable_schemes member (set from
  ProfileNetworkContextService::CreateNetworkContextParams) to support that.
- Chromium change: Add a ContentBrowserClient::HandleExternalProtocol variant
  that exposes additional NetworkService request information.
- GetResourceResponseFilter is not yet implemented.

API changes:
- Resource-related callbacks have been moved from CefRequestHandler to a new
  CefResourceRequestHandler interface which is returned via the
  GetResourceRequestHandler method. If the CefRequestHandler declines to handle
  a resource it can optionally be handled by the CefRequestContextHandler, if
  any, associated with the loading context.
- The OnProtocolExecution callback has been moved from CefRequestHandler to
  CefResourceRequestHandler and will be called if a custom scheme request is
  unhandled.
- Cookie send/save permission callbacks have been moved from CefRequestHandler
  and CefResourceHandler to CefResourceRequestHandler.
- New methods added to CefResourceHandler that better match NetworkService
  execution sequence expectations. The old methods are now deprecated.
- New methods added to CefRequest and CefResponse.

Known behavior changes with the NetworkService implementation:
- Modifying the |new_url| parameter in OnResourceRedirect will no longer result
  in the method being called an additional time (likely a bug in the old
  implementation).
- Modifying the request URL in OnResourceResponse would previously cause a
  redirect. This behavior is now deprecated because the NetworkService does not
  support this functionality when using default network loaders. Temporary
  support has been added in combination with CefResourceHandler usage only.
- Other changes to the request object in OnResourceResponse will now cause the
  request to be restarted. This means that OnBeforeResourceLoad, etc, will be
  called an additional time with the new request information.
- CefResponse::GetMimeType will now be empty for non-200 responses.
- Requests using custom schemes can now be handled via CefResourceRequestHandler
  with the same callback behavior as builtin schemes.
- Redirects of custom scheme requests will now be followed as expected.
- Default handling of builtin schemes can now be disabled by setting
  |disable_default_handling| to true in GetResourceRequestHandler.
- Unhandled requests (custom scheme or builtin scheme with default handling
  disabled) will fail with an CefResponse::GetError value of
  ERR_UNKNOWN_URL_SCHEME.
- The CefSchemeHandlerFactory::Create callback will now include cookie headers.

To test:
- Run `cefclient --enable-network-service`. All resources should load
  successfully (this tests the transparent proxy capability).
- All tests pass with NetworkService disabled.
- The following tests pass with NetworkService enabled:
  - CookieTest.*
  - FrameTest.* (excluding .*Nav)
  - NavigationTest.* (excluding .Redirect*)
  - RequestHandlerTest.*
  - RequestContextTest.Basic*
  - RequestContextTest.Popup*
  - RequestTest.*
  - ResourceManagerTest.*
  - ResourceRequestHandlerTest.* (excluding .Filter*)
  - SchemeHandlerTest.*
  - StreamResourceHandlerTest.*
2019-04-23 22:53:28 -04:00

215 lines
5.6 KiB
C++

// Copyright (c) 2012 The Chromium Embedded Framework Authors. All rights
// reserved. Use of this source code is governed by a BSD-style license that
// can be found in the LICENSE file.
#include "libcef/common/response_impl.h"
#include <string>
#include "libcef/common/net_service/net_service_util.h"
#include "base/logging.h"
#include "base/strings/string_util.h"
#include "net/http/http_request_headers.h"
#include "net/http/http_response_headers.h"
#include "net/url_request/url_request.h"
#include "third_party/blink/public/platform/web_http_header_visitor.h"
#include "third_party/blink/public/platform/web_string.h"
#include "third_party/blink/public/platform/web_url.h"
#include "third_party/blink/public/platform/web_url_response.h"
#define CHECK_READONLY_RETURN_VOID() \
if (read_only_) { \
NOTREACHED() << "object is read only"; \
return; \
}
// CefResponse ----------------------------------------------------------------
// static
CefRefPtr<CefResponse> CefResponse::Create() {
CefRefPtr<CefResponse> response(new CefResponseImpl());
return response;
}
// CefResponseImpl ------------------------------------------------------------
CefResponseImpl::CefResponseImpl()
: error_code_(ERR_NONE), status_code_(0), read_only_(false) {}
bool CefResponseImpl::IsReadOnly() {
base::AutoLock lock_scope(lock_);
return read_only_;
}
cef_errorcode_t CefResponseImpl::GetError() {
base::AutoLock lock_scope(lock_);
return error_code_;
}
void CefResponseImpl::SetError(cef_errorcode_t error) {
base::AutoLock lock_scope(lock_);
CHECK_READONLY_RETURN_VOID();
error_code_ = error;
}
int CefResponseImpl::GetStatus() {
base::AutoLock lock_scope(lock_);
return status_code_;
}
void CefResponseImpl::SetStatus(int status) {
base::AutoLock lock_scope(lock_);
CHECK_READONLY_RETURN_VOID();
status_code_ = status;
}
CefString CefResponseImpl::GetStatusText() {
base::AutoLock lock_scope(lock_);
return status_text_;
}
void CefResponseImpl::SetStatusText(const CefString& statusText) {
base::AutoLock lock_scope(lock_);
CHECK_READONLY_RETURN_VOID();
status_text_ = statusText;
}
CefString CefResponseImpl::GetMimeType() {
base::AutoLock lock_scope(lock_);
return mime_type_;
}
void CefResponseImpl::SetMimeType(const CefString& mimeType) {
base::AutoLock lock_scope(lock_);
CHECK_READONLY_RETURN_VOID();
mime_type_ = mimeType;
}
CefString CefResponseImpl::GetCharset() {
base::AutoLock lock_scope(lock_);
return charset_;
}
void CefResponseImpl::SetCharset(const CefString& charset) {
base::AutoLock lock_scope(lock_);
CHECK_READONLY_RETURN_VOID();
charset_ = charset;
}
CefString CefResponseImpl::GetHeader(const CefString& name) {
base::AutoLock lock_scope(lock_);
CefString value;
HeaderMap::const_iterator it = header_map_.find(name);
if (it != header_map_.end())
value = it->second;
return value;
}
CefString CefResponseImpl::GetURL() {
base::AutoLock lock_scope(lock_);
return url_;
}
void CefResponseImpl::SetURL(const CefString& url) {
base::AutoLock lock_scope(lock_);
CHECK_READONLY_RETURN_VOID();
url_ = url;
}
void CefResponseImpl::GetHeaderMap(HeaderMap& map) {
base::AutoLock lock_scope(lock_);
map = header_map_;
}
void CefResponseImpl::SetHeaderMap(const HeaderMap& headerMap) {
base::AutoLock lock_scope(lock_);
CHECK_READONLY_RETURN_VOID();
header_map_ = headerMap;
}
net::HttpResponseHeaders* CefResponseImpl::GetResponseHeaders() {
base::AutoLock lock_scope(lock_);
std::string mime_type = mime_type_;
if (mime_type.empty())
mime_type = "text/html";
std::multimap<std::string, std::string> extra_headers;
for (const auto& pair : header_map_)
extra_headers.insert(std::make_pair(pair.first, pair.second));
return net_service::MakeResponseHeaders(
status_code_, status_text_, mime_type, charset_, -1, extra_headers,
true /* allow_existing_header_override */);
}
void CefResponseImpl::SetResponseHeaders(
const net::HttpResponseHeaders& headers) {
base::AutoLock lock_scope(lock_);
CHECK_READONLY_RETURN_VOID();
header_map_.clear();
size_t iter = 0;
std::string name, value;
while (headers.EnumerateHeaderLines(&iter, &name, &value))
header_map_.insert(std::make_pair(name, value));
status_code_ = headers.response_code();
status_text_ = headers.GetStatusText();
std::string mime_type, charset;
headers.GetMimeTypeAndCharset(&mime_type, &charset);
mime_type_ = mime_type;
charset_ = charset;
}
void CefResponseImpl::Set(const blink::WebURLResponse& response) {
DCHECK(!response.IsNull());
base::AutoLock lock_scope(lock_);
CHECK_READONLY_RETURN_VOID();
blink::WebString str;
status_code_ = response.HttpStatusCode();
str = response.HttpStatusText();
status_text_ = str.Utf16();
str = response.MimeType();
mime_type_ = str.Utf16();
str = response.CurrentRequestUrl().GetString();
url_ = str.Utf16();
class HeaderVisitor : public blink::WebHTTPHeaderVisitor {
public:
explicit HeaderVisitor(HeaderMap* map) : map_(map) {}
void VisitHeader(const blink::WebString& name,
const blink::WebString& value) override {
map_->insert(std::make_pair(name.Utf16(), value.Utf16()));
}
private:
HeaderMap* map_;
};
HeaderVisitor visitor(&header_map_);
response.VisitHTTPHeaderFields(&visitor);
}
void CefResponseImpl::Set(const net::URLRequest* request) {
DCHECK(request);
const net::HttpResponseHeaders* headers = request->response_headers();
if (headers)
SetResponseHeaders(*headers);
}
void CefResponseImpl::SetReadOnly(bool read_only) {
base::AutoLock lock_scope(lock_);
read_only_ = read_only;
}