1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 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,
12 assign_account_by_id: 2,
14 skip_relationships?: 1
17 alias Pleroma.Plugs.OAuthScopesPlug
18 alias Pleroma.Plugs.RateLimiter
20 alias Pleroma.Web.ActivityPub.ActivityPub
21 alias Pleroma.Web.CommonAPI
22 alias Pleroma.Web.MastodonAPI.ListView
23 alias Pleroma.Web.MastodonAPI.MastodonAPI
24 alias Pleroma.Web.MastodonAPI.StatusView
25 alias Pleroma.Web.OAuth.Token
26 alias Pleroma.Web.TwitterAPI.TwitterAPI
30 %{fallback: :proceed_unauthenticated, scopes: ["read:accounts"]}
36 %{scopes: ["read:accounts"]}
37 when action in [:endorsements, :verify_credentials, :followers, :following]
40 plug(OAuthScopesPlug, %{scopes: ["write:accounts"]} when action == :update_credentials)
42 plug(OAuthScopesPlug, %{scopes: ["read:lists"]} when action == :lists)
46 %{scopes: ["follow", "read:blocks"]} when action == :blocks
51 %{scopes: ["follow", "write:blocks"]} when action in [:block, :unblock]
54 plug(OAuthScopesPlug, %{scopes: ["read:follows"]} when action == :relationships)
56 # Note: :follows (POST /api/v1/follows) is the same as :follow, consider removing :follows
59 %{scopes: ["follow", "write:follows"]} when action in [:follows, :follow, :unfollow]
62 plug(OAuthScopesPlug, %{scopes: ["follow", "read:mutes"]} when action == :mutes)
64 plug(OAuthScopesPlug, %{scopes: ["follow", "write:mutes"]} when action in [:mute, :unmute])
67 Pleroma.Plugs.EnsurePublicOrAuthenticatedPlug
68 when action not in [:create, :show, :statuses]
71 @relationship_actions [:follow, :unfollow]
72 @needs_account ~W(followers following lists follow unfollow mute unmute block unblock)a
76 [name: :relation_id_action, params: ["id", "uri"]] when action in @relationship_actions
79 plug(RateLimiter, [name: :relations_actions] when action in @relationship_actions)
80 plug(RateLimiter, [name: :app_account_creation] when action == :create)
81 plug(:assign_account_by_id when action in @needs_account)
84 OpenApiSpex.Plug.CastAndValidate,
85 [render_error: Pleroma.Web.ApiSpec.RenderError]
98 action_fallback(Pleroma.Web.MastodonAPI.FallbackController)
100 defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.AccountOperation
102 @doc "POST /api/v1/accounts"
103 def create(%{assigns: %{app: app}, body_params: params} = conn, _params) do
111 :captcha_answer_data,
116 |> Map.put(:nickname, params.username)
117 |> Map.put(:fullname, params.fullname || params.username)
118 |> Map.put(:bio, params.bio || "")
119 |> Map.put(:confirm, params.password)
121 with :ok <- validate_email_param(params),
122 {:ok, user} <- TwitterAPI.register_user(params, need_confirmation: true),
123 {:ok, token} <- Token.create_token(app, user, %{scopes: app.scopes}) do
125 token_type: "Bearer",
126 access_token: token.token,
128 created_at: Token.Utils.format_created_at(token)
131 {:error, errors} -> json_response(conn, :bad_request, errors)
135 def create(%{assigns: %{app: _app}} = conn, _) do
136 render_error(conn, :bad_request, "Missing parameters")
139 def create(conn, _) do
140 render_error(conn, :forbidden, "Invalid credentials")
143 defp validate_email_param(%{:email => email}) when not is_nil(email), do: :ok
145 defp validate_email_param(_) do
146 case Pleroma.Config.get([:instance, :account_activation_required]) do
147 true -> {:error, %{"error" => "Missing parameters"}}
152 @doc "GET /api/v1/accounts/verify_credentials"
153 def verify_credentials(%{assigns: %{user: user}} = conn, _) do
154 chat_token = Phoenix.Token.sign(conn, "user socket", user.id)
156 render(conn, "show.json",
159 with_pleroma_settings: true,
160 with_chat_token: chat_token
164 @doc "PATCH /api/v1/accounts/update_credentials"
165 def update_credentials(%{assigns: %{user: original_user}, body_params: params} = conn, _params) do
171 |> Enum.filter(fn {_, value} -> not is_nil(value) end)
178 :hide_followers_count,
184 :skip_thread_containment,
185 :allow_following_move,
188 |> Enum.reduce(%{}, fn key, acc ->
189 add_if_present(acc, params, key, key, &{:ok, truthy_param?(&1)})
191 |> add_if_present(params, :display_name, :name)
192 |> add_if_present(params, :note, :bio)
193 |> add_if_present(params, :avatar, :avatar)
194 |> add_if_present(params, :header, :banner)
195 |> add_if_present(params, :pleroma_background_image, :background)
200 &{:ok, normalize_fields_attributes(&1)}
202 |> add_if_present(params, :pleroma_settings_store, :pleroma_settings_store)
203 |> add_if_present(params, :default_scope, :default_scope)
204 |> add_if_present(params, :actor_type, :actor_type)
206 changeset = User.update_changeset(user, user_params)
208 with {:ok, user} <- User.update_and_set_cache(changeset) do
209 if original_user != user, do: CommonAPI.update(user)
211 render(conn, "show.json", user: user, for: user, with_pleroma_settings: true)
213 _e -> render_error(conn, :forbidden, "Invalid request")
217 defp add_if_present(map, params, params_field, map_field, value_function \\ &{:ok, &1}) do
218 with true <- Map.has_key?(params, params_field),
219 {:ok, new_value} <- value_function.(Map.get(params, params_field)) do
220 Map.put(map, map_field, new_value)
226 defp normalize_fields_attributes(fields) do
227 if Enum.all?(fields, &is_tuple/1) do
228 Enum.map(fields, fn {_, v} -> v end)
231 %Pleroma.Web.ApiSpec.Schemas.AccountAttributeField{} = field ->
232 %{"name" => field.name, "value" => field.value}
240 @doc "GET /api/v1/accounts/relationships"
241 def relationships(%{assigns: %{user: user}} = conn, %{id: id}) do
242 targets = User.get_all_by_ids(List.wrap(id))
244 render(conn, "relationships.json", user: user, targets: targets)
247 # Instead of returning a 400 when no "id" params is present, Mastodon returns an empty array.
248 def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, [])
250 @doc "GET /api/v1/accounts/:id"
251 def show(%{assigns: %{user: for_user}} = conn, %{id: nickname_or_id}) do
252 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user),
253 true <- User.visible_for?(user, for_user) do
254 render(conn, "show.json", user: user, for: for_user)
256 _e -> render_error(conn, :not_found, "Can't find user")
260 @doc "GET /api/v1/accounts/:id/statuses"
261 def statuses(%{assigns: %{user: reading_user}} = conn, params) do
262 with %User{} = user <- User.get_cached_by_nickname_or_id(params.id, for: reading_user),
263 true <- User.visible_for?(user, reading_user) do
266 |> Map.delete(:tagged)
267 |> Enum.filter(&(not is_nil(&1)))
268 |> Map.new(fn {key, value} -> {to_string(key), value} end)
269 |> Map.put("tag", params[:tagged])
271 activities = ActivityPub.fetch_user_activities(user, reading_user, params)
274 |> add_link_headers(activities)
275 |> put_view(StatusView)
276 |> render("index.json",
277 activities: activities,
280 skip_relationships: skip_relationships?(params)
283 _e -> render_error(conn, :not_found, "Can't find user")
287 @doc "GET /api/v1/accounts/:id/followers"
288 def followers(%{assigns: %{user: for_user, account: user}} = conn, params) do
291 |> Enum.map(fn {key, value} -> {to_string(key), value} end)
296 for_user && user.id == for_user.id -> MastodonAPI.get_followers(user, params)
297 user.hide_followers -> []
298 true -> MastodonAPI.get_followers(user, params)
302 |> add_link_headers(followers)
303 |> render("index.json", for: for_user, users: followers, as: :user)
306 @doc "GET /api/v1/accounts/:id/following"
307 def following(%{assigns: %{user: for_user, account: user}} = conn, params) do
310 |> Enum.map(fn {key, value} -> {to_string(key), value} end)
315 for_user && user.id == for_user.id -> MastodonAPI.get_friends(user, params)
316 user.hide_follows -> []
317 true -> MastodonAPI.get_friends(user, params)
321 |> add_link_headers(followers)
322 |> render("index.json", for: for_user, users: followers, as: :user)
325 @doc "GET /api/v1/accounts/:id/lists"
326 def lists(%{assigns: %{user: user, account: account}} = conn, _params) do
327 lists = Pleroma.List.get_lists_account_belongs(user, account)
330 |> put_view(ListView)
331 |> render("index.json", lists: lists)
334 @doc "POST /api/v1/accounts/:id/follow"
335 def follow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
339 def follow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
340 with {:ok, follower} <- MastodonAPI.follow(follower, followed, conn.params) do
341 render(conn, "relationship.json", user: follower, target: followed)
343 {:error, message} -> json_response(conn, :forbidden, %{error: message})
347 @doc "POST /api/v1/accounts/:id/unfollow"
348 def unfollow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
352 def unfollow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
353 with {:ok, follower} <- CommonAPI.unfollow(follower, followed) do
354 render(conn, "relationship.json", user: follower, target: followed)
358 @doc "POST /api/v1/accounts/:id/mute"
359 def mute(%{assigns: %{user: muter, account: muted}} = conn, params) do
360 notifications? = params |> Map.get("notifications", true) |> truthy_param?()
362 with {:ok, _user_relationships} <- User.mute(muter, muted, notifications?) do
363 render(conn, "relationship.json", user: muter, target: muted)
365 {:error, message} -> json_response(conn, :forbidden, %{error: message})
369 @doc "POST /api/v1/accounts/:id/unmute"
370 def unmute(%{assigns: %{user: muter, account: muted}} = conn, _params) do
371 with {:ok, _user_relationships} <- User.unmute(muter, muted) do
372 render(conn, "relationship.json", user: muter, target: muted)
374 {:error, message} -> json_response(conn, :forbidden, %{error: message})
378 @doc "POST /api/v1/accounts/:id/block"
379 def block(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
380 with {:ok, _user_block} <- User.block(blocker, blocked),
381 {:ok, _activity} <- ActivityPub.block(blocker, blocked) do
382 render(conn, "relationship.json", user: blocker, target: blocked)
384 {:error, message} -> json_response(conn, :forbidden, %{error: message})
388 @doc "POST /api/v1/accounts/:id/unblock"
389 def unblock(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
390 with {:ok, _user_block} <- User.unblock(blocker, blocked),
391 {:ok, _activity} <- ActivityPub.unblock(blocker, blocked) do
392 render(conn, "relationship.json", user: blocker, target: blocked)
394 {:error, message} -> json_response(conn, :forbidden, %{error: message})
398 @doc "POST /api/v1/follows"
399 def follows(%{assigns: %{user: follower}} = conn, %{"uri" => uri}) do
400 with {_, %User{} = followed} <- {:followed, User.get_cached_by_nickname(uri)},
401 {_, true} <- {:followed, follower.id != followed.id},
402 {:ok, follower, followed, _} <- CommonAPI.follow(follower, followed) do
403 render(conn, "show.json", user: followed, for: follower)
405 {:followed, _} -> {:error, :not_found}
406 {:error, message} -> json_response(conn, :forbidden, %{error: message})
410 @doc "GET /api/v1/mutes"
411 def mutes(%{assigns: %{user: user}} = conn, _) do
412 users = User.muted_users(user, _restrict_deactivated = true)
413 render(conn, "index.json", users: users, for: user, as: :user)
416 @doc "GET /api/v1/blocks"
417 def blocks(%{assigns: %{user: user}} = conn, _) do
418 users = User.blocked_users(user, _restrict_deactivated = true)
419 render(conn, "index.json", users: users, for: user, as: :user)
422 @doc "GET /api/v1/endorsements"
423 def endorsements(conn, params),
424 do: Pleroma.Web.MastodonAPI.MastodonAPIController.empty_array(conn, params)