4d1e2cdd74612f48ccf22f741cf995477c8a56cf
[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 "FloatRect.h"
30 #include "FrameLoaderTypes.h"
31 #include "IntPoint.h"
32 #include "IntRect.h"
33 #include "LengthBox.h"
34 #include "SerializedScriptValue.h"
35 #include <memory>
36 #include <wtf/RefCounted.h>
37 #include <wtf/text/WTFString.h>
38
39 #if PLATFORM(IOS)
40 #include "ViewportArguments.h"
41 #endif
42
43 #if PLATFORM(COCOA)
44 #import <wtf/RetainPtr.h>
45 typedef struct objc_object* id;
46 #endif
47
48 namespace WebCore {
49
50 class CachedPage;
51 class Document;
52 class FormData;
53 class HistoryItem;
54 class Image;
55 class ResourceRequest;
56 class URL;
57 enum class PruningReason;
58
59 WEBCORE_EXPORT extern void (*notifyHistoryItemChanged)(HistoryItem*);
60
61 class HistoryItem : public RefCounted<HistoryItem> {
62     friend class PageCache;
63
64 public: 
65     static Ref<HistoryItem> create() { return adoptRef(*new HistoryItem); }
66     static Ref<HistoryItem> create(const String& urlString, const String& title)
67     {
68         return adoptRef(*new HistoryItem(urlString, title));
69     }
70     static Ref<HistoryItem> create(const String& urlString, const String& title, const String& alternateTitle)
71     {
72         return adoptRef(*new HistoryItem(urlString, title, alternateTitle));
73     }
74     
75     WEBCORE_EXPORT ~HistoryItem();
76
77     WEBCORE_EXPORT Ref<HistoryItem> copy() const;
78
79     // Resets the HistoryItem to its initial state, as returned by create().
80     void reset();
81     
82     WEBCORE_EXPORT const String& originalURLString() const;
83     WEBCORE_EXPORT const String& urlString() const;
84     WEBCORE_EXPORT const String& title() const;
85     
86     bool isInPageCache() const { return m_cachedPage.get(); }
87     WEBCORE_EXPORT bool hasCachedPageExpired() const;
88
89     WEBCORE_EXPORT void setAlternateTitle(const String&);
90     WEBCORE_EXPORT const String& alternateTitle() const;
91     
92     WEBCORE_EXPORT URL url() const;
93     WEBCORE_EXPORT URL originalURL() const;
94     WEBCORE_EXPORT const String& referrer() const;
95     WEBCORE_EXPORT const String& target() const;
96     WEBCORE_EXPORT bool isTargetItem() const;
97     
98     WEBCORE_EXPORT FormData* formData();
99     WEBCORE_EXPORT String formContentType() const;
100     
101     bool lastVisitWasFailure() const { return m_lastVisitWasFailure; }
102
103     WEBCORE_EXPORT const IntPoint& scrollPosition() const;
104     WEBCORE_EXPORT void setScrollPosition(const IntPoint&);
105     void clearScrollPosition();
106
107     WEBCORE_EXPORT bool shouldRestoreScrollPosition() const;
108     WEBCORE_EXPORT void setShouldRestoreScrollPosition(bool);
109     
110     WEBCORE_EXPORT float pageScaleFactor() const;
111     WEBCORE_EXPORT void setPageScaleFactor(float);
112     
113     WEBCORE_EXPORT const Vector<String>& documentState() const;
114     WEBCORE_EXPORT void setDocumentState(const Vector<String>&);
115     void clearDocumentState();
116
117     WEBCORE_EXPORT void setShouldOpenExternalURLsPolicy(ShouldOpenExternalURLsPolicy);
118     WEBCORE_EXPORT ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicy() const;
119
120     void setURL(const URL&);
121     WEBCORE_EXPORT void setURLString(const String&);
122     WEBCORE_EXPORT void setOriginalURLString(const String&);
123     WEBCORE_EXPORT void setReferrer(const String&);
124     WEBCORE_EXPORT void setTarget(const String&);
125     WEBCORE_EXPORT void setTitle(const String&);
126     WEBCORE_EXPORT void setIsTargetItem(bool);
127     
128     WEBCORE_EXPORT void setStateObject(RefPtr<SerializedScriptValue>&&);
129     SerializedScriptValue* stateObject() const { return m_stateObject.get(); }
130
131     void setItemSequenceNumber(long long number) { m_itemSequenceNumber = number; }
132     long long itemSequenceNumber() const { return m_itemSequenceNumber; }
133
134     void setDocumentSequenceNumber(long long number) { m_documentSequenceNumber = number; }
135     long long documentSequenceNumber() const { return m_documentSequenceNumber; }
136
137     void setFormInfoFromRequest(const ResourceRequest&);
138     WEBCORE_EXPORT void setFormData(RefPtr<FormData>&&);
139     WEBCORE_EXPORT void setFormContentType(const String&);
140
141     void setLastVisitWasFailure(bool wasFailure) { m_lastVisitWasFailure = wasFailure; }
142
143     WEBCORE_EXPORT void addChildItem(Ref<HistoryItem>&&);
144     void setChildItem(Ref<HistoryItem>&&);
145     WEBCORE_EXPORT HistoryItem* childItemWithTarget(const String&);
146     HistoryItem* childItemWithDocumentSequenceNumber(long long number);
147     WEBCORE_EXPORT const Vector<Ref<HistoryItem>>& children() const;
148     WEBCORE_EXPORT bool hasChildren() const;
149     void clearChildren();
150     
151     bool shouldDoSameDocumentNavigationTo(HistoryItem& otherItem) const;
152     bool hasSameFrames(HistoryItem& otherItem) const;
153
154     bool isCurrentDocument(Document&) const;
155     
156 #if PLATFORM(COCOA)
157     WEBCORE_EXPORT id viewState() const;
158     WEBCORE_EXPORT void setViewState(id);
159     
160     // Transient properties may be of any ObjC type.  They are intended to be used to store state per back/forward list entry.
161     // The properties will not be persisted; when the history item is removed, the properties will be lost.
162     WEBCORE_EXPORT id getTransientProperty(const String&) const;
163     WEBCORE_EXPORT void setTransientProperty(const String&, id);
164 #endif
165
166 #ifndef NDEBUG
167     int showTree() const;
168     int showTreeWithIndent(unsigned indentLevel) const;
169 #endif
170
171 #if PLATFORM(IOS)
172     FloatRect exposedContentRect() const { return m_exposedContentRect; }
173     void setExposedContentRect(FloatRect exposedContentRect) { m_exposedContentRect = exposedContentRect; }
174
175     IntRect unobscuredContentRect() const { return m_unobscuredContentRect; }
176     void setUnobscuredContentRect(IntRect unobscuredContentRect) { m_unobscuredContentRect = unobscuredContentRect; }
177
178     const FloatBoxExtent& obscuredInsets() const { return m_obscuredInsets; }
179     void setObscuredInsets(const FloatBoxExtent& insets) { m_obscuredInsets = insets; }
180
181     FloatSize minimumLayoutSizeInScrollViewCoordinates() const { return m_minimumLayoutSizeInScrollViewCoordinates; }
182     void setMinimumLayoutSizeInScrollViewCoordinates(FloatSize minimumLayoutSizeInScrollViewCoordinates) { m_minimumLayoutSizeInScrollViewCoordinates = minimumLayoutSizeInScrollViewCoordinates; }
183
184     IntSize contentSize() const { return m_contentSize; }
185     void setContentSize(IntSize contentSize) { m_contentSize = contentSize; }
186
187     float scale() const { return m_scale; }
188     bool scaleIsInitial() const { return m_scaleIsInitial; }
189     void setScaleIsInitial(bool scaleIsInitial) { m_scaleIsInitial = scaleIsInitial; }
190     void setScale(float newScale, bool isInitial)
191     {
192         m_scale = newScale;
193         m_scaleIsInitial = isInitial;
194     }
195
196     const ViewportArguments& viewportArguments() const { return m_viewportArguments; }
197     void setViewportArguments(const ViewportArguments& viewportArguments) { m_viewportArguments = viewportArguments; }
198 #endif
199
200     void notifyChanged();
201
202     void setWasRestoredFromSession(bool wasRestoredFromSession) { m_wasRestoredFromSession = wasRestoredFromSession; }
203     bool wasRestoredFromSession() const { return m_wasRestoredFromSession; }
204
205 private:
206     WEBCORE_EXPORT HistoryItem();
207     WEBCORE_EXPORT HistoryItem(const String& urlString, const String& title);
208     WEBCORE_EXPORT HistoryItem(const String& urlString, const String& title, const String& alternateTitle);
209
210     HistoryItem(const HistoryItem&);
211
212     bool hasSameDocumentTree(HistoryItem& otherItem) const;
213
214     String m_urlString;
215     String m_originalURLString;
216     String m_referrer;
217     String m_target;
218     String m_title;
219     String m_displayTitle;
220     
221     IntPoint m_scrollPosition;
222     float m_pageScaleFactor { 0 }; // 0 indicates "unset".
223     Vector<String> m_documentState;
224
225     ShouldOpenExternalURLsPolicy m_shouldOpenExternalURLsPolicy { ShouldOpenExternalURLsPolicy::ShouldNotAllow };
226     
227     Vector<Ref<HistoryItem>> m_children;
228     
229     bool m_lastVisitWasFailure { false };
230     bool m_isTargetItem { false };
231     bool m_wasRestoredFromSession { false };
232     bool m_shouldRestoreScrollPosition { true };
233
234     // If two HistoryItems have the same item sequence number, then they are
235     // clones of one another.  Traversing history from one such HistoryItem to
236     // another is a no-op.  HistoryItem clones are created for parent and
237     // sibling frames when only a subframe navigates.
238     int64_t m_itemSequenceNumber;
239
240     // If two HistoryItems have the same document sequence number, then they
241     // refer to the same instance of a document.  Traversing history from one
242     // such HistoryItem to another preserves the document.
243     int64_t m_documentSequenceNumber;
244
245     // Support for HTML5 History
246     RefPtr<SerializedScriptValue> m_stateObject;
247     
248     // info used to repost form data
249     RefPtr<FormData> m_formData;
250     String m_formContentType;
251
252     // PageCache controls these fields.
253     std::unique_ptr<CachedPage> m_cachedPage;
254     PruningReason m_pruningReason;
255
256 #if PLATFORM(IOS)
257     FloatRect m_exposedContentRect;
258     IntRect m_unobscuredContentRect;
259     FloatSize m_minimumLayoutSizeInScrollViewCoordinates;
260     IntSize m_contentSize;
261     FloatBoxExtent m_obscuredInsets;
262     float m_scale { 0 }; // Note that UIWebView looks for a non-zero value, so this has to start as 0.
263     bool m_scaleIsInitial { false };
264     ViewportArguments m_viewportArguments;
265 #endif
266
267 #if PLATFORM(COCOA)
268     RetainPtr<id> m_viewState;
269     std::unique_ptr<HashMap<String, RetainPtr<id>>> m_transientProperties;
270 #endif
271 };
272
273 } // namespace WebCore
274
275 #if ENABLE(TREE_DEBUGGING)
276 // Outside the WebCore namespace for ease of invocation from the debugger.
277 extern "C" int showTree(const WebCore::HistoryItem*);
278 #endif