Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / platform / network / curl / CurlProxySettings.h
1 /*
2  * Copyright (C) 2018 Sony Interactive Entertainment Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <wtf/URL.h>
29 #include <wtf/text/WTFString.h>
30
31 #define kCURLAUTH_DIGEST_IE    (((unsigned long) 1) << 4)
32 #define kCURLAUTH_ANY          (~kCURLAUTH_DIGEST_IE)
33
34 namespace WebCore {
35
36 class CurlProxySettings {
37 public:
38     enum class Mode : uint8_t {
39         Default,
40         NoProxy,
41         Custom
42     };
43
44     CurlProxySettings() = default;
45     WEBCORE_EXPORT explicit CurlProxySettings(Mode mode) : m_mode(mode) { }
46     WEBCORE_EXPORT CurlProxySettings(URL&&, String&& ignoreHosts);
47
48     WEBCORE_EXPORT CurlProxySettings(const CurlProxySettings&) = default;
49     WEBCORE_EXPORT CurlProxySettings& operator=(const CurlProxySettings&) = default;
50
51     bool isEmpty() const { return m_mode == Mode::Custom && m_urlSerializedWithPort.isEmpty() && m_ignoreHosts.isEmpty(); }
52
53     Mode mode() const { return m_mode; }
54     const String& url() const { return m_urlSerializedWithPort; }
55     const String& ignoreHosts() const { return m_ignoreHosts; }
56
57     WEBCORE_EXPORT void setUserPass(const String&, const String&);
58     const String user() const { return m_url.user(); }
59     const String password() const { return m_url.pass(); }
60
61     void setDefaultAuthMethod() { m_authMethod = kCURLAUTH_ANY; }
62     void setAuthMethod(long);
63     long authMethod() const { return m_authMethod; }
64
65 private:
66     Mode m_mode { Mode::Default };
67     URL m_url;
68     String m_ignoreHosts;
69     long m_authMethod { static_cast<long>(kCURLAUTH_ANY) };
70
71     // We can't simply use m_url.string() because we need to explicitly indicate the port number
72     // to libcurl. URLParser omit the default port while parsing, but libcurl assume 1080 as a
73     // default HTTP Proxy, not 80, if port number is not in the url.
74     String m_urlSerializedWithPort;
75
76     void rebuildUrl();
77 };
78
79 bool protocolIsInSocksFamily(const URL&);
80
81 } // namespace WebCore