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.Formatter
13 alias Pleroma.Plugs.AuthenticationPlug
16 alias Pleroma.Web.ActivityPub.Utils
17 alias Pleroma.Web.ActivityPub.Visibility
18 alias Pleroma.Web.Endpoint
19 alias Pleroma.Web.MediaProxy
23 # This is a hack for twidere.
24 def get_by_id_or_ap_id(id) do
26 Activity.get_by_id_with_object(id) || Activity.get_create_by_object_ap_id_with_object(id)
29 if activity.data["type"] == "Create" do
32 Activity.get_create_by_object_ap_id_with_object(activity.data["object"])
36 def get_replied_to_activity(""), do: nil
38 def get_replied_to_activity(id) when not is_nil(id) do
39 Activity.get_by_id(id)
42 def get_replied_to_activity(_), do: nil
44 def attachments_from_ids(data) do
45 if Map.has_key?(data, "descriptions") do
46 attachments_from_ids_descs(data["media_ids"], data["descriptions"])
48 attachments_from_ids_no_descs(data["media_ids"])
52 def attachments_from_ids_no_descs(ids) do
53 Enum.map(ids || [], fn media_id ->
54 Repo.get(Object, media_id).data
58 def attachments_from_ids_descs(ids, descs_str) do
59 {_, descs} = Jason.decode(descs_str)
61 Enum.map(ids || [], fn media_id ->
62 Map.put(Repo.get(Object, media_id).data, "name", descs[media_id])
66 @spec get_to_and_cc(User.t(), list(String.t()), Activity.t() | nil, String.t()) ::
67 {list(String.t()), list(String.t())}
68 def get_to_and_cc(user, mentioned_users, inReplyTo, "public") do
69 to = ["https://www.w3.org/ns/activitystreams#Public" | mentioned_users]
70 cc = [user.follower_address]
73 {Enum.uniq([inReplyTo.data["actor"] | to]), cc}
79 def get_to_and_cc(user, mentioned_users, inReplyTo, "unlisted") do
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 get_to_and_cc(user, mentioned_users, inReplyTo, "private") do
91 {to, cc} = get_to_and_cc(user, mentioned_users, inReplyTo, "direct")
92 {[user.follower_address | to], cc}
95 def get_to_and_cc(_user, mentioned_users, inReplyTo, "direct") do
97 {Enum.uniq([inReplyTo.data["actor"] | mentioned_users]), []}
103 def get_addressed_users(_, to) when is_list(to) do
104 User.get_ap_ids_by_nicknames(to)
107 def get_addressed_users(mentioned_users, _), do: mentioned_users
109 def make_poll_data(%{"poll" => %{"options" => options, "expires_in" => expires_in}} = data)
110 when is_list(options) do
111 %{max_expiration: max_expiration, min_expiration: min_expiration} =
112 limits = Pleroma.Config.get([:instance, :poll_limits])
114 # XXX: There is probably a cleaner way of doing this
116 # In some cases mastofe sends out strings instead of integers
117 expires_in = if is_binary(expires_in), do: String.to_integer(expires_in), else: expires_in
119 if Enum.count(options) > limits.max_options do
120 raise ArgumentError, message: "Poll can't contain more than #{limits.max_options} options"
124 Enum.map_reduce(options, %{}, fn option, emoji ->
125 if String.length(option) > limits.max_option_chars do
128 "Poll options cannot be longer than #{limits.max_option_chars} characters each"
134 "replies" => %{"type" => "Collection", "totalItems" => 0}
135 }, Map.merge(emoji, Formatter.get_emoji_map(option))}
139 expires_in when expires_in > max_expiration ->
140 raise ArgumentError, message: "Expiration date is too far in the future"
142 expires_in when expires_in < min_expiration ->
143 raise ArgumentError, message: "Expiration date is too soon"
150 NaiveDateTime.utc_now()
151 |> NaiveDateTime.add(expires_in)
152 |> NaiveDateTime.to_iso8601()
155 if Pleroma.Web.ControllerHelper.truthy_param?(data["poll"]["multiple"]) do
156 %{"type" => "Question", "anyOf" => poll, "closed" => end_time}
158 %{"type" => "Question", "oneOf" => poll, "closed" => end_time}
163 e in ArgumentError -> e.message
167 def make_poll_data(%{"poll" => poll}) when is_map(poll) do
171 def make_poll_data(_data) do
175 def make_content_html(
181 no_attachment_links =
183 |> Map.get("no_attachment_links", Config.get([:instance, :no_attachment_links]))
184 |> Kernel.in([true, "true"])
186 content_type = get_content_type(data["content_type"])
189 if visibility == "direct" && Config.get([:instance, :safe_dm_mentions]) do
196 |> format_input(content_type, options)
197 |> maybe_add_attachments(attachments, no_attachment_links)
198 |> maybe_add_nsfw_tag(data)
201 defp get_content_type(content_type) do
202 if Enum.member?(Config.get([:instance, :allowed_post_formats]), content_type) do
209 defp maybe_add_nsfw_tag({text, mentions, tags}, %{"sensitive" => sensitive})
210 when sensitive in [true, "True", "true", "1"] do
211 {text, mentions, [{"#nsfw", "nsfw"} | tags]}
214 defp maybe_add_nsfw_tag(data, _), do: data
216 def make_context(%Activity{data: %{"context" => context}}), do: context
217 def make_context(_), do: Utils.generate_context_id()
219 def maybe_add_attachments(parsed, _attachments, true = _no_links), do: parsed
221 def maybe_add_attachments({text, mentions, tags}, attachments, _no_links) do
222 text = add_attachments(text, attachments)
223 {text, mentions, tags}
226 def add_attachments(text, attachments) do
228 Enum.map(attachments, fn
229 %{"url" => [%{"href" => href} | _]} = attachment ->
230 name = attachment["name"] || URI.decode(Path.basename(href))
231 href = MediaProxy.url(href)
232 "<a href=\"#{href}\" class='attachment'>#{shortname(name)}</a>"
238 Enum.join([text | attachment_text], "<br>")
241 def format_input(text, format, options \\ [])
244 Formatting text to plain text.
246 def format_input(text, "text/plain", options) do
248 |> Formatter.html_escape("text/plain")
249 |> Formatter.linkify(options)
250 |> (fn {text, mentions, tags} ->
251 {String.replace(text, ~r/\r?\n/, "<br>"), mentions, tags}
256 Formatting text as BBCode.
258 def format_input(text, "text/bbcode", options) do
260 |> String.replace(~r/\r/, "")
261 |> Formatter.html_escape("text/plain")
263 |> (fn {:ok, html} -> html end).()
264 |> Formatter.linkify(options)
268 Formatting text to html.
270 def format_input(text, "text/html", options) do
272 |> Formatter.html_escape("text/html")
273 |> Formatter.linkify(options)
277 Formatting text to markdown.
279 def format_input(text, "text/markdown", options) do
281 |> Formatter.mentions_escape(options)
282 |> Earmark.as_html!()
283 |> Formatter.linkify(options)
284 |> Formatter.html_escape("text/html")
304 "content" => content_html,
306 "sensitive" => !Enum.member?(["false", "False", "0", false], sensitive),
307 "context" => context,
308 "attachment" => attachments,
310 "tag" => tags |> Enum.map(fn {_, tag} -> tag end) |> Enum.uniq()
314 with false <- is_nil(in_reply_to),
315 %Object{} = in_reply_to_object <- Object.normalize(in_reply_to) do
316 Map.put(object, "inReplyTo", in_reply_to_object.data["id"])
321 Map.merge(object, merge)
324 def format_naive_asctime(date) do
325 date |> DateTime.from_naive!("Etc/UTC") |> format_asctime
328 def format_asctime(date) do
329 Strftime.strftime!(date, "%a %b %d %H:%M:%S %z %Y")
332 def date_to_asctime(date) when is_binary(date) do
333 with {:ok, date, _offset} <- DateTime.from_iso8601(date) do
337 Logger.warn("Date #{date} in wrong format, must be ISO 8601")
342 def date_to_asctime(date) do
343 Logger.warn("Date #{date} in wrong format, must be ISO 8601")
347 def to_masto_date(%NaiveDateTime{} = date) do
349 |> NaiveDateTime.to_iso8601()
350 |> String.replace(~r/(\.\d+)?$/, ".000Z", global: false)
353 def to_masto_date(date) do
356 |> NaiveDateTime.from_iso8601!()
357 |> NaiveDateTime.to_iso8601()
358 |> String.replace(~r/(\.\d+)?$/, ".000Z", global: false)
364 defp shortname(name) do
365 if String.length(name) < 30 do
368 String.slice(name, 0..30) <> "…"
372 def confirm_current_password(user, password) do
373 with %User{local: true} = db_user <- User.get_cached_by_id(user.id),
374 true <- AuthenticationPlug.checkpw(password, db_user.password_hash) do
377 _ -> {:error, dgettext("errors", "Invalid password.")}
381 def emoji_from_profile(%{info: _info} = user) do
382 (Formatter.get_emoji(user.bio) ++ Formatter.get_emoji(user.name))
383 |> Enum.map(fn {shortcode, url, _} ->
386 "icon" => %{"type" => "Image", "url" => "#{Endpoint.url()}#{url}"},
387 "name" => ":#{shortcode}:"
392 def maybe_notify_to_recipients(
394 %Activity{data: %{"to" => to, "type" => _type}} = _activity
399 def maybe_notify_mentioned_recipients(
401 %Activity{data: %{"to" => _to, "type" => type} = data} = activity
403 when type == "Create" do
404 object = Object.normalize(activity)
411 is_map(data["object"]) ->
418 tagged_mentions = maybe_extract_mentions(object_data)
420 recipients ++ tagged_mentions
423 def maybe_notify_mentioned_recipients(recipients, _), do: recipients
425 def maybe_notify_subscribers(
427 %Activity{data: %{"actor" => actor, "type" => type}} = activity
429 when type == "Create" do
430 with %User{} = user <- User.get_cached_by_ap_id(actor) do
433 |> User.subscribers()
434 |> Enum.filter(&Visibility.visible_for_user?(activity, &1))
435 |> Enum.map(& &1.ap_id)
437 recipients ++ subscriber_ids
441 def maybe_notify_subscribers(recipients, _), do: recipients
443 def maybe_extract_mentions(%{"tag" => tag}) do
445 |> Enum.filter(fn x -> is_map(x) end)
446 |> Enum.filter(fn x -> x["type"] == "Mention" end)
447 |> Enum.map(fn x -> x["href"] end)
450 def maybe_extract_mentions(_), do: []
452 def make_report_content_html(nil), do: {:ok, {nil, [], []}}
454 def make_report_content_html(comment) do
455 max_size = Pleroma.Config.get([:instance, :max_report_comment_size], 1000)
457 if String.length(comment) <= max_size do
458 {:ok, format_input(comment, "text/plain")}
461 dgettext("errors", "Comment must be up to %{max_size} characters", max_size: max_size)}
465 def get_report_statuses(%User{ap_id: actor}, %{"status_ids" => status_ids}) do
466 {:ok, Activity.all_by_actor_and_id(actor, status_ids)}
469 def get_report_statuses(_, _), do: {:ok, nil}
471 # DEPRECATED mostly, context objects are now created at insertion time.
472 def context_to_conversation_id(context) do
473 with %Object{id: id} <- Object.get_cached_by_ap_id(context) do
477 changeset = Object.context_mapping(context)
479 case Repo.insert(changeset) do
483 # This should be solved by an upsert, but it seems ecto
484 # has problems accessing the constraint inside the jsonb.
486 Object.get_cached_by_ap_id(context).id
491 def conversation_id_to_context(id) do
492 with %Object{data: %{"id" => context}} <- Repo.get(Object, id) do
496 {:error, dgettext("errors", "No such conversation")}
500 def make_answer_data(%User{ap_id: ap_id}, object, name) do
504 "cc" => [object.data["actor"]],
507 "inReplyTo" => object.data["id"]
511 def validate_character_limit(full_payload, attachments, limit) do
512 length = String.length(full_payload)
515 if length > 0 or Enum.count(attachments) > 0 do
518 {:error, dgettext("errors", "Cannot post an empty status without attachments")}
521 {:error, dgettext("errors", "The status is over the character limit")}