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
14 alias Pleroma.Object.Fetcher
15 alias Pleroma.ObjectTombstone
18 alias Pleroma.Workers.AttachmentsCleanupWorker
22 @type t() :: %__MODULE__{}
24 @derive {Jason.Encoder, only: [:data]}
32 def with_joined_activity(query, activity_type \\ "Create", join_type \\ :inner) do
33 object_position = Map.get(query.aliases, :object, 0)
35 join(query, join_type, [{object, object_position}], a in Activity,
38 "COALESCE(?->'object'->>'id', ?->>'object') = (? ->> 'id') AND (?->>'type' = ?) ",
51 |> Object.change(%{data: data})
55 def change(struct, params \\ %{}) do
58 |> cast(params, [:data])
59 |> validate_required([:data])
60 |> unique_constraint(:ap_id, name: :objects_unique_apid_index)
62 if hashtags_changed?(struct, get_change(changeset, :data)) do
63 # TODO: modify assoc once it's introduced
70 defp hashtags_changed?(%Object{} = struct, %{"tag" => _} = data) do
71 Enum.sort(embedded_hashtags(struct)) !=
72 Enum.sort(object_data_hashtags(data))
75 defp hashtags_changed?(_, _), do: false
77 def get_by_id(nil), do: nil
78 def get_by_id(id), do: Repo.get(Object, id)
80 def get_by_id_and_maybe_refetch(id, opts \\ []) do
81 %{updated_at: updated_at} = object = get_by_id(id)
84 NaiveDateTime.diff(NaiveDateTime.utc_now(), updated_at) > opts[:interval] do
85 case Fetcher.refetch_object(object) do
86 {:ok, %Object{} = object} ->
90 Logger.error("Couldn't refresh #{object.data["id"]}:\n#{inspect(e)}")
98 def get_by_ap_id(nil), do: nil
100 def get_by_ap_id(ap_id) do
101 Repo.one(from(object in Object, where: fragment("(?)->>'id' = ?", object.data, ^ap_id)))
105 Get a single attachment by it's name and href
107 @spec get_attachment_by_name_and_href(String.t(), String.t()) :: Object.t() | nil
108 def get_attachment_by_name_and_href(name, href) do
111 where: fragment("(?)->>'name' = ?", o.data, ^name),
112 where: fragment("(?)->>'href' = ?", o.data, ^href)
118 defp warn_on_no_object_preloaded(ap_id) do
119 "Object.normalize() called without preloaded object (#{inspect(ap_id)}). Consider preloading the object"
122 Logger.debug("Backtrace: #{inspect(Process.info(:erlang.self(), :current_stacktrace))}")
125 def normalize(_, fetch_remote \\ true, options \\ [])
127 # If we pass an Activity to Object.normalize(), we can try to use the preloaded object.
128 # Use this whenever possible, especially when walking graphs in an O(N) loop!
129 def normalize(%Object{} = object, _, _), do: object
130 def normalize(%Activity{object: %Object{} = object}, _, _), do: object
132 # A hack for fake activities
133 def normalize(%Activity{data: %{"object" => %{"fake" => true} = data}}, _, _) do
134 %Object{id: "pleroma:fake_object_id", data: data}
137 # No preloaded object
138 def normalize(%Activity{data: %{"object" => %{"id" => ap_id}}}, fetch_remote, _) do
139 warn_on_no_object_preloaded(ap_id)
140 normalize(ap_id, fetch_remote)
143 # No preloaded object
144 def normalize(%Activity{data: %{"object" => ap_id}}, fetch_remote, _) do
145 warn_on_no_object_preloaded(ap_id)
146 normalize(ap_id, fetch_remote)
149 # Old way, try fetching the object through cache.
150 def normalize(%{"id" => ap_id}, fetch_remote, _), do: normalize(ap_id, fetch_remote)
151 def normalize(ap_id, false, _) when is_binary(ap_id), do: get_cached_by_ap_id(ap_id)
153 def normalize(ap_id, true, options) when is_binary(ap_id) do
154 Fetcher.fetch_object_from_id!(ap_id, options)
157 def normalize(_, _, _), do: nil
159 # Owned objects can only be accessed by their owner
160 def authorize_access(%Object{data: %{"actor" => actor}}, %User{ap_id: ap_id}) do
168 # Legacy objects can be accessed by anybody
169 def authorize_access(%Object{}, %User{}), do: :ok
171 @spec get_cached_by_ap_id(String.t()) :: Object.t() | nil
172 def get_cached_by_ap_id(ap_id) do
173 key = "object:#{ap_id}"
175 with {:ok, nil} <- Cachex.get(:object_cache, key),
176 object when not is_nil(object) <- get_by_ap_id(ap_id),
177 {:ok, true} <- Cachex.put(:object_cache, key, object) do
180 {:ok, object} -> object
185 def context_mapping(context) do
186 Object.change(%Object{}, %{data: %{"id" => context}})
189 def make_tombstone(%Object{data: %{"id" => id, "type" => type}}, deleted \\ DateTime.utc_now()) do
198 def swap_object_with_tombstone(object) do
199 tombstone = make_tombstone(object)
202 |> Object.change(%{data: tombstone})
206 def delete(%Object{data: %{"id" => id}} = object) do
207 with {:ok, _obj} = swap_object_with_tombstone(object),
208 deleted_activity = Activity.delete_all_by_object_ap_id(id),
209 {:ok, _} <- invalid_object_cache(object) do
211 Config.get([:instance, :cleanup_attachments]),
212 %{"object" => object}
215 {:ok, object, deleted_activity}
219 @spec cleanup_attachments(boolean(), %{required(:object) => map()}) ::
220 {:ok, Oban.Job.t() | nil}
221 def cleanup_attachments(true, %{"object" => _} = params) do
222 AttachmentsCleanupWorker.enqueue("cleanup_attachments", params)
225 def cleanup_attachments(_, _), do: {:ok, nil}
227 def prune(%Object{data: %{"id" => _id}} = object) do
228 with {:ok, object} <- Repo.delete(object),
229 {:ok, _} <- invalid_object_cache(object) do
234 def invalid_object_cache(%Object{data: %{"id" => id}}) do
235 with {:ok, true} <- Cachex.del(:object_cache, "object:#{id}") do
236 Cachex.del(:web_resp_cache, URI.parse(id).path)
240 def set_cache(%Object{data: %{"id" => ap_id}} = object) do
241 Cachex.put(:object_cache, "object:#{ap_id}", object)
245 def update_and_set_cache(changeset) do
246 with {:ok, object} <- Repo.update(changeset) do
251 def increase_replies_count(ap_id) do
253 |> where([o], fragment("?->>'id' = ?::text", o.data, ^to_string(ap_id)))
259 safe_jsonb_set(?, '{repliesCount}',
260 (coalesce((?->>'repliesCount')::int, 0) + 1)::varchar::jsonb, true)
267 |> Repo.update_all([])
269 {1, [object]} -> set_cache(object)
270 _ -> {:error, "Not found"}
274 defp poll_is_multiple?(%Object{data: %{"anyOf" => [_ | _]}}), do: true
276 defp poll_is_multiple?(_), do: false
278 def decrease_replies_count(ap_id) do
280 |> where([o], fragment("?->>'id' = ?::text", o.data, ^to_string(ap_id)))
286 safe_jsonb_set(?, '{repliesCount}',
287 (greatest(0, (?->>'repliesCount')::int - 1))::varchar::jsonb, true)
294 |> Repo.update_all([])
296 {1, [object]} -> set_cache(object)
297 _ -> {:error, "Not found"}
301 def increase_vote_count(ap_id, name, actor) do
302 with %Object{} = object <- Object.normalize(ap_id),
303 "Question" <- object.data["type"] do
304 key = if poll_is_multiple?(object), do: "anyOf", else: "oneOf"
309 %{"name" => ^name} = option ->
310 Kernel.update_in(option["replies"]["totalItems"], &(&1 + 1))
316 voters = [actor | object.data["voters"] || []] |> Enum.uniq()
320 |> Map.put(key, options)
321 |> Map.put("voters", voters)
324 |> Object.change(%{data: data})
325 |> update_and_set_cache()
331 @doc "Updates data field of an object"
332 def update_data(%Object{data: data} = object, attrs \\ %{}) do
334 |> Object.change(%{data: Map.merge(data || %{}, attrs)})
338 def local?(%Object{data: %{"id" => id}}) do
339 String.starts_with?(id, Pleroma.Web.base_url() <> "/")
342 def replies(object, opts \\ []) do
343 object = Object.normalize(object)
349 fragment("(?)->>'inReplyTo' = ?", o.data, ^object.data["id"])
351 |> order_by([o], asc: o.id)
353 if opts[:self_only] do
354 actor = object.data["actor"]
355 where(query, [o], fragment("(?)->>'actor' = ?", o.data, ^actor))
361 def self_replies(object, opts \\ []),
362 do: replies(object, Keyword.put(opts, :self_only, true))
364 def tags(%Object{data: %{"tag" => tags}}) when is_list(tags), do: tags
368 def hashtags(object), do: embedded_hashtags(object)
370 defp embedded_hashtags(%Object{data: data}) do
371 object_data_hashtags(data)
374 defp embedded_hashtags(_), do: []
376 defp object_data_hashtags(%{"tag" => tags}) when is_list(tags) do
377 # Note: AS2 map-type elements are ignored
378 Enum.filter(tags, &is_bitstring(&1))
381 defp object_data_hashtags(_), do: []