fix and improve web push; add configuration docs
authorEgor Kislitsyn <egor@kislitsyn.com>
Fri, 7 Dec 2018 08:55:28 +0000 (15:55 +0700)
committerhref <href@random.sh>
Fri, 14 Dec 2018 12:05:29 +0000 (13:05 +0100)
config/config.md
lib/pleroma/plugs/oauth_plug.ex
lib/pleroma/web/mastodon_api/views/push_subscription_view.ex
lib/pleroma/web/push/push.ex

index 165f5d9f8c8256d61c6844bff6f85208a9c825e8..2401e9aedd6ffe92bc31626dc2efef5e2240d1e4 100644 (file)
@@ -154,3 +154,11 @@ An example:
 config :pleroma, :mrf_user_allowlist,
   "example.org": ["https://example.org/users/admin"]
 ```
+
+## :web_push_encryption
+
+Web Push Notifications configuration. You could use a mix task `mix web_push.gen.keypair` to generate it.
+
+* ``subject``: a mailto link for the administrative contact. It’s best if this email is not a personal email address, but rather a group email so that if a person leaves an organization, is unavailable for an extended period, or otherwise can’t respond, someone else on the list can.
+* ``public_key``: VAPID public key
+* ``private_key``: VAPID private key
index 8b99a74d1f49f2c0d197990c86634adb797d86e0..13c914c1b7f3fae2542ad54be418934efcfec6aa 100644 (file)
@@ -15,10 +15,10 @@ defmodule Pleroma.Plugs.OAuthPlug do
   def call(%{assigns: %{user: %User{}}} = conn, _), do: conn
 
   def call(conn, _) do
-    with {:ok, token} <- fetch_token(conn),
-         {:ok, user} <- fetch_user(token) do
+    with {:ok, token_str} <- fetch_token_str(conn),
+         {:ok, user, token_record} <- fetch_user_and_token(token_str) do
       conn
-      |> assign(:token, token)
+      |> assign(:token, token_record)
       |> assign(:user, user)
     else
       _ -> conn
@@ -27,12 +27,12 @@ defmodule Pleroma.Plugs.OAuthPlug do
 
   # Gets user by token
   #
-  @spec fetch_user(String.t()) :: {:ok, User.t()} | nil
-  defp fetch_user(token) do
+  @spec fetch_user_and_token(String.t()) :: {:ok, User.t(), Token.t()} | nil
+  defp fetch_user_and_token(token) do
     query = from(q in Token, where: q.token == ^token, preload: [:user])
 
-    with %Token{user: %{info: %{deactivated: false} = _} = user} <- Repo.one(query) do
-      {:ok, user}
+    with %Token{user: %{info: %{deactivated: false} = _} = user} = token_record <- Repo.one(query) do
+      {:ok, user, token_record}
     end
   end
 
@@ -48,23 +48,23 @@ defmodule Pleroma.Plugs.OAuthPlug do
 
   # Gets token from headers
   #
-  @spec fetch_token(Plug.Conn.t()) :: :no_token_found | {:ok, String.t()}
-  defp fetch_token(%Plug.Conn{} = conn) do
+  @spec fetch_token_str(Plug.Conn.t()) :: :no_token_found | {:ok, String.t()}
+  defp fetch_token_str(%Plug.Conn{} = conn) do
     headers = get_req_header(conn, "authorization")
 
-    with :no_token_found <- fetch_token(headers),
+    with :no_token_found <- fetch_token_str(headers),
          do: fetch_token_from_session(conn)
   end
 
-  @spec fetch_token(Keyword.t()) :: :no_token_found | {:ok, String.t()}
-  defp fetch_token([]), do: :no_token_found
+  @spec fetch_token_str(Keyword.t()) :: :no_token_found | {:ok, String.t()}
+  defp fetch_token_str([]), do: :no_token_found
 
-  defp fetch_token([token | tail]) do
+  defp fetch_token_str([token | tail]) do
     trimmed_token = String.trim(token)
 
     case Regex.run(@realm_reg, trimmed_token) do
       [_, match] -> {:ok, String.trim(match)}
-      _ -> fetch_token(tail)
+      _ -> fetch_token_str(tail)
     end
   end
 end
index c8b95d14cb420c82eecfc107f57c4a857ddf8017..67e86294e6c8739962da35ce8e45388d4ddedbf2 100644 (file)
@@ -5,7 +5,12 @@ defmodule Pleroma.Web.MastodonAPI.PushSubscriptionView do
     %{
       id: to_string(subscription.id),
       endpoint: subscription.endpoint,
-      alerts: Map.get(subscription.data, "alerts")
+      alerts: Map.get(subscription.data, "alerts"),
+      server_key: server_key()
     }
   end
+
+  defp server_key do
+    Keyword.get(Application.get_env(:web_push_encryption, :vapid_details), :public_key)
+  end
 end
index 5a873ec19cf3231c4079ef731e71c7525ce983b9..fb6605f307c4eb08211c29434eeee70aff482cc4 100644 (file)
@@ -100,16 +100,16 @@ defmodule Pleroma.Web.Push do
 
   def format(%{activity: %{data: %{"type" => "Announce"}}}, actor) do
     %{
-      title: "New Announce",
-      body: "@#{actor.nickname} has announced your post",
+      title: "New Repeat",
+      body: "@#{actor.nickname} has repeated your post",
       icon: User.avatar_url(actor)
     }
   end
 
   def format(%{activity: %{data: %{"type" => "Like"}}}, actor) do
     %{
-      title: "New Like",
-      body: "@#{actor.nickname} has liked your post",
+      title: "New Favorite",
+      body: "@#{actor.nickname} has favorited your post",
       icon: User.avatar_url(actor)
     }
   end