Add globally-unique HistoryItem identifiers (and have WebKit2 adopt them).
[WebKit-https.git] / Source / WebKit / WebProcess / WebPage / WebBackForwardListProxy.cpp
1 /*
2  * Copyright (C) 2010, 2011 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "WebBackForwardListProxy.h"
28
29 #include "SessionState.h"
30 #include "SessionStateConversion.h"
31 #include "WebCoreArgumentCoders.h"
32 #include "WebPage.h"
33 #include "WebPageProxyMessages.h"
34 #include "WebProcess.h"
35 #include "WebProcessProxyMessages.h"
36 #include <WebCore/Frame.h>
37 #include <WebCore/HistoryController.h>
38 #include <WebCore/HistoryItem.h>
39 #include <WebCore/PageCache.h>
40 #include <wtf/HashMap.h>
41 #include <wtf/NeverDestroyed.h>
42
43 using namespace WebCore;
44
45 namespace WebKit {
46
47 // FIXME <rdar://problem/8819268>: This leaks all HistoryItems that go into these maps.
48 // We need to clear up the life time of these objects.
49
50 typedef HashMap<BackForwardItemIdentifier, RefPtr<HistoryItem>> IDToHistoryItemMap; // "ID" here is the item ID.
51 static IDToHistoryItemMap& idToHistoryItemMap()
52 {
53     static NeverDestroyed<IDToHistoryItemMap> map;
54     return map;
55 }
56
57 void WebBackForwardListProxy::addItemFromUIProcess(const BackForwardItemIdentifier& itemID, Ref<HistoryItem>&& item, uint64_t pageID)
58 {
59     // This item/itemID pair should not already exist in our map.
60     ASSERT(!idToHistoryItemMap().contains(itemID));
61
62     idToHistoryItemMap().set(itemID, item.ptr());
63 }
64
65 static void WK2NotifyHistoryItemChanged(HistoryItem* item)
66 {
67     WebProcess::singleton().parentProcessConnection()->send(Messages::WebProcessProxy::UpdateBackForwardItem(toBackForwardListItemState(*item)), 0);
68 }
69
70 HistoryItem* WebBackForwardListProxy::itemForID(const BackForwardItemIdentifier& itemID)
71 {
72     return idToHistoryItemMap().get(itemID);
73 }
74
75 void WebBackForwardListProxy::removeItem(const BackForwardItemIdentifier& itemID)
76 {
77     RefPtr<HistoryItem> item = idToHistoryItemMap().take(itemID);
78     if (!item)
79         return;
80         
81     PageCache::singleton().remove(*item);
82     WebCore::Page::clearPreviousItemFromAllPages(item.get());
83 }
84
85 WebBackForwardListProxy::WebBackForwardListProxy(WebPage* page)
86     : m_page(page)
87 {
88     WebCore::notifyHistoryItemChanged = WK2NotifyHistoryItemChanged;
89 }
90
91 void WebBackForwardListProxy::addItem(Ref<HistoryItem>&& item)
92 {
93     if (!m_page)
94         return;
95
96     auto result = idToHistoryItemMap().add(item->identifier(), item.ptr());
97     ASSERT_UNUSED(result, result.isNewEntry);
98
99     m_page->send(Messages::WebPageProxy::BackForwardAddItem(toBackForwardListItemState(item.get())));
100 }
101
102 void WebBackForwardListProxy::goToItem(HistoryItem* item)
103 {
104     if (!m_page)
105         return;
106
107     SandboxExtension::Handle sandboxExtensionHandle;
108     m_page->sendSync(Messages::WebPageProxy::BackForwardGoToItem(item->identifier()), Messages::WebPageProxy::BackForwardGoToItem::Reply(sandboxExtensionHandle));
109     m_page->sandboxExtensionTracker().beginLoad(m_page->mainWebFrame(), WTFMove(sandboxExtensionHandle));
110 }
111
112 HistoryItem* WebBackForwardListProxy::itemAtIndex(int itemIndex)
113 {
114     if (!m_page)
115         return nullptr;
116
117     std::optional<BackForwardItemIdentifier> itemID;
118     if (!WebProcess::singleton().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardItemAtIndex(itemIndex), Messages::WebPageProxy::BackForwardItemAtIndex::Reply(itemID), m_page->pageID()))
119         return nullptr;
120
121     if (!itemID)
122         return nullptr;
123
124     return idToHistoryItemMap().get(*itemID);
125 }
126
127 int WebBackForwardListProxy::backListCount()
128 {
129     if (!m_page)
130         return 0;
131
132     int backListCount = 0;
133     if (!WebProcess::singleton().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardBackListCount(), Messages::WebPageProxy::BackForwardBackListCount::Reply(backListCount), m_page->pageID()))
134         return 0;
135
136     return backListCount;
137 }
138
139 int WebBackForwardListProxy::forwardListCount()
140 {
141     if (!m_page)
142         return 0;
143
144     int forwardListCount = 0;
145     if (!WebProcess::singleton().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardForwardListCount(), Messages::WebPageProxy::BackForwardForwardListCount::Reply(forwardListCount), m_page->pageID()))
146         return 0;
147
148     return forwardListCount;
149 }
150
151 void WebBackForwardListProxy::close()
152 {
153     ASSERT(m_page);
154     m_page = nullptr;
155 }
156
157 void WebBackForwardListProxy::clear()
158 {
159     m_page->send(Messages::WebPageProxy::BackForwardClear());
160 }
161
162 } // namespace WebKit