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,
170 "COALESCE((?->'object')->>'id', ?->>'object')",
175 "COALESCE((?->'object')->>'id', ?->>'object')",
176 mutated_activity.data,
177 mutated_activity.data
179 fragment("(?->>'type' = 'Like' or ?->>'type' = 'Announce')", a.data, a.data) and
180 fragment("?->>'type'", mutated_activity.data) == "Create",
181 as: :mutated_activity
184 [n, a, mutated_activity: mutated_activity],
187 CASE WHEN (?->>'type') = 'Like' or (?->>'type') = 'Announce'
188 THEN (activity_visibility(?, ?, ?) = ANY (?))
189 ELSE (activity_visibility(?, ?, ?) = ANY (?)) END
193 mutated_activity.actor,
194 mutated_activity.recipients,
195 mutated_activity.data,
204 Logger.error("Could not exclude visibility to #{visibility}")
209 defp exclude_visibility(query, %{exclude_visibilities: visibility})
210 when visibility in @valid_visibilities do
211 exclude_visibility(query, [visibility])
214 defp exclude_visibility(query, %{exclude_visibilities: visibility})
215 when visibility not in @valid_visibilities do
216 Logger.error("Could not exclude visibility to #{visibility}")
220 defp exclude_visibility(query, _visibility), do: query
222 def for_user(user, opts \\ %{}) do
224 |> for_user_query(opts)
225 |> Pagination.fetch_paginated(opts)
229 Returns notifications for user received since given date.
233 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-13 11:22:33])
234 [%Pleroma.Notification{}, %Pleroma.Notification{}]
236 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-15 11:22:33])
239 @spec for_user_since(Pleroma.User.t(), NaiveDateTime.t()) :: [t()]
240 def for_user_since(user, date) do
241 from(n in for_user_query(user),
242 where: n.updated_at > ^date
247 def set_read_up_to(%{id: user_id} = user, id) do
251 where: n.user_id == ^user_id,
253 where: n.seen == false,
254 # Ideally we would preload object and activities here
255 # but Ecto does not support preloads in update_all
259 {:ok, %{ids: {_, notification_ids}}} =
261 |> Multi.update_all(:ids, query, set: [seen: true, updated_at: NaiveDateTime.utc_now()])
262 |> Marker.multi_set_last_read_id(user, "notifications")
263 |> Repo.transaction()
266 |> where([n], n.id in ^notification_ids)
270 @spec read_one(User.t(), String.t()) ::
271 {:ok, Notification.t()} | {:error, Ecto.Changeset.t()} | nil
272 def read_one(%User{} = user, notification_id) do
273 with {:ok, %Notification{} = notification} <- get(user, notification_id) do
275 |> Multi.update(:update, changeset(notification, %{seen: true}))
276 |> Marker.multi_set_last_read_id(user, "notifications")
277 |> Repo.transaction()
279 {:ok, %{update: notification}} -> {:ok, notification}
280 {:error, :update, changeset, _} -> {:error, changeset}
285 def get(%{id: user_id} = _user, id) do
290 join: activity in assoc(n, :activity),
291 preload: [activity: activity]
294 notification = Repo.one(query)
297 %{user_id: ^user_id} ->
301 {:error, "Cannot get notification"}
306 from(n in Notification, where: n.user_id == ^user.id)
310 def destroy_multiple(%{id: user_id} = _user, ids) do
311 from(n in Notification,
313 where: n.user_id == ^user_id
318 def dismiss(%Pleroma.Activity{} = activity) do
320 |> where([n], n.activity_id == ^activity.id)
323 {_, notifications} -> {:ok, notifications}
324 _ -> {:error, "Cannot dismiss notification"}
328 def dismiss(%{id: user_id} = _user, id) do
329 notification = Repo.get(Notification, id)
332 %{user_id: ^user_id} ->
333 Repo.delete(notification)
336 {:error, "Cannot dismiss notification"}
340 def create_notifications(activity, options \\ [])
342 def create_notifications(%Activity{data: %{"to" => _, "type" => "Create"}} = activity, options) do
343 object = Object.normalize(activity, false)
345 if object && object.data["type"] == "Answer" do
348 do_create_notifications(activity, options)
352 def create_notifications(%Activity{data: %{"type" => type}} = activity, options)
353 when type in ["Follow", "Like", "Announce", "Move", "EmojiReact"] do
354 do_create_notifications(activity, options)
357 def create_notifications(_, _), do: {:ok, []}
359 defp do_create_notifications(%Activity{} = activity, options) do
360 do_send = Keyword.get(options, :do_send, true)
362 {enabled_receivers, disabled_receivers} = get_notified_from_activity(activity)
363 potential_receivers = enabled_receivers ++ disabled_receivers
366 Enum.map(potential_receivers, fn user ->
367 do_send = do_send && user in enabled_receivers
368 create_notification(activity, user, do_send)
374 defp type_from_activity(%{data: %{"type" => type}} = activity) do
377 if Activity.follow_accepted?(activity) do
393 "pleroma:emoji_reaction"
395 # Compatibility with old reactions
397 "pleroma:emoji_reaction"
401 |> type_from_activity_object()
404 raise "No notification type for activity type #{t}"
408 defp type_from_activity_object(%{data: %{"type" => "Create", "object" => %{}}}), do: "mention"
410 defp type_from_activity_object(%{data: %{"type" => "Create"}} = activity) do
411 object = Object.get_by_ap_id(activity.data["object"])
413 case object && object.data["type"] do
414 "ChatMessage" -> "pleroma:chat_mention"
419 # TODO move to sql, too.
420 def create_notification(%Activity{} = activity, %User{} = user, do_send \\ true) do
421 unless skip?(activity, user) do
422 {:ok, %{notification: notification}} =
424 |> Multi.insert(:notification, %Notification{
427 type: type_from_activity(activity)
429 |> Marker.multi_set_last_read_id(user, "notifications")
430 |> Repo.transaction()
433 Streamer.stream(["user", "user:notification"], notification)
434 Push.send(notification)
442 Returns a tuple with 2 elements:
443 {notification-enabled receivers, currently disabled receivers (blocking / [thread] muting)}
445 NOTE: might be called for FAKE Activities, see ActivityPub.Utils.get_notified_from_object/1
447 @spec get_notified_from_activity(Activity.t(), boolean()) :: {list(User.t()), list(User.t())}
448 def get_notified_from_activity(activity, local_only \\ true)
450 def get_notified_from_activity(%Activity{data: %{"type" => type}} = activity, local_only)
451 when type in ["Create", "Like", "Announce", "Follow", "Move", "EmojiReact"] do
452 potential_receiver_ap_ids = get_potential_receiver_ap_ids(activity)
454 potential_receivers =
455 User.get_users_from_set(potential_receiver_ap_ids, local_only: local_only)
457 notification_enabled_ap_ids =
458 potential_receiver_ap_ids
459 |> exclude_domain_blocker_ap_ids(activity, potential_receivers)
460 |> exclude_relationship_restricted_ap_ids(activity)
461 |> exclude_thread_muter_ap_ids(activity)
463 notification_enabled_users =
464 Enum.filter(potential_receivers, fn u -> u.ap_id in notification_enabled_ap_ids end)
466 {notification_enabled_users, potential_receivers -- notification_enabled_users}
469 def get_notified_from_activity(_, _local_only), do: {[], []}
471 # For some activities, only notify the author of the object
472 def get_potential_receiver_ap_ids(%{data: %{"type" => type, "object" => object_id}})
473 when type in ~w{Like Announce EmojiReact} do
474 case Object.get_cached_by_ap_id(object_id) do
475 %Object{data: %{"actor" => actor}} ->
483 def get_potential_receiver_ap_ids(activity) do
485 |> Utils.maybe_notify_to_recipients(activity)
486 |> Utils.maybe_notify_mentioned_recipients(activity)
487 |> Utils.maybe_notify_subscribers(activity)
488 |> Utils.maybe_notify_followers(activity)
492 @doc "Filters out AP IDs domain-blocking and not following the activity's actor"
493 def exclude_domain_blocker_ap_ids(ap_ids, activity, preloaded_users \\ [])
495 def exclude_domain_blocker_ap_ids([], _activity, _preloaded_users), do: []
497 def exclude_domain_blocker_ap_ids(ap_ids, %Activity{} = activity, preloaded_users) do
498 activity_actor_domain = activity.actor && URI.parse(activity.actor).host
502 |> Enum.map(fn ap_id ->
503 Enum.find(preloaded_users, &(&1.ap_id == ap_id)) ||
504 User.get_cached_by_ap_id(ap_id)
508 domain_blocker_ap_ids = for u <- users, activity_actor_domain in u.domain_blocks, do: u.ap_id
510 domain_blocker_follower_ap_ids =
511 if Enum.any?(domain_blocker_ap_ids) do
513 |> Activity.user_actor()
514 |> FollowingRelationship.followers_ap_ids(domain_blocker_ap_ids)
520 |> Kernel.--(domain_blocker_ap_ids)
521 |> Kernel.++(domain_blocker_follower_ap_ids)
524 @doc "Filters out AP IDs of users basing on their relationships with activity actor user"
525 def exclude_relationship_restricted_ap_ids([], _activity), do: []
527 def exclude_relationship_restricted_ap_ids(ap_ids, %Activity{} = activity) do
528 relationship_restricted_ap_ids =
530 |> Activity.user_actor()
531 |> User.incoming_relationships_ungrouped_ap_ids([
536 Enum.uniq(ap_ids) -- relationship_restricted_ap_ids
539 @doc "Filters out AP IDs of users who mute activity thread"
540 def exclude_thread_muter_ap_ids([], _activity), do: []
542 def exclude_thread_muter_ap_ids(ap_ids, %Activity{} = activity) do
543 thread_muter_ap_ids = ThreadMute.muter_ap_ids(activity.data["context"])
545 Enum.uniq(ap_ids) -- thread_muter_ap_ids
548 @spec skip?(Activity.t(), User.t()) :: boolean()
549 def skip?(%Activity{} = activity, %User{} = user) do
559 |> Enum.find(&skip?(&1, activity, user))
562 def skip?(_, _), do: false
564 @spec skip?(atom(), Activity.t(), User.t()) :: boolean()
565 def skip?(:self, %Activity{} = activity, %User{} = user) do
566 activity.data["actor"] == user.ap_id
569 def skip?(:invisible, %Activity{} = activity, _) do
570 actor = activity.data["actor"]
571 user = User.get_cached_by_ap_id(actor)
572 User.invisible?(user)
577 %Activity{} = activity,
578 %User{notification_settings: %{followers: false}} = user
580 actor = activity.data["actor"]
581 follower = User.get_cached_by_ap_id(actor)
582 User.following?(follower, user)
587 %Activity{} = activity,
588 %User{notification_settings: %{non_followers: false}} = user
590 actor = activity.data["actor"]
591 follower = User.get_cached_by_ap_id(actor)
592 !User.following?(follower, user)
597 %Activity{} = activity,
598 %User{notification_settings: %{follows: false}} = user
600 actor = activity.data["actor"]
601 followed = User.get_cached_by_ap_id(actor)
602 User.following?(user, followed)
607 %Activity{} = activity,
608 %User{notification_settings: %{non_follows: false}} = user
610 actor = activity.data["actor"]
611 followed = User.get_cached_by_ap_id(actor)
612 !User.following?(user, followed)
615 # To do: consider defining recency in hours and checking FollowingRelationship with a single SQL
616 def skip?(:recently_followed, %Activity{data: %{"type" => "Follow"}} = activity, %User{} = user) do
617 actor = activity.data["actor"]
619 Notification.for_user(user)
621 %{activity: %{data: %{"type" => "Follow", "actor" => ^actor}}} -> true
626 def skip?(_, _, _), do: false
628 def for_user_and_activity(user, activity) do
629 from(n in __MODULE__,
630 where: n.user_id == ^user.id,
631 where: n.activity_id == ^activity.id