capybara-webkit/src/WebPage.h

#ifndef _WEBPAGE_H
#define _WEBPAGE_H
#include <QtGlobal>
#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)
#include <QtWebKitWidgets>
#else
#include <QtWebKit>
#endif
#include <QtNetwork>

class WebPageManager;
class InvocationResult;
class NetworkReplyProxy;
class QWebView;

class WebPage : public QWebPage {
  Q_OBJECT

  public:
    WebPage(WebPageManager *, QObject *parent = 0);
    InvocationResult invokeCapybaraFunction(const char *name, bool allowUnattached, const QStringList &arguments);
    InvocationResult invokeCapybaraFunction(QString &name, bool allowUnattached, const QStringList &arguments);
    QString failureString();
    QString userAgentForUrl(const QUrl &url ) const;
    void setUserAgent(QString userAgent);
    void setConfirmAction(QString action);
    QString setConfirmAction(QString action, QString message);
    QString setPromptAction(QString action, QString message, QString response);
    QString setPromptAction(QString action, QString message);
    void setPromptAction(QString action);
    void setPromptText(QString action);
    QString acceptAlert(QString);
    int getLastStatus();
    void setCustomNetworkAccessManager();
    bool render(const QString &fileName, const QSize &minimumSize);
    virtual bool extension (Extension extension, const ExtensionOption *option=0, ExtensionReturn *output=0);
    void setSkipImageLoading(bool skip);
    QVariantList consoleMessages();
    QVariantList alertMessages();
    QVariantList confirmMessages();
    QVariantList promptMessages();
    void createWindow();
    void resetLocalStorage();
    QWebPage *createWindow(WebWindowType type);
    QString uuid();
    QString getWindowName();
    bool matchesWindowSelector(QString);
    void setFocus();
    void unsupportedContentFinishedReply(QNetworkReply *reply);
    QVariantMap pageHeaders();
    QByteArray body();
    QString contentType();
    void mouseEvent(QEvent::Type type, const QPoint &position, Qt::MouseButton button, Qt::KeyboardModifiers modifiers = Qt::NoModifier);
    bool clickTest(QWebElement element, int absoluteX, int absoluteY);
    void resize(int, int);
    int modalCount();
    QString modalMessage();
    void setCurrentFrameParent(QWebFrame* frame);
    QWebFrame* currentFrameParent();

  public slots:
    bool shouldInterruptJavaScript();
    void injectJavascriptHelpers();
    void loadStarted();
    void loadFinished(bool);
    bool isLoading() const;
    void frameCreated(QWebFrame *);
    void handleSslErrorsForReply(QNetworkReply *reply, const QList<QSslError> &);
    void handleUnsupportedContent(QNetworkReply *reply);
    void replyFinished(QUrl &, QNetworkReply *);
    void remove();

  signals:
    void pageFinished(bool);
    void requestCreated(QByteArray &url, QNetworkReply *reply);
    void replyFinished(QNetworkReply *reply);
    void modalReady();

  protected:
    virtual void javaScriptConsoleMessage(const QString &message, int lineNumber, const QString &sourceID);
    virtual void javaScriptAlert(QWebFrame *frame, const QString &message);
    virtual bool javaScriptConfirm(QWebFrame *frame, const QString &message);
    virtual bool javaScriptPrompt(QWebFrame *frame, const QString &message, const QString &defaultValue, QString *result);
    virtual QString chooseFile(QWebFrame * parentFrame, const QString &suggestedFile);
    virtual bool supportsExtension(Extension extension) const;

  private:
    QString m_capybaraJavascript;
    QString m_userAgent;
    bool m_loading;
    bool m_failed;
    QStringList getAttachedFileNames();
    void loadJavascript();
    void setUserStylesheet();
    bool m_confirmAction;
    bool m_promptAction;
    QVariantList m_consoleMessages;
    QVariantList m_alertMessages;
    QVariantList m_confirmMessages;
    QString m_prompt_text;
    QVariantList m_promptMessages;
    QString m_uuid;
    WebPageManager *m_manager;
    QString m_errorPageMessage;
    void setFrameProperties(QWebFrame *, QUrl &, NetworkReplyProxy *);
    QPoint m_mousePosition;
    QList<QVariantMap> m_modalResponses;
    QStringList m_modalMessages;
    void addModalMessage(bool, const QString &, const QRegExp &);
    QWebFrame* m_currentFrameParent;
};

#endif //_WEBPAGE_H
First pass at within_window support 2012-03-26 22:41:33 +00:00			`#ifndef _WEBPAGE_H`
			`#define _WEBPAGE_H`
Include the code that we need - `cin` and `cout` require iostream. - `QT_VERSION` requires QtGlobal. - `QSocketNotifier` requires QSocketNotifier. - Unrelated to includes: let Qt figure out the spec. Found by Jeremy Evans on behalf of the OpenBSD project. 2015-03-26 17:33:28 +00:00			`#include <QtGlobal>`
QtWebKit renamed to QtWebKitWidgets 2013-01-07 03:05:41 +00:00			`#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)`
			`#include <QtWebKitWidgets>`
			`#else`
Initial commit 2011-02-19 03:53:06 +00:00			`#include <QtWebKit>`
QtWebKit renamed to QtWebKitWidgets 2013-01-07 03:05:41 +00:00			`#endif`
Include QtNetwork before using it * Fixes compile errors on arch Linux 2013-02-14 19:19:17 +00:00			`#include <QtNetwork>`
Initial commit 2011-02-19 03:53:06 +00:00
WebPageManager is no longer a singleton 2012-03-29 03:05:24 +00:00			`class WebPageManager;`
JavaScript error handling 2013-01-20 23:57:04 +00:00			`class InvocationResult;`
Driver#html returns raw data for non-HTML content The behavior of QWebFrame::toPlainText is undefined if the content contains non-Latin1 characters. In Qt 5, additional MIME types are considered supported, so there's no way to get at the raw data when unsupported content has been loaded. Instead, proxy network replies through NetworkReplyProxy which provides repetitive reads. 2012-11-18 07:48:12 +00:00			`class NetworkReplyProxy;`
Update for Capybara 2.3.0 This adds support for the full Capybara 2.3.0 API. There are two known incompatibilities: * Selenium supports outerWidth and outerHeight, which we cannot, because we dont' have an actual OS window. * Selenium raises errors after interacting with a closed window. We focus the next available window after closing. This commit adds the following: * Implement Driver#close_window * Implement Driver#current_window_handle * Implement Driver#maximize_window * Implement Driver#open_new_window * Implement Driver#no_such_window_error * Implement Driver#resize_window_to * Implement Driver#switch_to_window * Implement Driver#window_size * Implement Driver#go_back * Implement Driver#go_forward * Support change events when clearing a text input * Support setting contentEditable elements * Support window.close() in JavaScript * Don't return text from hidden elements * Skip Capybara specs which use outerWidth, outerHeight * Don't use Qt object ownership to manage windows 2014-06-18 22:00:34 +00:00			`class QWebView;`
WebPageManager is no longer a singleton 2012-03-29 03:05:24 +00:00
Initial commit 2011-02-19 03:53:06 +00:00			`class WebPage : public QWebPage {`
			`Q_OBJECT`

			`public:`
WebPageManager is no longer a singleton 2012-03-29 03:05:24 +00:00			`WebPage(WebPageManager , QObject parent = 0);`
Check node index atomically to prevent race condition Fixes Capybara::Webkit::InvalidResponseError when nodes are missing. 2013-12-06 15:43:17 +00:00			`InvocationResult invokeCapybaraFunction(const char *name, bool allowUnattached, const QStringList &arguments);`
			`InvocationResult invokeCapybaraFunction(QString &name, bool allowUnattached, const QStringList &arguments);`
Don't create a command until all arguments are received; don't start the next command if a page is still loading 2011-03-09 05:08:30 +00:00			`QString failureString();`
add header support 2011-06-08 09:36:45 +00:00			`QString userAgentForUrl(const QUrl &url ) const;`
fix spell move header specs to driver_spec 2011-06-25 11:31:19 +00:00			`void setUserAgent(QString userAgent);`
Control JavaScript confirmation dialogs from Ruby Adds #alert_messages, #confirm_messages, #prompt_messages, #accept_js_confirms!, #dismiss_js_confirms, #accept_js_prompts!, #dismiss_js_prompts, and #js_prompt_input= . 2012-07-10 13:47:17 +00:00			`void setConfirmAction(QString action);`
Implement modal (confirm, prompt and alert) API * Retain backwards compatibility with legacy capybara-webkit API. * Confirm dialogs are accepted by default; dialogs are dismissed. * Legacy API overrides the default action, and does not raise errors for unexpected modals. 2014-07-03 22:21:21 +00:00			`QString setConfirmAction(QString action, QString message);`
			`QString setPromptAction(QString action, QString message, QString response);`
			`QString setPromptAction(QString action, QString message);`
Control JavaScript confirmation dialogs from Ruby Adds #alert_messages, #confirm_messages, #prompt_messages, #accept_js_confirms!, #dismiss_js_confirms, #accept_js_prompts!, #dismiss_js_prompts, and #js_prompt_input= . 2012-07-10 13:47:17 +00:00			`void setPromptAction(QString action);`
			`void setPromptText(QString action);`
Implement modal (confirm, prompt and alert) API * Retain backwards compatibility with legacy capybara-webkit API. * Confirm dialogs are accepted by default; dialogs are dismissed. * Legacy API overrides the default action, and does not raise errors for unexpected modals. 2014-07-03 22:21:21 +00:00			`QString acceptAlert(QString);`
Status codes 2011-08-12 20:50:43 +00:00			`int getLastStatus();`
reset status code 2011-08-23 15:18:08 +00:00			`void setCustomNetworkAccessManager();`
Restore viewport dimensions after rendering screenshots Fixes #388. 2013-01-13 22:19:46 +00:00			`bool render(const QString &fileName, const QSize &minimumSize);`
support attaching file to HTML5 input with multiple attribute 2011-07-20 19:58:23 +00:00			`virtual bool extension (Extension extension, const ExtensionOption option=0, ExtensionReturn output=0);`
Add option to disable image loading in WebKit. 2012-03-30 01:38:34 +00:00			`void setSkipImageLoading(bool skip);`
Serialize console messsages using JsonSerializer 2012-12-30 01:48:15 +00:00			`QVariantList consoleMessages();`
Support multi-line alert messages 2012-12-30 19:41:23 +00:00			`QVariantList alertMessages();`
Support multi-line confirmation messages 2012-12-30 19:28:45 +00:00			`QVariantList confirmMessages();`
Support multi-line prompt messages 2012-12-30 20:04:44 +00:00			`QVariantList promptMessages();`
Update for Capybara 2.3.0 This adds support for the full Capybara 2.3.0 API. There are two known incompatibilities: * Selenium supports outerWidth and outerHeight, which we cannot, because we dont' have an actual OS window. * Selenium raises errors after interacting with a closed window. We focus the next available window after closing. This commit adds the following: * Implement Driver#close_window * Implement Driver#current_window_handle * Implement Driver#maximize_window * Implement Driver#open_new_window * Implement Driver#no_such_window_error * Implement Driver#resize_window_to * Implement Driver#switch_to_window * Implement Driver#window_size * Implement Driver#go_back * Implement Driver#go_forward * Support change events when clearing a text input * Support setting contentEditable elements * Support window.close() in JavaScript * Don't return text from hidden elements * Skip Capybara specs which use outerWidth, outerHeight * Don't use Qt object ownership to manage windows 2014-06-18 22:00:34 +00:00			`void createWindow();`
Clear localStorage on reset! 2013-04-26 03:00:21 +00:00			`void resetLocalStorage();`
First pass at within_window support 2012-03-26 22:41:33 +00:00			`QWebPage *createWindow(WebWindowType type);`
Implement window_handles and window_handle for proper window switching 2012-03-27 22:49:57 +00:00			`QString uuid();`
Find window by name, title or URL 2012-03-28 15:46:07 +00:00			`QString getWindowName();`
Move window selection logic into WebPage 2012-03-28 19:20:32 +00:00			`bool matchesWindowSelector(QString);`
Pass the WebPageManager to each command 2012-04-04 22:18:17 +00:00			`void setFocus();`
Don't wait for finished replies Synchronous requests will have emitted the finished signal by the time we connect to it. 2012-12-04 03:47:10 +00:00			`void unsupportedContentFinishedReply(QNetworkReply *reply);`
Allow response header value to contain a colon HTTP response header field values are allowed to contain separators (which includes the colon) as long as they appear within quotes (http://www.w3.org/Protocols/rfc2616/rfc2616-sec2.html#sec2.2). This commit enables `Browser#response_headers` to handle a field value that contains a colon followed by a space (i.e., ": ") without breaking. 2015-02-08 23:09:55 +00:00			`QVariantMap pageHeaders();`
Driver#html returns raw data for non-HTML content The behavior of QWebFrame::toPlainText is undefined if the content contains non-Latin1 characters. In Qt 5, additional MIME types are considered supported, so there's no way to get at the raw data when unsupported content has been loaded. Instead, proxy network replies through NetworkReplyProxy which provides repetitive reads. 2012-11-18 07:48:12 +00:00			`QByteArray body();`
			`QString contentType();`
Add support for keys and offset with mouse clicks coming in Capybara 3 2018-01-06 20:26:31 +00:00			`void mouseEvent(QEvent::Type type, const QPoint &position, Qt::MouseButton button, Qt::KeyboardModifiers modifiers = Qt::NoModifier);`
Render a mouse pointer when saving screenshots * Helpful for ClickFailed errors 2013-11-09 20:12:16 +00:00			`bool clickTest(QWebElement element, int absoluteX, int absoluteY);`
Update for Capybara 2.3.0 This adds support for the full Capybara 2.3.0 API. There are two known incompatibilities: * Selenium supports outerWidth and outerHeight, which we cannot, because we dont' have an actual OS window. * Selenium raises errors after interacting with a closed window. We focus the next available window after closing. This commit adds the following: * Implement Driver#close_window * Implement Driver#current_window_handle * Implement Driver#maximize_window * Implement Driver#open_new_window * Implement Driver#no_such_window_error * Implement Driver#resize_window_to * Implement Driver#switch_to_window * Implement Driver#window_size * Implement Driver#go_back * Implement Driver#go_forward * Support change events when clearing a text input * Support setting contentEditable elements * Support window.close() in JavaScript * Don't return text from hidden elements * Skip Capybara specs which use outerWidth, outerHeight * Don't use Qt object ownership to manage windows 2014-06-18 22:00:34 +00:00			`void resize(int, int);`
Implement modal (confirm, prompt and alert) API * Retain backwards compatibility with legacy capybara-webkit API. * Confirm dialogs are accepted by default; dialogs are dismissed. * Legacy API overrides the default action, and does not raise errors for unexpected modals. 2014-07-03 22:21:21 +00:00			`int modalCount();`
Remove modal messages from modal message list * When multiple, non-nested modals are on a page, the modal ID will not point to the index of the corresponding modal message in the modal message list. 2014-10-03 02:47:43 +00:00			`QString modalMessage();`
Support Capybara 2.11 * Update versions being tested against * Implement missing APIs from newer versions 2017-01-04 00:33:42 +00:00			`void setCurrentFrameParent(QWebFrame* frame);`
			`QWebFrame* currentFrameParent();`
Initial commit 2011-02-19 03:53:06 +00:00
			`public slots:`
			`bool shouldInterruptJavaScript();`
Moved Javascript code into a .js file that gets loaded into each page 2011-02-26 03:32:22 +00:00			`void injectJavascriptHelpers();`
Don't create a command until all arguments are received; don't start the next command if a page is still loading 2011-03-09 05:08:30 +00:00			`void loadStarted();`
			`void loadFinished(bool);`
			`bool isLoading() const;`
Working on frame handling. In terms of the QT code, the non-frame-related specs pass with these changes (e.g. mainFrame() => currentFrame() and the new injectJavascriptHelpers() code in WebPage.cpp). It seems like the current JS+xpath implementation dives in to iframes already. Is this desired behavior? I wonder if that works with x-domain iframes? I doubt it... Also, this design assumes that we only step one frame down at a time... Lastly, I'm really not sure how QWebKit decides which frame is currentFrame(). For now, I'm hoping to be able to use the QWebFrame setFocus() method. This may be a dead end though. We may have to have WebPage manually keep track of the "current" frame. 2011-04-19 07:16:25 +00:00			`void frameCreated(QWebFrame *);`
Switch ignore ssl from a command-line flag to a server command 2012-05-04 17:56:21 +00:00			`void handleSslErrorsForReply(QNetworkReply *reply, const QList<QSslError> &);`
Handle unsupported content types gracefully 2011-09-15 15:22:10 +00:00			`void handleUnsupportedContent(QNetworkReply *reply);`
Driver#html returns raw data for non-HTML content The behavior of QWebFrame::toPlainText is undefined if the content contains non-Latin1 characters. In Qt 5, additional MIME types are considered supported, so there's no way to get at the raw data when unsupported content has been loaded. Instead, proxy network replies through NetworkReplyProxy which provides repetitive reads. 2012-11-18 07:48:12 +00:00			`void replyFinished(QUrl &, QNetworkReply *);`
Update for Capybara 2.3.0 This adds support for the full Capybara 2.3.0 API. There are two known incompatibilities: * Selenium supports outerWidth and outerHeight, which we cannot, because we dont' have an actual OS window. * Selenium raises errors after interacting with a closed window. We focus the next available window after closing. This commit adds the following: * Implement Driver#close_window * Implement Driver#current_window_handle * Implement Driver#maximize_window * Implement Driver#open_new_window * Implement Driver#no_such_window_error * Implement Driver#resize_window_to * Implement Driver#switch_to_window * Implement Driver#window_size * Implement Driver#go_back * Implement Driver#go_forward * Support change events when clearing a text input * Support setting contentEditable elements * Support window.close() in JavaScript * Don't return text from hidden elements * Skip Capybara specs which use outerWidth, outerHeight * Don't use Qt object ownership to manage windows 2014-06-18 22:00:34 +00:00			`void remove();`
Handle unsupported content types gracefully 2011-09-15 15:22:10 +00:00
			`signals:`
			`void pageFinished(bool);`
Fix issues with Qt 4.8 2012-07-12 03:36:22 +00:00			`void requestCreated(QByteArray &url, QNetworkReply *reply);`
Setup multi-window sync. 2012-06-29 14:41:08 +00:00			`void replyFinished(QNetworkReply *reply);`
Remove modal messages from modal message list * When multiple, non-nested modals are on a page, the modal ID will not point to the index of the corresponding modal message in the modal message list. 2014-10-03 02:47:43 +00:00			`void modalReady();`
Moved Javascript code into a .js file that gets loaded into each page 2011-02-26 03:32:22 +00:00
Implement Driver#evaluateScript 2011-02-26 18:02:43 +00:00			`protected:`
			`virtual void javaScriptConsoleMessage(const QString &message, int lineNumber, const QString &sourceID);`
Fixed alert/confirm/prompt crashing the page 2011-03-11 17:07:30 +00:00			`virtual void javaScriptAlert(QWebFrame *frame, const QString &message);`
			`virtual bool javaScriptConfirm(QWebFrame *frame, const QString &message);`
			`virtual bool javaScriptPrompt(QWebFrame frame, const QString &message, const QString &defaultValue, QString result);`
allow uploading files with forms 2011-07-18 21:16:57 +00:00			`virtual QString chooseFile(QWebFrame * parentFrame, const QString &suggestedFile);`
Add error message detail for page load failure. This makes it easier to debug "Unable to load URL" errors. 2012-04-04 01:27:41 +00:00			`virtual bool supportsExtension(Extension extension) const;`
Implement Driver#evaluateScript 2011-02-26 18:02:43 +00:00
Moved Javascript code into a .js file that gets loaded into each page 2011-02-26 03:32:22 +00:00			`private:`
			`QString m_capybaraJavascript;`
fix spell move header specs to driver_spec 2011-06-25 11:31:19 +00:00			`QString m_userAgent;`
Don't create a command until all arguments are received; don't start the next command if a page is still loading 2011-03-09 05:08:30 +00:00			`bool m_loading;`
Treat fewer responses as fatal failures * Relies on errorExtension instead of loadFinished * Ignores errors from canceled requests 2012-07-11 03:03:32 +00:00			`bool m_failed;`
Implement HTML5 multiple file upload 2012-11-18 07:48:24 +00:00			`QStringList getAttachedFileNames();`
Extract method 2011-08-12 19:49:40 +00:00			`void loadJavascript();`
Override custom fonts, since some of them crash QtWebkit on OS X 2011-08-12 19:26:26 +00:00			`void setUserStylesheet();`
Implement modal (confirm, prompt and alert) API * Retain backwards compatibility with legacy capybara-webkit API. * Confirm dialogs are accepted by default; dialogs are dismissed. * Legacy API overrides the default action, and does not raise errors for unexpected modals. 2014-07-03 22:21:21 +00:00			`bool m_confirmAction;`
			`bool m_promptAction;`
Serialize console messsages using JsonSerializer 2012-12-30 01:48:15 +00:00			`QVariantList m_consoleMessages;`
Support multi-line alert messages 2012-12-30 19:41:23 +00:00			`QVariantList m_alertMessages;`
Support multi-line confirmation messages 2012-12-30 19:28:45 +00:00			`QVariantList m_confirmMessages;`
Control JavaScript confirmation dialogs from Ruby Adds #alert_messages, #confirm_messages, #prompt_messages, #accept_js_confirms!, #dismiss_js_confirms, #accept_js_prompts!, #dismiss_js_prompts, and #js_prompt_input= . 2012-07-10 13:47:17 +00:00			`QString m_prompt_text;`
Support multi-line prompt messages 2012-12-30 20:04:44 +00:00			`QVariantList m_promptMessages;`
Implement window_handles and window_handle for proper window switching 2012-03-27 22:49:57 +00:00			`QString m_uuid;`
WebPageManager is no longer a singleton 2012-03-29 03:05:24 +00:00			`WebPageManager *m_manager;`
Add error message detail for page load failure. This makes it easier to debug "Unable to load URL" errors. 2012-04-04 01:27:41 +00:00			`QString m_errorPageMessage;`
Driver#html returns raw data for non-HTML content The behavior of QWebFrame::toPlainText is undefined if the content contains non-Latin1 characters. In Qt 5, additional MIME types are considered supported, so there's no way to get at the raw data when unsupported content has been loaded. Instead, proxy network replies through NetworkReplyProxy which provides repetitive reads. 2012-11-18 07:48:12 +00:00			`void setFrameProperties(QWebFrame , QUrl &, NetworkReplyProxy );`
Render a mouse pointer when saving screenshots * Helpful for ClickFailed errors 2013-11-09 20:12:16 +00:00			`QPoint m_mousePosition;`
Implement modal (confirm, prompt and alert) API * Retain backwards compatibility with legacy capybara-webkit API. * Confirm dialogs are accepted by default; dialogs are dismissed. * Legacy API overrides the default action, and does not raise errors for unexpected modals. 2014-07-03 22:21:21 +00:00			`QList<QVariantMap> m_modalResponses;`
			`QStringList m_modalMessages;`
			`void addModalMessage(bool, const QString &, const QRegExp &);`
Support Capybara 2.11 * Update versions being tested against * Implement missing APIs from newer versions 2017-01-04 00:33:42 +00:00			`QWebFrame* m_currentFrameParent;`
Initial commit 2011-02-19 03:53:06 +00:00			`};`

First pass at within_window support 2012-03-26 22:41:33 +00:00			`#endif //_WEBPAGE_H`