1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 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
12 @behaviour :cowboy_websocket
25 @anonymous_streams ["public", "public:local", "hashtag"]
27 # Handled by periodic keepalive in Pleroma.Web.Streamer.
30 def init(%{qs: qs} = req, state) do
31 with params <- :cow_qs.parse_qs(qs),
32 access_token <- :cowboy_req.header("sec-websocket-protocol", req, 0),
33 {_, stream} <- List.keyfind(params, "stream", 0),
34 {:ok, user} <- allow_request(stream, access_token),
35 topic when is_binary(topic) <- expand_topic(stream, params) do
36 {:cowboy_websocket, req, %{user: user, topic: topic}, %{idle_timeout: @timeout}}
39 Logger.debug("#{__MODULE__} denied connection: #{inspect(code)} - #{inspect(req)}")
40 {:ok, req} = :cowboy_req.reply(code, req)
44 Logger.debug("#{__MODULE__} denied connection: #{inspect(error)} - #{inspect(req)}")
45 {:ok, req} = :cowboy_req.reply(400, req)
50 def websocket_init(state) do
51 send(self(), :subscribe)
55 # We never receive messages.
56 def websocket_handle(_frame, state) do
60 def websocket_info(:subscribe, state) do
62 "#{__MODULE__} accepted websocket connection for user #{
63 (state.user || %{id: "anonymous"}).id
64 }, topic #{state.topic}"
67 Pleroma.Web.Streamer.add_socket(state.topic, streamer_socket(state))
71 def websocket_info({:text, message}, state) do
72 {:reply, {:text, message}, state}
75 def terminate(reason, _req, state) do
77 "#{__MODULE__} terminating websocket connection for user #{
78 (state.user || %{id: "anonymous"}).id
79 }, topic #{state.topic || "?"}: #{inspect(reason)}"
82 Pleroma.Web.Streamer.remove_socket(state.topic, streamer_socket(state))
86 # Public streams without authentication.
87 defp allow_request(stream, nil) when stream in @anonymous_streams do
91 # Authenticated streams.
92 defp allow_request(stream, access_token) when stream in @streams do
93 with %Token{user_id: user_id} <- Repo.get_by(Token, token: access_token),
94 user = %User{} <- User.get_cached_by_id(user_id) do
102 defp allow_request(stream, _) when stream in @streams, do: {:error, 403}
104 # No matching stream.
105 defp allow_request(_, _), do: {:error, 404}
107 defp expand_topic("hashtag", params) do
108 case List.keyfind(params, "tag", 0) do
109 {_, tag} -> "hashtag:#{tag}"
114 defp expand_topic("list", params) do
115 case List.keyfind(params, "list", 0) do
116 {_, list} -> "list:#{list}"
121 defp expand_topic(topic, _), do: topic
123 defp streamer_socket(state) do
124 %{transport_pid: self(), assigns: state}