Use completion handlers for ResourceHandleClient::canAuthenticateAgainstProtectionSpa...
[WebKit-https.git] / Source / WebCore / platform / network / ResourceHandleClient.h
1 /*
2  * Copyright (C) 2006-2017 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 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 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 #pragma once
27
28 #include <wtf/Forward.h>
29 #include <wtf/Ref.h>
30
31 #if USE(CFURLCONNECTION)
32 #include <pal/spi/cf/CFNetworkSPI.h>
33 #endif
34
35 #if PLATFORM(IOS) || USE(CFURLCONNECTION)
36 #include <wtf/RetainPtr.h>
37 #endif
38
39 #if PLATFORM(COCOA)
40 OBJC_CLASS NSCachedURLResponse;
41 #endif
42
43 namespace WebCore {
44 class AuthenticationChallenge;
45 class Credential;
46 class URL;
47 class ProtectionSpace;
48 class ResourceHandle;
49 class ResourceError;
50 class ResourceRequest;
51 class ResourceResponse;
52 class SharedBuffer;
53
54 enum CacheStoragePolicy {
55     StorageAllowed,
56     StorageAllowedInMemoryOnly,
57     StorageNotAllowed
58 };
59
60 class ResourceHandleClient {
61 public:
62     WEBCORE_EXPORT ResourceHandleClient();
63     WEBCORE_EXPORT virtual ~ResourceHandleClient();
64
65     virtual void didSendData(ResourceHandle*, unsigned long long /*bytesSent*/, unsigned long long /*totalBytesToBeSent*/) { }
66
67     virtual void didReceiveData(ResourceHandle*, const char*, unsigned, int /*encodedDataLength*/) { }
68     WEBCORE_EXPORT virtual void didReceiveBuffer(ResourceHandle*, Ref<SharedBuffer>&&, int encodedDataLength);
69     
70     virtual void didFinishLoading(ResourceHandle*) { }
71     virtual void didFail(ResourceHandle*, const ResourceError&) { }
72     virtual void wasBlocked(ResourceHandle*) { }
73     virtual void cannotShowURL(ResourceHandle*) { }
74
75     virtual bool loadingSynchronousXHR() { return false; }
76
77     WEBCORE_EXPORT virtual void willSendRequestAsync(ResourceHandle*, ResourceRequest&&, ResourceResponse&&, CompletionHandler<void(ResourceRequest&&)>&&) = 0;
78
79     WEBCORE_EXPORT virtual void didReceiveResponseAsync(ResourceHandle*, ResourceResponse&&, CompletionHandler<void()>&&) = 0;
80
81 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
82     WEBCORE_EXPORT virtual void canAuthenticateAgainstProtectionSpaceAsync(ResourceHandle*, const ProtectionSpace&, CompletionHandler<void(bool)>&&) = 0;
83 #endif
84     // Client will pass an updated request using ResourceHandle::continueWillCacheResponse() when ready.
85 #if USE(CFURLCONNECTION)
86     WEBCORE_EXPORT virtual void willCacheResponseAsync(ResourceHandle*, CFCachedURLResponseRef);
87 #elif PLATFORM(COCOA)
88     WEBCORE_EXPORT virtual void willCacheResponseAsync(ResourceHandle*, NSCachedURLResponse *);
89 #endif
90
91     virtual bool shouldUseCredentialStorage(ResourceHandle*) { return false; }
92     virtual void didReceiveAuthenticationChallenge(ResourceHandle*, const AuthenticationChallenge&) { }
93     virtual void receivedCancellation(ResourceHandle*, const AuthenticationChallenge&) { }
94
95 #if PLATFORM(IOS) || USE(CFURLCONNECTION)
96     virtual RetainPtr<CFDictionaryRef> connectionProperties(ResourceHandle*) { return nullptr; }
97 #endif
98
99 #if USE(CFURLCONNECTION)
100     virtual CFCachedURLResponseRef willCacheResponse(ResourceHandle*, CFCachedURLResponseRef response) { return response; }
101 #if PLATFORM(WIN)
102     virtual bool shouldCacheResponse(ResourceHandle*, CFCachedURLResponseRef) { return true; }
103 #endif // PLATFORM(WIN)
104
105 #elif PLATFORM(COCOA)
106     virtual NSCachedURLResponse *willCacheResponse(ResourceHandle*, NSCachedURLResponse *response) { return response; }
107 #endif
108 };
109
110 }