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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
|
/*
* Copyright (C) 2006, 2008, 2011 Apple Inc. All rights reserved.
* Copyright (C) 2012 Research In Motion Limited. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef HistoryItem_h
#define HistoryItem_h
#include "IntPoint.h"
#include "SerializedScriptValue.h"
#include <wtf/OwnPtr.h>
#include <wtf/PassOwnPtr.h>
#include <wtf/RefCounted.h>
#include <wtf/text/WTFString.h>
#if PLATFORM(MAC)
#import <wtf/RetainPtr.h>
typedef struct objc_object* id;
#endif
#if PLATFORM(QT)
#include <QVariant>
#include <QByteArray>
#include <QDataStream>
#endif
#if PLATFORM(BLACKBERRY)
#include "HistoryItemViewState.h"
#endif
namespace WebCore {
class CachedPage;
class Document;
class FormData;
class HistoryItem;
class Image;
class KURL;
class ResourceRequest;
typedef Vector<RefPtr<HistoryItem> > HistoryItemVector;
extern void (*notifyHistoryItemChanged)(HistoryItem*);
enum VisitCountBehavior {
IncreaseVisitCount,
DoNotIncreaseVisitCount
};
class HistoryItem : public RefCounted<HistoryItem> {
friend class PageCache;
public:
static PassRefPtr<HistoryItem> create() { return adoptRef(new HistoryItem); }
static PassRefPtr<HistoryItem> create(const String& urlString, const String& title, double lastVisited)
{
return adoptRef(new HistoryItem(urlString, title, lastVisited));
}
static PassRefPtr<HistoryItem> create(const String& urlString, const String& title, const String& alternateTitle, double lastVisited)
{
return adoptRef(new HistoryItem(urlString, title, alternateTitle, lastVisited));
}
static PassRefPtr<HistoryItem> create(const KURL& url, const String& target, const String& parent, const String& title)
{
return adoptRef(new HistoryItem(url, target, parent, title));
}
~HistoryItem();
PassRefPtr<HistoryItem> copy() const;
// Resets the HistoryItem to its initial state, as returned by create().
void reset();
void encodeBackForwardTree(Encoder&) const;
static PassRefPtr<HistoryItem> decodeBackForwardTree(const String& urlString, const String& title, const String& originalURLString, Decoder&);
const String& originalURLString() const;
const String& urlString() const;
const String& title() const;
bool isInPageCache() const { return m_cachedPage; }
bool hasCachedPageExpired() const;
double lastVisitedTime() const;
void setAlternateTitle(const String& alternateTitle);
const String& alternateTitle() const;
const String& parent() const;
KURL url() const;
KURL originalURL() const;
const String& referrer() const;
const String& target() const;
bool isTargetItem() const;
FormData* formData();
String formContentType() const;
int visitCount() const;
bool lastVisitWasFailure() const { return m_lastVisitWasFailure; }
bool lastVisitWasHTTPNonGet() const { return m_lastVisitWasHTTPNonGet; }
void mergeAutoCompleteHints(HistoryItem* otherItem);
const IntPoint& scrollPoint() const;
void setScrollPoint(const IntPoint&);
void clearScrollPoint();
float pageScaleFactor() const;
void setPageScaleFactor(float);
const Vector<String>& documentState() const;
void setDocumentState(const Vector<String>&);
void clearDocumentState();
void setURL(const KURL&);
void setURLString(const String&);
void setOriginalURLString(const String&);
void setReferrer(const String&);
void setTarget(const String&);
void setParent(const String&);
void setTitle(const String&);
void setIsTargetItem(bool);
void setStateObject(PassRefPtr<SerializedScriptValue> object);
PassRefPtr<SerializedScriptValue> stateObject() const { return m_stateObject; }
void setItemSequenceNumber(long long number) { m_itemSequenceNumber = number; }
long long itemSequenceNumber() const { return m_itemSequenceNumber; }
void setDocumentSequenceNumber(long long number) { m_documentSequenceNumber = number; }
long long documentSequenceNumber() const { return m_documentSequenceNumber; }
void setFormInfoFromRequest(const ResourceRequest&);
void setFormData(PassRefPtr<FormData>);
void setFormContentType(const String&);
void recordInitialVisit();
void setVisitCount(int);
void setLastVisitWasFailure(bool wasFailure) { m_lastVisitWasFailure = wasFailure; }
void setLastVisitWasHTTPNonGet(bool wasNotGet) { m_lastVisitWasHTTPNonGet = wasNotGet; }
void addChildItem(PassRefPtr<HistoryItem>);
void setChildItem(PassRefPtr<HistoryItem>);
HistoryItem* childItemWithTarget(const String&) const;
HistoryItem* childItemWithDocumentSequenceNumber(long long number) const;
HistoryItem* targetItem();
const HistoryItemVector& children() const;
bool hasChildren() const;
void clearChildren();
bool isAncestorOf(const HistoryItem*) const;
bool shouldDoSameDocumentNavigationTo(HistoryItem* otherItem) const;
bool hasSameFrames(HistoryItem* otherItem) const;
// This should not be called directly for HistoryItems that are already included
// in GlobalHistory. The WebKit api for this is to use -[WebHistory setLastVisitedTimeInterval:forItem:] instead.
void setLastVisitedTime(double);
void visited(const String& title, double time, VisitCountBehavior);
void addRedirectURL(const String&);
Vector<String>* redirectURLs() const;
void setRedirectURLs(PassOwnPtr<Vector<String> >);
bool isCurrentDocument(Document*) const;
#if PLATFORM(MAC)
id viewState() const;
void setViewState(id);
// Transient properties may be of any ObjC type. They are intended to be used to store state per back/forward list entry.
// The properties will not be persisted; when the history item is removed, the properties will be lost.
id getTransientProperty(const String&) const;
void setTransientProperty(const String&, id);
#endif
#if PLATFORM(QT)
QVariant userData() const { return m_userData; }
void setUserData(const QVariant& userData) { m_userData = userData; }
static PassRefPtr<HistoryItem> restoreState(QDataStream& buffer, int version);
QDataStream& saveState(QDataStream& out, int version) const;
#endif
#if PLATFORM(BLACKBERRY)
HistoryItemViewState& viewState() { return m_viewState; }
#endif
#ifndef NDEBUG
int showTree() const;
int showTreeWithIndent(unsigned indentLevel) const;
#endif
void adoptVisitCounts(Vector<int>& dailyCounts, Vector<int>& weeklyCounts);
const Vector<int>& dailyVisitCounts() const { return m_dailyVisitCounts; }
const Vector<int>& weeklyVisitCounts() const { return m_weeklyVisitCounts; }
private:
HistoryItem();
HistoryItem(const String& urlString, const String& title, double lastVisited);
HistoryItem(const String& urlString, const String& title, const String& alternateTitle, double lastVisited);
HistoryItem(const KURL& url, const String& frameName, const String& parent, const String& title);
explicit HistoryItem(const HistoryItem&);
void padDailyCountsForNewVisit(double time);
void collapseDailyVisitsToWeekly();
void recordVisitAtTime(double, VisitCountBehavior = IncreaseVisitCount);
bool hasSameDocumentTree(HistoryItem* otherItem) const;
HistoryItem* findTargetItem();
void encodeBackForwardTreeNode(Encoder&) const;
/* When adding new member variables to this class, please notify the Qt team.
* qt/HistoryItemQt.cpp contains code to serialize history items.
*/
String m_urlString;
String m_originalURLString;
String m_referrer;
String m_target;
String m_parent;
String m_title;
String m_displayTitle;
double m_lastVisitedTime;
bool m_lastVisitWasHTTPNonGet;
IntPoint m_scrollPoint;
float m_pageScaleFactor;
Vector<String> m_documentState;
HistoryItemVector m_children;
bool m_lastVisitWasFailure;
bool m_isTargetItem;
int m_visitCount;
Vector<int> m_dailyVisitCounts;
Vector<int> m_weeklyVisitCounts;
OwnPtr<Vector<String> > m_redirectURLs;
// If two HistoryItems have the same item sequence number, then they are
// clones of one another. Traversing history from one such HistoryItem to
// another is a no-op. HistoryItem clones are created for parent and
// sibling frames when only a subframe navigates.
int64_t m_itemSequenceNumber;
// If two HistoryItems have the same document sequence number, then they
// refer to the same instance of a document. Traversing history from one
// such HistoryItem to another preserves the document.
int64_t m_documentSequenceNumber;
// Support for HTML5 History
RefPtr<SerializedScriptValue> m_stateObject;
// info used to repost form data
RefPtr<FormData> m_formData;
String m_formContentType;
// PageCache controls these fields.
HistoryItem* m_next;
HistoryItem* m_prev;
RefPtr<CachedPage> m_cachedPage;
#if PLATFORM(MAC)
RetainPtr<id> m_viewState;
OwnPtr<HashMap<String, RetainPtr<id> > > m_transientProperties;
#endif
#if PLATFORM(QT)
QVariant m_userData;
#endif
#if PLATFORM(BLACKBERRY)
HistoryItemViewState m_viewState;
#endif
}; //class HistoryItem
} //namespace WebCore
#ifndef NDEBUG
// Outside the WebCore namespace for ease of invocation from gdb.
extern "C" int showTree(const WebCore::HistoryItem*);
#endif
#endif // HISTORYITEM_H
|