Add Subsonic scrobble support (#545)

* add SubsonicScrobbler, add Scrobble method in SubsonicService

* new class SubsonicScrobbleRequest, use queue again, clean up

* add checkbox to enable server-side scrobbling to Subsonic settings page

* Check serversidescrobbling in SubsonicScrobbler::ReloadSettings instead of SubsonicService

TODO: SubsonicScrobbler::ReloadSettings needs to be called when
SubsonicSettings change.

src/scrobbler/audioscrobbler.cpp

@@ -37,6 +37,7 @@
 #include "lastfmscrobbler.h"
 #include "librefmscrobbler.h"
 #include "listenbrainzscrobbler.h"
+#include "subsonicscrobbler.h"
 
 AudioScrobbler::AudioScrobbler(Application *app, QObject *parent) :
   QObject(parent),
@@ -54,6 +55,7 @@ AudioScrobbler::AudioScrobbler(Application *app, QObject *parent) :
   scrobbler_services_->AddService(new LastFMScrobbler(app_, scrobbler_services_));
   scrobbler_services_->AddService(new LibreFMScrobbler(app_, scrobbler_services_));
   scrobbler_services_->AddService(new ListenBrainzScrobbler(app_, scrobbler_services_));
+  scrobbler_services_->AddService(new SubsonicScrobbler(app_, scrobbler_services_));
 
   ReloadSettings();
 

src/scrobbler/subsonicscrobbler.cpp

@@ -0,0 +1,129 @@
+/*
+ * Strawberry Music Player
+ * Copyright 2018, Jonas Kvinge <jonas@jkvinge.net>
+ * Copyright 2020, Pascal Below <spezifisch@below.fr>
+ *
+ * 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 <QtGlobal>
+#include <QVariant>
+#include <QString>
+#include <QDateTime>
+#include <QTimer>
+#include <QtDebug>
+
+#include "core/application.h"
+#include "core/song.h"
+#include "core/timeconstants.h"
+#include "core/logging.h"
+#include "core/closure.h"
+#include "internet/internetservices.h"
+#include "settings/subsonicsettingspage.h"
+#include "subsonic/subsonicservice.h"
+
+#include "audioscrobbler.h"
+#include "scrobblerservice.h"
+#include "subsonicscrobbler.h"
+
+const char *SubsonicScrobbler::kName = "Subsonic";
+
+SubsonicScrobbler::SubsonicScrobbler(Application *app, QObject *parent) : ScrobblerService(kName, app, parent),
+  app_(app),
+  service_(app->internet_services()->Service<SubsonicService>()),
+  enabled_(false),
+  submitted_(false) {
+
+  ReloadSettings();
+
+}
+
+SubsonicScrobbler::~SubsonicScrobbler() {
+
+}
+
+void SubsonicScrobbler::ReloadSettings() {
+
+  QSettings s;
+  s.beginGroup(SubsonicSettingsPage::kSettingsGroup);
+  enabled_ = s.value("serversidescrobbling", false).toBool();
+  s.endGroup();
+
+}
+
+void SubsonicScrobbler::UpdateNowPlaying(const Song &song) {
+
+  if (song.source() != Song::Source::Source_Subsonic) return;
+
+  song_playing_ = song;
+  time_ = QDateTime::currentDateTime();
+
+  if (!song.is_metadata_good() || app_->scrobbler()->IsOffline()) return;
+
+  service_->Scrobble(song.song_id(), false, time_);
+
+}
+
+void SubsonicScrobbler::ClearPlaying() {
+
+  song_playing_ = Song();
+  time_ = QDateTime();
+
+}
+
+void SubsonicScrobbler::Scrobble(const Song &song) {
+
+  if (song.source() != Song::Source::Source_Subsonic) return;
+
+  if (song.id() != song_playing_.id() || song.url() != song_playing_.url() || !song.is_metadata_good()) return;
+
+  if (app_->scrobbler()->IsOffline()) return;
+
+  if (!submitted_) {
+    submitted_ = true;
+    if (app_->scrobbler()->SubmitDelay() <= 0) {
+      Submit();
+    }
+    else {
+      qint64 msec = (app_->scrobbler()->SubmitDelay() * 60 * kMsecPerSec);
+      DoAfter(this, SLOT(Submit()), msec);
+    }
+  }
+
+}
+
+void SubsonicScrobbler::DoSubmit() {
+
+}
+
+void SubsonicScrobbler::Submit() {
+
+  qLog(Debug) << "SubsonicScrobbler: Submitting scrobble for " << song_playing_.song_id();
+  submitted_ = false;
+
+  if (app_->scrobbler()->IsOffline()) return;
+
+  service_->Scrobble(song_playing_.song_id(), true, time_);
+
+}
+
+void SubsonicScrobbler::Error(const QString &error, const QVariant &debug) {
+
+  qLog(Error) << "SubsonicScrobbler:" << error;
+  if (debug.isValid()) qLog(Debug) << debug;
+
+}

src/scrobbler/subsonicscrobbler.h

@@ -0,0 +1,75 @@
+/*
+ * Strawberry Music Player
+ * Copyright 2018, Jonas Kvinge <jonas@jkvinge.net>
+ * Copyright 2020, Pascal Below <spezifisch@below.fr>
+ *
+ * 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 SUBSONICSCROBBLER_H
+#define SUBSONICSCROBBLER_H
+
+#include "config.h"
+
+#include <QtGlobal>
+#include <QObject>
+#include <QDateTime>
+#include <QVariant>
+#include <QString>
+
+#include "core/song.h"
+#include "scrobblerservice.h"
+
+class Application;
+class SubsonicService;
+
+class SubsonicScrobbler : public ScrobblerService {
+  Q_OBJECT
+
+ public:
+  explicit SubsonicScrobbler(Application *app, QObject *parent = nullptr);
+  ~SubsonicScrobbler() override;
+
+  static const char *kName;
+
+  void ReloadSettings() override;
+
+  bool IsEnabled() const override { return enabled_; }
+  bool IsAuthenticated() const override { return true; }
+
+  void UpdateNowPlaying(const Song &song) override;
+  void ClearPlaying() override;
+  void Scrobble(const Song &song) override;
+  void Error(const QString &error, const QVariant &debug = QVariant()) override;
+
+  void DoSubmit() override;
+  void Submitted() override { submitted_ = true; }
+  bool IsSubmitted() const override { return submitted_; }
+
+ public slots:
+  void WriteCache() override {}
+  void Submit() override;
+
+ private:
+  Application *app_;
+  SubsonicService *service_;
+  bool enabled_;
+  bool submitted_;
+  Song song_playing_;
+  QDateTime time_;
+
+};
+
+#endif  // SUBSONICSCROBBLER_H