Clean up which storage cookie jar functions use
[WebKit-https.git] / Source / WebCore / platform / network / cf / CookieJarCFNet.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
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 COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "CookieJar.h"
28
29 #if USE(CFNETWORK)
30
31 #include "Cookie.h"
32 #include "CookieStorageCFNet.h"
33 #include "Document.h"
34 #include "KURL.h"
35 #include "ResourceHandle.h"
36 #include "SoftLinking.h"
37 #include <CFNetwork/CFHTTPCookiesPriv.h>
38 #include <CoreFoundation/CoreFoundation.h>
39 #include <wtf/text/WTFString.h>
40
41 #if PLATFORM(WIN)
42 #include <WebKitSystemInterface/WebKitSystemInterface.h>
43 #include <windows.h>
44 #endif
45
46 namespace WebCore {
47
48 static const CFStringRef s_setCookieKeyCF = CFSTR("Set-Cookie");
49 static const CFStringRef s_cookieCF = CFSTR("Cookie");
50
51 static inline RetainPtr<CFStringRef> cookieDomain(CFHTTPCookieRef cookie)
52 {
53     return RetainPtr<CFStringRef>(AdoptCF, CFHTTPCookieCopyDomain(cookie));
54 }
55
56 static inline CFAbsoluteTime cookieExpirationTime(CFHTTPCookieRef cookie)
57 {
58     return CFHTTPCookieGetExpirationTime(cookie);
59 }
60
61 static inline RetainPtr<CFStringRef> cookieName(CFHTTPCookieRef cookie)
62 {
63     return RetainPtr<CFStringRef>(AdoptCF, CFHTTPCookieCopyName(cookie));
64 }
65
66 static inline RetainPtr<CFStringRef> cookiePath(CFHTTPCookieRef cookie)
67 {
68     return RetainPtr<CFStringRef>(AdoptCF, CFHTTPCookieCopyPath(cookie));
69 }
70
71 static inline RetainPtr<CFStringRef> cookieValue(CFHTTPCookieRef cookie)
72 {
73     return RetainPtr<CFStringRef>(AdoptCF, CFHTTPCookieCopyValue(cookie));
74 }
75
76 static RetainPtr<CFArrayRef> filterCookies(CFArrayRef unfilteredCookies)
77 {
78     CFIndex count = CFArrayGetCount(unfilteredCookies);
79     RetainPtr<CFMutableArrayRef> filteredCookies(AdoptCF, CFArrayCreateMutable(0, count, &kCFTypeArrayCallBacks));
80     for (CFIndex i = 0; i < count; ++i) {
81         CFHTTPCookieRef cookie = (CFHTTPCookieRef)CFArrayGetValueAtIndex(unfilteredCookies, i);
82
83         // <rdar://problem/5632883> CFHTTPCookieStorage would store an empty cookie,
84         // which would be sent as "Cookie: =". We have a workaround in setCookies() to prevent
85         // that, but we also need to avoid sending cookies that were previously stored, and
86         // there's no harm to doing this check because such a cookie is never valid.
87         if (!CFStringGetLength(cookieName(cookie).get()))
88             continue;
89
90         if (CFHTTPCookieIsHTTPOnly(cookie))
91             continue;
92
93         CFArrayAppendValue(filteredCookies.get(), cookie);
94     }
95     return filteredCookies;
96 }
97
98 void setCookies(Document* document, const KURL& url, const String& value)
99 {
100     // <rdar://problem/5632883> CFHTTPCookieStorage stores an empty cookie, which would be sent as "Cookie: =".
101     if (value.isEmpty())
102         return;
103
104     RetainPtr<CFHTTPCookieStorageRef> cookieStorage = currentCFHTTPCookieStorage();
105     if (!cookieStorage)
106         return;
107
108     RetainPtr<CFURLRef> urlCF(AdoptCF, url.createCFURL());
109     RetainPtr<CFURLRef> firstPartyForCookiesCF(AdoptCF, document->firstPartyForCookies().createCFURL());
110
111     // <http://bugs.webkit.org/show_bug.cgi?id=6531>, <rdar://4409034>
112     // cookiesWithResponseHeaderFields doesn't parse cookies without a value
113     String cookieString = value.contains('=') ? value : value + "=";
114
115     RetainPtr<CFStringRef> cookieStringCF = cookieString.createCFString();
116     RetainPtr<CFDictionaryRef> headerFieldsCF(AdoptCF, CFDictionaryCreate(kCFAllocatorDefault,
117         (const void**)&s_setCookieKeyCF, (const void**)&cookieStringCF, 1,
118         &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks));
119
120     RetainPtr<CFArrayRef> cookiesCF(AdoptCF, CFHTTPCookieCreateWithResponseHeaderFields(kCFAllocatorDefault,
121         headerFieldsCF.get(), urlCF.get()));
122
123     CFHTTPCookieStorageSetCookies(cookieStorage.get(), filterCookies(cookiesCF.get()).get(), urlCF.get(), firstPartyForCookiesCF.get());
124 }
125
126 String cookies(const Document* /*document*/, const KURL& url)
127 {
128     RetainPtr<CFHTTPCookieStorageRef> cookieStorage = currentCFHTTPCookieStorage();
129     if (!cookieStorage)
130         return String();
131
132     RetainPtr<CFURLRef> urlCF(AdoptCF, url.createCFURL());
133
134     bool secure = url.protocolIs("https");
135     RetainPtr<CFArrayRef> cookiesCF(AdoptCF, CFHTTPCookieStorageCopyCookiesForURL(cookieStorage.get(), urlCF.get(), secure));
136     RetainPtr<CFDictionaryRef> headerCF(AdoptCF, CFHTTPCookieCopyRequestHeaderFields(kCFAllocatorDefault, filterCookies(cookiesCF.get()).get()));
137     return (CFStringRef)CFDictionaryGetValue(headerCF.get(), s_cookieCF);
138 }
139
140 String cookieRequestHeaderFieldValue(const Document* /*document*/, const KURL& url)
141 {
142     RetainPtr<CFHTTPCookieStorageRef> cookieStorage = currentCFHTTPCookieStorage();
143     if (!cookieStorage)
144         return String();
145
146     RetainPtr<CFURLRef> urlCF(AdoptCF, url.createCFURL());
147
148     bool secure = url.protocolIs("https");
149     RetainPtr<CFArrayRef> cookiesCF(AdoptCF, CFHTTPCookieStorageCopyCookiesForURL(cookieStorage.get(), urlCF.get(), secure));
150     RetainPtr<CFDictionaryRef> headerCF(AdoptCF, CFHTTPCookieCopyRequestHeaderFields(kCFAllocatorDefault, cookiesCF.get()));
151     return (CFStringRef)CFDictionaryGetValue(headerCF.get(), s_cookieCF);
152 }
153
154 bool cookiesEnabled(const Document* /*document*/)
155 {
156     CFHTTPCookieStorageAcceptPolicy policy = CFHTTPCookieStorageAcceptPolicyOnlyFromMainDocumentDomain;
157     if (RetainPtr<CFHTTPCookieStorageRef> cookieStorage = currentCFHTTPCookieStorage())
158         policy = CFHTTPCookieStorageGetCookieAcceptPolicy(cookieStorage.get());
159     return policy == CFHTTPCookieStorageAcceptPolicyOnlyFromMainDocumentDomain || policy == CFHTTPCookieStorageAcceptPolicyAlways;
160 }
161
162 bool getRawCookies(const Document*, const KURL& url, Vector<Cookie>& rawCookies)
163 {
164     rawCookies.clear();
165     RetainPtr<CFHTTPCookieStorageRef> cookieStorage = currentCFHTTPCookieStorage();
166     if (!cookieStorage)
167         return false;
168
169     RetainPtr<CFURLRef> urlCF(AdoptCF, url.createCFURL());
170
171     bool sendSecureCookies = url.protocolIs("https");
172     RetainPtr<CFArrayRef> cookiesCF(AdoptCF, CFHTTPCookieStorageCopyCookiesForURL(cookieStorage.get(), urlCF.get(), sendSecureCookies));
173
174     CFIndex count = CFArrayGetCount(cookiesCF.get());
175     rawCookies.reserveCapacity(count);
176
177     for (CFIndex i = 0; i < count; i++) {
178        CFHTTPCookieRef cookie = (CFHTTPCookieRef)CFArrayGetValueAtIndex(cookiesCF.get(), i);
179        String name = cookieName(cookie).get();
180        String value = cookieValue(cookie).get();
181        String domain = cookieDomain(cookie).get();
182        String path = cookiePath(cookie).get();
183
184        double expires = (cookieExpirationTime(cookie) + kCFAbsoluteTimeIntervalSince1970) * 1000;
185
186        bool httpOnly = CFHTTPCookieIsHTTPOnly(cookie);
187        bool secure = CFHTTPCookieIsSecure(cookie);
188        bool session = false;    // FIXME: Need API for if a cookie is a session cookie.
189
190        rawCookies.uncheckedAppend(Cookie(name, value, domain, path, expires, httpOnly, secure, session));
191     }
192
193     return true;
194 }
195
196 void deleteCookie(const Document*, const KURL& url, const String& name)
197 {
198     RetainPtr<CFHTTPCookieStorageRef> cookieStorage = currentCFHTTPCookieStorage();
199     if (!cookieStorage)
200         return;
201
202     RetainPtr<CFURLRef> urlCF(AdoptCF, url.createCFURL());
203
204     bool sendSecureCookies = url.protocolIs("https");
205     RetainPtr<CFArrayRef> cookiesCF(AdoptCF, CFHTTPCookieStorageCopyCookiesForURL(cookieStorage.get(), urlCF.get(), sendSecureCookies));
206
207     CFIndex count = CFArrayGetCount(cookiesCF.get());
208     for (CFIndex i = 0; i < count; i++) {
209         CFHTTPCookieRef cookie = (CFHTTPCookieRef)CFArrayGetValueAtIndex(cookiesCF.get(), i);
210         if (String(cookieName(cookie).get()) == name) {
211             CFHTTPCookieStorageDeleteCookie(cookieStorage.get(), cookie);
212             break;
213         }
214     }
215 }
216
217 void getHostnamesWithCookies(HashSet<String>& hostnames)
218 {
219     RetainPtr<CFHTTPCookieStorageRef> cookieStorage = defaultCFHTTPCookieStorage();
220     if (!cookieStorage)
221         return;
222
223     RetainPtr<CFArrayRef> cookiesCF(AdoptCF, CFHTTPCookieStorageCopyCookies(cookieStorage.get()));
224     if (!cookiesCF)
225         return;
226
227     CFIndex count = CFArrayGetCount(cookiesCF.get());
228     for (CFIndex i = 0; i < count; ++i) {
229         CFHTTPCookieRef cookie = static_cast<CFHTTPCookieRef>(const_cast<void *>(CFArrayGetValueAtIndex(cookiesCF.get(), i)));
230         RetainPtr<CFStringRef> domain = cookieDomain(cookie);
231         hostnames.add(domain.get());
232     }
233 }
234
235 void deleteCookiesForHostname(const String& hostname)
236 {
237     RetainPtr<CFHTTPCookieStorageRef> cookieStorage = defaultCFHTTPCookieStorage();
238     if (!cookieStorage)
239         return;
240
241     RetainPtr<CFArrayRef> cookiesCF(AdoptCF, CFHTTPCookieStorageCopyCookies(cookieStorage.get()));
242     if (!cookiesCF)
243         return;
244
245     CFIndex count = CFArrayGetCount(cookiesCF.get());
246     for (CFIndex i = count - 1; i >=0; i--) {
247         CFHTTPCookieRef cookie = static_cast<CFHTTPCookieRef>(const_cast<void *>(CFArrayGetValueAtIndex(cookiesCF.get(), i)));
248         RetainPtr<CFStringRef> domain = cookieDomain(cookie);
249         if (String(domain.get()) == hostname)
250             CFHTTPCookieStorageDeleteCookie(cookieStorage.get(), cookie);
251     }
252 }
253
254 void deleteAllCookies()
255 {
256     RetainPtr<CFHTTPCookieStorageRef> cookieStorage = defaultCFHTTPCookieStorage();
257     if (!cookieStorage)
258         return;
259
260     CFHTTPCookieStorageDeleteAllCookies(cookieStorage.get());
261 }
262
263 } // namespace WebCore
264
265 #endif // USE(CFNETWORK)