1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2022 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)
169 UserRelationship.exists?(
174 &User.endorses?(&2, &1)
179 def render("relationships.json", %{user: user, targets: targets} = opts) do
182 Map.has_key?(opts, :relationships) ->
186 UserRelationship.view_relationships_option(nil, [])
189 UserRelationship.view_relationships_option(user, targets)
192 render_opts = %{as: :target, user: user, relationships: relationships_opt}
193 render_many(targets, AccountView, "relationship.json", render_opts)
196 defp do_render("show.json", %{user: user} = opts) do
197 user = User.sanitize_html(user, User.html_filter_policy(opts[:for]))
198 display_name = user.name || user.nickname
200 avatar = User.avatar_url(user) |> MediaProxy.url()
201 avatar_static = User.avatar_url(user) |> MediaProxy.preview_url(static: true)
202 header = User.banner_url(user) |> MediaProxy.url()
203 header_static = User.banner_url(user) |> MediaProxy.preview_url(static: true)
206 if !user.hide_follows_count or !user.hide_follows or opts[:for] == user,
207 do: user.following_count,
211 if !user.hide_followers_count or !user.hide_followers or opts[:for] == user,
212 do: user.follower_count,
215 bot = user.actor_type == "Service"
218 Enum.map(user.emoji, fn {shortcode, raw_url} ->
219 url = MediaProxy.url(raw_url)
222 shortcode: shortcode,
225 visible_in_picker: false
230 if opts[:embed_relationships] do
231 render("relationship.json", %{
234 relationships: opts[:relationships]
241 if Pleroma.Config.get([:instances_favicons, :enabled]) do
243 |> Map.get(:ap_id, "")
246 |> Pleroma.Instances.Instance.get_or_update_favicon()
253 id: to_string(user.id),
254 username: username_from_nickname(user.nickname),
256 display_name: display_name,
257 locked: user.is_locked,
258 created_at: Utils.to_masto_date(user.inserted_at),
259 followers_count: followers_count,
260 following_count: following_count,
261 statuses_count: user.note_count,
263 url: user.uri || user.ap_id,
265 avatar_static: avatar_static,
267 header_static: header_static,
272 note: user.raw_bio || "",
274 fields: user.raw_fields,
276 discoverable: user.is_discoverable,
277 actor_type: user.actor_type
280 last_status_at: user.last_status_at,
283 # Note: it's insecure to output :email but fully-qualified nickname may serve as safe stub
284 fqn: User.full_nickname(user),
287 also_known_as: user.also_known_as,
288 is_confirmed: user.is_confirmed,
289 is_suggested: user.is_suggested,
291 hide_followers_count: user.hide_followers_count,
292 hide_follows_count: user.hide_follows_count,
293 hide_followers: user.hide_followers,
294 hide_follows: user.hide_follows,
295 hide_favorites: user.hide_favorites,
296 relationship: relationship,
297 skip_thread_containment: user.skip_thread_containment,
298 background_image: image_url(user.background) |> MediaProxy.url(),
299 accepts_chat_messages: user.accepts_chat_messages,
303 |> maybe_put_role(user, opts[:for])
304 |> maybe_put_settings(user, opts[:for], opts)
305 |> maybe_put_notification_settings(user, opts[:for])
306 |> maybe_put_settings_store(user, opts[:for], opts)
307 |> maybe_put_chat_token(user, opts[:for], opts)
308 |> maybe_put_activation_status(user, opts[:for])
309 |> maybe_put_follow_requests_count(user, opts[:for])
310 |> maybe_put_allow_following_move(user, opts[:for])
311 |> maybe_put_unread_conversation_count(user, opts[:for])
312 |> maybe_put_unread_notification_count(user, opts[:for])
313 |> maybe_put_email_address(user, opts[:for])
314 |> maybe_put_mute_expires_at(user, opts[:for], opts)
315 |> maybe_show_birthday(user, opts[:for])
318 defp username_from_nickname(string) when is_binary(string) do
319 hd(String.split(string, "@"))
322 defp username_from_nickname(_), do: nil
324 defp maybe_put_follow_requests_count(
326 %User{id: user_id} = user,
330 User.get_follow_requests(user)
334 |> Kernel.put_in([:follow_requests_count], count)
337 defp maybe_put_follow_requests_count(data, _, _), do: data
339 defp maybe_put_settings(
341 %User{id: user_id} = user,
346 |> Kernel.put_in([:source, :privacy], user.default_scope)
347 |> Kernel.put_in([:source, :pleroma, :show_role], user.show_role)
348 |> Kernel.put_in([:source, :pleroma, :no_rich_text], user.no_rich_text)
349 |> Kernel.put_in([:source, :pleroma, :show_birthday], user.show_birthday)
352 defp maybe_put_settings(data, _, _, _), do: data
354 defp maybe_put_settings_store(data, %User{} = user, %User{}, %{
355 with_pleroma_settings: true
358 |> Kernel.put_in([:pleroma, :settings_store], user.pleroma_settings_store)
361 defp maybe_put_settings_store(data, _, _, _), do: data
363 defp maybe_put_chat_token(data, %User{id: id}, %User{id: id}, %{
364 with_chat_token: token
367 |> Kernel.put_in([:pleroma, :chat_token], token)
370 defp maybe_put_chat_token(data, _, _, _), do: data
372 defp maybe_put_role(data, %User{show_role: true} = user, _) do
376 defp maybe_put_role(data, %User{id: user_id} = user, %User{id: user_id}) do
380 defp maybe_put_role(data, _, _), do: data
382 defp put_role(data, user) do
384 |> Kernel.put_in([:pleroma, :is_admin], user.is_admin)
385 |> Kernel.put_in([:pleroma, :is_moderator], user.is_moderator)
386 |> Kernel.put_in([:pleroma, :privileges], User.privileges(user))
389 defp maybe_put_notification_settings(data, %User{id: user_id} = user, %User{id: user_id}) do
392 [:pleroma, :notification_settings],
393 Map.from_struct(user.notification_settings)
397 defp maybe_put_notification_settings(data, _, _), do: data
399 defp maybe_put_allow_following_move(data, %User{id: user_id} = user, %User{id: user_id}) do
400 Kernel.put_in(data, [:pleroma, :allow_following_move], user.allow_following_move)
403 defp maybe_put_allow_following_move(data, _, _), do: data
405 defp maybe_put_activation_status(data, user, user_for) do
406 if User.privileged?(user_for, :users_manage_activation_state),
407 do: Kernel.put_in(data, [:pleroma, :deactivated], !user.is_active),
411 defp maybe_put_unread_conversation_count(data, %User{id: user_id} = user, %User{id: user_id}) do
414 [:pleroma, :unread_conversation_count],
415 Pleroma.Conversation.Participation.unread_count(user)
419 defp maybe_put_unread_conversation_count(data, _, _), do: data
421 defp maybe_put_unread_notification_count(data, %User{id: user_id}, %User{id: user_id} = user) do
424 [:pleroma, :unread_notifications_count],
425 Pleroma.Notification.unread_notifications_count(user)
429 defp maybe_put_unread_notification_count(data, _, _), do: data
431 defp maybe_put_email_address(data, %User{id: user_id}, %User{id: user_id} = user) do
439 defp maybe_put_email_address(data, _, _), do: data
441 defp maybe_put_mute_expires_at(data, %User{} = user, target, %{mutes: true}) do
445 UserRelationship.get_mute_expire_date(target, user)
449 defp maybe_put_mute_expires_at(data, _, _, _), do: data
451 defp maybe_show_birthday(data, %User{id: user_id} = user, %User{id: user_id}) do
453 |> Kernel.put_in([:pleroma, :birthday], user.birthday)
456 defp maybe_show_birthday(data, %User{show_birthday: true} = user, _) do
458 |> Kernel.put_in([:pleroma, :birthday], user.birthday)
461 defp maybe_show_birthday(data, _, _) do
465 defp image_url(%{"url" => [%{"href" => href} | _]}), do: href
466 defp image_url(_), do: nil