1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.ActivityPub.Utils do
9 alias Pleroma.Activity.Queries
10 alias Pleroma.Notification
15 alias Pleroma.Web.ActivityPub.ActivityPub
16 alias Pleroma.Web.ActivityPub.Visibility
17 alias Pleroma.Web.Endpoint
18 alias Pleroma.Web.Router.Helpers
23 require Pleroma.Constants
25 @supported_object_types ["Article", "Note", "Video", "Page", "Question", "Answer", "Audio"]
26 @supported_report_states ~w(open closed resolved)
27 @valid_visibilities ~w(public unlisted private direct)
29 # Some implementations send the actor URI as the actor field, others send the entire actor object,
30 # so figure out what the actor's URI is based on what we have.
31 def get_ap_id(%{"id" => id} = _), do: id
32 def get_ap_id(id), do: id
34 def normalize_params(params) do
35 Map.put(params, "actor", get_ap_id(params["actor"]))
38 @spec determine_explicit_mentions(map()) :: map()
39 def determine_explicit_mentions(%{"tag" => tag} = _) when is_list(tag) do
41 %{"type" => "Mention", "href" => href} -> [href]
46 def determine_explicit_mentions(%{"tag" => tag} = object) when is_map(tag) do
48 |> Map.put("tag", [tag])
49 |> determine_explicit_mentions()
52 def determine_explicit_mentions(_), do: []
54 @spec recipient_in_collection(any(), any()) :: boolean()
55 defp recipient_in_collection(ap_id, coll) when is_binary(coll), do: ap_id == coll
56 defp recipient_in_collection(ap_id, coll) when is_list(coll), do: ap_id in coll
57 defp recipient_in_collection(_, _), do: false
59 @spec recipient_in_message(User.t(), User.t(), map()) :: boolean()
60 def recipient_in_message(%User{ap_id: ap_id} = recipient, %User{} = actor, params) do
61 addresses = [params["to"], params["cc"], params["bto"], params["bcc"]]
64 Enum.any?(addresses, &recipient_in_collection(ap_id, &1)) -> true
65 # if the message is unaddressed at all, then assume it is directly addressed
67 Enum.all?(addresses, &is_nil(&1)) -> true
68 # if the message is sent from somebody the user is following, then assume it
69 # is addressed to the recipient
70 User.following?(recipient, actor) -> true
75 defp extract_list(target) when is_binary(target), do: [target]
76 defp extract_list(lst) when is_list(lst), do: lst
77 defp extract_list(_), do: []
79 def maybe_splice_recipient(ap_id, params) do
81 !recipient_in_collection(ap_id, params["to"]) &&
82 !recipient_in_collection(ap_id, params["cc"])
85 cc_list = extract_list(params["cc"])
86 Map.put(params, "cc", [ap_id | cc_list])
92 def make_json_ld_header do
95 "https://www.w3.org/ns/activitystreams",
96 "#{Web.base_url()}/schemas/litepub-0.1.jsonld",
105 DateTime.utc_now() |> DateTime.to_iso8601()
108 def generate_activity_id do
109 generate_id("activities")
112 def generate_context_id do
113 generate_id("contexts")
116 def generate_object_id do
117 Helpers.o_status_url(Endpoint, :object, UUID.generate())
120 def generate_id(type) do
121 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
124 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
125 fake_create_activity = %{
126 "to" => object["to"],
127 "cc" => object["cc"],
132 get_notified_from_object(fake_create_activity)
135 def get_notified_from_object(object) do
136 Notification.get_notified_from_activity(%Activity{data: object}, false)
139 def create_context(context) do
140 context = context || generate_id("contexts")
142 # Ecto has problems accessing the constraint inside the jsonb,
143 # so we explicitly check for the existed object before insert
144 object = Object.get_cached_by_ap_id(context)
146 with true <- is_nil(object),
147 changeset <- Object.context_mapping(context),
148 {:ok, inserted_object} <- Repo.insert(changeset) do
157 Enqueues an activity for federation if it's local
159 @spec maybe_federate(any()) :: :ok
160 def maybe_federate(%Activity{local: true} = activity) do
161 if Pleroma.Config.get!([:instance, :federating]) do
162 Pleroma.Web.Federator.publish(activity)
168 def maybe_federate(_), do: :ok
171 Adds an id and a published data if they aren't there,
172 also adds it to an included object
174 @spec lazy_put_activity_defaults(map(), boolean) :: map()
175 def lazy_put_activity_defaults(map, fake? \\ false)
177 def lazy_put_activity_defaults(map, true) do
179 |> Map.put_new("id", "pleroma:fakeid")
180 |> Map.put_new_lazy("published", &make_date/0)
181 |> Map.put_new("context", "pleroma:fakecontext")
182 |> Map.put_new("context_id", -1)
183 |> lazy_put_object_defaults(true)
186 def lazy_put_activity_defaults(map, _fake?) do
187 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
190 |> Map.put_new_lazy("id", &generate_activity_id/0)
191 |> Map.put_new_lazy("published", &make_date/0)
192 |> Map.put_new("context", context)
193 |> Map.put_new("context_id", context_id)
194 |> lazy_put_object_defaults(false)
197 # Adds an id and published date if they aren't there.
199 @spec lazy_put_object_defaults(map(), boolean()) :: map()
200 defp lazy_put_object_defaults(%{"object" => map} = activity, true)
204 |> Map.put_new("id", "pleroma:fake_object_id")
205 |> Map.put_new_lazy("published", &make_date/0)
206 |> Map.put_new("context", activity["context"])
207 |> Map.put_new("context_id", activity["context_id"])
208 |> Map.put_new("fake", true)
210 %{activity | "object" => object}
213 defp lazy_put_object_defaults(%{"object" => map} = activity, _)
217 |> Map.put_new_lazy("id", &generate_object_id/0)
218 |> Map.put_new_lazy("published", &make_date/0)
219 |> Map.put_new("context", activity["context"])
220 |> Map.put_new("context_id", activity["context_id"])
222 %{activity | "object" => object}
225 defp lazy_put_object_defaults(activity, _), do: activity
228 Inserts a full object if it is contained in an activity.
230 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
231 when is_map(object_data) and type in @supported_object_types do
232 with {:ok, object} <- Object.create(object_data) do
233 map = Map.put(map, "object", object.data["id"])
239 def insert_full_object(map), do: {:ok, map, nil}
241 #### Like-related helpers
244 Returns an existing like if a user already liked an object
246 @spec get_existing_like(String.t(), map()) :: Activity.t() | nil
247 def get_existing_like(actor, %{data: %{"id" => id}}) do
249 |> Activity.Queries.by_actor()
250 |> Activity.Queries.by_object_id(id)
251 |> Activity.Queries.by_type("Like")
256 @spec make_like_data(User.t(), map(), String.t()) :: map()
258 %User{ap_id: ap_id} = actor,
259 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
262 object_actor = User.get_cached_by_ap_id(object_actor_id)
265 if Visibility.is_public?(object) do
266 [actor.follower_address, object.data["actor"]]
268 [object.data["actor"]]
272 (object.data["to"] ++ (object.data["cc"] || []))
273 |> List.delete(actor.ap_id)
274 |> List.delete(object_actor.follower_address)
282 "context" => object.data["context"]
284 |> maybe_put("id", activity_id)
287 @spec update_element_in_object(String.t(), list(any), Object.t()) ::
288 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
289 def update_element_in_object(property, element, object) do
293 %{"#{property}_count" => length(element), "#{property}s" => element}
297 |> Changeset.change(data: data)
298 |> Object.update_and_set_cache()
301 @spec add_like_to_object(Activity.t(), Object.t()) ::
302 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
303 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
304 [actor | fetch_likes(object)]
306 |> update_likes_in_object(object)
309 @spec remove_like_from_object(Activity.t(), Object.t()) ::
310 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
311 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
314 |> List.delete(actor)
315 |> update_likes_in_object(object)
318 defp update_likes_in_object(likes, object) do
319 update_element_in_object("like", likes, object)
322 defp fetch_likes(object) do
323 if is_list(object.data["likes"]) do
330 #### Follow-related helpers
333 Updates a follow activity's state (for locked accounts).
335 @spec update_follow_state_for_all(Activity.t(), String.t()) :: {:ok, Activity} | {:error, any()}
336 def update_follow_state_for_all(
337 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
341 |> Activity.Queries.by_type()
342 |> Activity.Queries.by_actor(actor)
343 |> Activity.Queries.by_object_id(object)
344 |> where(fragment("data->>'state' = 'pending'"))
345 |> update(set: [data: fragment("jsonb_set(data, '{state}', ?)", ^state)])
346 |> Repo.update_all([])
348 User.set_follow_state_cache(actor, object, state)
350 activity = Activity.get_by_id(activity.id)
355 def update_follow_state(
356 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
359 new_data = Map.put(activity.data, "state", state)
360 changeset = Changeset.change(activity, data: new_data)
362 with {:ok, activity} <- Repo.update(changeset) do
363 User.set_follow_state_cache(actor, object, state)
369 Makes a follow activity data for the given follower and followed
371 def make_follow_data(
372 %User{ap_id: follower_id},
373 %User{ap_id: followed_id} = _followed,
378 "actor" => follower_id,
379 "to" => [followed_id],
380 "cc" => [Pleroma.Constants.as_public()],
381 "object" => followed_id,
384 |> maybe_put("id", activity_id)
387 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
389 |> Activity.Queries.by_type()
390 |> where(actor: ^follower_id)
391 # this is to use the index
392 |> Activity.Queries.by_object_id(followed_id)
393 |> order_by([activity], fragment("? desc nulls last", activity.id))
398 #### Announce-related helpers
401 Retruns an existing announce activity if the notice has already been announced
403 @spec get_existing_announce(String.t(), map()) :: Activity.t() | nil
404 def get_existing_announce(actor, %{data: %{"id" => ap_id}}) do
406 |> Activity.Queries.by_type()
407 |> where(actor: ^actor)
408 # this is to use the index
409 |> Activity.Queries.by_object_id(ap_id)
414 Make announce activity data for the given actor and object
416 # for relayed messages, we only want to send to subscribers
417 def make_announce_data(
418 %User{ap_id: ap_id} = user,
419 %Object{data: %{"id" => id}} = object,
424 "type" => "Announce",
427 "to" => [user.follower_address],
429 "context" => object.data["context"]
431 |> maybe_put("id", activity_id)
434 def make_announce_data(
435 %User{ap_id: ap_id} = user,
436 %Object{data: %{"id" => id}} = object,
441 "type" => "Announce",
444 "to" => [user.follower_address, object.data["actor"]],
445 "cc" => [Pleroma.Constants.as_public()],
446 "context" => object.data["context"]
448 |> maybe_put("id", activity_id)
452 Make unannounce activity data for the given actor and object
454 def make_unannounce_data(
455 %User{ap_id: ap_id} = user,
456 %Activity{data: %{"context" => context, "object" => object}} = activity,
459 object = Object.normalize(object)
464 "object" => activity.data,
465 "to" => [user.follower_address, object.data["actor"]],
466 "cc" => [Pleroma.Constants.as_public()],
469 |> maybe_put("id", activity_id)
472 def make_unlike_data(
473 %User{ap_id: ap_id} = user,
474 %Activity{data: %{"context" => context, "object" => object}} = activity,
477 object = Object.normalize(object)
482 "object" => activity.data,
483 "to" => [user.follower_address, object.data["actor"]],
484 "cc" => [Pleroma.Constants.as_public()],
487 |> maybe_put("id", activity_id)
490 @spec add_announce_to_object(Activity.t(), Object.t()) ::
491 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
492 def add_announce_to_object(
493 %Activity{data: %{"actor" => actor}},
496 announcements = take_announcements(object)
498 with announcements <- Enum.uniq([actor | announcements]) do
499 update_element_in_object("announcement", announcements, object)
503 def add_announce_to_object(_, object), do: {:ok, object}
505 @spec remove_announce_from_object(Activity.t(), Object.t()) ::
506 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
507 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
508 with announcements <- List.delete(take_announcements(object), actor) do
509 update_element_in_object("announcement", announcements, object)
513 defp take_announcements(%{data: %{"announcements" => announcements}} = _)
514 when is_list(announcements),
517 defp take_announcements(_), do: []
519 #### Unfollow-related helpers
521 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
524 "actor" => follower.ap_id,
525 "to" => [followed.ap_id],
526 "object" => follow_activity.data
528 |> maybe_put("id", activity_id)
531 #### Block-related helpers
532 @spec fetch_latest_block(User.t(), User.t()) :: Activity.t() | nil
533 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
535 |> Activity.Queries.by_type()
536 |> where(actor: ^blocker_id)
537 # this is to use the index
538 |> Activity.Queries.by_object_id(blocked_id)
539 |> order_by([activity], fragment("? desc nulls last", activity.id))
544 def make_block_data(blocker, blocked, activity_id) do
547 "actor" => blocker.ap_id,
548 "to" => [blocked.ap_id],
549 "object" => blocked.ap_id
551 |> maybe_put("id", activity_id)
554 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
557 "actor" => blocker.ap_id,
558 "to" => [blocked.ap_id],
559 "object" => block_activity.data
561 |> maybe_put("id", activity_id)
564 #### Create-related helpers
566 def make_create_data(params, additional) do
567 published = params.published || make_date()
571 "to" => params.to |> Enum.uniq(),
572 "actor" => params.actor.ap_id,
573 "object" => params.object,
574 "published" => published,
575 "context" => params.context
577 |> Map.merge(additional)
580 #### Listen-related helpers
581 def make_listen_data(params, additional) do
582 published = params.published || make_date()
586 "to" => params.to |> Enum.uniq(),
587 "actor" => params.actor.ap_id,
588 "object" => params.object,
589 "published" => published,
590 "context" => params.context
592 |> Map.merge(additional)
595 #### Flag-related helpers
596 @spec make_flag_data(map(), map()) :: map()
597 def make_flag_data(%{actor: actor, context: context, content: content} = params, additional) do
600 "actor" => actor.ap_id,
601 "content" => content,
602 "object" => build_flag_object(params),
603 "context" => context,
606 |> Map.merge(additional)
609 def make_flag_data(_, _), do: %{}
611 defp build_flag_object(%{account: account, statuses: statuses} = _) do
613 Enum.map(statuses || [], fn
614 %Activity{} = act -> act.data["id"]
615 act when is_map(act) -> act["id"]
616 act when is_binary(act) -> act
620 defp build_flag_object(_), do: []
623 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
624 the first one to `pages_left` pages.
625 If the amount of pages is higher than the collection has, it returns whatever was there.
627 def fetch_ordered_collection(from, pages_left, acc \\ []) do
628 with {:ok, response} <- Tesla.get(from),
629 {:ok, collection} <- Jason.decode(response.body) do
630 case collection["type"] do
631 "OrderedCollection" ->
632 # If we've encountered the OrderedCollection and not the page,
633 # just call the same function on the page address
634 fetch_ordered_collection(collection["first"], pages_left)
636 "OrderedCollectionPage" ->
638 # There are still more pages
639 if Map.has_key?(collection, "next") do
640 # There are still more pages, go deeper saving what we have into the accumulator
641 fetch_ordered_collection(
644 acc ++ collection["orderedItems"]
647 # No more pages left, just return whatever we already have
648 acc ++ collection["orderedItems"]
651 # Got the amount of pages needed, add them all to the accumulator
652 acc ++ collection["orderedItems"]
656 {:error, "Not an OrderedCollection or OrderedCollectionPage"}
661 #### Report-related helpers
663 def get_reports(params, page, page_size) do
666 |> Map.put("type", "Flag")
667 |> Map.put("skip_preload", true)
668 |> Map.put("total", true)
669 |> Map.put("limit", page_size)
670 |> Map.put("offset", (page - 1) * page_size)
672 ActivityPub.fetch_activities([], params, :offset)
675 @spec get_reports_grouped_by_status() :: %{
676 required(:groups) => [
678 required(:date) => String.t(),
679 required(:account) => %User{},
680 required(:status) => %Activity{},
681 required(:actors) => [%User{}],
682 required(:reports) => [%Activity{}]
685 required(:total) => integer
687 def get_reports_grouped_by_status do
688 paginated_activities = get_reported_status_ids()
692 |> Enum.map(fn entry ->
695 |> Queries.by_ap_id(entry[:activity_id])
696 |> Activity.with_preloaded_object(:left)
697 |> Activity.with_preloaded_user_actor()
700 reports = get_reports_by_status_id(status.data["id"])
703 Enum.max_by(reports, &Pleroma.Web.CommonAPI.Utils.to_masto_date(&1.data["published"])).data[
707 actors = Enum.map(reports, & &1.user_actor)
711 account: status.user_actor,
723 def get_reports_by_status_id(status_id) do
725 where: fragment("(?)->>'type' = 'Flag'", a.data),
726 where: fragment("(?)->'object' \\? (?)", a.data, ^status_id)
728 |> Activity.with_preloaded_user_actor()
732 @spec get_reported_status_ids() :: %{
733 required(:items) => [%Activity{}],
734 required(:total) => integer
736 def get_reported_status_ids do
738 where: fragment("(?)->>'type' = 'Flag'", a.data),
740 date: fragment("max(?->>'published') date", a.data),
742 fragment("jsonb_array_elements_text((? #- '{object,0}')->'object') activity_id", a.data)
744 group_by: fragment("activity_id"),
745 order_by: fragment("date DESC")
750 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
751 new_data = Map.put(activity.data, "state", state)
754 |> Changeset.change(data: new_data)
758 def update_report_state(activity_ids, state) when state in @supported_report_states do
759 activities_num = length(activity_ids)
761 from(a in Activity, where: a.id in ^activity_ids)
762 |> update(set: [data: fragment("jsonb_set(data, '{state}', ?)", ^state)])
763 |> Repo.update_all([])
765 {^activities_num, _} -> :ok
766 _ -> {:error, activity_ids}
770 def update_report_state(_, _), do: {:error, "Unsupported state"}
772 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
773 [to, cc, recipients] =
775 |> get_updated_targets(visibility)
776 |> Enum.map(&Enum.uniq/1)
785 |> Object.change(%{data: object_data})
786 |> Object.update_and_set_cache()
794 |> Map.put(:object, object)
795 |> Activity.change(%{data: activity_data, recipients: recipients})
799 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
801 defp get_updated_targets(
802 %Activity{data: %{"to" => to} = data, recipients: recipients},
805 cc = Map.get(data, "cc", [])
806 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
807 public = Pleroma.Constants.as_public()
811 to = [public | List.delete(to, follower_address)]
812 cc = [follower_address | List.delete(cc, public)]
813 recipients = [public | recipients]
817 to = [follower_address | List.delete(to, public)]
818 cc = List.delete(cc, public)
819 recipients = List.delete(recipients, public)
823 to = [follower_address | List.delete(to, public)]
824 cc = [public | List.delete(cc, follower_address)]
825 recipients = recipients ++ [follower_address, public]
833 def get_existing_votes(actor, %{data: %{"id" => id}}) do
835 |> Activity.Queries.by_actor()
836 |> Activity.Queries.by_type("Create")
837 |> Activity.with_preloaded_object()
838 |> where([a, object: o], fragment("(?)->>'inReplyTo' = ?", o.data, ^to_string(id)))
839 |> where([a, object: o], fragment("(?)->>'type' = 'Answer'", o.data))
843 def maybe_put(map, _key, nil), do: map
844 def maybe_put(map, key, value), do: Map.put(map, key, value)