CachedResourceLoader should set headers of the HTTP request prior checking for the...
[WebKit-https.git] / Source / WebCore / loader / cache / CachedResourceRequest.h
1 /*
2  * Copyright (C) 2012 Google, 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 GOOGLE 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 #ifndef CachedResourceRequest_h
27 #define CachedResourceRequest_h
28
29 #include "CachedResource.h"
30 #include "DocumentLoader.h"
31 #include "Element.h"
32 #include "ResourceLoadPriority.h"
33 #include "ResourceLoaderOptions.h"
34 #include "ResourceRequest.h"
35 #include "SecurityOrigin.h"
36 #include <wtf/RefPtr.h>
37 #include <wtf/text/AtomicString.h>
38
39 namespace WebCore {
40
41 namespace ContentExtensions {
42 struct BlockedStatus;
43 }
44
45 class Document;
46 class FrameLoader;
47 enum class ReferrerPolicy;
48
49 bool isRequestCrossOrigin(SecurityOrigin*, const URL& requestURL, const ResourceLoaderOptions&);
50
51 class CachedResourceRequest {
52 public:
53     CachedResourceRequest(ResourceRequest&&, const ResourceLoaderOptions&, Optional<ResourceLoadPriority> = Nullopt, String&& charset = String());
54
55     ResourceRequest&& releaseResourceRequest() { return WTFMove(m_resourceRequest); }
56     const ResourceRequest& resourceRequest() const { return m_resourceRequest; }
57     const String& charset() const { return m_charset; }
58     void setCharset(const String& charset) { m_charset = charset; }
59     const ResourceLoaderOptions& options() const { return m_options; }
60     void setOptions(const ResourceLoaderOptions& options) { m_options = options; }
61     const Optional<ResourceLoadPriority>& priority() const { return m_priority; }
62     void setInitiator(PassRefPtr<Element>);
63     void setInitiator(const AtomicString& name);
64     const AtomicString& initiatorName() const;
65     bool allowsCaching() const { return m_options.cachingPolicy == CachingPolicy::AllowCaching; }
66     void setCachingPolicy(CachingPolicy policy) { m_options.cachingPolicy = policy;  }
67
68     void setAsPotentiallyCrossOrigin(const String&, Document&);
69     void updateForAccessControl(Document&);
70
71     void updateReferrerOriginAndUserAgentHeaders(FrameLoader&, ReferrerPolicy);
72     void upgradeInsecureRequestIfNeeded(Document&);
73     void setAcceptHeaderIfNone(CachedResource::Type);
74     void updateAccordingCacheMode();
75     void removeFragmentIdentifierIfNeeded();
76 #if ENABLE(CONTENT_EXTENSIONS)
77     void applyBlockedStatus(const ContentExtensions::BlockedStatus&);
78 #endif
79 #if ENABLE(CACHE_PARTITIONING)
80     void setDomainForCachePartition(Document&);
81 #endif
82
83     void setOrigin(RefPtr<SecurityOrigin>&& origin) { m_origin = WTFMove(origin); }
84     RefPtr<SecurityOrigin> releaseOrigin() { return WTFMove(m_origin); }
85     SecurityOrigin* origin() const { return m_origin.get(); }
86
87     String&& releaseFragmentIdentifier() { return WTFMove(m_fragmentIdentifier); }
88     void clearFragmentIdentifier() { m_fragmentIdentifier = { }; }
89
90     static String splitFragmentIdentifierFromRequestURL(ResourceRequest&);
91
92 private:
93     ResourceRequest m_resourceRequest;
94     String m_charset;
95     ResourceLoaderOptions m_options;
96     Optional<ResourceLoadPriority> m_priority;
97     RefPtr<Element> m_initiatorElement;
98     AtomicString m_initiatorName;
99     RefPtr<SecurityOrigin> m_origin;
100     String m_fragmentIdentifier;
101 };
102
103 void upgradeInsecureResourceRequestIfNeeded(ResourceRequest&, Document&);
104
105 } // namespace WebCore
106
107 #endif