1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/*
* Copyright (C) 1999 Lars Knoll (knoll@kde.org)
* (C) 1999 Antti Koivisto (koivisto@kde.org)
* (C) 2001 Dirk Mueller (mueller@kde.org)
* (C) 2006 Alexey Proskuryakov (ap@webkit.org)
* Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012 Apple Inc. All
* rights reserved.
* Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved.
* (http://www.torchmobile.com/)
* Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
* Copyright (C) 2013 Google Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_DOM_DOCUMENT_INIT_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_DOM_DOCUMENT_INIT_H_
#include "base/dcheck_is_on.h"
#include "base/uuid.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "third_party/blink/public/common/tokens/tokens.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/execution_context/security_context.h"
#include "third_party/blink/renderer/platform/graphics/color.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/weborigin/kurl.h"
namespace blink {
class Agent;
class Document;
class ExecutionContext;
class LocalDOMWindow;
class LocalFrame;
class PluginData;
class CORE_EXPORT DocumentInit final {
STACK_ALLOCATED();
public:
// Create a DocumentInit instance, then add a chain of calls to add optional
// parameters to it.
//
// Example:
//
// DocumentInit init = DocumentInit::Create()
// .WithExecutionContext(context)
// .WithURL(url);
//
// Before creating a Document from this DocumentInit, the caller must invoke
// exactly one of:
// * ForTest() - for unit-test-only cases
// * WithWindow() - for navigations originating from DocumentLoader and
// attaching to a LocalDOMWindow.
// * WithExecutionContext() - for all other cases
//
// Invoking init.CreateDocument() will construct a Document of the appropriate
// subclass for the init's Type.
// However, when the document type is known, it is acceptable to invoke the
// constructor for Document (or the appropriate subclass) directly:
// Document* document = MakeGarbageCollected<Document>(init);
static DocumentInit Create();
DocumentInit(const DocumentInit&);
~DocumentInit();
enum class Type {
kHTML,
kXHTML,
kImage,
kPlugin,
kMedia,
kSVG,
kXML,
kViewSource,
kText,
kUnspecified
};
DocumentInit& ForTest(ExecutionContext& execution_context);
// Actually constructs the Document based on the provided state.
Document* CreateDocument() const;
bool IsSrcdocDocument() const;
bool IsAboutBlankDocument() const;
const KURL& FallbackBaseURL() const;
bool ShouldSetURL() const;
DocumentInit& WithWindow(LocalDOMWindow*, Document* owner_document);
LocalDOMWindow* GetWindow() const { return window_; }
DocumentInit& WithToken(const DocumentToken& token);
const std::optional<DocumentToken>& GetToken() const;
DocumentInit& WithAgent(Agent& agent);
Agent& GetAgent() const;
DocumentInit& ForInitialEmptyDocument(bool empty);
bool IsInitialEmptyDocument() const { return is_initial_empty_document_; }
DocumentInit& ForPrerendering(bool is_prerendering);
bool IsPrerendering() const { return is_prerendering_; }
// Compute the type of document to be loaded inside a `frame`, given its
// `mime_type`.
//
// In case of plugin handled by MimeHandlerview (which do not create a
// PluginDocument), the type is Type::KHTML and `is_for_external_handler` is
// set to true.
static Type ComputeDocumentType(LocalFrame* frame,
const String& mime_type,
bool* is_for_external_handler = nullptr);
DocumentInit& WithTypeFrom(const String& mime_type);
Type GetType() const { return type_; }
const String& GetMimeType() const { return mime_type_; }
bool IsForExternalHandler() const { return is_for_external_handler_; }
// Used when creating Documents not attached to a window.
DocumentInit& WithExecutionContext(ExecutionContext*);
ExecutionContext* GetExecutionContext() const { return execution_context_; }
DocumentInit& WithURL(const KURL&);
const KURL& Url() const { return url_; }
const KURL& GetCookieUrl() const;
DocumentInit& WithSrcdocDocument(bool is_srcdoc_document);
DocumentInit& WithFallbackBaseURL(const KURL& fallback_base_url);
DocumentInit& WithJavascriptURL(bool is_for_javascript_url);
DocumentInit& ForDiscard(bool is_for_discard);
bool IsForDiscard() const;
DocumentInit& WithUkmSourceId(ukm::SourceId ukm_source_id);
ukm::SourceId UkmSourceId() const { return ukm_source_id_; }
DocumentInit& WithBaseAuctionNonce(base::Uuid base_auction_nonce);
base::Uuid BaseAuctionNonce() const { return base_auction_nonce_; }
private:
DocumentInit() = default;
static PluginData* GetPluginData(LocalFrame* frame);
Type type_ = Type::kUnspecified;
bool is_prerendering_ = false;
bool is_initial_empty_document_ = false;
String mime_type_;
LocalDOMWindow* window_ = nullptr;
std::optional<DocumentToken> token_;
ExecutionContext* execution_context_ = nullptr;
KURL url_;
Document* owner_document_ = nullptr;
Agent* agent_ = nullptr;
// Whether we should treat the new document as "srcdoc" document. This
// affects security checks, since srcdoc's content comes directly from
// the parent document, not from loading a URL.
bool is_srcdoc_document_ = false;
KURL fallback_base_url_;
// True when the commit reason for this DocumentInit was a javascript: url.
bool is_for_javascript_url_ = false;
// True when the commit reason for this DocumentInit was a discard operation.
bool is_for_discard_ = false;
// Source id to set on the Document to be created.
ukm::SourceId ukm_source_id_ = ukm::kInvalidSourceId;
// Seed for all PAAPI Auction Nonces generated for this document.
base::Uuid base_auction_nonce_;
bool is_for_external_handler_ = false;
#if DCHECK_IS_ON()
bool for_test_ = false;
#endif
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_CORE_DOM_DOCUMENT_INIT_H_
|
