1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.MastodonAPI.WebsocketHandler do
10 alias Pleroma.Web.OAuth.Token
11 alias Pleroma.Web.Streamer
13 @behaviour :cowboy_websocket
16 @tick :timer.seconds(30)
17 # Cowboy timeout period.
18 @timeout :timer.seconds(60)
19 # Hibernate every X messages
22 def init(%{qs: qs} = req, state) do
23 with params <- Enum.into(:cow_qs.parse_qs(qs), %{}),
24 sec_websocket <- :cowboy_req.header("sec-websocket-protocol", req, nil),
25 access_token <- Map.get(params, "access_token"),
26 {:ok, user, oauth_token} <- authenticate_request(access_token, sec_websocket),
27 {:ok, topic} <- Streamer.get_topic(params["stream"], user, oauth_token, params) do
30 :cowboy_req.set_resp_header("sec-websocket-protocol", sec_websocket, req)
35 {:cowboy_websocket, req, %{user: user, topic: topic, count: 0, timer: nil},
36 %{idle_timeout: @timeout}}
38 {:error, :bad_topic} ->
39 Logger.debug("#{__MODULE__} bad topic #{inspect(req)}")
40 req = :cowboy_req.reply(404, req)
43 {:error, :unauthorized} ->
44 Logger.debug("#{__MODULE__} authentication error: #{inspect(req)}")
45 req = :cowboy_req.reply(401, req)
50 def websocket_init(state) do
52 "#{__MODULE__} accepted websocket connection for user #{(state.user || %{id: "anonymous"}).id}, topic #{state.topic}"
55 Streamer.add_socket(state.topic, state.user)
56 {:ok, %{state | timer: timer()}}
59 # Client's Pong frame.
60 def websocket_handle(:pong, state) do
61 if state.timer, do: Process.cancel_timer(state.timer)
62 {:ok, %{state | timer: timer()}}
65 # We only receive pings for now
66 def websocket_handle(:ping, state), do: {:ok, state}
68 def websocket_handle(frame, state) do
69 Logger.error("#{__MODULE__} received frame: #{inspect(frame)}")
73 def websocket_info({:render_with_user, view, template, item}, state) do
74 user = %User{} = User.get_cached_by_ap_id(state.user.ap_id)
76 unless Streamer.filtered_by_user?(user, item) do
77 websocket_info({:text, view.render(template, item, user)}, %{state | user: user})
83 def websocket_info({:text, message}, state) do
84 # If the websocket processed X messages, force an hibernate/GC.
85 # We don't hibernate at every message to balance CPU usage/latency with RAM usage.
86 if state.count > @hibernate_every do
87 {:reply, {:text, message}, %{state | count: 0}, :hibernate}
89 {:reply, {:text, message}, %{state | count: state.count + 1}}
93 # Ping tick. We don't re-queue a timer there, it is instead queued when :pong is received.
94 # As we hibernate there, reset the count to 0.
95 # If the client misses :pong, Cowboy will automatically timeout the connection after
97 def websocket_info(:tick, state) do
98 {:reply, :ping, %{state | timer: nil, count: 0}, :hibernate}
101 # State can be `[]` only in case we terminate before switching to websocket,
102 # we already log errors for these cases in `init/1`, so just do nothing here
103 def terminate(_reason, _req, []), do: :ok
105 def terminate(reason, _req, state) do
107 "#{__MODULE__} terminating websocket connection for user #{(state.user || %{id: "anonymous"}).id}, topic #{state.topic || "?"}: #{inspect(reason)}"
110 Streamer.remove_socket(state.topic)
114 # Public streams without authentication.
115 defp authenticate_request(nil, nil) do
119 # Authenticated streams.
120 defp authenticate_request(access_token, sec_websocket) do
121 token = access_token || sec_websocket
123 with true <- is_bitstring(token),
124 oauth_token = %Token{user_id: user_id} <- Repo.get_by(Token, token: token),
125 user = %User{} <- User.get_cached_by_id(user_id) do
126 {:ok, user, oauth_token}
128 _ -> {:error, :unauthorized}
133 Process.send_after(self(), :tick, @tick)