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
10 alias Pleroma.FollowingRelationship
12 alias Pleroma.Notification
14 alias Pleroma.Pagination
16 alias Pleroma.ThreadMute
18 alias Pleroma.Web.CommonAPI.Utils
19 alias Pleroma.Web.Push
20 alias Pleroma.Web.Streamer
27 @type t :: %__MODULE__{}
29 @include_muted_option :with_muted
31 schema "notifications" do
32 field(:seen, :boolean, default: false)
33 # This is an enum type in the database. If you add a new notification type,
34 # remember to add a migration to add it to the `notifications_type` enum
37 belongs_to(:user, User, type: FlakeId.Ecto.CompatType)
38 belongs_to(:activity, Activity, type: FlakeId.Ecto.CompatType)
43 def update_notification_type(user, activity) do
44 with %__MODULE__{} = notification <-
45 Repo.get_by(__MODULE__, user_id: user.id, activity_id: activity.id) do
48 |> type_from_activity()
51 |> changeset(%{type: type})
56 @spec unread_notifications_count(User.t()) :: integer()
57 def unread_notifications_count(%User{id: user_id}) do
59 where: q.user_id == ^user_id and q.seen == false
61 |> Repo.aggregate(:count, :id)
64 @notification_types ~w{
71 pleroma:emoji_reaction
75 def changeset(%Notification{} = notification, attrs) do
77 |> cast(attrs, [:seen, :type])
78 |> validate_inclusion(:type, @notification_types)
81 @spec last_read_query(User.t()) :: Ecto.Queryable.t()
82 def last_read_query(user) do
83 from(q in Pleroma.Notification,
84 where: q.user_id == ^user.id,
85 where: q.seen == true,
86 select: type(q.id, :string),
92 defp for_user_query_ap_id_opts(user, opts) do
95 if opts[@include_muted_option], do: [], else: [:notification_mute]
97 preloaded_ap_ids = User.outgoing_relationships_ap_ids(user, ap_id_relationships)
99 exclude_blocked_opts = Map.merge(%{blocked_users_ap_ids: preloaded_ap_ids[:block]}, opts)
101 exclude_notification_muted_opts =
102 Map.merge(%{notification_muted_users_ap_ids: preloaded_ap_ids[:notification_mute]}, opts)
104 {exclude_blocked_opts, exclude_notification_muted_opts}
107 def for_user_query(user, opts \\ %{}) do
108 {exclude_blocked_opts, exclude_notification_muted_opts} =
109 for_user_query_ap_id_opts(user, opts)
112 |> where(user_id: ^user.id)
116 "? not in (SELECT ap_id FROM users WHERE deactivated = 'true')",
120 |> join(:inner, [n], activity in assoc(n, :activity))
121 |> join(:left, [n, a], object in Object,
124 "(?->>'id') = COALESCE(?->'object'->>'id', ?->>'object')",
130 |> preload([n, a, o], activity: {a, object: o})
131 |> exclude_notification_muted(user, exclude_notification_muted_opts)
132 |> exclude_blocked(user, exclude_blocked_opts)
133 |> exclude_visibility(opts)
136 # Excludes blocked users and non-followed domain-blocked users
137 defp exclude_blocked(query, user, opts) do
138 blocked_ap_ids = opts[:blocked_users_ap_ids] || User.blocked_users_ap_ids(user)
141 |> where([n, a], a.actor not in ^blocked_ap_ids)
142 |> FollowingRelationship.keep_following_or_not_domain_blocked(user)
145 defp exclude_notification_muted(query, _, %{@include_muted_option => true}) do
149 defp exclude_notification_muted(query, user, opts) do
150 notification_muted_ap_ids =
151 opts[:notification_muted_users_ap_ids] || User.notification_muted_users_ap_ids(user)
154 |> where([n, a], a.actor not in ^notification_muted_ap_ids)
155 |> join(:left, [n, a], tm in ThreadMute,
156 on: tm.user_id == ^user.id and tm.context == fragment("?->>'context'", a.data)
158 |> where([n, a, o, tm], is_nil(tm.user_id))
161 @valid_visibilities ~w[direct unlisted public private]
163 defp exclude_visibility(query, %{exclude_visibilities: visibility})
164 when is_list(visibility) do
165 if Enum.all?(visibility, &(&1 in @valid_visibilities)) do
167 |> join(:left, [n, a], mutated_activity in Pleroma.Activity,
169 fragment("?->>'context'", a.data) ==
170 fragment("?->>'context'", mutated_activity.data) and
171 fragment("(?->>'type' = 'Like' or ?->>'type' = 'Announce')", a.data, a.data) and
172 fragment("?->>'type'", mutated_activity.data) == "Create",
173 as: :mutated_activity
176 [n, a, mutated_activity: mutated_activity],
179 CASE WHEN (?->>'type') = 'Like' or (?->>'type') = 'Announce'
180 THEN (activity_visibility(?, ?, ?) = ANY (?))
181 ELSE (activity_visibility(?, ?, ?) = ANY (?)) END
185 mutated_activity.actor,
186 mutated_activity.recipients,
187 mutated_activity.data,
196 Logger.error("Could not exclude visibility to #{visibility}")
201 defp exclude_visibility(query, %{exclude_visibilities: visibility})
202 when visibility in @valid_visibilities do
203 exclude_visibility(query, [visibility])
206 defp exclude_visibility(query, %{exclude_visibilities: visibility})
207 when visibility not in @valid_visibilities do
208 Logger.error("Could not exclude visibility to #{visibility}")
212 defp exclude_visibility(query, _visibility), do: query
214 def for_user(user, opts \\ %{}) do
216 |> for_user_query(opts)
217 |> Pagination.fetch_paginated(opts)
221 Returns notifications for user received since given date.
225 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-13 11:22:33])
226 [%Pleroma.Notification{}, %Pleroma.Notification{}]
228 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-15 11:22:33])
231 @spec for_user_since(Pleroma.User.t(), NaiveDateTime.t()) :: [t()]
232 def for_user_since(user, date) do
233 from(n in for_user_query(user),
234 where: n.updated_at > ^date
239 def set_read_up_to(%{id: user_id} = user, id) do
243 where: n.user_id == ^user_id,
245 where: n.seen == false,
246 # Ideally we would preload object and activities here
247 # but Ecto does not support preloads in update_all
251 {:ok, %{ids: {_, notification_ids}}} =
253 |> Multi.update_all(:ids, query, set: [seen: true, updated_at: NaiveDateTime.utc_now()])
254 |> Marker.multi_set_last_read_id(user, "notifications")
255 |> Repo.transaction()
258 |> where([n], n.id in ^notification_ids)
262 @spec read_one(User.t(), String.t()) ::
263 {:ok, Notification.t()} | {:error, Ecto.Changeset.t()} | nil
264 def read_one(%User{} = user, notification_id) do
265 with {:ok, %Notification{} = notification} <- get(user, notification_id) do
267 |> Multi.update(:update, changeset(notification, %{seen: true}))
268 |> Marker.multi_set_last_read_id(user, "notifications")
269 |> Repo.transaction()
271 {:ok, %{update: notification}} -> {:ok, notification}
272 {:error, :update, changeset, _} -> {:error, changeset}
277 def get(%{id: user_id} = _user, id) do
282 join: activity in assoc(n, :activity),
283 preload: [activity: activity]
286 notification = Repo.one(query)
289 %{user_id: ^user_id} ->
293 {:error, "Cannot get notification"}
298 from(n in Notification, where: n.user_id == ^user.id)
302 def destroy_multiple(%{id: user_id} = _user, ids) do
303 from(n in Notification,
305 where: n.user_id == ^user_id
310 def dismiss(%Pleroma.Activity{} = activity) do
312 |> where([n], n.activity_id == ^activity.id)
315 {_, notifications} -> {:ok, notifications}
316 _ -> {:error, "Cannot dismiss notification"}
320 def dismiss(%{id: user_id} = _user, id) do
321 notification = Repo.get(Notification, id)
324 %{user_id: ^user_id} ->
325 Repo.delete(notification)
328 {:error, "Cannot dismiss notification"}
332 def create_notifications(activity, options \\ [])
334 def create_notifications(%Activity{data: %{"to" => _, "type" => "Create"}} = activity, options) do
335 object = Object.normalize(activity, false)
337 if object && object.data["type"] == "Answer" do
340 do_create_notifications(activity, options)
344 def create_notifications(%Activity{data: %{"type" => type}} = activity, options)
345 when type in ["Follow", "Like", "Announce", "Move", "EmojiReact"] do
346 do_create_notifications(activity, options)
349 def create_notifications(_, _), do: {:ok, []}
351 defp do_create_notifications(%Activity{} = activity, options) do
352 do_send = Keyword.get(options, :do_send, true)
354 {enabled_receivers, disabled_receivers} = get_notified_from_activity(activity)
355 potential_receivers = enabled_receivers ++ disabled_receivers
358 Enum.map(potential_receivers, fn user ->
359 do_send = do_send && user in enabled_receivers
360 create_notification(activity, user, do_send)
366 defp type_from_activity(%{data: %{"type" => type}} = activity) do
369 if Activity.follow_accepted?(activity) do
385 "pleroma:emoji_reaction"
387 # Compatibility with old reactions
389 "pleroma:emoji_reaction"
393 |> type_from_activity_object()
396 raise "No notification type for activity type #{t}"
400 defp type_from_activity_object(%{data: %{"type" => "Create", "object" => %{}}}), do: "mention"
402 defp type_from_activity_object(%{data: %{"type" => "Create"}} = activity) do
403 object = Object.get_by_ap_id(activity.data["object"])
405 case object && object.data["type"] do
406 "ChatMessage" -> "pleroma:chat_mention"
411 # TODO move to sql, too.
412 def create_notification(%Activity{} = activity, %User{} = user, do_send \\ true) do
413 unless skip?(activity, user) do
414 {:ok, %{notification: notification}} =
416 |> Multi.insert(:notification, %Notification{
419 type: type_from_activity(activity)
421 |> Marker.multi_set_last_read_id(user, "notifications")
422 |> Repo.transaction()
425 Streamer.stream(["user", "user:notification"], notification)
426 Push.send(notification)
434 Returns a tuple with 2 elements:
435 {notification-enabled receivers, currently disabled receivers (blocking / [thread] muting)}
437 NOTE: might be called for FAKE Activities, see ActivityPub.Utils.get_notified_from_object/1
439 @spec get_notified_from_activity(Activity.t(), boolean()) :: {list(User.t()), list(User.t())}
440 def get_notified_from_activity(activity, local_only \\ true)
442 def get_notified_from_activity(%Activity{data: %{"type" => type}} = activity, local_only)
443 when type in ["Create", "Like", "Announce", "Follow", "Move", "EmojiReact"] do
444 potential_receiver_ap_ids = get_potential_receiver_ap_ids(activity)
446 potential_receivers =
447 User.get_users_from_set(potential_receiver_ap_ids, local_only: local_only)
449 notification_enabled_ap_ids =
450 potential_receiver_ap_ids
451 |> exclude_domain_blocker_ap_ids(activity, potential_receivers)
452 |> exclude_relationship_restricted_ap_ids(activity)
453 |> exclude_thread_muter_ap_ids(activity)
455 notification_enabled_users =
456 Enum.filter(potential_receivers, fn u -> u.ap_id in notification_enabled_ap_ids end)
458 {notification_enabled_users, potential_receivers -- notification_enabled_users}
461 def get_notified_from_activity(_, _local_only), do: {[], []}
463 # For some activities, only notify the author of the object
464 def get_potential_receiver_ap_ids(%{data: %{"type" => type, "object" => object_id}})
465 when type in ~w{Like Announce EmojiReact} do
466 case Object.get_cached_by_ap_id(object_id) do
467 %Object{data: %{"actor" => actor}} ->
475 def get_potential_receiver_ap_ids(activity) do
477 |> Utils.maybe_notify_to_recipients(activity)
478 |> Utils.maybe_notify_mentioned_recipients(activity)
479 |> Utils.maybe_notify_subscribers(activity)
480 |> Utils.maybe_notify_followers(activity)
484 @doc "Filters out AP IDs domain-blocking and not following the activity's actor"
485 def exclude_domain_blocker_ap_ids(ap_ids, activity, preloaded_users \\ [])
487 def exclude_domain_blocker_ap_ids([], _activity, _preloaded_users), do: []
489 def exclude_domain_blocker_ap_ids(ap_ids, %Activity{} = activity, preloaded_users) do
490 activity_actor_domain = activity.actor && URI.parse(activity.actor).host
494 |> Enum.map(fn ap_id ->
495 Enum.find(preloaded_users, &(&1.ap_id == ap_id)) ||
496 User.get_cached_by_ap_id(ap_id)
500 domain_blocker_ap_ids = for u <- users, activity_actor_domain in u.domain_blocks, do: u.ap_id
502 domain_blocker_follower_ap_ids =
503 if Enum.any?(domain_blocker_ap_ids) do
505 |> Activity.user_actor()
506 |> FollowingRelationship.followers_ap_ids(domain_blocker_ap_ids)
512 |> Kernel.--(domain_blocker_ap_ids)
513 |> Kernel.++(domain_blocker_follower_ap_ids)
516 @doc "Filters out AP IDs of users basing on their relationships with activity actor user"
517 def exclude_relationship_restricted_ap_ids([], _activity), do: []
519 def exclude_relationship_restricted_ap_ids(ap_ids, %Activity{} = activity) do
520 relationship_restricted_ap_ids =
522 |> Activity.user_actor()
523 |> User.incoming_relationships_ungrouped_ap_ids([
528 Enum.uniq(ap_ids) -- relationship_restricted_ap_ids
531 @doc "Filters out AP IDs of users who mute activity thread"
532 def exclude_thread_muter_ap_ids([], _activity), do: []
534 def exclude_thread_muter_ap_ids(ap_ids, %Activity{} = activity) do
535 thread_muter_ap_ids = ThreadMute.muter_ap_ids(activity.data["context"])
537 Enum.uniq(ap_ids) -- thread_muter_ap_ids
540 @spec skip?(Activity.t(), User.t()) :: boolean()
541 def skip?(%Activity{} = activity, %User{} = user) do
550 |> Enum.find(&skip?(&1, activity, user))
553 def skip?(_, _), do: false
555 @spec skip?(atom(), Activity.t(), User.t()) :: boolean()
556 def skip?(:self, %Activity{} = activity, %User{} = user) do
557 activity.data["actor"] == user.ap_id
562 %Activity{} = activity,
563 %User{notification_settings: %{followers: false}} = user
565 actor = activity.data["actor"]
566 follower = User.get_cached_by_ap_id(actor)
567 User.following?(follower, user)
572 %Activity{} = activity,
573 %User{notification_settings: %{non_followers: false}} = user
575 actor = activity.data["actor"]
576 follower = User.get_cached_by_ap_id(actor)
577 !User.following?(follower, user)
582 %Activity{} = activity,
583 %User{notification_settings: %{follows: false}} = user
585 actor = activity.data["actor"]
586 followed = User.get_cached_by_ap_id(actor)
587 User.following?(user, followed)
592 %Activity{} = activity,
593 %User{notification_settings: %{non_follows: false}} = user
595 actor = activity.data["actor"]
596 followed = User.get_cached_by_ap_id(actor)
597 !User.following?(user, followed)
600 # To do: consider defining recency in hours and checking FollowingRelationship with a single SQL
601 def skip?(:recently_followed, %Activity{data: %{"type" => "Follow"}} = activity, %User{} = user) do
602 actor = activity.data["actor"]
604 Notification.for_user(user)
606 %{activity: %{data: %{"type" => "Follow", "actor" => ^actor}}} -> true
611 def skip?(_, _, _), do: false
613 def for_user_and_activity(user, activity) do
614 from(n in __MODULE__,
615 where: n.user_id == ^user.id,
616 where: n.activity_id == ^activity.id