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.AccountController do
6 use Pleroma.Web, :controller
8 import Pleroma.Web.ControllerHelper,
11 assign_account_by_id: 2,
12 embed_relationships?: 1,
18 alias Pleroma.UserNote
19 alias Pleroma.Web.ActivityPub.ActivityPub
20 alias Pleroma.Web.ActivityPub.Builder
21 alias Pleroma.Web.ActivityPub.Pipeline
22 alias Pleroma.Web.CommonAPI
23 alias Pleroma.Web.MastodonAPI.ListView
24 alias Pleroma.Web.MastodonAPI.MastodonAPI
25 alias Pleroma.Web.MastodonAPI.MastodonAPIController
26 alias Pleroma.Web.MastodonAPI.StatusView
27 alias Pleroma.Web.OAuth.OAuthController
28 alias Pleroma.Web.Plugs.OAuthScopesPlug
29 alias Pleroma.Web.Plugs.RateLimiter
30 alias Pleroma.Web.TwitterAPI.TwitterAPI
31 alias Pleroma.Web.Utils.Params
33 plug(Pleroma.Web.ApiSpec.CastAndValidate)
35 plug(:skip_auth when action in [:create, :lookup])
37 plug(:skip_public_check when action in [:show, :statuses])
41 %{fallback: :proceed_unauthenticated, scopes: ["read:accounts"]}
42 when action in [:show, :followers, :following]
47 %{fallback: :proceed_unauthenticated, scopes: ["read:statuses"]}
48 when action == :statuses
53 %{scopes: ["read:accounts"]}
54 when action in [:verify_credentials, :endorsements, :identity_proofs]
59 %{scopes: ["write:accounts"]}
60 when action in [:update_credentials, :note]
63 plug(OAuthScopesPlug, %{scopes: ["read:lists"]} when action == :lists)
67 %{scopes: ["follow", "read:blocks"]} when action == :blocks
72 %{scopes: ["follow", "write:blocks"]} when action in [:block, :unblock]
75 plug(OAuthScopesPlug, %{scopes: ["read:follows"]} when action == :relationships)
79 %{scopes: ["follow", "write:follows"]}
80 when action in [:follow_by_uri, :follow, :unfollow, :remove_from_followers]
83 plug(OAuthScopesPlug, %{scopes: ["follow", "read:mutes"]} when action == :mutes)
85 plug(OAuthScopesPlug, %{scopes: ["follow", "write:mutes"]} when action in [:mute, :unmute])
87 @relationship_actions [:follow, :unfollow, :remove_from_followers]
88 @needs_account ~W(followers following lists follow unfollow mute unmute block unblock note remove_from_followers)a
92 [name: :relation_id_action, params: [:id, :uri]] when action in @relationship_actions
95 plug(RateLimiter, [name: :relations_actions] when action in @relationship_actions)
96 plug(RateLimiter, [name: :app_account_creation] when action == :create)
97 plug(:assign_account_by_id when action in @needs_account)
99 action_fallback(Pleroma.Web.MastodonAPI.FallbackController)
101 defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.AccountOperation
103 @doc "POST /api/v1/accounts"
104 def create(%{assigns: %{app: app}, body_params: params} = conn, _params) do
105 with :ok <- validate_email_param(params),
106 :ok <- TwitterAPI.validate_captcha(app, params),
107 {:ok, user} <- TwitterAPI.register_user(params),
109 {:login, OAuthController.login(user, app, app.scopes)} do
110 OAuthController.after_token_exchange(conn, %{user: user, token: token})
112 {:login, {:account_status, :confirmation_pending}} ->
113 json_response(conn, :ok, %{
114 message: "You have been registered. Please check your email for further instructions.",
115 identifier: "missing_confirmed_email"
118 {:login, {:account_status, :approval_pending}} ->
119 json_response(conn, :ok, %{
121 "You have been registered. You'll be able to log in once your account is approved.",
122 identifier: "awaiting_approval"
126 json_response(conn, :ok, %{
128 "You have been registered. Some post-registration steps may be pending. " <>
129 "Please log in manually.",
130 identifier: "manual_login_required"
134 json_response(conn, :bad_request, %{error: error})
138 def create(%{assigns: %{app: _app}} = conn, _) do
139 render_error(conn, :bad_request, "Missing parameters")
142 def create(conn, _) do
143 render_error(conn, :forbidden, "Invalid credentials")
146 defp validate_email_param(%{email: email}) when not is_nil(email), do: :ok
148 defp validate_email_param(_) do
149 case Pleroma.Config.get([:instance, :account_activation_required]) do
150 true -> {:error, dgettext("errors", "Missing parameter: %{name}", name: "email")}
155 @doc "GET /api/v1/accounts/verify_credentials"
156 def verify_credentials(%{assigns: %{user: user}} = conn, _) do
157 render(conn, "show.json",
160 with_pleroma_settings: true
164 @doc "PATCH /api/v1/accounts/update_credentials"
165 def update_credentials(%{assigns: %{user: user}, body_params: params} = conn, _params) do
168 |> Enum.filter(fn {_, value} -> not is_nil(value) end)
171 # We use an empty string as a special value to reset
172 # avatars, banners, backgrounds
173 user_image_value = fn
175 value -> {:ok, value}
178 status_ttl_days_value = fn
180 value -> {:ok, value}
186 :hide_followers_count,
192 :skip_thread_containment,
193 :allow_following_move,
196 |> Enum.reduce(%{}, fn key, acc ->
197 Maps.put_if_present(acc, key, params[key], &{:ok, Params.truthy_param?(&1)})
199 |> Maps.put_if_present(:name, params[:display_name])
200 |> Maps.put_if_present(:bio, params[:note])
201 |> Maps.put_if_present(:raw_bio, params[:note])
202 |> Maps.put_if_present(:avatar, params[:avatar], user_image_value)
203 |> Maps.put_if_present(:banner, params[:header], user_image_value)
204 |> Maps.put_if_present(:background, params[:pleroma_background_image], user_image_value)
205 |> Maps.put_if_present(
207 params[:fields_attributes],
208 &{:ok, normalize_fields_attributes(&1)}
210 |> Maps.put_if_present(:pleroma_settings_store, params[:pleroma_settings_store])
211 |> Maps.put_if_present(:default_scope, params[:default_scope])
212 |> Maps.put_if_present(:default_scope, params["source"]["privacy"])
213 |> Maps.put_if_present(:actor_type, params[:bot], fn bot ->
214 if bot, do: {:ok, "Service"}, else: {:ok, "Person"}
216 |> Maps.put_if_present(:actor_type, params[:actor_type])
217 |> Maps.put_if_present(:also_known_as, params[:also_known_as])
218 # Note: param name is indeed :locked (not an error)
219 |> Maps.put_if_present(:is_locked, params[:locked])
220 # Note: param name is indeed :discoverable (not an error)
221 |> Maps.put_if_present(:is_discoverable, params[:discoverable])
222 |> Maps.put_if_present(:language, Pleroma.Web.Gettext.normalize_locale(params[:language]))
223 |> Maps.put_if_present(:status_ttl_days, params[:status_ttl_days], status_ttl_days_value)
227 # We want to update the user through the pipeline, but the ActivityPub
228 # update information is not quite enough for this, because this also
229 # contains local settings that don't federate and don't even appear
230 # in the Update activity.
232 # So we first build the normal local changeset, then apply it to the
233 # user data, but don't persist it. With this, we generate the object
234 # data for our update activity. We feed this and the changeset as meta
235 # inforation into the pipeline, where they will be properly updated and
237 with changeset <- User.update_changeset(user, user_params),
238 {:ok, unpersisted_user} <- Ecto.Changeset.apply_action(changeset, :update),
240 Pleroma.Web.ActivityPub.UserView.render("user.json", user: unpersisted_user)
241 |> Map.delete("@context"),
242 {:ok, update_data, []} <- Builder.update(user, updated_object),
244 Pipeline.common_pipeline(update_data,
246 user_update_changeset: changeset
248 render(conn, "show.json",
249 user: unpersisted_user,
250 for: unpersisted_user,
251 with_pleroma_settings: true
254 _e -> render_error(conn, :forbidden, "Invalid request")
258 defp normalize_fields_attributes(fields) do
259 if Enum.all?(fields, &is_tuple/1) do
260 Enum.map(fields, fn {_, v} -> v end)
263 %{} = field -> %{"name" => field.name, "value" => field.value}
269 @doc "GET /api/v1/accounts/relationships"
270 def relationships(%{assigns: %{user: user}} = conn, %{id: id}) do
271 targets = User.get_all_by_ids(List.wrap(id))
273 render(conn, "relationships.json", user: user, targets: targets)
276 # Instead of returning a 400 when no "id" params is present, Mastodon returns an empty array.
277 def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, [])
279 @doc "GET /api/v1/accounts/:id"
280 def show(%{assigns: %{user: for_user}} = conn, %{id: nickname_or_id} = params) do
281 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user),
282 :visible <- User.visible_for(user, for_user) do
283 render(conn, "show.json",
286 embed_relationships: embed_relationships?(params)
289 error -> user_visibility_error(conn, error)
293 @doc "GET /api/v1/accounts/:id/statuses"
294 def statuses(%{assigns: %{user: reading_user}} = conn, params) do
295 with %User{} = user <- User.get_cached_by_nickname_or_id(params.id, for: reading_user),
296 :visible <- User.visible_for(user, reading_user) do
299 |> Map.delete(:tagged)
300 |> Map.put(:tag, params[:tagged])
302 activities = ActivityPub.fetch_user_activities(user, reading_user, params)
305 |> add_link_headers(activities)
306 |> put_view(StatusView)
307 |> render("index.json",
308 activities: activities,
311 with_muted: Map.get(params, :with_muted, false)
314 error -> user_visibility_error(conn, error)
318 defp user_visibility_error(conn, error) do
320 :restrict_unauthenticated ->
321 render_error(conn, :unauthorized, "This API requires an authenticated user")
324 render_error(conn, :not_found, "Can't find user")
328 @doc "GET /api/v1/accounts/:id/followers"
329 def followers(%{assigns: %{user: for_user, account: user}} = conn, params) do
332 |> Enum.map(fn {key, value} -> {to_string(key), value} end)
337 for_user && user.id == for_user.id -> MastodonAPI.get_followers(user, params)
338 user.hide_followers -> []
339 true -> MastodonAPI.get_followers(user, params)
343 |> add_link_headers(followers)
344 # https://git.pleroma.social/pleroma/pleroma-fe/-/issues/838#note_59223
345 |> render("index.json",
349 embed_relationships: embed_relationships?(params)
353 @doc "GET /api/v1/accounts/:id/following"
354 def following(%{assigns: %{user: for_user, account: user}} = conn, params) do
357 |> Enum.map(fn {key, value} -> {to_string(key), value} end)
362 for_user && user.id == for_user.id -> MastodonAPI.get_friends(user, params)
363 user.hide_follows -> []
364 true -> MastodonAPI.get_friends(user, params)
368 |> add_link_headers(followers)
369 # https://git.pleroma.social/pleroma/pleroma-fe/-/issues/838#note_59223
370 |> render("index.json",
374 embed_relationships: embed_relationships?(params)
378 @doc "GET /api/v1/accounts/:id/lists"
379 def lists(%{assigns: %{user: user, account: account}} = conn, _params) do
380 lists = Pleroma.List.get_lists_account_belongs(user, account)
383 |> put_view(ListView)
384 |> render("index.json", lists: lists)
387 @doc "POST /api/v1/accounts/:id/follow"
388 def follow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
389 {:error, "Can not follow yourself"}
392 def follow(%{body_params: params, assigns: %{user: follower, account: followed}} = conn, _) do
393 with {:ok, follower} <- MastodonAPI.follow(follower, followed, params) do
394 render(conn, "relationship.json", user: follower, target: followed)
396 {:error, message} -> json_response(conn, :forbidden, %{error: message})
400 @doc "POST /api/v1/accounts/:id/unfollow"
401 def unfollow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
402 {:error, "Can not unfollow yourself"}
405 def unfollow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
406 with {:ok, follower} <- CommonAPI.unfollow(follower, followed) do
407 render(conn, "relationship.json", user: follower, target: followed)
411 @doc "POST /api/v1/accounts/:id/mute"
412 def mute(%{assigns: %{user: muter, account: muted}, body_params: params} = conn, _params) do
413 with {:ok, _user_relationships} <- User.mute(muter, muted, params) do
414 render(conn, "relationship.json", user: muter, target: muted)
416 {:error, message} -> json_response(conn, :forbidden, %{error: message})
420 @doc "POST /api/v1/accounts/:id/unmute"
421 def unmute(%{assigns: %{user: muter, account: muted}} = conn, _params) do
422 with {:ok, _user_relationships} <- User.unmute(muter, muted) do
423 render(conn, "relationship.json", user: muter, target: muted)
425 {:error, message} -> json_response(conn, :forbidden, %{error: message})
429 @doc "POST /api/v1/accounts/:id/block"
430 def block(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
431 with {:ok, _activity} <- CommonAPI.block(blocker, blocked) do
432 render(conn, "relationship.json", user: blocker, target: blocked)
434 {:error, message} -> json_response(conn, :forbidden, %{error: message})
438 @doc "POST /api/v1/accounts/:id/unblock"
439 def unblock(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
440 with {:ok, _activity} <- CommonAPI.unblock(blocker, blocked) do
441 render(conn, "relationship.json", user: blocker, target: blocked)
443 {:error, message} -> json_response(conn, :forbidden, %{error: message})
447 @doc "POST /api/v1/accounts/:id/note"
449 %{assigns: %{user: noter, account: target}, body_params: %{comment: comment}} = conn,
452 with {:ok, _user_note} <- UserNote.create(noter, target, comment) do
453 render(conn, "relationship.json", user: noter, target: target)
457 @doc "POST /api/v1/accounts/:id/remove_from_followers"
458 def remove_from_followers(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
459 {:error, "Can not unfollow yourself"}
462 def remove_from_followers(%{assigns: %{user: followed, account: follower}} = conn, _params) do
463 with {:ok, follower} <- CommonAPI.reject_follow_request(follower, followed) do
464 render(conn, "relationship.json", user: followed, target: follower)
467 render_error(conn, :not_found, "Record not found")
471 @doc "POST /api/v1/follows"
472 def follow_by_uri(%{body_params: %{uri: uri}} = conn, _) do
473 case User.get_cached_by_nickname(uri) do
476 |> assign(:account, user)
484 @doc "GET /api/v1/mutes"
485 def mutes(%{assigns: %{user: user}} = conn, params) do
488 |> User.muted_users_relation(_restrict_deactivated = true)
489 |> Pleroma.Pagination.fetch_paginated(Map.put(params, :skip_order, true))
492 |> add_link_headers(users)
493 |> render("index.json",
497 embed_relationships: embed_relationships?(params)
501 @doc "GET /api/v1/blocks"
502 def blocks(%{assigns: %{user: user}} = conn, params) do
505 |> User.blocked_users_relation(_restrict_deactivated = true)
506 |> Pleroma.Pagination.fetch_paginated(Map.put(params, :skip_order, true))
509 |> add_link_headers(users)
510 |> render("index.json", users: users, for: user, as: :user)
513 @doc "GET /api/v1/accounts/lookup"
514 def lookup(conn, %{acct: nickname} = _params) do
515 with %User{} = user <- User.get_by_nickname(nickname) do
516 render(conn, "show.json",
518 skip_visibility_check: true
521 error -> user_visibility_error(conn, error)
525 @doc "GET /api/v1/endorsements"
526 def endorsements(conn, params), do: MastodonAPIController.empty_array(conn, params)
528 @doc "GET /api/v1/identity_proofs"
529 def identity_proofs(conn, params), do: MastodonAPIController.empty_array(conn, params)