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