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]}
26 @cachex Pleroma.Config.get([:cachex, :provider], Cachex)
34 def with_joined_activity(query, activity_type \\ "Create", join_type \\ :inner) do
35 object_position = Map.get(query.aliases, :object, 0)
37 join(query, join_type, [{object, object_position}], a in Activity,
40 "COALESCE(?->'object'->>'id', ?->>'object') = (? ->> 'id') AND (?->>'type' = ?) ",
52 Object.change(%Object{}, %{data: data})
56 def change(struct, params \\ %{}) do
58 |> cast(params, [:data])
59 |> validate_required([:data])
60 |> unique_constraint(:ap_id, name: :objects_unique_apid_index)
63 def get_by_id(nil), do: nil
64 def get_by_id(id), do: Repo.get(Object, id)
66 def get_by_id_and_maybe_refetch(id, opts \\ []) do
67 %{updated_at: updated_at} = object = get_by_id(id)
70 NaiveDateTime.diff(NaiveDateTime.utc_now(), updated_at) > opts[:interval] do
71 case Fetcher.refetch_object(object) do
72 {:ok, %Object{} = object} ->
76 Logger.error("Couldn't refresh #{object.data["id"]}:\n#{inspect(e)}")
84 def get_by_ap_id(nil), do: nil
86 def get_by_ap_id(ap_id) do
87 Repo.one(from(object in Object, where: fragment("(?)->>'id' = ?", object.data, ^ap_id)))
91 Get a single attachment by it's name and href
93 @spec get_attachment_by_name_and_href(String.t(), String.t()) :: Object.t() | nil
94 def get_attachment_by_name_and_href(name, href) do
97 where: fragment("(?)->>'name' = ?", o.data, ^name),
98 where: fragment("(?)->>'href' = ?", o.data, ^href)
104 defp warn_on_no_object_preloaded(ap_id) do
105 "Object.normalize() called without preloaded object (#{inspect(ap_id)}). Consider preloading the object"
108 Logger.debug("Backtrace: #{inspect(Process.info(:erlang.self(), :current_stacktrace))}")
111 def normalize(_, fetch_remote \\ true, options \\ [])
113 # If we pass an Activity to Object.normalize(), we can try to use the preloaded object.
114 # Use this whenever possible, especially when walking graphs in an O(N) loop!
115 def normalize(%Object{} = object, _, _), do: object
116 def normalize(%Activity{object: %Object{} = object}, _, _), do: object
118 # A hack for fake activities
119 def normalize(%Activity{data: %{"object" => %{"fake" => true} = data}}, _, _) do
120 %Object{id: "pleroma:fake_object_id", data: data}
123 # No preloaded object
124 def normalize(%Activity{data: %{"object" => %{"id" => ap_id}}}, fetch_remote, _) do
125 warn_on_no_object_preloaded(ap_id)
126 normalize(ap_id, fetch_remote)
129 # No preloaded object
130 def normalize(%Activity{data: %{"object" => ap_id}}, fetch_remote, _) do
131 warn_on_no_object_preloaded(ap_id)
132 normalize(ap_id, fetch_remote)
135 # Old way, try fetching the object through cache.
136 def normalize(%{"id" => ap_id}, fetch_remote, _), do: normalize(ap_id, fetch_remote)
137 def normalize(ap_id, false, _) when is_binary(ap_id), do: get_cached_by_ap_id(ap_id)
139 def normalize(ap_id, true, options) when is_binary(ap_id) do
140 Fetcher.fetch_object_from_id!(ap_id, options)
143 def normalize(_, _, _), do: nil
145 # Owned objects can only be accessed by their owner
146 def authorize_access(%Object{data: %{"actor" => actor}}, %User{ap_id: ap_id}) do
154 # Legacy objects can be accessed by anybody
155 def authorize_access(%Object{}, %User{}), do: :ok
157 @spec get_cached_by_ap_id(String.t()) :: Object.t() | nil
158 def get_cached_by_ap_id(ap_id) do
159 key = "object:#{ap_id}"
161 with {:ok, nil} <- @cachex.get(:object_cache, key),
162 object when not is_nil(object) <- get_by_ap_id(ap_id),
163 {:ok, true} <- @cachex.put(:object_cache, key, object) do
166 {:ok, object} -> object
171 def context_mapping(context) do
172 Object.change(%Object{}, %{data: %{"id" => context}})
175 def make_tombstone(%Object{data: %{"id" => id, "type" => type}}, deleted \\ DateTime.utc_now()) do
184 def swap_object_with_tombstone(object) do
185 tombstone = make_tombstone(object)
188 |> Object.change(%{data: tombstone})
192 def delete(%Object{data: %{"id" => id}} = object) do
193 with {:ok, _obj} = swap_object_with_tombstone(object),
194 deleted_activity = Activity.delete_all_by_object_ap_id(id),
195 {:ok, _} <- invalid_object_cache(object) do
197 Config.get([:instance, :cleanup_attachments]),
198 %{"object" => object}
201 {:ok, object, deleted_activity}
205 @spec cleanup_attachments(boolean(), %{required(:object) => map()}) ::
206 {:ok, Oban.Job.t() | nil}
207 def cleanup_attachments(true, %{"object" => _} = params) do
208 AttachmentsCleanupWorker.enqueue("cleanup_attachments", params)
211 def cleanup_attachments(_, _), do: {:ok, nil}
213 def prune(%Object{data: %{"id" => _id}} = object) do
214 with {:ok, object} <- Repo.delete(object),
215 {:ok, _} <- invalid_object_cache(object) do
220 def invalid_object_cache(%Object{data: %{"id" => id}}) do
221 with {:ok, true} <- @cachex.del(:object_cache, "object:#{id}") do
222 @cachex.del(:web_resp_cache, URI.parse(id).path)
226 def set_cache(%Object{data: %{"id" => ap_id}} = object) do
227 @cachex.put(:object_cache, "object:#{ap_id}", object)
231 def update_and_set_cache(changeset) do
232 with {:ok, object} <- Repo.update(changeset) do
237 def increase_replies_count(ap_id) do
239 |> where([o], fragment("?->>'id' = ?::text", o.data, ^to_string(ap_id)))
245 safe_jsonb_set(?, '{repliesCount}',
246 (coalesce((?->>'repliesCount')::int, 0) + 1)::varchar::jsonb, true)
253 |> Repo.update_all([])
255 {1, [object]} -> set_cache(object)
256 _ -> {:error, "Not found"}
260 defp poll_is_multiple?(%Object{data: %{"anyOf" => [_ | _]}}), do: true
262 defp poll_is_multiple?(_), do: false
264 def decrease_replies_count(ap_id) do
266 |> where([o], fragment("?->>'id' = ?::text", o.data, ^to_string(ap_id)))
272 safe_jsonb_set(?, '{repliesCount}',
273 (greatest(0, (?->>'repliesCount')::int - 1))::varchar::jsonb, true)
280 |> Repo.update_all([])
282 {1, [object]} -> set_cache(object)
283 _ -> {:error, "Not found"}
287 def increase_vote_count(ap_id, name, actor) do
288 with %Object{} = object <- Object.normalize(ap_id),
289 "Question" <- object.data["type"] do
290 key = if poll_is_multiple?(object), do: "anyOf", else: "oneOf"
295 %{"name" => ^name} = option ->
296 Kernel.update_in(option["replies"]["totalItems"], &(&1 + 1))
302 voters = [actor | object.data["voters"] || []] |> Enum.uniq()
306 |> Map.put(key, options)
307 |> Map.put("voters", voters)
310 |> Object.change(%{data: data})
311 |> update_and_set_cache()
317 @doc "Updates data field of an object"
318 def update_data(%Object{data: data} = object, attrs \\ %{}) do
320 |> Object.change(%{data: Map.merge(data || %{}, attrs)})
324 def local?(%Object{data: %{"id" => id}}) do
325 String.starts_with?(id, Pleroma.Web.base_url() <> "/")
328 def replies(object, opts \\ []) do
329 object = Object.normalize(object)
335 fragment("(?)->>'inReplyTo' = ?", o.data, ^object.data["id"])
337 |> order_by([o], asc: o.id)
339 if opts[:self_only] do
340 actor = object.data["actor"]
341 where(query, [o], fragment("(?)->>'actor' = ?", o.data, ^actor))
347 def self_replies(object, opts \\ []),
348 do: replies(object, Keyword.put(opts, :self_only, true))