// Copyright (c) 2019 GitHub, Inc. // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. #ifndef ELECTRON_SHELL_BROWSER_API_ELECTRON_API_WEB_REQUEST_H_ #define ELECTRON_SHELL_BROWSER_API_ELECTRON_API_WEB_REQUEST_H_ #include #include #include "base/memory/raw_ptr.h" #include "base/values.h" #include "extensions/common/url_pattern.h" #include "gin/arguments.h" #include "gin/handle.h" #include "gin/wrappable.h" #include "shell/browser/net/web_request_api_interface.h" namespace content { class BrowserContext; } namespace electron::api { class WebRequest : public gin::Wrappable, public WebRequestAPI { public: // Return the WebRequest object attached to |browser_context|, create if there // is no one. // Note that the lifetime of WebRequest object is managed by Session, instead // of the caller. static gin::Handle FromOrCreate( v8::Isolate* isolate, content::BrowserContext* browser_context); // Return a new WebRequest object, this should only be called by Session. static gin::Handle Create( v8::Isolate* isolate, content::BrowserContext* browser_context); // Find the WebRequest object attached to |browser_context|. static gin::Handle From(v8::Isolate* isolate, content::BrowserContext* browser_context); // gin::Wrappable: static gin::WrapperInfo kWrapperInfo; gin::ObjectTemplateBuilder GetObjectTemplateBuilder( v8::Isolate* isolate) override; const char* GetTypeName() override; // WebRequestAPI: bool HasListener() const override; int OnBeforeRequest(extensions::WebRequestInfo* info, const network::ResourceRequest& request, net::CompletionOnceCallback callback, GURL* new_url) override; int OnBeforeSendHeaders(extensions::WebRequestInfo* info, const network::ResourceRequest& request, BeforeSendHeadersCallback callback, net::HttpRequestHeaders* headers) override; int OnHeadersReceived( extensions::WebRequestInfo* info, const network::ResourceRequest& request, net::CompletionOnceCallback callback, const net::HttpResponseHeaders* original_response_headers, scoped_refptr* override_response_headers, GURL* allowed_unsafe_redirect_url) override; void OnSendHeaders(extensions::WebRequestInfo* info, const network::ResourceRequest& request, const net::HttpRequestHeaders& headers) override; void OnBeforeRedirect(extensions::WebRequestInfo* info, const network::ResourceRequest& request, const GURL& new_location) override; void OnResponseStarted(extensions::WebRequestInfo* info, const network::ResourceRequest& request) override; void OnErrorOccurred(extensions::WebRequestInfo* info, const network::ResourceRequest& request, int net_error) override; void OnCompleted(extensions::WebRequestInfo* info, const network::ResourceRequest& request, int net_error) override; void OnRequestWillBeDestroyed(extensions::WebRequestInfo* info) override; private: WebRequest(v8::Isolate* isolate, content::BrowserContext* browser_context); ~WebRequest() override; enum class SimpleEvent { kOnSendHeaders, kOnBeforeRedirect, kOnResponseStarted, kOnCompleted, kOnErrorOccurred, }; enum class ResponseEvent { kOnBeforeRequest, kOnBeforeSendHeaders, kOnHeadersReceived, }; using SimpleListener = base::RepeatingCallback)>; using ResponseCallback = base::OnceCallback)>; using ResponseListener = base::RepeatingCallback, ResponseCallback)>; template void SetSimpleListener(gin::Arguments* args); template void SetResponseListener(gin::Arguments* args); template void SetListener(Event event, Listeners* listeners, gin::Arguments* args); template void HandleSimpleEvent(SimpleEvent event, extensions::WebRequestInfo* info, Args... args); template int HandleResponseEvent(ResponseEvent event, extensions::WebRequestInfo* info, net::CompletionOnceCallback callback, Out out, Args... args); template void OnListenerResult(uint64_t id, T out, v8::Local response); class RequestFilter { public: RequestFilter(std::set, std::set); RequestFilter(const RequestFilter&); RequestFilter(); ~RequestFilter(); void AddUrlPattern(URLPattern pattern); void AddType(extensions::WebRequestResourceType type); bool MatchesRequest(extensions::WebRequestInfo* info) const; private: bool MatchesURL(const GURL& url) const; bool MatchesType(extensions::WebRequestResourceType type) const; std::set url_patterns_; std::set types_; }; struct SimpleListenerInfo { RequestFilter filter; SimpleListener listener; SimpleListenerInfo(RequestFilter, SimpleListener); SimpleListenerInfo(); ~SimpleListenerInfo(); }; struct ResponseListenerInfo { RequestFilter filter; ResponseListener listener; ResponseListenerInfo(RequestFilter, ResponseListener); ResponseListenerInfo(); ~ResponseListenerInfo(); }; std::map simple_listeners_; std::map response_listeners_; std::map callbacks_; // Weak-ref, it manages us. raw_ptr browser_context_; }; } // namespace electron::api #endif // ELECTRON_SHELL_BROWSER_API_ELECTRON_API_WEB_REQUEST_H_