Introduce QWebEngineProfile API

Introduces initial widgets API for the Chromium BrowserContext.

Adds API for controlling cookie jar policy, user-agent string and
cache and persistent data paths.

Similar QML API will follow in another patch.

[ChangeLog][QtWebEngineWidgets][QWebEngineProfile] New API for profiles
applying to groups of QWebEnginePages.

Change-Id: I3c4ef4053fde7564af29178c91a0aca8a2b61a5f
Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>

7 files changed, 529 insertions, 6 deletions

diff --git a/src/webenginewidgets/api/qwebenginepage.cpp b/src/webenginewidgets/api/qwebenginepage.cpp
index 3f5fd53b5..f5994d304 100644
--- a/src/webenginewidgets/api/qwebenginepage.cpp
+++ b/src/webenginewidgets/api/qwebenginepage.cpp
@@ -28,6 +28,8 @@
 #include "javascript_dialog_controller.h"
 #include "qwebenginehistory.h"
 #include "qwebenginehistory_p.h"
+#include "qwebengineprofile.h"
+#include "qwebengineprofile_p.h"
 #include "qwebenginesettings.h"
 #include "qwebenginesettings_p.h"
 #include "qwebengineview.h"
@@ -167,9 +169,10 @@ void CallbackDirectory::CallbackSharedDataPointer::doDeref()
     }
 }
 
-QWebEnginePagePrivate::QWebEnginePagePrivate()
+QWebEnginePagePrivate::QWebEnginePagePrivate(QWebEngineProfile *_profile)
     : adapter(new WebContentsAdapter)
     , history(new QWebEngineHistory(new QWebEngineHistoryPrivate(this)))
+    , profile(_profile ? _profile : QWebEngineProfile::defaultProfile())
     , settings(new QWebEngineSettings)
     , view(0)
     , isLoading(false)
@@ -419,12 +422,29 @@ void QWebEnginePagePrivate::recreateFromSerializedHistory(QDataStream &input)
 
 BrowserContextAdapter *QWebEnginePagePrivate::browserContextAdapter()
 {
-    return BrowserContextAdapter::defaultContext();
+    return profile->d_ptr->browserContext();
 }
 
 QWebEnginePage::QWebEnginePage(QObject* parent)
     : QObject(parent)
-    , d_ptr(new QWebEnginePagePrivate)
+    , d_ptr(new QWebEnginePagePrivate())
+{
+    Q_D(QWebEnginePage);
+    d->q_ptr = this;
+    d->adapter->initialize(d);
+}
+
+/*!
+    Constructs an empty QWebEnginePage in the QWebEngineProfile \a profile with parent \a parent.
+
+    If the profile is not the default profile the caller must ensure the profile is alive for as
+    long as the page is.
+
+    \since 5.5
+*/
+QWebEnginePage::QWebEnginePage(QWebEngineProfile *profile, QObject* parent)
+    : QObject(parent)
+    , d_ptr(new QWebEnginePagePrivate(profile))
 {
     Q_D(QWebEnginePage);
     d->q_ptr = this;
@@ -460,6 +480,16 @@ QWidget *QWebEnginePage::view() const
     return d->view;
 }
 
+/*!
+    Returns the QWebEngineProfile the page belongs to.
+    \since 5.5
+*/
+QWebEngineProfile *QWebEnginePage::profile() const
+{
+    Q_D(const QWebEnginePage);
+    return d->profile;
+}
+
 bool QWebEnginePage::hasSelection() const
 {
     return !selectedText().isEmpty();
diff --git a/src/webenginewidgets/api/qwebenginepage.h b/src/webenginewidgets/api/qwebenginepage.h
index afb62ceda..e70b90d10 100644
--- a/src/webenginewidgets/api/qwebenginepage.h
+++ b/src/webenginewidgets/api/qwebenginepage.h
@@ -50,8 +50,9 @@ QT_BEGIN_NAMESPACE
 class QMenu;
 class QWebEngineHistory;
 class QWebEnginePage;
-class QWebEngineSettings;
 class QWebEnginePagePrivate;
+class QWebEngineProfile;
+class QWebEngineSettings;
 
 namespace QtWebEnginePrivate {
 
@@ -171,6 +172,7 @@ public:
     };
 
     explicit QWebEnginePage(QObject *parent = 0);
+    QWebEnginePage(QWebEngineProfile *profile, QObject *parent = 0);
     ~QWebEnginePage();
     QWebEngineHistory *history() const;
 
@@ -180,6 +182,8 @@ public:
     bool hasSelection() const;
     QString selectedText() const;
 
+    QWebEngineProfile *profile() const;
+
 #ifndef QT_NO_ACTION
     QAction *action(WebAction action) const;
 #endif
diff --git a/src/webenginewidgets/api/qwebenginepage_p.h b/src/webenginewidgets/api/qwebenginepage_p.h
index 23d577c94..2f44bc732 100644
--- a/src/webenginewidgets/api/qwebenginepage_p.h
+++ b/src/webenginewidgets/api/qwebenginepage_p.h
@@ -49,6 +49,7 @@ class WebContentsAdapter;
 QT_BEGIN_NAMESPACE
 class QWebEngineHistory;
 class QWebEnginePage;
+class QWebEngineProfile;
 class QWebEngineSettings;
 class QWebEngineView;
 
@@ -101,7 +102,7 @@ public:
     Q_DECLARE_PUBLIC(QWebEnginePage)
     QWebEnginePage *q_ptr;
 
-    QWebEnginePagePrivate();
+    QWebEnginePagePrivate(QWebEngineProfile *profile = 0);
     ~QWebEnginePagePrivate();
 
     virtual RenderWidgetHostViewQtDelegate* CreateRenderWidgetHostViewQtDelegate(RenderWidgetHostViewQtDelegateClient *client) Q_DECL_OVERRIDE;
@@ -151,6 +152,7 @@ public:
 
     QExplicitlySharedDataPointer<WebContentsAdapter> adapter;
     QWebEngineHistory *history;
+    QWebEngineProfile *profile;
     QWebEngineSettings *settings;
     QWebEngineView *view;
     QSize viewportSize;
diff --git a/src/webenginewidgets/api/qwebengineprofile.cpp b/src/webenginewidgets/api/qwebengineprofile.cpp
new file mode 100644
index 000000000..1487f06ce
--- /dev/null
+++ b/src/webenginewidgets/api/qwebengineprofile.cpp
@@ -0,0 +1,320 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qwebengineprofile.h"
+
+#include "qwebenginepage.h"
+#include "qwebengineprofile_p.h"
+
+#include "browser_context_adapter.h"
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \class QWebEngineProfile
+    \brief The QWebEngineProfile class provides a web-engine profile shared by multiple pages.
+    \since 5.5
+
+    \inmodule QtWebEngineWidgets
+
+    QWebEngineProfile contains settings and history shared by all QWebEnginePages that belong
+    to the profile.
+
+    A default profile is built-in that all web pages not specifically created with another profile
+    belongs to.
+*/
+
+/*!
+    \enum QWebEngineProfile::HttpCacheType
+
+    This enum describes the HTTP cache types QtWebEngine can be configured to use.
+
+    \value MemoryHttpCache Use a in-memory cache. This is the only setting possible if off-the-record is set or no cache path is available.
+    \value DiskHttpCache Use a disk cache. This is the default.
+*/
+
+/*!
+    \enum QWebEngineProfile::PersistentCookiesPolicy
+
+    This enum describes policy for cookie persistency.
+
+    \value NoPersistentCookies Both session and persistent cookies are stored in memory. This is the only setting possible if off-the-record is set or no persistent data path is available.
+    \value AllowPersistentCookies Cookies marked persistent are save and restored from disk, session cookies are only stored to disk for crash recovery. This is the default setting.
+    \value ForcePersistentCookies Both session and persistent cookies are save and restored from disk.
+*/
+
+QWebEngineProfilePrivate::QWebEngineProfilePrivate(BrowserContextAdapter* browserContext, bool ownsContext)
+        : m_browserContext(browserContext)
+{
+    if (ownsContext)
+        m_browserContextRef = browserContext;
+}
+
+QWebEngineProfilePrivate::~QWebEngineProfilePrivate()
+{
+}
+
+/*!
+    Constructs a new off-the-record profile.
+
+    An off-the-record profile leaves no record on the local machine, and has no persistent data or cache.
+    Thus, the HTTP cache can only be in memory and the cookies only be non-persistent, trying to change
+    these settings will have no effect.
+
+    \sa isOffTheRecord()
+*/
+QWebEngineProfile::QWebEngineProfile(QObject *parent)
+    : QObject(parent)
+    , d_ptr(new QWebEngineProfilePrivate(new BrowserContextAdapter(true), true))
+{
+}
+
+/*!
+    Constructs a new profile with storage name \a storageName.
+
+    The storage name must be unique.
+
+    A disk-based QWebEngineProfile should be destroyed on or before application exit, otherwise the cache
+    and persistent data may not be fully flushed to disk.
+
+    \sa storageName()
+*/
+QWebEngineProfile::QWebEngineProfile(const QString &storageName, QObject *parent)
+    : QObject(parent)
+    , d_ptr(new QWebEngineProfilePrivate(new BrowserContextAdapter(storageName), true))
+{
+}
+
+/*! \internal
+*/
+QWebEngineProfile::QWebEngineProfile(QWebEngineProfilePrivate *privatePtr)
+    : d_ptr(privatePtr)
+{
+}
+
+/*! \internal
+*/
+QWebEngineProfile::~QWebEngineProfile()
+{
+}
+
+/*!
+    Returns the storage name for the profile.
+
+    The storage name is used to give each profile that uses the disk separate subdirectories for persistent data and cache.
+*/
+QString QWebEngineProfile::storageName() const
+{
+    const Q_D(QWebEngineProfile);
+    return d->browserContext()->storageName();
+}
+
+/*!
+    Returns true if this is an off-the-record profile that leaves no record on the computer.
+
+    This will force cookies and HTTP cache to be in memory, but also force all other normally
+    persistent data to be stored in memory.
+*/
+bool QWebEngineProfile::isOffTheRecord() const
+{
+    const Q_D(QWebEngineProfile);
+    return d->browserContext()->isOffTheRecord();
+}
+
+/*!
+    Returns the path used to store persistent data for the browser and web content.
+
+    Persistent data includes persistent cookies, HTML5 local storage and visited links.
+
+    By default this is below QStandardPaths::writableLocation(QStandardPaths::DataLocation) in a storage name specific directory.
+
+    \sa setPersistentStoragePath(), storageName(), QStandardPaths::writableLocation()
+*/
+QString QWebEngineProfile::persistentStoragePath() const
+{
+    const Q_D(QWebEngineProfile);
+    return d->browserContext()->dataPath();
+}
+
+/*!
+    Overrides the default path used to store persistent web engine data.
+
+    If set to the null string, the default path is restored.
+
+    \sa persistentStoragePath()
+*/
+void QWebEngineProfile::setPersistentStoragePath(const QString &path)
+{
+    const Q_D(QWebEngineProfile);
+    d->browserContext()->setDataPath(path);
+}
+
+/*!
+    Returns the path used for caches.
+
+    By default this is below QStandardPaths::writableLocation(QStandardPaths::CacheLocation) in a storage name specific directory.
+
+    \sa setCachePath(), storageName(), QStandardPaths::writableLocation()
+*/
+QString QWebEngineProfile::cachePath() const
+{
+    const Q_D(QWebEngineProfile);
+    return d->browserContext()->cachePath();
+}
+
+/*!
+    Overrides the default path used for disk caches.
+
+    If set to the null string, the default path is restored.
+
+    \sa cachePath()
+*/
+void QWebEngineProfile::setCachePath(const QString &path)
+{
+    Q_D(QWebEngineProfile);
+    d->browserContext()->setCachePath(path);
+}
+
+/*!
+    Returns the user-agent string send with HTTP to identify the browser.
+
+    \sa setHttpUserAgent()
+*/
+QString QWebEngineProfile::httpUserAgent() const
+{
+    const Q_D(QWebEngineProfile);
+    return d->browserContext()->httpUserAgent();
+}
+
+/*!
+    Overrides the default user-agent string, setting it to \a userAgent.
+
+    \sa httpUserAgent()
+*/
+void QWebEngineProfile::setHttpUserAgent(const QString &userAgent)
+{
+    Q_D(QWebEngineProfile);
+    d->browserContext()->setHttpUserAgent(userAgent);
+}
+
+/*!
+    Returns the type of HTTP cache used.
+
+    If the profile is off-the-record MemoryHttpCache is returned.
+
+    \sa setHttpCacheType(), cachePath()
+*/
+QWebEngineProfile::HttpCacheType QWebEngineProfile::httpCacheType() const
+{
+    const Q_D(QWebEngineProfile);
+    return QWebEngineProfile::HttpCacheType(d->browserContext()->httpCacheType());
+}
+
+/*!
+    Sets the HTTP cache type to \a httpCacheType.
+
+    \sa httpCacheType(), setCachePath()
+*/
+void QWebEngineProfile::setHttpCacheType(QWebEngineProfile::HttpCacheType httpCacheType)
+{
+    Q_D(QWebEngineProfile);
+    d->browserContext()->setHttpCacheType(BrowserContextAdapter::HttpCacheType(httpCacheType));
+}
+
+/*!
+    Returns the current policy for persistent cookies.
+
+    If the profile is off-the-record NoPersistentCookies is returned.
+
+    \sa setPersistentCookiesPolicy()
+*/
+QWebEngineProfile::PersistentCookiesPolicy QWebEngineProfile::persistentCookiesPolicy() const
+{
+    const Q_D(QWebEngineProfile);
+    return QWebEngineProfile::PersistentCookiesPolicy(d->browserContext()->persistentCookiesPolicy());
+}
+
+/*!
+    Sets the policy for persistent cookies to \a newPersistentCookiesPolicy.
+
+    \sa persistentCookiesPolicy()
+*/
+void QWebEngineProfile::setPersistentCookiesPolicy(QWebEngineProfile::PersistentCookiesPolicy newPersistentCookiesPolicy)
+{
+    Q_D(QWebEngineProfile);
+    d->browserContext()->setPersistentCookiesPolicy(BrowserContextAdapter::PersistentCookiesPolicy(newPersistentCookiesPolicy));
+}
+
+/*!
+    Returns the maximum size of the HTTP size.
+
+    Will return 0 if the size is automatically controlled by QtWebEngine.
+
+    \sa setHttpCacheMaximumSize(), httpCacheType()
+*/
+int QWebEngineProfile::httpCacheMaximumSize() const
+{
+    const Q_D(QWebEngineProfile);
+    return d->browserContext()->httpCacheMaxSize();
+}
+
+/*!
+    Sets the maximum size of the HTTP cache to \a maxSize.
+
+    Setting it to 0 means the size will be controlled automatically by QtWebEngine.
+
+    \sa httpCacheMaximumSize(), setHttpCacheType()
+*/
+void QWebEngineProfile::setHttpCacheMaximumSize(int maxSize)
+{
+    Q_D(QWebEngineProfile);
+    d->browserContext()->setHttpCacheMaxSize(maxSize);
+}
+
+/*!
+    Returns the default profile.
+
+    The default profile uses the storage name "Default".
+
+    \sa storageName()
+*/
+QWebEngineProfile *QWebEngineProfile::defaultProfile()
+{
+    static QWebEngineProfile profile(new QWebEngineProfilePrivate(BrowserContextAdapter::defaultContext(), false));
+    return &profile;
+}
+
+QT_END_NAMESPACE
diff --git a/src/webenginewidgets/api/qwebengineprofile.h b/src/webenginewidgets/api/qwebengineprofile.h
new file mode 100644
index 000000000..d21eed372
--- /dev/null
+++ b/src/webenginewidgets/api/qwebengineprofile.h
@@ -0,0 +1,104 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QWEBENGINEPROFILE_H
+#define QWEBENGINEPROFILE_H
+
+#include "qtwebenginewidgetsglobal.h"
+
+#include <QObject>
+#include <QScopedPointer>
+#include <QString>
+
+QT_BEGIN_NAMESPACE
+
+class QObject;
+class QWebEnginePage;
+class QWebEnginePagePrivate;
+class QWebEngineProfilePrivate;
+
+class QWEBENGINEWIDGETS_EXPORT QWebEngineProfile : public QObject {
+    Q_OBJECT
+public:
+    explicit QWebEngineProfile(QObject *parent = 0);
+    explicit QWebEngineProfile(const QString &name, QObject *parent = 0);
+    virtual ~QWebEngineProfile();
+
+    enum HttpCacheType {
+        MemoryHttpCache,
+        DiskHttpCache
+    };
+
+    enum PersistentCookiesPolicy {
+        NoPersistentCookies,
+        AllowPersistentCookies,
+        ForcePersistentCookies
+    };
+
+    QString storageName() const;
+    bool isOffTheRecord() const;
+
+    QString persistentStoragePath() const;
+    void setPersistentStoragePath(const QString &path);
+
+    QString cachePath() const;
+    void setCachePath(const QString &path);
+
+    QString httpUserAgent() const;
+    void setHttpUserAgent(const QString &userAgent);
+
+    HttpCacheType httpCacheType() const;
+    void setHttpCacheType(QWebEngineProfile::HttpCacheType);
+
+    PersistentCookiesPolicy persistentCookiesPolicy() const;
+    void setPersistentCookiesPolicy(QWebEngineProfile::PersistentCookiesPolicy);
+
+    int httpCacheMaximumSize() const;
+    void setHttpCacheMaximumSize(int maxSize);
+
+    static QWebEngineProfile *defaultProfile();
+
+private:
+    Q_DECLARE_PRIVATE(QWebEngineProfile);
+    QWebEngineProfile(QWebEngineProfilePrivate *);
+
+    friend class QWebEnginePagePrivate;
+    QScopedPointer<QWebEngineProfilePrivate> d_ptr;
+};
+
+QT_END_NAMESPACE
+
+#endif // QWEBENGINEPROFILE_H
diff --git a/src/webenginewidgets/api/qwebengineprofile_p.h b/src/webenginewidgets/api/qwebengineprofile_p.h
new file mode 100644
index 000000000..3a08b6b1e
--- /dev/null
+++ b/src/webenginewidgets/api/qwebengineprofile_p.h
@@ -0,0 +1,60 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QWEBENGINEPROFILE_P_H
+#define QWEBENGINEPROFILE_P_H
+
+class BrowserContextAdapter;
+
+QT_BEGIN_NAMESPACE
+
+class QWebEngineSettings;
+
+class QWebEngineProfilePrivate {
+public:
+    QWebEngineProfilePrivate(BrowserContextAdapter* browserContext, bool ownsContext);
+    ~QWebEngineProfilePrivate();
+
+    BrowserContextAdapter *browserContext() const { return m_browserContext; }
+
+private:
+    BrowserContextAdapter *m_browserContext;
+    QExplicitlySharedDataPointer<BrowserContextAdapter> m_browserContextRef;
+};
+
+QT_END_NAMESPACE
+
+#endif // QWEBENGINEPROFILE_P_H
diff --git a/src/webenginewidgets/webenginewidgets.pro b/src/webenginewidgets/webenginewidgets.pro
index 296b62475..aabcc710d 100644
--- a/src/webenginewidgets/webenginewidgets.pro
+++ b/src/webenginewidgets/webenginewidgets.pro
@@ -17,8 +17,9 @@ SOURCES = \
         api/qwebenginecertificateerror.cpp \
         api/qwebenginehistory.cpp \
         api/qwebenginepage.cpp \
+        api/qwebengineprofile.cpp \
         api/qwebenginesettings.cpp \
-        api/qwebengineview.cpp\
+        api/qwebengineview.cpp \
         render_widget_host_view_qt_delegate_widget.cpp
 
 HEADERS = \
@@ -27,6 +28,8 @@ HEADERS = \
         api/qwebenginehistory.h \
         api/qwebenginepage.h \
         api/qwebenginepage_p.h \
+        api/qwebengineprofile.h \
+        api/qwebengineprofile_p.h \
         api/qwebenginesettings.h \
         api/qwebenginesettings_p.h \
         api/qwebengineview.h \