File: captcha.cpp

package info (click to toggle)
telepathy-qt 0.9.1-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 38,764 kB
  • sloc: cpp: 59,914; xml: 34,543; ansic: 21,194; python: 3,370; sh: 118; makefile: 20
file content (200 lines) | stat: -rw-r--r-- 4,242 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/**
 * This file is part of TelepathyQt
 *
 * @copyright Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
 * @copyright Copyright (C) 2012 Nokia Corporation
 * @license LGPL 2.1
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#include <TelepathyQt/Captcha>

namespace Tp
{

struct TP_QT_NO_EXPORT Captcha::Private : public QSharedData
{
    Private();
    Private(const Captcha::Private &other);
    ~Private();

    QString mimeType;
    QString label;
    QByteArray captchaData;
    CaptchaAuthentication::ChallengeType type;
    uint id;
};

Captcha::Private::Private()
    : type(CaptchaAuthentication::NoChallenge),
      id(0)
{
}

Captcha::Private::Private(const Private &other)
    : QSharedData(other),
      mimeType(other.mimeType),
      label(other.label),
      captchaData(other.captchaData),
      type(other.type),
      id(other.id)
{
}

Captcha::Private::~Private()
{
}

/**
 * \class Captcha
 * \ingroup client
 * \headerfile TelepathyQt/captcha.h <TelepathyQt/Captcha>
 *
 * \brief The Captcha class represents a Captcha ready to be answered.
 *
 * It exposes all the parameters needed for a handler to present the user with a captcha.
 *
 * Please note this class is meant to be read-only. It is usually created by PendingCaptchas
 * once a Captcha request operation succeeds.
 *
 * Please note that this class is implicitly shared.
 */

/**
 * Default constructor.
 */
Captcha::Captcha()
{
}

/**
 * Copy constructor.
 */
Captcha::Captcha(const Captcha &other)
    : mPriv(other.mPriv)
{
}

Captcha::Captcha(const QString &mimeType, const QString &label,
        const QByteArray &data, CaptchaAuthentication::ChallengeType type, uint id)
    : mPriv(new Captcha::Private)
{
    mPriv->mimeType = mimeType;
    mPriv->label = label;
    mPriv->captchaData = data;
    mPriv->type = type;
    mPriv->id = id;
}

/**
 * Class destructor.
 */
Captcha::~Captcha()
{
}

Captcha &Captcha::operator=(const Captcha &rhs)
{
    if (this==&rhs) {
        //Protect against self-assignment
        return *this;
    }

    mPriv = rhs.mPriv;
    return *this;
}

/**
 * Return the mimetype of the captcha.
 *
 * \return The captcha's mimetype.
 * \sa data()
 */
QString Captcha::mimeType() const
{
    if (!isValid()) {
        return QString();
    }

    return mPriv->mimeType;
}

/**
 * Return the label of the captcha. For some captcha types, such as
 * CaptchaAuthentication::TextQuestionChallenge, the label is also
 * the challenge the user has to answer
 *
 * \return The captcha's label.
 * \sa data()
 *     type()
 */
QString Captcha::label() const
{
    if (!isValid()) {
        return QString();
    }

    return mPriv->label;
}

/**
 * Return the raw data of the captcha. The handler can check its type and
 * metatype to know how to parse the blob.
 *
 * \return The captcha's data.
 * \sa mimeType(), type()
 */
QByteArray Captcha::data() const
{
    if (!isValid()) {
        return QByteArray();
    }

    return mPriv->captchaData;
}

/**
 * Return the type of the captcha.
 *
 * \return The captcha's type.
 * \sa data()
 */
CaptchaAuthentication::ChallengeType Captcha::type() const
{
    if (!isValid()) {
        return CaptchaAuthentication::NoChallenge;
    }

    return mPriv->type;
}

/**
 * Return the id of the captcha. This parameter should be used to identify
 * the captcha when answering its challenge.
 *
 * \return The captcha's id.
 * \sa CaptchaAuthentication::answer()
 */
uint Captcha::id() const
{
    if (!isValid()) {
        return 0;
    }

    return mPriv->id;
}

}