1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.MastodonAPI.AccountView do
8 alias Pleroma.FollowingRelationship
10 alias Pleroma.UserNote
11 alias Pleroma.UserRelationship
12 alias Pleroma.Web.CommonAPI.Utils
13 alias Pleroma.Web.MastodonAPI.AccountView
14 alias Pleroma.Web.MediaProxy
16 def render("index.json", %{users: users} = opts) do
17 reading_user = opts[:for]
21 Map.has_key?(opts, :relationships) ->
24 is_nil(reading_user) || !opts[:embed_relationships] ->
25 UserRelationship.view_relationships_option(nil, [])
28 UserRelationship.view_relationships_option(reading_user, users)
33 |> Map.merge(%{relationships: relationships_opt, as: :user})
37 |> render_many(AccountView, "show.json", opts)
38 |> Enum.filter(&Enum.any?/1)
42 Renders specified user account.
43 :skip_visibility_check option skips visibility check and renders any user (local or remote)
44 regardless of [:pleroma, :restrict_unauthenticated] setting.
45 :for option specifies the requester and can be a User record or nil.
46 Only use `user: user, for: user` when `user` is the actual requester of own profile.
48 def render("show.json", %{user: _user, skip_visibility_check: true} = opts) do
49 do_render("show.json", opts)
52 def render("show.json", %{user: user, for: for_user_or_nil} = opts) do
53 if User.visible_for(user, for_user_or_nil) == :visible do
54 do_render("show.json", opts)
60 def render("show.json", _) do
61 raise "In order to prevent account accessibility issues, " <>
62 ":skip_visibility_check or :for option is required."
65 def render("mention.json", %{user: user}) do
67 id: to_string(user.id),
69 username: username_from_nickname(user.nickname),
70 url: user.uri || user.ap_id
74 def render("relationship.json", %{user: nil, target: _target}) do
80 %{user: %User{} = reading_user, target: %User{} = target} = opts
82 user_relationships = get_in(opts, [:relationships, :user_relationships])
83 following_relationships = get_in(opts, [:relationships, :following_relationships])
86 if following_relationships do
87 user_to_target_following_relation =
88 FollowingRelationship.find(following_relationships, reading_user, target)
90 User.get_follow_state(reading_user, target, user_to_target_following_relation)
92 User.get_follow_state(reading_user, target)
96 if following_relationships do
97 case FollowingRelationship.find(following_relationships, target, reading_user) do
98 %{state: :follow_accept} -> true
102 User.following?(target, reading_user)
106 UserRelationship.exists?(
108 :inverse_subscription,
111 &User.subscribed_to?(&2, &1)
114 # NOTE: adjust UserRelationship.view_relationships_option/2 on new relation-related flags
116 id: to_string(target.id),
117 following: follow_state == :follow_accept,
118 followed_by: followed_by,
120 UserRelationship.exists?(
125 &User.blocks_user?(&1, &2)
128 UserRelationship.exists?(
133 &User.blocks_user?(&1, &2)
136 UserRelationship.exists?(
143 muting_notifications:
144 UserRelationship.exists?(
149 &User.muted_notifications?(&1, &2)
151 subscribing: subscribing,
152 notifying: subscribing,
153 requested: follow_state == :follow_pending,
154 domain_blocking: User.blocks_domain?(reading_user, target),
156 not UserRelationship.exists?(
161 &User.muting_reblogs?(&1, &2)
172 def render("relationships.json", %{user: user, targets: targets} = opts) do
175 Map.has_key?(opts, :relationships) ->
179 UserRelationship.view_relationships_option(nil, [])
182 UserRelationship.view_relationships_option(user, targets)
185 render_opts = %{as: :target, user: user, relationships: relationships_opt}
186 render_many(targets, AccountView, "relationship.json", render_opts)
189 defp do_render("show.json", %{user: user} = opts) do
190 user = User.sanitize_html(user, User.html_filter_policy(opts[:for]))
191 display_name = user.name || user.nickname
193 avatar = User.avatar_url(user) |> MediaProxy.url()
194 avatar_static = User.avatar_url(user) |> MediaProxy.preview_url(static: true)
195 header = User.banner_url(user) |> MediaProxy.url()
196 header_static = User.banner_url(user) |> MediaProxy.preview_url(static: true)
199 if !user.hide_follows_count or !user.hide_follows or opts[:for] == user,
200 do: user.following_count,
204 if !user.hide_followers_count or !user.hide_followers or opts[:for] == user,
205 do: user.follower_count,
208 bot = user.actor_type == "Service"
211 Enum.map(user.emoji, fn {shortcode, raw_url} ->
212 url = MediaProxy.url(raw_url)
215 shortcode: shortcode,
218 visible_in_picker: false
223 if opts[:embed_relationships] do
224 render("relationship.json", %{
227 relationships: opts[:relationships]
234 if Pleroma.Config.get([:instances_favicons, :enabled]) do
236 |> Map.get(:ap_id, "")
239 |> Pleroma.Instances.Instance.get_or_update_favicon()
246 id: to_string(user.id),
247 username: username_from_nickname(user.nickname),
249 display_name: display_name,
250 locked: user.is_locked,
251 created_at: Utils.to_masto_date(user.inserted_at),
252 followers_count: followers_count,
253 following_count: following_count,
254 statuses_count: user.note_count,
256 url: user.uri || user.ap_id,
258 avatar_static: avatar_static,
260 header_static: header_static,
265 note: user.raw_bio || "",
267 fields: user.raw_fields,
269 discoverable: user.is_discoverable,
270 actor_type: user.actor_type
273 last_status_at: user.last_status_at,
276 # Note: it's insecure to output :email but fully-qualified nickname may serve as safe stub
277 fqn: User.full_nickname(user),
280 also_known_as: user.also_known_as,
281 is_confirmed: user.is_confirmed,
282 is_suggested: user.is_suggested,
284 hide_followers_count: user.hide_followers_count,
285 hide_follows_count: user.hide_follows_count,
286 hide_followers: user.hide_followers,
287 hide_follows: user.hide_follows,
288 hide_favorites: user.hide_favorites,
289 relationship: relationship,
290 skip_thread_containment: user.skip_thread_containment,
291 background_image: image_url(user.background) |> MediaProxy.url(),
292 accepts_chat_messages: user.accepts_chat_messages,
296 |> maybe_put_role(user, opts[:for])
297 |> maybe_put_settings(user, opts[:for], opts)
298 |> maybe_put_notification_settings(user, opts[:for])
299 |> maybe_put_settings_store(user, opts[:for], opts)
300 |> maybe_put_chat_token(user, opts[:for], opts)
301 |> maybe_put_activation_status(user, opts[:for])
302 |> maybe_put_follow_requests_count(user, opts[:for])
303 |> maybe_put_allow_following_move(user, opts[:for])
304 |> maybe_put_unread_conversation_count(user, opts[:for])
305 |> maybe_put_unread_notification_count(user, opts[:for])
306 |> maybe_put_email_address(user, opts[:for])
309 defp username_from_nickname(string) when is_binary(string) do
310 hd(String.split(string, "@"))
313 defp username_from_nickname(_), do: nil
315 defp maybe_put_follow_requests_count(
317 %User{id: user_id} = user,
321 User.get_follow_requests(user)
325 |> Kernel.put_in([:follow_requests_count], count)
328 defp maybe_put_follow_requests_count(data, _, _), do: data
330 defp maybe_put_settings(
332 %User{id: user_id} = user,
337 |> Kernel.put_in([:source, :privacy], user.default_scope)
338 |> Kernel.put_in([:source, :pleroma, :show_role], user.show_role)
339 |> Kernel.put_in([:source, :pleroma, :no_rich_text], user.no_rich_text)
342 defp maybe_put_settings(data, _, _, _), do: data
344 defp maybe_put_settings_store(data, %User{} = user, %User{}, %{
345 with_pleroma_settings: true
348 |> Kernel.put_in([:pleroma, :settings_store], user.pleroma_settings_store)
351 defp maybe_put_settings_store(data, _, _, _), do: data
353 defp maybe_put_chat_token(data, %User{id: id}, %User{id: id}, %{
354 with_chat_token: token
357 |> Kernel.put_in([:pleroma, :chat_token], token)
360 defp maybe_put_chat_token(data, _, _, _), do: data
362 defp maybe_put_role(data, %User{show_role: true} = user, _) do
364 |> Kernel.put_in([:pleroma, :is_admin], user.is_admin)
365 |> Kernel.put_in([:pleroma, :is_moderator], user.is_moderator)
368 defp maybe_put_role(data, %User{id: user_id} = user, %User{id: user_id}) do
370 |> Kernel.put_in([:pleroma, :is_admin], user.is_admin)
371 |> Kernel.put_in([:pleroma, :is_moderator], user.is_moderator)
374 defp maybe_put_role(data, _, _), do: data
376 defp maybe_put_notification_settings(data, %User{id: user_id} = user, %User{id: user_id}) do
379 [:pleroma, :notification_settings],
380 Map.from_struct(user.notification_settings)
384 defp maybe_put_notification_settings(data, _, _), do: data
386 defp maybe_put_allow_following_move(data, %User{id: user_id} = user, %User{id: user_id}) do
387 Kernel.put_in(data, [:pleroma, :allow_following_move], user.allow_following_move)
390 defp maybe_put_allow_following_move(data, _, _), do: data
392 defp maybe_put_activation_status(data, user, %User{is_admin: true}) do
393 Kernel.put_in(data, [:pleroma, :deactivated], !user.is_active)
396 defp maybe_put_activation_status(data, _, _), do: data
398 defp maybe_put_unread_conversation_count(data, %User{id: user_id} = user, %User{id: user_id}) do
401 [:pleroma, :unread_conversation_count],
402 Pleroma.Conversation.Participation.unread_count(user)
406 defp maybe_put_unread_conversation_count(data, _, _), do: data
408 defp maybe_put_unread_notification_count(data, %User{id: user_id}, %User{id: user_id} = user) do
411 [:pleroma, :unread_notifications_count],
412 Pleroma.Notification.unread_notifications_count(user)
416 defp maybe_put_unread_notification_count(data, _, _), do: data
418 defp maybe_put_email_address(data, %User{id: user_id}, %User{id: user_id} = user) do
426 defp maybe_put_email_address(data, _, _), do: data
428 defp image_url(%{"url" => [%{"href" => href} | _]}), do: href
429 defp image_url(_), do: nil