1 /* This file is part of Clementine.
2 Copyright 2012, Martin Björklund <mbj4668@gmail.com>
3 Copyright 2018, Jonas Kvinge <jonas@jkvinge.net>
4
5 Clementine is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
9
10 Clementine is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with Clementine. If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 #include <QByteArray>
20 #include <QJsonDocument>
21 #include <QJsonObject>
22 #include <QList>
23 #include <QNetworkReply>
24 #include <QNetworkRequest>
25 #include <QPair>
26 #include <QString>
27 #include <QStringList>
28 #include <QUrlQuery>
29 #include <QVariant>
30
31 #include "discogscoverprovider.h"
32
33 #include "core/closure.h"
34 #include "core/logging.h"
35 #include "core/network.h"
36 #include "core/utilities.h"
37
38 const char* DiscogsCoverProvider::kUrlSearch =
39 "https://api.discogs.com/database/search";
40 const char* DiscogsCoverProvider::kUrlReleases =
41 "https://api.discogs.com/releases";
42
43 const char* DiscogsCoverProvider::kAccessKeyB64 =
44 "YVR4Yk5JTnlmUkhFY0pTaldid2c=";
45 const char* DiscogsCoverProvider::kSecretKeyB64 =
46 "QkJNb2tMVXVUVFhSRWRUVmZDc0ZGamZmSWRjdHZRVno=";
47
DiscogsCoverProvider(QObject * parent)48 DiscogsCoverProvider::DiscogsCoverProvider(QObject* parent)
49 : CoverProvider("Discogs", false, parent),
50 network_(new NetworkAccessManager(this)) {}
51
StartSearch(const QString & artist,const QString & album,int s_id)52 bool DiscogsCoverProvider::StartSearch(const QString& artist,
53 const QString& album, int s_id) {
54 DiscogsCoverSearchContext* s_ctx = new DiscogsCoverSearchContext;
55
56 s_ctx->id = s_id;
57 s_ctx->artist = artist;
58 s_ctx->album = album;
59 s_ctx->r_count = 0;
60 requests_search_.insert(s_id, s_ctx);
61 SendSearchRequest(s_ctx);
62
63 return true;
64 }
65
CancelSearch(int id)66 void DiscogsCoverProvider::CancelSearch(int id) {
67 delete requests_search_.take(id);
68 }
69
StartRelease(DiscogsCoverSearchContext * s_ctx,int r_id,QString resource_url)70 bool DiscogsCoverProvider::StartRelease(DiscogsCoverSearchContext* s_ctx,
71 int r_id, QString resource_url) {
72 DiscogsCoverReleaseContext* r_ctx = new DiscogsCoverReleaseContext;
73
74 s_ctx->r_count++;
75
76 r_ctx->id = r_id;
77 r_ctx->resource_url = resource_url;
78
79 r_ctx->s_id = s_ctx->id;
80
81 requests_release_.insert(r_id, r_ctx);
82 SendReleaseRequest(s_ctx, r_ctx);
83
84 return true;
85 }
86
SendSearchRequest(DiscogsCoverSearchContext * s_ctx)87 void DiscogsCoverProvider::SendSearchRequest(DiscogsCoverSearchContext* s_ctx) {
88 typedef QPair<QString, QString> Arg;
89 typedef QList<Arg> ArgList;
90
91 typedef QPair<QByteArray, QByteArray> EncodedArg;
92 typedef QList<EncodedArg> EncodedArgList;
93
94 ArgList args =
95 ArgList() << Arg("key", QByteArray::fromBase64(kAccessKeyB64))
96 << Arg("secret", QByteArray::fromBase64(kSecretKeyB64));
97
98 args.append(Arg("type", "release"));
99 if (!s_ctx->artist.isEmpty()) {
100 args.append(Arg("artist", s_ctx->artist.toLower()));
101 }
102 if (!s_ctx->album.isEmpty()) {
103 args.append(Arg("release_title", s_ctx->album.toLower()));
104 }
105
106 QUrlQuery url_query;
107 QUrl url(kUrlSearch);
108 QStringList query_items;
109
110 // Encode the arguments
111 for (const Arg& arg : args) {
112 EncodedArg encoded_arg(QUrl::toPercentEncoding(arg.first),
113 QUrl::toPercentEncoding(arg.second));
114 query_items << QString(encoded_arg.first + "=" + encoded_arg.second);
115 url_query.addQueryItem(encoded_arg.first, encoded_arg.second);
116 }
117
118 // Sign the request
119 const QByteArray data_to_sign =
120 QString("GET\n%1\n%2\n%3")
121 .arg(url.host(), url.path(), query_items.join("&"))
122 .toUtf8();
123 const QByteArray signature(Utilities::HmacSha256(
124 QByteArray::fromBase64(kSecretKeyB64), data_to_sign));
125
126 // Add the signature to the request
127 url_query.addQueryItem("Signature",
128 QUrl::toPercentEncoding(signature.toBase64()));
129
130 url.setQuery(url_query);
131 QNetworkReply* reply = network_->get(QNetworkRequest(url));
132
133 NewClosure(reply, SIGNAL(error(QNetworkReply::NetworkError)), this,
134 SLOT(SearchRequestError(QNetworkReply::NetworkError,
135 QNetworkReply*, int)),
136 reply, s_ctx->id);
137 NewClosure(reply, SIGNAL(finished()), this,
138 SLOT(HandleSearchReply(QNetworkReply*, int)), reply, s_ctx->id);
139 }
140
SendReleaseRequest(DiscogsCoverSearchContext * s_ctx,DiscogsCoverReleaseContext * r_ctx)141 void DiscogsCoverProvider::SendReleaseRequest(
142 DiscogsCoverSearchContext* s_ctx, DiscogsCoverReleaseContext* r_ctx) {
143 typedef QPair<QString, QString> Arg;
144 typedef QList<Arg> ArgList;
145
146 typedef QPair<QByteArray, QByteArray> EncodedArg;
147 typedef QList<EncodedArg> EncodedArgList;
148
149 QUrlQuery url_query;
150 QStringList query_items;
151
152 ArgList args =
153 ArgList() << Arg("key", QByteArray::fromBase64(kAccessKeyB64))
154 << Arg("secret", QByteArray::fromBase64(kSecretKeyB64));
155 // Encode the arguments
156 for (const Arg& arg : args) {
157 EncodedArg encoded_arg(QUrl::toPercentEncoding(arg.first),
158 QUrl::toPercentEncoding(arg.second));
159 query_items << QString(encoded_arg.first + "=" + encoded_arg.second);
160 url_query.addQueryItem(encoded_arg.first, encoded_arg.second);
161 }
162
163 QUrl url(r_ctx->resource_url);
164
165 // Sign the request
166 const QByteArray data_to_sign =
167 QString("GET\n%1\n%2\n%3")
168 .arg(url.host(), url.path(), query_items.join("&"))
169 .toUtf8();
170 const QByteArray signature(Utilities::HmacSha256(
171 QByteArray::fromBase64(kSecretKeyB64), data_to_sign));
172
173 // Add the signature to the request
174 url_query.addQueryItem("Signature",
175 QUrl::toPercentEncoding(signature.toBase64()));
176
177 url.setQuery(url_query);
178 QNetworkReply* reply = network_->get(QNetworkRequest(url));
179
180 NewClosure(reply, SIGNAL(error(QNetworkReply::NetworkError)), this,
181 SLOT(ReleaseRequestError(QNetworkReply::NetworkError,
182 QNetworkReply*, int, int)),
183 reply, s_ctx->id, r_ctx->id);
184 NewClosure(reply, SIGNAL(finished()), this,
185 SLOT(HandleReleaseReply(QNetworkReply*, int, int)), reply,
186 s_ctx->id, r_ctx->id);
187 }
188
HandleSearchReply(QNetworkReply * reply,int s_id)189 void DiscogsCoverProvider::HandleSearchReply(QNetworkReply* reply, int s_id) {
190 reply->deleteLater();
191
192 if (!requests_search_.contains(s_id)) return;
193 DiscogsCoverSearchContext* s_ctx = requests_search_.value(s_id);
194
195 QJsonDocument json_doc = QJsonDocument::fromJson(reply->readAll());
196 if ((json_doc.isNull()) || (!json_doc.isObject())) {
197 qLog(Error) << "Discogs: Failed to create JSON doc.";
198 EndSearch(s_ctx);
199 return;
200 }
201
202 QJsonObject json_obj = json_doc.object();
203 if (json_obj.isEmpty()) {
204 qLog(Error) << "Discogs: Failed to create JSON object.";
205 EndSearch(s_ctx);
206 return;
207 }
208
209 QVariantMap reply_map = json_obj.toVariantMap();
210 if (!reply_map.contains("results")) {
211 EndSearch(s_ctx);
212 return;
213 }
214
215 QVariantList results = reply_map["results"].toList();
216 int i = 0;
217 for (const QVariant& result : results) {
218 QVariantMap result_map = result.toMap();
219 if ((result_map.contains("id")) && (result_map.contains("resource_url"))) {
220 int r_id = result_map["id"].toInt();
221 QString title = result_map["title"].toString();
222 QString resource_url = result_map["resource_url"].toString();
223 if (resource_url.isEmpty()) continue;
224 StartRelease(s_ctx, r_id, resource_url);
225 i++;
226 }
227 }
228 if (i <= 0) EndSearch(s_ctx);
229 }
230
HandleReleaseReply(QNetworkReply * reply,int s_id,int r_id)231 void DiscogsCoverProvider::HandleReleaseReply(QNetworkReply* reply, int s_id,
232 int r_id) {
233 reply->deleteLater();
234
235 if (!requests_release_.contains(r_id)) return;
236 DiscogsCoverReleaseContext* r_ctx = requests_release_.value(r_id);
237
238 if (!requests_search_.contains(s_id)) {
239 EndSearch(r_ctx);
240 return;
241 }
242 DiscogsCoverSearchContext* s_ctx = requests_search_.value(s_id);
243
244 QJsonDocument json_doc = QJsonDocument::fromJson(reply->readAll());
245 if ((json_doc.isNull()) || (!json_doc.isObject())) {
246 qLog(Error) << "Discogs: Failed to create JSON doc.";
247 EndSearch(s_ctx, r_ctx);
248 return;
249 }
250 QJsonObject json_obj = json_doc.object();
251 if (json_obj.isEmpty()) {
252 qLog(Error) << "Discogs: JSON object is empty.";
253 EndSearch(s_ctx, r_ctx);
254 return;
255 }
256
257 QVariantMap reply_map = json_obj.toVariantMap();
258 if (!reply_map.contains("images")) {
259 EndSearch(s_ctx, r_ctx);
260 return;
261 }
262
263 QVariantList results = reply_map["images"].toList();
264
265 for (const QVariant& result : results) {
266 QVariantMap result_map = result.toMap();
267 CoverSearchResult cover_result;
268 cover_result.description = s_ctx->title;
269
270 if (result_map.contains("type")) {
271 QString type = result_map["type"].toString();
272 if (type != "primary") continue;
273 }
274 if (result_map.contains("resource_url")) {
275 cover_result.image_url = QUrl(result_map["resource_url"].toString());
276 }
277 if (cover_result.image_url.isEmpty()) continue;
278 s_ctx->results.append(cover_result);
279 }
280
281 EndSearch(s_ctx, r_ctx);
282 }
283
SearchRequestError(QNetworkReply::NetworkError error,QNetworkReply * reply,int s_id)284 void DiscogsCoverProvider::SearchRequestError(QNetworkReply::NetworkError error,
285 QNetworkReply* reply, int s_id) {
286 if (!requests_search_.contains(s_id)) return;
287 DiscogsCoverSearchContext* s_ctx = requests_search_.value(s_id);
288
289 EndSearch(s_ctx);
290 }
291
ReleaseRequestError(QNetworkReply::NetworkError error,QNetworkReply * reply,int s_id,int r_id)292 void DiscogsCoverProvider::ReleaseRequestError(
293 QNetworkReply::NetworkError error, QNetworkReply* reply, int s_id,
294 int r_id) {
295 if (!requests_release_.contains(r_id)) return;
296 DiscogsCoverReleaseContext* r_ctx = requests_release_.value(r_id);
297
298 if (!requests_search_.contains(s_id)) {
299 EndSearch(r_ctx);
300 return;
301 }
302 DiscogsCoverSearchContext* s_ctx = requests_search_.value(s_id);
303 EndSearch(s_ctx, r_ctx);
304 }
305
EndSearch(DiscogsCoverSearchContext * s_ctx,DiscogsCoverReleaseContext * r_ctx)306 void DiscogsCoverProvider::EndSearch(DiscogsCoverSearchContext* s_ctx,
307 DiscogsCoverReleaseContext* r_ctx) {
308 delete requests_release_.take(r_ctx->id);
309
310 s_ctx->r_count--;
311
312 if (s_ctx->r_count <= 0) EndSearch(s_ctx);
313 }
314
EndSearch(DiscogsCoverSearchContext * s_ctx)315 void DiscogsCoverProvider::EndSearch(DiscogsCoverSearchContext* s_ctx) {
316 requests_search_.remove(s_ctx->id);
317 emit SearchFinished(s_ctx->id, s_ctx->results);
318 delete s_ctx;
319 }
320
EndSearch(DiscogsCoverReleaseContext * r_ctx)321 void DiscogsCoverProvider::EndSearch(DiscogsCoverReleaseContext* r_ctx) {
322 delete requests_release_.take(r_ctx->id);
323 }
324