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.Notification do
9 alias Pleroma.Notification
11 alias Pleroma.Pagination
13 alias Pleroma.ThreadMute
15 alias Pleroma.Web.CommonAPI.Utils
16 alias Pleroma.Web.Push
17 alias Pleroma.Web.Streamer
24 @type t :: %__MODULE__{}
26 @include_muted_option :with_muted
28 schema "notifications" do
29 field(:seen, :boolean, default: false)
30 belongs_to(:user, User, type: FlakeId.Ecto.CompatType)
31 belongs_to(:activity, Activity, type: FlakeId.Ecto.CompatType)
36 def changeset(%Notification{} = notification, attrs) do
38 |> cast(attrs, [:seen])
41 defp for_user_query_ap_id_opts(user, opts) do
44 if opts[@include_muted_option], do: [], else: [:notification_mute]
46 preloaded_ap_ids = User.outgoing_relationships_ap_ids(user, ap_id_relationships)
48 exclude_blocked_opts = Map.merge(%{blocked_users_ap_ids: preloaded_ap_ids[:block]}, opts)
50 exclude_notification_muted_opts =
51 Map.merge(%{notification_muted_users_ap_ids: preloaded_ap_ids[:notification_mute]}, opts)
53 {exclude_blocked_opts, exclude_notification_muted_opts}
56 def for_user_query(user, opts \\ %{}) do
57 {exclude_blocked_opts, exclude_notification_muted_opts} =
58 for_user_query_ap_id_opts(user, opts)
61 |> where(user_id: ^user.id)
65 "? not in (SELECT ap_id FROM users WHERE deactivated = 'true')",
69 |> join(:inner, [n], activity in assoc(n, :activity))
70 |> join(:left, [n, a], object in Object,
73 "(?->>'id') = COALESCE(?->'object'->>'id', ?->>'object')",
79 |> preload([n, a, o], activity: {a, object: o})
80 |> exclude_notification_muted(user, exclude_notification_muted_opts)
81 |> exclude_blocked(user, exclude_blocked_opts)
82 |> exclude_visibility(opts)
86 defp exclude_blocked(query, user, opts) do
87 blocked_ap_ids = opts[:blocked_users_ap_ids] || User.blocked_users_ap_ids(user)
90 |> where([n, a], a.actor not in ^blocked_ap_ids)
93 fragment("substring(? from '.*://([^/]*)')", a.actor) not in ^user.domain_blocks
97 defp exclude_notification_muted(query, _, %{@include_muted_option => true}) do
101 defp exclude_notification_muted(query, user, opts) do
102 notification_muted_ap_ids =
103 opts[:notification_muted_users_ap_ids] || User.notification_muted_users_ap_ids(user)
106 |> where([n, a], a.actor not in ^notification_muted_ap_ids)
107 |> join(:left, [n, a], tm in ThreadMute,
108 on: tm.user_id == ^user.id and tm.context == fragment("?->>'context'", a.data)
110 |> where([n, a, o, tm], is_nil(tm.user_id))
113 defp exclude_move(query, %{with_move: true}) do
117 defp exclude_move(query, _opts) do
118 where(query, [n, a], fragment("?->>'type' != 'Move'", a.data))
121 @valid_visibilities ~w[direct unlisted public private]
123 defp exclude_visibility(query, %{exclude_visibilities: visibility})
124 when is_list(visibility) do
125 if Enum.all?(visibility, &(&1 in @valid_visibilities)) do
127 |> join(:left, [n, a], mutated_activity in Pleroma.Activity,
129 fragment("?->>'context'", a.data) ==
130 fragment("?->>'context'", mutated_activity.data) and
131 fragment("(?->>'type' = 'Like' or ?->>'type' = 'Announce')", a.data, a.data) and
132 fragment("?->>'type'", mutated_activity.data) == "Create",
133 as: :mutated_activity
136 [n, a, mutated_activity: mutated_activity],
139 CASE WHEN (?->>'type') = 'Like' or (?->>'type') = 'Announce'
140 THEN (activity_visibility(?, ?, ?) = ANY (?))
141 ELSE (activity_visibility(?, ?, ?) = ANY (?)) END
145 mutated_activity.actor,
146 mutated_activity.recipients,
147 mutated_activity.data,
156 Logger.error("Could not exclude visibility to #{visibility}")
161 defp exclude_visibility(query, %{exclude_visibilities: visibility})
162 when visibility in @valid_visibilities do
163 exclude_visibility(query, [visibility])
166 defp exclude_visibility(query, %{exclude_visibilities: visibility})
167 when visibility not in @valid_visibilities do
168 Logger.error("Could not exclude visibility to #{visibility}")
172 defp exclude_visibility(query, _visibility), do: query
174 def for_user(user, opts \\ %{}) do
176 |> for_user_query(opts)
177 |> Pagination.fetch_paginated(opts)
181 Returns notifications for user received since given date.
185 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-13 11:22:33])
186 [%Pleroma.Notification{}, %Pleroma.Notification{}]
188 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-15 11:22:33])
191 @spec for_user_since(Pleroma.User.t(), NaiveDateTime.t()) :: [t()]
192 def for_user_since(user, date) do
193 from(n in for_user_query(user),
194 where: n.updated_at > ^date
199 def set_read_up_to(%{id: user_id} = user, id) do
203 where: n.user_id == ^user_id,
205 where: n.seen == false,
209 updated_at: ^NaiveDateTime.utc_now()
212 # Ideally we would preload object and activities here
213 # but Ecto does not support preloads in update_all
217 {_, notification_ids} = Repo.update_all(query, [])
220 |> where([n], n.id in ^notification_ids)
224 def read_one(%User{} = user, notification_id) do
225 with {:ok, %Notification{} = notification} <- get(user, notification_id) do
227 |> changeset(%{seen: true})
232 def get(%{id: user_id} = _user, id) do
237 join: activity in assoc(n, :activity),
238 preload: [activity: activity]
241 notification = Repo.one(query)
244 %{user_id: ^user_id} ->
248 {:error, "Cannot get notification"}
253 from(n in Notification, where: n.user_id == ^user.id)
257 def destroy_multiple(%{id: user_id} = _user, ids) do
258 from(n in Notification,
260 where: n.user_id == ^user_id
265 def dismiss(%Pleroma.Activity{} = activity) do
267 |> where([n], n.activity_id == ^activity.id)
270 {_, notifications} -> {:ok, notifications}
271 _ -> {:error, "Cannot dismiss notification"}
275 def dismiss(%{id: user_id} = _user, id) do
276 notification = Repo.get(Notification, id)
279 %{user_id: ^user_id} ->
280 Repo.delete(notification)
283 {:error, "Cannot dismiss notification"}
287 def create_notifications(%Activity{data: %{"to" => _, "type" => "Create"}} = activity) do
288 object = Object.normalize(activity)
290 if object && object.data["type"] == "Answer" do
293 do_create_notifications(activity)
297 def create_notifications(%Activity{data: %{"type" => type}} = activity)
298 when type in ["Follow", "Like", "Announce", "Move", "EmojiReact"] do
299 do_create_notifications(activity)
302 def create_notifications(_), do: {:ok, []}
304 defp do_create_notifications(%Activity{} = activity) do
305 {enabled_receivers, disabled_receivers} = get_notified_from_activity(activity)
306 potential_receivers = enabled_receivers ++ disabled_receivers
309 Enum.map(potential_receivers, fn user ->
310 do_send = user in enabled_receivers
311 create_notification(activity, user, do_send)
317 # TODO move to sql, too.
318 def create_notification(%Activity{} = activity, %User{} = user, do_send \\ true) do
319 unless skip?(activity, user) do
320 notification = %Notification{user_id: user.id, activity: activity}
321 {:ok, notification} = Repo.insert(notification)
324 Streamer.stream(["user", "user:notification"], notification)
325 Push.send(notification)
333 Returns a tuple with 2 elements:
334 {enabled notification receivers, currently disabled receivers (blocking / [thread] muting)}
336 NOTE: might be called for FAKE Activities, see ActivityPub.Utils.get_notified_from_object/1
338 def get_notified_from_activity(activity, local_only \\ true)
340 def get_notified_from_activity(%Activity{data: %{"type" => type}} = activity, local_only)
341 when type in ["Create", "Like", "Announce", "Follow", "Move", "EmojiReact"] do
342 potential_receiver_ap_ids =
344 |> Utils.maybe_notify_to_recipients(activity)
345 |> Utils.maybe_notify_mentioned_recipients(activity)
346 |> Utils.maybe_notify_subscribers(activity)
347 |> Utils.maybe_notify_followers(activity)
350 # Since even subscribers and followers can mute / thread-mute, filtering all above AP IDs
351 notification_enabled_ap_ids =
352 potential_receiver_ap_ids
353 |> exclude_relationship_restricted_ap_ids(activity)
354 |> exclude_thread_muter_ap_ids(activity)
356 potential_receivers =
357 potential_receiver_ap_ids
359 |> User.get_users_from_set(local_only)
361 notification_enabled_users =
362 Enum.filter(potential_receivers, fn u -> u.ap_id in notification_enabled_ap_ids end)
364 {notification_enabled_users, potential_receivers -- notification_enabled_users}
367 def get_notified_from_activity(_, _local_only), do: {[], []}
369 @doc "Filters out AP IDs of users basing on their relationships with activity actor user"
370 def exclude_relationship_restricted_ap_ids([], _activity), do: []
372 def exclude_relationship_restricted_ap_ids(ap_ids, %Activity{} = activity) do
373 relationship_restricted_ap_ids =
375 |> Activity.user_actor()
376 |> User.incoming_relationships_ungrouped_ap_ids([
381 Enum.uniq(ap_ids) -- relationship_restricted_ap_ids
384 @doc "Filters out AP IDs of users who mute activity thread"
385 def exclude_thread_muter_ap_ids([], _activity), do: []
387 def exclude_thread_muter_ap_ids(ap_ids, %Activity{} = activity) do
388 thread_muter_ap_ids = ThreadMute.muter_ap_ids(activity.data["context"])
390 Enum.uniq(ap_ids) -- thread_muter_ap_ids
393 @spec skip?(Activity.t(), User.t()) :: boolean()
394 def skip?(%Activity{} = activity, %User{} = user) do
403 |> Enum.find(&skip?(&1, activity, user))
406 def skip?(_, _), do: false
408 @spec skip?(atom(), Activity.t(), User.t()) :: boolean()
409 def skip?(:self, %Activity{} = activity, %User{} = user) do
410 activity.data["actor"] == user.ap_id
415 %Activity{} = activity,
416 %User{notification_settings: %{followers: false}} = user
418 actor = activity.data["actor"]
419 follower = User.get_cached_by_ap_id(actor)
420 User.following?(follower, user)
425 %Activity{} = activity,
426 %User{notification_settings: %{non_followers: false}} = user
428 actor = activity.data["actor"]
429 follower = User.get_cached_by_ap_id(actor)
430 !User.following?(follower, user)
435 %Activity{} = activity,
436 %User{notification_settings: %{follows: false}} = user
438 actor = activity.data["actor"]
439 followed = User.get_cached_by_ap_id(actor)
440 User.following?(user, followed)
445 %Activity{} = activity,
446 %User{notification_settings: %{non_follows: false}} = user
448 actor = activity.data["actor"]
449 followed = User.get_cached_by_ap_id(actor)
450 !User.following?(user, followed)
453 # To do: consider defining recency in hours and checking FollowingRelationship with a single SQL
454 def skip?(:recently_followed, %Activity{data: %{"type" => "Follow"}} = activity, %User{} = user) do
455 actor = activity.data["actor"]
457 Notification.for_user(user)
459 %{activity: %{data: %{"type" => "Follow", "actor" => ^actor}}} -> true
464 def skip?(_, _, _), do: false