Add scrobbler with support for Last.fm, Libre.fm and ListenBrainz

src/scrobbler/scrobblingapi20.h

@@ -0,0 +1,158 @@
+/*
+ * Strawberry Music Player
+ * Copyright 2018, 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 SCROBBLINGAPI20_H
+#define SCROBBLINGAPI20_H
+
+#include "config.h"
+
+#include <memory>
+
+#include <QtGlobal>
+#include <QObject>
+#include <QNetworkReply>
+#include <QPair>
+#include <QList>
+#include <QVariant>
+#include <QByteArray>
+#include <QString>
+#include <QJsonObject>
+
+#include "core/song.h"
+#include "scrobblerservice.h"
+#include "scrobblercache.h"
+
+class Application;
+class NetworkAccessManager;
+class LocalRedirectServer;
+class ScrobblerService;
+class ScrobblerCache;
+class ScrobblerCacheItem;
+
+class ScrobblingAPI20 : public ScrobblerService {
+  Q_OBJECT
+
+ public:
+  explicit ScrobblingAPI20(const QString &name, const QString &settings_group, const QString &auth_url, const QString &api_url, const bool batch, Application *app, QObject *parent = nullptr);
+  ~ScrobblingAPI20();
+
+  static const char *kRedirectUrl;
+
+  void ReloadSettings();
+  void LoadSession();
+  
+  virtual NetworkAccessManager *network() = 0;
+  virtual ScrobblerCache *cache() = 0;
+
+  bool IsEnabled() const { return enabled_; }
+  bool IsAuthenticated() const { return !username_.isEmpty() && !session_key_.isEmpty(); }
+  bool IsSubscriber() const { return subscriber_; }
+  bool IsSubmitted() const { return submitted_; }
+  void Submitted() { submitted_ = true; }
+  QString username() const { return username_; }
+
+  void Authenticate();
+  void Logout();
+  void UpdateNowPlaying(const Song &song);
+  void Scrobble(const Song &song);
+  void Submit();
+  void Love(const Song &song);
+
+ signals:
+  void AuthenticationComplete(bool success, QString error = QString());
+
+ public slots:
+  void WriteCache() { cache()->WriteCache(); }
+
+ private slots:
+  void RedirectArrived(LocalRedirectServer *server);
+  void AuthenticateReplyFinished(QNetworkReply *reply);
+  void UpdateNowPlayingRequestFinished(QNetworkReply *reply);
+  void ScrobbleRequestFinished(QNetworkReply *reply, QList<quint64>);
+  void SingleScrobbleRequestFinished(QNetworkReply *reply, quint64 timestamp);
+
+ private:
+
+  enum ScrobbleErrorCode {
+    Unknown = 0,
+    NoError = 1,
+    InvalidService = 2,
+    InvalidMethod = 3,
+    AuthenticationFailed = 4,
+    InvalidFormat = 5,
+    InvalidParameters = 6,
+    InvalidResourceSpecified = 7,
+    OperationFailed = 8,
+    InvalidSessionKey = 9,
+    InvalidApiKey = 10,
+    ServiceOffline = 11,
+    Reserved12 = 12,
+    InvalidMethodSignature = 13,
+    Reserved14 = 14,
+    Reserved15 = 15,
+    TempError = 16,
+    Reserved17 = 17,
+    Reserved18 = 18,
+    Reserved19 = 19,
+    Reserved20 = 20,
+    Reserved21 = 21,
+    Reserved22 = 22,
+    Reserved23 = 23,
+    Reserved24 = 24,
+    Reserved25 = 25,
+    SuspendedAPIKey = 26,
+    Reserved27 = 27,
+    Reserved28 = 28,
+    RateLimitExceeded = 29,
+  };
+
+  static const char *kApiKey;
+  static const char *kSecret;
+  static const int kScrobblesPerRequest;
+
+  QNetworkReply *CreateRequest(const ParamList &request_params);
+  QByteArray GetReplyData(QNetworkReply *reply);
+
+  void RequestSession(QString token);
+  void AuthError(QString error);
+  void SendSingleScrobble(ScrobblerCacheItem *item);
+  void Error(QString error, QVariant debug = QVariant());
+  QString ErrorString(ScrobbleErrorCode error) const;
+
+  QString name_;
+  QString settings_group_;
+  QString auth_url_;
+  QString api_url_;
+  bool batch_;
+
+  Application *app_;
+
+  bool enabled_;
+
+  bool subscriber_;
+  QString username_;
+  QString session_key_;
+
+  bool submitted_;
+  Song song_playing_;
+  quint64 timestamp_;
+
+};
+
+#endif  // SCROBBLINGAPI20_H