1ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen// Copyright (c) 2011 The Chromium Authors. All rights reserved. 2c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Use of this source code is governed by a BSD-style license that can be 3c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// found in the LICENSE file. 4c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 5c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#ifndef CHROME_BROWSER_NET_RESOLVE_PROXY_MSG_HELPER_H_ 6c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#define CHROME_BROWSER_NET_RESOLVE_PROXY_MSG_HELPER_H_ 73345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#pragma once 8c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 9c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <deque> 10c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <string> 11c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 12ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen#include "base/memory/ref_counted.h" 13ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen#include "content/browser/browser_message_filter.h" 14c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "googleurl/src/gurl.h" 15c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "net/base/completion_callback.h" 16c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "net/proxy/proxy_service.h" 17c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 18ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen// Responds to ChildProcessHostMsg_ResolveProxy, kicking off a ProxyResolve 19ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen// request on the IO thread using the specified proxy service. Completion is 20ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen// notified through the delegate. If multiple requests are started at the same 21ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen// time, they will run in FIFO order, with only 1 being outstanding at a time. 22c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 23c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// When an instance of ResolveProxyMsgHelper is destroyed, it cancels any 24c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// outstanding proxy resolve requests with the proxy service. It also deletes 25c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// the stored IPC::Message pointers for pending requests. 26c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 27c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// This object is expected to live on the IO thread. 28ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsenclass ResolveProxyMsgHelper : public BrowserMessageFilter { 29c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public: 30ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen // If |proxy_service| is NULL, then the main profile's proxy service will 31ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen // be used. 32ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen explicit ResolveProxyMsgHelper(net::ProxyService* proxy_service); 33c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 34c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Destruction cancels the current outstanding request, and clears the 35c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // pending queue. 36c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ~ResolveProxyMsgHelper(); 37c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 38ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen // BrowserMessageFilter implementation 39ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen virtual bool OnMessageReceived(const IPC::Message& message, 40ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen bool* message_was_ok); 41ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen 42ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen void OnResolveProxy(const GURL& url, IPC::Message* reply_msg); 43ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen 44c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch private: 45c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Callback for the ProxyService (bound to |callback_|). 46c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void OnResolveProxyCompleted(int result); 47c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 48c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Starts the first pending request. 49c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void StartPendingRequest(); 50c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 51c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Get the proxy service instance to use. On success returns true and 52c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // sets |*out|. Otherwise returns false. 53c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool GetProxyService(scoped_refptr<net::ProxyService>* out) const; 54c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 55c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // A PendingRequest is a resolve request that is in progress, or queued. 56c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch struct PendingRequest { 57c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public: 58c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch PendingRequest(const GURL& url, IPC::Message* reply_msg) : 59c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch url(url), reply_msg(reply_msg), pac_req(NULL) { } 60c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 61c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // The URL of the request. 62c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch GURL url; 63c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 64c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Data to pass back to the delegate on completion (we own it until then). 65c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch IPC::Message* reply_msg; 66c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 67c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Handle for cancelling the current request if it has started (else NULL). 68c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch net::ProxyService::PacRequest* pac_req; 69c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch }; 70c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 71c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Members for the current outstanding proxy request. 72c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch scoped_refptr<net::ProxyService> proxy_service_; 73c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch net::CompletionCallbackImpl<ResolveProxyMsgHelper> callback_; 74c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch net::ProxyInfo proxy_info_; 75c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 76c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // FIFO queue of pending requests. The first entry is always the current one. 77c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch typedef std::deque<PendingRequest> PendingRequestList; 78c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch PendingRequestList pending_requests_; 79c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 80c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Specified by unit-tests, to use this proxy service in place of the 81c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // global one. 82c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch scoped_refptr<net::ProxyService> proxy_service_override_; 83c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch}; 84c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 85c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#endif // CHROME_BROWSER_NET_RESOLVE_PROXY_MSG_HELPER_H_ 86