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]}
30 many_to_many(:hashtags, Hashtag, join_through: "hashtags_objects", on_replace: :delete)
35 def with_joined_activity(query, activity_type \\ "Create", join_type \\ :inner) do
36 object_position = Map.get(query.aliases, :object, 0)
38 join(query, join_type, [{object, object_position}], a in Activity,
41 "COALESCE(?->'object'->>'id', ?->>'object') = (? ->> 'id') AND (?->>'type' = ?) ",
54 |> Object.change(%{data: data})
58 def change(struct, params \\ %{}) do
60 |> cast(params, [:data])
61 |> validate_required([:data])
62 |> unique_constraint(:ap_id, name: :objects_unique_apid_index)
63 |> maybe_handle_hashtags_change(struct)
66 defp maybe_handle_hashtags_change(changeset, struct) do
67 with data_hashtags_change = get_change(changeset, :data),
68 true <- hashtags_changed?(struct, data_hashtags_change),
69 {:ok, hashtag_records} <-
71 |> object_data_hashtags()
72 |> Hashtag.get_or_create_by_names() do
73 put_assoc(changeset, :hashtags, hashtag_records)
78 {:error, hashtag_changeset} ->
79 failed_hashtag = get_field(hashtag_changeset, :name)
81 validate_change(changeset, :data, fn _, _ ->
82 [data: "error referencing hashtag: #{failed_hashtag}"]
87 defp hashtags_changed?(%Object{} = struct, %{"tag" => _} = data) do
88 Enum.sort(embedded_hashtags(struct)) !=
89 Enum.sort(object_data_hashtags(data))
92 defp hashtags_changed?(_, _), do: false
94 def get_by_id(nil), do: nil
95 def get_by_id(id), do: Repo.get(Object, id)
97 def get_by_id_and_maybe_refetch(id, opts \\ []) do
98 %{updated_at: updated_at} = object = get_by_id(id)
100 if opts[:interval] &&
101 NaiveDateTime.diff(NaiveDateTime.utc_now(), updated_at) > opts[:interval] do
102 case Fetcher.refetch_object(object) do
103 {:ok, %Object{} = object} ->
107 Logger.error("Couldn't refresh #{object.data["id"]}:\n#{inspect(e)}")
115 def get_by_ap_id(nil), do: nil
117 def get_by_ap_id(ap_id) do
118 Repo.one(from(object in Object, where: fragment("(?)->>'id' = ?", object.data, ^ap_id)))
122 Get a single attachment by it's name and href
124 @spec get_attachment_by_name_and_href(String.t(), String.t()) :: Object.t() | nil
125 def get_attachment_by_name_and_href(name, href) do
128 where: fragment("(?)->>'name' = ?", o.data, ^name),
129 where: fragment("(?)->>'href' = ?", o.data, ^href)
135 defp warn_on_no_object_preloaded(ap_id) do
136 "Object.normalize() called without preloaded object (#{inspect(ap_id)}). Consider preloading the object"
139 Logger.debug("Backtrace: #{inspect(Process.info(:erlang.self(), :current_stacktrace))}")
142 def normalize(_, fetch_remote \\ true, options \\ [])
144 # If we pass an Activity to Object.normalize(), we can try to use the preloaded object.
145 # Use this whenever possible, especially when walking graphs in an O(N) loop!
146 def normalize(%Object{} = object, _, _), do: object
147 def normalize(%Activity{object: %Object{} = object}, _, _), do: object
149 # A hack for fake activities
150 def normalize(%Activity{data: %{"object" => %{"fake" => true} = data}}, _, _) do
151 %Object{id: "pleroma:fake_object_id", data: data}
154 # No preloaded object
155 def normalize(%Activity{data: %{"object" => %{"id" => ap_id}}}, fetch_remote, _) do
156 warn_on_no_object_preloaded(ap_id)
157 normalize(ap_id, fetch_remote)
160 # No preloaded object
161 def normalize(%Activity{data: %{"object" => ap_id}}, fetch_remote, _) do
162 warn_on_no_object_preloaded(ap_id)
163 normalize(ap_id, fetch_remote)
166 # Old way, try fetching the object through cache.
167 def normalize(%{"id" => ap_id}, fetch_remote, _), do: normalize(ap_id, fetch_remote)
168 def normalize(ap_id, false, _) when is_binary(ap_id), do: get_cached_by_ap_id(ap_id)
170 def normalize(ap_id, true, options) when is_binary(ap_id) do
171 Fetcher.fetch_object_from_id!(ap_id, options)
174 def normalize(_, _, _), do: nil
176 # Owned objects can only be accessed by their owner
177 def authorize_access(%Object{data: %{"actor" => actor}}, %User{ap_id: ap_id}) do
185 # Legacy objects can be accessed by anybody
186 def authorize_access(%Object{}, %User{}), do: :ok
188 @spec get_cached_by_ap_id(String.t()) :: Object.t() | nil
189 def get_cached_by_ap_id(ap_id) do
190 key = "object:#{ap_id}"
192 with {:ok, nil} <- Cachex.get(:object_cache, key),
193 object when not is_nil(object) <- get_by_ap_id(ap_id),
194 {:ok, true} <- Cachex.put(:object_cache, key, object) do
197 {:ok, object} -> object
202 def context_mapping(context) do
203 Object.change(%Object{}, %{data: %{"id" => context}})
206 def make_tombstone(%Object{data: %{"id" => id, "type" => type}}, deleted \\ DateTime.utc_now()) do
215 def swap_object_with_tombstone(object) do
216 tombstone = make_tombstone(object)
219 |> Object.change(%{data: tombstone})
223 def delete(%Object{data: %{"id" => id}} = object) do
224 with {:ok, _obj} = swap_object_with_tombstone(object),
225 deleted_activity = Activity.delete_all_by_object_ap_id(id),
226 {:ok, _} <- invalid_object_cache(object) do
228 Config.get([:instance, :cleanup_attachments]),
229 %{"object" => object}
232 {:ok, object, deleted_activity}
236 @spec cleanup_attachments(boolean(), %{required(:object) => map()}) ::
237 {:ok, Oban.Job.t() | nil}
238 def cleanup_attachments(true, %{"object" => _} = params) do
239 AttachmentsCleanupWorker.enqueue("cleanup_attachments", params)
242 def cleanup_attachments(_, _), do: {:ok, nil}
244 def prune(%Object{data: %{"id" => _id}} = object) do
245 with {:ok, object} <- Repo.delete(object),
246 {:ok, _} <- invalid_object_cache(object) do
251 def invalid_object_cache(%Object{data: %{"id" => id}}) do
252 with {:ok, true} <- Cachex.del(:object_cache, "object:#{id}") do
253 Cachex.del(:web_resp_cache, URI.parse(id).path)
257 def set_cache(%Object{data: %{"id" => ap_id}} = object) do
258 Cachex.put(:object_cache, "object:#{ap_id}", object)
262 def update_and_set_cache(changeset) do
263 with {:ok, object} <- Repo.update(changeset) do
268 def increase_replies_count(ap_id) do
270 |> where([o], fragment("?->>'id' = ?::text", o.data, ^to_string(ap_id)))
276 safe_jsonb_set(?, '{repliesCount}',
277 (coalesce((?->>'repliesCount')::int, 0) + 1)::varchar::jsonb, true)
284 |> Repo.update_all([])
286 {1, [object]} -> set_cache(object)
287 _ -> {:error, "Not found"}
291 defp poll_is_multiple?(%Object{data: %{"anyOf" => [_ | _]}}), do: true
293 defp poll_is_multiple?(_), do: false
295 def decrease_replies_count(ap_id) do
297 |> where([o], fragment("?->>'id' = ?::text", o.data, ^to_string(ap_id)))
303 safe_jsonb_set(?, '{repliesCount}',
304 (greatest(0, (?->>'repliesCount')::int - 1))::varchar::jsonb, true)
311 |> Repo.update_all([])
313 {1, [object]} -> set_cache(object)
314 _ -> {:error, "Not found"}
318 def increase_vote_count(ap_id, name, actor) do
319 with %Object{} = object <- Object.normalize(ap_id),
320 "Question" <- object.data["type"] do
321 key = if poll_is_multiple?(object), do: "anyOf", else: "oneOf"
326 %{"name" => ^name} = option ->
327 Kernel.update_in(option["replies"]["totalItems"], &(&1 + 1))
333 voters = [actor | object.data["voters"] || []] |> Enum.uniq()
337 |> Map.put(key, options)
338 |> Map.put("voters", voters)
341 |> Object.change(%{data: data})
342 |> update_and_set_cache()
348 @doc "Updates data field of an object"
349 def update_data(%Object{data: data} = object, attrs \\ %{}) do
351 |> Object.change(%{data: Map.merge(data || %{}, attrs)})
355 def local?(%Object{data: %{"id" => id}}) do
356 String.starts_with?(id, Pleroma.Web.base_url() <> "/")
359 def replies(object, opts \\ []) do
360 object = Object.normalize(object)
366 fragment("(?)->>'inReplyTo' = ?", o.data, ^object.data["id"])
368 |> order_by([o], asc: o.id)
370 if opts[:self_only] do
371 actor = object.data["actor"]
372 where(query, [o], fragment("(?)->>'actor' = ?", o.data, ^actor))
378 def self_replies(object, opts \\ []),
379 do: replies(object, Keyword.put(opts, :self_only, true))
381 def tags(%Object{data: %{"tag" => tags}}) when is_list(tags), do: tags
385 def hashtags(object), do: embedded_hashtags(object)
387 defp embedded_hashtags(%Object{data: data}) do
388 object_data_hashtags(data)
391 defp embedded_hashtags(_), do: []
393 defp object_data_hashtags(%{"tag" => tags}) when is_list(tags) do
394 # Note: AS2 map-type elements are ignored
395 Enum.filter(tags, &is_bitstring(&1))
398 defp object_data_hashtags(_), do: []