7c10c78e3fef2b179371da5ba483252261de7935
[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<uint64_t, RefPtr<HistoryItem>> IDToHistoryItemMap; // "ID" here is the item ID.
51     
52 struct ItemAndPageID {
53     uint64_t itemID;
54     uint64_t pageID;
55 };
56 typedef HashMap<RefPtr<HistoryItem>, ItemAndPageID> HistoryItemToIDMap;
57
58 static IDToHistoryItemMap& idToHistoryItemMap()
59 {
60     static NeverDestroyed<IDToHistoryItemMap> map;
61     return map;
62 }
63
64 static HistoryItemToIDMap& historyItemToIDMap()
65 {
66     static NeverDestroyed<HistoryItemToIDMap> map;
67     return map;
68 }
69
70 static uint64_t uniqueHistoryItemID = 1;
71
72 static uint64_t generateHistoryItemID()
73 {
74     // These IDs exist in the WebProcess for items created by the WebProcess.
75     // The IDs generated here need to never collide with the IDs created in WebBackForwardList in the UIProcess.
76     // We accomplish this by starting from 3, and only ever using odd ids.
77     uniqueHistoryItemID += 2;
78     return uniqueHistoryItemID;
79 }
80
81 void WebBackForwardListProxy::setHighestItemIDFromUIProcess(uint64_t itemID)
82 {
83     if (itemID <= uniqueHistoryItemID)
84         return;
85     
86      if (itemID % 2)
87          uniqueHistoryItemID = itemID;
88      else
89          uniqueHistoryItemID = itemID + 1;
90 }
91
92 static void updateBackForwardItem(uint64_t itemID, uint64_t pageID, HistoryItem* item)
93 {
94     WebProcess::singleton().parentProcessConnection()->send(Messages::WebProcessProxy::AddOrUpdateBackForwardItem(itemID, pageID, toPageState(*item)), 0);
95 }
96
97 void WebBackForwardListProxy::addItemFromUIProcess(uint64_t itemID, Ref<HistoryItem>&& item, uint64_t pageID)
98 {
99     // This item/itemID pair should not already exist in our maps.
100     ASSERT(!historyItemToIDMap().contains(item.ptr()));
101     ASSERT(!idToHistoryItemMap().contains(itemID));
102
103     historyItemToIDMap().set<ItemAndPageID>(item.ptr(), { itemID, pageID });
104     idToHistoryItemMap().set(itemID, item.ptr());
105 }
106
107 static void WK2NotifyHistoryItemChanged(HistoryItem* item)
108 {
109     ItemAndPageID ids = historyItemToIDMap().get(item);
110     if (!ids.itemID)
111         return;
112
113     updateBackForwardItem(ids.itemID, ids.pageID, item);
114 }
115
116 HistoryItem* WebBackForwardListProxy::itemForID(uint64_t itemID)
117 {
118     return idToHistoryItemMap().get(itemID);
119 }
120
121 uint64_t WebBackForwardListProxy::idForItem(HistoryItem* item)
122 {
123     ASSERT(item);
124     return historyItemToIDMap().get(item).itemID;
125 }
126
127 void WebBackForwardListProxy::removeItem(uint64_t itemID)
128 {
129     RefPtr<HistoryItem> item = idToHistoryItemMap().take(itemID);
130     if (!item)
131         return;
132         
133     PageCache::singleton().remove(*item);
134     WebCore::Page::clearPreviousItemFromAllPages(item.get());
135     historyItemToIDMap().remove(item);
136 }
137
138 WebBackForwardListProxy::WebBackForwardListProxy(WebPage* page)
139     : m_page(page)
140 {
141     WebCore::notifyHistoryItemChanged = WK2NotifyHistoryItemChanged;
142 }
143
144 void WebBackForwardListProxy::addItem(Ref<HistoryItem>&& item)
145 {
146     ASSERT(!historyItemToIDMap().contains(item.ptr()));
147
148     if (!m_page)
149         return;
150
151     uint64_t itemID = generateHistoryItemID();
152
153     ASSERT(!idToHistoryItemMap().contains(itemID));
154
155     historyItemToIDMap().set<ItemAndPageID>(item.ptr(), { itemID, m_page->pageID() });
156     idToHistoryItemMap().set(itemID, item.ptr());
157
158     updateBackForwardItem(itemID, m_page->pageID(), item.ptr());
159     m_page->send(Messages::WebPageProxy::BackForwardAddItem(itemID));
160 }
161
162 void WebBackForwardListProxy::goToItem(HistoryItem* item)
163 {
164     if (!m_page)
165         return;
166
167     SandboxExtension::Handle sandboxExtensionHandle;
168     m_page->sendSync(Messages::WebPageProxy::BackForwardGoToItem(historyItemToIDMap().get(item).itemID), Messages::WebPageProxy::BackForwardGoToItem::Reply(sandboxExtensionHandle));
169     m_page->sandboxExtensionTracker().beginLoad(m_page->mainWebFrame(), WTFMove(sandboxExtensionHandle));
170 }
171
172 HistoryItem* WebBackForwardListProxy::itemAtIndex(int itemIndex)
173 {
174     if (!m_page)
175         return nullptr;
176
177     uint64_t itemID = 0;
178     if (!WebProcess::singleton().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardItemAtIndex(itemIndex), Messages::WebPageProxy::BackForwardItemAtIndex::Reply(itemID), m_page->pageID()))
179         return nullptr;
180
181     if (!itemID)
182         return nullptr;
183
184     return idToHistoryItemMap().get(itemID);
185 }
186
187 int WebBackForwardListProxy::backListCount()
188 {
189     if (!m_page)
190         return 0;
191
192     int backListCount = 0;
193     if (!WebProcess::singleton().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardBackListCount(), Messages::WebPageProxy::BackForwardBackListCount::Reply(backListCount), m_page->pageID()))
194         return 0;
195
196     return backListCount;
197 }
198
199 int WebBackForwardListProxy::forwardListCount()
200 {
201     if (!m_page)
202         return 0;
203
204     int forwardListCount = 0;
205     if (!WebProcess::singleton().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardForwardListCount(), Messages::WebPageProxy::BackForwardForwardListCount::Reply(forwardListCount), m_page->pageID()))
206         return 0;
207
208     return forwardListCount;
209 }
210
211 void WebBackForwardListProxy::close()
212 {
213     m_page = nullptr;
214 }
215
216 void WebBackForwardListProxy::clear()
217 {
218     m_page->send(Messages::WebPageProxy::BackForwardClear());
219 }
220
221 } // namespace WebKit