1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
|
/*
* Copyright (C) 2013-2014 Igalia S.L.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2,1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#include "config.h"
#include "WebKitTestServer.h"
#include "WebViewTest.h"
#include <cstdarg>
#include <gtk/gtk.h>
#include <webkit2/webkit2.h>
#include <wtf/glib/GRefPtr.h>
#include <wtf/glib/GUniquePtr.h>
class UserContentManagerTest : public WebViewTest {
public:
MAKE_GLIB_TEST_FIXTURE(UserContentManagerTest);
UserContentManagerTest()
: WebViewTest(webkit_user_content_manager_new())
{
// A reference is leaked when passing the result of webkit_user_content_manager_new()
// directly to webkit_web_view_new_with_user_content_manager() above. Adopting the
// reference here avoids the leak.
m_userContentManager = adoptGRef(webkit_web_view_get_user_content_manager(m_webView));
assertObjectIsDeletedWhenTestFinishes(G_OBJECT(m_userContentManager.get()));
}
GRefPtr<WebKitUserContentManager> m_userContentManager;
};
static WebKitTestServer* kServer;
// These are all here so that they can be changed easily, if necessary.
static const char* kStyleSheetHTML = "<html><div id=\"styledElement\">Sweet stylez!</div></html>";
static const char* kInjectedStyleSheet = "#styledElement { font-weight: bold; }";
static const char* kStyleSheetTestScript = "getComputedStyle(document.getElementById('styledElement'))['font-weight']";
static const char* kStyleSheetTestScriptResult = "bold";
static const char* kInjectedScript = "document.write('<div id=\"item\">Generated by a script</div>')";
static const char* kScriptTestScript = "document.getElementById('item').innerText";
static const char* kScriptTestScriptResult = "Generated by a script";
static void testWebViewNewWithUserContentManager(Test* test, gconstpointer)
{
GRefPtr<WebKitUserContentManager> userContentManager1 = adoptGRef(webkit_user_content_manager_new());
test->assertObjectIsDeletedWhenTestFinishes(G_OBJECT(userContentManager1.get()));
GRefPtr<WebKitWebView> webView1 = WEBKIT_WEB_VIEW(webkit_web_view_new_with_user_content_manager(userContentManager1.get()));
g_assert(webkit_web_view_get_user_content_manager(webView1.get()) == userContentManager1.get());
GRefPtr<WebKitWebView> webView2 = WEBKIT_WEB_VIEW(webkit_web_view_new());
g_assert(webkit_web_view_get_user_content_manager(webView2.get()) != userContentManager1.get());
}
static bool isStyleSheetInjectedForURLAtPath(WebViewTest* test, const char* path)
{
test->loadURI(kServer->getURIForPath(path).data());
test->waitUntilLoadFinished();
GUniqueOutPtr<GError> error;
WebKitJavascriptResult* javascriptResult = test->runJavaScriptAndWaitUntilFinished(kStyleSheetTestScript, &error.outPtr());
g_assert(javascriptResult);
g_assert(!error.get());
GUniquePtr<char> resultString(WebViewTest::javascriptResultToCString(javascriptResult));
return !g_strcmp0(resultString.get(), kStyleSheetTestScriptResult);
}
static bool isScriptInjectedForURLAtPath(WebViewTest* test, const char* path)
{
test->loadURI(kServer->getURIForPath(path).data());
test->waitUntilLoadFinished();
GUniqueOutPtr<GError> error;
if (WebKitJavascriptResult* javascriptResult = test->runJavaScriptAndWaitUntilFinished(kScriptTestScript, &error.outPtr())) {
g_assert(!error.get());
GUniquePtr<char> resultString(WebViewTest::javascriptResultToCString(javascriptResult));
return !g_strcmp0(resultString.get(), kScriptTestScriptResult);
}
return false;
}
static void fillURLListFromPaths(char** list, const char* path, ...)
{
va_list argumentList;
va_start(argumentList, path);
int i = 0;
while (path) {
// FIXME: We must use a wildcard for the host here until http://wkbug.com/112476 is fixed.
// Until that time patterns with port numbers in them will not properly match URLs with port numbers.
list[i++] = g_strdup_printf("http://*/%s*", path);
path = va_arg(argumentList, const char*);
}
}
static void removeOldInjectedContentAndResetLists(WebKitUserContentManager* userContentManager, char** whitelist, char** blacklist)
{
webkit_user_content_manager_remove_all_style_sheets(userContentManager);
webkit_user_content_manager_remove_all_scripts(userContentManager);
while (*whitelist) {
g_free(*whitelist);
*whitelist = 0;
whitelist++;
}
while (*blacklist) {
g_free(*blacklist);
*blacklist = 0;
blacklist++;
}
}
static void testUserContentManagerInjectedStyleSheet(UserContentManagerTest* test, gconstpointer)
{
char* whitelist[3] = { 0, 0, 0 };
char* blacklist[3] = { 0, 0, 0 };
removeOldInjectedContentAndResetLists(test->m_userContentManager.get(), whitelist, blacklist);
// Without a whitelist or a blacklist all URLs should have the injected style sheet.
static const char* randomPath = "somerandompath";
g_assert(!isStyleSheetInjectedForURLAtPath(test, randomPath));
WebKitUserStyleSheet* styleSheet = webkit_user_style_sheet_new(kInjectedStyleSheet, WEBKIT_USER_CONTENT_INJECT_ALL_FRAMES, WEBKIT_USER_STYLE_LEVEL_USER, nullptr, nullptr);
webkit_user_content_manager_add_style_sheet(test->m_userContentManager.get(), styleSheet);
webkit_user_style_sheet_unref(styleSheet);
g_assert(isStyleSheetInjectedForURLAtPath(test, randomPath));
removeOldInjectedContentAndResetLists(test->m_userContentManager.get(), whitelist, blacklist);
fillURLListFromPaths(blacklist, randomPath, 0);
styleSheet = webkit_user_style_sheet_new(kInjectedStyleSheet, WEBKIT_USER_CONTENT_INJECT_ALL_FRAMES, WEBKIT_USER_STYLE_LEVEL_USER, nullptr, blacklist);
webkit_user_content_manager_add_style_sheet(test->m_userContentManager.get(), styleSheet);
webkit_user_style_sheet_unref(styleSheet);
g_assert(!isStyleSheetInjectedForURLAtPath(test, randomPath));
g_assert(isStyleSheetInjectedForURLAtPath(test, "someotherrandompath"));
removeOldInjectedContentAndResetLists(test->m_userContentManager.get(), whitelist, blacklist);
static const char* inTheWhiteList = "inthewhitelist";
static const char* notInWhitelist = "notinthewhitelist";
static const char* inTheWhiteListAndBlackList = "inthewhitelistandblacklist";
fillURLListFromPaths(whitelist, inTheWhiteList, inTheWhiteListAndBlackList, 0);
fillURLListFromPaths(blacklist, inTheWhiteListAndBlackList, 0);
styleSheet = webkit_user_style_sheet_new(kInjectedStyleSheet, WEBKIT_USER_CONTENT_INJECT_ALL_FRAMES, WEBKIT_USER_STYLE_LEVEL_USER, whitelist, blacklist);
webkit_user_content_manager_add_style_sheet(test->m_userContentManager.get(), styleSheet);
webkit_user_style_sheet_unref(styleSheet);
g_assert(isStyleSheetInjectedForURLAtPath(test, inTheWhiteList));
g_assert(!isStyleSheetInjectedForURLAtPath(test, inTheWhiteListAndBlackList));
g_assert(!isStyleSheetInjectedForURLAtPath(test, notInWhitelist));
// It's important to clean up the environment before other tests.
removeOldInjectedContentAndResetLists(test->m_userContentManager.get(), whitelist, blacklist);
}
static void testUserContentManagerInjectedScript(UserContentManagerTest* test, gconstpointer)
{
char* whitelist[3] = { 0, 0, 0 };
char* blacklist[3] = { 0, 0, 0 };
removeOldInjectedContentAndResetLists(test->m_userContentManager.get(), whitelist, blacklist);
// Without a whitelist or a blacklist all URLs should have the injected script.
static const char* randomPath = "somerandompath";
g_assert(!isScriptInjectedForURLAtPath(test, randomPath));
WebKitUserScript* script = webkit_user_script_new(kInjectedScript, WEBKIT_USER_CONTENT_INJECT_ALL_FRAMES, WEBKIT_USER_SCRIPT_INJECT_AT_DOCUMENT_END, nullptr, nullptr);
webkit_user_content_manager_add_script(test->m_userContentManager.get(), script);
webkit_user_script_unref(script);
g_assert(isScriptInjectedForURLAtPath(test, randomPath));
removeOldInjectedContentAndResetLists(test->m_userContentManager.get(), whitelist, blacklist);
fillURLListFromPaths(blacklist, randomPath, 0);
script = webkit_user_script_new(kInjectedScript, WEBKIT_USER_CONTENT_INJECT_ALL_FRAMES, WEBKIT_USER_SCRIPT_INJECT_AT_DOCUMENT_END, nullptr, blacklist);
webkit_user_content_manager_add_script(test->m_userContentManager.get(), script);
webkit_user_script_unref(script);
g_assert(!isScriptInjectedForURLAtPath(test, randomPath));
g_assert(isScriptInjectedForURLAtPath(test, "someotherrandompath"));
removeOldInjectedContentAndResetLists(test->m_userContentManager.get(), whitelist, blacklist);
static const char* inTheWhiteList = "inthewhitelist";
static const char* notInWhitelist = "notinthewhitelist";
static const char* inTheWhiteListAndBlackList = "inthewhitelistandblacklist";
fillURLListFromPaths(whitelist, inTheWhiteList, inTheWhiteListAndBlackList, 0);
fillURLListFromPaths(blacklist, inTheWhiteListAndBlackList, 0);
script = webkit_user_script_new(kInjectedScript, WEBKIT_USER_CONTENT_INJECT_ALL_FRAMES, WEBKIT_USER_SCRIPT_INJECT_AT_DOCUMENT_END, whitelist, blacklist);
webkit_user_content_manager_add_script(test->m_userContentManager.get(), script);
webkit_user_script_unref(script);
g_assert(isScriptInjectedForURLAtPath(test, inTheWhiteList));
g_assert(!isScriptInjectedForURLAtPath(test, inTheWhiteListAndBlackList));
g_assert(!isScriptInjectedForURLAtPath(test, notInWhitelist));
// It's important to clean up the environment before other tests.
removeOldInjectedContentAndResetLists(test->m_userContentManager.get(), whitelist, blacklist);
}
class UserScriptMessageTest : public UserContentManagerTest {
public:
MAKE_GLIB_TEST_FIXTURE(UserScriptMessageTest);
UserScriptMessageTest()
: UserContentManagerTest()
, m_userScriptMessage(nullptr)
{
}
~UserScriptMessageTest()
{
if (m_userScriptMessage)
webkit_javascript_result_unref(m_userScriptMessage);
}
bool registerHandler(const char* handlerName)
{
return webkit_user_content_manager_register_script_message_handler(m_userContentManager.get(), handlerName);
}
void unregisterHandler(const char* handlerName)
{
webkit_user_content_manager_unregister_script_message_handler(m_userContentManager.get(), handlerName);
}
static void scriptMessageReceived(WebKitUserContentManager* userContentManager, WebKitJavascriptResult* jsResult, UserScriptMessageTest* test)
{
g_signal_handlers_disconnect_by_func(userContentManager, reinterpret_cast<gpointer>(scriptMessageReceived), test);
g_main_loop_quit(test->m_mainLoop);
g_assert(!test->m_userScriptMessage);
test->m_userScriptMessage = webkit_javascript_result_ref(jsResult);
}
WebKitJavascriptResult* waitUntilMessageReceived(const char* handlerName)
{
if (m_userScriptMessage) {
webkit_javascript_result_unref(m_userScriptMessage);
m_userScriptMessage = nullptr;
}
GUniquePtr<char> signalName(g_strdup_printf("script-message-received::%s", handlerName));
g_signal_connect(m_userContentManager.get(), signalName.get(), G_CALLBACK(scriptMessageReceived), this);
g_main_loop_run(m_mainLoop);
g_assert(m_userScriptMessage);
return m_userScriptMessage;
}
WebKitJavascriptResult* postMessageAndWaitUntilReceived(const char* handlerName, const char* javascriptValueAsText)
{
GUniquePtr<char> javascriptSnippet(g_strdup_printf("window.webkit.messageHandlers.%s.postMessage(%s);", handlerName, javascriptValueAsText));
webkit_web_view_run_javascript(m_webView, javascriptSnippet.get(), nullptr, nullptr, nullptr);
return waitUntilMessageReceived(handlerName);
}
private:
WebKitJavascriptResult* m_userScriptMessage;
};
static void testUserContentManagerScriptMessageReceived(UserScriptMessageTest* test, gconstpointer)
{
g_assert(test->registerHandler("msg"));
// Trying to register the same handler a second time must fail.
g_assert(!test->registerHandler("msg"));
test->loadHtml("<html></html>", nullptr);
test->waitUntilLoadFinished();
// Check that the "window.webkit.messageHandlers" namespace exists.
GUniqueOutPtr<GError> error;
WebKitJavascriptResult* javascriptResult = test->runJavaScriptAndWaitUntilFinished("window.webkit.messageHandlers ? 'y' : 'n';", &error.outPtr());
g_assert(javascriptResult);
g_assert(!error.get());
GUniquePtr<char> valueString(WebViewTest::javascriptResultToCString(javascriptResult));
g_assert_cmpstr(valueString.get(), ==, "y");
// Check that the "document.webkit.messageHandlers.msg" namespace exists.
javascriptResult = test->runJavaScriptAndWaitUntilFinished("window.webkit.messageHandlers.msg ? 'y' : 'n';", &error.outPtr());
g_assert(javascriptResult);
g_assert(!error.get());
valueString.reset(WebViewTest::javascriptResultToCString(javascriptResult));
g_assert_cmpstr(valueString.get(), ==, "y");
valueString.reset(WebViewTest::javascriptResultToCString(test->postMessageAndWaitUntilReceived("msg", "'user message'")));
g_assert_cmpstr(valueString.get(), ==, "user message");
// Messages should arrive despite of other handlers being registered.
g_assert(test->registerHandler("anotherHandler"));
// Check that the "document.webkit.messageHandlers.msg" namespace still exists.
javascriptResult = test->runJavaScriptAndWaitUntilFinished("window.webkit.messageHandlers.msg ? 'y' : 'n';", &error.outPtr());
g_assert(javascriptResult);
g_assert(!error.get());
valueString.reset(WebViewTest::javascriptResultToCString(javascriptResult));
g_assert_cmpstr(valueString.get(), ==, "y");
// Check that the "document.webkit.messageHandlers.anotherHandler" namespace exists.
javascriptResult = test->runJavaScriptAndWaitUntilFinished("window.webkit.messageHandlers.anotherHandler ? 'y' : 'n';", &error.outPtr());
g_assert(javascriptResult);
g_assert(!error.get());
valueString.reset(WebViewTest::javascriptResultToCString(javascriptResult));
g_assert_cmpstr(valueString.get(), ==, "y");
valueString.reset(WebViewTest::javascriptResultToCString(test->postMessageAndWaitUntilReceived("msg", "'handler: msg'")));
g_assert_cmpstr(valueString.get(), ==, "handler: msg");
valueString.reset(WebViewTest::javascriptResultToCString(test->postMessageAndWaitUntilReceived("anotherHandler", "'handler: anotherHandler'")));
g_assert_cmpstr(valueString.get(), ==, "handler: anotherHandler");
// Unregistering a handler and re-registering again under the same name should work.
test->unregisterHandler("msg");
javascriptResult = test->runJavaScriptAndWaitUntilFinished("window.webkit.messageHandlers.msg.postMessage('42');", &error.outPtr());
g_assert(!javascriptResult);
g_assert(error.get());
// Re-registering a handler that has been unregistered must work
g_assert(test->registerHandler("msg"));
valueString.reset(WebViewTest::javascriptResultToCString(test->postMessageAndWaitUntilReceived("msg", "'handler: msg'")));
g_assert_cmpstr(valueString.get(), ==, "handler: msg");
test->unregisterHandler("anotherHandler");
}
static void testUserContentManagerScriptMessageFromDOMBindings(UserScriptMessageTest* test, gconstpointer)
{
g_assert(test->registerHandler("dom"));
test->loadHtml("<html>1</html>", nullptr);
WebKitJavascriptResult* javascriptResult = test->waitUntilMessageReceived("dom");
g_assert(javascriptResult);
GUniquePtr<char> valueString(WebViewTest::javascriptResultToCString(javascriptResult));
g_assert_cmpstr(valueString.get(), ==, "DocumentLoaded");
test->unregisterHandler("dom");
g_assert(test->registerHandler("dom-convenience"));
test->loadHtml("<html>2</html>", nullptr);
javascriptResult = test->waitUntilMessageReceived("dom-convenience");
g_assert(javascriptResult);
valueString.reset(WebViewTest::javascriptResultToCString(javascriptResult));
g_assert_cmpstr(valueString.get(), ==, "DocumentLoaded");
test->unregisterHandler("dom-convenience");
}
static void serverCallback(SoupServer* server, SoupMessage* message, const char* path, GHashTable*, SoupClientContext*, gpointer)
{
soup_message_set_status(message, SOUP_STATUS_OK);
soup_message_body_append(message->response_body, SOUP_MEMORY_STATIC, kStyleSheetHTML, strlen(kStyleSheetHTML));
soup_message_body_complete(message->response_body);
}
void beforeAll()
{
kServer = new WebKitTestServer();
kServer->run(serverCallback);
Test::add("WebKitWebView", "new-with-user-content-manager", testWebViewNewWithUserContentManager);
UserContentManagerTest::add("WebKitUserContentManager", "injected-style-sheet", testUserContentManagerInjectedStyleSheet);
UserContentManagerTest::add("WebKitUserContentManager", "injected-script", testUserContentManagerInjectedScript);
UserScriptMessageTest::add("WebKitUserContentManager", "script-message-received", testUserContentManagerScriptMessageReceived);
UserScriptMessageTest::add("WebKitUserContentManager", "script-message-from-dom-bindings", testUserContentManagerScriptMessageFromDOMBindings);
}
void afterAll()
{
delete kServer;
}
|
