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
108 Enum.map_reduce(options, %{}, fn option, emoji ->
112 "replies" => %{"type" => "Collection", "totalItems" => 0}
113 }, Map.merge(emoji, Formatter.get_emoji_map(option))}
117 NaiveDateTime.utc_now()
118 |> NaiveDateTime.add(expires_in)
119 |> NaiveDateTime.to_iso8601()
122 if Pleroma.Web.ControllerHelper.truthy_param?(data["poll"]["multiple"]) do
123 %{"type" => "Question", "anyOf" => poll, "closed" => end_time}
125 %{"type" => "Question", "oneOf" => poll, "closed" => end_time}
131 def make_poll_data(_data) do
135 def make_content_html(
141 no_attachment_links =
143 |> Map.get("no_attachment_links", Config.get([:instance, :no_attachment_links]))
144 |> Kernel.in([true, "true"])
146 content_type = get_content_type(data["content_type"])
149 if visibility == "direct" && Config.get([:instance, :safe_dm_mentions]) do
156 |> format_input(content_type, options)
157 |> maybe_add_attachments(attachments, no_attachment_links)
158 |> maybe_add_nsfw_tag(data)
161 defp get_content_type(content_type) do
162 if Enum.member?(Config.get([:instance, :allowed_post_formats]), content_type) do
169 defp maybe_add_nsfw_tag({text, mentions, tags}, %{"sensitive" => sensitive})
170 when sensitive in [true, "True", "true", "1"] do
171 {text, mentions, [{"#nsfw", "nsfw"} | tags]}
174 defp maybe_add_nsfw_tag(data, _), do: data
176 def make_context(%Activity{data: %{"context" => context}}), do: context
177 def make_context(_), do: Utils.generate_context_id()
179 def maybe_add_attachments(parsed, _attachments, true = _no_links), do: parsed
181 def maybe_add_attachments({text, mentions, tags}, attachments, _no_links) do
182 text = add_attachments(text, attachments)
183 {text, mentions, tags}
186 def add_attachments(text, attachments) do
188 Enum.map(attachments, fn
189 %{"url" => [%{"href" => href} | _]} = attachment ->
190 name = attachment["name"] || URI.decode(Path.basename(href))
191 href = MediaProxy.url(href)
192 "<a href=\"#{href}\" class='attachment'>#{shortname(name)}</a>"
198 Enum.join([text | attachment_text], "<br>")
201 def format_input(text, format, options \\ [])
204 Formatting text to plain text.
206 def format_input(text, "text/plain", options) do
208 |> Formatter.html_escape("text/plain")
209 |> Formatter.linkify(options)
210 |> (fn {text, mentions, tags} ->
211 {String.replace(text, ~r/\r?\n/, "<br>"), mentions, tags}
216 Formatting text as BBCode.
218 def format_input(text, "text/bbcode", options) do
220 |> String.replace(~r/\r/, "")
221 |> Formatter.html_escape("text/plain")
223 |> (fn {:ok, html} -> html end).()
224 |> Formatter.linkify(options)
228 Formatting text to html.
230 def format_input(text, "text/html", options) do
232 |> Formatter.html_escape("text/html")
233 |> Formatter.linkify(options)
237 Formatting text to markdown.
239 def format_input(text, "text/markdown", options) do
241 |> Formatter.mentions_escape(options)
242 |> Earmark.as_html!()
243 |> Formatter.linkify(options)
244 |> Formatter.html_escape("text/html")
264 "content" => content_html,
266 "sensitive" => !Enum.member?(["false", "False", "0", false], sensitive),
267 "context" => context,
268 "attachment" => attachments,
270 "tag" => tags |> Enum.map(fn {_, tag} -> tag end) |> Enum.uniq()
274 with false <- is_nil(in_reply_to),
275 %Object{} = in_reply_to_object <- Object.normalize(in_reply_to) do
276 Map.put(object, "inReplyTo", in_reply_to_object.data["id"])
281 Map.merge(object, merge)
284 def format_naive_asctime(date) do
285 date |> DateTime.from_naive!("Etc/UTC") |> format_asctime
288 def format_asctime(date) do
289 Strftime.strftime!(date, "%a %b %d %H:%M:%S %z %Y")
292 def date_to_asctime(date) when is_binary(date) do
293 with {:ok, date, _offset} <- DateTime.from_iso8601(date) do
297 Logger.warn("Date #{date} in wrong format, must be ISO 8601")
302 def date_to_asctime(date) do
303 Logger.warn("Date #{date} in wrong format, must be ISO 8601")
307 def to_masto_date(%NaiveDateTime{} = date) do
309 |> NaiveDateTime.to_iso8601()
310 |> String.replace(~r/(\.\d+)?$/, ".000Z", global: false)
313 def to_masto_date(date) do
316 |> NaiveDateTime.from_iso8601!()
317 |> NaiveDateTime.to_iso8601()
318 |> String.replace(~r/(\.\d+)?$/, ".000Z", global: false)
324 defp shortname(name) do
325 if String.length(name) < 30 do
328 String.slice(name, 0..30) <> "…"
332 def confirm_current_password(user, password) do
333 with %User{local: true} = db_user <- User.get_cached_by_id(user.id),
334 true <- Pbkdf2.checkpw(password, db_user.password_hash) do
337 _ -> {:error, "Invalid password."}
341 def emoji_from_profile(%{info: _info} = user) do
342 (Formatter.get_emoji(user.bio) ++ Formatter.get_emoji(user.name))
343 |> Enum.map(fn {shortcode, url, _} ->
346 "icon" => %{"type" => "Image", "url" => "#{Endpoint.url()}#{url}"},
347 "name" => ":#{shortcode}:"
352 def maybe_notify_to_recipients(
354 %Activity{data: %{"to" => to, "type" => _type}} = _activity
359 def maybe_notify_mentioned_recipients(
361 %Activity{data: %{"to" => _to, "type" => type} = data} = activity
363 when type == "Create" do
364 object = Object.normalize(activity)
371 is_map(data["object"]) ->
378 tagged_mentions = maybe_extract_mentions(object_data)
380 recipients ++ tagged_mentions
383 def maybe_notify_mentioned_recipients(recipients, _), do: recipients
385 def maybe_notify_subscribers(
387 %Activity{data: %{"actor" => actor, "type" => type}} = activity
389 when type == "Create" do
390 with %User{} = user <- User.get_cached_by_ap_id(actor) do
393 |> User.subscribers()
394 |> Enum.filter(&Visibility.visible_for_user?(activity, &1))
395 |> Enum.map(& &1.ap_id)
397 recipients ++ subscriber_ids
401 def maybe_notify_subscribers(recipients, _), do: recipients
403 def maybe_extract_mentions(%{"tag" => tag}) do
405 |> Enum.filter(fn x -> is_map(x) end)
406 |> Enum.filter(fn x -> x["type"] == "Mention" end)
407 |> Enum.map(fn x -> x["href"] end)
410 def maybe_extract_mentions(_), do: []
412 def make_report_content_html(nil), do: {:ok, {nil, [], []}}
414 def make_report_content_html(comment) do
415 max_size = Pleroma.Config.get([:instance, :max_report_comment_size], 1000)
417 if String.length(comment) <= max_size do
418 {:ok, format_input(comment, "text/plain")}
420 {:error, "Comment must be up to #{max_size} characters"}
424 def get_report_statuses(%User{ap_id: actor}, %{"status_ids" => status_ids}) do
425 {:ok, Activity.all_by_actor_and_id(actor, status_ids)}
428 def get_report_statuses(_, _), do: {:ok, nil}
430 # DEPRECATED mostly, context objects are now created at insertion time.
431 def context_to_conversation_id(context) do
432 with %Object{id: id} <- Object.get_cached_by_ap_id(context) do
436 changeset = Object.context_mapping(context)
438 case Repo.insert(changeset) do
442 # This should be solved by an upsert, but it seems ecto
443 # has problems accessing the constraint inside the jsonb.
445 Object.get_cached_by_ap_id(context).id
450 def conversation_id_to_context(id) do
451 with %Object{data: %{"id" => context}} <- Repo.get(Object, id) do
455 {:error, "No such conversation"}