Add globally-unique HistoryItem identifiers (and have WebKit2 adopt them).
[WebKit-https.git] / Source / WebCore / history / HistoryItem.h
1 /*
2  * Copyright (C) 2006, 2008, 2011, 2014 Apple Inc. All rights reserved.
3  * Copyright (C) 2012 Research In Motion Limited. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #pragma once
28
29 #include "BackForwardItemIdentifier.h"
30 #include "FloatRect.h"
31 #include "FrameLoaderTypes.h"
32 #include "IntPoint.h"
33 #include "IntRect.h"
34 #include "LengthBox.h"
35 #include "SerializedScriptValue.h"
36 #include <memory>
37 #include <wtf/RefCounted.h>
38 #include <wtf/text/WTFString.h>
39
40 #if PLATFORM(IOS)
41 #include "ViewportArguments.h"
42 #endif
43
44 #if PLATFORM(COCOA)
45 #import <wtf/RetainPtr.h>
46 typedef struct objc_object* id;
47 #endif
48
49 namespace WebCore {
50
51 class CachedPage;
52 class Document;
53 class FormData;
54 class HistoryItem;
55 class Image;
56 class ResourceRequest;
57 class URL;
58 enum class PruningReason;
59
60 WEBCORE_EXPORT extern void (*notifyHistoryItemChanged)(HistoryItem*);
61
62 class HistoryItem : public RefCounted<HistoryItem> {
63     friend class PageCache;
64
65 public: 
66     static Ref<HistoryItem> create()
67     {
68         return adoptRef(*new HistoryItem);
69     }
70
71     static Ref<HistoryItem> create(const String& urlString, const String& title)
72     {
73         return adoptRef(*new HistoryItem(urlString, title));
74     }
75
76     static Ref<HistoryItem> create(const String& urlString, const String& title, const String& alternateTitle)
77     {
78         return adoptRef(*new HistoryItem(urlString, title, alternateTitle));
79     }
80
81     static Ref<HistoryItem> create(const String& urlString, const String& title, const String& alternateTitle, BackForwardItemIdentifier identifier)
82     {
83         return adoptRef(*new HistoryItem(urlString, title, alternateTitle, identifier));
84     }
85     
86     WEBCORE_EXPORT ~HistoryItem();
87
88     WEBCORE_EXPORT Ref<HistoryItem> copy() const;
89
90     const BackForwardItemIdentifier& identifier() const { return m_identifier; }
91
92     // Resets the HistoryItem to its initial state, as returned by create().
93     void reset();
94     
95     WEBCORE_EXPORT const String& originalURLString() const;
96     WEBCORE_EXPORT const String& urlString() const;
97     WEBCORE_EXPORT const String& title() const;
98     
99     bool isInPageCache() const { return m_cachedPage.get(); }
100     WEBCORE_EXPORT bool hasCachedPageExpired() const;
101
102     WEBCORE_EXPORT void setAlternateTitle(const String&);
103     WEBCORE_EXPORT const String& alternateTitle() const;
104     
105     WEBCORE_EXPORT URL url() const;
106     WEBCORE_EXPORT URL originalURL() const;
107     WEBCORE_EXPORT const String& referrer() const;
108     WEBCORE_EXPORT const String& target() const;
109     WEBCORE_EXPORT bool isTargetItem() const;
110     
111     WEBCORE_EXPORT FormData* formData();
112     WEBCORE_EXPORT String formContentType() const;
113     
114     bool lastVisitWasFailure() const { return m_lastVisitWasFailure; }
115
116     WEBCORE_EXPORT const IntPoint& scrollPosition() const;
117     WEBCORE_EXPORT void setScrollPosition(const IntPoint&);
118     void clearScrollPosition();
119
120     WEBCORE_EXPORT bool shouldRestoreScrollPosition() const;
121     WEBCORE_EXPORT void setShouldRestoreScrollPosition(bool);
122     
123     WEBCORE_EXPORT float pageScaleFactor() const;
124     WEBCORE_EXPORT void setPageScaleFactor(float);
125     
126     WEBCORE_EXPORT const Vector<String>& documentState() const;
127     WEBCORE_EXPORT void setDocumentState(const Vector<String>&);
128     void clearDocumentState();
129
130     WEBCORE_EXPORT void setShouldOpenExternalURLsPolicy(ShouldOpenExternalURLsPolicy);
131     WEBCORE_EXPORT ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicy() const;
132
133     void setURL(const URL&);
134     WEBCORE_EXPORT void setURLString(const String&);
135     WEBCORE_EXPORT void setOriginalURLString(const String&);
136     WEBCORE_EXPORT void setReferrer(const String&);
137     WEBCORE_EXPORT void setTarget(const String&);
138     WEBCORE_EXPORT void setTitle(const String&);
139     WEBCORE_EXPORT void setIsTargetItem(bool);
140     
141     WEBCORE_EXPORT void setStateObject(RefPtr<SerializedScriptValue>&&);
142     SerializedScriptValue* stateObject() const { return m_stateObject.get(); }
143
144     void setItemSequenceNumber(long long number) { m_itemSequenceNumber = number; }
145     long long itemSequenceNumber() const { return m_itemSequenceNumber; }
146
147     void setDocumentSequenceNumber(long long number) { m_documentSequenceNumber = number; }
148     long long documentSequenceNumber() const { return m_documentSequenceNumber; }
149
150     void setFormInfoFromRequest(const ResourceRequest&);
151     WEBCORE_EXPORT void setFormData(RefPtr<FormData>&&);
152     WEBCORE_EXPORT void setFormContentType(const String&);
153
154     void setLastVisitWasFailure(bool wasFailure) { m_lastVisitWasFailure = wasFailure; }
155
156     WEBCORE_EXPORT void addChildItem(Ref<HistoryItem>&&);
157     void setChildItem(Ref<HistoryItem>&&);
158     WEBCORE_EXPORT HistoryItem* childItemWithTarget(const String&);
159     HistoryItem* childItemWithDocumentSequenceNumber(long long number);
160     WEBCORE_EXPORT const Vector<Ref<HistoryItem>>& children() const;
161     WEBCORE_EXPORT bool hasChildren() const;
162     void clearChildren();
163     
164     bool shouldDoSameDocumentNavigationTo(HistoryItem& otherItem) const;
165     bool hasSameFrames(HistoryItem& otherItem) const;
166
167     bool isCurrentDocument(Document&) const;
168     
169 #if PLATFORM(COCOA)
170     WEBCORE_EXPORT id viewState() const;
171     WEBCORE_EXPORT void setViewState(id);
172     
173     // Transient properties may be of any ObjC type.  They are intended to be used to store state per back/forward list entry.
174     // The properties will not be persisted; when the history item is removed, the properties will be lost.
175     WEBCORE_EXPORT id getTransientProperty(const String&) const;
176     WEBCORE_EXPORT void setTransientProperty(const String&, id);
177 #endif
178
179 #ifndef NDEBUG
180     int showTree() const;
181     int showTreeWithIndent(unsigned indentLevel) const;
182 #endif
183
184 #if PLATFORM(IOS)
185     FloatRect exposedContentRect() const { return m_exposedContentRect; }
186     void setExposedContentRect(FloatRect exposedContentRect) { m_exposedContentRect = exposedContentRect; }
187
188     IntRect unobscuredContentRect() const { return m_unobscuredContentRect; }
189     void setUnobscuredContentRect(IntRect unobscuredContentRect) { m_unobscuredContentRect = unobscuredContentRect; }
190
191     const FloatBoxExtent& obscuredInsets() const { return m_obscuredInsets; }
192     void setObscuredInsets(const FloatBoxExtent& insets) { m_obscuredInsets = insets; }
193
194     FloatSize minimumLayoutSizeInScrollViewCoordinates() const { return m_minimumLayoutSizeInScrollViewCoordinates; }
195     void setMinimumLayoutSizeInScrollViewCoordinates(FloatSize minimumLayoutSizeInScrollViewCoordinates) { m_minimumLayoutSizeInScrollViewCoordinates = minimumLayoutSizeInScrollViewCoordinates; }
196
197     IntSize contentSize() const { return m_contentSize; }
198     void setContentSize(IntSize contentSize) { m_contentSize = contentSize; }
199
200     float scale() const { return m_scale; }
201     bool scaleIsInitial() const { return m_scaleIsInitial; }
202     void setScaleIsInitial(bool scaleIsInitial) { m_scaleIsInitial = scaleIsInitial; }
203     void setScale(float newScale, bool isInitial)
204     {
205         m_scale = newScale;
206         m_scaleIsInitial = isInitial;
207     }
208
209     const ViewportArguments& viewportArguments() const { return m_viewportArguments; }
210     void setViewportArguments(const ViewportArguments& viewportArguments) { m_viewportArguments = viewportArguments; }
211 #endif
212
213     void notifyChanged();
214
215     void setWasRestoredFromSession(bool wasRestoredFromSession) { m_wasRestoredFromSession = wasRestoredFromSession; }
216     bool wasRestoredFromSession() const { return m_wasRestoredFromSession; }
217
218 private:
219     WEBCORE_EXPORT HistoryItem();
220     WEBCORE_EXPORT HistoryItem(const String& urlString, const String& title);
221     WEBCORE_EXPORT HistoryItem(const String& urlString, const String& title, const String& alternateTitle);
222     WEBCORE_EXPORT HistoryItem(const String& urlString, const String& title, const String& alternateTitle, BackForwardItemIdentifier);
223
224     HistoryItem(const HistoryItem&);
225
226     static int64_t generateSequenceNumber();
227
228     bool hasSameDocumentTree(HistoryItem& otherItem) const;
229
230     String m_urlString;
231     String m_originalURLString;
232     String m_referrer;
233     String m_target;
234     String m_title;
235     String m_displayTitle;
236     
237     IntPoint m_scrollPosition;
238     float m_pageScaleFactor { 0 }; // 0 indicates "unset".
239     Vector<String> m_documentState;
240
241     ShouldOpenExternalURLsPolicy m_shouldOpenExternalURLsPolicy { ShouldOpenExternalURLsPolicy::ShouldNotAllow };
242     
243     Vector<Ref<HistoryItem>> m_children;
244     
245     bool m_lastVisitWasFailure { false };
246     bool m_isTargetItem { false };
247     bool m_wasRestoredFromSession { false };
248     bool m_shouldRestoreScrollPosition { true };
249
250     // If two HistoryItems have the same item sequence number, then they are
251     // clones of one another.  Traversing history from one such HistoryItem to
252     // another is a no-op.  HistoryItem clones are created for parent and
253     // sibling frames when only a subframe navigates.
254     int64_t m_itemSequenceNumber { generateSequenceNumber() };
255
256     // If two HistoryItems have the same document sequence number, then they
257     // refer to the same instance of a document.  Traversing history from one
258     // such HistoryItem to another preserves the document.
259     int64_t m_documentSequenceNumber { generateSequenceNumber() };
260
261     // Support for HTML5 History
262     RefPtr<SerializedScriptValue> m_stateObject;
263     
264     // info used to repost form data
265     RefPtr<FormData> m_formData;
266     String m_formContentType;
267
268     // PageCache controls these fields.
269     std::unique_ptr<CachedPage> m_cachedPage;
270     PruningReason m_pruningReason;
271
272 #if PLATFORM(IOS)
273     FloatRect m_exposedContentRect;
274     IntRect m_unobscuredContentRect;
275     FloatSize m_minimumLayoutSizeInScrollViewCoordinates;
276     IntSize m_contentSize;
277     FloatBoxExtent m_obscuredInsets;
278     float m_scale { 0 }; // Note that UIWebView looks for a non-zero value, so this has to start as 0.
279     bool m_scaleIsInitial { false };
280     ViewportArguments m_viewportArguments;
281 #endif
282
283 #if PLATFORM(COCOA)
284     RetainPtr<id> m_viewState;
285     std::unique_ptr<HashMap<String, RetainPtr<id>>> m_transientProperties;
286 #endif
287
288     BackForwardItemIdentifier m_identifier;
289 };
290
291 } // namespace WebCore
292
293 #if ENABLE(TREE_DEBUGGING)
294 // Outside the WebCore namespace for ease of invocation from the debugger.
295 extern "C" int showTree(const WebCore::HistoryItem*);
296 #endif