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
15 # Cowboy timeout period.
16 @timeout :timer.seconds(30)
17 # Hibernate every X messages
31 @anonymous_streams ["public", "public:local", "hashtag"]
33 def init(%{qs: qs} = req, state) do
34 with params <- :cow_qs.parse_qs(qs),
35 sec_websocket <- :cowboy_req.header("sec-websocket-protocol", req, nil),
36 access_token <- List.keyfind(params, "access_token", 0),
37 {_, stream} <- List.keyfind(params, "stream", 0),
38 {:ok, user} <- allow_request(stream, [access_token, sec_websocket]),
39 topic when is_binary(topic) <- expand_topic(stream, params) do
42 :cowboy_req.set_resp_header("sec-websocket-protocol", sec_websocket, req)
47 {:cowboy_websocket, req, %{user: user, topic: topic, count: 0}, %{idle_timeout: @timeout}}
50 Logger.debug("#{__MODULE__} denied connection: #{inspect(code)} - #{inspect(req)}")
51 {:ok, req} = :cowboy_req.reply(code, req)
55 Logger.debug("#{__MODULE__} denied connection: #{inspect(error)} - #{inspect(req)}")
56 {:ok, req} = :cowboy_req.reply(400, req)
61 def websocket_init(state) do
63 "#{__MODULE__} accepted websocket connection for user #{
64 (state.user || %{id: "anonymous"}).id
65 }, topic #{state.topic}"
68 Streamer.add_socket(state.topic, state.user)
72 # We never receive messages.
73 def websocket_handle(_frame, state) do
77 def websocket_info({:render_with_user, view, template, item}, state) do
78 user = %User{} = User.get_cached_by_ap_id(state.user.ap_id)
80 unless Streamer.filtered_by_user?(user, item) do
81 websocket_info({:text, view.render(template, item, user)}, %{state | user: user})
87 def websocket_info({:text, message}, state) do
88 # If the websocket processed X messages, force an hibernate/GC.
89 # We don't hibernate at every message to balance CPU usage/latency with RAM usage.
90 if state.count > @hibernate_every do
91 {:reply, {:text, message}, %{state | count: 0}, :hibernate}
93 {:reply, {:text, message}, %{state | count: state.count + 1}}
97 def terminate(reason, _req, state) do
99 "#{__MODULE__} terminating websocket connection for user #{
100 (state.user || %{id: "anonymous"}).id
101 }, topic #{state.topic || "?"}: #{inspect(reason)}"
104 Streamer.remove_socket(state.topic)
108 # Public streams without authentication.
109 defp allow_request(stream, [nil, nil]) when stream in @anonymous_streams do
113 # Authenticated streams.
114 defp allow_request(stream, [access_token, sec_websocket]) when stream in @streams do
116 with {"access_token", token} <- access_token do
122 with true <- is_bitstring(token),
123 %Token{user_id: user_id} <- Repo.get_by(Token, token: token),
124 user = %User{} <- User.get_cached_by_id(user_id) do
132 defp allow_request(stream, _) when stream in @streams, do: {:error, 403}
134 # No matching stream.
135 defp allow_request(_, _), do: {:error, 404}
137 defp expand_topic("hashtag", params) do
138 case List.keyfind(params, "tag", 0) do
139 {_, tag} -> "hashtag:#{tag}"
144 defp expand_topic("list", params) do
145 case List.keyfind(params, "list", 0) do
146 {_, list} -> "list:#{list}"
151 defp expand_topic(topic, _), do: topic