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
118 |> put_view(AdminAPI.StatusView)
119 |> render("index.json", %{activities: activities, as: :activity})
121 _ -> {:error, :not_found}
125 def list_user_chats(%{assigns: %{user: admin}} = conn, %{"nickname" => nickname} = _params) do
126 with %User{id: user_id} <- User.get_cached_by_nickname_or_id(nickname, for: admin) do
128 Pleroma.Chat.for_user_query(user_id)
129 |> Pleroma.Repo.all()
132 |> put_view(AdminAPI.ChatView)
133 |> render("index.json", chats: chats)
135 _ -> {:error, :not_found}
139 def tag_users(%{assigns: %{user: admin}} = conn, %{"nicknames" => nicknames, "tags" => tags}) do
140 with {:ok, _} <- User.tag(nicknames, tags) do
141 ModerationLog.insert_log(%{
143 nicknames: nicknames,
148 json_response(conn, :no_content, "")
152 def untag_users(%{assigns: %{user: admin}} = conn, %{"nicknames" => nicknames, "tags" => tags}) do
153 with {:ok, _} <- User.untag(nicknames, tags) do
154 ModerationLog.insert_log(%{
156 nicknames: nicknames,
161 json_response(conn, :no_content, "")
165 def right_add_multiple(%{assigns: %{user: admin}} = conn, %{
166 "permission_group" => permission_group,
167 "nicknames" => nicknames
169 when permission_group in ["moderator", "admin"] do
170 update = %{:"is_#{permission_group}" => true}
172 users = nicknames |> Enum.map(&User.get_cached_by_nickname/1)
174 for u <- users, do: User.admin_api_update(u, update)
176 ModerationLog.insert_log(%{
180 permission: permission_group
186 def right_add_multiple(conn, _) do
187 render_error(conn, :not_found, "No such permission_group")
190 def right_add(%{assigns: %{user: admin}} = conn, %{
191 "permission_group" => permission_group,
192 "nickname" => nickname
194 when permission_group in ["moderator", "admin"] do
195 fields = %{:"is_#{permission_group}" => true}
199 |> User.get_cached_by_nickname()
200 |> User.admin_api_update(fields)
202 ModerationLog.insert_log(%{
206 permission: permission_group
212 def right_add(conn, _) do
213 render_error(conn, :not_found, "No such permission_group")
216 def right_get(conn, %{"nickname" => nickname}) do
217 user = User.get_cached_by_nickname(nickname)
221 is_moderator: user.is_moderator,
222 is_admin: user.is_admin
226 def right_delete_multiple(
227 %{assigns: %{user: %{nickname: admin_nickname} = admin}} = conn,
229 "permission_group" => permission_group,
230 "nicknames" => nicknames
233 when permission_group in ["moderator", "admin"] do
234 with false <- Enum.member?(nicknames, admin_nickname) do
235 update = %{:"is_#{permission_group}" => false}
237 users = nicknames |> Enum.map(&User.get_cached_by_nickname/1)
239 for u <- users, do: User.admin_api_update(u, update)
241 ModerationLog.insert_log(%{
245 permission: permission_group
250 _ -> render_error(conn, :forbidden, "You can't revoke your own admin/moderator status.")
254 def right_delete_multiple(conn, _) do
255 render_error(conn, :not_found, "No such permission_group")
259 %{assigns: %{user: admin}} = conn,
261 "permission_group" => permission_group,
262 "nickname" => nickname
265 when permission_group in ["moderator", "admin"] do
266 fields = %{:"is_#{permission_group}" => false}
270 |> User.get_cached_by_nickname()
271 |> User.admin_api_update(fields)
273 ModerationLog.insert_log(%{
277 permission: permission_group
283 def right_delete(%{assigns: %{user: %{nickname: nickname}}} = conn, %{"nickname" => nickname}) do
284 render_error(conn, :forbidden, "You can't revoke your own admin status.")
287 @doc "Get a password reset token (base64 string) for given nickname"
288 def get_password_reset(conn, %{"nickname" => nickname}) do
289 (%User{local: true} = user) = User.get_cached_by_nickname(nickname)
290 {:ok, token} = Pleroma.PasswordResetToken.create_token(user)
295 link: Router.Helpers.reset_password_url(Endpoint, :reset, token.token)
299 @doc "Force password reset for a given user"
300 def force_password_reset(%{assigns: %{user: admin}} = conn, %{"nicknames" => nicknames}) do
301 users = nicknames |> Enum.map(&User.get_cached_by_nickname/1)
303 Enum.each(users, &User.force_password_reset_async/1)
305 ModerationLog.insert_log(%{
308 action: "force_password_reset"
311 json_response(conn, :no_content, "")
314 @doc "Disable mfa for user's account."
315 def disable_mfa(conn, %{"nickname" => nickname}) do
316 case User.get_by_nickname(nickname) do
326 @doc "Show a given user's credentials"
327 def show_user_credentials(%{assigns: %{user: admin}} = conn, %{"nickname" => nickname}) do
328 with %User{} = user <- User.get_cached_by_nickname_or_id(nickname, for: admin) do
330 |> put_view(AccountView)
331 |> render("credentials.json", %{user: user, for: admin})
333 _ -> {:error, :not_found}
337 @doc "Updates a given user"
338 def update_user_credentials(
339 %{assigns: %{user: admin}} = conn,
340 %{"nickname" => nickname} = params
342 with {_, %User{} = user} <- {:user, User.get_cached_by_nickname(nickname)},
344 User.update_as_admin(user, params) do
345 ModerationLog.insert_log(%{
348 action: "updated_users"
351 if params["password"] do
352 User.force_password_reset_async(user)
355 ModerationLog.insert_log(%{
358 action: "force_password_reset"
361 json(conn, %{status: "success"})
363 {:error, changeset} ->
364 errors = Map.new(changeset.errors, fn {key, {error, _}} -> {key, error} end)
373 def list_log(conn, params) do
374 {page, page_size} = page_params(params)
377 ModerationLog.get_all(%{
379 page_size: page_size,
380 start_date: params["start_date"],
381 end_date: params["end_date"],
382 user_id: params["user_id"],
383 search: params["search"]
387 |> put_view(ModerationLogView)
388 |> render("index.json", %{log: log})
391 def restart(conn, _params) do
392 with :ok <- configurable_from_database() do
393 Restarter.Pleroma.restart(Config.get(:env), 50)
399 def need_reboot(conn, _params) do
400 json(conn, %{need_reboot: Restarter.Pleroma.need_reboot?()})
403 defp configurable_from_database do
404 if Config.get(:configurable_from_database) do
407 {:error, "To use this endpoint you need to enable configuration from database."}
411 def reload_emoji(conn, _params) do
412 Pleroma.Emoji.reload()
417 def confirm_email(%{assigns: %{user: admin}} = conn, %{"nicknames" => nicknames}) do
418 users = Enum.map(nicknames, &User.get_cached_by_nickname/1)
422 ModerationLog.insert_log(%{actor: admin, subject: users, action: "confirm_email"})
427 def resend_confirmation_email(%{assigns: %{user: admin}} = conn, %{"nicknames" => nicknames}) do
429 Enum.map(nicknames, fn nickname ->
431 |> User.get_cached_by_nickname()
432 |> User.send_confirmation_email()
435 ModerationLog.insert_log(%{actor: admin, subject: users, action: "resend_confirmation_email"})
440 def stats(conn, params) do
441 counters = Stats.get_status_visibility_count(params["instance"])
443 json(conn, %{"status_visibility" => counters})
446 def create_backup(%{assigns: %{user: admin}} = conn, %{"nickname" => nickname}) do
447 with %User{} = user <- User.get_by_nickname(nickname),
448 {:ok, _} <- Pleroma.User.Backup.create(user, admin.id) do
449 ModerationLog.insert_log(%{actor: admin, subject: user, action: "create_backup"})
455 defp page_params(params) do
457 fetch_integer_param(params, "page", 1),
458 fetch_integer_param(params, "page_size", @users_page_size)