1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Object do
11 alias Pleroma.Activity
15 alias Pleroma.Object.Fetcher
16 alias Pleroma.ObjectTombstone
19 alias Pleroma.Workers.AttachmentsCleanupWorker
23 @type t() :: %__MODULE__{}
25 @derive {Jason.Encoder, only: [:data]}
27 @cachex Pleroma.Config.get([:cachex, :provider], Cachex)
32 many_to_many(:hashtags, Hashtag, join_through: "hashtags_objects", on_replace: :delete)
37 def with_joined_activity(query, activity_type \\ "Create", join_type \\ :inner) do
38 object_position = Map.get(query.aliases, :object, 0)
40 join(query, join_type, [{object, object_position}], a in Activity,
43 "COALESCE(?->'object'->>'id', ?->>'object') = (? ->> 'id') AND (?->>'type' = ?) ",
56 |> Object.change(%{data: data})
60 def change(struct, params \\ %{}) do
62 |> cast(params, [:data])
63 |> validate_required([:data])
64 |> unique_constraint(:ap_id, name: :objects_unique_apid_index)
65 |> maybe_handle_hashtags_change(struct)
68 defp maybe_handle_hashtags_change(changeset, struct) do
69 with data_hashtags_change = get_change(changeset, :data),
70 true <- hashtags_changed?(struct, data_hashtags_change),
71 {:ok, hashtag_records} <-
73 |> object_data_hashtags()
74 |> Hashtag.get_or_create_by_names() do
75 put_assoc(changeset, :hashtags, hashtag_records)
80 {:error, hashtag_changeset} ->
81 failed_hashtag = get_field(hashtag_changeset, :name)
83 validate_change(changeset, :data, fn _, _ ->
84 [data: "error referencing hashtag: #{failed_hashtag}"]
89 defp hashtags_changed?(%Object{} = struct, %{"tag" => _} = data) do
90 Enum.sort(embedded_hashtags(struct)) !=
91 Enum.sort(object_data_hashtags(data))
94 defp hashtags_changed?(_, _), do: false
96 def get_by_id(nil), do: nil
97 def get_by_id(id), do: Repo.get(Object, id)
99 def get_by_id_and_maybe_refetch(id, opts \\ []) do
100 %{updated_at: updated_at} = object = get_by_id(id)
102 if opts[:interval] &&
103 NaiveDateTime.diff(NaiveDateTime.utc_now(), updated_at) > opts[:interval] do
104 case Fetcher.refetch_object(object) do
105 {:ok, %Object{} = object} ->
109 Logger.error("Couldn't refresh #{object.data["id"]}:\n#{inspect(e)}")
117 def get_by_ap_id(nil), do: nil
119 def get_by_ap_id(ap_id) do
120 Repo.one(from(object in Object, where: fragment("(?)->>'id' = ?", object.data, ^ap_id)))
124 Get a single attachment by it's name and href
126 @spec get_attachment_by_name_and_href(String.t(), String.t()) :: Object.t() | nil
127 def get_attachment_by_name_and_href(name, href) do
130 where: fragment("(?)->>'name' = ?", o.data, ^name),
131 where: fragment("(?)->>'href' = ?", o.data, ^href)
137 defp warn_on_no_object_preloaded(ap_id) do
138 "Object.normalize() called without preloaded object (#{inspect(ap_id)}). Consider preloading the object"
141 Logger.debug("Backtrace: #{inspect(Process.info(:erlang.self(), :current_stacktrace))}")
144 def normalize(_, fetch_remote \\ true, options \\ [])
146 # If we pass an Activity to Object.normalize(), we can try to use the preloaded object.
147 # Use this whenever possible, especially when walking graphs in an O(N) loop!
148 def normalize(%Object{} = object, _, _), do: object
149 def normalize(%Activity{object: %Object{} = object}, _, _), do: object
151 # A hack for fake activities
152 def normalize(%Activity{data: %{"object" => %{"fake" => true} = data}}, _, _) do
153 %Object{id: "pleroma:fake_object_id", data: data}
156 # No preloaded object
157 def normalize(%Activity{data: %{"object" => %{"id" => ap_id}}}, fetch_remote, _) do
158 warn_on_no_object_preloaded(ap_id)
159 normalize(ap_id, fetch_remote)
162 # No preloaded object
163 def normalize(%Activity{data: %{"object" => ap_id}}, fetch_remote, _) do
164 warn_on_no_object_preloaded(ap_id)
165 normalize(ap_id, fetch_remote)
168 # Old way, try fetching the object through cache.
169 def normalize(%{"id" => ap_id}, fetch_remote, _), do: normalize(ap_id, fetch_remote)
170 def normalize(ap_id, false, _) when is_binary(ap_id), do: get_cached_by_ap_id(ap_id)
172 def normalize(ap_id, true, options) when is_binary(ap_id) do
173 Fetcher.fetch_object_from_id!(ap_id, options)
176 def normalize(_, _, _), do: nil
178 # Owned objects can only be accessed by their owner
179 def authorize_access(%Object{data: %{"actor" => actor}}, %User{ap_id: ap_id}) do
187 # Legacy objects can be accessed by anybody
188 def authorize_access(%Object{}, %User{}), do: :ok
190 @spec get_cached_by_ap_id(String.t()) :: Object.t() | nil
191 def get_cached_by_ap_id(ap_id) do
192 key = "object:#{ap_id}"
194 with {:ok, nil} <- @cachex.get(:object_cache, key),
195 object when not is_nil(object) <- get_by_ap_id(ap_id),
196 {:ok, true} <- @cachex.put(:object_cache, key, object) do
199 {:ok, object} -> object
204 def context_mapping(context) do
205 Object.change(%Object{}, %{data: %{"id" => context}})
208 def make_tombstone(%Object{data: %{"id" => id, "type" => type}}, deleted \\ DateTime.utc_now()) do
217 def swap_object_with_tombstone(object) do
218 tombstone = make_tombstone(object)
221 |> Object.change(%{data: tombstone})
225 def delete(%Object{data: %{"id" => id}} = object) do
226 with {:ok, _obj} = swap_object_with_tombstone(object),
227 deleted_activity = Activity.delete_all_by_object_ap_id(id),
228 {:ok, _} <- invalid_object_cache(object) do
230 Config.get([:instance, :cleanup_attachments]),
231 %{"object" => object}
234 {:ok, object, deleted_activity}
238 @spec cleanup_attachments(boolean(), %{required(:object) => map()}) ::
239 {:ok, Oban.Job.t() | nil}
240 def cleanup_attachments(true, %{"object" => _} = params) do
241 AttachmentsCleanupWorker.enqueue("cleanup_attachments", params)
244 def cleanup_attachments(_, _), do: {:ok, nil}
246 def prune(%Object{data: %{"id" => _id}} = object) do
247 with {:ok, object} <- Repo.delete(object),
248 {:ok, _} <- invalid_object_cache(object) do
253 def invalid_object_cache(%Object{data: %{"id" => id}}) do
254 with {:ok, true} <- @cachex.del(:object_cache, "object:#{id}") do
255 @cachex.del(:web_resp_cache, URI.parse(id).path)
259 def set_cache(%Object{data: %{"id" => ap_id}} = object) do
260 @cachex.put(:object_cache, "object:#{ap_id}", object)
264 def update_and_set_cache(changeset) do
265 with {:ok, object} <- Repo.update(changeset) do
270 def increase_replies_count(ap_id) do
272 |> where([o], fragment("?->>'id' = ?::text", o.data, ^to_string(ap_id)))
278 safe_jsonb_set(?, '{repliesCount}',
279 (coalesce((?->>'repliesCount')::int, 0) + 1)::varchar::jsonb, true)
286 |> Repo.update_all([])
288 {1, [object]} -> set_cache(object)
289 _ -> {:error, "Not found"}
293 defp poll_is_multiple?(%Object{data: %{"anyOf" => [_ | _]}}), do: true
295 defp poll_is_multiple?(_), do: false
297 def decrease_replies_count(ap_id) do
299 |> where([o], fragment("?->>'id' = ?::text", o.data, ^to_string(ap_id)))
305 safe_jsonb_set(?, '{repliesCount}',
306 (greatest(0, (?->>'repliesCount')::int - 1))::varchar::jsonb, true)
313 |> Repo.update_all([])
315 {1, [object]} -> set_cache(object)
316 _ -> {:error, "Not found"}
320 def increase_vote_count(ap_id, name, actor) do
321 with %Object{} = object <- Object.normalize(ap_id),
322 "Question" <- object.data["type"] do
323 key = if poll_is_multiple?(object), do: "anyOf", else: "oneOf"
328 %{"name" => ^name} = option ->
329 Kernel.update_in(option["replies"]["totalItems"], &(&1 + 1))
335 voters = [actor | object.data["voters"] || []] |> Enum.uniq()
339 |> Map.put(key, options)
340 |> Map.put("voters", voters)
343 |> Object.change(%{data: data})
344 |> update_and_set_cache()
350 @doc "Updates data field of an object"
351 def update_data(%Object{data: data} = object, attrs \\ %{}) do
353 |> Object.change(%{data: Map.merge(data || %{}, attrs)})
357 def local?(%Object{data: %{"id" => id}}) do
358 String.starts_with?(id, Pleroma.Web.base_url() <> "/")
361 def replies(object, opts \\ []) do
362 object = Object.normalize(object)
368 fragment("(?)->>'inReplyTo' = ?", o.data, ^object.data["id"])
370 |> order_by([o], asc: o.id)
372 if opts[:self_only] do
373 actor = object.data["actor"]
374 where(query, [o], fragment("(?)->>'actor' = ?", o.data, ^actor))
380 def self_replies(object, opts \\ []),
381 do: replies(object, Keyword.put(opts, :self_only, true))
383 def tags(%Object{data: %{"tag" => tags}}) when is_list(tags), do: tags
387 def hashtags(%Object{} = object) do
389 Config.object_embedded_hashtags?() ->
390 embedded_hashtags(object)
392 object.id == "pleroma:fake_object_id" ->
396 hashtag_records = Repo.preload(object, :hashtags).hashtags
397 Enum.map(hashtag_records, & &1.name)
401 defp embedded_hashtags(%Object{data: data}) do
402 object_data_hashtags(data)
405 defp embedded_hashtags(_), do: []
407 defp object_data_hashtags(%{"tag" => tags}) when is_list(tags) do
410 %{"type" => "Hashtag"} = data -> Map.has_key?(data, "name")
411 plain_text when is_bitstring(plain_text) -> true
415 %{"name" => "#" <> hashtag} -> String.downcase(hashtag)
416 %{"name" => hashtag} -> String.downcase(hashtag)
417 hashtag when is_bitstring(hashtag) -> String.downcase(hashtag)
422 defp object_data_hashtags(_), do: []