1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.AdminAPI.AdminAPIController do
6 use Pleroma.Web, :controller
8 import Pleroma.Web.ControllerHelper,
9 only: [json_response: 3, fetch_integer_param: 3]
13 alias Pleroma.ModerationLog
16 alias Pleroma.Web.ActivityPub.ActivityPub
17 alias Pleroma.Web.AdminAPI
18 alias Pleroma.Web.AdminAPI.AccountView
19 alias Pleroma.Web.AdminAPI.ModerationLogView
20 alias Pleroma.Web.Endpoint
21 alias Pleroma.Web.Plugs.OAuthScopesPlug
22 alias Pleroma.Web.Router
28 %{scopes: ["read:accounts"], admin: true}
29 when action in [:right_get, :show_user_credentials, :create_backup]
34 %{scopes: ["write:accounts"], admin: true}
37 :force_password_reset,
44 :right_delete_multiple,
45 :update_user_credentials
51 %{scopes: ["read:statuses"], admin: true}
52 when action in [:list_user_statuses, :list_instance_statuses]
57 %{scopes: ["read:chats"], admin: true}
58 when action in [:list_user_chats]
63 %{scopes: ["read"], admin: true}
73 %{scopes: ["write"], admin: true}
76 :resend_confirmation_email,
82 action_fallback(AdminAPI.FallbackController)
84 def list_instance_statuses(conn, %{"instance" => instance} = params) do
85 with_reblogs = params["with_reblogs"] == "true" || params["with_reblogs"] == true
86 {page, page_size} = page_params(params)
89 ActivityPub.fetch_statuses(nil, %{
92 offset: (page - 1) * page_size,
93 exclude_reblogs: not with_reblogs
97 |> put_view(AdminAPI.StatusView)
98 |> render("index.json", %{activities: activities, as: :activity})
101 def list_user_statuses(%{assigns: %{user: admin}} = conn, %{"nickname" => nickname} = params) do
102 with_reblogs = params["with_reblogs"] == "true" || params["with_reblogs"] == true
103 godmode = params["godmode"] == "true" || params["godmode"] == true
105 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname, for: admin) do
106 {page, page_size} = page_params(params)
109 ActivityPub.fetch_user_activities(user, nil, %{
111 offset: (page - 1) * page_size,
113 exclude_reblogs: not with_reblogs,
114 pagination_type: :offset,
119 |> put_view(AdminAPI.StatusView)
120 |> render("index.json", %{total: result[:total], activities: result[:items], as: :activity})
122 _ -> {:error, :not_found}
126 def list_user_chats(%{assigns: %{user: admin}} = conn, %{"nickname" => nickname} = _params) do
127 with %User{id: user_id} <- User.get_cached_by_nickname_or_id(nickname, for: admin) do
129 Pleroma.Chat.for_user_query(user_id)
130 |> Pleroma.Repo.all()
133 |> put_view(AdminAPI.ChatView)
134 |> render("index.json", chats: chats)
136 _ -> {:error, :not_found}
140 def tag_users(%{assigns: %{user: admin}} = conn, %{"nicknames" => nicknames, "tags" => tags}) do
141 with {:ok, _} <- User.tag(nicknames, tags) do
142 ModerationLog.insert_log(%{
144 nicknames: nicknames,
149 json_response(conn, :no_content, "")
153 def untag_users(%{assigns: %{user: admin}} = conn, %{"nicknames" => nicknames, "tags" => tags}) do
154 with {:ok, _} <- User.untag(nicknames, tags) do
155 ModerationLog.insert_log(%{
157 nicknames: nicknames,
162 json_response(conn, :no_content, "")
166 def right_add_multiple(%{assigns: %{user: admin}} = conn, %{
167 "permission_group" => permission_group,
168 "nicknames" => nicknames
170 when permission_group in ["moderator", "admin"] do
171 update = %{:"is_#{permission_group}" => true}
173 users = nicknames |> Enum.map(&User.get_cached_by_nickname/1)
175 for u <- users, do: User.admin_api_update(u, update)
177 ModerationLog.insert_log(%{
181 permission: permission_group
187 def right_add_multiple(conn, _) do
188 render_error(conn, :not_found, "No such permission_group")
191 def right_add(%{assigns: %{user: admin}} = conn, %{
192 "permission_group" => permission_group,
193 "nickname" => nickname
195 when permission_group in ["moderator", "admin"] do
196 fields = %{:"is_#{permission_group}" => true}
200 |> User.get_cached_by_nickname()
201 |> User.admin_api_update(fields)
203 ModerationLog.insert_log(%{
207 permission: permission_group
213 def right_add(conn, _) do
214 render_error(conn, :not_found, "No such permission_group")
217 def right_get(conn, %{"nickname" => nickname}) do
218 user = User.get_cached_by_nickname(nickname)
222 is_moderator: user.is_moderator,
223 is_admin: user.is_admin
227 def right_delete_multiple(
228 %{assigns: %{user: %{nickname: admin_nickname} = admin}} = conn,
230 "permission_group" => permission_group,
231 "nicknames" => nicknames
234 when permission_group in ["moderator", "admin"] do
235 with false <- Enum.member?(nicknames, admin_nickname) do
236 update = %{:"is_#{permission_group}" => false}
238 users = nicknames |> Enum.map(&User.get_cached_by_nickname/1)
240 for u <- users, do: User.admin_api_update(u, update)
242 ModerationLog.insert_log(%{
246 permission: permission_group
251 _ -> render_error(conn, :forbidden, "You can't revoke your own admin/moderator status.")
255 def right_delete_multiple(conn, _) do
256 render_error(conn, :not_found, "No such permission_group")
260 %{assigns: %{user: admin}} = conn,
262 "permission_group" => permission_group,
263 "nickname" => nickname
266 when permission_group in ["moderator", "admin"] do
267 fields = %{:"is_#{permission_group}" => false}
271 |> User.get_cached_by_nickname()
272 |> User.admin_api_update(fields)
274 ModerationLog.insert_log(%{
278 permission: permission_group
284 def right_delete(%{assigns: %{user: %{nickname: nickname}}} = conn, %{"nickname" => nickname}) do
285 render_error(conn, :forbidden, "You can't revoke your own admin status.")
288 @doc "Get a password reset token (base64 string) for given nickname"
289 def get_password_reset(conn, %{"nickname" => nickname}) do
290 (%User{local: true} = user) = User.get_cached_by_nickname(nickname)
291 {:ok, token} = Pleroma.PasswordResetToken.create_token(user)
296 link: Router.Helpers.reset_password_url(Endpoint, :reset, token.token)
300 @doc "Force password reset for a given user"
301 def force_password_reset(%{assigns: %{user: admin}} = conn, %{"nicknames" => nicknames}) do
302 users = nicknames |> Enum.map(&User.get_cached_by_nickname/1)
304 Enum.each(users, &User.force_password_reset_async/1)
306 ModerationLog.insert_log(%{
309 action: "force_password_reset"
312 json_response(conn, :no_content, "")
315 @doc "Disable mfa for user's account."
316 def disable_mfa(conn, %{"nickname" => nickname}) do
317 case User.get_by_nickname(nickname) do
327 @doc "Show a given user's credentials"
328 def show_user_credentials(%{assigns: %{user: admin}} = conn, %{"nickname" => nickname}) do
329 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname, for: admin) do
331 |> put_view(AccountView)
332 |> render("credentials.json", %{user: user, for: admin})
334 _ -> {:error, :not_found}
338 @doc "Updates a given user"
339 def update_user_credentials(
340 %{assigns: %{user: admin}} = conn,
341 %{"nickname" => nickname} = params
343 with {_, %User{} = user} <- {:user, User.get_cached_by_nickname(nickname)},
345 User.update_as_admin(user, params) do
346 ModerationLog.insert_log(%{
349 action: "updated_users"
352 if params["password"] do
353 User.force_password_reset_async(user)
356 ModerationLog.insert_log(%{
359 action: "force_password_reset"
362 json(conn, %{status: "success"})
364 {:error, changeset} ->
365 errors = Map.new(changeset.errors, fn {key, {error, _}} -> {key, error} end)
374 def list_log(conn, params) do
375 {page, page_size} = page_params(params)
378 ModerationLog.get_all(%{
380 page_size: page_size,
381 start_date: params["start_date"],
382 end_date: params["end_date"],
383 user_id: params["user_id"],
384 search: params["search"]
388 |> put_view(ModerationLogView)
389 |> render("index.json", %{log: log})
392 def restart(conn, _params) do
393 with :ok <- configurable_from_database() do
394 Restarter.Pleroma.restart(Config.get(:env), 50)
400 def need_reboot(conn, _params) do
401 json(conn, %{need_reboot: Restarter.Pleroma.need_reboot?()})
404 defp configurable_from_database do
405 if Config.get(:configurable_from_database) do
408 {:error, "To use this endpoint you need to enable configuration from database."}
412 def reload_emoji(conn, _params) do
413 Pleroma.Emoji.reload()
418 def confirm_email(%{assigns: %{user: admin}} = conn, %{"nicknames" => nicknames}) do
419 users = Enum.map(nicknames, &User.get_cached_by_nickname/1)
423 ModerationLog.insert_log(%{actor: admin, subject: users, action: "confirm_email"})
428 def resend_confirmation_email(%{assigns: %{user: admin}} = conn, %{"nicknames" => nicknames}) do
430 Enum.map(nicknames, fn nickname ->
432 |> User.get_cached_by_nickname()
433 |> User.send_confirmation_email()
436 ModerationLog.insert_log(%{actor: admin, subject: users, action: "resend_confirmation_email"})
441 def stats(conn, params) do
442 counters = Stats.get_status_visibility_count(params["instance"])
444 json(conn, %{"status_visibility" => counters})
447 def create_backup(%{assigns: %{user: admin}} = conn, %{"nickname" => nickname}) do
448 with %User{} = user <- User.get_by_nickname(nickname),
449 {:ok, _} <- Pleroma.User.Backup.create(user, admin.id) do
450 ModerationLog.insert_log(%{actor: admin, subject: user, action: "create_backup"})
456 defp page_params(params) do
458 fetch_integer_param(params, "page", 1),
459 fetch_integer_param(params, "page_size", @users_page_size)