From 510a7b64f1354d4313ab565d557f422b7e059432 Mon Sep 17 00:00:00 2001
From: NEETzsche <neetzsche@tutanota.com>
Date: Wed, 15 Nov 2023 00:43:58 -0700
Subject: [PATCH] Add optional URL value for scrobbles

---
 changelog.d/scrobble-url.add                         |  1 +
 .../operations/pleroma_scrobble_operation.ex         |  6 +++++-
 lib/pleroma/web/common_api/activity_draft.ex         |  2 +-
 lib/pleroma/web/pleroma_api/views/scrobble_view.ex   |  1 +
 .../controllers/scrobble_controller_test.exs         | 12 ++++++++----
 5 files changed, 16 insertions(+), 6 deletions(-)
 create mode 100644 changelog.d/scrobble-url.add

diff --git a/changelog.d/scrobble-url.add b/changelog.d/scrobble-url.add
new file mode 100644
index 000000000..24bdeed89
--- /dev/null
+++ b/changelog.d/scrobble-url.add
@@ -0,0 +1 @@
+Adds the capability to add a URL to a scrobble (optional field)
diff --git a/lib/pleroma/web/api_spec/operations/pleroma_scrobble_operation.ex b/lib/pleroma/web/api_spec/operations/pleroma_scrobble_operation.ex
index ca40da930..68c586b73 100644
--- a/lib/pleroma/web/api_spec/operations/pleroma_scrobble_operation.ex
+++ b/lib/pleroma/web/api_spec/operations/pleroma_scrobble_operation.ex
@@ -59,6 +59,7 @@ defmodule Pleroma.Web.ApiSpec.PleromaScrobbleOperation do
         album: %Schema{type: :string, description: "The album of the media playing"},
         artist: %Schema{type: :string, description: "The artist of the media playing"},
         length: %Schema{type: :integer, description: "The length of the media playing"},
+        url: %Schema{type: :string, description: "A URL referencing the media playing"},
         visibility: %Schema{
           allOf: [VisibilityScope],
           default: "public",
@@ -69,7 +70,8 @@ defmodule Pleroma.Web.ApiSpec.PleromaScrobbleOperation do
         "title" => "Some Title",
         "artist" => "Some Artist",
         "album" => "Some Album",
-        "length" => 180_000
+        "length" => 180_000,
+        "url" => "https://www.last.fm/music/Some+Artist/_/Some+Title"
       }
     }
   end
@@ -83,6 +85,7 @@ defmodule Pleroma.Web.ApiSpec.PleromaScrobbleOperation do
         title: %Schema{type: :string, description: "The title of the media playing"},
         album: %Schema{type: :string, description: "The album of the media playing"},
         artist: %Schema{type: :string, description: "The artist of the media playing"},
+        url: %Schema{type: :string, description: "A URL referencing the media playing"},
         length: %Schema{
           type: :integer,
           description: "The length of the media playing",
@@ -97,6 +100,7 @@ defmodule Pleroma.Web.ApiSpec.PleromaScrobbleOperation do
         "artist" => "Some Artist",
         "album" => "Some Album",
         "length" => 180_000,
+        "url" => "https://www.last.fm/music/Some+Artist/_/Some+Title",
         "created_at" => "2019-09-28T12:40:45.000Z"
       }
     }
diff --git a/lib/pleroma/web/common_api/activity_draft.ex b/lib/pleroma/web/common_api/activity_draft.ex
index ca1329284..00cbacbb4 100644
--- a/lib/pleroma/web/common_api/activity_draft.ex
+++ b/lib/pleroma/web/common_api/activity_draft.ex
@@ -83,7 +83,7 @@ defmodule Pleroma.Web.CommonAPI.ActivityDraft do
   defp listen_object(draft) do
     object =
       draft.params
-      |> Map.take([:album, :artist, :title, :length])
+      |> Map.take([:album, :artist, :title, :length, :url])
       |> Map.new(fn {key, value} -> {to_string(key), value} end)
       |> Map.put("type", "Audio")
       |> Map.put("to", draft.to)
diff --git a/lib/pleroma/web/pleroma_api/views/scrobble_view.ex b/lib/pleroma/web/pleroma_api/views/scrobble_view.ex
index a5985fb2a..7a983f8b5 100644
--- a/lib/pleroma/web/pleroma_api/views/scrobble_view.ex
+++ b/lib/pleroma/web/pleroma_api/views/scrobble_view.ex
@@ -27,6 +27,7 @@ defmodule Pleroma.Web.PleromaAPI.ScrobbleView do
       title: object.data["title"] |> HTML.strip_tags(),
       artist: object.data["artist"] |> HTML.strip_tags(),
       album: object.data["album"] |> HTML.strip_tags(),
+      url: object.data["url"],
       length: object.data["length"]
     }
   end
diff --git a/test/pleroma/web/pleroma_api/controllers/scrobble_controller_test.exs b/test/pleroma/web/pleroma_api/controllers/scrobble_controller_test.exs
index 908ce962d..df12a05ce 100644
--- a/test/pleroma/web/pleroma_api/controllers/scrobble_controller_test.exs
+++ b/test/pleroma/web/pleroma_api/controllers/scrobble_controller_test.exs
@@ -18,7 +18,8 @@ defmodule Pleroma.Web.PleromaAPI.ScrobbleControllerTest do
           "title" => "lain radio episode 1",
           "artist" => "lain",
           "album" => "lain radio",
-          "length" => "180000"
+          "length" => "180000",
+          "url" => "https://www.last.fm/music/lain/lain+radio/lain+radio+episode+1"
         })
 
       assert %{"title" => "lain radio episode 1"} = json_response_and_validate_schema(conn, 200)
@@ -33,21 +34,24 @@ defmodule Pleroma.Web.PleromaAPI.ScrobbleControllerTest do
         CommonAPI.listen(user, %{
           title: "lain radio episode 1",
           artist: "lain",
-          album: "lain radio"
+          album: "lain radio",
+          url: "https://www.last.fm/music/lain/lain+radio/lain+radio+episode+1"
         })
 
       {:ok, _activity} =
         CommonAPI.listen(user, %{
           title: "lain radio episode 2",
           artist: "lain",
-          album: "lain radio"
+          album: "lain radio",
+          url: "https://www.last.fm/music/lain/lain+radio/lain+radio+episode+2"
         })
 
       {:ok, _activity} =
         CommonAPI.listen(user, %{
           title: "lain radio episode 3",
           artist: "lain",
-          album: "lain radio"
+          album: "lain radio",
+          url: "https://www.last.fm/music/lain/lain+radio/lain+radio+episode+3"
         })
 
       conn = get(conn, "/api/v1/pleroma/accounts/#{user.id}/scrobbles")