capybara-webkit/src/WebPageManager.h

#ifndef _WEBPAGEMANAGER_H
#define _WEBPAGEMANAGER_H
#include <QList>
#include <QSet>
#include <QObject>
#include <QNetworkReply>
#include <QDebug>
#include <QFile>

#include "UnknownUrlHandler.h"

class WebPage;
class NetworkCookieJar;
class NetworkAccessManager;
class BlacklistedRequestHandler;
class CustomHeadersRequestHandler;

class WebPageManager : public QObject {
  Q_OBJECT

  public:
    WebPageManager(QObject *parent = 0);
    void append(WebPage *value);
    QList<WebPage *> pages() const;
    void setCurrentPage(WebPage *);
    WebPage *currentPage() const;
    WebPage *createPage();
    void removePage(WebPage *);
    void setIgnoreSslErrors(bool);
    bool ignoreSslErrors();
    void setTimeout(int);
    int getTimeout();
    void reset();
    NetworkCookieJar *cookieJar();
    bool isLoading() const;
    QDebug logger() const;
    void enableLogging();
    void replyFinished(QNetworkReply *reply);
    NetworkAccessManager *networkAccessManager();
    void setUrlBlacklist(const QStringList &);
    void addHeader(QString, QString);
    void setUnknownUrlMode(UnknownUrlHandler::Mode);
    void allowUrl(const QString &);
    void blockUrl(const QString &);

  public slots:
    void emitLoadStarted();
    void setPageStatus(bool);
    void requestCreated(QByteArray &url, QNetworkReply *reply);
    void handleReplyFinished();
    void replyDestroyed(QObject *);

  signals:
    void pageFinished(bool);
    void loadStarted();

  private:
    void emitPageFinished();
    static void handleDebugMessage(QtMsgType type, const char *message);
    void initOfflineWebApplicationCache();

    QList<WebPage *> m_pages;
    QList<QNetworkReply *> m_pendingReplies;
    WebPage *m_currentPage;
    bool m_ignoreSslErrors;
    NetworkCookieJar *m_cookieJar;
    QSet<WebPage *> m_started;
    bool m_success;
    bool m_loggingEnabled;
    bool m_isCacheInitialized;
    QFile *m_ignoredOutput;
    int m_timeout;
    NetworkAccessManager *m_networkAccessManager;
    BlacklistedRequestHandler *m_blacklistedRequestHandler;
    CustomHeadersRequestHandler *m_customHeadersRequestHandler;
    UnknownUrlHandler *m_unknownUrlHandler;
};

#endif // _WEBPAGEMANAGER_H
Implement window_handles and window_handle for proper window switching 2012-03-27 18:49:57 -04:00			`#ifndef _WEBPAGEMANAGER_H`
			`#define _WEBPAGEMANAGER_H`
First pass at within_window support 2012-03-26 18:41:33 -04:00			`#include <QList>`
Setup multi-window sync. 2012-06-29 10:41:08 -04:00			`#include <QSet>`
WebPageManager is no longer a singleton 2012-03-28 23:05:24 -04:00			`#include <QObject>`
Setup multi-window sync. 2012-06-29 10:41:08 -04:00			`#include <QNetworkReply>`
Command to enable a more useful debug log 2012-06-29 12:14:22 -04:00			`#include <QDebug>`
			`#include <QFile>`
WebPageManager is no longer a singleton 2012-03-28 23:05:24 -04:00
Introduce allowed, blocked URL filters * Adds `allow_url`, `block_url`, and `block_unknown_url` methods. * Both allow_url and block_url accept wildcards. * Any requests to blocked URLs will be blocked immediately. * Blocked URLs take precedence over allowed URLs. * By default, any requests to localhost and 127.0.0.1 are allowed. * By default, any requests to unknown hosts will print a warning. * `block_unknown_urls` causes unknown hosts to be silently blocked. * `blacklisted_urls=` is deprecated in favor of `block_url`. 2014-11-14 14:55:14 -05:00			`#include "UnknownUrlHandler.h"`

WebPageManager is no longer a singleton 2012-03-28 23:05:24 -04:00			`class WebPage;`
Shared cookie jar for all windows 2012-06-21 23:34:51 -04:00			`class NetworkCookieJar;`
Share the NetworkAccessManager across WebPages Destroying the NetworkAccessManager seems to result in "terminate called without an active exception" segfaults. The documentation states that an application requires only a single single NetworkAccessManager. 2013-03-18 08:11:59 -04:00			`class NetworkAccessManager;`
Extract handle classes from NetworkAccessManager NetworkAccessManager was getting pretty complex, and adding something that modifies or intercepts requests is becoming a common change. This change introduces a chain of handlers which can modify a request or return a response of their own. To start with, this extracts the concerns of fixing missing content types, setting custom headers, and intercepting blacklisted requests. 2014-11-24 09:52:34 -05:00			`class BlacklistedRequestHandler;`
			`class CustomHeadersRequestHandler;`
First pass at within_window support 2012-03-26 18:41:33 -04:00
Move window change handling into WebPageManager 2012-04-04 15:40:18 -04:00			`class WebPageManager : public QObject {`
			`Q_OBJECT`

First pass at within_window support 2012-03-26 18:41:33 -04:00			`public:`
Move window change handling into WebPageManager 2012-04-04 15:40:18 -04:00			`WebPageManager(QObject *parent = 0);`
First pass at within_window support 2012-03-26 18:41:33 -04:00			`void append(WebPage *value);`
Setup multi-window sync. 2012-06-29 10:41:08 -04:00			`QList<WebPage *> pages() const;`
WebPageManager is no longer a singleton 2012-03-28 23:05:24 -04:00			`void setCurrentPage(WebPage *);`
Command to enable a more useful debug log 2012-06-29 12:14:22 -04:00			`WebPage *currentPage() const;`
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 18:00:34 -04:00			`WebPage *createPage();`
			`void removePage(WebPage *);`
New windows should respect ignore_ssl_errors 2012-03-30 15:00:51 -04:00			`void setIgnoreSslErrors(bool);`
			`bool ignoreSslErrors();`
Revert "Revert "Add configurable timeouts to commands."" This reverts commit b1b3a4c390031a47e74a35eae0a7a6eebb7697e7. 2012-10-24 07:55:29 -04:00			`void setTimeout(int);`
			`int getTimeout();`
Close new windows on reset 2012-05-14 21:59:28 -04:00			`void reset();`
Shared cookie jar for all windows 2012-06-21 23:34:51 -04:00			`NetworkCookieJar *cookieJar();`
Setup multi-window sync. 2012-06-29 10:41:08 -04:00			`bool isLoading() const;`
Command to enable a more useful debug log 2012-06-29 12:14:22 -04:00			`QDebug logger() const;`
			`void enableLogging();`
Don't wait for finished replies Synchronous requests will have emitted the finished signal by the time we connect to it. 2012-12-03 22:47:10 -05:00			`void replyFinished(QNetworkReply *reply);`
Share the NetworkAccessManager across WebPages Destroying the NetworkAccessManager seems to result in "terminate called without an active exception" segfaults. The documentation states that an application requires only a single single NetworkAccessManager. 2013-03-18 08:11:59 -04:00			`NetworkAccessManager *networkAccessManager();`
Extract handle classes from NetworkAccessManager NetworkAccessManager was getting pretty complex, and adding something that modifies or intercepts requests is becoming a common change. This change introduces a chain of handlers which can modify a request or return a response of their own. To start with, this extracts the concerns of fixing missing content types, setting custom headers, and intercepting blacklisted requests. 2014-11-24 09:52:34 -05:00			`void setUrlBlacklist(const QStringList &);`
			`void addHeader(QString, QString);`
Introduce allowed, blocked URL filters * Adds `allow_url`, `block_url`, and `block_unknown_url` methods. * Both allow_url and block_url accept wildcards. * Any requests to blocked URLs will be blocked immediately. * Blocked URLs take precedence over allowed URLs. * By default, any requests to localhost and 127.0.0.1 are allowed. * By default, any requests to unknown hosts will print a warning. * `block_unknown_urls` causes unknown hosts to be silently blocked. * `blacklisted_urls=` is deprecated in favor of `block_url`. 2014-11-14 14:55:14 -05:00			`void setUnknownUrlMode(UnknownUrlHandler::Mode);`
			`void allowUrl(const QString &);`
			`void blockUrl(const QString &);`
First pass at within_window support 2012-03-26 18:41:33 -04:00
Move window change handling into WebPageManager 2012-04-04 15:40:18 -04:00			`public slots:`
Close new windows on reset 2012-05-14 21:59:28 -04:00			`void emitLoadStarted();`
Command to enable a more useful debug log 2012-06-29 12:14:22 -04:00			`void setPageStatus(bool);`
Fix issues with Qt 4.8 2012-07-11 23:36:22 -04:00			`void requestCreated(QByteArray &url, QNetworkReply *reply);`
Don't wait for finished replies Synchronous requests will have emitted the finished signal by the time we connect to it. 2012-12-03 22:47:10 -05:00			`void handleReplyFinished();`
Fix reset crash when replies are destroyed We attempted to track in-progress replies and abort them in 1.5.1. However, sometimes these replies are destroyed unexpectedly, so attempting to abort them raises errors. This commit tracks when replies are destroyed and removes them from the queue of in-progress replies. 2015-06-05 13:29:26 -04:00			`void replyDestroyed(QObject *);`
Move window change handling into WebPageManager 2012-04-04 15:40:18 -04:00
			`signals:`
			`void pageFinished(bool);`
Close new windows on reset 2012-05-14 21:59:28 -04:00			`void loadStarted();`
Move window change handling into WebPageManager 2012-04-04 15:40:18 -04:00
First pass at within_window support 2012-03-26 18:41:33 -04:00			`private:`
Command to enable a more useful debug log 2012-06-29 12:14:22 -04:00			`void emitPageFinished();`
			`static void handleDebugMessage(QtMsgType type, const char *message);`
Move the call to cache initialization to the WebPageManager 2017-03-26 16:31:29 -04:00			`void initOfflineWebApplicationCache();`
Command to enable a more useful debug log 2012-06-29 12:14:22 -04:00
Implement window_handles and window_handle for proper window switching 2012-03-27 18:49:57 -04:00			`QList<WebPage *> m_pages;`
Fix native alerts from Ajax requests If an Ajax request finished after a `reset` triggered an alert, a native alert pops up. Additionally, the next request to the driver after the native alert will crash the webkit process. 2015-04-23 10:15:37 -04:00			`QList<QNetworkReply *> m_pendingReplies;`
WebPageManager is no longer a singleton 2012-03-28 23:05:24 -04:00			`WebPage *m_currentPage;`
Move window change handling into WebPageManager 2012-04-04 15:40:18 -04:00			`bool m_ignoreSslErrors;`
Shared cookie jar for all windows 2012-06-21 23:34:51 -04:00			`NetworkCookieJar *m_cookieJar;`
Emit loadStarted and pageFinished on WebPage state change Instead of emitting loadStarted when a reply is created and pageFinished when all pending replies have finished, emit these signals when the corresponding WebPage events fire. 2012-12-05 19:38:03 -05:00			`QSet<WebPage *> m_started;`
Setup multi-window sync. 2012-06-29 10:41:08 -04:00			`bool m_success;`
Command to enable a more useful debug log 2012-06-29 12:14:22 -04:00			`bool m_loggingEnabled;`
Fix the 'Reset' command in debug builds (on Windows) 2017-03-06 12:18:34 -05:00			`bool m_isCacheInitialized;`
Back the logger with a QFile Previously all messages were written to a string which grew unbounded when logging was disabled. 2013-01-15 22:37:24 -05:00			`QFile *m_ignoredOutput;`
Revert "Revert "Add configurable timeouts to commands."" This reverts commit b1b3a4c390031a47e74a35eae0a7a6eebb7697e7. 2012-10-24 07:55:29 -04:00			`int m_timeout;`
Share the NetworkAccessManager across WebPages Destroying the NetworkAccessManager seems to result in "terminate called without an active exception" segfaults. The documentation states that an application requires only a single single NetworkAccessManager. 2013-03-18 08:11:59 -04:00			`NetworkAccessManager *m_networkAccessManager;`
Extract handle classes from NetworkAccessManager NetworkAccessManager was getting pretty complex, and adding something that modifies or intercepts requests is becoming a common change. This change introduces a chain of handlers which can modify a request or return a response of their own. To start with, this extracts the concerns of fixing missing content types, setting custom headers, and intercepting blacklisted requests. 2014-11-24 09:52:34 -05:00			`BlacklistedRequestHandler *m_blacklistedRequestHandler;`
			`CustomHeadersRequestHandler *m_customHeadersRequestHandler;`
Introduce allowed, blocked URL filters * Adds `allow_url`, `block_url`, and `block_unknown_url` methods. * Both allow_url and block_url accept wildcards. * Any requests to blocked URLs will be blocked immediately. * Blocked URLs take precedence over allowed URLs. * By default, any requests to localhost and 127.0.0.1 are allowed. * By default, any requests to unknown hosts will print a warning. * `block_unknown_urls` causes unknown hosts to be silently blocked. * `blacklisted_urls=` is deprecated in favor of `block_url`. 2014-11-14 14:55:14 -05:00			`UnknownUrlHandler *m_unknownUrlHandler;`
First pass at within_window support 2012-03-26 18:41:33 -04:00			`};`

Implement window_handles and window_handle for proper window switching 2012-03-27 18:49:57 -04:00			`#endif // _WEBPAGEMANAGER_H`