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.Websub do
8 alias Pleroma.Instances
9 alias Pleroma.Web.Websub.{WebsubServerSubscription, WebsubClientSubscription}
10 alias Pleroma.Web.OStatus.FeedRepresenter
11 alias Pleroma.Web.{XML, Endpoint, OStatus}
12 alias Pleroma.Web.Router.Helpers
17 @httpoison Application.get_env(:pleroma, :httpoison)
19 def verify(subscription, getter \\ &@httpoison.get/3) do
20 challenge = Base.encode16(:crypto.strong_rand_bytes(8))
21 lease_seconds = NaiveDateTime.diff(subscription.valid_until, subscription.updated_at)
22 lease_seconds = lease_seconds |> to_string
25 "hub.challenge": challenge,
26 "hub.lease_seconds": lease_seconds,
27 "hub.topic": subscription.topic,
28 "hub.mode": "subscribe"
31 url = hd(String.split(subscription.callback, "?"))
32 query = URI.parse(subscription.callback).query || ""
33 params = Map.merge(params, URI.decode_query(query))
35 with {:ok, response} <- getter.(url, [], params: params),
36 ^challenge <- response.body do
37 changeset = Changeset.change(subscription, %{state: "active"})
38 Repo.update(changeset)
41 Logger.debug("Couldn't verify subscription")
42 Logger.debug(inspect(e))
43 {:error, subscription}
47 @supported_activities [
55 def publish(topic, user, %{data: %{"type" => type}} = activity)
56 when type in @supported_activities do
59 |> FeedRepresenter.to_simple_form([activity], [user])
60 |> :xmerl.export_simple(:xmerl_xml)
65 sub in WebsubServerSubscription,
66 where: sub.topic == ^topic and sub.state == "active",
67 where: fragment("? > (NOW() at time zone 'UTC')", sub.valid_until)
70 subscriptions = Repo.all(query)
72 callbacks = Enum.map(subscriptions, & &1.callback)
73 reachable_callbacks = Instances.filter_reachable(callbacks)
76 |> Enum.filter(&(&1.callback in reachable_callbacks))
77 |> Enum.each(fn sub ->
81 callback: sub.callback,
85 Pleroma.Web.Federator.enqueue(:publish_single_websub, data)
89 def publish(_, _, _), do: ""
91 def sign(secret, doc) do
92 :crypto.hmac(:sha, secret, to_string(doc)) |> Base.encode16() |> String.downcase()
95 def incoming_subscription_request(user, %{"hub.mode" => "subscribe"} = params) do
96 with {:ok, topic} <- valid_topic(params, user),
97 {:ok, lease_time} <- lease_time(params),
98 secret <- params["hub.secret"],
99 callback <- params["hub.callback"] do
100 subscription = get_subscription(topic, callback)
103 state: subscription.state || "requested",
109 change = Changeset.change(subscription, data)
110 websub = Repo.insert_or_update!(change)
113 Changeset.change(websub, %{valid_until: NaiveDateTime.add(websub.updated_at, lease_time)})
115 websub = Repo.update!(change)
117 Pleroma.Web.Federator.enqueue(:verify_websub, websub)
122 Logger.debug("Couldn't create subscription")
123 Logger.debug(inspect(reason))
129 def incoming_subscription_request(user, params) do
130 Logger.info("Unhandled WebSub request for #{user.nickname}: #{inspect(params)}")
132 {:error, "Invalid WebSub request"}
135 defp get_subscription(topic, callback) do
136 Repo.get_by(WebsubServerSubscription, topic: topic, callback: callback) ||
137 %WebsubServerSubscription{}
140 # Temp hack for mastodon.
141 defp lease_time(%{"hub.lease_seconds" => ""}) do
143 {:ok, 60 * 60 * 24 * 3}
146 defp lease_time(%{"hub.lease_seconds" => lease_seconds}) do
147 {:ok, String.to_integer(lease_seconds)}
150 defp lease_time(_) do
152 {:ok, 60 * 60 * 24 * 3}
155 defp valid_topic(%{"hub.topic" => topic}, user) do
156 if topic == OStatus.feed_path(user) do
157 {:ok, OStatus.feed_path(user)}
159 {:error, "Wrong topic requested, expected #{OStatus.feed_path(user)}, got #{topic}"}
163 def subscribe(subscriber, subscribed, requester \\ &request_subscription/1) do
164 topic = subscribed.info.topic
165 # FIXME: Race condition, use transactions
166 {:ok, subscription} =
167 with subscription when not is_nil(subscription) <-
168 Repo.get_by(WebsubClientSubscription, topic: topic) do
169 subscribers = [subscriber.ap_id | subscription.subscribers] |> Enum.uniq()
170 change = Ecto.Changeset.change(subscription, %{subscribers: subscribers})
174 subscription = %WebsubClientSubscription{
176 hub: subscribed.info.hub,
177 subscribers: [subscriber.ap_id],
179 secret: :crypto.strong_rand_bytes(8) |> Base.url_encode64(),
183 Repo.insert(subscription)
186 requester.(subscription)
189 def gather_feed_data(topic, getter \\ &@httpoison.get/1) do
190 with {:ok, response} <- getter.(topic),
191 status when status in 200..299 <- response.status,
192 body <- response.body,
193 doc <- XML.parse_document(body),
194 uri when not is_nil(uri) <- XML.string_from_xpath("/feed/author[1]/uri", doc),
195 hub when not is_nil(hub) <- XML.string_from_xpath(~S{/feed/link[@rel="hub"]/@href}, doc) do
196 name = XML.string_from_xpath("/feed/author[1]/name", doc)
197 preferredUsername = XML.string_from_xpath("/feed/author[1]/poco:preferredUsername", doc)
198 displayName = XML.string_from_xpath("/feed/author[1]/poco:displayName", doc)
199 avatar = OStatus.make_avatar_object(doc)
200 bio = XML.string_from_xpath("/feed/author[1]/summary", doc)
206 "nickname" => preferredUsername || name,
207 "name" => displayName || name,
208 "host" => URI.parse(uri).host,
218 def request_subscription(websub, poster \\ &@httpoison.post/3, timeout \\ 10_000) do
220 "hub.mode": "subscribe",
221 "hub.topic": websub.topic,
222 "hub.secret": websub.secret,
223 "hub.callback": Helpers.websub_url(Endpoint, :websub_subscription_confirmation, websub.id)
226 # This checks once a second if we are confirmed yet
227 websub_checker = fn ->
228 helper = fn helper ->
230 websub = Repo.get_by(WebsubClientSubscription, id: websub.id, state: "accepted")
231 if websub, do: websub, else: helper.(helper)
237 task = Task.async(websub_checker)
239 with {:ok, %{status: 202}} <-
240 poster.(websub.hub, {:form, data}, "Content-type": "application/x-www-form-urlencoded"),
241 {:ok, websub} <- Task.yield(task, timeout) do
247 change = Ecto.Changeset.change(websub, %{state: "rejected"})
248 {:ok, websub} = Repo.update(change)
250 Logger.debug(fn -> "Couldn't confirm subscription: #{inspect(websub)}" end)
251 Logger.debug(fn -> "error: #{inspect(e)}" end)
257 def refresh_subscriptions(delta \\ 60 * 60 * 24) do
258 Logger.debug("Refreshing subscriptions")
260 cut_off = NaiveDateTime.add(NaiveDateTime.utc_now(), delta)
262 query = from(sub in WebsubClientSubscription, where: sub.valid_until < ^cut_off)
264 subs = Repo.all(query)
266 Enum.each(subs, fn sub ->
267 Pleroma.Web.Federator.enqueue(:request_subscription, sub)
271 def publish_one(%{xml: xml, topic: topic, callback: callback, secret: secret}) do
272 signature = sign(secret || "", xml)
273 Logger.info(fn -> "Pushing #{topic} to #{callback}" end)
275 with {:ok, %{status: code}} when code in 200..299 <-
280 {"Content-Type", "application/atom+xml"},
281 {"X-Hub-Signature", "sha1=#{signature}"}
284 Instances.set_reachable(callback)
285 Logger.info(fn -> "Pushed to #{callback}, code #{code}" end)
288 {_post_result, response} ->
289 Instances.set_unreachable(callback)
290 Logger.debug(fn -> "Couldn't push to #{callback}, #{inspect(response)}" end)