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] when action == :create
88 action_fallback(Pleroma.Web.MastodonAPI.FallbackController)
90 defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.AccountOperation
92 @doc "POST /api/v1/accounts"
93 def create(%{assigns: %{app: app}, body_params: params} = conn, _params) do
101 :captcha_answer_data,
106 |> Map.put(:nickname, params.username)
107 |> Map.put(:fullname, params.fullname || params.username)
108 |> Map.put(:bio, params.bio || "")
109 |> Map.put(:confirm, params.password)
111 with :ok <- validate_email_param(params),
112 {:ok, user} <- TwitterAPI.register_user(params, need_confirmation: true),
113 {:ok, token} <- Token.create_token(app, user, %{scopes: app.scopes}) do
115 token_type: "Bearer",
116 access_token: token.token,
118 created_at: Token.Utils.format_created_at(token)
121 {:error, errors} -> json_response(conn, :bad_request, errors)
125 def create(%{assigns: %{app: _app}} = conn, _) do
126 render_error(conn, :bad_request, "Missing parameters")
129 def create(conn, _) do
130 render_error(conn, :forbidden, "Invalid credentials")
133 defp validate_email_param(%{:email => email}) when not is_nil(email), do: :ok
135 defp validate_email_param(_) do
136 case Pleroma.Config.get([:instance, :account_activation_required]) do
137 true -> {:error, %{"error" => "Missing parameters"}}
142 @doc "GET /api/v1/accounts/verify_credentials"
143 def verify_credentials(%{assigns: %{user: user}} = conn, _) do
144 chat_token = Phoenix.Token.sign(conn, "user socket", user.id)
146 render(conn, "show.json",
149 with_pleroma_settings: true,
150 with_chat_token: chat_token
154 @doc "PATCH /api/v1/accounts/update_credentials"
155 def update_credentials(%{assigns: %{user: original_user}} = conn, params) do
162 :hide_followers_count,
168 :skip_thread_containment,
169 :allow_following_move,
172 |> Enum.reduce(%{}, fn key, acc ->
173 add_if_present(acc, params, to_string(key), key, &{:ok, truthy_param?(&1)})
175 |> add_if_present(params, "display_name", :name)
176 |> add_if_present(params, "note", :bio)
177 |> add_if_present(params, "avatar", :avatar)
178 |> add_if_present(params, "header", :banner)
179 |> add_if_present(params, "pleroma_background_image", :background)
184 &{:ok, normalize_fields_attributes(&1)}
186 |> add_if_present(params, "pleroma_settings_store", :pleroma_settings_store)
187 |> add_if_present(params, "default_scope", :default_scope)
188 |> add_if_present(params, "actor_type", :actor_type)
190 changeset = User.update_changeset(user, user_params)
192 with {:ok, user} <- User.update_and_set_cache(changeset) do
193 if original_user != user, do: CommonAPI.update(user)
195 render(conn, "show.json", user: user, for: user, with_pleroma_settings: true)
197 _e -> render_error(conn, :forbidden, "Invalid request")
201 defp add_if_present(map, params, params_field, map_field, value_function \\ &{:ok, &1}) do
202 with true <- Map.has_key?(params, params_field),
203 {:ok, new_value} <- value_function.(params[params_field]) do
204 Map.put(map, map_field, new_value)
210 defp normalize_fields_attributes(fields) do
211 if Enum.all?(fields, &is_tuple/1) do
212 Enum.map(fields, fn {_, v} -> v end)
218 @doc "GET /api/v1/accounts/relationships"
219 def relationships(%{assigns: %{user: user}} = conn, %{"id" => id}) do
220 targets = User.get_all_by_ids(List.wrap(id))
222 render(conn, "relationships.json", user: user, targets: targets)
225 # Instead of returning a 400 when no "id" params is present, Mastodon returns an empty array.
226 def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, [])
228 @doc "GET /api/v1/accounts/:id"
229 def show(%{assigns: %{user: for_user}} = conn, %{"id" => nickname_or_id}) do
230 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user),
231 true <- User.visible_for?(user, for_user) do
232 render(conn, "show.json", user: user, for: for_user)
234 _e -> render_error(conn, :not_found, "Can't find user")
238 @doc "GET /api/v1/accounts/:id/statuses"
239 def statuses(%{assigns: %{user: reading_user}} = conn, params) do
240 with %User{} = user <- User.get_cached_by_nickname_or_id(params["id"], for: reading_user),
241 true <- User.visible_for?(user, reading_user) do
244 |> Map.put("tag", params["tagged"])
245 |> Map.delete("godmode")
247 activities = ActivityPub.fetch_user_activities(user, reading_user, params)
250 |> add_link_headers(activities)
251 |> put_view(StatusView)
252 |> render("index.json",
253 activities: activities,
256 skip_relationships: skip_relationships?(params)
259 _e -> render_error(conn, :not_found, "Can't find user")
263 @doc "GET /api/v1/accounts/:id/followers"
264 def followers(%{assigns: %{user: for_user, account: user}} = conn, params) do
267 for_user && user.id == for_user.id -> MastodonAPI.get_followers(user, params)
268 user.hide_followers -> []
269 true -> MastodonAPI.get_followers(user, params)
273 |> add_link_headers(followers)
274 |> render("index.json", for: for_user, users: followers, as: :user)
277 @doc "GET /api/v1/accounts/:id/following"
278 def following(%{assigns: %{user: for_user, account: user}} = conn, params) do
281 for_user && user.id == for_user.id -> MastodonAPI.get_friends(user, params)
282 user.hide_follows -> []
283 true -> MastodonAPI.get_friends(user, params)
287 |> add_link_headers(followers)
288 |> render("index.json", for: for_user, users: followers, as: :user)
291 @doc "GET /api/v1/accounts/:id/lists"
292 def lists(%{assigns: %{user: user, account: account}} = conn, _params) do
293 lists = Pleroma.List.get_lists_account_belongs(user, account)
296 |> put_view(ListView)
297 |> render("index.json", lists: lists)
300 @doc "POST /api/v1/accounts/:id/follow"
301 def follow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
305 def follow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
306 with {:ok, follower} <- MastodonAPI.follow(follower, followed, conn.params) do
307 render(conn, "relationship.json", user: follower, target: followed)
309 {:error, message} -> json_response(conn, :forbidden, %{error: message})
313 @doc "POST /api/v1/accounts/:id/unfollow"
314 def unfollow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
318 def unfollow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
319 with {:ok, follower} <- CommonAPI.unfollow(follower, followed) do
320 render(conn, "relationship.json", user: follower, target: followed)
324 @doc "POST /api/v1/accounts/:id/mute"
325 def mute(%{assigns: %{user: muter, account: muted}} = conn, params) do
326 notifications? = params |> Map.get("notifications", true) |> truthy_param?()
328 with {:ok, _user_relationships} <- User.mute(muter, muted, notifications?) do
329 render(conn, "relationship.json", user: muter, target: muted)
331 {:error, message} -> json_response(conn, :forbidden, %{error: message})
335 @doc "POST /api/v1/accounts/:id/unmute"
336 def unmute(%{assigns: %{user: muter, account: muted}} = conn, _params) do
337 with {:ok, _user_relationships} <- User.unmute(muter, muted) do
338 render(conn, "relationship.json", user: muter, target: muted)
340 {:error, message} -> json_response(conn, :forbidden, %{error: message})
344 @doc "POST /api/v1/accounts/:id/block"
345 def block(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
346 with {:ok, _user_block} <- User.block(blocker, blocked),
347 {:ok, _activity} <- ActivityPub.block(blocker, blocked) do
348 render(conn, "relationship.json", user: blocker, target: blocked)
350 {:error, message} -> json_response(conn, :forbidden, %{error: message})
354 @doc "POST /api/v1/accounts/:id/unblock"
355 def unblock(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
356 with {:ok, _user_block} <- User.unblock(blocker, blocked),
357 {:ok, _activity} <- ActivityPub.unblock(blocker, blocked) do
358 render(conn, "relationship.json", user: blocker, target: blocked)
360 {:error, message} -> json_response(conn, :forbidden, %{error: message})
364 @doc "POST /api/v1/follows"
365 def follows(%{assigns: %{user: follower}} = conn, %{"uri" => uri}) do
366 with {_, %User{} = followed} <- {:followed, User.get_cached_by_nickname(uri)},
367 {_, true} <- {:followed, follower.id != followed.id},
368 {:ok, follower, followed, _} <- CommonAPI.follow(follower, followed) do
369 render(conn, "show.json", user: followed, for: follower)
371 {:followed, _} -> {:error, :not_found}
372 {:error, message} -> json_response(conn, :forbidden, %{error: message})
376 @doc "GET /api/v1/mutes"
377 def mutes(%{assigns: %{user: user}} = conn, _) do
378 users = User.muted_users(user, _restrict_deactivated = true)
379 render(conn, "index.json", users: users, for: user, as: :user)
382 @doc "GET /api/v1/blocks"
383 def blocks(%{assigns: %{user: user}} = conn, _) do
384 users = User.blocked_users(user, _restrict_deactivated = true)
385 render(conn, "index.json", users: users, for: user, as: :user)
388 @doc "GET /api/v1/endorsements"
389 def endorsements(conn, params),
390 do: Pleroma.Web.MastodonAPI.MastodonAPIController.empty_array(conn, params)