ChangeLog

2013-02-12  Jocelyn Turcotte  <jocelyn.turcotte@digia.com>

        [Qt] Properly layer QtWebContext on top of the C API

        https://bugs.webkit.org/show_bug.cgi?id=108475

        Reviewed by NOBODY (OOPS!).

        The lifetime of the WebContext is difficult to manage since a circular

        reference is kept with the WebProcessProxy until it shuts itself down, 60

        seconds after the last page is closed. There was some notification

        in place to handle this in the upper layer, but having to go through the

        C API makes this quite awkward.

        The biggest behavior change that this introduces is that the WebContext

        isn't automatically destroyed anymore and will be kept alive until the

        application is shut down.

        This includes the icon database, ideally we should only enable it once the

        QQuickWebView::icon property is read.

        Also, instead of going through WebPageProxy and PageClient to forward

        injected bundle messages received by the context, maintain a static map

        of QQuickWebViewPrivate and fetch it using the WKPageRef.

        * UIProcess/API/qt/qquickwebview.cpp:

        (QQuickWebViewPrivate::get):

        (QQuickWebViewPrivate::QQuickWebViewPrivate):

        (QQuickWebViewPrivate::~QQuickWebViewPrivate):

        (QQuickWebViewPrivate::initialize):

        (QQuickWebViewPrivate::handleDownloadRequest):

        (QQuickWebViewPrivate::updateIcon):

        (QQuickWebViewPrivate::didReceiveMessageFromNavigatorQtObject):

        * UIProcess/API/qt/qquickwebview_p_p.h:

        (QQuickWebViewPrivate):

        * UIProcess/API/qt/qwebiconimageprovider.cpp:

        (QWebIconImageProvider::requestImage):

        * UIProcess/API/qt/raw/qrawwebview.cpp:

        * UIProcess/API/qt/raw/qrawwebview_p_p.h:

        * UIProcess/PageClient.h:

        (PageClient):

        * UIProcess/WebPageProxy.h:

        (WebPageProxy):

        * UIProcess/qt/QtPageClient.cpp:

        * UIProcess/qt/QtPageClient.h:

        (QtPageClient):

        * UIProcess/qt/QtWebContext.cpp:

        (WebKit):

        (WebKit::didReceiveMessageFromInjectedBundle):

        (WebKit::initializeContextInjectedBundleClient):

        (WebKit::QtWebContext::QtWebContext):

        (WebKit::QtWebContext::~QtWebContext):

        (WebKit::QtWebContext::create):

        (WebKit::QtWebContext::defaultContext):

        * UIProcess/qt/QtWebContext.h:

        (WebKit):

        (QtWebContext):

        (WebKit::QtWebContext::context):

        (WebKit::QtWebContext::downloadManager):

        (WebKit::QtWebContext::iconDatabase):

        * UIProcess/qt/WebContextQt.cpp:

        (WebKit::WebContext::platformInvalidateContext):

        * UIProcess/qt/WebPageProxyQt.cpp:

2013-02-11  Jocelyn Turcotte  <jocelyn.turcotte@digia.com>

        [Qt][WK2] Favor QUrl to WTF::String in the Qt API layer

Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp

#include "QtWebPageEventHandler.h"

#include "QtWebPagePolicyClient.h"

#include "WebBackForwardList.h"

37#include "WebContext.h"

#include "WebFindOptions.h"

#if ENABLE(INSPECTOR_SERVER)

#include "WebInspectorProxy.h"

#endif

#include "WebPageGroup.h"

#include "WebPreferences.h"

48#include "qglobal.h"

#include "qquicknetworkreply_p.h"

#include "qquicknetworkrequest_p.h"

#include "qquickwebpage_p_p.h"

#include <JavaScriptCore/JSBase.h>

#include <JavaScriptCore/JSRetainPtr.h>

#include <QDateTime>

65#include <QMap>

#include <QtCore/QFile>

#include <QtQml/QJSValue>

#include <QtQuick/QQuickView>

@@static const int kAxisLockSampleCount = 5;

static const qreal kAxisLockVelocityThreshold = 300;

static const qreal kAxisLockVelocityDirectionThreshold = 50;

typedef QMap<WKPageRef, QQuickWebViewPrivate*> PageToViewMap;

Q_GLOBAL_STATIC(PageToViewMap, pageToView)

static inline QQuickWebViewPrivate* toQQuickWebViewPrivate(const void* clientInfo)

{

    ASSERT(clientInfo);

@@static QQuickWebViewPrivate* createPrivateObject(QQuickWebView* publicObject)

    return new QQuickWebViewLegacyPrivate(publicObject);

}

QQuickWebViewPrivate* QQuickWebViewPrivate::get(WKPageRef page)

{

    return pageToView()->value(page);

}

QQuickWebViewPrivate::FlickableAxisLocker::FlickableAxisLocker()

    : m_allowedDirection(QQuickFlickable::AutoFlickDirection)

    , m_time(0), m_sampleCount(0)

@@QPointF QQuickWebViewPrivate::FlickableAxisLocker::adjust(const QPointF& positio

QQuickWebViewPrivate::QQuickWebViewPrivate(QQuickWebView* viewport)

    : q_ptr(viewport)

    , experimental(new QQuickWebViewExperimental(viewport, this))

286 , context(0)

    , alertDialog(0)

    , confirmDialog(0)

    , promptDialog(0)

@@QQuickWebViewPrivate::QQuickWebViewPrivate(QQuickWebView* viewport)

QQuickWebViewPrivate::~QQuickWebViewPrivate()

{

    webPageProxy->close();

314 pageToView()->remove(webPage.get());

}

// Note: we delay this initialization to make sure that QQuickWebView has its d-ptr in-place.

@@void QQuickWebViewPrivate::initialize(WKContextRef contextRef, WKPageGroupRef pa

    if (!pageGroup)

        pageGroup = adoptWK(WKPageGroupCreateWithIdentifier(0));

311 context = contextRef ? QtWebContext::create(~~toImpl(~~contextRef)) : QtWebContext::defaultContext();

312 webPageProxy = context->createWebPage(&pageClient, toImpl(pageGroup.get()));

324 context = contextRef ? QtWebContext::create(contextRef) : QtWebContext::defaultContext();

325 webPageProxy = toImpl(context->context())->createWebPage(&pageClient, toImpl(pageGroup.get()));

313326 webPage = toAPI(webPageProxy.get());

327 pageToView()->insert(webPage.get(), this);

328

    webPageProxy->setUseFixedLayout(s_flickableViewportEnabled);

#if ENABLE(FULLSCREEN_API)

    webPageProxy->fullScreenManager()->setWebView(q_ptr);

@@void QQuickWebViewPrivate::handleDownloadRequest(DownloadProxy* download)

    downloadItem->d->downloadProxy = download;

    q->connect(downloadItem->d, SIGNAL(receivedResponse(QWebDownloadItem*)), q, SLOT(_q_onReceivedResponseFromDownload(QWebDownloadItem*)));

610 QtWebContext::downloadManager()->addDownload(download, downloadItem);

625 QtWebContext::defaultContext()->downloadManager()->addDownload(download, downloadItem);

}

void QQuickWebViewPrivate::_q_onVisibleChanged()

@@void QQuickWebViewPrivate::updateIcon()

    if (!provider)

        return;

645 QUrl iconUrl = provider->iconURLForPageURLInContext(m_currentUrl, context~~.get()~~);

660 QUrl iconUrl = provider->iconURLForPageURLInContext(m_currentUrl, context);

    if (iconUrl == m_iconUrl)

        return;

@@WebCore::IntSize QQuickWebViewPrivate::viewSize() const

    \sa postMessage

*/

899 void QQuickWebViewPrivate::didReceiveMessageFromNavigatorQtObject(~~const~~ String& message)

914void QQuickWebViewPrivate::didReceiveMessageFromNavigatorQtObject(WKStringRef message)

900915{

901916 QVariantMap variantMap;

902 variantMap.insert(QLatin1String("data"), QString(message));

917 variantMap.insert(QLatin1String("data"), WKStringCopyQString(message));

    variantMap.insert(QLatin1String("origin"), q_ptr->url());

    emit q_ptr->experimental()->messageReceived(variantMap);

}

Source/WebKit2/UIProcess/API/qt/qquickwebview_p_p.h

@@class QQuickWebViewPrivate {

public:

    static QQuickWebViewPrivate* get(QQuickWebView* q) { return q->d_ptr.data(); }

68 static QQuickWebViewPrivate* get(WKPageRef);

    virtual ~QQuickWebViewPrivate();

@@public:

    // PageClient.

    WebCore::IntSize viewSize() const;

126 void didReceiveMessageFromNavigatorQtObject(const String& message);

    virtual void pageDidRequestScroll(const QPoint& pos) { }

    void processDidCrash();

    void didRelaunchProcess();

    PassOwnPtr<WebKit::DrawingAreaProxy> createDrawingAreaProxy();

    void handleDownloadRequest(WebKit::DownloadProxy*);

133 void didReceiveMessageFromNavigatorQtObject(WKStringRef message);

134

protected:

    class FlickableAxisLocker {

        QQuickFlickable::FlickableDirection m_allowedDirection;

@@protected:

    static void didChangeBackForwardList(WKPageRef, WKBackForwardListItemRef, WKArrayRef, const void *clientInfo);

    QQuickWebViewPrivate(QQuickWebView* viewport);

167 RefPtr<WebKit::QtWebContext> context;

    RefPtr<WebKit::WebPageProxy> webPageProxy;

    WKRetainPtr<WKPageRef> webPage;

    WKRetainPtr<WKPageGroupRef> pageGroup;

@@protected:

    QScopedPointer<QQuickWebPage> pageView;

    QQuickWebView* q_ptr;

    QQuickWebViewExperimental* experimental;

184 WebKit::QtWebContext* context;

    FlickableAxisLocker axisLocker;

Source/WebKit2/UIProcess/API/qt/qwebiconimageprovider.cpp

@@QImage QWebIconImageProvider::requestImage(const QString& id, QSize* size, const

{

    QUrl pageURL = QUrl::fromEncoded(QByteArray::fromBase64(id.midRef(id.indexOf('#') + 1).toLatin1()));

70 QtWebIconDatabaseClient* iconDatabase = QtWebContext::iconDatabase();

70 QtWebIconDatabaseClient* iconDatabase = QtWebContext::defaultContext()->iconDatabase();

    if (!iconDatabase)

        return QImage();

Source/WebKit2/UIProcess/API/qt/raw/qrawwebview.cpp

#include <WebCore/CoordinatedGraphicsScene.h>

#include <WebKit2/qrawwebview_p.h>

void QRawWebViewPrivate::didReceiveMessageFromNavigatorQtObject(const String& message)

{

    notImplemented();

}

void QRawWebViewPrivate::didChangeViewportProperties(const WebCore::ViewportAttributes& attr)

{

    notImplemented();

Source/WebKit2/UIProcess/API/qt/raw/qrawwebview_p_p.h

@@public:

    virtual void countStringMatchesInCustomRepresentation(const String&, WebKit::FindOptions, unsigned maxMatchCount) { }

    virtual void clearAllEditCommands() { }

49 virtual void didReceiveMessageFromNavigatorQtObject(const String& message);

    virtual void didChangeViewportProperties(const WebCore::ViewportAttributes& attr);

    virtual void handleDownloadRequest(WebKit::DownloadProxy* download);

Source/WebKit2/UIProcess/PageClient.h

@@public:

#endif

#if PLATFORM(QT)

    virtual void didFindZoomableArea(const WebCore::IntPoint&, const WebCore::IntRect&) = 0;

124 virtual void didReceiveMessageFromNavigatorQtObject(const String&) = 0;

    virtual void handleAuthenticationRequiredRequest(const String& hostname, const String& realm, const String& prefilledUsername, String& username, String& password) = 0;

    virtual void handleCertificateVerificationRequest(const String& hostname, bool& ignoreErrors) = 0;

    virtual void handleProxyAuthenticationRequiredRequest(const String& hostname, uint16_t port, const String& prefilledUsername, String& username, String& password) = 0;

Source/WebKit2/UIProcess/WebPageProxy.h

@@public:

#if PLATFORM(QT)

    void findZoomableAreaForPoint(const WebCore::IntPoint&, const WebCore::IntSize&);

645 void didReceiveMessageFromNavigatorQtObject(const String&);

#endif

#if PLATFORM(QT) || PLATFORM(EFL) || PLATFORM(GTK)

Source/WebKit2/UIProcess/qt/QtPageClient.cpp

@@void QtPageClient::didFindZoomableArea(const IntPoint& target, const IntRect& ar

    m_eventHandler->didFindZoomableArea(target, area);

}

void QtPageClient::didReceiveMessageFromNavigatorQtObject(const String& message)

{

    QQuickWebViewPrivate::get(m_webView)->didReceiveMessageFromNavigatorQtObject(message);

}

void QtPageClient::updateTextInputState()

{

    ASSERT(m_eventHandler);

Source/WebKit2/UIProcess/qt/QtPageClient.h

@@public:

    virtual WebCore::IntSize viewSize();

    virtual bool isViewFocused();

    virtual bool isViewVisible();

50 virtual void didReceiveMessageFromNavigatorQtObject(const String&);

    virtual void pageDidRequestScroll(const WebCore::IntPoint&);

    virtual void didChangeContentsSize(const WebCore::IntSize&);

    virtual void didChangeViewportProperties(const WebCore::ViewportAttributes&);

Source/WebKit2/UIProcess/qt/QtWebContext.cpp

#include "QtDownloadManager.h"

#include "QtWebIconDatabaseClient.h"

26 #include "WKAPICast.h"

27 #include "WebContext.h"

2826#include "WebInspectorServer.h"

29 #include "WebPageProxy.h"

27#include "qquickwebview_p_p.h"

28#include <WKAPICast.h>

#include <WKArray.h>

#include <WKPage.h>

#include <WKString.h>

namespace WebKit {

37 static WebContext* s_defaultWebContext = 0;

// Prevent the destruction of the WKContext for two reasons:

// - An internal reference is kept to the WebContext waiting until the web process shut down, which

// does so 60 seconds after the last page closed. We want to reuse that web process if possible and

// avoid creating a second parallel WKContext + web process.

// - The IconDatabase wasn't designed to have more than one instance, or to be quickly opened/closed.

3841static QtWebContext* s_defaultQtWebContext = 0;

39 static OwnPtr<QtDownloadManager> s_downloadManager;

40 static OwnPtr<QtWebIconDatabaseClient> s_iconDatabase;

static void initInspectorServer()

{

@@static void didReceiveMessageFromInjectedBundle(WKContextRef, WKStringRef messag

    WKPageRef page = static_cast<WKPageRef>(WKArrayGetItemAtIndex(body, 0));

    WKStringRef str = static_cast<WKStringRef>(WKArrayGetItemAtIndex(body, 1));

100 ~~toImpl~~(page)->didReceiveMessageFromNavigatorQtObject(~~toImpl(~~str)~~->string())~~;

101 QQuickWebViewPrivate::get(page)->didReceiveMessageFromNavigatorQtObject(str);

101102}

102103

103 static void initializeContextInjectedBundleClient(WebContext* context)

104static void initializeContextInjectedBundleClient(WKContextRef context)

{

    WKContextInjectedBundleClient injectedBundleClient;

    memset(&injectedBundleClient, 0, sizeof(WKContextInjectedBundleClient));

    injectedBundleClient.version = kWKContextInjectedBundleClientCurrentVersion;

    injectedBundleClient.didReceiveMessageFromInjectedBundle = didReceiveMessageFromInjectedBundle;

109 WKContextSetInjectedBundleClient(~~toAPI(~~context), &injectedBundleClient);

110 WKContextSetInjectedBundleClient(context, &injectedBundleClient);

110111}

111112

112 QtWebContext::QtWebContext(WebContext* context)

113QtWebContext::QtWebContext(WKContextRef context)

113114 : m_context(context)

115 , m_downloadManager(new QtDownloadManager(toImpl(context)))

116 , m_iconDatabase(new QtWebIconDatabaseClient(toImpl(context)))

{

}

QtWebContext::~QtWebContext()

{

119 ASSERT(!s_defaultQtWebContext || s_defaultQtWebContext == this);

120 s_defaultQtWebContext = 0;

}

// Used directly only by WebKitTestRunner.

124 ~~PassRefPtr<~~QtWebContext> QtWebContext::create(WebContext* context)

125QtWebContext* QtWebContext::create(WKContextRef context)

125126{

126127 globalInitialization();

    // The lifetime of WebContext is a bit special, it is bound to the reference held

    // by QtWebContext at first and then enters a circular dependency with WebProcessProxy

    // once the first page is created until the web process exits. Because of this we can't

    // assume that destroying the last QtWebContext will destroy the WebContext and we

    // have to make sure that WebContext's clients follow its lifetime and aren't attached

    // to QtWebContext. QtWebContext itself is only attached to QQuickWebView.

    // Since we only support one WebContext at a time, initialize those clients globally

    // here. They have to be available to views spawned by WebKitTestRunner as well.

    if (!s_downloadManager)

        s_downloadManager = adoptPtr(new QtDownloadManager(context));

    if (!s_iconDatabase)

        s_iconDatabase = adoptPtr(new QtWebIconDatabaseClient(context));

    return adoptRef(new QtWebContext(context));

128 return new QtWebContext(context);

140129}

141130

142 ~~PassRefPtr<~~QtWebContext> QtWebContext::defaultContext()

131QtWebContext* QtWebContext::defaultContext()

143132{

    // Keep local references until we can return a ref to QtWebContext holding the WebContext.

    RefPtr<WebContext> webContext(s_defaultWebContext);

    RefPtr<QtWebContext> qtWebContext(s_defaultQtWebContext);

    if (!webContext) {

        webContext = WebContext::create(String());

        s_defaultWebContext = webContext.get();

133 if (!s_defaultQtWebContext) {

134 WKRetainPtr<WKContextRef> wkContext = adoptWK(WKContextCreate());

151135 // Make sure for WebKitTestRunner that the injected bundle client isn't initialized

152 // and that the page cache isn't enabled (defaultContext isn't used there).

153 initializeContextInjectedBundleClient(webContext.get());

136 // and that the page cache isn't enabled (defaultContext() isn't used there).

137 initializeContextInjectedBundleClient(wkContext.get());

154138 // A good all-around default.

155 webContext->setCacheModel(CacheModelDocumentBrowser);

156 }

139 WKContextSetCacheModel(wkContext.get(), kWKCacheModelDocumentBrowser);

157140

    if (!qtWebContext) {

        qtWebContext = QtWebContext::create(webContext.get());

        s_defaultQtWebContext = qtWebContext.get();

141 s_defaultQtWebContext = QtWebContext::create(wkContext.get());

161142 }

162143

    return qtWebContext.release();

}

PassRefPtr<WebPageProxy> QtWebContext::createWebPage(PageClient* client, WebPageGroup* pageGroup)

{

    return m_context->createWebPage(client, pageGroup);

}

QtDownloadManager* QtWebContext::downloadManager()

{

    ASSERT(s_downloadManager);

    return s_downloadManager.get();

}

QtWebIconDatabaseClient* QtWebContext::iconDatabase()

{

    ASSERT(s_iconDatabase);

    return s_iconDatabase.get();

}

void QtWebContext::invalidateContext(WebContext* context)

{

    UNUSED_PARAM(context);

    ASSERT(!s_defaultQtWebContext);

    ASSERT(!s_defaultWebContext || s_defaultWebContext == context);

    s_downloadManager.clear();

    s_iconDatabase.clear();

    s_defaultWebContext = 0;

144 return s_defaultQtWebContext;

}

} // namespace WebKit

Source/WebKit2/UIProcess/qt/QtWebContext.h

#ifndef QtWebContext_h

#define QtWebContext_h

24#include <QScopedPointer>

2425#include <QtGlobal>

2526#include <WKContext.h>

#include <wtf/OwnPtr.h>

#include <wtf/PassRefPtr.h>

#include <wtf/RefCounted.h>

#include <wtf/RefPtr.h>

27#include <WKRetainPtr.h>

namespace WebKit {

33 class PageClient;

3431class QtDownloadManager;

3532class QtWebIconDatabaseClient;

class WebContext;

class WebPageGroup;

class WebPageProxy;

3933

40 class QtWebContext ~~: public RefCounted<QtWebContext>~~ {

34class QtWebContext {

public:

    ~QtWebContext();

44 static ~~PassRefPtr<~~QtWebContext> create(WebContext*);

45 static ~~PassRefPtr<~~QtWebContext> defaultContext();

38 static QtWebContext* create(WKContextRef);

39 static QtWebContext* defaultContext();

4640

47 ~~Pass~~RefPt~~r<WebPageProxy> createWebPage~~(PageClient*, WebPageGroup*);

41 WKContextRef context() { return m_context.get(); }

4842

    WebContext* context() { return m_context.get(); }

    static QtDownloadManager* downloadManager();

    static QtWebIconDatabaseClient* iconDatabase();

    static void invalidateContext(WebContext*);

43 QtDownloadManager* downloadManager() { return m_downloadManager.data(); }

44 QtWebIconDatabaseClient* iconDatabase() { return m_iconDatabase.data(); }

5445

5546private:

56 explicit QtWebContext(WebContext*);

47 explicit QtWebContext(WKContextRef);

5748

58 RefPtr<WebContext> m_context;

    WKRetainPtr<WKContextRef> m_context;

    QScopedPointer<QtDownloadManager> m_downloadManager;

    QScopedPointer<QtWebIconDatabaseClient> m_iconDatabase;

};

} // namespace WebKit

Source/WebKit2/UIProcess/qt/WebContextQt.cpp

@@void WebContext::platformInitializeWebProcess(WebProcessCreationParameters& para

void WebContext::platformInvalidateContext()

{

#if HAVE(QTQUICK)

    QtWebContext::invalidateContext(this);

#endif

}

String WebContext::platformDefaultDatabaseDirectory() const

Source/WebKit2/UIProcess/qt/WebPageProxyQt.cpp

@@void WebPageProxy::findZoomableAreaForPoint(const IntPoint& point, const IntSize

    m_process->send(Messages::WebPage::FindZoomableAreaForPoint(point, area), m_pageID);

}

void WebPageProxy::didReceiveMessageFromNavigatorQtObject(const String& contents)

{

    m_pageClient->didReceiveMessageFromNavigatorQtObject(contents);

}

void WebPageProxy::authenticationRequiredRequest(const String& hostname, const String& realm, const String& prefilledUsername, String& username, String& password)

{

    m_pageClient->handleAuthenticationRequiredRequest(hostname, realm, prefilledUsername, username, password);