MusixmatchLyricsProvider: Use API for lyrics search when possible
This commit is contained in:
Jonas Kvinge
parent
89e8518f31
commit
eaa33a03d7
@ -1,6 +1,6 @@
|
||||
/*
|
||||
* Strawberry Music Player
|
||||
* Copyright 2020-2021, Jonas Kvinge <jonas@jkvinge.net>
|
||||
* Copyright 2020-2022, Jonas Kvinge <jonas@jkvinge.net>
|
||||
*
|
||||
* Strawberry is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
@ -19,6 +19,8 @@
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include <memory>
|
||||
|
||||
#include <QObject>
|
||||
#include <QByteArray>
|
||||
#include <QVariant>
|
||||
@ -29,6 +31,7 @@
|
||||
#include <QNetworkRequest>
|
||||
#include <QNetworkReply>
|
||||
#include <QJsonObject>
|
||||
#include <QJsonArray>
|
||||
|
||||
#include "core/logging.h"
|
||||
#include "core/networkaccessmanager.h"
|
||||
@ -37,7 +40,10 @@
|
||||
#include "lyricsfetcher.h"
|
||||
#include "musixmatchlyricsprovider.h"
|
||||
|
||||
MusixmatchLyricsProvider::MusixmatchLyricsProvider(NetworkAccessManager *network, QObject *parent) : JsonLyricsProvider("Musixmatch", true, false, network, parent) {}
|
||||
const char *MusixmatchLyricsProvider::kApiUrl = "https://api.musixmatch.com/ws/1.1";
|
||||
const char *MusixmatchLyricsProvider::kApiKey = "Y2FhMDRlN2Y4OWE5OTIxYmZlOGMzOWQzOGI3ZGU4MjE=";
|
||||
|
||||
MusixmatchLyricsProvider::MusixmatchLyricsProvider(NetworkAccessManager *network, QObject *parent) : JsonLyricsProvider("Musixmatch", true, false, network, parent), rate_limit_exceeded_(false) {}
|
||||
|
||||
MusixmatchLyricsProvider::~MusixmatchLyricsProvider() {
|
||||
|
||||
@ -52,69 +58,258 @@ MusixmatchLyricsProvider::~MusixmatchLyricsProvider() {
|
||||
|
||||
bool MusixmatchLyricsProvider::StartSearch(const QString &artist, const QString &album, const QString &title, const int id) {
|
||||
|
||||
QString artist_stripped = artist;
|
||||
QString title_stripped = title;
|
||||
LyricsSearchContextPtr search = std::make_shared<LyricsSearchContext>();
|
||||
search->id = id;
|
||||
search->artist = artist;
|
||||
search->album = album;
|
||||
search->title = title;
|
||||
requests_search_.append(search);
|
||||
|
||||
artist_stripped = artist_stripped.replace('/', '-')
|
||||
.remove(QRegularExpression("[^\\w0-9\\- ]", QRegularExpression::UseUnicodePropertiesOption))
|
||||
.simplified()
|
||||
.replace(' ', '-')
|
||||
.replace(QRegularExpression("(-)\\1+"), "-")
|
||||
.toLower();
|
||||
|
||||
title_stripped = title_stripped.replace('/', '-')
|
||||
.remove(QRegularExpression("[^\\w0-9\\- ]", QRegularExpression::UseUnicodePropertiesOption))
|
||||
.simplified()
|
||||
.replace(' ', '-')
|
||||
.replace(QRegularExpression("(-)\\1+"), "-")
|
||||
.toLower();
|
||||
|
||||
if (artist_stripped.isEmpty() || title_stripped.isEmpty()) return false;
|
||||
|
||||
QUrl url(QString("https://www.musixmatch.com/lyrics/%1/%2").arg(artist_stripped, title_stripped));
|
||||
QNetworkRequest req(url);
|
||||
req.setAttribute(QNetworkRequest::RedirectPolicyAttribute, QNetworkRequest::NoLessSafeRedirectPolicy);
|
||||
#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
|
||||
req.setAttribute(QNetworkRequest::Http2AllowedAttribute, false);
|
||||
#endif
|
||||
QNetworkReply *reply = network_->get(req);
|
||||
replies_ << reply;
|
||||
QObject::connect(reply, &QNetworkReply::finished, this, [this, reply, id, artist, album, title]() { HandleSearchReply(reply, id, artist, album, title); });
|
||||
|
||||
qLog(Debug) << "MusixmatchLyrics: Sending request for" << artist_stripped << title_stripped << url;
|
||||
|
||||
return true;
|
||||
if (rate_limit_exceeded_) {
|
||||
return CreateLyricsRequest(search);
|
||||
}
|
||||
else {
|
||||
return SendSearchRequest(search);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
void MusixmatchLyricsProvider::CancelSearch(const int id) { Q_UNUSED(id); }
|
||||
|
||||
void MusixmatchLyricsProvider::HandleSearchReply(QNetworkReply *reply, const int id, const QString &artist, const QString &album, const QString &title) {
|
||||
bool MusixmatchLyricsProvider::SendSearchRequest(LyricsSearchContextPtr search) {
|
||||
|
||||
Q_UNUSED(album);
|
||||
const ParamList params = ParamList() << Param("apikey", QByteArray::fromBase64(kApiKey))
|
||||
<< Param("q_artist", search->artist)
|
||||
<< Param("q_track", search->title)
|
||||
<< Param("f_has_lyrics", "1");
|
||||
|
||||
QUrlQuery url_query;
|
||||
for (const Param ¶m : params) {
|
||||
url_query.addQueryItem(QUrl::toPercentEncoding(param.first), QUrl::toPercentEncoding(param.second));
|
||||
}
|
||||
|
||||
QUrl url(QString(kApiUrl) + QString("/track.search"));
|
||||
url.setQuery(url_query);
|
||||
QNetworkRequest req(url);
|
||||
req.setAttribute(QNetworkRequest::RedirectPolicyAttribute, QNetworkRequest::NoLessSafeRedirectPolicy);
|
||||
QNetworkReply *reply = network_->get(req);
|
||||
replies_ << reply;
|
||||
QObject::connect(reply, &QNetworkReply::finished, this, [this, reply, search]() { HandleSearchReply(reply, search); });
|
||||
|
||||
qLog(Debug) << "MusixmatchLyrics: Sending request for" << url;
|
||||
|
||||
return true;
|
||||
|
||||
}
|
||||
|
||||
void MusixmatchLyricsProvider::HandleSearchReply(QNetworkReply *reply, LyricsSearchContextPtr search) {
|
||||
|
||||
if (!replies_.contains(reply)) return;
|
||||
replies_.removeAll(reply);
|
||||
QObject::disconnect(reply, nullptr, this, nullptr);
|
||||
reply->deleteLater();
|
||||
|
||||
LyricsSearchResults results;
|
||||
if (reply->error() != QNetworkReply::NoError) {
|
||||
Error(QString("%1 (%2)").arg(reply->errorString()).arg(reply->error()));
|
||||
if (reply->error() == 402) {
|
||||
rate_limit_exceeded_ = true;
|
||||
CreateLyricsRequest(search);
|
||||
return;
|
||||
}
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
|
||||
if (reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt() != 200) {
|
||||
Error(QString("Received HTTP code %1").arg(reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt()));
|
||||
if (reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt() == 402) {
|
||||
rate_limit_exceeded_ = true;
|
||||
CreateLyricsRequest(search);
|
||||
return;
|
||||
}
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
|
||||
QByteArray data = reply->readAll();
|
||||
QJsonObject json_obj = ExtractJsonObj(data);
|
||||
if (json_obj.isEmpty()) {
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
|
||||
if (!json_obj.contains("message")) {
|
||||
Error("Json reply is missing message object.", json_obj);
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
if (!json_obj["message"].isObject()) {
|
||||
Error("Json reply message is not an object.", json_obj);
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
QJsonObject obj_message = json_obj["message"].toObject();
|
||||
|
||||
if (!obj_message.contains("header")) {
|
||||
Error("Json reply message object is missing header.", obj_message);
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
if (!obj_message["header"].isObject()) {
|
||||
Error("Json reply message header is not an object.", obj_message);
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
QJsonObject obj_header = obj_message["header"].toObject();
|
||||
|
||||
int status_code = obj_header["status_code"].toInt();
|
||||
if (status_code != 200) {
|
||||
Error(QString("Received status code %s").arg(status_code));
|
||||
if (status_code == 402) {
|
||||
rate_limit_exceeded_ = true;
|
||||
CreateLyricsRequest(search);
|
||||
return;
|
||||
}
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
|
||||
if (!obj_message.contains("body")) {
|
||||
Error("Json reply is missing body.", json_obj);
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
if (!obj_message["body"].isObject()) {
|
||||
Error("Json body is not an object.", json_obj);
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
QJsonObject obj_body = obj_message["body"].toObject();
|
||||
|
||||
if (!obj_body.contains("track_list")) {
|
||||
Error("Json response is missing body.", obj_body);
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
if (!obj_body["track_list"].isArray()) {
|
||||
Error("Json hits is not an array.", obj_body);
|
||||
EndSearch(search);
|
||||
return;
|
||||
}
|
||||
QJsonArray array_tracklist = obj_body["track_list"].toArray();
|
||||
|
||||
for (const QJsonValueRef value_track : array_tracklist) {
|
||||
if (!value_track.isObject()) {
|
||||
continue;
|
||||
}
|
||||
QJsonObject obj_track = value_track.toObject();
|
||||
|
||||
if (!obj_track.contains("track") || !obj_track["track"].isObject()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
obj_track = obj_track["track"].toObject();
|
||||
if (!obj_track.contains("artist_name") ||
|
||||
!obj_track.contains("album_name") ||
|
||||
!obj_track.contains("track_name") ||
|
||||
!obj_track.contains("track_share_url")) {
|
||||
Error("Missing one or more values in result object", obj_track);
|
||||
continue;
|
||||
}
|
||||
|
||||
QString artist_name = obj_track["artist_name"].toString();
|
||||
QString album_name = obj_track["album_name"].toString();
|
||||
QString track_name = obj_track["track_name"].toString();
|
||||
QUrl track_share_url(obj_track["track_share_url"].toString());
|
||||
|
||||
// Ignore results where both the artist, album and title don't match.
|
||||
if (artist_name.compare(search->artist, Qt::CaseInsensitive) != 0 &&
|
||||
album_name.compare(search->album, Qt::CaseInsensitive) != 0 &&
|
||||
track_name.compare(search->title, Qt::CaseInsensitive) != 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!track_share_url.isValid()) continue;
|
||||
|
||||
if (search->requests_lyrics_.contains(track_share_url)) continue;
|
||||
search->requests_lyrics_.append(track_share_url);
|
||||
|
||||
}
|
||||
|
||||
if (search->requests_lyrics_.isEmpty()) {
|
||||
EndSearch(search);
|
||||
}
|
||||
else {
|
||||
for (const QUrl &url : search->requests_lyrics_) {
|
||||
SendLyricsRequest(search, url);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
QString MusixmatchLyricsProvider::StringFixup(QString string) {
|
||||
|
||||
return string.replace('/', '-')
|
||||
.replace('\'', '-')
|
||||
.remove(QRegularExpression("[^\\w0-9\\- ]", QRegularExpression::UseUnicodePropertiesOption))
|
||||
.simplified()
|
||||
.replace(' ', '-')
|
||||
.replace(QRegularExpression("(-)\\1+"), "-")
|
||||
.toLower();
|
||||
|
||||
}
|
||||
|
||||
bool MusixmatchLyricsProvider::CreateLyricsRequest(LyricsSearchContextPtr search) {
|
||||
|
||||
QString artist_stripped = StringFixup(search->artist);
|
||||
QString title_stripped = StringFixup(search->title);
|
||||
if (artist_stripped.isEmpty() || title_stripped.isEmpty()) {
|
||||
EndSearch(search);
|
||||
return false;
|
||||
}
|
||||
|
||||
QUrl url(QString("https://www.musixmatch.com/lyrics/%1/%2").arg(artist_stripped, title_stripped));
|
||||
search->requests_lyrics_.append(url);
|
||||
return SendLyricsRequest(search, url);
|
||||
|
||||
}
|
||||
|
||||
bool MusixmatchLyricsProvider::SendLyricsRequest(LyricsSearchContextPtr search, const QUrl &url) {
|
||||
|
||||
QNetworkRequest req(url);
|
||||
req.setAttribute(QNetworkRequest::RedirectPolicyAttribute, QNetworkRequest::NoLessSafeRedirectPolicy);
|
||||
QNetworkReply *reply = network_->get(req);
|
||||
replies_ << reply;
|
||||
QObject::connect(reply, &QNetworkReply::finished, this, [this, reply, search, url]() { HandleLyricsReply(reply, search, url); });
|
||||
|
||||
qLog(Debug) << "MusixmatchLyrics: Sending request for" << url;
|
||||
|
||||
return true;
|
||||
|
||||
}
|
||||
|
||||
void MusixmatchLyricsProvider::HandleLyricsReply(QNetworkReply *reply, LyricsSearchContextPtr search, const QUrl &url) {
|
||||
|
||||
if (!replies_.contains(reply)) return;
|
||||
replies_.removeAll(reply);
|
||||
QObject::disconnect(reply, nullptr, this, nullptr);
|
||||
reply->deleteLater();
|
||||
|
||||
if (reply->error() != QNetworkReply::NoError) {
|
||||
Error(QString("%1 (%2)").arg(reply->errorString()).arg(reply->error()));
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
else if (reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt() != 200) {
|
||||
Error(QString("Received HTTP code %1").arg(reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt()));
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
|
||||
QByteArray data = reply->readAll();
|
||||
if (data.isEmpty()) {
|
||||
Error("Empty reply received from server.");
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
|
||||
@ -132,58 +327,58 @@ void MusixmatchLyricsProvider::HandleSearchReply(QNetworkReply *reply, const int
|
||||
}
|
||||
|
||||
if (content_json.isEmpty()) {
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
|
||||
if (content_json.contains(QRegularExpression("<[^>]*>"))) { // Make sure it's not HTML code.
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
|
||||
QJsonObject json_obj = ExtractJsonObj(content_json.toUtf8());
|
||||
if (json_obj.isEmpty()) {
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
|
||||
if (!json_obj.contains("page") || !json_obj["page"].isObject()) {
|
||||
Error("Json reply is missing page.", json_obj);
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
json_obj = json_obj["page"].toObject();
|
||||
|
||||
|
||||
if (!json_obj.contains("track") || !json_obj["track"].isObject()) {
|
||||
Error("Json reply is missing track.", json_obj);
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
QJsonObject obj_track = json_obj["track"].toObject();
|
||||
|
||||
if (!obj_track.contains("artistName") || !obj_track.contains("albumName") || !obj_track.contains("name")) {
|
||||
Error("Json track is missing artistName, albumName or name.", json_obj);
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
|
||||
if (!json_obj.contains("lyrics") || !json_obj["lyrics"].isObject()) {
|
||||
Error("Json reply is missing lyrics.", json_obj);
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
QJsonObject obj_lyrics = json_obj["lyrics"].toObject();
|
||||
|
||||
if (!obj_lyrics.contains("lyrics") || !obj_lyrics["lyrics"].isObject()) {
|
||||
Error("Json reply is missing lyrics.", obj_lyrics);
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
obj_lyrics = obj_lyrics["lyrics"].toObject();
|
||||
|
||||
if (obj_lyrics.isEmpty() || !obj_lyrics.contains("body")) {
|
||||
emit SearchFinished(id, results);
|
||||
EndSearch(search, url);
|
||||
return;
|
||||
}
|
||||
|
||||
LyricsSearchResult result;
|
||||
@ -192,19 +387,33 @@ void MusixmatchLyricsProvider::HandleSearchReply(QNetworkReply *reply, const int
|
||||
result.title = obj_track["name"].toString();
|
||||
result.lyrics = obj_lyrics["body"].toString();
|
||||
|
||||
if (!result.lyrics.isEmpty() && (result.artist.compare(artist, Qt::CaseInsensitive) == 0 || result.title.compare(title, Qt::CaseInsensitive) == 0)) {
|
||||
if (!result.lyrics.isEmpty() &&
|
||||
(result.artist.compare(search->artist, Qt::CaseInsensitive) == 0 ||
|
||||
result.title.compare(search->title, Qt::CaseInsensitive) == 0)) {
|
||||
result.lyrics = Utilities::DecodeHtmlEntities(result.lyrics);
|
||||
results.append(result);
|
||||
search->results.append(result);
|
||||
}
|
||||
|
||||
if (results.isEmpty()) {
|
||||
qLog(Debug) << "MusixmatchLyrics: No lyrics for" << artist << title;
|
||||
}
|
||||
else {
|
||||
qLog(Debug) << "MusixmatchLyrics: Got lyrics for" << artist << title;
|
||||
EndSearch(search, url);
|
||||
|
||||
}
|
||||
|
||||
void MusixmatchLyricsProvider::EndSearch(LyricsSearchContextPtr search, const QUrl &url) {
|
||||
|
||||
if (search->requests_lyrics_.contains(url)) {
|
||||
search->requests_lyrics_.removeAll(url);
|
||||
}
|
||||
|
||||
emit SearchFinished(id, results);
|
||||
if (search->requests_lyrics_.count() == 0) {
|
||||
requests_search_.removeAll(search);
|
||||
if (search->results.isEmpty()) {
|
||||
qLog(Debug) << "Musixmatch: No lyrics for" << search->artist << search->title;
|
||||
}
|
||||
else {
|
||||
qLog(Debug) << "Musixmatch: Got lyrics for" << search->artist << search->title;
|
||||
}
|
||||
emit SearchFinished(search->id, search->results);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/*
|
||||
* Strawberry Music Player
|
||||
* Copyright 2020-2021, Jonas Kvinge <jonas@jkvinge.net>
|
||||
* Copyright 2020-2022, Jonas Kvinge <jonas@jkvinge.net>
|
||||
*
|
||||
* Strawberry is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
@ -22,11 +22,14 @@
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include <memory>
|
||||
|
||||
#include <QtGlobal>
|
||||
#include <QObject>
|
||||
#include <QList>
|
||||
#include <QVariant>
|
||||
#include <QString>
|
||||
#include <QUrl>
|
||||
|
||||
#include "jsonlyricsprovider.h"
|
||||
#include "lyricsfetcher.h"
|
||||
@ -45,13 +48,36 @@ class MusixmatchLyricsProvider : public JsonLyricsProvider {
|
||||
void CancelSearch(const int id) override;
|
||||
|
||||
private:
|
||||
struct LyricsSearchContext {
|
||||
explicit LyricsSearchContext() : id(-1) {}
|
||||
int id;
|
||||
QString artist;
|
||||
QString album;
|
||||
QString title;
|
||||
QList<QUrl> requests_lyrics_;
|
||||
LyricsSearchResults results;
|
||||
};
|
||||
|
||||
using LyricsSearchContextPtr = std::shared_ptr<LyricsSearchContext>;
|
||||
|
||||
QString StringFixup(QString string);
|
||||
bool SendSearchRequest(LyricsSearchContextPtr search);
|
||||
bool CreateLyricsRequest(LyricsSearchContextPtr search);
|
||||
bool CreateLyricsRequest(LyricsSearchContextPtr search, const QUrl &url);
|
||||
bool SendLyricsRequest(LyricsSearchContextPtr search, const QUrl &url);
|
||||
void EndSearch(LyricsSearchContextPtr search, const QUrl &url = QUrl());
|
||||
void Error(const QString &error, const QVariant &debug = QVariant()) override;
|
||||
|
||||
private slots:
|
||||
void HandleSearchReply(QNetworkReply *reply, const int id, const QString &artist, const QString &album, const QString &title);
|
||||
void HandleSearchReply(QNetworkReply *reply, LyricsSearchContextPtr search);
|
||||
void HandleLyricsReply(QNetworkReply *reply, LyricsSearchContextPtr search, const QUrl &url);
|
||||
|
||||
private:
|
||||
static const char *kApiUrl;
|
||||
static const char *kApiKey;
|
||||
QList<LyricsSearchContextPtr> requests_search_;
|
||||
QList<QNetworkReply*> replies_;
|
||||
bool rate_limit_exceeded_;
|
||||
|
||||
};
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user