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 # remembert 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 def changeset(%Notification{} = notification, attrs) do
66 |> cast(attrs, [:seen, :type])
69 @spec last_read_query(User.t()) :: Ecto.Queryable.t()
70 def last_read_query(user) do
71 from(q in Pleroma.Notification,
72 where: q.user_id == ^user.id,
73 where: q.seen == true,
74 select: type(q.id, :string),
80 defp for_user_query_ap_id_opts(user, opts) do
83 if opts[@include_muted_option], do: [], else: [:notification_mute]
85 preloaded_ap_ids = User.outgoing_relationships_ap_ids(user, ap_id_relationships)
87 exclude_blocked_opts = Map.merge(%{blocked_users_ap_ids: preloaded_ap_ids[:block]}, opts)
89 exclude_notification_muted_opts =
90 Map.merge(%{notification_muted_users_ap_ids: preloaded_ap_ids[:notification_mute]}, opts)
92 {exclude_blocked_opts, exclude_notification_muted_opts}
95 def for_user_query(user, opts \\ %{}) do
96 {exclude_blocked_opts, exclude_notification_muted_opts} =
97 for_user_query_ap_id_opts(user, opts)
100 |> where(user_id: ^user.id)
104 "? not in (SELECT ap_id FROM users WHERE deactivated = 'true')",
108 |> join(:inner, [n], activity in assoc(n, :activity))
109 |> join(:left, [n, a], object in Object,
112 "(?->>'id') = COALESCE(?->'object'->>'id', ?->>'object')",
118 |> preload([n, a, o], activity: {a, object: o})
119 |> exclude_notification_muted(user, exclude_notification_muted_opts)
120 |> exclude_blocked(user, exclude_blocked_opts)
121 |> exclude_visibility(opts)
124 # Excludes blocked users and non-followed domain-blocked users
125 defp exclude_blocked(query, user, opts) do
126 blocked_ap_ids = opts[:blocked_users_ap_ids] || User.blocked_users_ap_ids(user)
129 |> where([n, a], a.actor not in ^blocked_ap_ids)
130 |> FollowingRelationship.keep_following_or_not_domain_blocked(user)
133 defp exclude_notification_muted(query, _, %{@include_muted_option => true}) do
137 defp exclude_notification_muted(query, user, opts) do
138 notification_muted_ap_ids =
139 opts[:notification_muted_users_ap_ids] || User.notification_muted_users_ap_ids(user)
142 |> where([n, a], a.actor not in ^notification_muted_ap_ids)
143 |> join(:left, [n, a], tm in ThreadMute,
144 on: tm.user_id == ^user.id and tm.context == fragment("?->>'context'", a.data)
146 |> where([n, a, o, tm], is_nil(tm.user_id))
149 @valid_visibilities ~w[direct unlisted public private]
151 defp exclude_visibility(query, %{exclude_visibilities: visibility})
152 when is_list(visibility) do
153 if Enum.all?(visibility, &(&1 in @valid_visibilities)) do
155 |> join(:left, [n, a], mutated_activity in Pleroma.Activity,
157 fragment("?->>'context'", a.data) ==
158 fragment("?->>'context'", mutated_activity.data) and
159 fragment("(?->>'type' = 'Like' or ?->>'type' = 'Announce')", a.data, a.data) and
160 fragment("?->>'type'", mutated_activity.data) == "Create",
161 as: :mutated_activity
164 [n, a, mutated_activity: mutated_activity],
167 CASE WHEN (?->>'type') = 'Like' or (?->>'type') = 'Announce'
168 THEN (activity_visibility(?, ?, ?) = ANY (?))
169 ELSE (activity_visibility(?, ?, ?) = ANY (?)) END
173 mutated_activity.actor,
174 mutated_activity.recipients,
175 mutated_activity.data,
184 Logger.error("Could not exclude visibility to #{visibility}")
189 defp exclude_visibility(query, %{exclude_visibilities: visibility})
190 when visibility in @valid_visibilities do
191 exclude_visibility(query, [visibility])
194 defp exclude_visibility(query, %{exclude_visibilities: visibility})
195 when visibility not in @valid_visibilities do
196 Logger.error("Could not exclude visibility to #{visibility}")
200 defp exclude_visibility(query, _visibility), do: query
202 def for_user(user, opts \\ %{}) do
204 |> for_user_query(opts)
205 |> Pagination.fetch_paginated(opts)
209 Returns notifications for user received since given date.
213 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-13 11:22:33])
214 [%Pleroma.Notification{}, %Pleroma.Notification{}]
216 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-15 11:22:33])
219 @spec for_user_since(Pleroma.User.t(), NaiveDateTime.t()) :: [t()]
220 def for_user_since(user, date) do
221 from(n in for_user_query(user),
222 where: n.updated_at > ^date
227 def set_read_up_to(%{id: user_id} = user, id) do
231 where: n.user_id == ^user_id,
233 where: n.seen == false,
234 # Ideally we would preload object and activities here
235 # but Ecto does not support preloads in update_all
239 {:ok, %{ids: {_, notification_ids}}} =
241 |> Multi.update_all(:ids, query, set: [seen: true, updated_at: NaiveDateTime.utc_now()])
242 |> Marker.multi_set_last_read_id(user, "notifications")
243 |> Repo.transaction()
246 |> where([n], n.id in ^notification_ids)
250 @spec read_one(User.t(), String.t()) ::
251 {:ok, Notification.t()} | {:error, Ecto.Changeset.t()} | nil
252 def read_one(%User{} = user, notification_id) do
253 with {:ok, %Notification{} = notification} <- get(user, notification_id) do
255 |> Multi.update(:update, changeset(notification, %{seen: true}))
256 |> Marker.multi_set_last_read_id(user, "notifications")
257 |> Repo.transaction()
259 {:ok, %{update: notification}} -> {:ok, notification}
260 {:error, :update, changeset, _} -> {:error, changeset}
265 def get(%{id: user_id} = _user, id) do
270 join: activity in assoc(n, :activity),
271 preload: [activity: activity]
274 notification = Repo.one(query)
277 %{user_id: ^user_id} ->
281 {:error, "Cannot get notification"}
286 from(n in Notification, where: n.user_id == ^user.id)
290 def destroy_multiple(%{id: user_id} = _user, ids) do
291 from(n in Notification,
293 where: n.user_id == ^user_id
298 def dismiss(%Pleroma.Activity{} = activity) do
300 |> where([n], n.activity_id == ^activity.id)
303 {_, notifications} -> {:ok, notifications}
304 _ -> {:error, "Cannot dismiss notification"}
308 def dismiss(%{id: user_id} = _user, id) do
309 notification = Repo.get(Notification, id)
312 %{user_id: ^user_id} ->
313 Repo.delete(notification)
316 {:error, "Cannot dismiss notification"}
320 def create_notifications(activity, options \\ [])
322 def create_notifications(%Activity{data: %{"to" => _, "type" => "Create"}} = activity, options) do
323 object = Object.normalize(activity, false)
325 if object && object.data["type"] == "Answer" do
328 do_create_notifications(activity, options)
332 def create_notifications(%Activity{data: %{"type" => type}} = activity, options)
333 when type in ["Follow", "Like", "Announce", "Move", "EmojiReact"] do
334 do_create_notifications(activity, options)
337 def create_notifications(_, _), do: {:ok, []}
339 defp do_create_notifications(%Activity{} = activity, options) do
340 do_send = Keyword.get(options, :do_send, true)
342 {enabled_receivers, disabled_receivers} = get_notified_from_activity(activity)
343 potential_receivers = enabled_receivers ++ disabled_receivers
346 Enum.map(potential_receivers, fn user ->
347 do_send = do_send && user in enabled_receivers
348 create_notification(activity, user, do_send)
354 defp type_from_activity(%{data: %{"type" => type}} = activity) do
357 if Activity.follow_accepted?(activity) do
373 "pleroma:emoji_reaction"
375 # Compatibility with old reactions
377 "pleroma:emoji_reaction"
381 |> type_from_activity_object()
384 raise "No notification type for activity type #{t}"
388 defp type_from_activity_object(%{data: %{"type" => "Create", "object" => %{}}}), do: "mention"
390 defp type_from_activity_object(%{data: %{"type" => "Create"}} = activity) do
391 object = Object.get_by_ap_id(activity.data["object"])
393 case object && object.data["type"] do
394 "ChatMessage" -> "pleroma:chat_mention"
399 # TODO move to sql, too.
400 def create_notification(%Activity{} = activity, %User{} = user, do_send \\ true) do
401 unless skip?(activity, user) do
402 {:ok, %{notification: notification}} =
404 |> Multi.insert(:notification, %Notification{
407 type: type_from_activity(activity)
409 |> Marker.multi_set_last_read_id(user, "notifications")
410 |> Repo.transaction()
413 Streamer.stream(["user", "user:notification"], notification)
414 Push.send(notification)
422 Returns a tuple with 2 elements:
423 {notification-enabled receivers, currently disabled receivers (blocking / [thread] muting)}
425 NOTE: might be called for FAKE Activities, see ActivityPub.Utils.get_notified_from_object/1
427 @spec get_notified_from_activity(Activity.t(), boolean()) :: {list(User.t()), list(User.t())}
428 def get_notified_from_activity(activity, local_only \\ true)
430 def get_notified_from_activity(%Activity{data: %{"type" => type}} = activity, local_only)
431 when type in ["Create", "Like", "Announce", "Follow", "Move", "EmojiReact"] do
432 potential_receiver_ap_ids = get_potential_receiver_ap_ids(activity)
434 potential_receivers =
435 User.get_users_from_set(potential_receiver_ap_ids, local_only: local_only)
437 notification_enabled_ap_ids =
438 potential_receiver_ap_ids
439 |> exclude_domain_blocker_ap_ids(activity, potential_receivers)
440 |> exclude_relationship_restricted_ap_ids(activity)
441 |> exclude_thread_muter_ap_ids(activity)
443 notification_enabled_users =
444 Enum.filter(potential_receivers, fn u -> u.ap_id in notification_enabled_ap_ids end)
446 {notification_enabled_users, potential_receivers -- notification_enabled_users}
449 def get_notified_from_activity(_, _local_only), do: {[], []}
451 # For some activities, only notify the author of the object
452 def get_potential_receiver_ap_ids(%{data: %{"type" => type, "object" => object_id}})
453 when type in ~w{Like Announce EmojiReact} do
454 case Object.get_cached_by_ap_id(object_id) do
455 %Object{data: %{"actor" => actor}} ->
463 def get_potential_receiver_ap_ids(activity) do
465 |> Utils.maybe_notify_to_recipients(activity)
466 |> Utils.maybe_notify_mentioned_recipients(activity)
467 |> Utils.maybe_notify_subscribers(activity)
468 |> Utils.maybe_notify_followers(activity)
472 @doc "Filters out AP IDs domain-blocking and not following the activity's actor"
473 def exclude_domain_blocker_ap_ids(ap_ids, activity, preloaded_users \\ [])
475 def exclude_domain_blocker_ap_ids([], _activity, _preloaded_users), do: []
477 def exclude_domain_blocker_ap_ids(ap_ids, %Activity{} = activity, preloaded_users) do
478 activity_actor_domain = activity.actor && URI.parse(activity.actor).host
482 |> Enum.map(fn ap_id ->
483 Enum.find(preloaded_users, &(&1.ap_id == ap_id)) ||
484 User.get_cached_by_ap_id(ap_id)
488 domain_blocker_ap_ids = for u <- users, activity_actor_domain in u.domain_blocks, do: u.ap_id
490 domain_blocker_follower_ap_ids =
491 if Enum.any?(domain_blocker_ap_ids) do
493 |> Activity.user_actor()
494 |> FollowingRelationship.followers_ap_ids(domain_blocker_ap_ids)
500 |> Kernel.--(domain_blocker_ap_ids)
501 |> Kernel.++(domain_blocker_follower_ap_ids)
504 @doc "Filters out AP IDs of users basing on their relationships with activity actor user"
505 def exclude_relationship_restricted_ap_ids([], _activity), do: []
507 def exclude_relationship_restricted_ap_ids(ap_ids, %Activity{} = activity) do
508 relationship_restricted_ap_ids =
510 |> Activity.user_actor()
511 |> User.incoming_relationships_ungrouped_ap_ids([
516 Enum.uniq(ap_ids) -- relationship_restricted_ap_ids
519 @doc "Filters out AP IDs of users who mute activity thread"
520 def exclude_thread_muter_ap_ids([], _activity), do: []
522 def exclude_thread_muter_ap_ids(ap_ids, %Activity{} = activity) do
523 thread_muter_ap_ids = ThreadMute.muter_ap_ids(activity.data["context"])
525 Enum.uniq(ap_ids) -- thread_muter_ap_ids
528 @spec skip?(Activity.t(), User.t()) :: boolean()
529 def skip?(%Activity{} = activity, %User{} = user) do
538 |> Enum.find(&skip?(&1, activity, user))
541 def skip?(_, _), do: false
543 @spec skip?(atom(), Activity.t(), User.t()) :: boolean()
544 def skip?(:self, %Activity{} = activity, %User{} = user) do
545 activity.data["actor"] == user.ap_id
550 %Activity{} = activity,
551 %User{notification_settings: %{followers: false}} = user
553 actor = activity.data["actor"]
554 follower = User.get_cached_by_ap_id(actor)
555 User.following?(follower, user)
560 %Activity{} = activity,
561 %User{notification_settings: %{non_followers: false}} = user
563 actor = activity.data["actor"]
564 follower = User.get_cached_by_ap_id(actor)
565 !User.following?(follower, user)
570 %Activity{} = activity,
571 %User{notification_settings: %{follows: false}} = user
573 actor = activity.data["actor"]
574 followed = User.get_cached_by_ap_id(actor)
575 User.following?(user, followed)
580 %Activity{} = activity,
581 %User{notification_settings: %{non_follows: false}} = user
583 actor = activity.data["actor"]
584 followed = User.get_cached_by_ap_id(actor)
585 !User.following?(user, followed)
588 # To do: consider defining recency in hours and checking FollowingRelationship with a single SQL
589 def skip?(:recently_followed, %Activity{data: %{"type" => "Follow"}} = activity, %User{} = user) do
590 actor = activity.data["actor"]
592 Notification.for_user(user)
594 %{activity: %{data: %{"type" => "Follow", "actor" => ^actor}}} -> true
599 def skip?(_, _, _), do: false
601 def for_user_and_activity(user, activity) do
602 from(n in __MODULE__,
603 where: n.user_id == ^user.id,
604 where: n.activity_id == ^activity.id