1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 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", "write:blocks"]} when action in [:block, :unblock]
44 plug(OAuthScopesPlug, %{scopes: ["read:follows"]} when action == :relationships)
48 %{scopes: ["follow", "write:follows"]} when action in [:follow, :unfollow]
51 plug(OAuthScopesPlug, %{scopes: ["follow", "write:mutes"]} when action in [:mute, :unmute])
54 Pleroma.Plugs.EnsurePublicOrAuthenticatedPlug
55 when action != :create
58 @relations [:follow, :unfollow]
59 @needs_account ~W(followers following lists follow unfollow mute unmute block unblock)a
61 plug(RateLimiter, {:relations_id_action, params: ["id", "uri"]} when action in @relations)
62 plug(RateLimiter, :relations_actions when action in @relations)
63 plug(RateLimiter, :app_account_creation when action == :create)
64 plug(:assign_account_by_id when action in @needs_account)
66 action_fallback(Pleroma.Web.MastodonAPI.FallbackController)
68 @doc "POST /api/v1/accounts"
70 %{assigns: %{app: app}} = conn,
71 %{"username" => nickname, "email" => _, "password" => _, "agreement" => true} = params
79 "captcha_answer_data",
83 |> Map.put("nickname", nickname)
84 |> Map.put("fullname", params["fullname"] || nickname)
85 |> Map.put("bio", params["bio"] || "")
86 |> Map.put("confirm", params["password"])
88 with {:ok, user} <- TwitterAPI.register_user(params, need_confirmation: true),
89 {:ok, token} <- Token.create_token(app, user, %{scopes: app.scopes}) do
92 access_token: token.token,
94 created_at: Token.Utils.format_created_at(token)
97 {:error, errors} -> json_response(conn, :bad_request, errors)
101 def create(%{assigns: %{app: _app}} = conn, _) do
102 render_error(conn, :bad_request, "Missing parameters")
105 def create(conn, _) do
106 render_error(conn, :forbidden, "Invalid credentials")
109 @doc "GET /api/v1/accounts/verify_credentials"
110 def verify_credentials(%{assigns: %{user: user}} = conn, _) do
111 chat_token = Phoenix.Token.sign(conn, "user socket", user.id)
113 render(conn, "show.json",
116 with_pleroma_settings: true,
117 with_chat_token: chat_token
121 @doc "PATCH /api/v1/accounts/update_credentials"
122 def update_credentials(%{assigns: %{user: original_user}} = conn, params) do
127 |> add_if_present(params, "display_name", :name)
128 |> add_if_present(params, "note", :bio, fn value -> {:ok, User.parse_bio(value, user)} end)
129 |> add_if_present(params, "avatar", :avatar, fn value ->
130 with %Plug.Upload{} <- value,
131 {:ok, object} <- ActivityPub.upload(value, type: :avatar) do
136 emojis_text = (user_params["display_name"] || "") <> (user_params["note"] || "")
140 |> Map.get(:emoji, [])
141 |> Enum.concat(Emoji.Formatter.get_emoji_map(emojis_text))
148 :hide_followers_count,
154 :skip_thread_containment,
157 |> Enum.reduce(%{}, fn key, acc ->
158 add_if_present(acc, params, to_string(key), key, &{:ok, truthy_param?(&1)})
160 |> add_if_present(params, "default_scope", :default_scope)
161 |> add_if_present(params, "fields", :fields, fn fields ->
162 fields = Enum.map(fields, fn f -> Map.update!(f, "value", &AutoLinker.link(&1)) end)
166 |> add_if_present(params, "fields", :raw_fields)
167 |> add_if_present(params, "pleroma_settings_store", :pleroma_settings_store, fn value ->
168 {:ok, Map.merge(user.info.pleroma_settings_store, value)}
170 |> add_if_present(params, "header", :banner, fn value ->
171 with %Plug.Upload{} <- value,
172 {:ok, object} <- ActivityPub.upload(value, type: :banner) do
176 |> add_if_present(params, "pleroma_background_image", :background, fn value ->
177 with %Plug.Upload{} <- value,
178 {:ok, object} <- ActivityPub.upload(value, type: :background) do
182 |> Map.put(:emoji, user_info_emojis)
186 |> User.update_changeset(user_params)
187 |> User.change_info(&User.Info.profile_update(&1, info_params))
189 with {:ok, user} <- User.update_and_set_cache(changeset) do
190 if original_user != user, do: CommonAPI.update(user)
192 render(conn, "show.json", user: user, for: user, with_pleroma_settings: true)
194 _e -> render_error(conn, :forbidden, "Invalid request")
198 defp add_if_present(map, params, params_field, map_field, value_function \\ &{:ok, &1}) do
199 with true <- Map.has_key?(params, params_field),
200 {:ok, new_value} <- value_function.(params[params_field]) do
201 Map.put(map, map_field, new_value)
207 @doc "GET /api/v1/accounts/relationships"
208 def relationships(%{assigns: %{user: user}} = conn, %{"id" => id}) do
209 targets = User.get_all_by_ids(List.wrap(id))
211 render(conn, "relationships.json", user: user, targets: targets)
214 # Instead of returning a 400 when no "id" params is present, Mastodon returns an empty array.
215 def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, [])
217 @doc "GET /api/v1/accounts/:id"
218 def show(%{assigns: %{user: for_user}} = conn, %{"id" => nickname_or_id}) do
219 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user),
220 true <- User.auth_active?(user) || user.id == for_user.id || User.superuser?(for_user) do
221 render(conn, "show.json", user: user, for: for_user)
223 _e -> render_error(conn, :not_found, "Can't find user")
227 @doc "GET /api/v1/accounts/:id/statuses"
228 def statuses(%{assigns: %{user: reading_user}} = conn, params) do
229 with %User{} = user <- User.get_cached_by_nickname_or_id(params["id"], for: reading_user) do
230 params = Map.put(params, "tag", params["tagged"])
231 activities = ActivityPub.fetch_user_activities(user, reading_user, params)
234 |> add_link_headers(activities)
235 |> put_view(StatusView)
236 |> render("index.json", activities: activities, for: reading_user, as: :activity)
240 @doc "GET /api/v1/accounts/:id/followers"
241 def followers(%{assigns: %{user: for_user, account: user}} = conn, params) do
244 for_user && user.id == for_user.id -> MastodonAPI.get_followers(user, params)
245 user.info.hide_followers -> []
246 true -> MastodonAPI.get_followers(user, params)
250 |> add_link_headers(followers)
251 |> render("index.json", for: for_user, users: followers, as: :user)
254 @doc "GET /api/v1/accounts/:id/following"
255 def following(%{assigns: %{user: for_user, account: user}} = conn, params) do
258 for_user && user.id == for_user.id -> MastodonAPI.get_friends(user, params)
259 user.info.hide_follows -> []
260 true -> MastodonAPI.get_friends(user, params)
264 |> add_link_headers(followers)
265 |> render("index.json", for: for_user, users: followers, as: :user)
268 @doc "GET /api/v1/accounts/:id/lists"
269 def lists(%{assigns: %{user: user, account: account}} = conn, _params) do
270 lists = Pleroma.List.get_lists_account_belongs(user, account)
273 |> put_view(ListView)
274 |> render("index.json", lists: lists)
277 @doc "POST /api/v1/accounts/:id/follow"
278 def follow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
282 def follow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
283 with {:ok, follower} <- MastodonAPI.follow(follower, followed, conn.params) do
284 render(conn, "relationship.json", user: follower, target: followed)
286 {:error, message} -> json_response(conn, :forbidden, %{error: message})
290 @doc "POST /api/v1/accounts/:id/unfollow"
291 def unfollow(%{assigns: %{user: %{id: id}, account: %{id: id}}}, _params) do
295 def unfollow(%{assigns: %{user: follower, account: followed}} = conn, _params) do
296 with {:ok, follower} <- CommonAPI.unfollow(follower, followed) do
297 render(conn, "relationship.json", user: follower, target: followed)
301 @doc "POST /api/v1/accounts/:id/mute"
302 def mute(%{assigns: %{user: muter, account: muted}} = conn, params) do
303 notifications? = params |> Map.get("notifications", true) |> truthy_param?()
305 with {:ok, muter} <- User.mute(muter, muted, notifications?) do
306 render(conn, "relationship.json", user: muter, target: muted)
308 {:error, message} -> json_response(conn, :forbidden, %{error: message})
312 @doc "POST /api/v1/accounts/:id/unmute"
313 def unmute(%{assigns: %{user: muter, account: muted}} = conn, _params) do
314 with {:ok, muter} <- User.unmute(muter, muted) do
315 render(conn, "relationship.json", user: muter, target: muted)
317 {:error, message} -> json_response(conn, :forbidden, %{error: message})
321 @doc "POST /api/v1/accounts/:id/block"
322 def block(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
323 with {:ok, blocker} <- User.block(blocker, blocked),
324 {:ok, _activity} <- ActivityPub.block(blocker, blocked) do
325 render(conn, "relationship.json", user: blocker, target: blocked)
327 {:error, message} -> json_response(conn, :forbidden, %{error: message})
331 @doc "POST /api/v1/accounts/:id/unblock"
332 def unblock(%{assigns: %{user: blocker, account: blocked}} = conn, _params) do
333 with {:ok, blocker} <- User.unblock(blocker, blocked),
334 {:ok, _activity} <- ActivityPub.unblock(blocker, blocked) do
335 render(conn, "relationship.json", user: blocker, target: blocked)
337 {:error, message} -> json_response(conn, :forbidden, %{error: message})
341 @doc "GET /api/v1/endorsements"
342 def endorsements(conn, params),
343 do: Pleroma.Web.MastodonAPI.MastodonAPIController.empty_array(conn, params)