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.Web.Streamer do
9 alias Pleroma.Chat.MessageReference
11 alias Pleroma.Conversation.Participation
12 alias Pleroma.Notification
15 alias Pleroma.Web.ActivityPub.ActivityPub
16 alias Pleroma.Web.ActivityPub.Visibility
17 alias Pleroma.Web.CommonAPI
18 alias Pleroma.Web.StreamerView
21 @registry Pleroma.Web.StreamerRegistry
23 def registry, do: @registry
25 @public_streams ["public", "public:local", "public:media", "public:local:media"]
26 @user_streams ["user", "user:notification", "direct", "user:pleroma_chat"]
28 @doc "Expands and authorizes a stream, and registers the process for streaming."
29 @spec get_topic_and_add_socket(stream :: String.t(), User.t() | nil, Map.t() | nil) ::
30 {:ok, topic :: String.t()} | {:error, :bad_topic} | {:error, :unauthorized}
31 def get_topic_and_add_socket(stream, user, params \\ %{}) do
32 case get_topic(stream, user, params) do
33 {:ok, topic} -> add_socket(topic, user)
38 @doc "Expand and authorizes a stream"
39 @spec get_topic(stream :: String.t(), User.t() | nil, Map.t()) ::
40 {:ok, topic :: String.t()} | {:error, :bad_topic}
41 def get_topic(stream, user, params \\ %{})
43 # Allow all public steams.
44 def get_topic(stream, _, _) when stream in @public_streams do
48 # Allow all hashtags streams.
49 def get_topic("hashtag", _, %{"tag" => tag}) do
50 {:ok, "hashtag:" <> tag}
53 # Expand user streams.
54 def get_topic(stream, %User{} = user, _) when stream in @user_streams do
55 {:ok, stream <> ":" <> to_string(user.id)}
58 def get_topic(stream, _, _) when stream in @user_streams do
59 {:error, :unauthorized}
63 def get_topic("list", %User{} = user, %{"list" => id}) do
64 if Pleroma.List.get(id, user) do
65 {:ok, "list:" <> to_string(id)}
71 def get_topic("list", _, _) do
72 {:error, :unauthorized}
75 def get_topic(_, _, _) do
79 @doc "Registers the process for streaming. Use `get_topic/3` to get the full authorized topic."
80 def add_socket(topic, user) do
81 if should_env_send?() do
82 auth? = if user, do: true
83 Registry.register(@registry, topic, auth?)
89 def remove_socket(topic) do
90 if should_env_send?(), do: Registry.unregister(@registry, topic)
93 def stream(topics, items) do
94 if should_env_send?() do
96 |> Enum.each(fn topic ->
98 |> Enum.each(fn item ->
99 spawn(fn -> do_stream(topic, item) end)
107 def filtered_by_user?(%User{} = user, %Activity{} = item) do
108 %{block: blocked_ap_ids, mute: muted_ap_ids, reblog_mute: reblog_muted_ap_ids} =
109 User.outgoing_relationships_ap_ids(user, [:block, :mute, :reblog_mute])
111 recipient_blocks = MapSet.new(blocked_ap_ids ++ muted_ap_ids)
112 recipients = MapSet.new(item.recipients)
113 domain_blocks = Pleroma.Web.ActivityPub.MRF.subdomains_regex(user.domain_blocks)
115 with parent <- Object.normalize(item) || item,
117 Enum.all?([blocked_ap_ids, muted_ap_ids], &(item.actor not in &1)),
118 true <- item.data["type"] != "Announce" || item.actor not in reblog_muted_ap_ids,
119 true <- !(item.data["type"] == "Announce" && parent.data["actor"] == user.ap_id),
120 true <- Enum.all?([blocked_ap_ids, muted_ap_ids], &(parent.data["actor"] not in &1)),
121 true <- MapSet.disjoint?(recipients, recipient_blocks),
122 %{host: item_host} <- URI.parse(item.actor),
123 %{host: parent_host} <- URI.parse(parent.data["actor"]),
124 false <- Pleroma.Web.ActivityPub.MRF.subdomain_match?(domain_blocks, item_host),
125 false <- Pleroma.Web.ActivityPub.MRF.subdomain_match?(domain_blocks, parent_host),
126 true <- thread_containment(item, user),
127 false <- CommonAPI.thread_muted?(user, parent) do
134 def filtered_by_user?(%User{} = user, %Notification{activity: activity}) do
135 filtered_by_user?(user, activity)
138 defp do_stream("direct", item) do
140 User.get_recipients_from_activity(item)
141 |> Enum.map(fn %{id: id} -> "direct:#{id}" end)
143 Enum.each(recipient_topics, fn user_topic ->
144 Logger.debug("Trying to push direct message to #{user_topic}\n\n")
145 push_to_socket(user_topic, item)
149 defp do_stream("participation", participation) do
150 user_topic = "direct:#{participation.user_id}"
151 Logger.debug("Trying to push a conversation participation to #{user_topic}\n\n")
153 push_to_socket(user_topic, participation)
156 defp do_stream("list", item) do
157 # filter the recipient list if the activity is not public, see #270.
159 case Visibility.is_public?(item) do
161 Pleroma.List.get_lists_from_activity(item)
164 Pleroma.List.get_lists_from_activity(item)
165 |> Enum.filter(fn list ->
166 owner = User.get_cached_by_id(list.user_id)
168 Visibility.visible_for_user?(item, owner)
174 |> Enum.map(fn %{id: id} -> "list:#{id}" end)
176 Enum.each(recipient_topics, fn list_topic ->
177 Logger.debug("Trying to push message to #{list_topic}\n\n")
178 push_to_socket(list_topic, item)
182 defp do_stream(topic, %Notification{} = item)
183 when topic in ["user", "user:notification"] do
184 Registry.dispatch(@registry, "#{topic}:#{item.user_id}", fn list ->
185 Enum.each(list, fn {pid, _auth} ->
186 send(pid, {:render_with_user, StreamerView, "notification.json", item})
191 defp do_stream(topic, {user, %MessageReference{} = cm_ref})
192 when topic in ["user", "user:pleroma_chat"] do
193 topic = "#{topic}:#{user.id}"
195 text = StreamerView.render("chat_update.json", %{chat_message_reference: cm_ref})
197 Registry.dispatch(@registry, topic, fn list ->
198 Enum.each(list, fn {pid, _auth} ->
199 send(pid, {:text, text})
204 defp do_stream("user", item) do
205 Logger.debug("Trying to push to users")
208 User.get_recipients_from_activity(item)
209 |> Enum.map(fn %{id: id} -> "user:#{id}" end)
211 Enum.each(recipient_topics, fn topic ->
212 push_to_socket(topic, item)
216 defp do_stream(topic, item) do
217 Logger.debug("Trying to push to #{topic}")
218 Logger.debug("Pushing item to #{topic}")
219 push_to_socket(topic, item)
222 defp push_to_socket(topic, %Participation{} = participation) do
223 rendered = StreamerView.render("conversation.json", participation)
225 Registry.dispatch(@registry, topic, fn list ->
226 Enum.each(list, fn {pid, _} ->
227 send(pid, {:text, rendered})
232 defp push_to_socket(topic, %Activity{
233 data: %{"type" => "Delete", "deleted_activity_id" => deleted_activity_id}
235 rendered = Jason.encode!(%{event: "delete", payload: to_string(deleted_activity_id)})
237 Registry.dispatch(@registry, topic, fn list ->
238 Enum.each(list, fn {pid, _} ->
239 send(pid, {:text, rendered})
244 defp push_to_socket(_topic, %Activity{data: %{"type" => "Delete"}}), do: :noop
246 defp push_to_socket(topic, item) do
247 anon_render = StreamerView.render("update.json", item)
249 Registry.dispatch(@registry, topic, fn list ->
250 Enum.each(list, fn {pid, auth?} ->
252 send(pid, {:render_with_user, StreamerView, "update.json", item})
254 send(pid, {:text, anon_render})
260 defp thread_containment(_activity, %User{skip_thread_containment: true}), do: true
262 defp thread_containment(activity, user) do
263 if Config.get([:instance, :skip_thread_containment]) do
266 ActivityPub.contain_activity(activity, user)
270 # In test environement, only return true if the registry is started.
271 # In benchmark environment, returns false.
272 # In any other environment, always returns true.
275 def should_env_send? do
276 case Process.whereis(@registry) do
285 @mix_env == :benchmark ->
286 def should_env_send?, do: false
289 def should_env_send?, do: true