Add to HistoryItem a way to know if its underlying CachedPage has expired.
[WebKit-https.git] / Source / WebCore / history / CachedPage.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008 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 COMPUTER, 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 COMPUTER, 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 "Frame.h"
33 #include "FrameView.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 using namespace JSC;
43
44 namespace WebCore {
45
46 DEFINE_DEBUG_ONLY_GLOBAL(WTF::RefCountedLeakCounter, cachedPageCounter, ("CachedPage"));
47
48 PassRefPtr<CachedPage> CachedPage::create(Page* page)
49 {
50     return adoptRef(new CachedPage(page));
51 }
52
53 CachedPage::CachedPage(Page* page)
54     : m_timeStamp(currentTime())
55     , m_expirationTime(m_timeStamp + page->settings()->backForwardCacheExpirationInterval())
56     , m_cachedMainFrame(CachedFrame::create(page->mainFrame()))
57     , m_needStyleRecalcForVisitedLinks(false)
58     , m_needsFullStyleRecalc(false)
59 {
60 #ifndef NDEBUG
61     cachedPageCounter.increment();
62 #endif
63 }
64
65 CachedPage::~CachedPage()
66 {
67 #ifndef NDEBUG
68     cachedPageCounter.decrement();
69 #endif
70
71     destroy();
72     ASSERT(!m_cachedMainFrame);
73 }
74
75 void CachedPage::restore(Page* page)
76 {
77     ASSERT(m_cachedMainFrame);
78     ASSERT(page && page->mainFrame() && page->mainFrame() == m_cachedMainFrame->view()->frame());
79     ASSERT(!page->subframeCount());
80
81     m_cachedMainFrame->open();
82     
83     // Restore the focus appearance for the focused element.
84     // 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.
85     Document* focusedDocument = page->focusController()->focusedOrMainFrame()->document();
86     if (Node* node = focusedDocument->focusedNode()) {
87         if (node->isElementNode())
88             toElement(node)->updateFocusAppearance(true);
89     }
90
91     if (m_needStyleRecalcForVisitedLinks) {
92         for (Frame* frame = page->mainFrame(); frame; frame = frame->tree()->traverseNext())
93             frame->document()->visitedLinkState()->invalidateStyleForAllLinks();
94     }
95
96     if (m_needsFullStyleRecalc)
97         page->setNeedsRecalcStyleInAllFrames();
98
99     clear();
100 }
101
102 void CachedPage::clear()
103 {
104     ASSERT(m_cachedMainFrame);
105     m_cachedMainFrame->clear();
106     m_cachedMainFrame = 0;
107     m_needStyleRecalcForVisitedLinks = false;
108     m_needsFullStyleRecalc = false;
109 }
110
111 void CachedPage::destroy()
112 {
113     if (m_cachedMainFrame)
114         m_cachedMainFrame->destroy();
115
116     m_cachedMainFrame = 0;
117 }
118
119 bool CachedPage::hasExpired() const
120 {
121     return currentTime() > m_expirationTime;
122 }
123
124 } // namespace WebCore