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 import Pleroma.Web.Gettext
8 alias Calendar.Strftime
11 alias Pleroma.Conversation.Participation
12 alias Pleroma.Formatter
14 alias Pleroma.Plugs.AuthenticationPlug
17 alias Pleroma.Web.ActivityPub.Utils
18 alias Pleroma.Web.ActivityPub.Visibility
19 alias Pleroma.Web.Endpoint
20 alias Pleroma.Web.MediaProxy
23 require Pleroma.Constants
25 # This is a hack for twidere.
26 def get_by_id_or_ap_id(id) do
28 Activity.get_by_id_with_object(id) || Activity.get_create_by_object_ap_id_with_object(id)
31 if activity.data["type"] == "Create" do
34 Activity.get_create_by_object_ap_id_with_object(activity.data["object"])
38 def get_replied_to_activity(""), do: nil
40 def get_replied_to_activity(id) when not is_nil(id) do
41 Activity.get_by_id(id)
44 def get_replied_to_activity(_), do: nil
46 def attachments_from_ids(data) do
47 if Map.has_key?(data, "descriptions") do
48 attachments_from_ids_descs(data["media_ids"], data["descriptions"])
50 attachments_from_ids_no_descs(data["media_ids"])
54 def attachments_from_ids_no_descs(ids) do
55 Enum.map(ids || [], fn media_id ->
56 Repo.get(Object, media_id).data
60 def attachments_from_ids_descs(ids, descs_str) do
61 {_, descs} = Jason.decode(descs_str)
63 Enum.map(ids || [], fn media_id ->
64 Map.put(Repo.get(Object, media_id).data, "name", descs[media_id])
73 Participation.t() | nil
75 {list(String.t()), list(String.t())}
77 def get_to_and_cc(_, _, _, _, %Participation{} = participation) do
78 participation = Repo.preload(participation, :recipients)
79 {Enum.map(participation.recipients, & &1.ap_id), []}
82 def get_to_and_cc(user, mentioned_users, inReplyTo, "public", _) do
83 to = [Pleroma.Constants.as_public() | mentioned_users]
84 cc = [user.follower_address]
87 {Enum.uniq([inReplyTo.data["actor"] | to]), cc}
93 def get_to_and_cc(user, mentioned_users, inReplyTo, "unlisted", _) do
94 to = [user.follower_address | mentioned_users]
95 cc = [Pleroma.Constants.as_public()]
98 {Enum.uniq([inReplyTo.data["actor"] | to]), cc}
104 def get_to_and_cc(user, mentioned_users, inReplyTo, "private", _) do
105 {to, cc} = get_to_and_cc(user, mentioned_users, inReplyTo, "direct", nil)
106 {[user.follower_address | to], cc}
109 def get_to_and_cc(_user, mentioned_users, inReplyTo, "direct", _) do
111 {Enum.uniq([inReplyTo.data["actor"] | mentioned_users]), []}
113 {mentioned_users, []}
117 def get_to_and_cc(_user, mentions, _inReplyTo, {:list, _}, _), do: {mentions, []}
119 def get_addressed_users(_, to) when is_list(to) do
120 User.get_ap_ids_by_nicknames(to)
123 def get_addressed_users(mentioned_users, _), do: mentioned_users
125 def maybe_add_list_data(activity_params, user, {:list, list_id}) do
126 case Pleroma.List.get(list_id, user) do
127 %Pleroma.List{} = list ->
129 |> put_in([:additional, "bcc"], [list.ap_id])
130 |> put_in([:additional, "listMessage"], list.ap_id)
131 |> put_in([:object, "listMessage"], list.ap_id)
138 def maybe_add_list_data(activity_params, _, _), do: activity_params
140 def make_poll_data(%{"poll" => %{"options" => options, "expires_in" => expires_in}} = data)
141 when is_list(options) do
142 %{max_expiration: max_expiration, min_expiration: min_expiration} =
143 limits = Pleroma.Config.get([:instance, :poll_limits])
145 # XXX: There is probably a cleaner way of doing this
147 # In some cases mastofe sends out strings instead of integers
148 expires_in = if is_binary(expires_in), do: String.to_integer(expires_in), else: expires_in
150 if Enum.count(options) > limits.max_options do
151 raise ArgumentError, message: "Poll can't contain more than #{limits.max_options} options"
155 Enum.map_reduce(options, %{}, fn option, emoji ->
156 if String.length(option) > limits.max_option_chars do
159 "Poll options cannot be longer than #{limits.max_option_chars} characters each"
165 "replies" => %{"type" => "Collection", "totalItems" => 0}
166 }, Map.merge(emoji, Formatter.get_emoji_map(option))}
170 expires_in when expires_in > max_expiration ->
171 raise ArgumentError, message: "Expiration date is too far in the future"
173 expires_in when expires_in < min_expiration ->
174 raise ArgumentError, message: "Expiration date is too soon"
181 NaiveDateTime.utc_now()
182 |> NaiveDateTime.add(expires_in)
183 |> NaiveDateTime.to_iso8601()
186 if Pleroma.Web.ControllerHelper.truthy_param?(data["poll"]["multiple"]) do
187 %{"type" => "Question", "anyOf" => poll, "closed" => end_time}
189 %{"type" => "Question", "oneOf" => poll, "closed" => end_time}
194 e in ArgumentError -> e.message
198 def make_poll_data(%{"poll" => poll}) when is_map(poll) do
202 def make_poll_data(_data) do
206 def make_content_html(
212 no_attachment_links =
214 |> Map.get("no_attachment_links", Config.get([:instance, :no_attachment_links]))
215 |> Kernel.in([true, "true"])
217 content_type = get_content_type(data["content_type"])
220 if visibility == "direct" && Config.get([:instance, :safe_dm_mentions]) do
227 |> format_input(content_type, options)
228 |> maybe_add_attachments(attachments, no_attachment_links)
229 |> maybe_add_nsfw_tag(data)
232 defp get_content_type(content_type) do
233 if Enum.member?(Config.get([:instance, :allowed_post_formats]), content_type) do
240 defp maybe_add_nsfw_tag({text, mentions, tags}, %{"sensitive" => sensitive})
241 when sensitive in [true, "True", "true", "1"] do
242 {text, mentions, [{"#nsfw", "nsfw"} | tags]}
245 defp maybe_add_nsfw_tag(data, _), do: data
247 def make_context(%Activity{data: %{"context" => context}}), do: context
248 def make_context(_), do: Utils.generate_context_id()
250 def maybe_add_attachments(parsed, _attachments, true = _no_links), do: parsed
252 def maybe_add_attachments({text, mentions, tags}, attachments, _no_links) do
253 text = add_attachments(text, attachments)
254 {text, mentions, tags}
257 def add_attachments(text, attachments) do
259 Enum.map(attachments, fn
260 %{"url" => [%{"href" => href} | _]} = attachment ->
261 name = attachment["name"] || URI.decode(Path.basename(href))
262 href = MediaProxy.url(href)
263 "<a href=\"#{href}\" class='attachment'>#{shortname(name)}</a>"
269 Enum.join([text | attachment_text], "<br>")
272 def format_input(text, format, options \\ [])
275 Formatting text to plain text.
277 def format_input(text, "text/plain", options) do
279 |> Formatter.html_escape("text/plain")
280 |> Formatter.linkify(options)
281 |> (fn {text, mentions, tags} ->
282 {String.replace(text, ~r/\r?\n/, "<br>"), mentions, tags}
287 Formatting text as BBCode.
289 def format_input(text, "text/bbcode", options) do
291 |> String.replace(~r/\r/, "")
292 |> Formatter.html_escape("text/plain")
294 |> (fn {:ok, html} -> html end).()
295 |> Formatter.linkify(options)
299 Formatting text to html.
301 def format_input(text, "text/html", options) do
303 |> Formatter.html_escape("text/html")
304 |> Formatter.linkify(options)
308 Formatting text to markdown.
310 def format_input(text, "text/markdown", options) do
312 |> Formatter.mentions_escape(options)
313 |> Earmark.as_html!()
314 |> Formatter.linkify(options)
315 |> Formatter.html_escape("text/html")
335 "content" => content_html,
337 "sensitive" => !Enum.member?(["false", "False", "0", false], sensitive),
338 "context" => context,
339 "attachment" => attachments,
341 "tag" => tags |> Enum.map(fn {_, tag} -> tag end) |> Enum.uniq()
345 with false <- is_nil(in_reply_to),
346 %Object{} = in_reply_to_object <- Object.normalize(in_reply_to) do
347 Map.put(object, "inReplyTo", in_reply_to_object.data["id"])
352 Map.merge(object, merge)
355 def format_naive_asctime(date) do
356 date |> DateTime.from_naive!("Etc/UTC") |> format_asctime
359 def format_asctime(date) do
360 Strftime.strftime!(date, "%a %b %d %H:%M:%S %z %Y")
363 def date_to_asctime(date) when is_binary(date) do
364 with {:ok, date, _offset} <- DateTime.from_iso8601(date) do
368 Logger.warn("Date #{date} in wrong format, must be ISO 8601")
373 def date_to_asctime(date) do
374 Logger.warn("Date #{date} in wrong format, must be ISO 8601")
378 def to_masto_date(%NaiveDateTime{} = date) do
380 |> NaiveDateTime.to_iso8601()
381 |> String.replace(~r/(\.\d+)?$/, ".000Z", global: false)
384 def to_masto_date(date) do
387 |> NaiveDateTime.from_iso8601!()
388 |> NaiveDateTime.to_iso8601()
389 |> String.replace(~r/(\.\d+)?$/, ".000Z", global: false)
395 defp shortname(name) do
396 if String.length(name) < 30 do
399 String.slice(name, 0..30) <> "…"
403 def confirm_current_password(user, password) do
404 with %User{local: true} = db_user <- User.get_cached_by_id(user.id),
405 true <- AuthenticationPlug.checkpw(password, db_user.password_hash) do
408 _ -> {:error, dgettext("errors", "Invalid password.")}
412 def emoji_from_profile(%{info: _info} = user) do
413 (Formatter.get_emoji(user.bio) ++ Formatter.get_emoji(user.name))
414 |> Enum.map(fn {shortcode, url, _} ->
417 "icon" => %{"type" => "Image", "url" => "#{Endpoint.url()}#{url}"},
418 "name" => ":#{shortcode}:"
423 def maybe_notify_to_recipients(
425 %Activity{data: %{"to" => to, "type" => _type}} = _activity
430 def maybe_notify_mentioned_recipients(
432 %Activity{data: %{"to" => _to, "type" => type} = data} = activity
434 when type == "Create" do
435 object = Object.normalize(activity)
442 is_map(data["object"]) ->
449 tagged_mentions = maybe_extract_mentions(object_data)
451 recipients ++ tagged_mentions
454 def maybe_notify_mentioned_recipients(recipients, _), do: recipients
456 # Do not notify subscribers if author is making a reply
457 def maybe_notify_subscribers(recipients, %Activity{
458 object: %Object{data: %{"inReplyTo" => _ap_id}}
463 def maybe_notify_subscribers(
465 %Activity{data: %{"actor" => actor, "type" => type}} = activity
467 when type == "Create" do
468 with %User{} = user <- User.get_cached_by_ap_id(actor) do
471 |> User.subscribers()
472 |> Enum.filter(&Visibility.visible_for_user?(activity, &1))
473 |> Enum.map(& &1.ap_id)
475 recipients ++ subscriber_ids
479 def maybe_notify_subscribers(recipients, _), do: recipients
481 def maybe_extract_mentions(%{"tag" => tag}) do
483 |> Enum.filter(fn x -> is_map(x) end)
484 |> Enum.filter(fn x -> x["type"] == "Mention" end)
485 |> Enum.map(fn x -> x["href"] end)
488 def maybe_extract_mentions(_), do: []
490 def make_report_content_html(nil), do: {:ok, {nil, [], []}}
492 def make_report_content_html(comment) do
493 max_size = Pleroma.Config.get([:instance, :max_report_comment_size], 1000)
495 if String.length(comment) <= max_size do
496 {:ok, format_input(comment, "text/plain")}
499 dgettext("errors", "Comment must be up to %{max_size} characters", max_size: max_size)}
503 def get_report_statuses(%User{ap_id: actor}, %{"status_ids" => status_ids}) do
504 {:ok, Activity.all_by_actor_and_id(actor, status_ids)}
507 def get_report_statuses(_, _), do: {:ok, nil}
509 # DEPRECATED mostly, context objects are now created at insertion time.
510 def context_to_conversation_id(context) do
511 with %Object{id: id} <- Object.get_cached_by_ap_id(context) do
515 changeset = Object.context_mapping(context)
517 case Repo.insert(changeset) do
521 # This should be solved by an upsert, but it seems ecto
522 # has problems accessing the constraint inside the jsonb.
524 Object.get_cached_by_ap_id(context).id
529 def conversation_id_to_context(id) do
530 with %Object{data: %{"id" => context}} <- Repo.get(Object, id) do
534 {:error, dgettext("errors", "No such conversation")}
538 def make_answer_data(%User{ap_id: ap_id}, object, name) do
542 "cc" => [object.data["actor"]],
545 "inReplyTo" => object.data["id"]
549 def validate_character_limit(full_payload, attachments, limit) do
550 length = String.length(full_payload)
553 if length > 0 or Enum.count(attachments) > 0 do
556 {:error, dgettext("errors", "Cannot post an empty status without attachments")}
559 {:error, dgettext("errors", "The status is over the character limit")}