.:
[WebKit-https.git] / WebKitTools / DumpRenderTree / qt / DumpRenderTree.cpp
1 /*
2  * Copyright (C) 2005, 2006 Apple Computer, Inc.  All rights reserved.
3  * Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
4  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
5  * Copyright (C) 2009 Torch Mobile Inc. http://www.torchmobile.com/
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1.  Redistributions of source code must retain the above copyright
12  *     notice, this list of conditions and the following disclaimer.
13  * 2.  Redistributions in binary form must reproduce the above copyright
14  *     notice, this list of conditions and the following disclaimer in the
15  *     documentation and/or other materials provided with the distribution.
16  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
17  *     its contributors may be used to endorse or promote products derived
18  *     from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
21  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
24  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "DumpRenderTree.h"
33 #include "jsobjects.h"
34 #include "testplugin.h"
35
36 #include <QDir>
37 #include <QFile>
38 #include <QTimer>
39 #include <QBoxLayout>
40 #include <QScrollArea>
41 #include <QApplication>
42 #include <QUrl>
43 #include <QFocusEvent>
44 #include <QFontDatabase>
45
46 #include <qwebpage.h>
47 #include <qwebframe.h>
48 #include <qwebview.h>
49 #include <qwebsettings.h>
50 #include <qwebsecurityorigin.h>
51
52 #ifdef Q_WS_X11
53 #include <fontconfig/fontconfig.h>
54 #endif
55
56 #include <unistd.h>
57 #include <qdebug.h>
58
59 extern void qt_drt_run(bool b);
60 extern void qt_dump_set_accepts_editing(bool b);
61 extern void qt_dump_frame_loader(bool b);
62 extern void qt_drt_clearFrameName(QWebFrame* qFrame);
63
64 namespace WebCore {
65
66 // Choose some default values.
67 const unsigned int maxViewWidth = 800;
68 const unsigned int maxViewHeight = 600;
69
70 class WebPage : public QWebPage {
71     Q_OBJECT
72 public:
73     WebPage(QWidget *parent, DumpRenderTree *drt);
74
75     QWebPage *createWindow(QWebPage::WebWindowType);
76
77     void javaScriptAlert(QWebFrame *frame, const QString& message);
78     void javaScriptConsoleMessage(const QString& message, int lineNumber, const QString& sourceID);
79     bool javaScriptConfirm(QWebFrame *frame, const QString& msg);
80     bool javaScriptPrompt(QWebFrame *frame, const QString& msg, const QString& defaultValue, QString* result);
81
82 private slots:
83     void setViewGeometry(const QRect &r)
84     {
85         QWidget *v = view();
86         if (v)
87             v->setGeometry(r);
88     }
89 private:
90     DumpRenderTree *m_drt;
91 };
92
93 WebPage::WebPage(QWidget *parent, DumpRenderTree *drt)
94     : QWebPage(parent), m_drt(drt)
95 {
96     settings()->setFontSize(QWebSettings::MinimumFontSize, 5);
97     settings()->setFontSize(QWebSettings::MinimumLogicalFontSize, 5);
98     // To get DRT compliant to some layout tests lets set the default fontsize to 13.
99     settings()->setFontSize(QWebSettings::DefaultFontSize, 13);
100     settings()->setFontSize(QWebSettings::DefaultFixedFontSize, 13);
101     settings()->setAttribute(QWebSettings::JavascriptCanOpenWindows, true);
102     settings()->setAttribute(QWebSettings::JavascriptCanAccessClipboard, true);
103     settings()->setAttribute(QWebSettings::LinksIncludedInFocusChain, false);
104     settings()->setAttribute(QWebSettings::PluginsEnabled, true);
105     connect(this, SIGNAL(geometryChangeRequested(const QRect &)),
106             this, SLOT(setViewGeometry(const QRect & )));
107
108     setPluginFactory(new TestPlugin(this));
109 }
110
111 QWebPage *WebPage::createWindow(QWebPage::WebWindowType)
112 {
113     return m_drt->createWindow();
114 }
115
116 void WebPage::javaScriptAlert(QWebFrame*, const QString& message)
117 {
118     fprintf(stdout, "ALERT: %s\n", message.toUtf8().constData());
119 }
120
121 void WebPage::javaScriptConsoleMessage(const QString& message, int lineNumber, const QString&)
122 {
123     fprintf (stdout, "CONSOLE MESSAGE: line %d: %s\n", lineNumber, message.toUtf8().constData());
124 }
125
126 bool WebPage::javaScriptConfirm(QWebFrame*, const QString& msg)
127 {
128     fprintf(stdout, "CONFIRM: %s\n", msg.toUtf8().constData());
129     return true;
130 }
131
132 bool WebPage::javaScriptPrompt(QWebFrame*, const QString& msg, const QString& defaultValue, QString* result)
133 {
134     fprintf(stdout, "PROMPT: %s, default text: %s\n", msg.toUtf8().constData(), defaultValue.toUtf8().constData());
135     *result = defaultValue;
136     return true;
137 }
138
139 DumpRenderTree::DumpRenderTree()
140     : m_stdin(0)
141     , m_notifier(0)
142 {
143     m_controller = new LayoutTestController(this);
144     connect(m_controller, SIGNAL(done()), this, SLOT(dump()));
145
146     QWebView *view = new QWebView(0);
147     view->resize(QSize(maxViewWidth, maxViewHeight));
148     m_page = new WebPage(view, this);
149     view->setPage(m_page);
150     connect(m_page, SIGNAL(frameCreated(QWebFrame *)), this, SLOT(connectFrame(QWebFrame *)));
151     connectFrame(m_page->mainFrame());
152
153     connect(m_page->mainFrame(), SIGNAL(loadFinished(bool)), m_controller, SLOT(maybeDump(bool)));
154
155     m_page->mainFrame()->setScrollBarPolicy(Qt::Horizontal, Qt::ScrollBarAlwaysOff);
156     m_page->mainFrame()->setScrollBarPolicy(Qt::Vertical, Qt::ScrollBarAlwaysOff);
157     connect(m_page->mainFrame(), SIGNAL(titleChanged(const QString&)),
158             SLOT(titleChanged(const QString&)));
159     connect(m_page, SIGNAL(databaseQuotaExceeded(QWebFrame*,QString)),
160             this, SLOT(dumpDatabaseQuota(QWebFrame*,QString)));
161
162     m_eventSender = new EventSender(m_page);
163     m_textInputController = new TextInputController(m_page);
164     m_gcController = new GCController(m_page);
165
166     QObject::connect(this, SIGNAL(quit()), qApp, SLOT(quit()), Qt::QueuedConnection);
167     qt_drt_run(true);
168     QFocusEvent event(QEvent::FocusIn, Qt::ActiveWindowFocusReason);
169     QApplication::sendEvent(view, &event);
170 }
171
172 DumpRenderTree::~DumpRenderTree()
173 {
174     delete m_page;
175
176     delete m_stdin;
177     delete m_notifier;
178 }
179
180 void DumpRenderTree::open()
181 {
182     if (!m_stdin) {
183         m_stdin = new QFile;
184         m_stdin->open(stdin, QFile::ReadOnly);
185     }
186
187     if (!m_notifier) {
188         m_notifier = new QSocketNotifier(STDIN_FILENO, QSocketNotifier::Read);
189         connect(m_notifier, SIGNAL(activated(int)), this, SLOT(readStdin(int)));
190     }
191 }
192
193 void DumpRenderTree::open(const QUrl& url)
194 {
195     // W3C SVG tests expect to be 480x360
196     bool isW3CTest = url.toString().contains("svg/W3C-SVG-1.1");
197     int width = isW3CTest ? 480 : maxViewWidth;
198     int height = isW3CTest ? 360 : maxViewHeight;
199     m_page->view()->resize(QSize(width, height));
200     m_page->setFixedContentsSize(QSize());
201     m_page->setViewportSize(QSize(width, height));
202
203     // Reset so that any current loads are stopped
204     m_page->blockSignals(true);
205     m_page->triggerAction(QWebPage::Stop);
206     m_page->blockSignals(false);
207
208     resetJSObjects();
209
210     QFocusEvent ev(QEvent::FocusIn);
211     m_page->event(&ev);
212
213     QFontDatabase::removeAllApplicationFonts();
214 #if defined(Q_WS_X11)
215     initializeFonts();
216 #endif
217
218     qt_drt_clearFrameName(m_page->mainFrame());
219
220     qt_dump_frame_loader(url.toString().contains("loading/"));
221     m_page->mainFrame()->load(url);
222 }
223
224 void DumpRenderTree::readStdin(int /* socket */)
225 {
226     // Read incoming data from stdin...
227     QByteArray line = m_stdin->readLine();
228     if (line.endsWith('\n'))
229         line.truncate(line.size()-1);
230     //fprintf(stderr, "\n    opening %s\n", line.constData());
231     if (line.isEmpty())
232         quit();
233
234     if (line.startsWith("http:") || line.startsWith("https:"))
235         open(QUrl(line));
236     else {
237         QFileInfo fi(line);
238         open(QUrl::fromLocalFile(fi.absoluteFilePath()));
239     }
240
241     fflush(stdout);
242 }
243
244 void DumpRenderTree::resetJSObjects()
245 {
246     m_controller->reset();
247     foreach(QWidget *widget, windows)
248         delete widget;
249     windows.clear();
250 }
251
252 void DumpRenderTree::initJSObjects()
253 {
254     QWebFrame *frame = qobject_cast<QWebFrame*>(sender());
255     Q_ASSERT(frame);
256     frame->addToJavaScriptWindowObject(QLatin1String("layoutTestController"), m_controller);
257     frame->addToJavaScriptWindowObject(QLatin1String("eventSender"), m_eventSender);
258     frame->addToJavaScriptWindowObject(QLatin1String("textInputController"), m_textInputController);
259     frame->addToJavaScriptWindowObject(QLatin1String("GCController"), m_gcController);
260 }
261
262
263 QString DumpRenderTree::dumpFramesAsText(QWebFrame* frame)
264 {
265     if (!frame)
266         return QString();
267
268     QString result;
269     QWebFrame *parent = qobject_cast<QWebFrame *>(frame->parent());
270     if (parent) {
271         result.append(QLatin1String("\n--------\nFrame: '"));
272         result.append(frame->frameName());
273         result.append(QLatin1String("'\n--------\n"));
274     }
275
276     result.append(frame->toPlainText());
277     result.append(QLatin1String("\n"));
278
279     if (m_controller->shouldDumpChildrenAsText()) {
280         QList<QWebFrame *> children = frame->childFrames();
281         for (int i = 0; i < children.size(); ++i)
282             result += dumpFramesAsText(children.at(i));
283     }
284
285     return result;
286 }
287
288 QString DumpRenderTree::dumpBackForwardList()
289 {
290     QString result;
291     result.append(QLatin1String("\n============== Back Forward List ==============\n"));
292     result.append(QLatin1String("FIXME: Unimplemented!\n"));
293     result.append(QLatin1String("===============================================\n"));
294     return result;
295 }
296
297 void DumpRenderTree::dump()
298 {
299     QWebFrame *frame = m_page->mainFrame();
300
301     //fprintf(stderr, "    Dumping\n");
302     if (!m_notifier) {
303         // Dump markup in single file mode...
304         QString markup = frame->toHtml();
305         fprintf(stdout, "Source:\n\n%s\n", markup.toUtf8().constData());
306     }
307
308     // Dump render text...
309     QString renderDump;
310     if (m_controller->shouldDumpAsText()) {
311         renderDump = dumpFramesAsText(frame);
312     } else {
313         renderDump = frame->renderTreeDump();
314     }
315
316     if (m_controller->shouldDumpBackForwardList()) {
317         renderDump.append(dumpBackForwardList());
318     }
319
320     if (renderDump.isEmpty()) {
321         printf("ERROR: nil result from %s", m_controller->shouldDumpAsText() ? "[documentElement innerText]" : "[frame renderTreeAsExternalRepresentation]");
322     } else {
323         fprintf(stdout, "%s", renderDump.toUtf8().constData());
324     }
325
326     // signal end of text block
327     fprintf(stdout, "#EOF\n");
328
329     // Since pixel tests are currently unsupported by Qt's DRT,
330     // just signal an empty pixel test block to run-webkit-tests
331     fprintf(stdout, "#EOF\n");
332
333     fflush(stdout);
334
335     fprintf(stderr, "#EOF\n");
336
337     fflush(stderr);
338
339     if (!m_notifier) {
340         // Exit now in single file mode...
341         quit();
342     }
343 }
344
345 void DumpRenderTree::titleChanged(const QString &s)
346 {
347     if (m_controller->shouldDumpTitleChanges())
348         printf("TITLE CHANGED: %s\n", s.toUtf8().data());
349 }
350
351 void DumpRenderTree::connectFrame(QWebFrame *frame)
352 {
353     connect(frame, SIGNAL(javaScriptWindowObjectCleared()), this, SLOT(initJSObjects()));
354     connect(frame, SIGNAL(provisionalLoad()),
355             layoutTestController(), SLOT(provisionalLoad()));
356 }
357
358 void DumpRenderTree::dumpDatabaseQuota(QWebFrame* frame, const QString& dbName)
359 {
360     if (!m_controller->shouldDumpDatabaseCallbacks())
361         return;
362     QWebSecurityOrigin origin = frame->securityOrigin();
363     printf("UI DELEGATE DATABASE CALLBACK: exceededDatabaseQuotaForSecurityOrigin:{%s, %s, %i} database:%s\n",
364            origin.scheme().toUtf8().data(),
365            origin.host().toUtf8().data(),
366            origin.port(),
367            dbName.toUtf8().data());
368     origin.setDatabaseQuota(5 * 1024 * 1024);
369 }
370
371 QWebPage *DumpRenderTree::createWindow()
372 {
373     if (!m_controller->canOpenWindows())
374         return 0;
375     QWidget *container = new QWidget(0);
376     container->resize(0, 0);
377     container->move(-1, -1);
378     container->hide();
379     QWebPage *page = new WebPage(container, this);
380     connectFrame(page->mainFrame());
381     connect(m_page, SIGNAL(frameCreated(QWebFrame *)), this, SLOT(connectFrame(QWebFrame *)));
382     windows.append(container);
383     return page;
384 }
385
386 int DumpRenderTree::windowCount() const
387 {
388     int count = 0;
389     foreach(QWidget *w, windows) {
390         if (w->children().count())
391             ++count;
392     }
393     return count + 1;
394 }
395
396 #if defined(Q_WS_X11)
397 void DumpRenderTree::initializeFonts()
398 {
399     static int numFonts = -1;
400
401     // Some test cases may add or remove application fonts (via @font-face).
402     // Make sure to re-initialize the font set if necessary.
403     FcFontSet* appFontSet = FcConfigGetFonts(0, FcSetApplication);
404     if (appFontSet && numFonts >= 0 && appFontSet->nfont == numFonts)
405         return;
406
407     QByteArray fontDir = getenv("WEBKIT_TESTFONTS");
408     if (fontDir.isEmpty() || !QDir(fontDir).exists()) {
409         fprintf(stderr,
410                 "\n\n"
411                 "----------------------------------------------------------------------\n"
412                 "WEBKIT_TESTFONTS environment variable is not set correctly.\n"
413                 "This variable has to point to the directory containing the fonts\n"
414                 "you can clone from git://gitorious.org/qtwebkit/testfonts.git\n"
415                 "----------------------------------------------------------------------\n"
416                );
417         exit(1);
418     }
419     char currentPath[PATH_MAX+1];
420     getcwd(currentPath, PATH_MAX);
421     QByteArray configFile = currentPath;
422     FcConfig *config = FcConfigCreate();
423     configFile += "/WebKitTools/DumpRenderTree/qt/fonts.conf";
424     if (!FcConfigParseAndLoad (config, (FcChar8*) configFile.data(), true))
425         qFatal("Couldn't load font configuration file");
426     if (!FcConfigAppFontAddDir (config, (FcChar8*) fontDir.data()))
427         qFatal("Couldn't add font dir!");
428     FcConfigSetCurrent(config);
429
430     appFontSet = FcConfigGetFonts(config, FcSetApplication);
431     numFonts = appFontSet->nfont;
432 }
433 #endif
434
435 }
436
437 #include "DumpRenderTree.moc"