Implement encoding of arrays of objects
[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     EncoderAdapter encoder;
88     item->encodeBackForwardTree(encoder);
89
90     WebProcess::shared().parentProcessConnection()->send(Messages::WebProcessProxy::AddBackForwardItem(itemID, item->originalURLString(), item->urlString(), item->title(), encoder.dataReference()), 0);
91 }
92
93 void WebBackForwardListProxy::addItemFromUIProcess(uint64_t itemID, PassRefPtr<WebCore::HistoryItem> prpItem)
94 {
95     RefPtr<HistoryItem> item = prpItem;
96     
97     // This item/itemID pair should not already exist in our maps.
98     ASSERT(!historyItemToIDMap().contains(item.get()));
99     ASSERT(!idToHistoryItemMap().contains(itemID));
100         
101     historyItemToIDMap().set(item, itemID);
102     idToHistoryItemMap().set(itemID, item);
103 }
104
105 static void WK2NotifyHistoryItemChanged(HistoryItem* item)
106 {
107     uint64_t itemID = historyItemToIDMap().get(item);
108     if (!itemID)
109         return;
110
111     updateBackForwardItem(itemID, item);
112 }
113
114 HistoryItem* WebBackForwardListProxy::itemForID(uint64_t itemID)
115 {
116     return idToHistoryItemMap().get(itemID);
117 }
118
119 uint64_t WebBackForwardListProxy::idForItem(HistoryItem* item)
120 {
121     ASSERT(item);
122     return historyItemToIDMap().get(item);
123 }
124
125 void WebBackForwardListProxy::removeItem(uint64_t itemID)
126 {
127     RefPtr<HistoryItem> item = idToHistoryItemMap().take(itemID);
128     if (!item)
129         return;
130         
131     pageCache()->remove(item.get());
132     historyItemToIDMap().remove(item);
133 }
134
135 WebBackForwardListProxy::WebBackForwardListProxy(WebPage* page)
136     : m_page(page)
137 {
138     WebCore::notifyHistoryItemChanged = WK2NotifyHistoryItemChanged;
139 }
140
141 void WebBackForwardListProxy::addItem(PassRefPtr<HistoryItem> prpItem)
142 {
143     RefPtr<HistoryItem> item = prpItem;
144
145     ASSERT(!historyItemToIDMap().contains(item));
146
147     if (!m_page)
148         return;
149
150     uint64_t itemID = generateHistoryItemID();
151
152     ASSERT(!idToHistoryItemMap().contains(itemID));
153
154     m_associatedItemIDs.add(itemID);
155
156     historyItemToIDMap().set(item, itemID);
157     idToHistoryItemMap().set(itemID, item);
158
159     updateBackForwardItem(itemID, item.get());
160     m_page->send(Messages::WebPageProxy::BackForwardAddItem(itemID));
161 }
162
163 void WebBackForwardListProxy::goToItem(HistoryItem* item)
164 {
165     if (!m_page)
166         return;
167
168     SandboxExtension::Handle sandboxExtensionHandle;
169     m_page->sendSync(Messages::WebPageProxy::BackForwardGoToItem(historyItemToIDMap().get(item)), Messages::WebPageProxy::BackForwardGoToItem::Reply(sandboxExtensionHandle));
170     m_page->sandboxExtensionTracker().beginLoad(m_page->mainWebFrame(), sandboxExtensionHandle);
171 }
172
173 HistoryItem* WebBackForwardListProxy::itemAtIndex(int itemIndex)
174 {
175     if (!m_page)
176         return 0;
177
178     uint64_t itemID = 0;
179     if (!WebProcess::shared().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardItemAtIndex(itemIndex), Messages::WebPageProxy::BackForwardItemAtIndex::Reply(itemID), m_page->pageID()))
180         return 0;
181
182     if (!itemID)
183         return 0;
184
185     return idToHistoryItemMap().get(itemID);
186 }
187
188 int WebBackForwardListProxy::backListCount()
189 {
190     if (!m_page)
191         return 0;
192
193     int backListCount = 0;
194     if (!WebProcess::shared().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardBackListCount(), Messages::WebPageProxy::BackForwardBackListCount::Reply(backListCount), m_page->pageID()))
195         return 0;
196
197     return backListCount;
198 }
199
200 int WebBackForwardListProxy::forwardListCount()
201 {
202     if (!m_page)
203         return 0;
204
205     int forwardListCount = 0;
206     if (!WebProcess::shared().parentProcessConnection()->sendSync(Messages::WebPageProxy::BackForwardForwardListCount(), Messages::WebPageProxy::BackForwardForwardListCount::Reply(forwardListCount), m_page->pageID()))
207         return 0;
208
209     return forwardListCount;
210 }
211
212 void WebBackForwardListProxy::close()
213 {
214     HashSet<uint64_t>::iterator end = m_associatedItemIDs.end();
215     for (HashSet<uint64_t>::iterator i = m_associatedItemIDs.begin(); i != end; ++i)
216         WebCore::pageCache()->remove(itemForID(*i));
217
218     m_associatedItemIDs.clear();
219
220     m_page = 0;
221 }
222
223 bool WebBackForwardListProxy::isActive()
224 {
225     // FIXME: Should check the the list is enabled and has non-zero capacity.
226     return true;
227 }
228
229 void WebBackForwardListProxy::clear()
230 {
231     m_page->send(Messages::WebPageProxy::BackForwardClear());
232 }
233
234 } // namespace WebKit