Add azlyrics.com lyrics provider

README.md

@@ -52,7 +52,7 @@ Funding developers is a way to contribute to open source projects you appreciate
   * Edit tags on audio files
   * Fetch tags from MusicBrainz
   * Album cover art from [Last.fm](https://www.last.fm/), [Musicbrainz](https://musicbrainz.org/), [Discogs](https://www.discogs.com/), [Musixmatch](https://www.musixmatch.com/), [Deezer](https://www.deezer.com/), [Tidal](https://www.tidal.com/), [Qobuz](https://www.qobuz.com/) and [Spotify](https://www.spotify.com/)
-  * Song lyrics from [Genius](https://genius.com/), [Musixmatch](https://www.musixmatch.com/), [ChartLyrics](http://www.chartlyrics.com/), [lyrics.ovh](https://lyrics.ovh/), [lololyrics.com](https://www.lololyrics.com/) and [songlyrics.com](https://www.songlyrics.com/)
+  * Song lyrics from [Genius](https://genius.com/), [Musixmatch](https://www.musixmatch.com/), [ChartLyrics](http://www.chartlyrics.com/), [lyrics.ovh](https://lyrics.ovh/), [lololyrics.com](https://www.lololyrics.com/), [songlyrics.com](https://www.songlyrics.com/) and [azlyrics.com](https://www.azlyrics.com/)
   * Support for multiple backends
   * Audio analyzer
   * Audio equalizer

debian/control.in

@@ -52,7 +52,7 @@ Description: music player and music collection organizer
   - Edit tags on audio files
   - Automatically retrieve tags from MusicBrainz
   - Album cover art from Last.fm, Musicbrainz, Discogs, Musixmatch, Deezer, Tidal, Qobuz and Spotify
-  - Song lyrics from Genius, Musixmatch, ChartLyrics, lyrics.ovh, lololyrics.com and songlyrics.com
+  - Song lyrics from Genius, Musixmatch, ChartLyrics, lyrics.ovh, lololyrics.com, songlyrics.com and azlyrics.com
   - Audio analyzer
   - Audio equalizer
   - Transfer music to mass-storage USB players, MTP compatible devices and iPod Nano/Classic

dist/unix/org.strawberrymusicplayer.strawberry.appdata.xml

@@ -29,7 +29,7 @@
       <li>Edit tags on audio files</li>
       <li>Automatically retrieve tags from MusicBrainz</li>
       <li>Album cover art from Last.fm, Musicbrainz, Discogs, Musixmatch, Deezer, Tidal, Qobuz and Spotify</li>
-      <li>Song lyrics from Genius, Musixmatch, ChartLyrics, lyrics.ovh, lololyrics.com and songlyrics.com</li>
+      <li>Song lyrics from Genius, Musixmatch, ChartLyrics, lyrics.ovh, lololyrics.com, songlyrics.com and azlyrics.com</li>
       <li>Support for multiple backends</li>
       <li>Audio analyzer and equalizer</li>
       <li>Transfer music to mass-storage USB players, MTP compatible devices and iPod Nano/Classic</li>

dist/unix/strawberry.spec.in

@@ -118,7 +118,7 @@ Features:
   - Edit tags on audio files
   - Automatically retrieve tags from MusicBrainz
   - Album cover art from Last.fm, Musicbrainz, Discogs, Musixmatch, Deezer, Tidal, Qobuz and Spotify
-  - Song lyrics from Genius, Musixmatch, ChartLyrics, lyrics.ovh, lololyrics.com and songlyrics.com
+  - Song lyrics from Genius, Musixmatch, ChartLyrics, lyrics.ovh, lololyrics.com, songlyrics.com and azlyrics.com
   - Support for multiple backends
   - Audio analyzer
   - Audio equalizer

src/CMakeLists.txt

@@ -184,6 +184,7 @@ set(SOURCES
   lyrics/musixmatchlyricsprovider.cpp
   lyrics/chartlyricsprovider.cpp
   lyrics/songlyricscomlyricsprovider.cpp
+  lyrics/azlyricscomlyricsprovider.cpp
 
   providers/musixmatchprovider.cpp
 
@@ -422,6 +423,7 @@ set(HEADERS
   lyrics/musixmatchlyricsprovider.h
   lyrics/chartlyricsprovider.h
   lyrics/songlyricscomlyricsprovider.h
+  lyrics/azlyricscomlyricsprovider.h
 
   settings/settingsdialog.h
   settings/settingspage.h

src/core/application.cpp

@@ -65,6 +65,7 @@
 #include "lyrics/musixmatchlyricsprovider.h"
 #include "lyrics/chartlyricsprovider.h"
 #include "lyrics/songlyricscomlyricsprovider.h"
+#include "lyrics/azlyricscomlyricsprovider.h"
 
 #include "scrobbler/audioscrobbler.h"
 #include "scrobbler/lastfmscrobbler.h"
@@ -164,6 +165,7 @@ class ApplicationImpl {
           lyrics_providers->AddProvider(new MusixmatchLyricsProvider(app->network()));
           lyrics_providers->AddProvider(new ChartLyricsProvider(app->network()));
           lyrics_providers->AddProvider(new SongLyricsComLyricsProvider(app->network()));
+          lyrics_providers->AddProvider(new AzLyricsComLyricsProvider(app->network()));
           lyrics_providers->ReloadSettings();
           return lyrics_providers;
         }),

src/lyrics/azlyricscomlyricsprovider.cpp

@@ -0,0 +1,128 @@
+/*
+ * Strawberry Music Player
+ * Copyright 2023, 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 <QObject>
+#include <QByteArray>
+#include <QVariant>
+#include <QString>
+#include <QUrl>
+#include <QNetworkRequest>
+#include <QNetworkReply>
+#include <QRegularExpression>
+
+#include "core/logging.h"
+#include "core/shared_ptr.h"
+#include "core/networkaccessmanager.h"
+#include "lyricssearchrequest.h"
+#include "lyricssearchresult.h"
+#include "azlyricscomlyricsprovider.h"
+
+const char *AzLyricsComLyricsProvider::kUrl = "https://www.azlyrics.com/lyrics/";
+
+AzLyricsComLyricsProvider::AzLyricsComLyricsProvider(SharedPtr<NetworkAccessManager> network, QObject *parent) : LyricsProvider("azlyrics.com", true, false, network, parent) {}
+
+AzLyricsComLyricsProvider::~AzLyricsComLyricsProvider() {
+
+  while (!replies_.isEmpty()) {
+    QNetworkReply *reply = replies_.takeFirst();
+    QObject::disconnect(reply, nullptr, this, nullptr);
+    reply->abort();
+    reply->deleteLater();
+  }
+
+}
+
+bool AzLyricsComLyricsProvider::StartSearch(const int id, const LyricsSearchRequest &request) {
+
+  SendRequest(id, request, request.artist, request.album, request.title);
+
+  return true;
+
+}
+
+void AzLyricsComLyricsProvider::CancelSearch(const int id) { Q_UNUSED(id); }
+
+void AzLyricsComLyricsProvider::SendRequest(const int id, const LyricsSearchRequest &request, const QString &result_artist, const QString &result_album, const QString &result_title, QUrl url) {
+
+  if (url.isEmpty() || !url.isValid()) {
+    url.setUrl(kUrl + StringFixup(result_artist) + "/" + StringFixup(result_title) + ".html");
+  }
+
+  QNetworkRequest req(url);
+  req.setAttribute(QNetworkRequest::RedirectPolicyAttribute, QNetworkRequest::NoLessSafeRedirectPolicy);
+  QNetworkReply *reply = network_->get(req);
+  replies_ << reply;
+  QObject::connect(reply, &QNetworkReply::finished, this, [this, reply, id, request, result_artist, result_album, result_title]() { HandleLyricsReply(reply, id, request, result_artist, result_album, result_title); });
+
+}
+
+void AzLyricsComLyricsProvider::HandleLyricsReply(QNetworkReply *reply, const int id, const LyricsSearchRequest &request, const QString &result_artist, const QString &result_album, const QString &result_title) {
+
+  if (!replies_.contains(reply)) return;
+  replies_.removeAll(reply);
+  QObject::disconnect(reply, nullptr, this, nullptr);
+  reply->deleteLater();
+
+  if (reply->error() != QNetworkReply::NoError) {
+    qLog(Error) << "azlyrics.com:" << reply->errorString() << reply->error();
+    emit SearchFinished(id);
+    return;
+  }
+  else if (reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt() != 200) {
+    qLog(Error) << "azlyrics.com: Received HTTP code" << reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt();
+    emit SearchFinished(id);
+    return;
+  }
+
+  const QByteArray data = reply->readAll();
+  if (data.isEmpty()) {
+    qLog(Error) << "azlyrics.com: Empty reply received from server.";
+    emit SearchFinished(id);
+    return;
+  }
+
+  const QString lyrics = ParseLyricsFromHTML(QString::fromUtf8(data), QRegularExpression("<div>"), QRegularExpression("</div>"), QRegularExpression("<!-- Usage of azlyrics.com content by any third-party lyrics provider is prohibited by our licensing agreement. Sorry about that. -->"), false);
+  if (lyrics.isEmpty()) {
+    qLog(Debug) << "azlyrics.com: No lyrics for" << request.artist << request.album << request.title;
+    emit SearchFinished(id);
+    return;
+  }
+
+  qLog(Debug) << "azlyrics.com: Got lyrics for" << request.artist << request.album << request.title;
+
+  LyricsSearchResult result(lyrics);
+  result.artist = result_artist;
+  result.album = result_album;
+  result.title = result_title;
+  emit SearchFinished(id, LyricsSearchResults() << result);
+
+}
+
+QString AzLyricsComLyricsProvider::StringFixup(QString string) {
+
+  return string.remove(QRegularExpression("[^\\w0-9\\-]", QRegularExpression::UseUnicodePropertiesOption)).simplified().toLower();
+
+}
+
+void AzLyricsComLyricsProvider::Error(const QString &error, const QVariant &debug) {
+
+  qLog(Error) << "azlyrics.com:" << error;
+  if (debug.isValid()) qLog(Debug) << debug;
+
+}

src/lyrics/azlyricscomlyricsprovider.h

@@ -0,0 +1,60 @@
+/*
+ * Strawberry Music Player
+ * Copyright 2023, 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 AZLYRICSCOMLYRICSPROVIDER_H
+#define AZLYRICSCOMLYRICSPROVIDER_H
+
+#include <QtGlobal>
+#include <QObject>
+#include <QList>
+#include <QVariant>
+#include <QString>
+#include <QUrl>
+
+#include "core/shared_ptr.h"
+#include "lyricsprovider.h"
+#include "lyricssearchrequest.h"
+
+class QNetworkReply;
+class NetworkAccessManager;
+
+class AzLyricsComLyricsProvider : public LyricsProvider {
+  Q_OBJECT
+
+ public:
+  explicit AzLyricsComLyricsProvider(SharedPtr<NetworkAccessManager> network, QObject *parent = nullptr);
+  ~AzLyricsComLyricsProvider() override;
+
+  bool StartSearch(const int id, const LyricsSearchRequest &request) override;
+  void CancelSearch(const int id) override;
+
+ private:
+  void SendRequest(const int id, const LyricsSearchRequest &request, const QString &result_artist, const QString &result_album, const QString &result_title, QUrl url = QUrl());
+  void Error(const QString &error, const QVariant &debug = QVariant()) override;
+  static QString StringFixup(QString string);
+
+ private slots:
+  void HandleLyricsReply(QNetworkReply *reply, const int id, const LyricsSearchRequest &request, const QString &result_artist, const QString &result_album, const QString &result_title);
+
+ private:
+  static const char *kUrl;
+  QList<QNetworkReply*> replies_;
+};
+
+#endif  // AZLYRICSCOMLYRICSPROVIDER_H