1c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Copyright (c) 2010 The Chromium Authors. All rights reserved.
2c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Use of this source code is governed by a BSD-style license that can be
3c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// found in the LICENSE file.
4c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
5c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#ifndef NET_PROXY_PROXY_RESOLVER_JS_BINDINGS_H_
6c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#define NET_PROXY_PROXY_RESOLVER_JS_BINDINGS_H_
73345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#pragma once
8c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
9c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <string>
10c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
11c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "base/string16.h"
12c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
13c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottnamespace net {
14c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
15c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottclass HostResolver;
16c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass NetLog;
17c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochstruct ProxyResolverRequestContext;
18c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
19c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Interface for the javascript bindings.
20c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottclass ProxyResolverJSBindings {
21c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott public:
22c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  ProxyResolverJSBindings() : current_request_context_(NULL) {}
23c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
24c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott  virtual ~ProxyResolverJSBindings() {}
25c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
26c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott  // Handler for "alert(message)"
27c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  virtual void Alert(const string16& message) = 0;
28c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
29c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Handler for "myIpAddress()". Returns true on success and fills
30c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // |*first_ip_address| with the result.
31c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  virtual bool MyIpAddress(std::string* first_ip_address) = 0;
32c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
33c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Handler for "myIpAddressEx()". Returns true on success and fills
34c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // |*ip_address_list| with the result.
35c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott  //
36c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott  // This is a Microsoft extension to PAC for IPv6, see:
373345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick  // http://blogs.msdn.com/b/wndp/archive/2006/07/13/ipv6-pac-extensions-v0-9.aspx
383345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick
39c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  virtual bool MyIpAddressEx(std::string* ip_address_list) = 0;
40c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
41c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Handler for "dnsResolve(host)". Returns true on success and fills
42c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // |*first_ip_address| with the result.
43c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  virtual bool DnsResolve(const std::string& host,
44c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch                          std::string* first_ip_address) = 0;
45c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
46c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Handler for "dnsResolveEx(host)". Returns true on success and fills
47c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // |*ip_address_list| with the result.
48c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott  //
49c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott  // This is a Microsoft extension to PAC for IPv6, see:
503345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick  // http://blogs.msdn.com/b/wndp/archive/2006/07/13/ipv6-pac-extensions-v0-9.aspx
51c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  virtual bool DnsResolveEx(const std::string& host,
52c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch                            std::string* ip_address_list) = 0;
53c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
54c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott  // Handler for when an error is encountered. |line_number| may be -1
55c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott  // if a line number is not applicable to this error.
56c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  virtual void OnError(int line_number, const string16& error) = 0;
57c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
58c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Called before the thread running the proxy resolver is stopped.
59c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  virtual void Shutdown() = 0;
60c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
61c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott  // Creates a default javascript bindings implementation that will:
62731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick  //   - Send script error messages to both VLOG(1) and the NetLog.
63731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick  //   - Send script alert()s to both VLOG(1) and the NetLog.
64c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott  //   - Use the provided host resolver to service dnsResolve().
65c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott  //
66c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Note that |host_resolver| will be used in sync mode mode.
67c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  static ProxyResolverJSBindings* CreateDefault(HostResolver* host_resolver,
68c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch                                                NetLog* net_log);
69c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
70c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Sets details about the currently executing FindProxyForURL() request.
71c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  void set_current_request_context(
72c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch      ProxyResolverRequestContext* current_request_context) {
73c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch    current_request_context_ = current_request_context;
74c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  }
75c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
76c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Retrieves details about the currently executing FindProxyForURL() request.
77c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  ProxyResolverRequestContext* current_request_context() {
78c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch    return current_request_context_;
79c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  }
80c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
81c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch private:
82c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  ProxyResolverRequestContext* current_request_context_;
83c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott};
84c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
85c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott}  // namespace net
86c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott
87c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#endif  // NET_PROXY_PROXY_RESOLVER_JS_BINDINGS_H_
88