1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 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
33 @anonymous_streams ["public", "public:local", "hashtag"]
35 def init(%{qs: qs} = req, state) do
36 with params <- :cow_qs.parse_qs(qs),
37 sec_websocket <- :cowboy_req.header("sec-websocket-protocol", req, nil),
38 access_token <- List.keyfind(params, "access_token", 0),
39 {_, stream} <- List.keyfind(params, "stream", 0),
40 {:ok, user} <- allow_request(stream, [access_token, sec_websocket]),
41 topic when is_binary(topic) <- expand_topic(stream, params) do
44 :cowboy_req.set_resp_header("sec-websocket-protocol", sec_websocket, req)
49 {:cowboy_websocket, req, %{user: user, topic: topic, count: 0, timer: nil},
50 %{idle_timeout: @timeout}}
53 Logger.debug("#{__MODULE__} denied connection: #{inspect(code)} - #{inspect(req)}")
54 {:ok, req} = :cowboy_req.reply(code, req)
58 Logger.debug("#{__MODULE__} denied connection: #{inspect(error)} - #{inspect(req)}")
59 {:ok, req} = :cowboy_req.reply(400, req)
64 def websocket_init(state) do
66 "#{__MODULE__} accepted websocket connection for user #{
67 (state.user || %{id: "anonymous"}).id
68 }, topic #{state.topic}"
71 Streamer.add_socket(state.topic, state.user)
72 {:ok, %{state | timer: timer()}}
75 # Client's Pong frame.
76 def websocket_handle(:pong, state) do
77 if state.timer, do: Process.cancel_timer(state.timer)
78 {:ok, %{state | timer: timer()}}
81 # We never receive messages.
82 def websocket_handle(frame, state) do
83 Logger.error("#{__MODULE__} received frame: #{inspect(frame)}")
87 def websocket_info({:render_with_user, view, template, item}, state) do
88 user = %User{} = User.get_cached_by_ap_id(state.user.ap_id)
90 unless Streamer.filtered_by_user?(user, item) do
91 websocket_info({:text, view.render(template, item, user)}, %{state | user: user})
97 def websocket_info({:text, message}, state) do
98 # If the websocket processed X messages, force an hibernate/GC.
99 # We don't hibernate at every message to balance CPU usage/latency with RAM usage.
100 if state.count > @hibernate_every do
101 {:reply, {:text, message}, %{state | count: 0}, :hibernate}
103 {:reply, {:text, message}, %{state | count: state.count + 1}}
107 # Ping tick. We don't re-queue a timer there, it is instead queued when :pong is received.
108 # As we hibernate there, reset the count to 0.
109 # If the client misses :pong, Cowboy will automatically timeout the connection after
111 def websocket_info(:tick, state) do
112 {:reply, :ping, %{state | timer: nil, count: 0}, :hibernate}
115 def terminate(reason, _req, state) do
117 "#{__MODULE__} terminating websocket connection for user #{
118 (state.user || %{id: "anonymous"}).id
119 }, topic #{state.topic || "?"}: #{inspect(reason)}"
122 Streamer.remove_socket(state.topic)
126 # Public streams without authentication.
127 defp allow_request(stream, [nil, nil]) when stream in @anonymous_streams do
131 # Authenticated streams.
132 defp allow_request(stream, [access_token, sec_websocket]) when stream in @streams do
134 with {"access_token", token} <- access_token do
140 with true <- is_bitstring(token),
141 %Token{user_id: user_id} <- Repo.get_by(Token, token: token),
142 user = %User{} <- User.get_cached_by_id(user_id) do
150 defp allow_request(stream, _) when stream in @streams, do: {:error, 403}
152 # No matching stream.
153 defp allow_request(_, _), do: {:error, 404}
155 defp expand_topic("hashtag", params) do
156 case List.keyfind(params, "tag", 0) do
157 {_, tag} -> "hashtag:#{tag}"
162 defp expand_topic("list", params) do
163 case List.keyfind(params, "list", 0) do
164 {_, list} -> "list:#{list}"
169 defp expand_topic(topic, _), do: topic
172 Process.send_after(self(), :tick, @tick)