2009-07-13 Simon Hausmann <hausmann@webkit.org>
[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     connect(this, SIGNAL(geometryChangeRequested(const QRect &)),
105             this, SLOT(setViewGeometry(const QRect & )));
106
107     setPluginFactory(new TestPlugin(this));
108 }
109
110 QWebPage *WebPage::createWindow(QWebPage::WebWindowType)
111 {
112     return m_drt->createWindow();
113 }
114
115 void WebPage::javaScriptAlert(QWebFrame*, const QString& message)
116 {
117     fprintf(stdout, "ALERT: %s\n", message.toUtf8().constData());
118 }
119
120 void WebPage::javaScriptConsoleMessage(const QString& message, int lineNumber, const QString&)
121 {
122     fprintf (stdout, "CONSOLE MESSAGE: line %d: %s\n", lineNumber, message.toUtf8().constData());
123 }
124
125 bool WebPage::javaScriptConfirm(QWebFrame*, const QString& msg)
126 {
127     fprintf(stdout, "CONFIRM: %s\n", msg.toUtf8().constData());
128     return true;
129 }
130
131 bool WebPage::javaScriptPrompt(QWebFrame*, const QString& msg, const QString& defaultValue, QString* result)
132 {
133     fprintf(stdout, "PROMPT: %s, default text: %s\n", msg.toUtf8().constData(), defaultValue.toUtf8().constData());
134     *result = defaultValue;
135     return true;
136 }
137
138 DumpRenderTree::DumpRenderTree()
139     : m_stdin(0)
140     , m_notifier(0)
141 {
142     m_controller = new LayoutTestController(this);
143     connect(m_controller, SIGNAL(done()), this, SLOT(dump()));
144
145     QWebView *view = new QWebView(0);
146     view->resize(QSize(maxViewWidth, maxViewHeight));
147     m_page = new WebPage(view, this);
148     view->setPage(m_page);
149     connect(m_page, SIGNAL(frameCreated(QWebFrame *)), this, SLOT(connectFrame(QWebFrame *)));
150     connectFrame(m_page->mainFrame());
151
152     connect(m_page->mainFrame(), SIGNAL(loadFinished(bool)), m_controller, SLOT(maybeDump(bool)));
153
154     m_page->mainFrame()->setScrollBarPolicy(Qt::Horizontal, Qt::ScrollBarAlwaysOff);
155     m_page->mainFrame()->setScrollBarPolicy(Qt::Vertical, Qt::ScrollBarAlwaysOff);
156     connect(m_page->mainFrame(), SIGNAL(titleChanged(const QString&)),
157             SLOT(titleChanged(const QString&)));
158     connect(m_page, SIGNAL(databaseQuotaExceeded(QWebFrame*,QString)),
159             this, SLOT(dumpDatabaseQuota(QWebFrame*,QString)));
160
161     m_eventSender = new EventSender(m_page);
162     m_textInputController = new TextInputController(m_page);
163     m_gcController = new GCController(m_page);
164
165     QObject::connect(this, SIGNAL(quit()), qApp, SLOT(quit()), Qt::QueuedConnection);
166     qt_drt_run(true);
167     QFocusEvent event(QEvent::FocusIn, Qt::ActiveWindowFocusReason);
168     QApplication::sendEvent(view, &event);
169 }
170
171 DumpRenderTree::~DumpRenderTree()
172 {
173     delete m_page;
174
175     delete m_stdin;
176     delete m_notifier;
177 }
178
179 void DumpRenderTree::open()
180 {
181     if (!m_stdin) {
182         m_stdin = new QFile;
183         m_stdin->open(stdin, QFile::ReadOnly);
184     }
185
186     if (!m_notifier) {
187         m_notifier = new QSocketNotifier(STDIN_FILENO, QSocketNotifier::Read);
188         connect(m_notifier, SIGNAL(activated(int)), this, SLOT(readStdin(int)));
189     }
190 }
191
192 void DumpRenderTree::open(const QUrl& url)
193 {
194     // W3C SVG tests expect to be 480x360
195     bool isW3CTest = url.toString().contains("svg/W3C-SVG-1.1");
196     int width = isW3CTest ? 480 : maxViewWidth;
197     int height = isW3CTest ? 360 : maxViewHeight;
198     m_page->view()->resize(QSize(width, height));
199     m_page->setFixedContentsSize(QSize());
200     m_page->setViewportSize(QSize(width, height));
201
202     // Reset so that any current loads are stopped
203     m_page->blockSignals(true);
204     m_page->triggerAction(QWebPage::Stop);
205     m_page->blockSignals(false);
206
207     resetJSObjects();
208
209     QFocusEvent ev(QEvent::FocusIn);
210     m_page->event(&ev);
211
212     QFontDatabase::removeAllApplicationFonts();
213 #if defined(Q_WS_X11)
214     initializeFonts();
215 #endif
216
217     qt_drt_clearFrameName(m_page->mainFrame());
218
219     qt_dump_frame_loader(url.toString().contains("loading/"));
220     m_page->mainFrame()->load(url);
221 }
222
223 void DumpRenderTree::readStdin(int /* socket */)
224 {
225     // Read incoming data from stdin...
226     QByteArray line = m_stdin->readLine();
227     if (line.endsWith('\n'))
228         line.truncate(line.size()-1);
229     //fprintf(stderr, "\n    opening %s\n", line.constData());
230     if (line.isEmpty())
231         quit();
232
233     if (line.startsWith("http:") || line.startsWith("https:"))
234         open(QUrl(line));
235     else {
236         QFileInfo fi(line);
237         open(QUrl::fromLocalFile(fi.absoluteFilePath()));
238     }
239
240     fflush(stdout);
241 }
242
243 void DumpRenderTree::resetJSObjects()
244 {
245     m_controller->reset();
246     foreach(QWidget *widget, windows)
247         delete widget;
248     windows.clear();
249 }
250
251 void DumpRenderTree::initJSObjects()
252 {
253     QWebFrame *frame = qobject_cast<QWebFrame*>(sender());
254     Q_ASSERT(frame);
255     frame->addToJavaScriptWindowObject(QLatin1String("layoutTestController"), m_controller);
256     frame->addToJavaScriptWindowObject(QLatin1String("eventSender"), m_eventSender);
257     frame->addToJavaScriptWindowObject(QLatin1String("textInputController"), m_textInputController);
258     frame->addToJavaScriptWindowObject(QLatin1String("GCController"), m_gcController);
259 }
260
261
262 QString DumpRenderTree::dumpFramesAsText(QWebFrame* frame)
263 {
264     if (!frame)
265         return QString();
266
267     QString result;
268     QWebFrame *parent = qobject_cast<QWebFrame *>(frame->parent());
269     if (parent) {
270         result.append(QLatin1String("\n--------\nFrame: '"));
271         result.append(frame->frameName());
272         result.append(QLatin1String("'\n--------\n"));
273     }
274
275     result.append(frame->toPlainText());
276     result.append(QLatin1String("\n"));
277
278     if (m_controller->shouldDumpChildrenAsText()) {
279         QList<QWebFrame *> children = frame->childFrames();
280         for (int i = 0; i < children.size(); ++i)
281             result += dumpFramesAsText(children.at(i));
282     }
283
284     return result;
285 }
286
287 QString DumpRenderTree::dumpBackForwardList()
288 {
289     QString result;
290     result.append(QLatin1String("\n============== Back Forward List ==============\n"));
291     result.append(QLatin1String("FIXME: Unimplemented!\n"));
292     result.append(QLatin1String("===============================================\n"));
293     return result;
294 }
295
296 void DumpRenderTree::dump()
297 {
298     QWebFrame *frame = m_page->mainFrame();
299
300     //fprintf(stderr, "    Dumping\n");
301     if (!m_notifier) {
302         // Dump markup in single file mode...
303         QString markup = frame->toHtml();
304         fprintf(stdout, "Source:\n\n%s\n", markup.toUtf8().constData());
305     }
306
307     // Dump render text...
308     QString renderDump;
309     if (m_controller->shouldDumpAsText()) {
310         renderDump = dumpFramesAsText(frame);
311     } else {
312         renderDump = frame->renderTreeDump();
313     }
314
315     if (m_controller->shouldDumpBackForwardList()) {
316         renderDump.append(dumpBackForwardList());
317     }
318
319     if (renderDump.isEmpty()) {
320         printf("ERROR: nil result from %s", m_controller->shouldDumpAsText() ? "[documentElement innerText]" : "[frame renderTreeAsExternalRepresentation]");
321     } else {
322         fprintf(stdout, "%s", renderDump.toUtf8().constData());
323     }
324
325     // signal end of text block
326     fprintf(stdout, "#EOF\n");
327
328     // Since pixel tests are currently unsupported by Qt's DRT,
329     // just signal an empty pixel test block to run-webkit-tests
330     fprintf(stdout, "#EOF\n");
331
332     fflush(stdout);
333
334     fprintf(stderr, "#EOF\n");
335
336     fflush(stderr);
337
338     if (!m_notifier) {
339         // Exit now in single file mode...
340         quit();
341     }
342 }
343
344 void DumpRenderTree::titleChanged(const QString &s)
345 {
346     if (m_controller->shouldDumpTitleChanges())
347         printf("TITLE CHANGED: %s\n", s.toUtf8().data());
348 }
349
350 void DumpRenderTree::connectFrame(QWebFrame *frame)
351 {
352     connect(frame, SIGNAL(javaScriptWindowObjectCleared()), this, SLOT(initJSObjects()));
353     connect(frame, SIGNAL(provisionalLoad()),
354             layoutTestController(), SLOT(provisionalLoad()));
355 }
356
357 void DumpRenderTree::dumpDatabaseQuota(QWebFrame* frame, const QString& dbName)
358 {
359     if (!m_controller->shouldDumpDatabaseCallbacks())
360         return;
361     QWebSecurityOrigin origin = frame->securityOrigin();
362     printf("UI DELEGATE DATABASE CALLBACK: exceededDatabaseQuotaForSecurityOrigin:{%s, %s, %i} database:%s\n",
363            origin.scheme().toUtf8().data(),
364            origin.host().toUtf8().data(),
365            origin.port(),
366            dbName.toUtf8().data());
367     origin.setDatabaseQuota(5 * 1024 * 1024);
368 }
369
370 QWebPage *DumpRenderTree::createWindow()
371 {
372     if (!m_controller->canOpenWindows())
373         return 0;
374     QWidget *container = new QWidget(0);
375     container->resize(0, 0);
376     container->move(-1, -1);
377     container->hide();
378     QWebPage *page = new WebPage(container, this);
379     connectFrame(page->mainFrame());
380     connect(m_page, SIGNAL(frameCreated(QWebFrame *)), this, SLOT(connectFrame(QWebFrame *)));
381     windows.append(container);
382     return page;
383 }
384
385 int DumpRenderTree::windowCount() const
386 {
387     int count = 0;
388     foreach(QWidget *w, windows) {
389         if (w->children().count())
390             ++count;
391     }
392     return count + 1;
393 }
394
395 #if defined(Q_WS_X11)
396 void DumpRenderTree::initializeFonts()
397 {
398     static int numFonts = -1;
399
400     // Some test cases may add or remove application fonts (via @font-face).
401     // Make sure to re-initialize the font set if necessary.
402     FcFontSet* appFontSet = FcConfigGetFonts(0, FcSetApplication);
403     if (appFontSet && numFonts >= 0 && appFontSet->nfont == numFonts)
404         return;
405
406     QByteArray fontDir = getenv("WEBKIT_TESTFONTS");
407     if (fontDir.isEmpty() || !QDir(fontDir).exists()) {
408         fprintf(stderr,
409                 "\n\n"
410                 "----------------------------------------------------------------------\n"
411                 "WEBKIT_TESTFONTS environment variable is not set correctly.\n"
412                 "This variable has to point to the directory containing the fonts\n"
413                 "you can clone from git://gitorious.org/qtwebkit/testfonts.git\n"
414                 "----------------------------------------------------------------------\n"
415                );
416         exit(1);
417     }
418     char currentPath[PATH_MAX+1];
419     getcwd(currentPath, PATH_MAX);
420     QByteArray configFile = currentPath;
421     FcConfig *config = FcConfigCreate();
422     configFile += "/WebKitTools/DumpRenderTree/qt/fonts.conf";
423     if (!FcConfigParseAndLoad (config, (FcChar8*) configFile.data(), true))
424         qFatal("Couldn't load font configuration file");
425     if (!FcConfigAppFontAddDir (config, (FcChar8*) fontDir.data()))
426         qFatal("Couldn't add font dir!");
427     FcConfigSetCurrent(config);
428
429     appFontSet = FcConfigGetFonts(config, FcSetApplication);
430     numFonts = appFontSet->nfont;
431 }
432 #endif
433
434 }
435
436 #include "DumpRenderTree.moc"