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)
83 action_fallback(Pleroma.Web.MastodonAPI.FallbackController)
85 @doc "POST /api/v1/accounts"
87 %{assigns: %{app: app}} = conn,
88 %{"username" => nickname, "password" => _, "agreement" => true} = params
96 "captcha_answer_data",
100 |> Map.put("nickname", nickname)
101 |> Map.put("fullname", params["fullname"] || nickname)
102 |> Map.put("bio", params["bio"] || "")
103 |> Map.put("confirm", params["password"])
105 with :ok <- validate_email_param(params),
106 {:ok, user} <- TwitterAPI.register_user(params, need_confirmation: true),
107 {:ok, token} <- Token.create_token(app, user, %{scopes: app.scopes}) do
109 token_type: "Bearer",
110 access_token: token.token,
112 created_at: Token.Utils.format_created_at(token)
115 {:error, errors} -> json_response(conn, :bad_request, errors)
119 def create(%{assigns: %{app: _app}} = conn, _) do
120 render_error(conn, :bad_request, "Missing parameters")
123 def create(conn, _) do
124 render_error(conn, :forbidden, "Invalid credentials")
127 defp validate_email_param(%{"email" => _}), do: :ok
129 defp validate_email_param(_) do
130 case Pleroma.Config.get([:instance, :account_activation_required]) do
131 true -> {:error, %{"error" => "Missing parameters"}}
136 @doc "GET /api/v1/accounts/verify_credentials"
137 def verify_credentials(%{assigns: %{user: user}} = conn, _) do
138 chat_token = Phoenix.Token.sign(conn, "user socket", user.id)
140 render(conn, "show.json",
143 with_pleroma_settings: true,
144 with_chat_token: chat_token
148 @doc "PATCH /api/v1/accounts/update_credentials"
149 def update_credentials(%{assigns: %{user: user}} = conn, params) do
154 :hide_followers_count,
160 :skip_thread_containment,
161 :allow_following_move,
164 |> Enum.reduce(%{}, fn key, acc ->
165 add_if_present(acc, params, to_string(key), key, &{:ok, truthy_param?(&1)})
167 |> add_if_present(params, "display_name", :name)
168 |> add_if_present(params, "note", :bio)
169 |> add_if_present(params, "avatar", :avatar)
170 |> add_if_present(params, "header", :banner)
171 |> add_if_present(params, "pleroma_background_image", :background)
176 &{:ok, normalize_fields_attributes(&1)}
178 |> add_if_present(params, "pleroma_settings_store", :pleroma_settings_store)
179 |> add_if_present(params, "default_scope", :default_scope)
180 |> add_if_present(params, "actor_type", :actor_type)
182 changeset = User.update_changeset(user, user_params)
184 with {:ok, user} <- User.update_and_set_cache(changeset) do
185 render(conn, "show.json", user: user, for: user, with_pleroma_settings: true)
187 _e -> render_error(conn, :forbidden, "Invalid request")
191 defp add_if_present(map, params, params_field, map_field, value_function \\ &{:ok, &1}) do
192 with true <- Map.has_key?(params, params_field),
193 {:ok, new_value} <- value_function.(params[params_field]) do
194 Map.put(map, map_field, new_value)
200 defp normalize_fields_attributes(fields) do
201 if Enum.all?(fields, &is_tuple/1) do
202 Enum.map(fields, fn {_, v} -> v end)
208 @doc "GET /api/v1/accounts/relationships"
209 def relationships(%{assigns: %{user: user}} = conn, %{"id" => id}) do
210 targets = User.get_all_by_ids(List.wrap(id))
212 render(conn, "relationships.json", user: user, targets: targets)
215 # Instead of returning a 400 when no "id" params is present, Mastodon returns an empty array.
216 def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, [])
218 @doc "GET /api/v1/accounts/:id"
219 def show(%{assigns: %{user: for_user}} = conn, %{"id" => nickname_or_id}) do
220 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user),
221 true <- User.visible_for?(user, for_user) do
222 render(conn, "show.json", user: user, for: for_user)
224 _e -> render_error(conn, :not_found, "Can't find user")
228 @doc "GET /api/v1/accounts/:id/statuses"
229 def statuses(%{assigns: %{user: reading_user}} = conn, params) do
230 with %User{} = user <- User.get_cached_by_nickname_or_id(params["id"], for: reading_user),
231 true <- User.visible_for?(user, reading_user) do
234 |> Map.put("tag", params["tagged"])
235 |> Map.delete("godmode")
237 activities = ActivityPub.fetch_user_activities(user, reading_user, params)
240 |> add_link_headers(activities)
241 |> put_view(StatusView)
242 |> render("index.json",
243 activities: activities,
246 skip_relationships: skip_relationships?(params)
249 _e -> render_error(conn, :not_found, "Can't find user")
253 @doc "GET /api/v1/accounts/:id/followers"
254 def followers(%{assigns: %{user: for_user, account: user}} = conn, params) do
257 for_user && user.id == for_user.id -> MastodonAPI.get_followers(user, params)
258 user.hide_followers -> []
259 true -> MastodonAPI.get_followers(user, params)
263 |> add_link_headers(followers)
264 |> render("index.json", for: for_user, users: followers, as: :user)
267 @doc "GET /api/v1/accounts/:id/following"
268 def following(%{assigns: %{user: for_user, account: user}} = conn, params) do
271 for_user && user.id == for_user.id -> MastodonAPI.get_friends(user, params)
272 user.hide_follows -> []
273 true -> MastodonAPI.get_friends(user, params)
277 |> add_link_headers(followers)
278 |> render("index.json", for: for_user, users: followers, as: :user)
281 @doc "GET /api/v1/accounts/:id/lists"
282 def lists(%{assigns: %{user: user, account: account}} = conn, _params) do
283 lists = Pleroma.List.get_lists_account_belongs(user, account)
286 |> put_view(ListView)
287 |> render("index.json", lists: lists)
290 @doc "POST /api/v1/accounts/:id/follow"
291 def follow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
295 def follow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
296 with {:ok, follower} <- MastodonAPI.follow(follower, followed, conn.params) do
297 render(conn, "relationship.json", user: follower, target: followed)
299 {:error, message} -> json_response(conn, :forbidden, %{error: message})
303 @doc "POST /api/v1/accounts/:id/unfollow"
304 def unfollow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
308 def unfollow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
309 with {:ok, follower} <- CommonAPI.unfollow(follower, followed) do
310 render(conn, "relationship.json", user: follower, target: followed)
314 @doc "POST /api/v1/accounts/:id/mute"
315 def mute(%{assigns: %{user: muter, account: muted}} = conn, params) do
316 notifications? = params |> Map.get("notifications", true) |> truthy_param?()
318 with {:ok, _user_relationships} <- User.mute(muter, muted, notifications?) do
319 render(conn, "relationship.json", user: muter, target: muted)
321 {:error, message} -> json_response(conn, :forbidden, %{error: message})
325 @doc "POST /api/v1/accounts/:id/unmute"
326 def unmute(%{assigns: %{user: muter, account: muted}} = conn, _params) do
327 with {:ok, _user_relationships} <- User.unmute(muter, muted) do
328 render(conn, "relationship.json", user: muter, target: muted)
330 {:error, message} -> json_response(conn, :forbidden, %{error: message})
334 @doc "POST /api/v1/accounts/:id/block"
335 def block(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
336 with {:ok, _user_block} <- User.block(blocker, blocked),
337 {:ok, _activity} <- ActivityPub.block(blocker, blocked) do
338 render(conn, "relationship.json", user: blocker, target: blocked)
340 {:error, message} -> json_response(conn, :forbidden, %{error: message})
344 @doc "POST /api/v1/accounts/:id/unblock"
345 def unblock(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
346 with {:ok, _user_block} <- User.unblock(blocker, blocked),
347 {:ok, _activity} <- ActivityPub.unblock(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/follows"
355 def follows(%{assigns: %{user: follower}} = conn, %{"uri" => uri}) do
356 with {_, %User{} = followed} <- {:followed, User.get_cached_by_nickname(uri)},
357 {_, true} <- {:followed, follower.id != followed.id},
358 {:ok, follower, followed, _} <- CommonAPI.follow(follower, followed) do
359 render(conn, "show.json", user: followed, for: follower)
361 {:followed, _} -> {:error, :not_found}
362 {:error, message} -> json_response(conn, :forbidden, %{error: message})
366 @doc "GET /api/v1/mutes"
367 def mutes(%{assigns: %{user: user}} = conn, _) do
368 users = User.muted_users(user, _restrict_deactivated = true)
369 render(conn, "index.json", users: users, for: user, as: :user)
372 @doc "GET /api/v1/blocks"
373 def blocks(%{assigns: %{user: user}} = conn, _) do
374 users = User.blocked_users(user, _restrict_deactivated = true)
375 render(conn, "index.json", users: users, for: user, as: :user)
378 @doc "GET /api/v1/endorsements"
379 def endorsements(conn, params),
380 do: Pleroma.Web.MastodonAPI.MastodonAPIController.empty_array(conn, params)