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]
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
112 :captcha_answer_data,
117 |> Map.put(:nickname, params.username)
118 |> Map.put(:fullname, params.fullname || params.username)
119 |> Map.put(:bio, params.bio || "")
120 |> Map.put(:confirm, params.password)
122 with :ok <- validate_email_param(params),
123 {:ok, user} <- TwitterAPI.register_user(params, need_confirmation: true),
124 {:ok, token} <- Token.create_token(app, user, %{scopes: app.scopes}) do
126 token_type: "Bearer",
127 access_token: token.token,
129 created_at: Token.Utils.format_created_at(token)
132 {:error, errors} -> json_response(conn, :bad_request, errors)
136 def create(%{assigns: %{app: _app}} = conn, _) do
137 render_error(conn, :bad_request, "Missing parameters")
140 def create(conn, _) do
141 render_error(conn, :forbidden, "Invalid credentials")
144 defp validate_email_param(%{:email => email}) when not is_nil(email), do: :ok
146 defp validate_email_param(_) do
147 case Pleroma.Config.get([:instance, :account_activation_required]) do
148 true -> {:error, %{"error" => "Missing parameters"}}
153 @doc "GET /api/v1/accounts/verify_credentials"
154 def verify_credentials(%{assigns: %{user: user}} = conn, _) do
155 chat_token = Phoenix.Token.sign(conn, "user socket", user.id)
157 render(conn, "show.json",
160 with_pleroma_settings: true,
161 with_chat_token: chat_token
165 @doc "PATCH /api/v1/accounts/update_credentials"
166 def update_credentials(%{assigns: %{user: original_user}, body_params: params} = conn, _params) do
172 |> Enum.filter(fn {_, value} -> not is_nil(value) end)
179 :hide_followers_count,
185 :skip_thread_containment,
186 :allow_following_move,
189 |> Enum.reduce(%{}, fn key, acc ->
190 add_if_present(acc, params, key, key, &{:ok, truthy_param?(&1)})
192 |> add_if_present(params, :display_name, :name)
193 |> add_if_present(params, :note, :bio)
194 |> add_if_present(params, :avatar, :avatar)
195 |> add_if_present(params, :header, :banner)
196 |> add_if_present(params, :pleroma_background_image, :background)
201 &{:ok, normalize_fields_attributes(&1)}
203 |> add_if_present(params, :pleroma_settings_store, :pleroma_settings_store)
204 |> add_if_present(params, :default_scope, :default_scope)
205 |> add_if_present(params, :actor_type, :actor_type)
207 changeset = User.update_changeset(user, user_params)
209 with {:ok, user} <- User.update_and_set_cache(changeset) do
210 if original_user != user, do: CommonAPI.update(user)
212 render(conn, "show.json", user: user, for: user, with_pleroma_settings: true)
214 _e -> render_error(conn, :forbidden, "Invalid request")
218 defp add_if_present(map, params, params_field, map_field, value_function \\ &{:ok, &1}) do
219 with true <- Map.has_key?(params, params_field),
220 {:ok, new_value} <- value_function.(Map.get(params, params_field)) do
221 Map.put(map, map_field, new_value)
227 defp normalize_fields_attributes(fields) do
228 if Enum.all?(fields, &is_tuple/1) do
229 Enum.map(fields, fn {_, v} -> v end)
232 %Pleroma.Web.ApiSpec.Schemas.AccountAttributeField{} = field ->
233 %{"name" => field.name, "value" => field.value}
241 @doc "GET /api/v1/accounts/relationships"
242 def relationships(%{assigns: %{user: user}} = conn, %{id: id}) do
243 targets = User.get_all_by_ids(List.wrap(id))
245 render(conn, "relationships.json", user: user, targets: targets)
248 # Instead of returning a 400 when no "id" params is present, Mastodon returns an empty array.
249 def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, [])
251 @doc "GET /api/v1/accounts/:id"
252 def show(%{assigns: %{user: for_user}} = conn, %{id: nickname_or_id}) do
253 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user),
254 true <- User.visible_for?(user, for_user) do
255 render(conn, "show.json", user: user, for: for_user)
257 _e -> render_error(conn, :not_found, "Can't find user")
261 @doc "GET /api/v1/accounts/:id/statuses"
262 def statuses(%{assigns: %{user: reading_user}} = conn, params) do
263 with %User{} = user <- User.get_cached_by_nickname_or_id(params.id, for: reading_user),
264 true <- User.visible_for?(user, reading_user) do
267 |> Map.delete(:tagged)
268 |> Enum.filter(&(not is_nil(&1)))
269 |> Map.new(fn {key, value} -> {to_string(key), value} end)
270 |> Map.put("tag", params[:tagged])
272 activities = ActivityPub.fetch_user_activities(user, reading_user, params)
275 |> add_link_headers(activities)
276 |> put_view(StatusView)
277 |> render("index.json",
278 activities: activities,
281 skip_relationships: skip_relationships?(params)
284 _e -> render_error(conn, :not_found, "Can't find user")
288 @doc "GET /api/v1/accounts/:id/followers"
289 def followers(%{assigns: %{user: for_user, account: user}} = conn, params) do
292 |> Enum.map(fn {key, value} -> {to_string(key), value} end)
297 for_user && user.id == for_user.id -> MastodonAPI.get_followers(user, params)
298 user.hide_followers -> []
299 true -> MastodonAPI.get_followers(user, params)
303 |> add_link_headers(followers)
304 |> render("index.json", for: for_user, users: followers, as: :user)
307 @doc "GET /api/v1/accounts/:id/following"
308 def following(%{assigns: %{user: for_user, account: user}} = conn, params) do
311 |> Enum.map(fn {key, value} -> {to_string(key), value} end)
316 for_user && user.id == for_user.id -> MastodonAPI.get_friends(user, params)
317 user.hide_follows -> []
318 true -> MastodonAPI.get_friends(user, params)
322 |> add_link_headers(followers)
323 |> render("index.json", for: for_user, users: followers, as: :user)
326 @doc "GET /api/v1/accounts/:id/lists"
327 def lists(%{assigns: %{user: user, account: account}} = conn, _params) do
328 lists = Pleroma.List.get_lists_account_belongs(user, account)
331 |> put_view(ListView)
332 |> render("index.json", lists: lists)
335 @doc "POST /api/v1/accounts/:id/follow"
336 def follow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
340 def follow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
341 with {:ok, follower} <- MastodonAPI.follow(follower, followed, conn.params) do
342 render(conn, "relationship.json", user: follower, target: followed)
344 {:error, message} -> json_response(conn, :forbidden, %{error: message})
348 @doc "POST /api/v1/accounts/:id/unfollow"
349 def unfollow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
353 def unfollow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
354 with {:ok, follower} <- CommonAPI.unfollow(follower, followed) do
355 render(conn, "relationship.json", user: follower, target: followed)
359 @doc "POST /api/v1/accounts/:id/mute"
360 def mute(%{assigns: %{user: muter, account: muted}} = conn, params) do
361 notifications? = params |> Map.get("notifications", true) |> truthy_param?()
363 with {:ok, _user_relationships} <- User.mute(muter, muted, notifications?) do
364 render(conn, "relationship.json", user: muter, target: muted)
366 {:error, message} -> json_response(conn, :forbidden, %{error: message})
370 @doc "POST /api/v1/accounts/:id/unmute"
371 def unmute(%{assigns: %{user: muter, account: muted}} = conn, _params) do
372 with {:ok, _user_relationships} <- User.unmute(muter, muted) do
373 render(conn, "relationship.json", user: muter, target: muted)
375 {:error, message} -> json_response(conn, :forbidden, %{error: message})
379 @doc "POST /api/v1/accounts/:id/block"
380 def block(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
381 with {:ok, _user_block} <- User.block(blocker, blocked),
382 {:ok, _activity} <- ActivityPub.block(blocker, blocked) do
383 render(conn, "relationship.json", user: blocker, target: blocked)
385 {:error, message} -> json_response(conn, :forbidden, %{error: message})
389 @doc "POST /api/v1/accounts/:id/unblock"
390 def unblock(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
391 with {:ok, _user_block} <- User.unblock(blocker, blocked),
392 {:ok, _activity} <- ActivityPub.unblock(blocker, blocked) do
393 render(conn, "relationship.json", user: blocker, target: blocked)
395 {:error, message} -> json_response(conn, :forbidden, %{error: message})
399 @doc "POST /api/v1/follows"
400 def follows(%{assigns: %{user: follower}} = conn, %{"uri" => uri}) do
401 with {_, %User{} = followed} <- {:followed, User.get_cached_by_nickname(uri)},
402 {_, true} <- {:followed, follower.id != followed.id},
403 {:ok, follower, followed, _} <- CommonAPI.follow(follower, followed) do
404 render(conn, "show.json", user: followed, for: follower)
406 {:followed, _} -> {:error, :not_found}
407 {:error, message} -> json_response(conn, :forbidden, %{error: message})
411 @doc "GET /api/v1/mutes"
412 def mutes(%{assigns: %{user: user}} = conn, _) do
413 users = User.muted_users(user, _restrict_deactivated = true)
414 render(conn, "index.json", users: users, for: user, as: :user)
417 @doc "GET /api/v1/blocks"
418 def blocks(%{assigns: %{user: user}} = conn, _) do
419 users = User.blocked_users(user, _restrict_deactivated = true)
420 render(conn, "index.json", users: users, for: user, as: :user)
423 @doc "GET /api/v1/endorsements"
424 def endorsements(conn, params),
425 do: Pleroma.Web.MastodonAPI.MastodonAPIController.empty_array(conn, params)