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.CommonAPI.Utils do
6 alias Calendar.Strftime
10 alias Pleroma.Formatter
14 alias Pleroma.Web.ActivityPub.Utils
15 alias Pleroma.Web.ActivityPub.Visibility
16 alias Pleroma.Web.Endpoint
17 alias Pleroma.Web.MediaProxy
21 # This is a hack for twidere.
22 def get_by_id_or_ap_id(id) do
24 Activity.get_by_id_with_object(id) || Activity.get_create_by_object_ap_id_with_object(id)
27 if activity.data["type"] == "Create" do
30 Activity.get_create_by_object_ap_id_with_object(activity.data["object"])
34 def get_replied_to_activity(""), do: nil
36 def get_replied_to_activity(id) when not is_nil(id) do
37 Activity.get_by_id(id)
40 def get_replied_to_activity(_), do: nil
42 def attachments_from_ids(data) do
43 if Map.has_key?(data, "descriptions") do
44 attachments_from_ids_descs(data["media_ids"], data["descriptions"])
46 attachments_from_ids_no_descs(data["media_ids"])
50 def attachments_from_ids_no_descs(ids) do
51 Enum.map(ids || [], fn media_id ->
52 Repo.get(Object, media_id).data
56 def attachments_from_ids_descs(ids, descs_str) do
57 {_, descs} = Jason.decode(descs_str)
59 Enum.map(ids || [], fn media_id ->
60 Map.put(Repo.get(Object, media_id).data, "name", descs[media_id])
64 def to_for_user_and_mentions(user, mentions, inReplyTo, "public") do
65 mentioned_users = Enum.map(mentions, fn {_, %{ap_id: ap_id}} -> ap_id end)
67 to = ["https://www.w3.org/ns/activitystreams#Public" | mentioned_users]
68 cc = [user.follower_address]
71 {Enum.uniq([inReplyTo.data["actor"] | to]), cc}
77 def to_for_user_and_mentions(user, mentions, inReplyTo, "unlisted") do
78 mentioned_users = Enum.map(mentions, fn {_, %{ap_id: ap_id}} -> ap_id end)
80 to = [user.follower_address | mentioned_users]
81 cc = ["https://www.w3.org/ns/activitystreams#Public"]
84 {Enum.uniq([inReplyTo.data["actor"] | to]), cc}
90 def to_for_user_and_mentions(user, mentions, inReplyTo, "private") do
91 {to, cc} = to_for_user_and_mentions(user, mentions, inReplyTo, "direct")
92 {[user.follower_address | to], cc}
95 def to_for_user_and_mentions(_user, mentions, inReplyTo, "direct") do
96 mentioned_users = Enum.map(mentions, fn {_, %{ap_id: ap_id}} -> ap_id end)
99 {Enum.uniq([inReplyTo.data["actor"] | mentioned_users]), []}
101 {mentioned_users, []}
105 def make_poll_data(%{"poll" => %{"options" => options, "expires_in" => expires_in}} = data)
106 when is_list(options) and is_integer(expires_in) do
107 %{max_expiration: max_expiration, min_expiration: min_expiration} =
108 limits = Pleroma.Config.get([:instance, :poll_limits])
110 # XXX: There is probably a cleaner way of doing this
112 if Enum.count(options) > limits.max_options do
113 raise ArgumentError, message: "Poll can't contain more than #{limits.max_options} options"
117 Enum.map_reduce(options, %{}, fn option, emoji ->
118 if String.length(option) > limits.max_option_chars do
121 "Poll options cannot be longer than #{limits.max_option_chars} characters each"
127 "replies" => %{"type" => "Collection", "totalItems" => 0}
128 }, Map.merge(emoji, Formatter.get_emoji_map(option))}
132 expires_in when expires_in > max_expiration ->
133 raise ArgumentError, message: "Expiration date is too far in the future"
135 expires_in when expires_in < min_expiration ->
136 raise ArgumentError, message: "Expiration date is too soon"
143 NaiveDateTime.utc_now()
144 |> NaiveDateTime.add(expires_in)
145 |> NaiveDateTime.to_iso8601()
148 if Pleroma.Web.ControllerHelper.truthy_param?(data["poll"]["multiple"]) do
149 %{"type" => "Question", "anyOf" => poll, "closed" => end_time}
151 %{"type" => "Question", "oneOf" => poll, "closed" => end_time}
156 e in ArgumentError -> e.message
160 def make_poll_data(%{"poll" => poll}) when is_map(poll) do
164 def make_poll_data(_data) do
168 def make_content_html(
174 no_attachment_links =
176 |> Map.get("no_attachment_links", Config.get([:instance, :no_attachment_links]))
177 |> Kernel.in([true, "true"])
179 content_type = get_content_type(data["content_type"])
182 if visibility == "direct" && Config.get([:instance, :safe_dm_mentions]) do
189 |> format_input(content_type, options)
190 |> maybe_add_attachments(attachments, no_attachment_links)
191 |> maybe_add_nsfw_tag(data)
194 defp get_content_type(content_type) do
195 if Enum.member?(Config.get([:instance, :allowed_post_formats]), content_type) do
202 defp maybe_add_nsfw_tag({text, mentions, tags}, %{"sensitive" => sensitive})
203 when sensitive in [true, "True", "true", "1"] do
204 {text, mentions, [{"#nsfw", "nsfw"} | tags]}
207 defp maybe_add_nsfw_tag(data, _), do: data
209 def make_context(%Activity{data: %{"context" => context}}), do: context
210 def make_context(_), do: Utils.generate_context_id()
212 def maybe_add_attachments(parsed, _attachments, true = _no_links), do: parsed
214 def maybe_add_attachments({text, mentions, tags}, attachments, _no_links) do
215 text = add_attachments(text, attachments)
216 {text, mentions, tags}
219 def add_attachments(text, attachments) do
221 Enum.map(attachments, fn
222 %{"url" => [%{"href" => href} | _]} = attachment ->
223 name = attachment["name"] || URI.decode(Path.basename(href))
224 href = MediaProxy.url(href)
225 "<a href=\"#{href}\" class='attachment'>#{shortname(name)}</a>"
231 Enum.join([text | attachment_text], "<br>")
234 def format_input(text, format, options \\ [])
237 Formatting text to plain text.
239 def format_input(text, "text/plain", options) do
241 |> Formatter.html_escape("text/plain")
242 |> Formatter.linkify(options)
243 |> (fn {text, mentions, tags} ->
244 {String.replace(text, ~r/\r?\n/, "<br>"), mentions, tags}
249 Formatting text as BBCode.
251 def format_input(text, "text/bbcode", options) do
253 |> String.replace(~r/\r/, "")
254 |> Formatter.html_escape("text/plain")
256 |> (fn {:ok, html} -> html end).()
257 |> Formatter.linkify(options)
261 Formatting text to html.
263 def format_input(text, "text/html", options) do
265 |> Formatter.html_escape("text/html")
266 |> Formatter.linkify(options)
270 Formatting text to markdown.
272 def format_input(text, "text/markdown", options) do
274 |> Formatter.mentions_escape(options)
275 |> Earmark.as_html!()
276 |> Formatter.linkify(options)
277 |> Formatter.html_escape("text/html")
297 "content" => content_html,
299 "sensitive" => !Enum.member?(["false", "False", "0", false], sensitive),
300 "context" => context,
301 "attachment" => attachments,
303 "tag" => tags |> Enum.map(fn {_, tag} -> tag end) |> Enum.uniq()
307 with false <- is_nil(in_reply_to),
308 %Object{} = in_reply_to_object <- Object.normalize(in_reply_to) do
309 Map.put(object, "inReplyTo", in_reply_to_object.data["id"])
314 Map.merge(object, merge)
317 def format_naive_asctime(date) do
318 date |> DateTime.from_naive!("Etc/UTC") |> format_asctime
321 def format_asctime(date) do
322 Strftime.strftime!(date, "%a %b %d %H:%M:%S %z %Y")
325 def date_to_asctime(date) when is_binary(date) do
326 with {:ok, date, _offset} <- DateTime.from_iso8601(date) do
330 Logger.warn("Date #{date} in wrong format, must be ISO 8601")
335 def date_to_asctime(date) do
336 Logger.warn("Date #{date} in wrong format, must be ISO 8601")
340 def to_masto_date(%NaiveDateTime{} = date) do
342 |> NaiveDateTime.to_iso8601()
343 |> String.replace(~r/(\.\d+)?$/, ".000Z", global: false)
346 def to_masto_date(date) do
349 |> NaiveDateTime.from_iso8601!()
350 |> NaiveDateTime.to_iso8601()
351 |> String.replace(~r/(\.\d+)?$/, ".000Z", global: false)
357 defp shortname(name) do
358 if String.length(name) < 30 do
361 String.slice(name, 0..30) <> "…"
365 def confirm_current_password(user, password) do
366 with %User{local: true} = db_user <- User.get_cached_by_id(user.id),
367 true <- Pbkdf2.checkpw(password, db_user.password_hash) do
370 _ -> {:error, "Invalid password."}
374 def emoji_from_profile(%{info: _info} = user) do
375 (Formatter.get_emoji(user.bio) ++ Formatter.get_emoji(user.name))
376 |> Enum.map(fn {shortcode, url, _} ->
379 "icon" => %{"type" => "Image", "url" => "#{Endpoint.url()}#{url}"},
380 "name" => ":#{shortcode}:"
385 def maybe_notify_to_recipients(
387 %Activity{data: %{"to" => to, "type" => _type}} = _activity
392 def maybe_notify_mentioned_recipients(
394 %Activity{data: %{"to" => _to, "type" => type} = data} = activity
396 when type == "Create" do
397 object = Object.normalize(activity)
404 is_map(data["object"]) ->
411 tagged_mentions = maybe_extract_mentions(object_data)
413 recipients ++ tagged_mentions
416 def maybe_notify_mentioned_recipients(recipients, _), do: recipients
418 def maybe_notify_subscribers(
420 %Activity{data: %{"actor" => actor, "type" => type}} = activity
422 when type == "Create" do
423 with %User{} = user <- User.get_cached_by_ap_id(actor) do
426 |> User.subscribers()
427 |> Enum.filter(&Visibility.visible_for_user?(activity, &1))
428 |> Enum.map(& &1.ap_id)
430 recipients ++ subscriber_ids
434 def maybe_notify_subscribers(recipients, _), do: recipients
436 def maybe_extract_mentions(%{"tag" => tag}) do
438 |> Enum.filter(fn x -> is_map(x) end)
439 |> Enum.filter(fn x -> x["type"] == "Mention" end)
440 |> Enum.map(fn x -> x["href"] end)
443 def maybe_extract_mentions(_), do: []
445 def make_report_content_html(nil), do: {:ok, {nil, [], []}}
447 def make_report_content_html(comment) do
448 max_size = Pleroma.Config.get([:instance, :max_report_comment_size], 1000)
450 if String.length(comment) <= max_size do
451 {:ok, format_input(comment, "text/plain")}
453 {:error, "Comment must be up to #{max_size} characters"}
457 def get_report_statuses(%User{ap_id: actor}, %{"status_ids" => status_ids}) do
458 {:ok, Activity.all_by_actor_and_id(actor, status_ids)}
461 def get_report_statuses(_, _), do: {:ok, nil}
463 # DEPRECATED mostly, context objects are now created at insertion time.
464 def context_to_conversation_id(context) do
465 with %Object{id: id} <- Object.get_cached_by_ap_id(context) do
469 changeset = Object.context_mapping(context)
471 case Repo.insert(changeset) do
475 # This should be solved by an upsert, but it seems ecto
476 # has problems accessing the constraint inside the jsonb.
478 Object.get_cached_by_ap_id(context).id
483 def conversation_id_to_context(id) do
484 with %Object{data: %{"id" => context}} <- Repo.get(Object, id) do
488 {:error, "No such conversation"}