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)
82 defp exclude_blocked(query, user, opts) do
83 blocked_ap_ids = opts[:blocked_users_ap_ids] || User.blocked_users_ap_ids(user)
86 |> where([n, a], a.actor not in ^blocked_ap_ids)
89 fragment("substring(? from '.*://([^/]*)')", a.actor) not in ^user.domain_blocks
93 defp exclude_notification_muted(query, _, %{@include_muted_option => true}) do
97 defp exclude_notification_muted(query, user, opts) do
98 notification_muted_ap_ids =
99 opts[:notification_muted_users_ap_ids] || User.notification_muted_users_ap_ids(user)
102 |> where([n, a], a.actor not in ^notification_muted_ap_ids)
103 |> join(:left, [n, a], tm in Pleroma.ThreadMute,
104 on: tm.user_id == ^user.id and tm.context == fragment("?->>'context'", a.data)
106 |> where([n, a, o, tm], is_nil(tm.user_id))
109 @valid_visibilities ~w[direct unlisted public private]
111 defp exclude_visibility(query, %{exclude_visibilities: visibility})
112 when is_list(visibility) do
113 if Enum.all?(visibility, &(&1 in @valid_visibilities)) do
118 "activity_visibility(?, ?, ?) = ANY (?)",
126 Logger.error("Could not exclude visibility to #{visibility}")
131 defp exclude_visibility(query, %{exclude_visibilities: visibility})
132 when visibility in @valid_visibilities do
137 "activity_visibility(?, ?, ?) = (?)",
146 defp exclude_visibility(query, %{exclude_visibilities: visibility})
147 when visibility not in @valid_visibilities do
148 Logger.error("Could not exclude visibility to #{visibility}")
152 defp exclude_visibility(query, _visibility), do: query
154 def for_user(user, opts \\ %{}) do
156 |> for_user_query(opts)
157 |> Pagination.fetch_paginated(opts)
161 Returns notifications for user received since given date.
165 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-13 11:22:33])
166 [%Pleroma.Notification{}, %Pleroma.Notification{}]
168 iex> Pleroma.Notification.for_user_since(%Pleroma.User{}, ~N[2019-04-15 11:22:33])
171 @spec for_user_since(Pleroma.User.t(), NaiveDateTime.t()) :: [t()]
172 def for_user_since(user, date) do
173 from(n in for_user_query(user),
174 where: n.updated_at > ^date
179 def set_read_up_to(%{id: user_id} = _user, id) do
183 where: n.user_id == ^user_id,
185 where: n.seen == false,
189 updated_at: ^NaiveDateTime.utc_now()
192 # Ideally we would preload object and activities here
193 # but Ecto does not support preloads in update_all
197 {_, notification_ids} = Repo.update_all(query, [])
200 |> where([n], n.id in ^notification_ids)
201 |> join(:inner, [n], activity in assoc(n, :activity))
202 |> join(:left, [n, a], object in Object,
205 "(?->>'id') = COALESCE((? -> 'object'::text) ->> 'id'::text)",
210 |> preload([n, a, o], activity: {a, object: o})
214 def read_one(%User{} = user, notification_id) do
215 with {:ok, %Notification{} = notification} <- get(user, notification_id) do
217 |> changeset(%{seen: true})
222 def get(%{id: user_id} = _user, id) do
227 join: activity in assoc(n, :activity),
228 preload: [activity: activity]
231 notification = Repo.one(query)
234 %{user_id: ^user_id} ->
238 {:error, "Cannot get notification"}
243 from(n in Notification, where: n.user_id == ^user.id)
247 def destroy_multiple(%{id: user_id} = _user, ids) do
248 from(n in Notification,
250 where: n.user_id == ^user_id
255 def dismiss(%{id: user_id} = _user, id) do
256 notification = Repo.get(Notification, id)
259 %{user_id: ^user_id} ->
260 Repo.delete(notification)
263 {:error, "Cannot dismiss notification"}
267 def create_notifications(%Activity{data: %{"to" => _, "type" => "Create"}} = activity) do
268 object = Object.normalize(activity)
270 unless object && object.data["type"] == "Answer" do
271 users = get_notified_from_activity(activity)
272 notifications = Enum.map(users, fn user -> create_notification(activity, user) end)
279 def create_notifications(%Activity{data: %{"type" => type}} = activity)
280 when type in ["Like", "Announce", "Follow", "Move"] do
283 |> get_notified_from_activity()
284 |> Enum.map(&create_notification(activity, &1))
289 def create_notifications(_), do: {:ok, []}
291 # TODO move to sql, too.
292 def create_notification(%Activity{} = activity, %User{} = user) do
293 unless skip?(activity, user) do
294 notification = %Notification{user_id: user.id, activity: activity}
295 {:ok, notification} = Repo.insert(notification)
297 ["user", "user:notification"]
298 |> Streamer.stream(notification)
300 Push.send(notification)
305 def get_notified_from_activity(activity, local_only \\ true)
307 def get_notified_from_activity(%Activity{data: %{"type" => type}} = activity, local_only)
308 when type in ["Create", "Like", "Announce", "Follow", "Move"] do
310 |> Utils.maybe_notify_to_recipients(activity)
311 |> Utils.maybe_notify_mentioned_recipients(activity)
312 |> Utils.maybe_notify_subscribers(activity)
313 |> Utils.maybe_notify_followers(activity)
315 |> User.get_users_from_set(local_only)
318 def get_notified_from_activity(_, _local_only), do: []
320 @spec skip?(Activity.t(), User.t()) :: boolean()
321 def skip?(activity, user) do
330 |> Enum.any?(&skip?(&1, activity, user))
333 @spec skip?(atom(), Activity.t(), User.t()) :: boolean()
334 def skip?(:self, activity, user) do
335 activity.data["actor"] == user.ap_id
341 %{notification_settings: %{"followers" => false}} = user
343 actor = activity.data["actor"]
344 follower = User.get_cached_by_ap_id(actor)
345 User.following?(follower, user)
351 %{notification_settings: %{"non_followers" => false}} = user
353 actor = activity.data["actor"]
354 follower = User.get_cached_by_ap_id(actor)
355 !User.following?(follower, user)
358 def skip?(:follows, activity, %{notification_settings: %{"follows" => false}} = user) do
359 actor = activity.data["actor"]
360 followed = User.get_cached_by_ap_id(actor)
361 User.following?(user, followed)
367 %{notification_settings: %{"non_follows" => false}} = user
369 actor = activity.data["actor"]
370 followed = User.get_cached_by_ap_id(actor)
371 !User.following?(user, followed)
374 def skip?(:recently_followed, %{data: %{"type" => "Follow"}} = activity, user) do
375 actor = activity.data["actor"]
377 Notification.for_user(user)
379 %{activity: %{data: %{"type" => "Follow", "actor" => ^actor}}} -> true
384 def skip?(_, _, _), do: false