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]
12 alias Pleroma.Plugs.OAuthScopesPlug
13 alias Pleroma.Plugs.RateLimiter
15 alias Pleroma.Web.ActivityPub.ActivityPub
16 alias Pleroma.Web.CommonAPI
17 alias Pleroma.Web.MastodonAPI.ListView
18 alias Pleroma.Web.MastodonAPI.MastodonAPI
19 alias Pleroma.Web.MastodonAPI.StatusView
20 alias Pleroma.Web.OAuth.Token
21 alias Pleroma.Web.TwitterAPI.TwitterAPI
25 %{fallback: :proceed_unauthenticated, scopes: ["read:accounts"]}
31 %{scopes: ["read:accounts"]}
32 when action in [:endorsements, :verify_credentials, :followers, :following]
35 plug(OAuthScopesPlug, %{scopes: ["write:accounts"]} when action == :update_credentials)
37 plug(OAuthScopesPlug, %{scopes: ["read:lists"]} when action == :lists)
41 %{scopes: ["follow", "read:blocks"]} when action == :blocks
46 %{scopes: ["follow", "write:blocks"]} when action in [:block, :unblock]
49 plug(OAuthScopesPlug, %{scopes: ["read:follows"]} when action == :relationships)
51 # Note: :follows (POST /api/v1/follows) is the same as :follow, consider removing :follows
54 %{scopes: ["follow", "write:follows"]} when action in [:follows, :follow, :unfollow]
57 plug(OAuthScopesPlug, %{scopes: ["follow", "read:mutes"]} when action == :mutes)
59 plug(OAuthScopesPlug, %{scopes: ["follow", "write:mutes"]} when action in [:mute, :unmute])
62 Pleroma.Plugs.EnsurePublicOrAuthenticatedPlug
63 when action != :create
66 @relationship_actions [:follow, :unfollow]
67 @needs_account ~W(followers following lists follow unfollow mute unmute block unblock)a
71 [name: :relation_id_action, params: ["id", "uri"]] when action in @relationship_actions
74 plug(RateLimiter, [name: :relations_actions] when action in @relationship_actions)
75 plug(RateLimiter, [name: :app_account_creation] when action == :create)
76 plug(:assign_account_by_id when action in @needs_account)
78 action_fallback(Pleroma.Web.MastodonAPI.FallbackController)
80 @doc "POST /api/v1/accounts"
82 %{assigns: %{app: app}} = conn,
83 %{"username" => nickname, "password" => _, "agreement" => true} = params
91 "captcha_answer_data",
95 |> Map.put("nickname", nickname)
96 |> Map.put("fullname", params["fullname"] || nickname)
97 |> Map.put("bio", params["bio"] || "")
98 |> Map.put("confirm", params["password"])
100 with :ok <- validate_email_param(params),
101 {:ok, user} <- TwitterAPI.register_user(params, need_confirmation: true),
102 {:ok, token} <- Token.create_token(app, user, %{scopes: app.scopes}) do
104 token_type: "Bearer",
105 access_token: token.token,
107 created_at: Token.Utils.format_created_at(token)
110 {:error, errors} -> json_response(conn, :bad_request, errors)
114 def create(%{assigns: %{app: _app}} = conn, _) do
115 render_error(conn, :bad_request, "Missing parameters")
118 def create(conn, _) do
119 render_error(conn, :forbidden, "Invalid credentials")
122 defp validate_email_param(%{"email" => _}), do: :ok
124 defp validate_email_param(_) do
125 case Pleroma.Config.get([:instance, :account_activation_required]) do
126 true -> {:error, %{"error" => "Missing parameters"}}
131 @doc "GET /api/v1/accounts/verify_credentials"
132 def verify_credentials(%{assigns: %{user: user}} = conn, _) do
133 chat_token = Phoenix.Token.sign(conn, "user socket", user.id)
135 render(conn, "show.json",
138 with_pleroma_settings: true,
139 with_chat_token: chat_token
143 @doc "PATCH /api/v1/accounts/update_credentials"
144 def update_credentials(%{assigns: %{user: original_user}} = conn, params) do
148 if Map.has_key?(params, "fields_attributes") do
149 Map.update!(params, "fields_attributes", fn fields ->
151 |> normalize_fields_attributes()
152 |> Enum.filter(fn %{"name" => n} -> n != "" end)
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, fn value -> {:ok, User.parse_bio(value, user)} end)
177 |> add_if_present(params, "avatar", :avatar, fn value ->
178 with %Plug.Upload{} <- value,
179 {:ok, object} <- ActivityPub.upload(value, type: :avatar) do
183 |> add_if_present(params, "header", :banner, fn value ->
184 with %Plug.Upload{} <- value,
185 {:ok, object} <- ActivityPub.upload(value, type: :banner) do
189 |> add_if_present(params, "pleroma_background_image", :background, fn value ->
190 with %Plug.Upload{} <- value,
191 {:ok, object} <- ActivityPub.upload(value, type: :background) do
195 |> add_if_present(params, "fields_attributes", :fields, fn fields ->
196 fields = Enum.map(fields, fn f -> Map.update!(f, "value", &AutoLinker.link(&1)) end)
200 |> add_if_present(params, "fields_attributes", :raw_fields)
201 |> add_if_present(params, "pleroma_settings_store", :pleroma_settings_store, fn value ->
202 {:ok, Map.merge(user.pleroma_settings_store, value)}
204 |> add_if_present(params, "default_scope", :default_scope)
205 |> add_if_present(params, "actor_type", :actor_type)
207 emojis_text = (user_params["display_name"] || "") <> (user_params["note"] || "")
211 |> Map.get(:emoji, [])
212 |> Enum.concat(Emoji.Formatter.get_emoji_map(emojis_text))
215 user_params = Map.put(user_params, :emoji, user_emojis)
216 changeset = User.update_changeset(user, user_params)
218 with {:ok, user} <- User.update_and_set_cache(changeset) do
219 if original_user != user, do: CommonAPI.update(user)
221 render(conn, "show.json", user: user, for: user, with_pleroma_settings: true)
223 _e -> render_error(conn, :forbidden, "Invalid request")
227 defp add_if_present(map, params, params_field, map_field, value_function \\ &{:ok, &1}) do
228 with true <- Map.has_key?(params, params_field),
229 {:ok, new_value} <- value_function.(params[params_field]) do
230 Map.put(map, map_field, new_value)
236 defp normalize_fields_attributes(fields) do
237 if Enum.all?(fields, &is_tuple/1) do
238 Enum.map(fields, fn {_, v} -> v end)
244 @doc "GET /api/v1/accounts/relationships"
245 def relationships(%{assigns: %{user: user}} = conn, %{"id" => id}) do
246 targets = User.get_all_by_ids(List.wrap(id))
248 render(conn, "relationships.json", user: user, targets: targets)
251 # Instead of returning a 400 when no "id" params is present, Mastodon returns an empty array.
252 def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, [])
254 @doc "GET /api/v1/accounts/:id"
255 def show(%{assigns: %{user: for_user}} = conn, %{"id" => nickname_or_id}) do
256 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user),
257 true <- User.visible_for?(user, for_user) do
258 render(conn, "show.json", user: user, for: for_user)
260 _e -> render_error(conn, :not_found, "Can't find user")
264 @doc "GET /api/v1/accounts/:id/statuses"
265 def statuses(%{assigns: %{user: reading_user}} = conn, params) do
266 with %User{} = user <- User.get_cached_by_nickname_or_id(params["id"], for: reading_user) do
269 |> Map.put("tag", params["tagged"])
270 |> Map.delete("godmode")
272 activities = ActivityPub.fetch_user_activities(user, reading_user, params)
275 |> add_link_headers(activities)
276 |> put_view(StatusView)
277 |> render("index.json", activities: activities, for: reading_user, as: :activity)
281 @doc "GET /api/v1/accounts/:id/followers"
282 def followers(%{assigns: %{user: for_user, account: user}} = conn, params) do
285 for_user && user.id == for_user.id -> MastodonAPI.get_followers(user, params)
286 user.hide_followers -> []
287 true -> MastodonAPI.get_followers(user, params)
291 |> add_link_headers(followers)
292 |> render("index.json", for: for_user, users: followers, as: :user)
295 @doc "GET /api/v1/accounts/:id/following"
296 def following(%{assigns: %{user: for_user, account: user}} = conn, params) do
299 for_user && user.id == for_user.id -> MastodonAPI.get_friends(user, params)
300 user.hide_follows -> []
301 true -> MastodonAPI.get_friends(user, params)
305 |> add_link_headers(followers)
306 |> render("index.json", for: for_user, users: followers, as: :user)
309 @doc "GET /api/v1/accounts/:id/lists"
310 def lists(%{assigns: %{user: user, account: account}} = conn, _params) do
311 lists = Pleroma.List.get_lists_account_belongs(user, account)
314 |> put_view(ListView)
315 |> render("index.json", lists: lists)
318 @doc "POST /api/v1/accounts/:id/follow"
319 def follow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
323 def follow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
324 with {:ok, follower} <- MastodonAPI.follow(follower, followed, conn.params) do
325 render(conn, "relationship.json", user: follower, target: followed)
327 {:error, message} -> json_response(conn, :forbidden, %{error: message})
331 @doc "POST /api/v1/accounts/:id/unfollow"
332 def unfollow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
336 def unfollow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
337 with {:ok, follower} <- CommonAPI.unfollow(follower, followed) do
338 render(conn, "relationship.json", user: follower, target: followed)
342 @doc "POST /api/v1/accounts/:id/mute"
343 def mute(%{assigns: %{user: muter, account: muted}} = conn, params) do
344 notifications? = params |> Map.get("notifications", true) |> truthy_param?()
346 with {:ok, _user_relationships} <- User.mute(muter, muted, notifications?) do
347 render(conn, "relationship.json", user: muter, target: muted)
349 {:error, message} -> json_response(conn, :forbidden, %{error: message})
353 @doc "POST /api/v1/accounts/:id/unmute"
354 def unmute(%{assigns: %{user: muter, account: muted}} = conn, _params) do
355 with {:ok, _user_relationships} <- User.unmute(muter, muted) do
356 render(conn, "relationship.json", user: muter, target: muted)
358 {:error, message} -> json_response(conn, :forbidden, %{error: message})
362 @doc "POST /api/v1/accounts/:id/block"
363 def block(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
364 with {:ok, _user_block} <- User.block(blocker, blocked),
365 {:ok, _activity} <- ActivityPub.block(blocker, blocked) do
366 render(conn, "relationship.json", user: blocker, target: blocked)
368 {:error, message} -> json_response(conn, :forbidden, %{error: message})
372 @doc "POST /api/v1/accounts/:id/unblock"
373 def unblock(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
374 with {:ok, _user_block} <- User.unblock(blocker, blocked),
375 {:ok, _activity} <- ActivityPub.unblock(blocker, blocked) do
376 render(conn, "relationship.json", user: blocker, target: blocked)
378 {:error, message} -> json_response(conn, :forbidden, %{error: message})
382 @doc "POST /api/v1/follows"
383 def follows(%{assigns: %{user: follower}} = conn, %{"uri" => uri}) do
384 with {_, %User{} = followed} <- {:followed, User.get_cached_by_nickname(uri)},
385 {_, true} <- {:followed, follower.id != followed.id},
386 {:ok, follower, followed, _} <- CommonAPI.follow(follower, followed) do
387 render(conn, "show.json", user: followed, for: follower)
389 {:followed, _} -> {:error, :not_found}
390 {:error, message} -> json_response(conn, :forbidden, %{error: message})
394 @doc "GET /api/v1/mutes"
395 def mutes(%{assigns: %{user: user}} = conn, _) do
396 users = User.muted_users(user, _restrict_deactivated = true)
397 render(conn, "index.json", users: users, for: user, as: :user)
400 @doc "GET /api/v1/blocks"
401 def blocks(%{assigns: %{user: user}} = conn, _) do
402 users = User.blocked_users(user, _restrict_deactivated = true)
403 render(conn, "index.json", users: users, for: user, as: :user)
406 @doc "GET /api/v1/endorsements"
407 def endorsements(conn, params),
408 do: Pleroma.Web.MastodonAPI.MastodonAPIController.empty_array(conn, params)