2019-03-06 13:20:12 +00:00
|
|
|
# Pleroma: A lightweight social networking server
|
2022-02-26 06:11:42 +00:00
|
|
|
# Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
|
2019-03-06 13:20:12 +00:00
|
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
|
|
|
|
defmodule Pleroma.Web.Push.Impl do
|
|
|
|
@moduledoc "The module represents implementation push web notification"
|
|
|
|
|
|
|
|
alias Pleroma.Activity
|
2019-03-05 02:52:23 +00:00
|
|
|
alias Pleroma.Notification
|
2019-03-06 13:20:12 +00:00
|
|
|
alias Pleroma.Object
|
2019-03-05 02:52:23 +00:00
|
|
|
alias Pleroma.Repo
|
|
|
|
alias Pleroma.User
|
2019-03-06 13:20:12 +00:00
|
|
|
alias Pleroma.Web.Metadata.Utils
|
2019-03-05 02:52:23 +00:00
|
|
|
alias Pleroma.Web.Push.Subscription
|
2019-03-06 13:20:12 +00:00
|
|
|
|
|
|
|
require Logger
|
|
|
|
import Ecto.Query
|
|
|
|
|
2022-10-01 21:28:02 +00:00
|
|
|
@types ["Create", "Follow", "Announce", "Like", "Move", "EmojiReact", "Update"]
|
2019-03-06 13:20:12 +00:00
|
|
|
|
|
|
|
@doc "Performs sending notifications for user subscriptions"
|
2020-10-01 10:32:11 +00:00
|
|
|
@spec perform(Notification.t()) :: list(any) | :error | {:error, :unknown_type}
|
2019-04-05 12:38:44 +00:00
|
|
|
def perform(
|
2019-04-29 16:15:30 +00:00
|
|
|
%{
|
2019-10-29 18:33:17 +00:00
|
|
|
activity: %{data: %{"type" => activity_type}} = activity,
|
|
|
|
user: %User{id: user_id}
|
2020-04-07 18:52:32 +00:00
|
|
|
} = notification
|
2019-03-11 18:32:21 +00:00
|
|
|
)
|
2019-03-06 13:20:12 +00:00
|
|
|
when activity_type in @types do
|
2020-04-07 18:52:32 +00:00
|
|
|
actor = User.get_cached_by_ap_id(notification.activity.data["actor"])
|
2019-03-06 13:20:12 +00:00
|
|
|
|
2020-06-02 12:22:16 +00:00
|
|
|
mastodon_type = notification.type
|
2019-03-06 13:20:12 +00:00
|
|
|
gcm_api_key = Application.get_env(:web_push_encryption, :gcm_api_key)
|
|
|
|
avatar_url = User.avatar_url(actor)
|
2021-01-04 12:38:31 +00:00
|
|
|
object = Object.normalize(activity, fetch: false)
|
2019-11-26 12:53:43 +00:00
|
|
|
user = User.get_cached_by_id(user_id)
|
|
|
|
direct_conversation_id = Activity.direct_conversation_id(activity, user)
|
2019-03-06 13:20:12 +00:00
|
|
|
|
2020-04-07 18:52:32 +00:00
|
|
|
for subscription <- fetch_subscriptions(user_id),
|
|
|
|
Subscription.enabled?(subscription, mastodon_type) do
|
2019-03-06 13:20:12 +00:00
|
|
|
%{
|
|
|
|
access_token: subscription.token.token,
|
2020-04-07 18:52:32 +00:00
|
|
|
notification_id: notification.id,
|
|
|
|
notification_type: mastodon_type,
|
2019-03-06 13:20:12 +00:00
|
|
|
icon: avatar_url,
|
2019-03-11 18:23:21 +00:00
|
|
|
preferred_locale: "en",
|
|
|
|
pleroma: %{
|
2020-04-07 18:52:32 +00:00
|
|
|
activity_id: notification.activity.id,
|
2019-11-26 19:32:55 +00:00
|
|
|
direct_conversation_id: direct_conversation_id
|
2019-03-11 18:23:21 +00:00
|
|
|
}
|
2019-03-06 13:20:12 +00:00
|
|
|
}
|
2020-04-07 18:52:32 +00:00
|
|
|
|> Map.merge(build_content(notification, actor, object, mastodon_type))
|
2019-03-06 13:20:12 +00:00
|
|
|
|> Jason.encode!()
|
|
|
|
|> push_message(build_sub(subscription), gcm_api_key, subscription)
|
|
|
|
end
|
2020-04-22 11:28:34 +00:00
|
|
|
|> (&{:ok, &1}).()
|
2019-03-06 13:20:12 +00:00
|
|
|
end
|
|
|
|
|
2019-04-05 12:38:44 +00:00
|
|
|
def perform(_) do
|
2023-11-28 17:17:46 +00:00
|
|
|
Logger.warning("Unknown notification type")
|
2020-04-22 11:28:34 +00:00
|
|
|
{:error, :unknown_type}
|
2019-03-06 13:20:12 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
@doc "Push message to web"
|
|
|
|
def push_message(body, sub, api_key, subscription) do
|
|
|
|
case WebPushEncryption.send_web_push(body, sub, api_key) do
|
2020-10-01 10:32:11 +00:00
|
|
|
{:ok, %{status: code}} when code in 400..499 ->
|
2019-03-06 13:20:12 +00:00
|
|
|
Logger.debug("Removing subscription record")
|
|
|
|
Repo.delete!(subscription)
|
|
|
|
:ok
|
|
|
|
|
2020-10-01 10:32:11 +00:00
|
|
|
{:ok, %{status: code}} when code in 200..299 ->
|
2019-03-06 13:20:12 +00:00
|
|
|
:ok
|
|
|
|
|
2020-10-01 10:32:11 +00:00
|
|
|
{:ok, %{status: code}} ->
|
2019-03-06 13:20:12 +00:00
|
|
|
Logger.error("Web Push Notification failed with code: #{code}")
|
|
|
|
:error
|
|
|
|
|
2020-10-01 10:32:11 +00:00
|
|
|
error ->
|
|
|
|
Logger.error("Web Push Notification failed with #{inspect(error)}")
|
2019-03-06 13:20:12 +00:00
|
|
|
:error
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
@doc "Gets user subscriptions"
|
2020-04-07 18:52:32 +00:00
|
|
|
def fetch_subscriptions(user_id) do
|
2019-03-06 13:20:12 +00:00
|
|
|
Subscription
|
|
|
|
|> where(user_id: ^user_id)
|
|
|
|
|> preload(:token)
|
|
|
|
|> Repo.all()
|
|
|
|
end
|
|
|
|
|
|
|
|
def build_sub(subscription) do
|
|
|
|
%{
|
|
|
|
keys: %{
|
|
|
|
p256dh: subscription.key_p256dh,
|
|
|
|
auth: subscription.key_auth
|
|
|
|
},
|
|
|
|
endpoint: subscription.endpoint
|
|
|
|
}
|
|
|
|
end
|
|
|
|
|
2020-04-07 18:52:32 +00:00
|
|
|
def build_content(notification, actor, object, mastodon_type \\ nil)
|
|
|
|
|
2019-10-29 18:33:17 +00:00
|
|
|
def build_content(
|
|
|
|
%{
|
2020-06-26 17:45:46 +00:00
|
|
|
user: %{notification_settings: %{hide_notification_contents: true}}
|
2020-05-06 21:30:05 +00:00
|
|
|
} = notification,
|
2020-05-06 21:42:27 +00:00
|
|
|
_actor,
|
2020-04-07 18:52:32 +00:00
|
|
|
_object,
|
2020-05-06 21:30:05 +00:00
|
|
|
mastodon_type
|
2019-10-29 18:33:17 +00:00
|
|
|
) do
|
2020-05-06 21:42:27 +00:00
|
|
|
%{body: format_title(notification, mastodon_type)}
|
2019-10-29 18:33:17 +00:00
|
|
|
end
|
|
|
|
|
2020-04-07 18:52:32 +00:00
|
|
|
def build_content(notification, actor, object, mastodon_type) do
|
2020-06-02 12:22:16 +00:00
|
|
|
mastodon_type = mastodon_type || notification.type
|
2020-04-07 18:52:32 +00:00
|
|
|
|
2019-10-29 18:33:17 +00:00
|
|
|
%{
|
2020-04-07 18:52:32 +00:00
|
|
|
title: format_title(notification, mastodon_type),
|
|
|
|
body: format_body(notification, actor, object, mastodon_type)
|
2019-10-29 18:33:17 +00:00
|
|
|
}
|
|
|
|
end
|
|
|
|
|
2020-04-07 18:52:32 +00:00
|
|
|
def format_body(activity, actor, object, mastodon_type \\ nil)
|
|
|
|
|
2021-08-11 19:29:06 +00:00
|
|
|
def format_body(_activity, actor, %{data: %{"type" => "ChatMessage"} = data}, _) do
|
|
|
|
case data["content"] do
|
2020-06-06 07:46:07 +00:00
|
|
|
nil -> "@#{actor.nickname}: (Attachment)"
|
|
|
|
content -> "@#{actor.nickname}: #{Utils.scrub_html_and_truncate(content, 80)}"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2019-03-06 13:20:12 +00:00
|
|
|
def format_body(
|
2019-04-29 16:15:30 +00:00
|
|
|
%{activity: %{data: %{"type" => "Create"}}},
|
|
|
|
actor,
|
2020-04-07 18:52:32 +00:00
|
|
|
%{data: %{"content" => content}},
|
|
|
|
_mastodon_type
|
2019-03-06 13:20:12 +00:00
|
|
|
) do
|
|
|
|
"@#{actor.nickname}: #{Utils.scrub_html_and_truncate(content, 80)}"
|
|
|
|
end
|
|
|
|
|
|
|
|
def format_body(
|
2019-04-29 16:15:30 +00:00
|
|
|
%{activity: %{data: %{"type" => "Announce"}}},
|
|
|
|
actor,
|
2020-04-07 18:52:32 +00:00
|
|
|
%{data: %{"content" => content}},
|
|
|
|
_mastodon_type
|
2019-03-06 13:20:12 +00:00
|
|
|
) do
|
|
|
|
"@#{actor.nickname} repeated: #{Utils.scrub_html_and_truncate(content, 80)}"
|
|
|
|
end
|
|
|
|
|
2020-11-13 23:01:53 +00:00
|
|
|
def format_body(
|
|
|
|
%{activity: %{data: %{"type" => "EmojiReact", "content" => content}}},
|
|
|
|
actor,
|
|
|
|
_object,
|
|
|
|
_mastodon_type
|
|
|
|
) do
|
2020-11-17 19:51:37 +00:00
|
|
|
"@#{actor.nickname} reacted with #{content}"
|
2020-11-13 23:01:53 +00:00
|
|
|
end
|
|
|
|
|
2019-03-06 13:20:12 +00:00
|
|
|
def format_body(
|
2020-04-07 18:52:32 +00:00
|
|
|
%{activity: %{data: %{"type" => type}}} = notification,
|
2019-04-29 16:15:30 +00:00
|
|
|
actor,
|
2020-04-07 18:52:32 +00:00
|
|
|
_object,
|
|
|
|
mastodon_type
|
2019-03-06 13:20:12 +00:00
|
|
|
)
|
|
|
|
when type in ["Follow", "Like"] do
|
2020-06-02 12:22:16 +00:00
|
|
|
mastodon_type = mastodon_type || notification.type
|
2020-04-07 18:52:32 +00:00
|
|
|
|
2020-04-09 12:13:37 +00:00
|
|
|
case mastodon_type do
|
|
|
|
"follow" -> "@#{actor.nickname} has followed you"
|
|
|
|
"follow_request" -> "@#{actor.nickname} has requested to follow you"
|
|
|
|
"favourite" -> "@#{actor.nickname} has favorited your post"
|
2019-03-06 13:20:12 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2022-10-01 21:28:02 +00:00
|
|
|
def format_body(
|
|
|
|
%{activity: %{data: %{"type" => "Update"}}},
|
|
|
|
actor,
|
|
|
|
_object,
|
|
|
|
_mastodon_type
|
|
|
|
) do
|
|
|
|
"@#{actor.nickname} edited a status"
|
|
|
|
end
|
|
|
|
|
2020-04-07 18:52:32 +00:00
|
|
|
def format_title(activity, mastodon_type \\ nil)
|
|
|
|
|
|
|
|
def format_title(%{activity: %{data: %{"directMessage" => true}}}, _mastodon_type) do
|
2019-10-18 22:51:34 +00:00
|
|
|
"New Direct Message"
|
|
|
|
end
|
|
|
|
|
2020-06-02 12:22:16 +00:00
|
|
|
def format_title(%{type: type}, mastodon_type) do
|
|
|
|
case mastodon_type || type do
|
2020-04-09 12:13:37 +00:00
|
|
|
"mention" -> "New Mention"
|
2022-04-25 10:39:36 +00:00
|
|
|
"status" -> "New Status"
|
2020-04-09 12:13:37 +00:00
|
|
|
"follow" -> "New Follower"
|
|
|
|
"follow_request" -> "New Follow Request"
|
|
|
|
"reblog" -> "New Repeat"
|
|
|
|
"favourite" -> "New Favorite"
|
2022-10-01 21:28:02 +00:00
|
|
|
"update" -> "New Update"
|
2020-06-04 12:49:10 +00:00
|
|
|
"pleroma:chat_mention" -> "New Chat Message"
|
2020-11-13 23:01:53 +00:00
|
|
|
"pleroma:emoji_reaction" -> "New Reaction"
|
2020-04-09 12:13:37 +00:00
|
|
|
type -> "New #{String.capitalize(type || "event")}"
|
2019-03-06 13:20:12 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|