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]
105 action_fallback(Pleroma.Web.MastodonAPI.FallbackController)
107 defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.AccountOperation
109 @doc "POST /api/v1/accounts"
110 def create(%{assigns: %{app: app}, body_params: params} = conn, _params) do
118 :captcha_answer_data,
123 |> Map.put(:nickname, params.username)
124 |> Map.put(:fullname, params.fullname || params.username)
125 |> Map.put(:bio, params.bio || "")
126 |> Map.put(:confirm, params.password)
128 with :ok <- validate_email_param(params),
129 {:ok, user} <- TwitterAPI.register_user(params, need_confirmation: true),
130 {:ok, token} <- Token.create_token(app, user, %{scopes: app.scopes}) do
132 token_type: "Bearer",
133 access_token: token.token,
135 created_at: Token.Utils.format_created_at(token)
138 {:error, errors} -> json_response(conn, :bad_request, errors)
142 def create(%{assigns: %{app: _app}} = conn, _) do
143 render_error(conn, :bad_request, "Missing parameters")
146 def create(conn, _) do
147 render_error(conn, :forbidden, "Invalid credentials")
150 defp validate_email_param(%{:email => email}) when not is_nil(email), do: :ok
152 defp validate_email_param(_) do
153 case Pleroma.Config.get([:instance, :account_activation_required]) do
154 true -> {:error, %{"error" => "Missing parameters"}}
159 @doc "GET /api/v1/accounts/verify_credentials"
160 def verify_credentials(%{assigns: %{user: user}} = conn, _) do
161 chat_token = Phoenix.Token.sign(conn, "user socket", user.id)
163 render(conn, "show.json",
166 with_pleroma_settings: true,
167 with_chat_token: chat_token
171 @doc "PATCH /api/v1/accounts/update_credentials"
172 def update_credentials(%{assigns: %{user: original_user}, body_params: params} = conn, _params) do
178 |> Enum.filter(fn {_, value} -> not is_nil(value) end)
185 :hide_followers_count,
191 :skip_thread_containment,
192 :allow_following_move,
195 |> Enum.reduce(%{}, fn key, acc ->
196 add_if_present(acc, params, key, key, &{:ok, truthy_param?(&1)})
198 |> add_if_present(params, :display_name, :name)
199 |> add_if_present(params, :note, :bio)
200 |> add_if_present(params, :avatar, :avatar)
201 |> add_if_present(params, :header, :banner)
202 |> add_if_present(params, :pleroma_background_image, :background)
207 &{:ok, normalize_fields_attributes(&1)}
209 |> add_if_present(params, :pleroma_settings_store, :pleroma_settings_store)
210 |> add_if_present(params, :default_scope, :default_scope)
211 |> add_if_present(params, :actor_type, :actor_type)
213 changeset = User.update_changeset(user, user_params)
215 with {:ok, user} <- User.update_and_set_cache(changeset) do
216 if original_user != user, do: CommonAPI.update(user)
218 render(conn, "show.json", user: user, for: user, with_pleroma_settings: true)
220 _e -> render_error(conn, :forbidden, "Invalid request")
224 defp add_if_present(map, params, params_field, map_field, value_function \\ &{:ok, &1}) do
225 with true <- Map.has_key?(params, params_field),
226 {:ok, new_value} <- value_function.(Map.get(params, params_field)) do
227 Map.put(map, map_field, new_value)
233 defp normalize_fields_attributes(fields) do
234 if Enum.all?(fields, &is_tuple/1) do
235 Enum.map(fields, fn {_, v} -> v end)
238 %Pleroma.Web.ApiSpec.Schemas.AccountAttributeField{} = field ->
239 %{"name" => field.name, "value" => field.value}
247 @doc "GET /api/v1/accounts/relationships"
248 def relationships(%{assigns: %{user: user}} = conn, %{id: id}) do
249 targets = User.get_all_by_ids(List.wrap(id))
251 render(conn, "relationships.json", user: user, targets: targets)
254 # Instead of returning a 400 when no "id" params is present, Mastodon returns an empty array.
255 def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, [])
257 @doc "GET /api/v1/accounts/:id"
258 def show(%{assigns: %{user: for_user}} = conn, %{id: nickname_or_id}) do
259 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user),
260 true <- User.visible_for?(user, for_user) do
261 render(conn, "show.json", user: user, for: for_user)
263 _e -> render_error(conn, :not_found, "Can't find user")
267 @doc "GET /api/v1/accounts/:id/statuses"
268 def statuses(%{assigns: %{user: reading_user}} = conn, params) do
269 with %User{} = user <- User.get_cached_by_nickname_or_id(params.id, for: reading_user),
270 true <- User.visible_for?(user, reading_user) do
273 |> Map.delete(:tagged)
274 |> Enum.filter(&(not is_nil(&1)))
275 |> Map.new(fn {key, value} -> {to_string(key), value} end)
276 |> Map.put("tag", params[:tagged])
278 activities = ActivityPub.fetch_user_activities(user, reading_user, params)
281 |> add_link_headers(activities)
282 |> put_view(StatusView)
283 |> render("index.json",
284 activities: activities,
287 skip_relationships: skip_relationships?(params)
290 _e -> render_error(conn, :not_found, "Can't find user")
294 @doc "GET /api/v1/accounts/:id/followers"
295 def followers(%{assigns: %{user: for_user, account: user}} = conn, params) do
298 |> Enum.map(fn {key, value} -> {to_string(key), value} end)
303 for_user && user.id == for_user.id -> MastodonAPI.get_followers(user, params)
304 user.hide_followers -> []
305 true -> MastodonAPI.get_followers(user, params)
309 |> add_link_headers(followers)
310 |> render("index.json", for: for_user, users: followers, as: :user)
313 @doc "GET /api/v1/accounts/:id/following"
314 def following(%{assigns: %{user: for_user, account: user}} = conn, params) do
317 |> Enum.map(fn {key, value} -> {to_string(key), value} end)
322 for_user && user.id == for_user.id -> MastodonAPI.get_friends(user, params)
323 user.hide_follows -> []
324 true -> MastodonAPI.get_friends(user, params)
328 |> add_link_headers(followers)
329 |> render("index.json", for: for_user, users: followers, as: :user)
332 @doc "GET /api/v1/accounts/:id/lists"
333 def lists(%{assigns: %{user: user, account: account}} = conn, _params) do
334 lists = Pleroma.List.get_lists_account_belongs(user, account)
337 |> put_view(ListView)
338 |> render("index.json", lists: lists)
341 @doc "POST /api/v1/accounts/:id/follow"
342 def follow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
346 def follow(%{assigns: %{user: follower, account: followed}} = conn, params) do
347 with {:ok, follower} <- MastodonAPI.follow(follower, followed, params) do
348 render(conn, "relationship.json", user: follower, target: followed)
350 {:error, message} -> json_response(conn, :forbidden, %{error: message})
354 @doc "POST /api/v1/accounts/:id/unfollow"
355 def unfollow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
359 def unfollow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
360 with {:ok, follower} <- CommonAPI.unfollow(follower, followed) do
361 render(conn, "relationship.json", user: follower, target: followed)
365 @doc "POST /api/v1/accounts/:id/mute"
366 def mute(%{assigns: %{user: muter, account: muted}, body_params: params} = conn, _params) do
367 with {:ok, _user_relationships} <- User.mute(muter, muted, params.notifications) do
368 render(conn, "relationship.json", user: muter, target: muted)
370 {:error, message} -> json_response(conn, :forbidden, %{error: message})
374 @doc "POST /api/v1/accounts/:id/unmute"
375 def unmute(%{assigns: %{user: muter, account: muted}} = conn, _params) do
376 with {:ok, _user_relationships} <- User.unmute(muter, muted) do
377 render(conn, "relationship.json", user: muter, target: muted)
379 {:error, message} -> json_response(conn, :forbidden, %{error: message})
383 @doc "POST /api/v1/accounts/:id/block"
384 def block(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
385 with {:ok, _user_block} <- User.block(blocker, blocked),
386 {:ok, _activity} <- ActivityPub.block(blocker, blocked) do
387 render(conn, "relationship.json", user: blocker, target: blocked)
389 {:error, message} -> json_response(conn, :forbidden, %{error: message})
393 @doc "POST /api/v1/accounts/:id/unblock"
394 def unblock(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
395 with {:ok, _user_block} <- User.unblock(blocker, blocked),
396 {:ok, _activity} <- ActivityPub.unblock(blocker, blocked) do
397 render(conn, "relationship.json", user: blocker, target: blocked)
399 {:error, message} -> json_response(conn, :forbidden, %{error: message})
403 @doc "POST /api/v1/follows"
404 def follows(%{assigns: %{user: follower}} = conn, %{"uri" => uri}) do
405 with {_, %User{} = followed} <- {:followed, User.get_cached_by_nickname(uri)},
406 {_, true} <- {:followed, follower.id != followed.id},
407 {:ok, follower, followed, _} <- CommonAPI.follow(follower, followed) do
408 render(conn, "show.json", user: followed, for: follower)
410 {:followed, _} -> {:error, :not_found}
411 {:error, message} -> json_response(conn, :forbidden, %{error: message})
415 @doc "GET /api/v1/mutes"
416 def mutes(%{assigns: %{user: user}} = conn, _) do
417 users = User.muted_users(user, _restrict_deactivated = true)
418 render(conn, "index.json", users: users, for: user, as: :user)
421 @doc "GET /api/v1/blocks"
422 def blocks(%{assigns: %{user: user}} = conn, _) do
423 users = User.blocked_users(user, _restrict_deactivated = true)
424 render(conn, "index.json", users: users, for: user, as: :user)
427 @doc "GET /api/v1/endorsements"
428 def endorsements(conn, params),
429 do: Pleroma.Web.MastodonAPI.MastodonAPIController.empty_array(conn, params)