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 != :create
65 @relations [:follow, :unfollow]
66 @needs_account ~W(followers following lists follow unfollow mute unmute block unblock)a
68 plug(RateLimiter, [name: :relations_id_action, params: ["id", "uri"]] when action in @relations)
69 plug(RateLimiter, [name: :relations_actions] when action in @relations)
70 plug(RateLimiter, [name: :app_account_creation] when action == :create)
71 plug(:assign_account_by_id when action in @needs_account)
73 action_fallback(Pleroma.Web.MastodonAPI.FallbackController)
75 @doc "POST /api/v1/accounts"
77 %{assigns: %{app: app}} = conn,
78 %{"username" => nickname, "password" => _, "agreement" => true} = params
86 "captcha_answer_data",
90 |> Map.put("nickname", nickname)
91 |> Map.put("fullname", params["fullname"] || nickname)
92 |> Map.put("bio", params["bio"] || "")
93 |> Map.put("confirm", params["password"])
95 with :ok <- validate_email_param(params),
96 {:ok, user} <- TwitterAPI.register_user(params, need_confirmation: true),
97 {:ok, token} <- Token.create_token(app, user, %{scopes: app.scopes}) do
100 access_token: token.token,
102 created_at: Token.Utils.format_created_at(token)
105 {:error, errors} -> json_response(conn, :bad_request, errors)
109 def create(%{assigns: %{app: _app}} = conn, _) do
110 render_error(conn, :bad_request, "Missing parameters")
113 def create(conn, _) do
114 render_error(conn, :forbidden, "Invalid credentials")
117 defp validate_email_param(%{"email" => _}), do: :ok
119 defp validate_email_param(_) do
120 case Pleroma.Config.get([:instance, :account_activation_required]) do
121 true -> {:error, %{"error" => "Missing parameters"}}
126 @doc "GET /api/v1/accounts/verify_credentials"
127 def verify_credentials(%{assigns: %{user: user}} = conn, _) do
128 chat_token = Phoenix.Token.sign(conn, "user socket", user.id)
130 render(conn, "show.json",
133 with_pleroma_settings: true,
134 with_chat_token: chat_token
138 @doc "PATCH /api/v1/accounts/update_credentials"
139 def update_credentials(%{assigns: %{user: original_user}} = conn, params) do
146 :hide_followers_count,
152 :skip_thread_containment,
153 :allow_following_move,
156 |> Enum.reduce(%{}, fn key, acc ->
157 add_if_present(acc, params, to_string(key), key, &{:ok, truthy_param?(&1)})
159 |> add_if_present(params, "display_name", :name)
160 |> add_if_present(params, "note", :bio)
161 |> add_if_present(params, "avatar", :avatar)
162 |> add_if_present(params, "header", :banner)
163 |> add_if_present(params, "pleroma_background_image", :background)
168 &{:ok, normalize_fields_attributes(&1)}
170 |> add_if_present(params, "pleroma_settings_store", :pleroma_settings_store)
171 |> add_if_present(params, "default_scope", :default_scope)
172 |> add_if_present(params, "actor_type", :actor_type)
174 changeset = User.update_changeset(user, user_params)
176 with {:ok, user} <- User.update_and_set_cache(changeset) do
177 if original_user != user, do: CommonAPI.update(user)
179 render(conn, "show.json", user: user, for: user, with_pleroma_settings: true)
181 _e -> render_error(conn, :forbidden, "Invalid request")
185 defp add_if_present(map, params, params_field, map_field, value_function \\ &{:ok, &1}) do
186 with true <- Map.has_key?(params, params_field),
187 {:ok, new_value} <- value_function.(params[params_field]) do
188 Map.put(map, map_field, new_value)
194 defp normalize_fields_attributes(fields) do
195 if Enum.all?(fields, &is_tuple/1) do
196 Enum.map(fields, fn {_, v} -> v end)
202 @doc "GET /api/v1/accounts/relationships"
203 def relationships(%{assigns: %{user: user}} = conn, %{"id" => id}) do
204 targets = User.get_all_by_ids(List.wrap(id))
206 render(conn, "relationships.json", user: user, targets: targets)
209 # Instead of returning a 400 when no "id" params is present, Mastodon returns an empty array.
210 def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, [])
212 @doc "GET /api/v1/accounts/:id"
213 def show(%{assigns: %{user: for_user}} = conn, %{"id" => nickname_or_id}) do
214 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user),
215 true <- User.visible_for?(user, for_user) do
216 render(conn, "show.json", user: user, for: for_user)
218 _e -> render_error(conn, :not_found, "Can't find user")
222 @doc "GET /api/v1/accounts/:id/statuses"
223 def statuses(%{assigns: %{user: reading_user}} = conn, params) do
224 with %User{} = user <- User.get_cached_by_nickname_or_id(params["id"], for: reading_user) do
227 |> Map.put("tag", params["tagged"])
228 |> Map.delete("godmode")
230 activities = ActivityPub.fetch_user_activities(user, reading_user, params)
233 |> add_link_headers(activities)
234 |> put_view(StatusView)
235 |> render("index.json", activities: activities, for: reading_user, as: :activity)
239 @doc "GET /api/v1/accounts/:id/followers"
240 def followers(%{assigns: %{user: for_user, account: user}} = conn, params) do
243 for_user && user.id == for_user.id -> MastodonAPI.get_followers(user, params)
244 user.hide_followers -> []
245 true -> MastodonAPI.get_followers(user, params)
249 |> add_link_headers(followers)
250 |> render("index.json", for: for_user, users: followers, as: :user)
253 @doc "GET /api/v1/accounts/:id/following"
254 def following(%{assigns: %{user: for_user, account: user}} = conn, params) do
257 for_user && user.id == for_user.id -> MastodonAPI.get_friends(user, params)
258 user.hide_follows -> []
259 true -> MastodonAPI.get_friends(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/lists"
268 def lists(%{assigns: %{user: user, account: account}} = conn, _params) do
269 lists = Pleroma.List.get_lists_account_belongs(user, account)
272 |> put_view(ListView)
273 |> render("index.json", lists: lists)
276 @doc "POST /api/v1/accounts/:id/follow"
277 def follow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
281 def follow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
282 with {:ok, follower} <- MastodonAPI.follow(follower, followed, conn.params) do
283 render(conn, "relationship.json", user: follower, target: followed)
285 {:error, message} -> json_response(conn, :forbidden, %{error: message})
289 @doc "POST /api/v1/accounts/:id/unfollow"
290 def unfollow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
294 def unfollow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
295 with {:ok, follower} <- CommonAPI.unfollow(follower, followed) do
296 render(conn, "relationship.json", user: follower, target: followed)
300 @doc "POST /api/v1/accounts/:id/mute"
301 def mute(%{assigns: %{user: muter, account: muted}} = conn, params) do
302 notifications? = params |> Map.get("notifications", true) |> truthy_param?()
304 with {:ok, _user_relationships} <- User.mute(muter, muted, notifications?) do
305 render(conn, "relationship.json", user: muter, target: muted)
307 {:error, message} -> json_response(conn, :forbidden, %{error: message})
311 @doc "POST /api/v1/accounts/:id/unmute"
312 def unmute(%{assigns: %{user: muter, account: muted}} = conn, _params) do
313 with {:ok, _user_relationships} <- User.unmute(muter, muted) do
314 render(conn, "relationship.json", user: muter, target: muted)
316 {:error, message} -> json_response(conn, :forbidden, %{error: message})
320 @doc "POST /api/v1/accounts/:id/block"
321 def block(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
322 with {:ok, _user_block} <- User.block(blocker, blocked),
323 {:ok, _activity} <- ActivityPub.block(blocker, blocked) do
324 render(conn, "relationship.json", user: blocker, target: blocked)
326 {:error, message} -> json_response(conn, :forbidden, %{error: message})
330 @doc "POST /api/v1/accounts/:id/unblock"
331 def unblock(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
332 with {:ok, _user_block} <- User.unblock(blocker, blocked),
333 {:ok, _activity} <- ActivityPub.unblock(blocker, blocked) do
334 render(conn, "relationship.json", user: blocker, target: blocked)
336 {:error, message} -> json_response(conn, :forbidden, %{error: message})
340 @doc "POST /api/v1/follows"
341 def follows(%{assigns: %{user: follower}} = conn, %{"uri" => uri}) do
342 with {_, %User{} = followed} <- {:followed, User.get_cached_by_nickname(uri)},
343 {_, true} <- {:followed, follower.id != followed.id},
344 {:ok, follower, followed, _} <- CommonAPI.follow(follower, followed) do
345 render(conn, "show.json", user: followed, for: follower)
347 {:followed, _} -> {:error, :not_found}
348 {:error, message} -> json_response(conn, :forbidden, %{error: message})
352 @doc "GET /api/v1/mutes"
353 def mutes(%{assigns: %{user: user}} = conn, _) do
354 users = User.muted_users(user, _restrict_deactivated = true)
355 render(conn, "index.json", users: users, for: user, as: :user)
358 @doc "GET /api/v1/blocks"
359 def blocks(%{assigns: %{user: user}} = conn, _) do
360 users = User.blocked_users(user, _restrict_deactivated = true)
361 render(conn, "index.json", users: users, for: user, as: :user)
364 @doc "GET /api/v1/endorsements"
365 def endorsements(conn, params),
366 do: Pleroma.Web.MastodonAPI.MastodonAPIController.empty_array(conn, params)