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.Publisher do
9 alias Pleroma.Instances
11 alias Pleroma.Web.ActivityPub.Relay
12 alias Pleroma.Web.ActivityPub.Transmogrifier
14 require Pleroma.Constants
16 import Pleroma.Web.ActivityPub.Visibility
18 @behaviour Pleroma.Web.Federator.Publisher
23 ActivityPub outgoing federation module.
27 Determine if an activity can be represented by running it through Transmogrifier.
29 def is_representable?(%Activity{} = activity) do
30 with {:ok, _data} <- Transmogrifier.prepare_outgoing(activity.data) do
39 Publish a single message to a peer. Takes a struct with the following
42 * `inbox`: the inbox to publish to
43 * `json`: the JSON message body representing the ActivityPub message
44 * `actor`: the actor which is signing the message
45 * `id`: the ActivityStreams URI of the message
47 def publish_one(%{inbox: inbox, json: json, actor: %User{} = actor, id: id} = params) do
48 Logger.info("Federating #{id} to #{inbox}")
49 %{host: host, path: path} = URI.parse(inbox)
51 digest = "SHA-256=" <> (:crypto.hash(:sha256, json) |> Base.encode64())
54 NaiveDateTime.utc_now()
55 |> Timex.format!("{WDshort}, {0D} {Mshort} {YYYY} {h24}:{m}:{s} GMT")
58 Pleroma.Signature.sign(actor, %{
59 "(request-target)": "post #{path}",
61 "content-length": byte_size(json),
66 with {:ok, %{status: code}} when code in 200..299 <-
72 {"Content-Type", "application/activity+json"},
74 {"signature", signature},
78 if !Map.has_key?(params, :unreachable_since) || params[:unreachable_since],
79 do: Instances.set_reachable(inbox)
83 {_post_result, response} ->
84 unless params[:unreachable_since], do: Instances.set_unreachable(inbox)
89 defp should_federate?(inbox, public) do
93 %{host: host} = URI.parse(inbox)
95 quarantined_instances =
96 Config.get([:instance, :quarantined_instances], [])
97 |> Pleroma.Web.ActivityPub.MRF.subdomains_regex()
99 !Pleroma.Web.ActivityPub.MRF.subdomain_match?(quarantined_instances, host)
103 @spec recipients(User.t(), Activity.t()) :: list(User.t()) | []
104 defp recipients(actor, activity) do
106 if actor.follower_address in activity.recipients do
107 User.get_external_followers(actor)
112 Pleroma.Web.Salmon.remote_users(actor, activity) ++ followers
115 defp get_cc_ap_ids(ap_id, recipients) do
116 host = Map.get(URI.parse(ap_id), :host)
119 |> Enum.filter(fn %User{ap_id: ap_id} -> Map.get(URI.parse(ap_id), :host) == host end)
120 |> Enum.map(& &1.ap_id)
123 defp maybe_use_sharedinbox(%User{info: %{source_data: data}}),
124 do: (is_map(data["endpoints"]) && Map.get(data["endpoints"], "sharedInbox")) || data["inbox"]
127 Determine a user inbox to use based on heuristics. These heuristics
128 are based on an approximation of the ``sharedInbox`` rules in the
129 [ActivityPub specification][ap-sharedinbox].
131 Please do not edit this function (or its children) without reading
132 the spec, as editing the code is likely to introduce some breakage
133 without some familiarity.
135 [ap-sharedinbox]: https://www.w3.org/TR/activitypub/#shared-inbox-delivery
138 %Activity{data: activity_data},
139 %User{info: %{source_data: data}} = user
141 to = activity_data["to"] || []
142 cc = activity_data["cc"] || []
143 type = activity_data["type"]
147 maybe_use_sharedinbox(user)
149 Pleroma.Constants.as_public() in to || Pleroma.Constants.as_public() in cc ->
150 maybe_use_sharedinbox(user)
152 length(to) + length(cc) > 1 ->
153 maybe_use_sharedinbox(user)
161 Publishes an activity with BCC to all relevant peers.
164 def publish(actor, %{data: %{"bcc" => bcc}} = activity) when is_list(bcc) and bcc != [] do
165 public = is_public?(activity)
166 {:ok, data} = Transmogrifier.prepare_outgoing(activity.data)
168 recipients = recipients(actor, activity)
171 |> Enum.filter(&User.ap_enabled?/1)
172 |> Enum.map(fn %{info: %{source_data: data}} -> data["inbox"] end)
173 |> Enum.filter(fn inbox -> should_federate?(inbox, public) end)
174 |> Instances.filter_reachable()
175 |> Enum.each(fn {inbox, unreachable_since} ->
176 %User{ap_id: ap_id} =
177 Enum.find(recipients, fn %{info: %{source_data: data}} -> data["inbox"] == inbox end)
179 # Get all the recipients on the same host and add them to cc. Otherwise, a remote
180 # instance would only accept a first message for the first recipient and ignore the rest.
181 cc = get_cc_ap_ids(ap_id, recipients)
188 Pleroma.Web.Federator.Publisher.enqueue_one(__MODULE__, %{
192 id: activity.data["id"],
193 unreachable_since: unreachable_since
199 Publishes an activity to all relevant peers.
201 def publish(%User{} = actor, %Activity{} = activity) do
202 public = is_public?(activity)
204 if public && Config.get([:instance, :allow_relay]) do
205 Logger.info(fn -> "Relaying #{activity.data["id"]} out" end)
206 Relay.publish(activity)
209 {:ok, data} = Transmogrifier.prepare_outgoing(activity.data)
210 json = Jason.encode!(data)
212 recipients(actor, activity)
213 |> Enum.filter(fn user -> User.ap_enabled?(user) end)
214 |> Enum.map(fn %User{} = user ->
215 determine_inbox(activity, user)
218 |> Enum.filter(fn inbox -> should_federate?(inbox, public) end)
219 |> Instances.filter_reachable()
220 |> Enum.each(fn {inbox, unreachable_since} ->
221 Pleroma.Web.Federator.Publisher.enqueue_one(
227 id: activity.data["id"],
228 unreachable_since: unreachable_since
234 def gather_webfinger_links(%User{} = user) do
236 %{"rel" => "self", "type" => "application/activity+json", "href" => user.ap_id},
239 "type" => "application/ld+json; profile=\"https://www.w3.org/ns/activitystreams\"",
245 def gather_nodeinfo_protocol_names, do: ["activitypub"]