Insert text representation of hashtags into object["hashtags"]

Includes a new mix task: pleroma.database fill_old_hashtags

CHANGELOG.md

@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Changed
 
+- **Breaking:** Changed storage of hashtags in plain-text to `object->hashtags`, run [`pleroma.database fill_old_hashtags` mix task](docs/administration/CLI_tasks/database.md) for old objects (works while pleroma is running).
 - Polls now always return a `voters_count`, even if they are single-choice.
 - Admin Emails: The ap id is used as the user link in emails now.
 - Improved registration workflow for email confirmation and account approval modes.
@@ -432,7 +433,6 @@ switched to a new configuration mechanism, however it was not officially removed
 - Static-FE: Fix remote posts not being sanitized
 
 ### Fixed
-=======
 - Rate limiter crashes when there is no explicitly specified ip in the config
 - 500 errors when no `Accept` header is present if Static-FE is enabled
 - Instance panel not being updated immediately due to wrong `Cache-Control` headers

docs/administration/CLI_tasks/database.md

@@ -91,6 +91,16 @@ Can be safely re-run
     mix pleroma.database fix_likes_collections
     ```
 
+## Fill hashtags for old objects
+
+```sh tab="OTP"
+./bin/pleroma_ctl database fill_old_hashtags
+```
+
+```sh tab="From Source"
+mix pleroma.database fill_old_hashtags
+```
+
 ## Vacuum the database
 
 ### Analyze

lib/mix/tasks/pleroma/database.ex

@@ -128,6 +128,49 @@ defmodule Mix.Tasks.Pleroma.Database do
     |> Stream.run()
   end
 
+  def run(["fill_old_hashtags"]) do
+    import Ecto.Query
+
+    start_pleroma()
+
+    from(
+      o in Object,
+      where: fragment("(?)->>'hashtags' is null", o.data),
+      where: fragment("(?)->>'tag' != '[]'", o.data),
+      select: %{id: o.id, tag: fragment("(?)->>'tag'", o.data)},
+      order_by: [:desc, o.id]
+    )
+    |> Pleroma.Repo.chunk_stream(200, :batches)
+    |> Stream.each(fn objects ->
+      Repo.transaction(fn ->
+        objects_first = objects |> List.first()
+        objects_last = objects |> List.last()
+
+        Logger.info(
+          "fill_old_hashtags: #{objects_first.id} (#{objects_first.inserted_at}) -- #{
+            objects_last.id
+          } (#{objects_last.inserted_at})"
+        )
+
+        objects
+        |> Enum.map(fn object ->
+          tags =
+            object.tag
+            |> Jason.decode!()
+            |> Enum.filter(&is_bitstring(&1))
+
+          Object
+          |> where([o], o.id == ^object.id)
+          |> update([o],
+            set: [data: fragment("safe_jsonb_set(?, '{hashtags}', ?, true)", o.data, ^tags)]
+          )
+          |> Repo.update_all([], timeout: :infinity)
+        end)
+      end)
+    end)
+    |> Stream.run()
+  end
+
   def run(["vacuum", args]) do
     start_pleroma()
 

lib/pleroma/activity/ir/topics.ex

@@ -48,6 +48,10 @@ defmodule Pleroma.Activity.Ir.Topics do
     tags
   end
 
+  defp hashtags_to_topics(%{data: %{"hashtags" => tags}}) do
+    Enum.map(tags, fn tag -> "hashtag:" <> tag end)
+  end
+
   defp hashtags_to_topics(%{data: %{"tag" => tags}}) do
     tags
     |> Enum.filter(&is_bitstring(&1))

lib/pleroma/constants.ex

@@ -18,7 +18,8 @@ defmodule Pleroma.Constants do
       "emoji",
       "context_id",
       "deleted_activity_id",
-      "pleroma_internal"
+      "pleroma_internal",
+      "hashtags"
     ]
   )
 

lib/pleroma/web/activity_pub/activity_pub.ex

@@ -666,7 +666,7 @@ defmodule Pleroma.Web.ActivityPub.ActivityPub do
   defp restrict_tag_reject(query, %{tag_reject: [_ | _] = tag_reject}) do
     from(
       [_activity, object] in query,
-      where: fragment("not (?)->'tag' \\?| (?)", object.data, ^tag_reject)
+      where: fragment("not (?)->'hashtags' \\?| (?)", object.data, ^tag_reject)
     )
   end
 
@@ -679,7 +679,7 @@ defmodule Pleroma.Web.ActivityPub.ActivityPub do
   defp restrict_tag_all(query, %{tag_all: [_ | _] = tag_all}) do
     from(
       [_activity, object] in query,
-      where: fragment("(?)->'tag' \\?& (?)", object.data, ^tag_all)
+      where: fragment("(?)->'hashtags' \\?& (?)", object.data, ^tag_all)
     )
   end
 
@@ -692,14 +692,14 @@ defmodule Pleroma.Web.ActivityPub.ActivityPub do
   defp restrict_tag(query, %{tag: tag}) when is_list(tag) do
     from(
       [_activity, object] in query,
-      where: fragment("(?)->'tag' \\?| (?)", object.data, ^tag)
+      where: fragment("(?)->'hashtags' \\?| (?)", object.data, ^tag)
     )
   end
 
   defp restrict_tag(query, %{tag: tag}) when is_binary(tag) do
     from(
       [_activity, object] in query,
-      where: fragment("(?)->'tag' \\? (?)", object.data, ^tag)
+      where: fragment("(?)->'hashtags' \\? (?)", object.data, ^tag)
     )
   end
 

lib/pleroma/web/activity_pub/mrf/simple_policy.ex

@@ -74,9 +74,11 @@ defmodule Pleroma.Web.ActivityPub.MRF.SimplePolicy do
 
     object =
       if MRF.subdomain_match?(media_nsfw, actor_host) do
-        tags = (child_object["tag"] || []) ++ ["nsfw"]
+        child_object =
-        child_object = Map.put(child_object, "tag", tags)
+          child_object
-        child_object = Map.put(child_object, "sensitive", true)
+          |> Map.put("hashtags", (child_object["hashtags"] || []) ++ ["nsfw"])
+          |> Map.put("sensitive", true)
+
         Map.put(object, "object", child_object)
       else
         object

lib/pleroma/web/activity_pub/transmogrifier.ex

@@ -312,16 +312,15 @@ defmodule Pleroma.Web.ActivityPub.Transmogrifier do
   def fix_emoji(object), do: object
 
   def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
-    tags =
+    hashtags =
       tag
       |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
-      |> Enum.map(fn %{"name" => name} ->
+      |> Enum.map(fn
-        name
+        %{"name" => "#" <> hashtag} -> String.downcase(hashtag)
-        |> String.slice(1..-1)
+        %{"name" => hashtag} -> String.downcase(hashtag)
-        |> String.downcase()
       end)
 
-    Map.put(object, "tag", tag ++ tags)
+    Map.put(object, "hashtags", hashtags)
   end
 
   def fix_tag(%{"tag" => %{} = tag} = object) do
@@ -865,7 +864,7 @@ defmodule Pleroma.Web.ActivityPub.Transmogrifier do
 
   def add_hashtags(object) do
     tags =
-      (object["tag"] || [])
+      ((object["hashtags"] || []) ++ (object["tag"] || []))
       |> Enum.map(fn
         # Expand internal representation tags into AS2 tags.
         tag when is_binary(tag) ->
@@ -936,7 +935,7 @@ defmodule Pleroma.Web.ActivityPub.Transmogrifier do
   end
 
   def set_sensitive(object) do
-    tags = object["tag"] || []
+    tags = object["hashtags"] || object["tag"] || []
     Map.put(object, "sensitive", "nsfw" in tags)
   end
 

lib/pleroma/web/common_api/utils.ex

@@ -310,7 +310,16 @@ defmodule Pleroma.Web.CommonAPI.Utils do
       "context" => draft.context,
       "attachment" => draft.attachments,
       "actor" => draft.user.ap_id,
-      "tag" => Keyword.values(draft.tags) |> Enum.uniq()
+      "tag" => Enum.filter(draft.tags, &is_map(&1)) |> Enum.uniq(),
+      "hashtags" =>
+        draft.tags
+        |> Enum.reduce([], fn
+          # Why so many formats
+          {:name, x}, acc -> if is_bitstring(x), do: [x | acc], else: acc
+          {"#" <> _, x}, acc -> if is_bitstring(x), do: [x | acc], else: acc
+          x, acc -> if is_bitstring(x), do: [x | acc], else: acc
+        end)
+        |> Enum.uniq()
     }
     |> add_in_reply_to(draft.in_reply_to)
     |> Map.merge(draft.extra)

lib/pleroma/web/mastodon_api/views/status_view.ex

@@ -347,7 +347,7 @@ defmodule Pleroma.Web.MastodonAPI.StatusView do
       media_attachments: attachments,
       poll: render(PollView, "show.json", object: object, for: opts[:for]),
       mentions: mentions,
-      tags: build_tags(tags),
+      tags: build_tags(object.data["hashtags"] || tags),
       application: %{
         name: "Web",
         website: nil

lib/pleroma/web/templates/feed/feed/_activity.atom.eex

@@ -22,8 +22,8 @@
     <link type="text/html" href='<%= @data["external_url"] %>' rel="alternate"/>
   <% end %>
 
-  <%= for tag <- @data["tag"] || [] do %>
+  <%= for hashtag <- @data["hashtags"] || [] do %>
-    <category term="<%= tag %>"></category>
+    <category term="<%= hashtag %>"></category>
   <% end %>
 
   <%= for attachment <- @data["attachment"] || [] do %>

lib/pleroma/web/templates/feed/feed/_activity.rss.eex

@@ -21,8 +21,8 @@
     <link><%= @data["external_url"] %></link>
   <% end %>
 
-  <%= for tag <- @data["tag"] || [] do %>
+  <%= for hashtag <- @data["hashtags"] || [] do %>
-    <category term="<%= tag %>"></category>
+    <category term="<%= hashtag %>"></category>
   <% end %>
 
   <%= for attachment <- @data["attachment"] || [] do %>

lib/pleroma/web/templates/feed/feed/_tag_activity.atom.eex

@@ -41,8 +41,8 @@
       <% end %>
     <% end %>
 
-    <%= for tag <- @data["tag"] || [] do %>
+    <%= for hashtag <- @data["hashtags"] || [] do %>
-      <category term="<%= tag %>"></category>
+      <category term="<%= hashtag %>"></category>
     <% end %>
 
     <%= for {emoji, file} <- @data["emoji"] || %{} do %>

priv/repo/migrations/20200731165800_add_hashtags_index_to_objects.exs

@@ -0,0 +1,11 @@
+defmodule Pleroma.Repo.Migrations.AddHashtagsIndexToObjects do
+  use Ecto.Migration
+
+  def change do
+    drop_if_exists(index(:objects, ["(data->'tag')"], using: :gin, name: :objects_tags))
+
+    create_if_not_exists(
+      index(:objects, ["(data->'hashtags')"], using: :gin, name: :objects_hashtags)
+    )
+  end
+end

test/pleroma/activity/ir/topics_test.exs

@@ -78,7 +78,7 @@ defmodule Pleroma.Activity.Ir.TopicsTest do
     end
 
     test "converts tags to hash tags", %{activity: %{object: %{data: data} = object} = activity} do
-      tagged_data = Map.put(data, "tag", ["foo", "bar"])
+      tagged_data = Map.put(data, "hashtags", ["foo", "bar"])
       activity = %{activity | object: %{object | data: tagged_data}}
 
       topics = Topics.get_activity_topics(activity)

test/pleroma/web/activity_pub/mrf/simple_policy_test.exs

@@ -78,7 +78,7 @@ defmodule Pleroma.Web.ActivityPub.MRF.SimplePolicyTest do
       assert SimplePolicy.filter(media_message) ==
                {:ok,
                 media_message
-                |> put_in(["object", "tag"], ["foo", "nsfw"])
+                |> put_in(["object", "hashtags"], ["foo", "nsfw"])
                 |> put_in(["object", "sensitive"], true)}
 
       assert SimplePolicy.filter(local_message) == {:ok, local_message}
@@ -92,7 +92,7 @@ defmodule Pleroma.Web.ActivityPub.MRF.SimplePolicyTest do
       assert SimplePolicy.filter(media_message) ==
                {:ok,
                 media_message
-                |> put_in(["object", "tag"], ["foo", "nsfw"])
+                |> put_in(["object", "hashtags"], ["foo", "nsfw"])
                 |> put_in(["object", "sensitive"], true)}
 
       assert SimplePolicy.filter(local_message) == {:ok, local_message}
@@ -105,7 +105,7 @@ defmodule Pleroma.Web.ActivityPub.MRF.SimplePolicyTest do
       "type" => "Create",
       "object" => %{
         "attachment" => [%{}],
-        "tag" => ["foo"],
+        "hashtags" => ["foo"],
         "sensitive" => false
       }
     }

test/pleroma/web/activity_pub/transmogrifier/note_handling_test.exs

@@ -39,7 +39,7 @@ defmodule Pleroma.Web.ActivityPub.Transmogrifier.NoteHandlingTest do
       {:ok, %Activity{data: data, local: false}} = Transmogrifier.handle_incoming(data)
       object = Object.normalize(data["object"])
 
-      assert "test" in object.data["tag"]
+      assert ["test"] == object.data["hashtags"]
     end
 
     test "it cleans up incoming notices which are not really DMs" do
@@ -220,7 +220,7 @@ defmodule Pleroma.Web.ActivityPub.Transmogrifier.NoteHandlingTest do
       {:ok, %Activity{data: data, local: false}} = Transmogrifier.handle_incoming(data)
       object = Object.normalize(data["object"])
 
-      assert Enum.at(object.data["tag"], 2) == "moo"
+      assert object.data["hashtags"] == ["moo"]
     end
 
     test "it works for incoming notices with contentMap" do

test/pleroma/web/activity_pub/transmogrifier_test.exs

@@ -204,30 +204,37 @@ defmodule Pleroma.Web.ActivityPub.TransmogrifierTest do
 
       {:ok, activity} = CommonAPI.post(user, %{status: "#2hu :firefox:"})
 
-      {:ok, modified} = Transmogrifier.prepare_outgoing(activity.data)
+      {:ok, %{"object" => modified_object}} = Transmogrifier.prepare_outgoing(activity.data)
 
-      assert length(modified["object"]["tag"]) == 2
+      assert [
+               %{"name" => "#2hu", "type" => "Hashtag"},
+               %{"name" => ":firefox:", "type" => "Emoji"}
+             ] = modified_object["tag"]
 
-      assert is_nil(modified["object"]["emoji"])
+      refute Map.has_key?(modified_object, "hashtags")
-      assert is_nil(modified["object"]["like_count"])
+      refute Map.has_key?(modified_object, "emoji")
-      assert is_nil(modified["object"]["announcements"])
+      refute Map.has_key?(modified_object, "like_count")
-      assert is_nil(modified["object"]["announcement_count"])
+      refute Map.has_key?(modified_object, "announcements")
-      assert is_nil(modified["object"]["context_id"])
+      refute Map.has_key?(modified_object, "announcement_count")
+      refute Map.has_key?(modified_object, "context_id")
     end
 
     test "it strips internal fields of article" do
       activity = insert(:article_activity)
 
-      {:ok, modified} = Transmogrifier.prepare_outgoing(activity.data)
+      {:ok, %{"object" => modified_object}} = Transmogrifier.prepare_outgoing(activity.data)
 
-      assert length(modified["object"]["tag"]) == 2
+      assert [
+               %{"name" => "#2hu", "type" => "Hashtag"},
+               %{"name" => ":2hu:", "type" => "Emoji"}
+             ] = modified_object["tag"]
 
-      assert is_nil(modified["object"]["emoji"])
+      refute Map.has_key?(modified_object, "hashtags")
-      assert is_nil(modified["object"]["like_count"])
+      refute Map.has_key?(modified_object, "emoji")
-      assert is_nil(modified["object"]["announcements"])
+      refute Map.has_key?(modified_object, "like_count")
-      assert is_nil(modified["object"]["announcement_count"])
+      refute Map.has_key?(modified_object, "announcements")
-      assert is_nil(modified["object"]["context_id"])
+      refute Map.has_key?(modified_object, "announcement_count")
-      assert is_nil(modified["object"]["likes"])
+      refute Map.has_key?(modified_object, "context_id")
     end
 
     test "the directMessage flag is present" do

test/pleroma/web/common_api/utils_test.exs

@@ -591,7 +591,8 @@ defmodule Pleroma.Web.CommonAPI.UtilsTest do
                "context" => "2hu",
                "sensitive" => false,
                "summary" => "test summary",
-               "tag" => ["jimm"],
+               "hashtags" => ["jimm"],
+               "tag" => [],
                "to" => [user2.ap_id],
                "type" => "Note",
                "custom_tag" => "test"

test/pleroma/web/common_api_test.exs

@@ -493,7 +493,8 @@ defmodule Pleroma.Web.CommonAPITest do
 
     object = Object.normalize(activity)
 
-    assert object.data["tag"] == ["2hu"]
+    assert object.data["tag"] == []
+    assert object.data["hashtags"] == ["2hu"]
   end
 
   test "it adds emoji in the object" do

test/pleroma/web/mastodon_api/views/status_view_test.exs

@@ -262,8 +262,8 @@ defmodule Pleroma.Web.MastodonAPI.StatusViewTest do
       mentions: [],
       tags: [
         %{
-          name: "#{object_data["tag"]}",
+          name: "2hu",
-          url: "/tag/#{object_data["tag"]}"
+          url: "/tag/2hu"
         }
       ],
       application: %{

test/support/factory.ex

@@ -93,7 +93,7 @@ defmodule Pleroma.Factory do
       "like_count" => 0,
       "context" => "2hu",
       "summary" => "2hu",
-      "tag" => ["2hu"],
+      "hashtags" => ["2hu"],
       "emoji" => %{
         "2hu" => "corndog.png"
       }