1/*
2 * Copyright (C) 2012, 2015 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. 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 "FetchOptions.h"
29#include "ResourceLoadPriority.h"
30#include "ResourceLoaderOptions.h"
31#include "StoredCredentialsPolicy.h"
32#include <pal/SessionID.h>
33#include <wtf/Forward.h>
34
35namespace WebCore {
36
37class CachedResource;
38class ContentSecurityPolicy;
39class Frame;
40class FrameLoader;
41class HTTPHeaderMap;
42class NetscapePlugInStreamLoader;
43class NetscapePlugInStreamLoaderClient;
44struct NetworkTransactionInformation;
45class NetworkLoadMetrics;
46class ResourceError;
47class ResourceLoader;
48class ResourceRequest;
49class ResourceResponse;
50class SecurityOrigin;
51class SharedBuffer;
52class SubresourceLoader;
53
54struct FetchOptions;
55
56class WEBCORE_EXPORT LoaderStrategy {
57public:
58 virtual void loadResource(Frame&, CachedResource&, ResourceRequest&&, const ResourceLoaderOptions&, CompletionHandler<void(RefPtr<SubresourceLoader>&&)>&&) = 0;
59 virtual void loadResourceSynchronously(FrameLoader&, unsigned long identifier, const ResourceRequest&, ClientCredentialPolicy, const FetchOptions&, const HTTPHeaderMap&, ResourceError&, ResourceResponse&, Vector<char>& data) = 0;
60 virtual void pageLoadCompleted(uint64_t webPageID) = 0;
61
62 virtual void remove(ResourceLoader*) = 0;
63 virtual void setDefersLoading(ResourceLoader&, bool) = 0;
64 virtual void crossOriginRedirectReceived(ResourceLoader*, const URL& redirectURL) = 0;
65
66 virtual void servePendingRequests(ResourceLoadPriority minimumPriority = ResourceLoadPriority::VeryLow) = 0;
67 virtual void suspendPendingRequests() = 0;
68 virtual void resumePendingRequests() = 0;
69
70 virtual bool usePingLoad() const { return true; }
71 using PingLoadCompletionHandler = WTF::Function<void(const ResourceError&, const ResourceResponse&)>;
72 virtual void startPingLoad(Frame&, ResourceRequest&, const HTTPHeaderMap& originalRequestHeaders, const FetchOptions&, ContentSecurityPolicyImposition, PingLoadCompletionHandler&& = { }) = 0;
73
74 using PreconnectCompletionHandler = WTF::Function<void(const ResourceError&)>;
75 virtual void preconnectTo(FrameLoader&, const URL&, StoredCredentialsPolicy, PreconnectCompletionHandler&&) = 0;
76
77 virtual void setCaptureExtraNetworkLoadMetricsEnabled(bool) = 0;
78
79 virtual bool isOnLine() const = 0;
80 virtual void addOnlineStateChangeListener(WTF::Function<void(bool)>&&) = 0;
81
82 virtual bool shouldPerformSecurityChecks() const { return false; }
83 virtual bool havePerformedSecurityChecks(const ResourceResponse&) const { return false; }
84
85 virtual ResourceResponse responseFromResourceLoadIdentifier(uint64_t resourceLoadIdentifier);
86 virtual Vector<NetworkTransactionInformation> intermediateLoadInformationFromResourceLoadIdentifier(uint64_t resourceLoadIdentifier);
87 virtual NetworkLoadMetrics networkMetricsFromResourceLoadIdentifier(uint64_t resourceLoadIdentifier);
88
89 // Used for testing only.
90 virtual Vector<uint64_t> ongoingLoads() const { return { }; }
91
92protected:
93 virtual ~LoaderStrategy();
94};
95
96} // namespace WebCore
97