2011-01-05 Darin Adler <darin@apple.com>
[WebKit.git] / 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 "WebBackForwardListProxy.h"
27
28 #include "DataReference.h"
29 #include "EncoderAdapter.h"
30 #include "WebCoreArgumentCoders.h"
31 #include "WebPage.h"
32 #include "WebPageProxyMessages.h"
33 #include "WebProcess.h"
34 #include "WebProcessProxyMessages.h"
35 #include <WebCore/HistoryItem.h>
36 #include <wtf/HashMap.h>
37
38 using namespace WebCore;
39
40 namespace WebKit {
41
42 static const unsigned DefaultCapacity = 100;
43 static const unsigned NoCurrentItemIndex = UINT_MAX;
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     static IDToHistoryItemMap map;
54     return map;
55
56
57 static HistoryItemToIDMap& historyItemToIDMap()
58 {
59     static HistoryItemToIDMap map;
60     return map;
61
62
63 static uint64_t generateHistoryItemID()
64 {
65     // These IDs exist in the WebProcess for items created by the WebProcess.
66     // The IDs generated here need to never collide with the IDs created in WebBackForwardList in the UIProcess.
67     // We accomplish this by starting from 3, and only ever using odd ids.
68     static uint64_t uniqueHistoryItemID = 1;
69     uniqueHistoryItemID += 2;
70     return uniqueHistoryItemID;
71 }
72
73 static void updateBackForwardItem(uint64_t itemID, HistoryItem* item)
74 {
75     EncoderAdapter encoder;
76     item->encodeBackForwardTree(encoder);
77
78     WebProcess::shared().connection()->send(Messages::WebProcessProxy::AddBackForwardItem(itemID,
79         item->originalURLString(), item->urlString(), item->title(), encoder.data()), 0);
80 }
81
82 static void WK2NotifyHistoryItemChanged(HistoryItem* item)
83 {
84     uint64_t itemID = historyItemToIDMap().get(item);
85     if (!itemID)
86         return;
87
88     updateBackForwardItem(itemID, item);
89 }
90
91 HistoryItem* WebBackForwardListProxy::itemForID(uint64_t itemID)
92 {
93     return idToHistoryItemMap().get(itemID).get();
94 }
95
96 void WebBackForwardListProxy::removeBackForwardItem(uint64_t itemID)
97 {
98     IDToHistoryItemMap::iterator it = idToHistoryItemMap().find(itemID);
99     if (it == idToHistoryItemMap().end())
100         return;
101     historyItemToIDMap().remove(it->second);
102     idToHistoryItemMap().remove(it);
103 }
104
105 WebBackForwardListProxy::WebBackForwardListProxy(WebPage* page)
106     : m_page(page)
107 {
108     WebCore::notifyHistoryItemChanged = WK2NotifyHistoryItemChanged;
109 }
110
111 void WebBackForwardListProxy::addItem(PassRefPtr<HistoryItem> prpItem)
112 {
113     RefPtr<HistoryItem> item = prpItem;
114
115     ASSERT(!historyItemToIDMap().contains(item));
116
117     if (!m_page)
118         return;
119
120     uint64_t itemID = generateHistoryItemID();
121
122     ASSERT(!idToHistoryItemMap().contains(itemID));
123
124     historyItemToIDMap().set(item, itemID);
125     idToHistoryItemMap().set(itemID, item);
126
127     updateBackForwardItem(itemID, item.get());
128     m_page->send(Messages::WebPageProxy::BackForwardAddItem(itemID));
129 }
130
131 void WebBackForwardListProxy::goToItem(HistoryItem* item)
132 {
133     if (!m_page)
134         return;
135
136     m_page->send(Messages::WebPageProxy::BackForwardGoToItem(historyItemToIDMap().get(item)));
137 }
138
139 HistoryItem* WebBackForwardListProxy::itemAtIndex(int itemIndex)
140 {
141     if (!m_page)
142         return 0;
143
144     uint64_t itemID = 0;
145     if (!WebProcess::shared().connection()->sendSync(Messages::WebPageProxy::BackForwardItemAtIndex(itemIndex), Messages::WebPageProxy::BackForwardItemAtIndex::Reply(itemID), m_page->pageID()))
146         return 0;
147
148     if (!itemID)
149         return 0;
150
151     return idToHistoryItemMap().get(itemID).get();
152 }
153
154 int WebBackForwardListProxy::backListCount()
155 {
156     if (!m_page)
157         return 0;
158
159     int backListCount = 0;
160     if (!WebProcess::shared().connection()->sendSync(Messages::WebPageProxy::BackForwardBackListCount(), Messages::WebPageProxy::BackForwardBackListCount::Reply(backListCount), m_page->pageID()))
161         return 0;
162
163     return backListCount;
164 }
165
166 int WebBackForwardListProxy::forwardListCount()
167 {
168     if (!m_page)
169         return 0;
170
171     int forwardListCount = 0;
172     if (!WebProcess::shared().connection()->sendSync(Messages::WebPageProxy::BackForwardForwardListCount(), Messages::WebPageProxy::BackForwardForwardListCount::Reply(forwardListCount), m_page->pageID()))
173         return 0;
174
175     return forwardListCount;
176 }
177
178 void WebBackForwardListProxy::close()
179 {
180     m_page = 0;
181 }
182
183 bool WebBackForwardListProxy::isActive()
184 {
185     // FIXME: Should check the the list is enabled and has non-zero capacity.
186     return true;
187 }
188
189 void WebBackForwardListProxy::clear()
190 {
191     m_page->send(Messages::WebPageProxy::BackForwardClear());
192 }
193
194 #if ENABLE(WML)
195 void WebBackForwardListProxy::clearWMLPageHistory()
196 {
197 }
198 #endif
199
200 } // namespace WebKit