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/CompletionHandler.h>
29#include <wtf/Forward.h>
30#include <wtf/Ref.h>
31
32#if USE(CFURLCONNECTION)
33#include <pal/spi/cf/CFNetworkSPI.h>
34#endif
35
36#if PLATFORM(IOS_FAMILY) || USE(CFURLCONNECTION)
37#include <wtf/RetainPtr.h>
38#endif
39
40#if PLATFORM(COCOA)
41OBJC_CLASS NSCachedURLResponse;
42#endif
43
44namespace WebCore {
45class AuthenticationChallenge;
46class Credential;
47class ProtectionSpace;
48class ResourceHandle;
49class ResourceError;
50class ResourceRequest;
51class ResourceResponse;
52class SharedBuffer;
53
54enum CacheStoragePolicy {
55 StorageAllowed,
56 StorageAllowedInMemoryOnly,
57 StorageNotAllowed
58};
59
60class ResourceHandleClient {
61public:
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
85#if USE(CFURLCONNECTION)
86 virtual void willCacheResponseAsync(ResourceHandle*, CFCachedURLResponseRef response, CompletionHandler<void(CFCachedURLResponseRef)>&& completionHandler) { completionHandler(response); }
87#elif PLATFORM(COCOA)
88 virtual void willCacheResponseAsync(ResourceHandle*, NSCachedURLResponse *response, CompletionHandler<void(NSCachedURLResponse *)>&& completionHandler) { completionHandler(response); }
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_FAMILY) || USE(CFURLCONNECTION)
96 virtual RetainPtr<CFDictionaryRef> connectionProperties(ResourceHandle*) { return nullptr; }
97#endif
98
99#if PLATFORM(WIN) && USE(CFURLCONNECTION)
100 virtual bool shouldCacheResponse(ResourceHandle*, CFCachedURLResponseRef) { return true; }
101#endif
102};
103
104}
105