dhcp_proxy_script_adapter_fetcher_win.h revision c2e0dbddbe15c98d52c4786dac06cb8952a8ae6d
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NET_PROXY_DHCP_PROXY_SCRIPT_ADAPTER_FETCHER_WIN_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define NET_PROXY_DHCP_PROXY_SCRIPT_ADAPTER_FETCHER_WIN_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/weak_ptr.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/string16.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/threading/non_thread_safe.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/timer.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/completion_callback.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/net_export.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "googleurl/src/gurl.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ProxyScriptFetcher; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class URLRequestContext; 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// For a given adapter, this class takes care of first doing a DHCP lookup 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// to get the PAC URL, then if there is one, trying to fetch it. 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE DhcpProxyScriptAdapterFetcher 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) : public base::SupportsWeakPtr<DhcpProxyScriptAdapterFetcher>, 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NON_EXPORTED_BASE(public base::NonThreadSafe) { 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |url_request_context| must outlive DhcpProxyScriptAdapterFetcher. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit DhcpProxyScriptAdapterFetcher( 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) URLRequestContext* url_request_context); 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~DhcpProxyScriptAdapterFetcher(); 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Starts a fetch. On completion (but not cancellation), |callback| 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will be invoked with the network error indicating success or failure 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of fetching a DHCP-configured PAC file on this adapter. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // On completion, results can be obtained via |GetPacScript()|, |GetPacURL()|. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // You may only call Fetch() once on a given instance of 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // DhcpProxyScriptAdapterFetcher. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Fetch(const std::string& adapter_name, 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::CompletionCallback& callback); 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Cancels the fetch on this adapter. 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Cancel(); 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if in the FINISH state (not CANCEL). 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool DidFinish() const; 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the network error indicating the result of the fetch. Will 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // return IO_PENDING until the fetch is complete or cancelled. This is 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the same network error passed to the |callback| provided to |Fetch()|. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int GetResult() const; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the contents of the PAC file retrieved. Only valid if 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |IsComplete()| is true. Returns the empty string if |GetResult()| 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // returns anything other than OK. 61c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual base::string16 GetPacScript() const; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the PAC URL retrieved from DHCP. Only guaranteed to be 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // valid if |IsComplete()| is true. Returns an empty URL if no URL was 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // configured in DHCP. May return a valid URL even if |result()| does 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // not return OK (this would indicate that we found a URL configured in 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // DHCP but failed to download it). 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual GURL GetPacURL() const; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the PAC URL configured in DHCP for the given |adapter_name|, or 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the empty string if none is configured. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This function executes synchronously due to limitations of the Windows 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // DHCP client API. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static std::string GetPacURLFromDhcp(const std::string& adapter_name); 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is the state machine for fetching from a given adapter. 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The state machine goes from START->WAIT_DHCP when it starts 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a worker thread to fetch the PAC URL from DHCP. 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In state WAIT_DHCP, if the DHCP query finishes and has no URL, it 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // moves to state FINISH. If there is a URL, it starts a 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ProxyScriptFetcher to fetch it and moves to state WAIT_URL. 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // It goes from WAIT_URL->FINISH when the ProxyScriptFetcher completes. 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In state FINISH, completion is indicated to the outer class, with 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the results of the fetch if a PAC script was successfully fetched. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In state WAIT_DHCP, our timeout occurring can push us to FINISH. 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In any state except FINISH, a call to Cancel() will move to state 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // CANCEL and cause all outstanding work to be cancelled or its 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // results ignored when available. 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum State { 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATE_START, 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATE_WAIT_DHCP, 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATE_WAIT_URL, 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATE_FINISH, 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATE_CANCEL, 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) State state() const; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This inner class encapsulates work done on a worker pool thread. 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // By using a separate object, we can keep the main object completely 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // thread safe and let it be non-refcounted. 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class NET_EXPORT_PRIVATE DhcpQuery 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) : public base::RefCountedThreadSafe<DhcpQuery> { 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DhcpQuery(); 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~DhcpQuery(); 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This method should run on a worker pool thread, via PostTaskAndReply. 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // After it has run, the |url()| method on this object will return the 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // URL retrieved. 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void GetPacURLForAdapter(const std::string& adapter_name); 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the URL retrieved for the given adapter, once the task has run. 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& url() const; 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Virtual method introduced to allow unit testing. 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual std::string ImplGetPacURLFromDhcp(const std::string& adapter_name); 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The URL retrieved for the given adapter. 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string url_; 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(DhcpQuery); 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Virtual methods introduced to allow unit testing. 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ProxyScriptFetcher* ImplCreateScriptFetcher(); 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual DhcpQuery* ImplCreateDhcpQuery(); 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual base::TimeDelta ImplGetTimeout() const; 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Event/state transition handlers 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnDhcpQueryDone(scoped_refptr<DhcpQuery> dhcp_query); 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnTimeout(); 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnFetcherDone(int result); 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void TransitionToFinish(); 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Current state of this state machine. 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) State state_; 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A network error indicating result of operation. 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int result_; 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Empty string or the PAC script downloaded. 154c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::string16 pac_script_; 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Empty URL or the PAC URL configured in DHCP. 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GURL pac_url_; 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Callback to let our client know we're done. Invalid in states 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // START, FINISH and CANCEL. 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::CompletionCallback callback_; 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Fetcher to retrieve PAC files once URL is known. 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<ProxyScriptFetcher> script_fetcher_; 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Implements a timeout on the call to the Win32 DHCP API. 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::OneShotTimer<DhcpProxyScriptAdapterFetcher> wait_timer_; 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) URLRequestContext* const url_request_context_; 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_IMPLICIT_CONSTRUCTORS(DhcpProxyScriptAdapterFetcher); 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_PROXY_DHCP_PROXY_SCRIPT_ADAPTER_FETCHER_WIN_H_ 177