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 belongs_to(:user, User, type: FlakeId.Ecto.CompatType)
34 belongs_to(:activity, Activity, type: FlakeId.Ecto.CompatType)
39 @spec unread_notifications_count(User.t()) :: integer()
40 def unread_notifications_count(%User{id: user_id}) do
42 where: q.user_id == ^user_id and q.seen == false
44 |> Repo.aggregate(:count, :id)
47 def changeset(%Notification{} = notification, attrs) do
49 |> cast(attrs, [:seen])
52 @spec last_read_query(User.t()) :: Ecto.Queryable.t()
53 def last_read_query(user) do
54 from(q in Pleroma.Notification,
55 where: q.user_id == ^user.id,
56 where: q.seen == true,
57 select: type(q.id, :string),
63 defp for_user_query_ap_id_opts(user, opts) do
66 if opts[@include_muted_option], do: [], else: [:notification_mute]
68 preloaded_ap_ids = User.outgoing_relationships_ap_ids(user, ap_id_relationships)
70 exclude_blocked_opts = Map.merge(%{blocked_users_ap_ids: preloaded_ap_ids[:block]}, opts)
72 exclude_notification_muted_opts =
73 Map.merge(%{notification_muted_users_ap_ids: preloaded_ap_ids[:notification_mute]}, opts)
75 {exclude_blocked_opts, exclude_notification_muted_opts}
78 def for_user_query(user, opts \\ %{}) do
79 {exclude_blocked_opts, exclude_notification_muted_opts} =
80 for_user_query_ap_id_opts(user, opts)
83 |> where(user_id: ^user.id)
87 "? not in (SELECT ap_id FROM users WHERE deactivated = 'true')",
91 |> join(:inner, [n], activity in assoc(n, :activity))
92 |> join(:left, [n, a], object in Object,
95 "(?->>'id') = COALESCE(?->'object'->>'id', ?->>'object')",
101 |> preload([n, a, o], activity: {a, object: o})
102 |> exclude_notification_muted(user, exclude_notification_muted_opts)
103 |> exclude_blocked(user, exclude_blocked_opts)
104 |> exclude_visibility(opts)
107 # Excludes blocked users and non-followed domain-blocked users
108 defp exclude_blocked(query, user, opts) do
109 blocked_ap_ids = opts[:blocked_users_ap_ids] || User.blocked_users_ap_ids(user)
112 |> where([n, a], a.actor not in ^blocked_ap_ids)
113 |> FollowingRelationship.keep_following_or_not_domain_blocked(user)
116 defp exclude_notification_muted(query, _, %{@include_muted_option => true}) do
120 defp exclude_notification_muted(query, user, opts) do
121 notification_muted_ap_ids =
122 opts[:notification_muted_users_ap_ids] || User.notification_muted_users_ap_ids(user)
125 |> where([n, a], a.actor not in ^notification_muted_ap_ids)
126 |> join(:left, [n, a], tm in ThreadMute,
127 on: tm.user_id == ^user.id and tm.context == fragment("?->>'context'", a.data)
129 |> where([n, a, o, tm], is_nil(tm.user_id))
132 @valid_visibilities ~w[direct unlisted public private]
134 defp exclude_visibility(query, %{exclude_visibilities: visibility})
135 when is_list(visibility) do
136 if Enum.all?(visibility, &(&1 in @valid_visibilities)) do
138 |> join(:left, [n, a], mutated_activity in Pleroma.Activity,
140 fragment("?->>'context'", a.data) ==
141 fragment("?->>'context'", mutated_activity.data) and
142 fragment("(?->>'type' = 'Like' or ?->>'type' = 'Announce')", a.data, a.data) and
143 fragment("?->>'type'", mutated_activity.data) == "Create",
144 as: :mutated_activity
147 [n, a, mutated_activity: mutated_activity],
150 CASE WHEN (?->>'type') = 'Like' or (?->>'type') = 'Announce'
151 THEN (activity_visibility(?, ?, ?) = ANY (?))
152 ELSE (activity_visibility(?, ?, ?) = ANY (?)) END
156 mutated_activity.actor,
157 mutated_activity.recipients,
158 mutated_activity.data,
167 Logger.error("Could not exclude visibility to #{visibility}")
172 defp exclude_visibility(query, %{exclude_visibilities: visibility})
173 when visibility in @valid_visibilities do
174 exclude_visibility(query, [visibility])
177 defp exclude_visibility(query, %{exclude_visibilities: visibility})
178 when visibility not in @valid_visibilities do
179 Logger.error("Could not exclude visibility to #{visibility}")
183 defp exclude_visibility(query, _visibility), do: query
185 def for_user(user, opts \\ %{}) do
187 |> for_user_query(opts)
188 |> Pagination.fetch_paginated(opts)
192 Returns notifications for user received since given date.
196 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-13 11:22:33])
197 [%Pleroma.Notification{}, %Pleroma.Notification{}]
199 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-15 11:22:33])
202 @spec for_user_since(Pleroma.User.t(), NaiveDateTime.t()) :: [t()]
203 def for_user_since(user, date) do
204 from(n in for_user_query(user),
205 where: n.updated_at > ^date
210 def set_read_up_to(%{id: user_id} = user, id) do
214 where: n.user_id == ^user_id,
216 where: n.seen == false,
217 # Ideally we would preload object and activities here
218 # but Ecto does not support preloads in update_all
222 {:ok, %{ids: {_, notification_ids}}} =
224 |> Multi.update_all(:ids, query, set: [seen: true, updated_at: NaiveDateTime.utc_now()])
225 |> Marker.multi_set_last_read_id(user, "notifications")
226 |> Repo.transaction()
229 |> where([n], n.id in ^notification_ids)
233 @spec read_one(User.t(), String.t()) ::
234 {:ok, Notification.t()} | {:error, Ecto.Changeset.t()} | nil
235 def read_one(%User{} = user, notification_id) do
236 with {:ok, %Notification{} = notification} <- get(user, notification_id) do
238 |> Multi.update(:update, changeset(notification, %{seen: true}))
239 |> Marker.multi_set_last_read_id(user, "notifications")
240 |> Repo.transaction()
242 {:ok, %{update: notification}} -> {:ok, notification}
243 {:error, :update, changeset, _} -> {:error, changeset}
248 def get(%{id: user_id} = _user, id) do
253 join: activity in assoc(n, :activity),
254 preload: [activity: activity]
257 notification = Repo.one(query)
260 %{user_id: ^user_id} ->
264 {:error, "Cannot get notification"}
269 from(n in Notification, where: n.user_id == ^user.id)
273 def destroy_multiple(%{id: user_id} = _user, ids) do
274 from(n in Notification,
276 where: n.user_id == ^user_id
281 def dismiss(%Pleroma.Activity{} = activity) do
283 |> where([n], n.activity_id == ^activity.id)
286 {_, notifications} -> {:ok, notifications}
287 _ -> {:error, "Cannot dismiss notification"}
291 def dismiss(%{id: user_id} = _user, id) do
292 notification = Repo.get(Notification, id)
295 %{user_id: ^user_id} ->
296 Repo.delete(notification)
299 {:error, "Cannot dismiss notification"}
303 def create_notifications(%Activity{data: %{"to" => _, "type" => "Create"}} = activity) do
304 object = Object.normalize(activity)
306 if object && object.data["type"] == "Answer" do
309 do_create_notifications(activity)
313 def create_notifications(%Activity{data: %{"type" => type}} = activity)
314 when type in ["Follow", "Like", "Announce", "Move", "EmojiReact"] do
315 do_create_notifications(activity)
318 def create_notifications(_), do: {:ok, []}
320 defp do_create_notifications(%Activity{} = activity) do
321 {enabled_receivers, disabled_receivers} = get_notified_from_activity(activity)
322 potential_receivers = enabled_receivers ++ disabled_receivers
325 Enum.map(potential_receivers, fn user ->
326 do_send = user in enabled_receivers
327 create_notification(activity, user, do_send)
333 # TODO move to sql, too.
334 def create_notification(%Activity{} = activity, %User{} = user, do_send \\ true) do
335 unless skip?(activity, user) do
336 {:ok, %{notification: notification}} =
338 |> Multi.insert(:notification, %Notification{user_id: user.id, activity: activity})
339 |> Marker.multi_set_last_read_id(user, "notifications")
340 |> Repo.transaction()
343 Streamer.stream(["user", "user:notification"], notification)
344 Push.send(notification)
352 Returns a tuple with 2 elements:
353 {notification-enabled receivers, currently disabled receivers (blocking / [thread] muting)}
355 NOTE: might be called for FAKE Activities, see ActivityPub.Utils.get_notified_from_object/1
357 @spec get_notified_from_activity(Activity.t(), boolean()) :: {list(User.t()), list(User.t())}
358 def get_notified_from_activity(activity, local_only \\ true)
360 def get_notified_from_activity(%Activity{data: %{"type" => type}} = activity, local_only)
361 when type in ["Create", "Like", "Announce", "Follow", "Move", "EmojiReact"] do
362 potential_receiver_ap_ids = get_potential_receiver_ap_ids(activity)
364 potential_receivers =
365 User.get_users_from_set(potential_receiver_ap_ids, local_only: local_only)
367 notification_enabled_ap_ids =
368 potential_receiver_ap_ids
369 |> exclude_domain_blocker_ap_ids(activity, potential_receivers)
370 |> exclude_relationship_restricted_ap_ids(activity)
371 |> exclude_thread_muter_ap_ids(activity)
373 notification_enabled_users =
374 Enum.filter(potential_receivers, fn u -> u.ap_id in notification_enabled_ap_ids end)
376 {notification_enabled_users, potential_receivers -- notification_enabled_users}
379 def get_notified_from_activity(_, _local_only), do: {[], []}
381 # For some activities, only notify the author of the object
382 def get_potential_receiver_ap_ids(%{data: %{"type" => type, "object" => object_id}})
383 when type in ~w{Like Announce EmojiReact} do
384 case Object.get_cached_by_ap_id(object_id) do
385 %Object{data: %{"actor" => actor}} ->
393 def get_potential_receiver_ap_ids(activity) do
395 |> Utils.maybe_notify_to_recipients(activity)
396 |> Utils.maybe_notify_mentioned_recipients(activity)
397 |> Utils.maybe_notify_subscribers(activity)
398 |> Utils.maybe_notify_followers(activity)
402 @doc "Filters out AP IDs domain-blocking and not following the activity's actor"
403 def exclude_domain_blocker_ap_ids(ap_ids, activity, preloaded_users \\ [])
405 def exclude_domain_blocker_ap_ids([], _activity, _preloaded_users), do: []
407 def exclude_domain_blocker_ap_ids(ap_ids, %Activity{} = activity, preloaded_users) do
408 activity_actor_domain = activity.actor && URI.parse(activity.actor).host
412 |> Enum.map(fn ap_id ->
413 Enum.find(preloaded_users, &(&1.ap_id == ap_id)) ||
414 User.get_cached_by_ap_id(ap_id)
418 domain_blocker_ap_ids = for u <- users, activity_actor_domain in u.domain_blocks, do: u.ap_id
420 domain_blocker_follower_ap_ids =
421 if Enum.any?(domain_blocker_ap_ids) do
423 |> Activity.user_actor()
424 |> FollowingRelationship.followers_ap_ids(domain_blocker_ap_ids)
430 |> Kernel.--(domain_blocker_ap_ids)
431 |> Kernel.++(domain_blocker_follower_ap_ids)
434 @doc "Filters out AP IDs of users basing on their relationships with activity actor user"
435 def exclude_relationship_restricted_ap_ids([], _activity), do: []
437 def exclude_relationship_restricted_ap_ids(ap_ids, %Activity{} = activity) do
438 relationship_restricted_ap_ids =
440 |> Activity.user_actor()
441 |> User.incoming_relationships_ungrouped_ap_ids([
446 Enum.uniq(ap_ids) -- relationship_restricted_ap_ids
449 @doc "Filters out AP IDs of users who mute activity thread"
450 def exclude_thread_muter_ap_ids([], _activity), do: []
452 def exclude_thread_muter_ap_ids(ap_ids, %Activity{} = activity) do
453 thread_muter_ap_ids = ThreadMute.muter_ap_ids(activity.data["context"])
455 Enum.uniq(ap_ids) -- thread_muter_ap_ids
458 @spec skip?(Activity.t(), User.t()) :: boolean()
459 def skip?(%Activity{} = activity, %User{} = user) do
468 |> Enum.find(&skip?(&1, activity, user))
471 def skip?(_, _), do: false
473 @spec skip?(atom(), Activity.t(), User.t()) :: boolean()
474 def skip?(:self, %Activity{} = activity, %User{} = user) do
475 activity.data["actor"] == user.ap_id
480 %Activity{} = activity,
481 %User{notification_settings: %{followers: false}} = user
483 actor = activity.data["actor"]
484 follower = User.get_cached_by_ap_id(actor)
485 User.following?(follower, user)
490 %Activity{} = activity,
491 %User{notification_settings: %{non_followers: false}} = user
493 actor = activity.data["actor"]
494 follower = User.get_cached_by_ap_id(actor)
495 !User.following?(follower, user)
500 %Activity{} = activity,
501 %User{notification_settings: %{follows: false}} = user
503 actor = activity.data["actor"]
504 followed = User.get_cached_by_ap_id(actor)
505 User.following?(user, followed)
510 %Activity{} = activity,
511 %User{notification_settings: %{non_follows: false}} = user
513 actor = activity.data["actor"]
514 followed = User.get_cached_by_ap_id(actor)
515 !User.following?(user, followed)
518 # To do: consider defining recency in hours and checking FollowingRelationship with a single SQL
519 def skip?(:recently_followed, %Activity{data: %{"type" => "Follow"}} = activity, %User{} = user) do
520 actor = activity.data["actor"]
522 Notification.for_user(user)
524 %{activity: %{data: %{"type" => "Follow", "actor" => ^actor}}} -> true
529 def skip?(_, _, _), do: false