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,
9 only: [add_link_headers: 2, truthy_param?: 1, assign_account_by_id: 2, json_response: 3]
11 alias Pleroma.Plugs.OAuthScopesPlug
12 alias Pleroma.Plugs.RateLimiter
14 alias Pleroma.Web.ActivityPub.ActivityPub
15 alias Pleroma.Web.CommonAPI
16 alias Pleroma.Web.MastodonAPI.ListView
17 alias Pleroma.Web.MastodonAPI.MastodonAPI
18 alias Pleroma.Web.MastodonAPI.StatusView
19 alias Pleroma.Web.OAuth.Token
20 alias Pleroma.Web.TwitterAPI.TwitterAPI
24 %{fallback: :proceed_unauthenticated, scopes: ["read:accounts"]}
30 %{scopes: ["read:accounts"]}
31 when action in [:endorsements, :verify_credentials, :followers, :following]
34 plug(OAuthScopesPlug, %{scopes: ["write:accounts"]} when action == :update_credentials)
36 plug(OAuthScopesPlug, %{scopes: ["read:lists"]} when action == :lists)
40 %{scopes: ["follow", "read:blocks"]} when action == :blocks
45 %{scopes: ["follow", "write:blocks"]} when action in [:block, :unblock]
48 plug(OAuthScopesPlug, %{scopes: ["read:follows"]} when action == :relationships)
50 # Note: :follows (POST /api/v1/follows) is the same as :follow, consider removing :follows
53 %{scopes: ["follow", "write:follows"]} when action in [:follows, :follow, :unfollow]
56 plug(OAuthScopesPlug, %{scopes: ["follow", "read:mutes"]} when action == :mutes)
58 plug(OAuthScopesPlug, %{scopes: ["follow", "write:mutes"]} when action in [:mute, :unmute])
61 Pleroma.Plugs.EnsurePublicOrAuthenticatedPlug
62 when action not in [:create, :show, :statuses]
65 @relationship_actions [:follow, :unfollow]
66 @needs_account ~W(followers following lists follow unfollow mute unmute block unblock)a
70 [name: :relation_id_action, params: ["id", "uri"]] when action in @relationship_actions
73 plug(RateLimiter, [name: :relations_actions] when action in @relationship_actions)
74 plug(RateLimiter, [name: :app_account_creation] when action == :create)
75 plug(:assign_account_by_id when action in @needs_account)
77 action_fallback(Pleroma.Web.MastodonAPI.FallbackController)
79 @doc "POST /api/v1/accounts"
81 %{assigns: %{app: app}} = conn,
82 %{"username" => nickname, "password" => _, "agreement" => true} = params
90 "captcha_answer_data",
94 |> Map.put("nickname", nickname)
95 |> Map.put("fullname", params["fullname"] || nickname)
96 |> Map.put("bio", params["bio"] || "")
97 |> Map.put("confirm", params["password"])
99 with :ok <- validate_email_param(params),
100 {:ok, user} <- TwitterAPI.register_user(params, need_confirmation: true),
101 {:ok, token} <- Token.create_token(app, user, %{scopes: app.scopes}) do
103 token_type: "Bearer",
104 access_token: token.token,
106 created_at: Token.Utils.format_created_at(token)
109 {:error, errors} -> json_response(conn, :bad_request, errors)
113 def create(%{assigns: %{app: _app}} = conn, _) do
114 render_error(conn, :bad_request, "Missing parameters")
117 def create(conn, _) do
118 render_error(conn, :forbidden, "Invalid credentials")
121 defp validate_email_param(%{"email" => _}), do: :ok
123 defp validate_email_param(_) do
124 case Pleroma.Config.get([:instance, :account_activation_required]) do
125 true -> {:error, %{"error" => "Missing parameters"}}
130 @doc "GET /api/v1/accounts/verify_credentials"
131 def verify_credentials(%{assigns: %{user: user}} = conn, _) do
132 chat_token = Phoenix.Token.sign(conn, "user socket", user.id)
134 render(conn, "show.json",
137 with_pleroma_settings: true,
138 with_chat_token: chat_token
142 @doc "PATCH /api/v1/accounts/update_credentials"
143 def update_credentials(%{assigns: %{user: original_user}} = conn, params) do
150 :hide_followers_count,
156 :skip_thread_containment,
157 :allow_following_move,
160 |> Enum.reduce(%{}, fn key, acc ->
161 add_if_present(acc, params, to_string(key), key, &{:ok, truthy_param?(&1)})
163 |> add_if_present(params, "display_name", :name)
164 |> add_if_present(params, "note", :bio)
165 |> add_if_present(params, "avatar", :avatar)
166 |> add_if_present(params, "header", :banner)
167 |> add_if_present(params, "pleroma_background_image", :background)
172 &{:ok, normalize_fields_attributes(&1)}
174 |> add_if_present(params, "pleroma_settings_store", :pleroma_settings_store)
175 |> add_if_present(params, "default_scope", :default_scope)
176 |> add_if_present(params, "actor_type", :actor_type)
178 changeset = User.update_changeset(user, user_params)
180 with {:ok, user} <- User.update_and_set_cache(changeset) do
181 if original_user != user, do: CommonAPI.update(user)
183 render(conn, "show.json", user: user, for: user, with_pleroma_settings: true)
185 _e -> render_error(conn, :forbidden, "Invalid request")
189 defp add_if_present(map, params, params_field, map_field, value_function \\ &{:ok, &1}) do
190 with true <- Map.has_key?(params, params_field),
191 {:ok, new_value} <- value_function.(params[params_field]) do
192 Map.put(map, map_field, new_value)
198 defp normalize_fields_attributes(fields) do
199 if Enum.all?(fields, &is_tuple/1) do
200 Enum.map(fields, fn {_, v} -> v end)
206 @doc "GET /api/v1/accounts/relationships"
207 def relationships(%{assigns: %{user: user}} = conn, %{"id" => id}) do
208 targets = User.get_all_by_ids(List.wrap(id))
210 render(conn, "relationships.json", user: user, targets: targets)
213 # Instead of returning a 400 when no "id" params is present, Mastodon returns an empty array.
214 def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, [])
216 @doc "GET /api/v1/accounts/:id"
217 def show(%{assigns: %{user: for_user}} = conn, %{"id" => nickname_or_id}) do
218 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user),
219 true <- User.visible_for?(user, for_user) do
220 render(conn, "show.json", user: user, for: for_user)
222 _e -> render_error(conn, :not_found, "Can't find user")
226 @doc "GET /api/v1/accounts/:id/statuses"
227 def statuses(%{assigns: %{user: reading_user}} = conn, params) do
228 with %User{} = user <- User.get_cached_by_nickname_or_id(params["id"], for: reading_user),
229 true <- User.visible_for?(user, reading_user) do
232 |> Map.put("tag", params["tagged"])
233 |> Map.delete("godmode")
235 activities = ActivityPub.fetch_user_activities(user, reading_user, params)
238 |> add_link_headers(activities)
239 |> put_view(StatusView)
240 |> render("index.json", activities: activities, for: reading_user, as: :activity)
242 _e -> render_error(conn, :not_found, "Can't find user")
246 @doc "GET /api/v1/accounts/:id/followers"
247 def followers(%{assigns: %{user: for_user, account: user}} = conn, params) do
250 for_user && user.id == for_user.id -> MastodonAPI.get_followers(user, params)
251 user.hide_followers -> []
252 true -> MastodonAPI.get_followers(user, params)
256 |> add_link_headers(followers)
257 |> render("index.json", for: for_user, users: followers, as: :user)
260 @doc "GET /api/v1/accounts/:id/following"
261 def following(%{assigns: %{user: for_user, account: user}} = conn, params) do
264 for_user && user.id == for_user.id -> MastodonAPI.get_friends(user, params)
265 user.hide_follows -> []
266 true -> MastodonAPI.get_friends(user, params)
270 |> add_link_headers(followers)
271 |> render("index.json", for: for_user, users: followers, as: :user)
274 @doc "GET /api/v1/accounts/:id/lists"
275 def lists(%{assigns: %{user: user, account: account}} = conn, _params) do
276 lists = Pleroma.List.get_lists_account_belongs(user, account)
279 |> put_view(ListView)
280 |> render("index.json", lists: lists)
283 @doc "POST /api/v1/accounts/:id/follow"
284 def follow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
288 def follow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
289 with {:ok, follower} <- MastodonAPI.follow(follower, followed, conn.params) do
290 render(conn, "relationship.json", user: follower, target: followed)
292 {:error, message} -> json_response(conn, :forbidden, %{error: message})
296 @doc "POST /api/v1/accounts/:id/unfollow"
297 def unfollow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
301 def unfollow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
302 with {:ok, follower} <- CommonAPI.unfollow(follower, followed) do
303 render(conn, "relationship.json", user: follower, target: followed)
307 @doc "POST /api/v1/accounts/:id/mute"
308 def mute(%{assigns: %{user: muter, account: muted}} = conn, params) do
309 notifications? = params |> Map.get("notifications", true) |> truthy_param?()
311 with {:ok, _user_relationships} <- User.mute(muter, muted, notifications?) do
312 render(conn, "relationship.json", user: muter, target: muted)
314 {:error, message} -> json_response(conn, :forbidden, %{error: message})
318 @doc "POST /api/v1/accounts/:id/unmute"
319 def unmute(%{assigns: %{user: muter, account: muted}} = conn, _params) do
320 with {:ok, _user_relationships} <- User.unmute(muter, muted) do
321 render(conn, "relationship.json", user: muter, target: muted)
323 {:error, message} -> json_response(conn, :forbidden, %{error: message})
327 @doc "POST /api/v1/accounts/:id/block"
328 def block(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
329 with {:ok, _user_block} <- User.block(blocker, blocked),
330 {:ok, _activity} <- ActivityPub.block(blocker, blocked) do
331 render(conn, "relationship.json", user: blocker, target: blocked)
333 {:error, message} -> json_response(conn, :forbidden, %{error: message})
337 @doc "POST /api/v1/accounts/:id/unblock"
338 def unblock(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
339 with {:ok, _user_block} <- User.unblock(blocker, blocked),
340 {:ok, _activity} <- ActivityPub.unblock(blocker, blocked) do
341 render(conn, "relationship.json", user: blocker, target: blocked)
343 {:error, message} -> json_response(conn, :forbidden, %{error: message})
347 @doc "POST /api/v1/follows"
348 def follows(%{assigns: %{user: follower}} = conn, %{"uri" => uri}) do
349 with {_, %User{} = followed} <- {:followed, User.get_cached_by_nickname(uri)},
350 {_, true} <- {:followed, follower.id != followed.id},
351 {:ok, follower, followed, _} <- CommonAPI.follow(follower, followed) do
352 render(conn, "show.json", user: followed, for: follower)
354 {:followed, _} -> {:error, :not_found}
355 {:error, message} -> json_response(conn, :forbidden, %{error: message})
359 @doc "GET /api/v1/mutes"
360 def mutes(%{assigns: %{user: user}} = conn, _) do
361 users = User.muted_users(user, _restrict_deactivated = true)
362 render(conn, "index.json", users: users, for: user, as: :user)
365 @doc "GET /api/v1/blocks"
366 def blocks(%{assigns: %{user: user}} = conn, _) do
367 users = User.blocked_users(user, _restrict_deactivated = true)
368 render(conn, "index.json", users: users, for: user, as: :user)
371 @doc "GET /api/v1/endorsements"
372 def endorsements(conn, params),
373 do: Pleroma.Web.MastodonAPI.MastodonAPIController.empty_array(conn, params)