1/*
2 * Copyright (C) 2011 Igalia S.L.
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public License
15 * along with this library; see the file COPYING.LIB. If not, write to
16 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
18 */
19
20#include "config.h"
21
22#include "WebKitTestServer.h"
23#include "WebViewTest.h"
24#include <libsoup/soup.h>
25#include <string.h>
26
27// Back forward list limit is 100 by default.
28static const int kBackForwardListLimit = 100;
29
30static WebKitTestServer* kServer;
31
32static void serverCallback(SoupServer* server, SoupMessage* msg, const char* path, GHashTable* query, SoupClientContext* context, gpointer data)
33{
34 if (msg->method != SOUP_METHOD_GET) {
35 soup_message_set_status(msg, SOUP_STATUS_NOT_IMPLEMENTED);
36 return;
37 }
38
39 if (g_str_has_suffix(path, "favicon.ico")) {
40 soup_message_set_status(msg, SOUP_STATUS_NOT_FOUND);
41 return;
42 }
43
44 soup_message_set_status(msg, SOUP_STATUS_OK);
45
46 char* body = g_strdup_printf("<html><title>%s</title><body>%s</body></html>", path + 1, path + 1);
47 soup_message_body_append(msg->response_body, SOUP_MEMORY_TAKE, body, strlen(body));
48
49 soup_message_body_complete(msg->response_body);
50}
51
52class BackForwardListTest: public WebViewTest {
53public:
54 MAKE_GLIB_TEST_FIXTURE(BackForwardListTest);
55
56 enum {
57 Backward,
58 Forward
59 };
60
61 enum {
62 CurrentItem = 1 << 0,
63 AddedItem = 1 << 1,
64 RemovedItems = 1 << 2
65 };
66
67 static void checkItem(WebKitBackForwardListItem* item, const char* title, const char* uri, const char* originalURI)
68 {
69 g_assert_nonnull(item);
70 g_assert_cmpstr(webkit_back_forward_list_item_get_uri(item), ==, uri);
71 g_assert_cmpstr(webkit_back_forward_list_item_get_title(item), == , title);
72 g_assert_cmpstr(webkit_back_forward_list_item_get_original_uri(item), ==, originalURI);
73 }
74
75 static void checkItemIndex(WebKitBackForwardList* list)
76 {
77 g_assert_true(webkit_back_forward_list_get_nth_item(list, -1) == webkit_back_forward_list_get_back_item(list));
78 g_assert_true(webkit_back_forward_list_get_nth_item(list, 0) == webkit_back_forward_list_get_current_item(list));
79 g_assert_true(webkit_back_forward_list_get_nth_item(list, 1) == webkit_back_forward_list_get_forward_item(list));
80 }
81
82 static void checkList(WebKitBackForwardList* list, unsigned type, WebKitBackForwardListItem** items, unsigned nItems)
83 {
84 GList* listItems = type == BackForwardListTest::Backward ? webkit_back_forward_list_get_back_list(list) :
85 webkit_back_forward_list_get_forward_list(list);
86 g_assert_nonnull(listItems);
87
88 unsigned i = 0;
89 for (GList* listItem = listItems; listItem; listItem = g_list_next(listItem), i++) {
90 g_assert_cmpuint(i, <, nItems);
91 g_assert_true(listItem->data == items[i]);
92 }
93 g_list_free(listItems);
94 }
95
96 static void backForwardListChanged(WebKitBackForwardList* list, WebKitBackForwardListItem* addedItem, GList* removedItems, BackForwardListTest* test)
97 {
98 test->m_hasChanged = true;
99
100 if (test->m_changedFlags & BackForwardListTest::AddedItem) {
101 g_assert_true(WEBKIT_IS_BACK_FORWARD_LIST_ITEM(addedItem));
102 test->assertObjectIsDeletedWhenTestFinishes(G_OBJECT(addedItem));
103 } else
104 g_assert_null(addedItem);
105
106 if (test->m_changedFlags & BackForwardListTest::RemovedItems) {
107 g_assert_nonnull(removedItems);
108 for (GList* iter = removedItems; iter; iter = iter->next) {
109 g_assert_true(WEBKIT_IS_BACK_FORWARD_LIST_ITEM(iter->data));
110 if (test->m_expectedRemovedItems)
111 g_assert_nonnull(g_list_find(test->m_expectedRemovedItems, iter->data));
112 }
113
114 } else
115 g_assert_null(removedItems);
116 }
117
118 BackForwardListTest()
119 : m_list(webkit_web_view_get_back_forward_list(m_webView))
120 , m_changedFlags(0)
121 , m_hasChanged(false)
122 , m_expectedRemovedItems(0)
123 {
124 g_signal_connect(m_list, "changed", G_CALLBACK(backForwardListChanged), this);
125 assertObjectIsDeletedWhenTestFinishes(G_OBJECT(m_list));
126 }
127
128 ~BackForwardListTest()
129 {
130 g_signal_handlers_disconnect_matched(m_list, G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, this);
131 }
132
133 void waitUntilLoadFinished()
134 {
135 m_hasChanged = false;
136 WebViewTest::waitUntilLoadFinished();
137 g_assert_true(m_hasChanged);
138 }
139
140 void waitUntilLoadFinishedAndCheckRemovedItems(GList* removedItems)
141 {
142 m_expectedRemovedItems = removedItems;
143 waitUntilLoadFinished();
144 m_expectedRemovedItems = 0;
145 }
146
147 WebKitBackForwardList* m_list;
148 unsigned long m_changedFlags;
149 bool m_hasChanged;
150 GList* m_expectedRemovedItems;
151};
152
153static void testBackForwardListNavigation(BackForwardListTest* test, gconstpointer)
154{
155 WebKitBackForwardListItem* items[1];
156
157 g_assert_false(webkit_web_view_can_go_back(test->m_webView));
158 g_assert_false(webkit_web_view_can_go_forward(test->m_webView));
159
160 g_assert_cmpuint(webkit_back_forward_list_get_length(test->m_list), ==, 0);
161 g_assert_null(webkit_back_forward_list_get_current_item(test->m_list));
162 g_assert_null(webkit_back_forward_list_get_back_item(test->m_list));
163 g_assert_null(webkit_back_forward_list_get_forward_item(test->m_list));
164 BackForwardListTest::checkItemIndex(test->m_list);
165 g_assert_null(webkit_back_forward_list_get_back_list(test->m_list));
166 g_assert_null(webkit_back_forward_list_get_forward_list(test->m_list));
167
168 CString uriPage1 = kServer->getURIForPath("/Page1");
169 test->m_changedFlags = BackForwardListTest::CurrentItem | BackForwardListTest::AddedItem;
170 test->loadURI(uriPage1.data());
171 test->waitUntilLoadFinished();
172
173 g_assert_false(webkit_web_view_can_go_back(test->m_webView));
174 g_assert_false(webkit_web_view_can_go_forward(test->m_webView));
175
176 g_assert_cmpuint(webkit_back_forward_list_get_length(test->m_list), ==, 1);
177 WebKitBackForwardListItem* itemPage1 = webkit_back_forward_list_get_current_item(test->m_list);
178 BackForwardListTest::checkItem(itemPage1, "Page1", uriPage1.data(), uriPage1.data());
179 g_assert_null(webkit_back_forward_list_get_back_item(test->m_list));
180 g_assert_null(webkit_back_forward_list_get_forward_item(test->m_list));
181 BackForwardListTest::checkItemIndex(test->m_list);
182 g_assert_null(webkit_back_forward_list_get_back_list(test->m_list));
183 g_assert_null(webkit_back_forward_list_get_forward_list(test->m_list));
184
185 CString uriPage2 = kServer->getURIForPath("/Page2");
186 test->m_changedFlags = BackForwardListTest::CurrentItem | BackForwardListTest::AddedItem;
187 test->loadURI(uriPage2.data());
188 test->waitUntilLoadFinished();
189
190 g_assert_true(webkit_web_view_can_go_back(test->m_webView));
191 g_assert_false(webkit_web_view_can_go_forward(test->m_webView));
192
193 g_assert_cmpuint(webkit_back_forward_list_get_length(test->m_list), ==, 2);
194 WebKitBackForwardListItem* itemPage2 = webkit_back_forward_list_get_current_item(test->m_list);
195 BackForwardListTest::checkItem(itemPage2, "Page2", uriPage2.data(), uriPage2.data());
196 g_assert_true(webkit_back_forward_list_get_back_item(test->m_list) == itemPage1);
197 g_assert_null(webkit_back_forward_list_get_forward_item(test->m_list));
198 BackForwardListTest::checkItemIndex(test->m_list);
199 items[0] = itemPage1;
200 BackForwardListTest::checkList(test->m_list, BackForwardListTest::Backward, items, 1);
201 g_assert_null(webkit_back_forward_list_get_forward_list(test->m_list));
202
203 test->m_changedFlags = BackForwardListTest::CurrentItem;
204 test->goBack();
205 test->waitUntilLoadFinished();
206
207 g_assert_false(webkit_web_view_can_go_back(test->m_webView));
208 g_assert_true(webkit_web_view_can_go_forward(test->m_webView));
209
210 g_assert_cmpuint(webkit_back_forward_list_get_length(test->m_list), ==, 2);
211 g_assert_true(itemPage1 == webkit_back_forward_list_get_current_item(test->m_list));
212 BackForwardListTest::checkItem(webkit_back_forward_list_get_current_item(test->m_list), "Page1", uriPage1.data(), uriPage1.data());
213 g_assert_null(webkit_back_forward_list_get_back_item(test->m_list));
214 g_assert_true(webkit_back_forward_list_get_forward_item(test->m_list) == itemPage2);
215 BackForwardListTest::checkItemIndex(test->m_list);
216 g_assert_null(webkit_back_forward_list_get_back_list(test->m_list));
217 items[0] = itemPage2;
218 BackForwardListTest::checkList(test->m_list, BackForwardListTest::Forward, items, 1);
219
220 test->m_changedFlags = BackForwardListTest::CurrentItem;
221 test->goForward();
222 test->waitUntilLoadFinished();
223
224 g_assert_true(webkit_web_view_can_go_back(test->m_webView));
225 g_assert_false(webkit_web_view_can_go_forward(test->m_webView));
226
227 g_assert_cmpuint(webkit_back_forward_list_get_length(test->m_list), ==, 2);
228 g_assert_true(itemPage2 == webkit_back_forward_list_get_current_item(test->m_list));
229 BackForwardListTest::checkItem(webkit_back_forward_list_get_current_item(test->m_list), "Page2", uriPage2.data(), uriPage2.data());
230 g_assert_true(webkit_back_forward_list_get_back_item(test->m_list) == itemPage1);
231 g_assert_null(webkit_back_forward_list_get_forward_item(test->m_list));
232 BackForwardListTest::checkItemIndex(test->m_list);
233 items[0] = itemPage1;
234 BackForwardListTest::checkList(test->m_list, BackForwardListTest::Backward, items, 1);
235 g_assert_null(webkit_back_forward_list_get_forward_list(test->m_list));
236
237 test->m_changedFlags = BackForwardListTest::CurrentItem;
238 test->goToBackForwardListItem(itemPage1);
239 test->waitUntilLoadFinished();
240
241 g_assert_true(itemPage1 == webkit_back_forward_list_get_current_item(test->m_list));
242}
243
244static void testBackForwardListLimitAndCache(BackForwardListTest* test, gconstpointer)
245{
246 for (int i = 0; i < kBackForwardListLimit; i++) {
247 GUniquePtr<char> path(g_strdup_printf("/Page%d", i));
248 test->m_changedFlags = BackForwardListTest::CurrentItem | BackForwardListTest::AddedItem;
249 test->loadURI(kServer->getURIForPath(path.get()).data());
250 test->waitUntilLoadFinished();
251 }
252
253 g_assert_cmpuint(webkit_back_forward_list_get_length(test->m_list), ==, kBackForwardListLimit);
254 WebKitBackForwardListItem* itemPageFirst = webkit_back_forward_list_get_nth_item(test->m_list, -(kBackForwardListLimit - 1));
255 GUniquePtr<GList> removedItems(g_list_prepend(0, itemPageFirst));
256
257 GUniquePtr<char> path(g_strdup_printf("/Page%d", kBackForwardListLimit));
258 test->m_changedFlags = BackForwardListTest::CurrentItem | BackForwardListTest::AddedItem | BackForwardListTest::RemovedItems;
259 test->loadURI(kServer->getURIForPath(path.get()).data());
260 test->waitUntilLoadFinishedAndCheckRemovedItems(removedItems.get());
261
262 g_assert_cmpuint(webkit_back_forward_list_get_length(test->m_list), ==, kBackForwardListLimit);
263}
264
265static void testWebKitWebViewSessionState(BackForwardListTest* test, gconstpointer)
266{
267 WebKitWebViewSessionState* state = webkit_web_view_get_session_state(test->m_webView);
268 g_assert_nonnull(state);
269 auto view = Test::adoptView(Test::createWebView());
270 WebKitBackForwardList* bfList = webkit_web_view_get_back_forward_list(view.get());
271 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 0);
272 webkit_web_view_restore_session_state(view.get(), state);
273 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 0);
274 GRefPtr<GBytes> data = adoptGRef(webkit_web_view_session_state_serialize(state));
275 g_assert_nonnull(data);
276 state = webkit_web_view_session_state_new(data.get());
277 g_assert_nonnull(state);
278 view = Test::adoptView(Test::createWebView());
279 bfList = webkit_web_view_get_back_forward_list(view.get());
280 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 0);
281 webkit_web_view_restore_session_state(view.get(), state);
282 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 0);
283 webkit_web_view_session_state_unref(state);
284
285 CString uriPage1 = kServer->getURIForPath("/Page1");
286 test->m_changedFlags = BackForwardListTest::CurrentItem | BackForwardListTest::AddedItem;
287 test->loadURI(uriPage1.data());
288 test->waitUntilLoadFinished();
289
290 CString uriPage2 = kServer->getURIForPath("/Page2");
291 test->m_changedFlags = BackForwardListTest::CurrentItem | BackForwardListTest::AddedItem;
292 test->loadURI(uriPage2.data());
293 test->waitUntilLoadFinished();
294
295 CString uriPage3 = kServer->getURIForPath("/Page3");
296 test->m_changedFlags = BackForwardListTest::CurrentItem | BackForwardListTest::AddedItem;
297 test->loadURI(uriPage3.data());
298 test->waitUntilLoadFinished();
299
300 test->m_changedFlags = BackForwardListTest::CurrentItem;
301 test->goBack();
302 test->waitUntilLoadFinished();
303
304 state = webkit_web_view_get_session_state(test->m_webView);
305 g_assert_nonnull(state);
306
307 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 0);
308 webkit_web_view_restore_session_state(view.get(), state);
309 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 3);
310
311 BackForwardListTest::checkItem(webkit_back_forward_list_get_nth_item(bfList, -1), "Page1", uriPage1.data(), uriPage1.data());
312 BackForwardListTest::checkItem(webkit_back_forward_list_get_current_item(bfList), "Page2", uriPage2.data(), uriPage2.data());
313 BackForwardListTest::checkItem(webkit_back_forward_list_get_nth_item(bfList, 1), "Page3", uriPage3.data(), uriPage3.data());
314
315 data = adoptGRef(webkit_web_view_session_state_serialize(state));
316 g_assert_nonnull(data);
317 webkit_web_view_session_state_unref(state);
318 state = webkit_web_view_session_state_new(data.get());
319 g_assert_nonnull(state);
320
321 view = Test::adoptView(Test::createWebView());
322 bfList = webkit_web_view_get_back_forward_list(view.get());
323 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 0);
324 webkit_web_view_restore_session_state(view.get(), state);
325 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 3);
326 webkit_web_view_session_state_unref(state);
327
328 BackForwardListTest::checkItem(webkit_back_forward_list_get_nth_item(bfList, -1), "Page1", uriPage1.data(), uriPage1.data());
329 BackForwardListTest::checkItem(webkit_back_forward_list_get_current_item(bfList), "Page2", uriPage2.data(), uriPage2.data());
330 BackForwardListTest::checkItem(webkit_back_forward_list_get_nth_item(bfList, 1), "Page3", uriPage3.data(), uriPage3.data());
331
332 static const char* invalidSessionData = "invalid session data";
333 data = adoptGRef(g_bytes_new_static(invalidSessionData, strlen(invalidSessionData)));
334 g_assert_null(webkit_web_view_session_state_new(data.get()));
335}
336
337static void testWebKitWebViewSessionStateWithFormData(BackForwardListTest* test, gconstpointer)
338{
339 GUniquePtr<char> htmlPath(g_build_filename(Test::getResourcesDir(Test::WebKit2Resources).data(), "simple-form.html", nullptr));
340 GUniquePtr<char> htmlURL(g_filename_to_uri(htmlPath.get(), nullptr, nullptr));
341 test->m_changedFlags = BackForwardListTest::CurrentItem | BackForwardListTest::AddedItem;
342 test->loadURI(htmlURL.get());
343 test->waitUntilLoadFinished();
344
345 webkit_web_view_run_javascript(test->m_webView, "submitForm();", nullptr, nullptr, nullptr);
346 test->waitUntilLoadFinished();
347
348 WebKitWebViewSessionState* state = webkit_web_view_get_session_state(test->m_webView);
349 g_assert_nonnull(state);
350 auto view = Test::adoptView(Test::createWebView());
351 WebKitBackForwardList* bfList = webkit_web_view_get_back_forward_list(view.get());
352 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 0);
353 webkit_web_view_restore_session_state(view.get(), state);
354 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 2);
355 GRefPtr<GBytes> data = adoptGRef(webkit_web_view_session_state_serialize(state));
356 g_assert_nonnull(data);
357 state = webkit_web_view_session_state_new(data.get());
358 g_assert_nonnull(state);
359 view = Test::adoptView(Test::createWebView());
360 bfList = webkit_web_view_get_back_forward_list(view.get());
361 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 0);
362 webkit_web_view_restore_session_state(view.get(), state);
363 g_assert_cmpuint(webkit_back_forward_list_get_length(bfList), ==, 2);
364 webkit_web_view_session_state_unref(state);
365}
366
367static void viewLoadChanged(WebKitWebView* webView, WebKitLoadEvent loadEvent, GMainLoop* mainLoop)
368{
369 if (loadEvent == WEBKIT_LOAD_FINISHED)
370 g_main_loop_quit(mainLoop);
371}
372
373static void testWebKitWebViewNavigationAfterSessionRestore(BackForwardListTest* test, gconstpointer)
374{
375 // This test checks that a normal load after a session restore with a BackForard list having
376 // forward items doesn't produce any runtime critical warning. See https://bugs.webkit.org/show_bug.cgi?id=153233.
377 auto view = Test::adoptView(Test::createWebView());
378 g_signal_connect(view.get(), "load-changed", G_CALLBACK(viewLoadChanged), test->m_mainLoop);
379
380 webkit_web_view_load_uri(view.get(), kServer->getURIForPath("/Page1").data());
381 g_main_loop_run(test->m_mainLoop);
382 webkit_web_view_load_uri(view.get(), kServer->getURIForPath("/Page2").data());
383 g_main_loop_run(test->m_mainLoop);
384 webkit_web_view_load_uri(view.get(), kServer->getURIForPath("/Page3").data());
385 g_main_loop_run(test->m_mainLoop);
386 webkit_web_view_go_back(view.get());
387 g_main_loop_run(test->m_mainLoop);
388
389 WebKitWebViewSessionState* state = webkit_web_view_get_session_state(view.get());
390 webkit_web_view_restore_session_state(test->m_webView, state);
391 webkit_web_view_session_state_unref(state);
392
393 // A normal load after a session restore should remove the forward list, add the new item and update the current one.
394 test->m_changedFlags = BackForwardListTest::CurrentItem | BackForwardListTest::AddedItem | BackForwardListTest::RemovedItems;
395 test->loadURI(kServer->getURIForPath("/Page4").data());
396 test->waitUntilLoadFinished();
397}
398
399void beforeAll()
400{
401 kServer = new WebKitTestServer();
402 kServer->run(serverCallback);
403
404 BackForwardListTest::add("BackForwardList", "navigation", testBackForwardListNavigation);
405 BackForwardListTest::add("BackForwardList", "list-limit-and-cache", testBackForwardListLimitAndCache);
406 BackForwardListTest::add("WebKitWebView", "session-state", testWebKitWebViewSessionState);
407 BackForwardListTest::add("WebKitWebView", "session-state-with-form-data", testWebKitWebViewSessionStateWithFormData);
408 BackForwardListTest::add("WebKitWebView", "navigation-after-session-restore", testWebKitWebViewNavigationAfterSessionRestore);
409}
410
411void afterAll()
412{
413 delete kServer;
414}
415
416