Add facility for tracking times and results of page and resource loading
[WebKit-https.git] / Source / WebCore / loader / LoaderStrategy.h
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 #include <wtf/SHA1.h>
35
36 namespace WebCore {
37
38 class CachedResource;
39 class ContentSecurityPolicy;
40 class Frame;
41 class FrameLoader;
42 class HTTPHeaderMap;
43 class NetscapePlugInStreamLoader;
44 class NetscapePlugInStreamLoaderClient;
45 class NetworkLoadMetrics;
46 class ResourceError;
47 class ResourceLoader;
48 class ResourceRequest;
49 class ResourceResponse;
50 class SecurityOrigin;
51 class SharedBuffer;
52 class SubresourceLoader;
53 class URL;
54
55 struct FetchOptions;
56
57 class WEBCORE_EXPORT LoaderStrategy {
58 public:
59     virtual void loadResource(Frame&, CachedResource&, ResourceRequest&&, const ResourceLoaderOptions&, CompletionHandler<void(RefPtr<SubresourceLoader>&&)>&&) = 0;
60     virtual void loadResourceSynchronously(FrameLoader&, unsigned long identifier, const ResourceRequest&, ClientCredentialPolicy, const FetchOptions&, const HTTPHeaderMap&, ResourceError&, ResourceResponse&, Vector<char>& data) = 0;
61     virtual void pageLoadCompleted(uint64_t webPageID) = 0;
62
63     virtual void remove(ResourceLoader*) = 0;
64     virtual void setDefersLoading(ResourceLoader*, bool) = 0;
65     virtual void crossOriginRedirectReceived(ResourceLoader*, const URL& redirectURL) = 0;
66
67     virtual void servePendingRequests(ResourceLoadPriority minimumPriority = ResourceLoadPriority::VeryLow) = 0;
68     virtual void suspendPendingRequests() = 0;
69     virtual void resumePendingRequests() = 0;
70
71     using PingLoadCompletionHandler = WTF::Function<void(const ResourceError&, const ResourceResponse&)>;
72     virtual void startPingLoad(Frame&, ResourceRequest&, const HTTPHeaderMap& originalRequestHeaders, const FetchOptions&, 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 storeDerivedDataToCache(const SHA1::Digest& bodyKey, const String& type, const String& partition, WebCore::SharedBuffer&) = 0;
78
79     virtual void setCaptureExtraNetworkLoadMetricsEnabled(bool) = 0;
80
81     virtual bool isOnLine() const = 0;
82     virtual void addOnlineStateChangeListener(WTF::Function<void(bool)>&&) = 0;
83
84     virtual bool isDoingLoadingSecurityChecks() const { return false; }
85
86     virtual ResourceResponse responseFromResourceLoadIdentifier(uint64_t resourceLoadIdentifier);
87     virtual NetworkLoadMetrics networkMetricsFromResourceLoadIdentifier(uint64_t resourceLoadIdentifier);
88
89 protected:
90     virtual ~LoaderStrategy();
91 };
92
93 } // namespace WebCore