5284ed5a6c1b6153de47de13add5972220dac639
[WebKit-https.git] / Source / WebKit2 / 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 "DataReference.h"
30 #include "EncoderAdapter.h"
31 #include "KeyedEncoder.h"
32 #include "WebCoreArgumentCoders.h"
33 #include "WebPage.h"
34 #include "WebPageProxyMessages.h"
35 #include "WebProcess.h"
36 #include "WebProcessProxyMessages.h"
37 #include <WebCore/HistoryItem.h>
38 #include <WebCore/PageCache.h>
39 #include <wtf/HashMap.h>
40
41 using namespace WebCore;
42
43 namespace WebKit {
44
45 // FIXME <rdar://problem/8819268>: This leaks all HistoryItems that go into these maps.
46 // We need to clear up the life time of these objects.
47
48 typedef HashMap<uint64_t, RefPtr<HistoryItem>> IDToHistoryItemMap;
49 typedef HashMap<RefPtr<HistoryItem>, uint64_t> HistoryItemToIDMap;
50
51 static IDToHistoryItemMap& idToHistoryItemMap()
52 {
53     DEFINE_STATIC_LOCAL(IDToHistoryItemMap, map, ());
54     return map;
55
56
57 static HistoryItemToIDMap& historyItemToIDMap()
58 {
59     DEFINE_STATIC_LOCAL(HistoryItemToIDMap, map, ());
60     return map;
61
62
63 static uint64_t uniqueHistoryItemID = 1;
64
65 static uint64_t generateHistoryItemID()
66 {
67     // These IDs exist in the WebProcess for items created by the WebProcess.
68     // The IDs generated here need to never collide with the IDs created in WebBackForwardList in the UIProcess.
69     // We accomplish this by starting from 3, and only ever using odd ids.
70     uniqueHistoryItemID += 2;
71     return uniqueHistoryItemID;
72 }
73
74 void WebBackForwardListProxy::setHighestItemIDFromUIProcess(uint64_t itemID)
75 {
76     if (itemID <= uniqueHistoryItemID)
77         return;
78     
79      if (itemID % 2)
80          uniqueHistoryItemID = itemID;
81      else
82          uniqueHistoryItemID = itemID + 1;
83 }
84
85 static void updateBackForwardItem(uint64_t itemID, HistoryItem* item)
86 {
87     KeyedEncoder keyedEncoder;
88     item->encodeBackForwardTree(keyedEncoder);
89
90     EncoderAdapter encoder;
91     item->encodeBackForwardTree(encoder);
92
93     WebProcess::shared().parentProcessConnection()->send(Messages::WebProcessProxy::AddBackForwardItem(itemID, item->originalURLString(), item->urlString(), item->title(), encoder.dataReference()), 0);
94 }
95
96 void WebBackForwardListProxy::addItemFromUIProcess(uint64_t itemID, PassRefPtr<WebCore::HistoryItem> prpItem)
97 {
98     RefPtr<HistoryItem> item = prpItem;
99     
100     // This item/itemID pair should not already exist in our maps.
101     ASSERT(!historyItemToIDMap().contains(item.get()));
102     ASSERT(!idToHistoryItemMap().contains(itemID));
103         
104     historyItemToIDMap().set(item, itemID);
105     idToHistoryItemMap().set(itemID, item);
106 }
107
108 static void WK2NotifyHistoryItemChanged(HistoryItem* item)
109 {
110     uint64_t itemID = historyItemToIDMap().get(item);
111     if (!itemID)
112         return;
113
114     updateBackForwardItem(itemID, item);
115 }
116
117 HistoryItem* WebBackForwardListProxy::itemForID(uint64_t itemID)
118 {
119     return idToHistoryItemMap().get(itemID);
120 }
121
122 uint64_t WebBackForwardListProxy::idForItem(HistoryItem* item)
123 {
124     ASSERT(item);
125     return historyItemToIDMap().get(item);
126 }
127
128 void WebBackForwardListProxy::removeItem(uint64_t itemID)
129 {
130     RefPtr<HistoryItem> item = idToHistoryItemMap().take(itemID);
131     if (!item)
132         return;
133         
134     pageCache()->remove(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(PassRefPtr<HistoryItem> prpItem)
145 {
146     RefPtr<HistoryItem> item = prpItem;
147
148     ASSERT(!historyItemToIDMap().contains(item));
149
150     if (!m_page)
151         return;
152
153     uint64_t itemID = generateHistoryItemID();
154
155     ASSERT(!idToHistoryItemMap().contains(itemID));
156
157     m_associatedItemIDs.add(itemID);
158
159     historyItemToIDMap().set(item, itemID);
160     idToHistoryItemMap().set(itemID, item);
161
162     updateBackForwardItem(itemID, item.get());
163     m_page->send(Messages::WebPageProxy::BackForwardAddItem(itemID));
164 }
165
166 void WebBackForwardListProxy::goToItem(HistoryItem* item)
167 {
168     if (!m_page)
169         return;
170
171     SandboxExtension::Handle sandboxExtensionHandle;
172     m_page->sendSync(Messages::WebPageProxy::BackForwardGoToItem(historyItemToIDMap().get(item)), Messages::WebPageProxy::BackForwardGoToItem::Reply(sandboxExtensionHandle));
173     m_page->sandboxExtensionTracker().beginLoad(m_page->mainWebFrame(), sandboxExtensionHandle);
174 }
175
176 HistoryItem* WebBackForwardListProxy::itemAtIndex(int itemIndex)
177 {
178     if (!m_page)
179         return 0;
180
181     uint64_t itemID = 0;
182     if (!WebProcess::shared().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardItemAtIndex(itemIndex), Messages::WebPageProxy::BackForwardItemAtIndex::Reply(itemID), m_page->pageID()))
183         return 0;
184
185     if (!itemID)
186         return 0;
187
188     return idToHistoryItemMap().get(itemID);
189 }
190
191 int WebBackForwardListProxy::backListCount()
192 {
193     if (!m_page)
194         return 0;
195
196     int backListCount = 0;
197     if (!WebProcess::shared().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardBackListCount(), Messages::WebPageProxy::BackForwardBackListCount::Reply(backListCount), m_page->pageID()))
198         return 0;
199
200     return backListCount;
201 }
202
203 int WebBackForwardListProxy::forwardListCount()
204 {
205     if (!m_page)
206         return 0;
207
208     int forwardListCount = 0;
209     if (!WebProcess::shared().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardForwardListCount(), Messages::WebPageProxy::BackForwardForwardListCount::Reply(forwardListCount), m_page->pageID()))
210         return 0;
211
212     return forwardListCount;
213 }
214
215 void WebBackForwardListProxy::close()
216 {
217     HashSet<uint64_t>::iterator end = m_associatedItemIDs.end();
218     for (HashSet<uint64_t>::iterator i = m_associatedItemIDs.begin(); i != end; ++i)
219         WebCore::pageCache()->remove(itemForID(*i));
220
221     m_associatedItemIDs.clear();
222
223     m_page = 0;
224 }
225
226 bool WebBackForwardListProxy::isActive()
227 {
228     // FIXME: Should check the the list is enabled and has non-zero capacity.
229     return true;
230 }
231
232 void WebBackForwardListProxy::clear()
233 {
234     m_page->send(Messages::WebPageProxy::BackForwardClear());
235 }
236
237 } // namespace WebKit