1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtNetwork module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QNETWORKCOOKIE_H
41#define QNETWORKCOOKIE_H
42
43#include <QtNetwork/qtnetworkglobal.h>
44#include <QtCore/QSharedDataPointer>
45#include <QtCore/QList>
46#include <QtCore/QMetaType>
47#include <QtCore/QObject>
48
49QT_BEGIN_NAMESPACE
50
51
52class QByteArray;
53class QDateTime;
54class QString;
55class QUrl;
56
57class QNetworkCookiePrivate;
58class Q_NETWORK_EXPORT QNetworkCookie
59{
60public:
61 enum RawForm {
62 NameAndValueOnly,
63 Full
64 };
65
66 explicit QNetworkCookie(const QByteArray &name = QByteArray(), const QByteArray &value = QByteArray());
67 QNetworkCookie(const QNetworkCookie &other);
68 ~QNetworkCookie();
69 QNetworkCookie &operator=(QNetworkCookie &&other) noexcept { swap(other); return *this; }
70 QNetworkCookie &operator=(const QNetworkCookie &other);
71
72 void swap(QNetworkCookie &other) noexcept { qSwap(d, other.d); }
73
74 bool operator==(const QNetworkCookie &other) const;
75 inline bool operator!=(const QNetworkCookie &other) const
76 { return !(*this == other); }
77
78 bool isSecure() const;
79 void setSecure(bool enable);
80 bool isHttpOnly() const;
81 void setHttpOnly(bool enable);
82
83 bool isSessionCookie() const;
84 QDateTime expirationDate() const;
85 void setExpirationDate(const QDateTime &date);
86
87 QString domain() const;
88 void setDomain(const QString &domain);
89
90 QString path() const;
91 void setPath(const QString &path);
92
93 QByteArray name() const;
94 void setName(const QByteArray &cookieName);
95
96 QByteArray value() const;
97 void setValue(const QByteArray &value);
98
99 QByteArray toRawForm(RawForm form = Full) const;
100
101 bool hasSameIdentifier(const QNetworkCookie &other) const;
102 void normalize(const QUrl &url);
103
104 static QList<QNetworkCookie> parseCookies(const QByteArray &cookieString);
105
106private:
107 QSharedDataPointer<QNetworkCookiePrivate> d;
108 friend class QNetworkCookiePrivate;
109};
110
111Q_DECLARE_SHARED(QNetworkCookie)
112
113#ifndef QT_NO_DEBUG_STREAM
114class QDebug;
115Q_NETWORK_EXPORT QDebug operator<<(QDebug, const QNetworkCookie &);
116#endif
117
118QT_END_NAMESPACE
119
120Q_DECLARE_METATYPE(QNetworkCookie)
121
122#endif
123