84aa0304d5e2ddc3393c3ce8d8cbe59865eeb17c
[WebKit-https.git] / Source / WebCore / history / CachedPage.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "CachedPage.h"
28
29 #include "Document.h"
30 #include "Element.h"
31 #include "FocusController.h"
32 #include "FrameView.h"
33 #include "MainFrame.h"
34 #include "Node.h"
35 #include "Page.h"
36 #include "Settings.h"
37 #include "VisitedLinkState.h"
38 #include <wtf/CurrentTime.h>
39 #include <wtf/RefCountedLeakCounter.h>
40 #include <wtf/StdLibExtras.h>
41
42 #if PLATFORM(IOS)
43 #include "FrameSelection.h"
44 #endif
45
46 using namespace JSC;
47
48 namespace WebCore {
49
50 DEFINE_DEBUG_ONLY_GLOBAL(WTF::RefCountedLeakCounter, cachedPageCounter, ("CachedPage"));
51
52 CachedPage::CachedPage(Page& page)
53     : m_expirationTime(monotonicallyIncreasingTime() + page.settings().backForwardCacheExpirationInterval())
54     , m_cachedMainFrame(std::make_unique<CachedFrame>(page.mainFrame()))
55     , m_needStyleRecalcForVisitedLinks(false)
56     , m_needsFullStyleRecalc(false)
57 #if ENABLE(VIDEO_TRACK)
58     , m_needsCaptionPreferencesChanged(false)
59 #endif
60     , m_needsDeviceScaleChanged(false)
61 {
62 #ifndef NDEBUG
63     cachedPageCounter.increment();
64 #endif
65 }
66
67 CachedPage::~CachedPage()
68 {
69 #ifndef NDEBUG
70     cachedPageCounter.decrement();
71 #endif
72
73     if (m_cachedMainFrame)
74         m_cachedMainFrame->destroy();
75 }
76
77 void CachedPage::restore(Page& page)
78 {
79     ASSERT(m_cachedMainFrame);
80     ASSERT(m_cachedMainFrame->view()->frame().isMainFrame());
81     ASSERT(!page.subframeCount());
82
83     m_cachedMainFrame->open();
84     
85     // Restore the focus appearance for the focused element.
86     // FIXME: Right now we don't support pages w/ frames in the b/f cache.  This may need to be tweaked when we add support for that.
87     Document* focusedDocument = page.focusController().focusedOrMainFrame().document();
88     if (Element* element = focusedDocument->focusedElement()) {
89 #if PLATFORM(IOS)
90         // We don't want focused nodes changing scroll position when restoring from the cache
91         // as it can cause ugly jumps before we manage to restore the cached position.
92         page.mainFrame().selection().suppressScrolling();
93
94         bool hadProhibitsScrolling = false;
95         FrameView* frameView = page.mainFrame().view();
96         if (frameView) {
97             hadProhibitsScrolling = frameView->prohibitsScrolling();
98             frameView->setProhibitsScrolling(true);
99         }
100 #endif
101         element->updateFocusAppearance(true);
102 #if PLATFORM(IOS)
103         if (frameView)
104             frameView->setProhibitsScrolling(hadProhibitsScrolling);
105         page.mainFrame().selection().restoreScrolling();
106 #endif
107     }
108
109     if (m_needStyleRecalcForVisitedLinks) {
110         for (Frame* frame = &page.mainFrame(); frame; frame = frame->tree().traverseNext())
111             frame->document()->visitedLinkState().invalidateStyleForAllLinks();
112     }
113
114     if (m_needsDeviceScaleChanged)
115         page.mainFrame().deviceOrPageScaleFactorChanged();
116
117     if (m_needsFullStyleRecalc)
118         page.setNeedsRecalcStyleInAllFrames();
119
120 #if ENABLE(VIDEO_TRACK)
121     if (m_needsCaptionPreferencesChanged)
122         page.captionPreferencesChanged();
123 #endif
124
125     clear();
126 }
127
128 void CachedPage::clear()
129 {
130     ASSERT(m_cachedMainFrame);
131     m_cachedMainFrame->clear();
132     m_cachedMainFrame = nullptr;
133     m_needStyleRecalcForVisitedLinks = false;
134     m_needsFullStyleRecalc = false;
135 #if ENABLE(VIDEO_TRACK)
136     m_needsCaptionPreferencesChanged = false;
137 #endif
138     m_needsDeviceScaleChanged = false;
139 }
140
141 bool CachedPage::hasExpired() const
142 {
143     return monotonicallyIncreasingTime() > m_expirationTime;
144 }
145
146 } // namespace WebCore