1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Notification do
9 alias Pleroma.Notification
11 alias Pleroma.Pagination
14 alias Pleroma.Web.CommonAPI.Utils
15 alias Pleroma.Web.Push
16 alias Pleroma.Web.Streamer
22 @type t :: %__MODULE__{}
24 @include_muted_option :with_muted
26 schema "notifications" do
27 field(:seen, :boolean, default: false)
28 belongs_to(:user, User, type: FlakeId.Ecto.CompatType)
29 belongs_to(:activity, Activity, type: FlakeId.Ecto.CompatType)
34 def changeset(%Notification{} = notification, attrs) do
36 |> cast(attrs, [:seen])
39 defp for_user_query_ap_id_opts(user, opts) do
42 if opts[@include_muted_option], do: [], else: [:notification_mute]
44 preloaded_ap_ids = User.outgoing_relations_ap_ids(user, ap_id_relations)
46 exclude_blocked_opts = Map.merge(%{blocked_users_ap_ids: preloaded_ap_ids[:block]}, opts)
48 exclude_notification_muted_opts =
49 Map.merge(%{notification_muted_users_ap_ids: preloaded_ap_ids[:notification_mute]}, opts)
51 {exclude_blocked_opts, exclude_notification_muted_opts}
54 def for_user_query(user, opts \\ %{}) do
55 {exclude_blocked_opts, exclude_notification_muted_opts} =
56 for_user_query_ap_id_opts(user, opts)
59 |> where(user_id: ^user.id)
63 "? not in (SELECT ap_id FROM users WHERE deactivated = 'true')",
67 |> join(:inner, [n], activity in assoc(n, :activity))
68 |> join(:left, [n, a], object in Object,
71 "(?->>'id') = COALESCE((? -> 'object'::text) ->> 'id'::text)",
76 |> preload([n, a, o], activity: {a, object: o})
77 |> exclude_notification_muted(user, exclude_notification_muted_opts)
78 |> exclude_blocked(user, exclude_blocked_opts)
79 |> exclude_visibility(opts)
83 defp exclude_blocked(query, user, opts) do
84 blocked_ap_ids = opts[:blocked_users_ap_ids] || User.blocked_users_ap_ids(user)
87 |> where([n, a], a.actor not in ^blocked_ap_ids)
90 fragment("substring(? from '.*://([^/]*)')", a.actor) not in ^user.domain_blocks
94 defp exclude_notification_muted(query, _, %{@include_muted_option => true}) do
98 defp exclude_notification_muted(query, user, opts) do
99 notification_muted_ap_ids =
100 opts[:notification_muted_users_ap_ids] || User.notification_muted_users_ap_ids(user)
103 |> where([n, a], a.actor not in ^notification_muted_ap_ids)
104 |> join(:left, [n, a], tm in Pleroma.ThreadMute,
105 on: tm.user_id == ^user.id and tm.context == fragment("?->>'context'", a.data)
107 |> where([n, a, o, tm], is_nil(tm.user_id))
110 defp exclude_move(query, %{with_move: true}) do
114 defp exclude_move(query, _opts) do
115 where(query, [n, a], fragment("?->>'type' != 'Move'", a.data))
118 @valid_visibilities ~w[direct unlisted public private]
120 defp exclude_visibility(query, %{exclude_visibilities: visibility})
121 when is_list(visibility) do
122 if Enum.all?(visibility, &(&1 in @valid_visibilities)) do
127 "activity_visibility(?, ?, ?) = ANY (?)",
135 Logger.error("Could not exclude visibility to #{visibility}")
140 defp exclude_visibility(query, %{exclude_visibilities: visibility})
141 when visibility in @valid_visibilities do
146 "activity_visibility(?, ?, ?) = (?)",
155 defp exclude_visibility(query, %{exclude_visibilities: visibility})
156 when visibility not in @valid_visibilities do
157 Logger.error("Could not exclude visibility to #{visibility}")
161 defp exclude_visibility(query, _visibility), do: query
163 def for_user(user, opts \\ %{}) do
165 |> for_user_query(opts)
166 |> Pagination.fetch_paginated(opts)
170 Returns notifications for user received since given date.
174 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-13 11:22:33])
175 [%Pleroma.Notification{}, %Pleroma.Notification{}]
177 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-15 11:22:33])
180 @spec for_user_since(Pleroma.User.t(), NaiveDateTime.t()) :: [t()]
181 def for_user_since(user, date) do
182 from(n in for_user_query(user),
183 where: n.updated_at > ^date
188 def set_read_up_to(%{id: user_id} = _user, id) do
192 where: n.user_id == ^user_id,
194 where: n.seen == false,
198 updated_at: ^NaiveDateTime.utc_now()
201 # Ideally we would preload object and activities here
202 # but Ecto does not support preloads in update_all
206 {_, notification_ids} = Repo.update_all(query, [])
209 |> where([n], n.id in ^notification_ids)
210 |> join(:inner, [n], activity in assoc(n, :activity))
211 |> join(:left, [n, a], object in Object,
214 "(?->>'id') = COALESCE((? -> 'object'::text) ->> 'id'::text)",
219 |> preload([n, a, o], activity: {a, object: o})
223 def read_one(%User{} = user, notification_id) do
224 with {:ok, %Notification{} = notification} <- get(user, notification_id) do
226 |> changeset(%{seen: true})
231 def get(%{id: user_id} = _user, id) do
236 join: activity in assoc(n, :activity),
237 preload: [activity: activity]
240 notification = Repo.one(query)
243 %{user_id: ^user_id} ->
247 {:error, "Cannot get notification"}
252 from(n in Notification, where: n.user_id == ^user.id)
256 def destroy_multiple(%{id: user_id} = _user, ids) do
257 from(n in Notification,
259 where: n.user_id == ^user_id
264 def dismiss(%{id: user_id} = _user, id) do
265 notification = Repo.get(Notification, id)
268 %{user_id: ^user_id} ->
269 Repo.delete(notification)
272 {:error, "Cannot dismiss notification"}
276 def create_notifications(%Activity{data: %{"to" => _, "type" => "Create"}} = activity) do
277 object = Object.normalize(activity)
279 unless object && object.data["type"] == "Answer" do
280 users = get_notified_from_activity(activity)
281 notifications = Enum.map(users, fn user -> create_notification(activity, user) end)
288 def create_notifications(%Activity{data: %{"type" => type}} = activity)
289 when type in ["Like", "Announce", "Follow", "Move"] do
292 |> get_notified_from_activity()
293 |> Enum.map(&create_notification(activity, &1))
298 def create_notifications(_), do: {:ok, []}
300 # TODO move to sql, too.
301 def create_notification(%Activity{} = activity, %User{} = user) do
302 unless skip?(activity, user) do
303 notification = %Notification{user_id: user.id, activity: activity}
304 {:ok, notification} = Repo.insert(notification)
306 ["user", "user:notification"]
307 |> Streamer.stream(notification)
309 Push.send(notification)
314 def get_notified_from_activity(activity, local_only \\ true)
316 def get_notified_from_activity(%Activity{data: %{"type" => type}} = activity, local_only)
317 when type in ["Create", "Like", "Announce", "Follow", "Move"] do
319 |> Utils.maybe_notify_to_recipients(activity)
320 |> Utils.maybe_notify_mentioned_recipients(activity)
321 |> Utils.maybe_notify_subscribers(activity)
322 |> Utils.maybe_notify_followers(activity)
324 |> User.get_users_from_set(local_only)
327 def get_notified_from_activity(_, _local_only), do: []
329 @spec skip?(Activity.t(), User.t()) :: boolean()
330 def skip?(activity, user) do
339 |> Enum.any?(&skip?(&1, activity, user))
342 @spec skip?(atom(), Activity.t(), User.t()) :: boolean()
343 def skip?(:self, activity, user) do
344 activity.data["actor"] == user.ap_id
350 %{notification_settings: %{"followers" => false}} = user
352 actor = activity.data["actor"]
353 follower = User.get_cached_by_ap_id(actor)
354 User.following?(follower, user)
360 %{notification_settings: %{"non_followers" => false}} = user
362 actor = activity.data["actor"]
363 follower = User.get_cached_by_ap_id(actor)
364 !User.following?(follower, user)
367 def skip?(:follows, activity, %{notification_settings: %{"follows" => false}} = user) do
368 actor = activity.data["actor"]
369 followed = User.get_cached_by_ap_id(actor)
370 User.following?(user, followed)
376 %{notification_settings: %{"non_follows" => false}} = user
378 actor = activity.data["actor"]
379 followed = User.get_cached_by_ap_id(actor)
380 !User.following?(user, followed)
383 def skip?(:recently_followed, %{data: %{"type" => "Follow"}} = activity, user) do
384 actor = activity.data["actor"]
386 Notification.for_user(user)
388 %{activity: %{data: %{"type" => "Follow", "actor" => ^actor}}} -> true
393 def skip?(_, _, _), do: false