284 lines
13 KiB
C++
284 lines
13 KiB
C++
// Copyright (c) 2011 Marshall A. Greenblatt. 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 name Chromium Embedded
|
|
// Framework 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 contents of this file must follow a specific format in order to
|
|
// support the CEF translator tool. See the translator.README.txt file in the
|
|
// tools directory for more information.
|
|
//
|
|
|
|
#ifndef CEF_INCLUDE_CEF_REQUEST_HANDLER_H_
|
|
#define CEF_INCLUDE_CEF_REQUEST_HANDLER_H_
|
|
#pragma once
|
|
|
|
#include <vector>
|
|
|
|
#include "include/cef_auth_callback.h"
|
|
#include "include/cef_base.h"
|
|
#include "include/cef_browser.h"
|
|
#include "include/cef_callback.h"
|
|
#include "include/cef_frame.h"
|
|
#include "include/cef_request.h"
|
|
#include "include/cef_resource_request_handler.h"
|
|
#include "include/cef_ssl_info.h"
|
|
#include "include/cef_unresponsive_process_callback.h"
|
|
#include "include/cef_x509_certificate.h"
|
|
|
|
///
|
|
/// Callback interface used to select a client certificate for authentication.
|
|
///
|
|
/*--cef(source=library)--*/
|
|
class CefSelectClientCertificateCallback : public virtual CefBaseRefCounted {
|
|
public:
|
|
///
|
|
/// Chooses the specified certificate for client certificate authentication.
|
|
/// NULL value means that no client certificate should be used.
|
|
///
|
|
/*--cef(optional_param=cert)--*/
|
|
virtual void Select(CefRefPtr<CefX509Certificate> cert) = 0;
|
|
};
|
|
|
|
///
|
|
/// Implement this interface to handle events related to browser requests. The
|
|
/// methods of this class will be called on the thread indicated.
|
|
///
|
|
/*--cef(source=client)--*/
|
|
class CefRequestHandler : public virtual CefBaseRefCounted {
|
|
public:
|
|
typedef cef_termination_status_t TerminationStatus;
|
|
typedef cef_window_open_disposition_t WindowOpenDisposition;
|
|
typedef std::vector<CefRefPtr<CefX509Certificate>> X509CertificateList;
|
|
|
|
///
|
|
/// Called on the UI thread before browser navigation. Return true to cancel
|
|
/// the navigation or false to allow the navigation to proceed. The |request|
|
|
/// object cannot be modified in this callback.
|
|
/// CefLoadHandler::OnLoadingStateChange will be called twice in all cases.
|
|
/// If the navigation is allowed CefLoadHandler::OnLoadStart and
|
|
/// CefLoadHandler::OnLoadEnd will be called. If the navigation is canceled
|
|
/// CefLoadHandler::OnLoadError will be called with an |errorCode| value of
|
|
/// ERR_ABORTED. The |user_gesture| value will be true if the browser
|
|
/// navigated via explicit user gesture (e.g. clicking a link) or false if it
|
|
/// navigated automatically (e.g. via the DomContentLoaded event).
|
|
///
|
|
/*--cef()--*/
|
|
virtual bool OnBeforeBrowse(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
CefRefPtr<CefRequest> request,
|
|
bool user_gesture,
|
|
bool is_redirect) {
|
|
return false;
|
|
}
|
|
|
|
///
|
|
/// Called on the UI thread before OnBeforeBrowse in certain limited cases
|
|
/// where navigating a new or different browser might be desirable. This
|
|
/// includes user-initiated navigation that might open in a special way (e.g.
|
|
/// links clicked via middle-click or ctrl + left-click) and certain types of
|
|
/// cross-origin navigation initiated from the renderer process (e.g.
|
|
/// navigating the top-level frame to/from a file URL). The |browser| and
|
|
/// |frame| values represent the source of the navigation. The
|
|
/// |target_disposition| value indicates where the user intended to navigate
|
|
/// the browser based on standard Chromium behaviors (e.g. current tab,
|
|
/// new tab, etc). The |user_gesture| value will be true if the browser
|
|
/// navigated via explicit user gesture (e.g. clicking a link) or false if it
|
|
/// navigated automatically (e.g. via the DomContentLoaded event). Return true
|
|
/// to cancel the navigation or false to allow the navigation to proceed in
|
|
/// the source browser's top-level frame.
|
|
///
|
|
/*--cef()--*/
|
|
virtual bool OnOpenURLFromTab(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
const CefString& target_url,
|
|
WindowOpenDisposition target_disposition,
|
|
bool user_gesture) {
|
|
return false;
|
|
}
|
|
|
|
///
|
|
/// Called on the browser process IO thread before a resource request is
|
|
/// initiated. The |browser| and |frame| values represent the source of the
|
|
/// request. |request| represents the request contents and cannot be modified
|
|
/// in this callback. |is_navigation| will be true if the resource request is
|
|
/// a navigation. |is_download| will be true if the resource request is a
|
|
/// download. |request_initiator| is the origin (scheme + domain) of the page
|
|
/// that initiated the request. Set |disable_default_handling| to true to
|
|
/// disable default handling of the request, in which case it will need to be
|
|
/// handled via CefResourceRequestHandler::GetResourceHandler or it will be
|
|
/// canceled. To allow the resource load to proceed with default handling
|
|
/// return NULL. To specify a handler for the resource return a
|
|
/// CefResourceRequestHandler object. If this callback returns NULL the same
|
|
/// method will be called on the associated CefRequestContextHandler, if any.
|
|
///
|
|
/*--cef(optional_param=request_initiator)--*/
|
|
virtual CefRefPtr<CefResourceRequestHandler> GetResourceRequestHandler(
|
|
CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
CefRefPtr<CefRequest> request,
|
|
bool is_navigation,
|
|
bool is_download,
|
|
const CefString& request_initiator,
|
|
bool& disable_default_handling) {
|
|
return nullptr;
|
|
}
|
|
|
|
///
|
|
/// Called on the IO thread when the browser needs credentials from the user.
|
|
/// |origin_url| is the origin making this authentication request. |isProxy|
|
|
/// indicates whether the host is a proxy server. |host| contains the hostname
|
|
/// and |port| contains the port number. |realm| is the realm of the challenge
|
|
/// and may be empty. |scheme| is the authentication scheme used, such as
|
|
/// "basic" or "digest", and will be empty if the source of the request is an
|
|
/// FTP server. Return true to continue the request and call
|
|
/// CefAuthCallback::Continue() either in this method or at a later time when
|
|
/// the authentication information is available. Return false to cancel the
|
|
/// request immediately.
|
|
///
|
|
/*--cef(optional_param=realm,optional_param=scheme)--*/
|
|
virtual bool GetAuthCredentials(CefRefPtr<CefBrowser> browser,
|
|
const CefString& origin_url,
|
|
bool isProxy,
|
|
const CefString& host,
|
|
int port,
|
|
const CefString& realm,
|
|
const CefString& scheme,
|
|
CefRefPtr<CefAuthCallback> callback) {
|
|
return false;
|
|
}
|
|
|
|
///
|
|
/// Called on the UI thread to handle requests for URLs with an invalid
|
|
/// SSL certificate. Return true and call CefCallback methods either in this
|
|
/// method or at a later time to continue or cancel the request. Return false
|
|
/// to cancel the request immediately. If
|
|
/// cef_settings_t.ignore_certificate_errors is set all invalid certificates
|
|
/// will be accepted without calling this method.
|
|
///
|
|
/*--cef()--*/
|
|
virtual bool OnCertificateError(CefRefPtr<CefBrowser> browser,
|
|
cef_errorcode_t cert_error,
|
|
const CefString& request_url,
|
|
CefRefPtr<CefSSLInfo> ssl_info,
|
|
CefRefPtr<CefCallback> callback) {
|
|
return false;
|
|
}
|
|
|
|
///
|
|
/// Called on the UI thread when a client certificate is being requested for
|
|
/// authentication. Return false to use the default behavior. If the
|
|
/// |certificates| list is not empty the default behavior will be to display a
|
|
/// dialog for certificate selection. If the |certificates| list is empty then
|
|
/// the default behavior will be not to show a dialog and it will continue
|
|
/// without using any certificate. Return true and call
|
|
/// CefSelectClientCertificateCallback::Select either in this method or at a
|
|
/// later time to select a certificate. Do not call Select or call it with
|
|
/// NULL to continue without using any certificate. |isProxy| indicates
|
|
/// whether the host is an HTTPS proxy or the origin server. |host| and |port|
|
|
/// contains the hostname and port of the SSL server. |certificates| is the
|
|
/// list of certificates to choose from; this list has already been pruned by
|
|
/// Chromium so that it only contains certificates from issuers that the
|
|
/// server trusts.
|
|
///
|
|
/*--cef()--*/
|
|
virtual bool OnSelectClientCertificate(
|
|
CefRefPtr<CefBrowser> browser,
|
|
bool isProxy,
|
|
const CefString& host,
|
|
int port,
|
|
const X509CertificateList& certificates,
|
|
CefRefPtr<CefSelectClientCertificateCallback> callback) {
|
|
return false;
|
|
}
|
|
|
|
///
|
|
/// Called on the browser process UI thread when the render view associated
|
|
/// with |browser| is ready to receive/handle IPC messages in the render
|
|
/// process.
|
|
///
|
|
/*--cef()--*/
|
|
virtual void OnRenderViewReady(CefRefPtr<CefBrowser> browser) {}
|
|
|
|
///
|
|
/// Called on the browser process UI thread when the render process is
|
|
/// unresponsive as indicated by a lack of input event processing for at
|
|
/// least 15 seconds. Return false for the default behavior which is an
|
|
/// indefinite wait with Alloy style or display of the "Page
|
|
/// unresponsive" dialog with Chrome style. Return true and don't
|
|
/// execute the callback for an indefinite wait without display of the Chrome
|
|
/// style dialog. Return true and call CefUnresponsiveProcessCallback::Wait
|
|
/// either in this method or at a later time to reset the wait timer,
|
|
/// potentially triggering another call to this method if the process remains
|
|
/// unresponsive. Return true and call CefUnresponsiveProcessCallback::
|
|
/// Terminate either in this method or at a later time to terminate the
|
|
/// unresponsive process, resulting in a call to OnRenderProcessTerminated.
|
|
/// OnRenderProcessResponsive will be called if the process becomes responsive
|
|
/// after this method is called. This functionality depends on the hang
|
|
/// monitor which can be disabled by passing the `--disable-hang-monitor`
|
|
/// command-line flag.
|
|
///
|
|
/*--cef()--*/
|
|
virtual bool OnRenderProcessUnresponsive(
|
|
CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefUnresponsiveProcessCallback> callback) {
|
|
return false;
|
|
}
|
|
|
|
///
|
|
/// Called on the browser process UI thread when the render process becomes
|
|
/// responsive after previously being unresponsive. See documentation on
|
|
/// OnRenderProcessUnresponsive.
|
|
///
|
|
/*--cef()--*/
|
|
virtual void OnRenderProcessResponsive(CefRefPtr<CefBrowser> browser) {}
|
|
|
|
///
|
|
/// Called on the browser process UI thread when the render process
|
|
/// terminates unexpectedly. |status| indicates how the process terminated.
|
|
/// |error_code| and |error_string| represent the error that would be
|
|
/// displayed in Chrome's "Aw, Snap!" view. Possible |error_code| values
|
|
/// include cef_resultcode_t non-normal exit values and platform-specific
|
|
/// crash values (for example, a Posix signal or Windows hardware exception).
|
|
///
|
|
/*--cef()--*/
|
|
virtual void OnRenderProcessTerminated(CefRefPtr<CefBrowser> browser,
|
|
TerminationStatus status,
|
|
int error_code,
|
|
const CefString& error_string) {}
|
|
|
|
///
|
|
/// Called on the browser process UI thread when the window.document object of
|
|
/// the main frame has been created.
|
|
///
|
|
/*--cef()--*/
|
|
virtual void OnDocumentAvailableInMainFrame(CefRefPtr<CefBrowser> browser) {}
|
|
};
|
|
|
|
#endif // CEF_INCLUDE_CEF_REQUEST_HANDLER_H_
|