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
201
202
203
204
205
206
207
208
209
210
|
#include <utility>
/******************************************************************************
* Copyright (C) 2017 Kitsune Ral <kitsune-ral@users.sf.net>
*
* 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 Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include "avatar.h"
#include "jobs/mediathumbnailjob.h"
#include "events/eventcontent.h"
#include "connection.h"
#include <QtGui/QPainter>
#include <QtCore/QPointer>
#include <QtCore/QDir>
#include <QtCore/QStandardPaths>
#include <QtCore/QStringBuilder>
using namespace QMatrixClient;
using std::move;
class Avatar::Private
{
public:
explicit Private(QUrl url = {})
: _url(move(url))
{ }
~Private()
{
if (isJobRunning(_thumbnailRequest))
_thumbnailRequest->abandon();
if (isJobRunning(_uploadRequest))
_uploadRequest->abandon();
}
QImage get(Connection* connection, QSize size,
get_callback_t callback) const;
bool upload(UploadContentJob* job, upload_callback_t callback);
bool checkUrl(const QUrl& url) const;
QString localFile() const;
QUrl _url;
// The below are related to image caching, hence mutable
mutable QImage _originalImage;
mutable std::vector<QPair<QSize, QImage>> _scaledImages;
mutable QSize _requestedSize;
mutable enum { Unknown, Cache, Network, Banned } _imageSource = Unknown;
mutable QPointer<MediaThumbnailJob> _thumbnailRequest = nullptr;
mutable QPointer<BaseJob> _uploadRequest = nullptr;
mutable std::vector<get_callback_t> callbacks;
};
Avatar::Avatar()
: d(std::make_unique<Private>())
{ }
Avatar::Avatar(QUrl url)
: d(std::make_unique<Private>(std::move(url)))
{ }
Avatar::Avatar(Avatar&&) = default;
Avatar::~Avatar() = default;
Avatar& Avatar::operator=(Avatar&&) = default;
QImage Avatar::get(Connection* connection, int dimension,
get_callback_t callback) const
{
return d->get(connection, {dimension, dimension}, move(callback));
}
QImage Avatar::get(Connection* connection, int width, int height,
get_callback_t callback) const
{
return d->get(connection, {width, height}, move(callback));
}
bool Avatar::upload(Connection* connection, const QString& fileName,
upload_callback_t callback) const
{
if (isJobRunning(d->_uploadRequest))
return false;
return d->upload(connection->uploadFile(fileName), move(callback));
}
bool Avatar::upload(Connection* connection, QIODevice* source,
upload_callback_t callback) const
{
if (isJobRunning(d->_uploadRequest) || !source->isReadable())
return false;
return d->upload(connection->uploadContent(source), move(callback));
}
QString Avatar::mediaId() const
{
return d->_url.authority() + d->_url.path();
}
QImage Avatar::Private::get(Connection* connection, QSize size,
get_callback_t callback) const
{
if (!callback)
{
qCCritical(MAIN) << "Null callbacks are not allowed in Avatar::get";
Q_ASSERT(false);
}
if (_imageSource == Unknown && _originalImage.load(localFile()))
{
_imageSource = Cache;
_requestedSize = _originalImage.size();
}
// Alternating between longer-width and longer-height requests is a sure way
// to trick the below code into constantly getting another image from
// the server because the existing one is alleged unsatisfactory.
// Client authors can only blame themselves if they do so.
if (((_imageSource == Unknown && !_thumbnailRequest) ||
size.width() > _requestedSize.width() ||
size.height() > _requestedSize.height()) && checkUrl(_url)) {
qCDebug(MAIN) << "Getting avatar from" << _url.toString();
_requestedSize = size;
if (isJobRunning(_thumbnailRequest))
_thumbnailRequest->abandon();
if (callback)
callbacks.emplace_back(move(callback));
_thumbnailRequest = connection->getThumbnail(_url, size);
QObject::connect( _thumbnailRequest, &MediaThumbnailJob::success,
_thumbnailRequest, [this] {
_imageSource = Network;
_originalImage =
_thumbnailRequest->scaledThumbnail(_requestedSize);
_originalImage.save(localFile());
_scaledImages.clear();
for (const auto& n: callbacks)
n();
callbacks.clear();
});
}
for (const auto& p: _scaledImages)
if (p.first == size)
return p.second;
auto result = _originalImage.isNull() ? QImage() : _originalImage.scaled(size,
Qt::KeepAspectRatio, Qt::SmoothTransformation);
_scaledImages.emplace_back(size, result);
return result;
}
bool Avatar::Private::upload(UploadContentJob* job, upload_callback_t callback)
{
_uploadRequest = job;
if (!isJobRunning(_uploadRequest))
return false;
_uploadRequest->connect(_uploadRequest, &BaseJob::success, _uploadRequest,
[job,callback] { callback(job->contentUri()); });
return true;
}
bool Avatar::Private::checkUrl(const QUrl& url) const
{
if (_imageSource == Banned || url.isEmpty())
return false;
// FIXME: Make "mxc" a library-wide constant and maybe even make
// the URL checker a Connection(?) method.
if (!url.isValid() || url.scheme() != "mxc" || url.path().count('/') != 1)
{
qCWarning(MAIN) << "Avatar URL is invalid or not mxc-based:"
<< url.toDisplayString();
_imageSource = Banned;
}
return _imageSource != Banned;
}
QString Avatar::Private::localFile() const {
static const auto cachePath = cacheLocation(QStringLiteral("avatars"));
return cachePath % _url.authority() % '_' % _url.fileName() % ".png";
}
QUrl Avatar::url() const { return d->_url; }
bool Avatar::updateUrl(const QUrl& newUrl)
{
if (newUrl == d->_url)
return false;
d->_url = newUrl;
d->_imageSource = Private::Unknown;
if (isJobRunning(d->_thumbnailRequest))
d->_thumbnailRequest->abandon();
return true;
}
|
