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
7 alias Pleroma.Instances
9 alias Pleroma.Web.Websub.WebsubServerSubscription
10 alias Pleroma.Web.Websub.WebsubClientSubscription
11 alias Pleroma.Web.OStatus.FeedRepresenter
13 alias Pleroma.Web.Endpoint
14 alias Pleroma.Web.OStatus
15 alias Pleroma.Web.Router.Helpers
20 @httpoison Application.get_env(:pleroma, :httpoison)
22 def verify(subscription, getter \\ &@httpoison.get/3) do
23 challenge = Base.encode16(:crypto.strong_rand_bytes(8))
24 lease_seconds = NaiveDateTime.diff(subscription.valid_until, subscription.updated_at)
25 lease_seconds = lease_seconds |> to_string
28 "hub.challenge": challenge,
29 "hub.lease_seconds": lease_seconds,
30 "hub.topic": subscription.topic,
31 "hub.mode": "subscribe"
34 url = hd(String.split(subscription.callback, "?"))
35 query = URI.parse(subscription.callback).query || ""
36 params = Map.merge(params, URI.decode_query(query))
38 with {:ok, response} <- getter.(url, [], params: params),
39 ^challenge <- response.body do
40 changeset = Changeset.change(subscription, %{state: "active"})
41 Repo.update(changeset)
44 Logger.debug("Couldn't verify subscription")
45 Logger.debug(inspect(e))
46 {:error, subscription}
50 @supported_activities [
58 def publish(topic, user, %{data: %{"type" => type}} = activity)
59 when type in @supported_activities do
62 |> FeedRepresenter.to_simple_form([activity], [user])
63 |> :xmerl.export_simple(:xmerl_xml)
68 sub in WebsubServerSubscription,
69 where: sub.topic == ^topic and sub.state == "active",
70 where: fragment("? > (NOW() at time zone 'UTC')", sub.valid_until)
73 subscriptions = Repo.all(query)
75 callbacks = Enum.map(subscriptions, & &1.callback)
76 reachable_callbacks_metadata = Instances.filter_reachable(callbacks)
77 reachable_callbacks = Map.keys(reachable_callbacks_metadata)
80 |> Enum.filter(&(&1.callback in reachable_callbacks))
81 |> Enum.each(fn sub ->
85 callback: sub.callback,
87 unreachable_since: reachable_callbacks_metadata[sub.callback]
90 Pleroma.Web.Federator.enqueue(:publish_single_websub, data)
94 def publish(_, _, _), do: ""
96 def sign(secret, doc) do
97 :crypto.hmac(:sha, secret, to_string(doc)) |> Base.encode16() |> String.downcase()
100 def incoming_subscription_request(user, %{"hub.mode" => "subscribe"} = params) do
101 with {:ok, topic} <- valid_topic(params, user),
102 {:ok, lease_time} <- lease_time(params),
103 secret <- params["hub.secret"],
104 callback <- params["hub.callback"] do
105 subscription = get_subscription(topic, callback)
108 state: subscription.state || "requested",
114 change = Changeset.change(subscription, data)
115 websub = Repo.insert_or_update!(change)
118 Changeset.change(websub, %{valid_until: NaiveDateTime.add(websub.updated_at, lease_time)})
120 websub = Repo.update!(change)
122 Pleroma.Web.Federator.enqueue(:verify_websub, websub)
127 Logger.debug("Couldn't create subscription")
128 Logger.debug(inspect(reason))
134 def incoming_subscription_request(user, params) do
135 Logger.info("Unhandled WebSub request for #{user.nickname}: #{inspect(params)}")
137 {:error, "Invalid WebSub request"}
140 defp get_subscription(topic, callback) do
141 Repo.get_by(WebsubServerSubscription, topic: topic, callback: callback) ||
142 %WebsubServerSubscription{}
145 # Temp hack for mastodon.
146 defp lease_time(%{"hub.lease_seconds" => ""}) do
148 {:ok, 60 * 60 * 24 * 3}
151 defp lease_time(%{"hub.lease_seconds" => lease_seconds}) do
152 {:ok, String.to_integer(lease_seconds)}
155 defp lease_time(_) do
157 {:ok, 60 * 60 * 24 * 3}
160 defp valid_topic(%{"hub.topic" => topic}, user) do
161 if topic == OStatus.feed_path(user) do
162 {:ok, OStatus.feed_path(user)}
164 {:error, "Wrong topic requested, expected #{OStatus.feed_path(user)}, got #{topic}"}
168 def subscribe(subscriber, subscribed, requester \\ &request_subscription/1) do
169 topic = subscribed.info.topic
170 # FIXME: Race condition, use transactions
171 {:ok, subscription} =
172 with subscription when not is_nil(subscription) <-
173 Repo.get_by(WebsubClientSubscription, topic: topic) do
174 subscribers = [subscriber.ap_id | subscription.subscribers] |> Enum.uniq()
175 change = Ecto.Changeset.change(subscription, %{subscribers: subscribers})
179 subscription = %WebsubClientSubscription{
181 hub: subscribed.info.hub,
182 subscribers: [subscriber.ap_id],
184 secret: :crypto.strong_rand_bytes(8) |> Base.url_encode64(),
188 Repo.insert(subscription)
191 requester.(subscription)
194 def gather_feed_data(topic, getter \\ &@httpoison.get/1) do
195 with {:ok, response} <- getter.(topic),
196 status when status in 200..299 <- response.status,
197 body <- response.body,
198 doc <- XML.parse_document(body),
199 uri when not is_nil(uri) <- XML.string_from_xpath("/feed/author[1]/uri", doc),
200 hub when not is_nil(hub) <- XML.string_from_xpath(~S{/feed/link[@rel="hub"]/@href}, doc) do
201 name = XML.string_from_xpath("/feed/author[1]/name", doc)
202 preferredUsername = XML.string_from_xpath("/feed/author[1]/poco:preferredUsername", doc)
203 displayName = XML.string_from_xpath("/feed/author[1]/poco:displayName", doc)
204 avatar = OStatus.make_avatar_object(doc)
205 bio = XML.string_from_xpath("/feed/author[1]/summary", doc)
211 "nickname" => preferredUsername || name,
212 "name" => displayName || name,
213 "host" => URI.parse(uri).host,
223 def request_subscription(websub, poster \\ &@httpoison.post/3, timeout \\ 10_000) do
225 "hub.mode": "subscribe",
226 "hub.topic": websub.topic,
227 "hub.secret": websub.secret,
228 "hub.callback": Helpers.websub_url(Endpoint, :websub_subscription_confirmation, websub.id)
231 # This checks once a second if we are confirmed yet
232 websub_checker = fn ->
233 helper = fn helper ->
235 websub = Repo.get_by(WebsubClientSubscription, id: websub.id, state: "accepted")
236 if websub, do: websub, else: helper.(helper)
242 task = Task.async(websub_checker)
244 with {:ok, %{status: 202}} <-
245 poster.(websub.hub, {:form, data}, "Content-type": "application/x-www-form-urlencoded"),
246 {:ok, websub} <- Task.yield(task, timeout) do
252 change = Ecto.Changeset.change(websub, %{state: "rejected"})
253 {:ok, websub} = Repo.update(change)
255 Logger.debug(fn -> "Couldn't confirm subscription: #{inspect(websub)}" end)
256 Logger.debug(fn -> "error: #{inspect(e)}" end)
262 def refresh_subscriptions(delta \\ 60 * 60 * 24) do
263 Logger.debug("Refreshing subscriptions")
265 cut_off = NaiveDateTime.add(NaiveDateTime.utc_now(), delta)
267 query = from(sub in WebsubClientSubscription, where: sub.valid_until < ^cut_off)
269 subs = Repo.all(query)
271 Enum.each(subs, fn sub ->
272 Pleroma.Web.Federator.enqueue(:request_subscription, sub)
276 def publish_one(%{xml: xml, topic: topic, callback: callback, secret: secret} = params) do
277 signature = sign(secret || "", xml)
278 Logger.info(fn -> "Pushing #{topic} to #{callback}" end)
280 with {:ok, %{status: code}} when code in 200..299 <-
285 {"Content-Type", "application/atom+xml"},
286 {"X-Hub-Signature", "sha1=#{signature}"}
289 if !Map.has_key?(params, :unreachable_since) || params[:unreachable_since],
290 do: Instances.set_reachable(callback)
292 Logger.info(fn -> "Pushed to #{callback}, code #{code}" end)
295 {_post_result, response} ->
296 unless params[:unreachable_since], do: Instances.set_reachable(callback)
297 Logger.debug(fn -> "Couldn't push to #{callback}, #{inspect(response)}" end)