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_filtered(user)
134 |> exclude_visibility(opts)
137 # Excludes blocked users and non-followed domain-blocked users
138 defp exclude_blocked(query, user, opts) do
139 blocked_ap_ids = opts[:blocked_users_ap_ids] || User.blocked_users_ap_ids(user)
142 |> where([n, a], a.actor not in ^blocked_ap_ids)
143 |> FollowingRelationship.keep_following_or_not_domain_blocked(user)
146 defp exclude_notification_muted(query, _, %{@include_muted_option => true}) do
150 defp exclude_notification_muted(query, user, opts) do
151 notification_muted_ap_ids =
152 opts[:notification_muted_users_ap_ids] || User.notification_muted_users_ap_ids(user)
155 |> where([n, a], a.actor not in ^notification_muted_ap_ids)
156 |> join(:left, [n, a], tm in ThreadMute,
157 on: tm.user_id == ^user.id and tm.context == fragment("?->>'context'", a.data)
159 |> where([n, a, o, tm], is_nil(tm.user_id))
162 defp exclude_filtered(query, user) do
163 case Pleroma.Filter.compose_regex(user) do
168 from([_n, a, o] in query,
170 fragment("not(?->>'content' ~* ?)", o.data, ^regex) or
171 fragment("?->>'actor' = ?", o.data, ^user.ap_id)
176 @valid_visibilities ~w[direct unlisted public private]
178 defp exclude_visibility(query, %{exclude_visibilities: visibility})
179 when is_list(visibility) do
180 if Enum.all?(visibility, &(&1 in @valid_visibilities)) do
182 |> join(:left, [n, a], mutated_activity in Pleroma.Activity,
185 "COALESCE((?->'object')->>'id', ?->>'object')",
190 "COALESCE((?->'object')->>'id', ?->>'object')",
191 mutated_activity.data,
192 mutated_activity.data
194 fragment("(?->>'type' = 'Like' or ?->>'type' = 'Announce')", a.data, a.data) and
195 fragment("?->>'type'", mutated_activity.data) == "Create",
196 as: :mutated_activity
199 [n, a, mutated_activity: mutated_activity],
202 CASE WHEN (?->>'type') = 'Like' or (?->>'type') = 'Announce'
203 THEN (activity_visibility(?, ?, ?) = ANY (?))
204 ELSE (activity_visibility(?, ?, ?) = ANY (?)) END
208 mutated_activity.actor,
209 mutated_activity.recipients,
210 mutated_activity.data,
219 Logger.error("Could not exclude visibility to #{visibility}")
224 defp exclude_visibility(query, %{exclude_visibilities: visibility})
225 when visibility in @valid_visibilities do
226 exclude_visibility(query, [visibility])
229 defp exclude_visibility(query, %{exclude_visibilities: visibility})
230 when visibility not in @valid_visibilities do
231 Logger.error("Could not exclude visibility to #{visibility}")
235 defp exclude_visibility(query, _visibility), do: query
237 def for_user(user, opts \\ %{}) do
239 |> for_user_query(opts)
240 |> Pagination.fetch_paginated(opts)
244 Returns notifications for user received since given date.
248 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-13 11:22:33])
249 [%Pleroma.Notification{}, %Pleroma.Notification{}]
251 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-15 11:22:33])
254 @spec for_user_since(Pleroma.User.t(), NaiveDateTime.t()) :: [t()]
255 def for_user_since(user, date) do
256 from(n in for_user_query(user),
257 where: n.updated_at > ^date
262 def set_read_up_to(%{id: user_id} = user, id) do
266 where: n.user_id == ^user_id,
268 where: n.seen == false,
269 # Ideally we would preload object and activities here
270 # but Ecto does not support preloads in update_all
274 {:ok, %{ids: {_, notification_ids}}} =
276 |> Multi.update_all(:ids, query, set: [seen: true, updated_at: NaiveDateTime.utc_now()])
277 |> Marker.multi_set_last_read_id(user, "notifications")
278 |> Repo.transaction()
281 |> where([n], n.id in ^notification_ids)
285 @spec read_one(User.t(), String.t()) ::
286 {:ok, Notification.t()} | {:error, Ecto.Changeset.t()} | nil
287 def read_one(%User{} = user, notification_id) do
288 with {:ok, %Notification{} = notification} <- get(user, notification_id) do
290 |> Multi.update(:update, changeset(notification, %{seen: true}))
291 |> Marker.multi_set_last_read_id(user, "notifications")
292 |> Repo.transaction()
294 {:ok, %{update: notification}} -> {:ok, notification}
295 {:error, :update, changeset, _} -> {:error, changeset}
300 def get(%{id: user_id} = _user, id) do
305 join: activity in assoc(n, :activity),
306 preload: [activity: activity]
309 notification = Repo.one(query)
312 %{user_id: ^user_id} ->
316 {:error, "Cannot get notification"}
321 from(n in Notification, where: n.user_id == ^user.id)
325 def destroy_multiple(%{id: user_id} = _user, ids) do
326 from(n in Notification,
328 where: n.user_id == ^user_id
333 def dismiss(%Pleroma.Activity{} = activity) do
335 |> where([n], n.activity_id == ^activity.id)
338 {_, notifications} -> {:ok, notifications}
339 _ -> {:error, "Cannot dismiss notification"}
343 def dismiss(%{id: user_id} = _user, id) do
344 notification = Repo.get(Notification, id)
347 %{user_id: ^user_id} ->
348 Repo.delete(notification)
351 {:error, "Cannot dismiss notification"}
355 def create_notifications(activity, options \\ [])
357 def create_notifications(%Activity{data: %{"to" => _, "type" => "Create"}} = activity, options) do
358 object = Object.normalize(activity, false)
360 if object && object.data["type"] == "Answer" do
363 do_create_notifications(activity, options)
367 def create_notifications(%Activity{data: %{"type" => type}} = activity, options)
368 when type in ["Follow", "Like", "Announce", "Move", "EmojiReact"] do
369 do_create_notifications(activity, options)
372 def create_notifications(_, _), do: {:ok, []}
374 defp do_create_notifications(%Activity{} = activity, options) do
375 do_send = Keyword.get(options, :do_send, true)
377 {enabled_receivers, disabled_receivers} = get_notified_from_activity(activity)
378 potential_receivers = enabled_receivers ++ disabled_receivers
381 Enum.map(potential_receivers, fn user ->
382 do_send = do_send && user in enabled_receivers
383 create_notification(activity, user, do_send)
385 |> Enum.reject(&is_nil/1)
390 defp type_from_activity(%{data: %{"type" => type}} = activity) do
393 if Activity.follow_accepted?(activity) do
409 "pleroma:emoji_reaction"
411 # Compatibility with old reactions
413 "pleroma:emoji_reaction"
417 |> type_from_activity_object()
420 raise "No notification type for activity type #{t}"
424 defp type_from_activity_object(%{data: %{"type" => "Create", "object" => %{}}}), do: "mention"
426 defp type_from_activity_object(%{data: %{"type" => "Create"}} = activity) do
427 object = Object.get_by_ap_id(activity.data["object"])
429 case object && object.data["type"] do
430 "ChatMessage" -> "pleroma:chat_mention"
435 # TODO move to sql, too.
436 def create_notification(%Activity{} = activity, %User{} = user, do_send \\ true) do
437 unless skip?(activity, user) do
438 {:ok, %{notification: notification}} =
440 |> Multi.insert(:notification, %Notification{
443 type: type_from_activity(activity)
445 |> Marker.multi_set_last_read_id(user, "notifications")
446 |> Repo.transaction()
449 Streamer.stream(["user", "user:notification"], notification)
450 Push.send(notification)
458 Returns a tuple with 2 elements:
459 {notification-enabled receivers, currently disabled receivers (blocking / [thread] muting)}
461 NOTE: might be called for FAKE Activities, see ActivityPub.Utils.get_notified_from_object/1
463 @spec get_notified_from_activity(Activity.t(), boolean()) :: {list(User.t()), list(User.t())}
464 def get_notified_from_activity(activity, local_only \\ true)
466 def get_notified_from_activity(%Activity{data: %{"type" => type}} = activity, local_only)
467 when type in ["Create", "Like", "Announce", "Follow", "Move", "EmojiReact"] do
468 potential_receiver_ap_ids = get_potential_receiver_ap_ids(activity)
470 potential_receivers =
471 User.get_users_from_set(potential_receiver_ap_ids, local_only: local_only)
473 notification_enabled_ap_ids =
474 potential_receiver_ap_ids
475 |> exclude_domain_blocker_ap_ids(activity, potential_receivers)
476 |> exclude_relationship_restricted_ap_ids(activity)
477 |> exclude_thread_muter_ap_ids(activity)
479 notification_enabled_users =
480 Enum.filter(potential_receivers, fn u -> u.ap_id in notification_enabled_ap_ids end)
482 {notification_enabled_users, potential_receivers -- notification_enabled_users}
485 def get_notified_from_activity(_, _local_only), do: {[], []}
487 # For some activities, only notify the author of the object
488 def get_potential_receiver_ap_ids(%{data: %{"type" => type, "object" => object_id}})
489 when type in ~w{Like Announce EmojiReact} do
490 case Object.get_cached_by_ap_id(object_id) do
491 %Object{data: %{"actor" => actor}} ->
499 def get_potential_receiver_ap_ids(activity) do
501 |> Utils.maybe_notify_to_recipients(activity)
502 |> Utils.maybe_notify_mentioned_recipients(activity)
503 |> Utils.maybe_notify_subscribers(activity)
504 |> Utils.maybe_notify_followers(activity)
508 @doc "Filters out AP IDs domain-blocking and not following the activity's actor"
509 def exclude_domain_blocker_ap_ids(ap_ids, activity, preloaded_users \\ [])
511 def exclude_domain_blocker_ap_ids([], _activity, _preloaded_users), do: []
513 def exclude_domain_blocker_ap_ids(ap_ids, %Activity{} = activity, preloaded_users) do
514 activity_actor_domain = activity.actor && URI.parse(activity.actor).host
518 |> Enum.map(fn ap_id ->
519 Enum.find(preloaded_users, &(&1.ap_id == ap_id)) ||
520 User.get_cached_by_ap_id(ap_id)
524 domain_blocker_ap_ids = for u <- users, activity_actor_domain in u.domain_blocks, do: u.ap_id
526 domain_blocker_follower_ap_ids =
527 if Enum.any?(domain_blocker_ap_ids) do
529 |> Activity.user_actor()
530 |> FollowingRelationship.followers_ap_ids(domain_blocker_ap_ids)
536 |> Kernel.--(domain_blocker_ap_ids)
537 |> Kernel.++(domain_blocker_follower_ap_ids)
540 @doc "Filters out AP IDs of users basing on their relationships with activity actor user"
541 def exclude_relationship_restricted_ap_ids([], _activity), do: []
543 def exclude_relationship_restricted_ap_ids(ap_ids, %Activity{} = activity) do
544 relationship_restricted_ap_ids =
546 |> Activity.user_actor()
547 |> User.incoming_relationships_ungrouped_ap_ids([
552 Enum.uniq(ap_ids) -- relationship_restricted_ap_ids
555 @doc "Filters out AP IDs of users who mute activity thread"
556 def exclude_thread_muter_ap_ids([], _activity), do: []
558 def exclude_thread_muter_ap_ids(ap_ids, %Activity{} = activity) do
559 thread_muter_ap_ids = ThreadMute.muter_ap_ids(activity.data["context"])
561 Enum.uniq(ap_ids) -- thread_muter_ap_ids
564 @spec skip?(Activity.t(), User.t()) :: boolean()
565 def skip?(%Activity{} = activity, %User{} = user) do
576 |> Enum.find(&skip?(&1, activity, user))
579 def skip?(_, _), do: false
581 @spec skip?(atom(), Activity.t(), User.t()) :: boolean()
582 def skip?(:self, %Activity{} = activity, %User{} = user) do
583 activity.data["actor"] == user.ap_id
586 def skip?(:invisible, %Activity{} = activity, _) do
587 actor = activity.data["actor"]
588 user = User.get_cached_by_ap_id(actor)
589 User.invisible?(user)
594 %Activity{} = activity,
595 %User{notification_settings: %{followers: false}} = user
597 actor = activity.data["actor"]
598 follower = User.get_cached_by_ap_id(actor)
599 User.following?(follower, user)
604 %Activity{} = activity,
605 %User{notification_settings: %{non_followers: false}} = user
607 actor = activity.data["actor"]
608 follower = User.get_cached_by_ap_id(actor)
609 !User.following?(follower, user)
614 %Activity{} = activity,
615 %User{notification_settings: %{follows: false}} = user
617 actor = activity.data["actor"]
618 followed = User.get_cached_by_ap_id(actor)
619 User.following?(user, followed)
624 %Activity{} = activity,
625 %User{notification_settings: %{non_follows: false}} = user
627 actor = activity.data["actor"]
628 followed = User.get_cached_by_ap_id(actor)
629 !User.following?(user, followed)
632 # To do: consider defining recency in hours and checking FollowingRelationship with a single SQL
633 def skip?(:recently_followed, %Activity{data: %{"type" => "Follow"}} = activity, %User{} = user) do
634 actor = activity.data["actor"]
636 Notification.for_user(user)
638 %{activity: %{data: %{"type" => "Follow", "actor" => ^actor}}} -> true
643 def skip?(:filtered, activity, user) do
644 object = Object.normalize(activity)
650 object.data["actor"] == user.ap_id ->
653 not is_nil(regex = Pleroma.Filter.compose_regex(user, :re)) ->
654 Regex.match?(regex, object.data["content"])
661 def skip?(_, _, _), do: false
663 def for_user_and_activity(user, activity) do
664 from(n in __MODULE__,
665 where: n.user_id == ^user.id,
666 where: n.activity_id == ^activity.id