- Qt 5.5
- Qt WebEngine Widgets
- WebEngine Tab Browser Example
- cookiejar.h Example File
- Qt 5.5.1 Reference Documentation

# cookiejar.h Example File

browser/cookiejar.h

    /****************************************************************************
    **
    ** Copyright (C) 2015 The Qt Company Ltd.
    ** Contact: http://www.qt.io/licensing/
    **
    ** This file is part of the demonstration applications 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 The Qt Company. For licensing terms
    ** and conditions see http://www.qt.io/terms-conditions. For further
    ** information use the contact form at http://www.qt.io/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 2.1 as published by the Free Software
    ** Foundation and appearing in the file LICENSE.LGPL included in the
    ** packaging of this file. Please review the following information to
    ** ensure the GNU Lesser General Public License version 2.1 requirements
    ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
    **
    ** As a special exception, The Qt Company gives you certain additional
    ** rights. These rights are described in The Qt Company LGPL Exception
    ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
    **
    ** GNU General Public License Usage
    ** Alternatively, this file may be used under the terms of the GNU
    ** General Public License version 3.0 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 3.0 requirements will be
    ** met: http://www.gnu.org/copyleft/gpl.html.
    **
    **
    ** $QT_END_LICENSE$
    **
    ****************************************************************************/

    #ifndef COOKIEJAR_H
    #define COOKIEJAR_H

    #include <QtNetwork/QNetworkCookieJar>

    #include <QtCore/QAbstractItemModel>
    #include <QtCore/QStringList>

    #include <QtWidgets/QDialog>
    #include <QtWidgets/QTableView>

    class QSortFilterProxyModel;
    class QKeyEvent;

    class AutoSaver;

    class CookieJar : public QNetworkCookieJar
    {
        friend class CookieModel;
        Q_OBJECT
        Q_PROPERTY(AcceptPolicy acceptPolicy READ acceptPolicy WRITE setAcceptPolicy)
        Q_PROPERTY(KeepPolicy keepPolicy READ keepPolicy WRITE setKeepPolicy)
        Q_PROPERTY(QStringList blockedCookies READ blockedCookies WRITE setBlockedCookies)
        Q_PROPERTY(QStringList allowedCookies READ allowedCookies WRITE setAllowedCookies)
        Q_PROPERTY(QStringList allowForSessionCookies READ allowForSessionCookies WRITE setAllowForSessionCookies)
        Q_ENUMS(KeepPolicy)
        Q_ENUMS(AcceptPolicy)

    signals:
        void cookiesChanged();

    public:
        enum AcceptPolicy {
            AcceptAlways,
            AcceptNever,
            AcceptOnlyFromSitesNavigatedTo
        };

        enum KeepPolicy {
            KeepUntilExpire,
            KeepUntilExit,
            KeepUntilTimeLimit
        };

        CookieJar(QObject *parent = 0);
        ~CookieJar();

        QList<QNetworkCookie> cookiesForUrl(const QUrl &url) const;
        bool setCookiesFromUrl(const QList<QNetworkCookie> &cookieList, const QUrl &url);

        AcceptPolicy acceptPolicy() const;
        void setAcceptPolicy(AcceptPolicy policy);

        KeepPolicy keepPolicy() const;
        void setKeepPolicy(KeepPolicy policy);

        QStringList blockedCookies() const;
        QStringList allowedCookies() const;
        QStringList allowForSessionCookies() const;

        void setBlockedCookies(const QStringList &list);
        void setAllowedCookies(const QStringList &list);
        void setAllowForSessionCookies(const QStringList &list);

    public slots:
        void clear();
        void loadSettings();

    private slots:
        void save();

    private:
        void purgeOldCookies();
        void load();
        bool m_loaded;
        AutoSaver *m_saveTimer;

        AcceptPolicy m_acceptCookies;
        KeepPolicy m_keepCookies;

        QStringList m_exceptions_block;
        QStringList m_exceptions_allow;
        QStringList m_exceptions_allowForSession;
    };

    class CookieModel : public QAbstractTableModel
    {
        Q_OBJECT

    public:
        CookieModel(CookieJar *jar, QObject *parent = 0);
        QVariant headerData(int section, Qt::Orientation orientation, int role) const;
        QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
        int columnCount(const QModelIndex &parent = QModelIndex()) const;
        int rowCount(const QModelIndex &parent = QModelIndex()) const;
        bool removeRows(int row, int count, const QModelIndex &parent = QModelIndex());

    private slots:
        void cookiesChanged();

    private:
        CookieJar *m_cookieJar;
    };

    #include "ui_cookies.h"
    #include "ui_cookiesexceptions.h"

    class CookiesDialog : public QDialog, public Ui_CookiesDialog
    {
        Q_OBJECT

    public:
        CookiesDialog(CookieJar *cookieJar, QWidget *parent = 0);

    private:
        QSortFilterProxyModel *m_proxyModel;
    };

    class CookieExceptionsModel : public QAbstractTableModel
    {
        Q_OBJECT
        friend class CookiesExceptionsDialog;

    public:
        CookieExceptionsModel(CookieJar *cookieJar, QObject *parent = 0);
        QVariant headerData(int section, Qt::Orientation orientation, int role) const;
        QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
        int columnCount(const QModelIndex &parent = QModelIndex()) const;
        int rowCount(const QModelIndex &parent = QModelIndex()) const;
        bool removeRows(int row, int count, const QModelIndex &parent = QModelIndex());

    private:
        CookieJar *m_cookieJar;

        // Domains we allow, Domains we block, Domains we allow for this session
        QStringList m_allowedCookies;
        QStringList m_blockedCookies;
        QStringList m_sessionCookies;
    };

    class CookiesExceptionsDialog : public QDialog, public Ui_CookiesExceptionsDialog
    {
        Q_OBJECT

    public:
        CookiesExceptionsDialog(CookieJar *cookieJar, QWidget *parent = 0);

    private slots:
        void block();
        void allow();
        void allowForSession();
        void textChanged(const QString &text);

    private:
        CookieExceptionsModel *m_exceptionsModel;
        QSortFilterProxyModel *m_proxyModel;
        CookieJar *m_cookieJar;
    };

    #endif // COOKIEJAR_H