1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
3  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
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  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef HistoryController_h
31 #define HistoryController_h
32 
33 #include "FrameLoaderTypes.h"
34 #include "PlatformString.h"
35 #include <wtf/Noncopyable.h>
36 #include <wtf/RefPtr.h>
37 
38 namespace WebCore {
39 
40 class Frame;
41 class HistoryItem;
42 class SerializedScriptValue;
43 class StringWithDirection;
44 
45 class HistoryController {
46     WTF_MAKE_NONCOPYABLE(HistoryController);
47 public:
48     enum HistoryUpdateType { UpdateAll, UpdateAllExceptBackForwardList };
49 
50     HistoryController(Frame*);
51     ~HistoryController();
52 
53     void saveScrollPositionAndViewStateToItem(HistoryItem*);
54     void restoreScrollPositionAndViewState();
55 
56     void updateBackForwardListForFragmentScroll();
57 
58     void saveDocumentState();
59     void saveDocumentAndScrollState();
60     void restoreDocumentState();
61 
62     void invalidateCurrentItemCachedPage();
63 
64     void updateForBackForwardNavigation();
65     void updateForReload();
66     void updateForStandardLoad(HistoryUpdateType updateType = UpdateAll);
67     void updateForRedirectWithLockedBackForwardList();
68     void updateForClientRedirect();
69     void updateForCommit();
70     void updateForSameDocumentNavigation();
71     void updateForFrameLoadCompleted();
72 
currentItem()73     HistoryItem* currentItem() const { return m_currentItem.get(); }
74     void setCurrentItem(HistoryItem*);
75     void setCurrentItemTitle(const StringWithDirection&);
76     bool currentItemShouldBeReplaced() const;
77 
previousItem()78     HistoryItem* previousItem() const { return m_previousItem.get(); }
79 
provisionalItem()80     HistoryItem* provisionalItem() const { return m_provisionalItem.get(); }
81     void setProvisionalItem(HistoryItem*);
82 
83     void pushState(PassRefPtr<SerializedScriptValue>, const String& title, const String& url);
84     void replaceState(PassRefPtr<SerializedScriptValue>, const String& title, const String& url);
85 
86 private:
87     friend class Page;
88     bool shouldStopLoadingForHistoryItem(HistoryItem*) const;
89     void goToItem(HistoryItem*, FrameLoadType);
90 
91     void initializeItem(HistoryItem*);
92     PassRefPtr<HistoryItem> createItem();
93     PassRefPtr<HistoryItem> createItemTree(Frame* targetFrame, bool clipAtTarget);
94 
95     void recursiveSetProvisionalItem(HistoryItem*, HistoryItem*, FrameLoadType);
96     void recursiveGoToItem(HistoryItem*, HistoryItem*, FrameLoadType);
97     bool isReplaceLoadTypeWithProvisionalItem(FrameLoadType);
98     void recursiveUpdateForCommit();
99     void recursiveUpdateForSameDocumentNavigation();
100     bool itemsAreClones(HistoryItem*, HistoryItem*) const;
101     bool currentFramesMatchItem(HistoryItem*) const;
102     void updateBackForwardListClippedAtTarget(bool doClip);
103     void updateCurrentItem();
104 
105     Frame* m_frame;
106 
107     RefPtr<HistoryItem> m_currentItem;
108     RefPtr<HistoryItem> m_previousItem;
109     RefPtr<HistoryItem> m_provisionalItem;
110 
111     bool m_frameLoadComplete;
112 };
113 
114 } // namespace WebCore
115 
116 #endif // HistoryController_h
117