Add lyricfind.com lyrics provider

src/CMakeLists.txt

@@ -201,6 +201,7 @@ set(SOURCES
   lyrics/azlyricscomlyricsprovider.cpp
   lyrics/elyricsnetlyricsprovider.cpp
   lyrics/letraslyricsprovider.cpp
+  lyrics/lyricfindlyricsprovider.cpp
 
   providers/musixmatchprovider.cpp
 
@@ -453,6 +454,7 @@ set(HEADERS
   lyrics/azlyricscomlyricsprovider.h
   lyrics/elyricsnetlyricsprovider.h
   lyrics/letraslyricsprovider.h
+  lyrics/lyricfindlyricsprovider.h
 
   settings/settingsdialog.h
   settings/settingspage.h

src/core/application.cpp

@@ -69,6 +69,7 @@
 #include "lyrics/azlyricscomlyricsprovider.h"
 #include "lyrics/elyricsnetlyricsprovider.h"
 #include "lyrics/letraslyricsprovider.h"
+#include "lyrics/lyricfindlyricsprovider.h"
 
 #include "scrobbler/audioscrobbler.h"
 #include "scrobbler/lastfmscrobbler.h"
@@ -179,6 +180,7 @@ class ApplicationImpl {
           lyrics_providers->AddProvider(new AzLyricsComLyricsProvider(app->network()));
           lyrics_providers->AddProvider(new ElyricsNetLyricsProvider(app->network()));
           lyrics_providers->AddProvider(new LetrasLyricsProvider(app->network()));
+          lyrics_providers->AddProvider(new LyricFindLyricsProvider(app->network()));
           lyrics_providers->ReloadSettings();
           return lyrics_providers;
         }),

src/lyrics/lyricfindlyricsprovider.cpp

@@ -0,0 +1,211 @@
+/*
+ * Strawberry Music Player
+ * Copyright 2024, 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Strawberry 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Strawberry.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include "config.h"
+
+#include <QByteArray>
+#include <QVariant>
+#include <QString>
+#include <QUrl>
+#include <QNetworkRequest>
+#include <QNetworkReply>
+#include <QRegularExpression>
+#include <QJsonDocument>
+#include <QJsonObject>
+#include <QScopeGuard>
+
+#include "core/logging.h"
+#include "core/networkaccessmanager.h"
+#include "utilities/transliterate.h"
+#include "lyricfindlyricsprovider.h"
+
+namespace {
+constexpr char kUrl[] = "https://lyrics.lyricfind.com/lyrics";
+constexpr char kLyricsStart[] = "<script id=\"__NEXT_DATA__\" type=\"application/json\">";
+constexpr char kLyricsEnd[] = "</script>";
+}  // namespace
+
+LyricFindLyricsProvider::LyricFindLyricsProvider(SharedPtr<NetworkAccessManager> network, QObject *parent) : JsonLyricsProvider(QStringLiteral("lyricfind.com"), true, false, network, parent) {}
+
+LyricFindLyricsProvider::~LyricFindLyricsProvider() {
+
+  while (!replies_.isEmpty()) {
+    QNetworkReply *reply = replies_.takeFirst();
+    QObject::disconnect(reply, nullptr, this, nullptr);
+    reply->abort();
+    reply->deleteLater();
+  }
+
+}
+
+QUrl LyricFindLyricsProvider::Url(const LyricsSearchRequest &request) {
+
+  return QUrl(QLatin1String(kUrl) + QLatin1Char('/') + StringFixup(request.artist) + QLatin1Char('-') + StringFixup(request.title));
+
+}
+
+QString LyricFindLyricsProvider::StringFixup(const QString &text) {
+
+  return Utilities::Transliterate(text)
+    .remove(QRegularExpression(QStringLiteral("[^\\w0-9_\\- ]")))
+    .replace(QRegularExpression(QStringLiteral(" {2,}")), QStringLiteral(" "))
+    .simplified()
+    .replace(QLatin1Char(' '), QLatin1Char('-'))
+    .toLower();
+
+}
+
+bool LyricFindLyricsProvider::StartSearch(const int id, const LyricsSearchRequest &request) {
+
+  const QUrl url = Url(request);
+  QNetworkRequest req(url);
+  req.setAttribute(QNetworkRequest::RedirectPolicyAttribute, QNetworkRequest::NoLessSafeRedirectPolicy);
+  req.setHeader(QNetworkRequest::UserAgentHeader, QStringLiteral("Mozilla/5.0 (X11; Linux x86_64; rv:122.0) Gecko/20100101 Firefox/122.0"));
+  QNetworkReply *reply = network_->get(req);
+  replies_ << reply;
+  QObject::connect(reply, &QNetworkReply::finished, this, [this, reply, id, request]() { HandleSearchReply(reply, id, request); });
+
+  qLog(Debug) << "LyricFind: Sending request for" << url;
+
+  return true;
+
+}
+
+void LyricFindLyricsProvider::CancelSearch(const int id) { Q_UNUSED(id); }
+
+void LyricFindLyricsProvider::HandleSearchReply(QNetworkReply *reply, const int id, const LyricsSearchRequest &request) {
+
+  if (!replies_.contains(reply)) return;
+  replies_.removeAll(reply);
+  QObject::disconnect(reply, nullptr, this, nullptr);
+  reply->deleteLater();
+
+  LyricsSearchResults results;
+  const QScopeGuard end_search = qScopeGuard([this, id, request, &results]() { EndSearch(id, request, results); });
+
+  if (reply->error() != QNetworkReply::NoError) {
+    Error(QStringLiteral("%1 (%2)").arg(reply->errorString()).arg(reply->error()));
+    return;
+  }
+
+  if (reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).isValid()) {
+    const int http_code = reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt();
+    if (http_code != 200 && http_code != 201 && http_code != 202) {
+      Error(QStringLiteral("Received HTTP code %1").arg(http_code));
+      return;
+    }
+  }
+
+  const QByteArray data = reply->readAll();
+  if (data.isEmpty()) {
+    Error(QStringLiteral("Empty reply received from server."));
+    return;
+  }
+
+  const QString content = QString::fromUtf8(data);
+  if (content.isEmpty()) {
+    Error(QStringLiteral("Empty reply received from server."));
+    return;
+  }
+
+  const QString data_begin = QLatin1String(kLyricsStart);
+  const QString data_end = QLatin1String(kLyricsEnd);
+  qint64 begin_idx = content.indexOf(data_begin);
+  QString content_json;
+  if (begin_idx > 0) {
+    begin_idx += data_begin.length();
+    qint64 end_idx = content.indexOf(data_end, begin_idx);
+    if (end_idx > begin_idx) {
+      content_json = content.mid(begin_idx, end_idx - begin_idx);
+    }
+  }
+  if (content_json.isEmpty()) {
+    Error(QStringLiteral("Could not parse HTML reply."));
+    return;
+  }
+
+  QJsonObject obj = ExtractJsonObj(content_json.toUtf8());
+  if (obj.isEmpty()) {
+    return;
+  }
+  if (!obj.contains(QLatin1String("props")) || !obj[QLatin1String("props")].isObject()) {
+    Error(QStringLiteral("Missing props."));
+    return;
+  }
+  obj = obj[QLatin1String("props")].toObject();
+  if (!obj.contains(QLatin1String("pageProps")) || !obj[QLatin1String("pageProps")].isObject()) {
+    Error(QStringLiteral("Missing pageProps."));
+    return;
+  }
+  obj = obj[QLatin1String("pageProps")].toObject();
+  if (!obj.contains(QLatin1String("songData")) || !obj[QLatin1String("songData")].isObject()) {
+    Error(QStringLiteral("Missing songData."));
+    return;
+  }
+  obj = obj[QLatin1String("songData")].toObject();
+
+  if (!obj.contains(QLatin1String("response")) || !obj[QLatin1String("response")].isObject()) {
+    Error(QStringLiteral("Missing response."));
+    return;
+  }
+  //const QJsonObject obj_response = obj[QLatin1String("response")].toObject();
+
+  if (!obj.contains(QLatin1String("track")) || !obj[QLatin1String("track")].isObject()) {
+    Error(QStringLiteral("Missing track."));
+    return;
+  }
+  const QJsonObject obj_track = obj[QLatin1String("track")].toObject();
+
+  if (!obj_track.contains(QLatin1String("title")) ||
+      !obj_track.contains(QLatin1String("lyrics"))) {
+    Error(QStringLiteral("Missing title or lyrics."));
+    return;
+  }
+
+  LyricsSearchResult result;
+
+  const QJsonObject obj_artist = obj[QLatin1String("artist")].toObject();
+  if (obj_artist.contains(QLatin1String("name"))) {
+    result.artist = obj_artist[QLatin1String("name")].toString();
+  }
+  result.title = obj_track[QLatin1String("title")].toString();
+  result.lyrics = obj_track[QLatin1String("lyrics")].toString();
+  results << result;
+
+}
+
+void LyricFindLyricsProvider::Error(const QString &error, const QVariant &debug) {
+
+  qLog(Error) << "LyricFind:" << error;
+  if (debug.isValid()) qLog(Debug) << debug;
+
+}
+
+void LyricFindLyricsProvider::EndSearch(const int id, const LyricsSearchRequest &request, const LyricsSearchResults &results) {
+
+  if (results.isEmpty()) {
+    qLog(Debug) << "LyricFind: No lyrics for" << request.artist << request.title;
+  }
+  else {
+    qLog(Debug) << "LyricFind: Got lyrics for" << request.artist << request.title;
+  }
+
+  emit SearchFinished(id, results);
+
+}

src/lyrics/lyricfindlyricsprovider.h

@@ -0,0 +1,61 @@
+/*
+ * Strawberry Music Player
+ * Copyright 2024, 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Strawberry 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Strawberry.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef LYRICFINDLYRICSPROVIDER_H
+#define LYRICFINDLYRICSPROVIDER_H
+
+#include "config.h"
+
+#include <QObject>
+#include <QList>
+#include <QVariant>
+#include <QString>
+#include <QUrl>
+
+#include "jsonlyricsprovider.h"
+#include "lyricssearchrequest.h"
+#include "lyricssearchresult.h"
+
+class QNetworkReply;
+class NetworkAccessManager;
+
+class LyricFindLyricsProvider : public JsonLyricsProvider {
+  Q_OBJECT
+
+ public:
+  explicit LyricFindLyricsProvider(SharedPtr<NetworkAccessManager> network, QObject *parent = nullptr);
+  ~LyricFindLyricsProvider() override;
+
+  bool StartSearch(const int id, const LyricsSearchRequest &request) override;
+  void CancelSearch(const int id) override;
+
+ private:
+  static QUrl Url(const LyricsSearchRequest &request);
+  static QString StringFixup(const QString &text);
+  void Error(const QString &error, const QVariant &debug = QVariant()) override;
+  void EndSearch(const int id, const LyricsSearchRequest &request, const LyricsSearchResults &lyrics = LyricsSearchResults());
+
+ private Q_SLOTS:
+  void HandleSearchReply(QNetworkReply *reply, const int id, const LyricsSearchRequest &request);
+
+ private:
+  QList<QNetworkReply*> replies_;
+};
+
+#endif  // LYRICFINDLYRICSPROVIDER_H