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 Mix.Tasks.Pleroma.User do
10 alias Pleroma.Web.ActivityPub.ActivityPub
11 alias Pleroma.UserInviteToken
12 alias Pleroma.Web.ActivityPub.Builder
13 alias Pleroma.Web.ActivityPub.Pipeline
15 @shortdoc "Manages Pleroma users"
16 @moduledoc File.read!("docs/docs/administration/CLI_tasks/user.md")
18 def run(["new", nickname, email | rest]) do
35 name = Keyword.get(options, :name, nickname)
36 bio = Keyword.get(options, :bio, "")
38 {password, generated_password?} =
39 case Keyword.get(options, :password) do
41 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
47 moderator? = Keyword.get(options, :moderator, false)
48 admin? = Keyword.get(options, :admin, false)
49 assume_yes? = Keyword.get(options, :assume_yes, false)
52 A user will be created with the following information:
53 - nickname: #{nickname}
55 - password: #{if(generated_password?, do: "[generated; a reset link will be created]", else: password)}
58 - moderator: #{if(moderator?, do: "true", else: "false")}
59 - admin: #{if(admin?, do: "true", else: "false")}
62 proceed? = assume_yes? or shell_prompt("Continue?", "n") in ~w(Yn Y y)
71 password_confirmation: password,
76 changeset = User.register_changeset(%User{}, params, is_confirmed: true)
77 {:ok, _user} = User.register(changeset)
79 shell_info("User #{nickname} created")
82 run(["set", nickname, "--moderator"])
86 run(["set", nickname, "--admin"])
89 if generated_password? do
90 run(["reset_password", nickname])
93 shell_info("User will not be created.")
97 def run(["rm", nickname]) do
100 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
101 {:ok, delete_data, _} <- Builder.delete(user, user.ap_id),
102 {:ok, _delete, _} <- Pipeline.common_pipeline(delete_data, local: true) do
103 shell_info("User #{nickname} deleted.")
105 _ -> shell_error("No local user #{nickname}")
109 def run(["reset_password", nickname]) do
112 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
113 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
114 shell_info("Generated password reset token for #{user.nickname}")
116 IO.puts("URL: #{Pleroma.Web.Router.Helpers.reset_password_url(Pleroma.Web.Endpoint,
121 shell_error("No local user #{nickname}")
125 def run(["reset_mfa", nickname]) do
128 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
129 {:ok, _token} <- Pleroma.MFA.disable(user) do
130 shell_info("Multi-Factor Authentication disabled for #{user.nickname}")
133 shell_error("No local user #{nickname}")
137 def run(["activate", nickname]) do
140 with %User{} = user <- User.get_cached_by_nickname(nickname),
141 false <- user.is_active do
142 User.set_activation(user, true)
145 shell_info("Successfully activated #{nickname}")
148 shell_info("User #{nickname} already activated")
151 shell_error("No user #{nickname}")
155 def run(["deactivate", nickname]) do
158 with %User{} = user <- User.get_cached_by_nickname(nickname),
159 true <- user.is_active do
160 User.set_activation(user, false)
163 user = User.get_cached_by_id(user.id)
165 if Enum.empty?(Enum.filter(User.get_friends(user), & &1.local)) do
166 shell_info("Successfully deactivated #{nickname} and unsubscribed all local followers")
170 shell_info("User #{nickname} already deactivated")
173 shell_error("No user #{nickname}")
177 def run(["deactivate_all_from_instance", instance]) do
180 Pleroma.User.Query.build(%{nickname: "@#{instance}"})
181 |> Pleroma.Repo.chunk_stream(500, :batches)
182 |> Stream.each(fn users ->
184 |> Enum.each(fn user ->
185 run(["deactivate", user.nickname])
191 def run(["set", nickname | rest]) do
205 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
207 case Keyword.get(options, :admin) do
209 value -> set_admin(user, value)
213 case Keyword.get(options, :confirmed) do
215 value -> set_confirmation(user, value)
219 case Keyword.get(options, :locked) do
221 value -> set_locked(user, value)
225 case Keyword.get(options, :moderator) do
227 value -> set_moderator(user, value)
231 shell_error("No local user #{nickname}")
235 def run(["tag", nickname | tags]) do
238 with %User{} = user <- User.get_cached_by_nickname(nickname) do
239 user = user |> User.tag(tags)
241 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
244 shell_error("Could not change user tags for #{nickname}")
248 def run(["untag", nickname | tags]) do
251 with %User{} = user <- User.get_cached_by_nickname(nickname) do
252 user = user |> User.untag(tags)
254 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
257 shell_error("Could not change user tags for #{nickname}")
261 def run(["invite" | rest]) do
263 OptionParser.parse(rest,
272 |> Keyword.update(:expires_at, {:ok, nil}, fn
274 val -> Date.from_iso8601(val)
280 with {:ok, val} <- options[:expires_at],
281 options = Map.put(options, :expires_at, val),
282 {:ok, invite} <- UserInviteToken.create_invite(options) do
283 shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
286 Pleroma.Web.Router.Helpers.redirect_url(
287 Pleroma.Web.Endpoint,
295 shell_error("Could not create invite token: #{inspect(error)}")
299 def run(["invites"]) do
302 shell_info("Invites list:")
304 UserInviteToken.list_invites()
305 |> Enum.each(fn invite ->
307 with expires_at when not is_nil(expires_at) <- invite.expires_at do
308 " | Expires at: #{Date.to_string(expires_at)}"
312 with max_use when not is_nil(max_use) <- invite.max_use do
313 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
317 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{invite.used}#{expire_info}#{using_info}"
322 def run(["revoke_invite", token]) do
325 with {:ok, invite} <- UserInviteToken.find_by_token(token),
326 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
327 shell_info("Invite for token #{token} was revoked.")
329 _ -> shell_error("No invite found with token #{token}")
333 def run(["delete_activities", nickname]) do
336 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
337 User.delete_user_activities(user)
338 shell_info("User #{nickname} statuses deleted.")
341 shell_error("No local user #{nickname}")
345 def run(["change_email", nickname, email]) do
348 with %User{} = user <- User.get_cached_by_nickname(nickname) do
350 |> User.update_changeset(%{"email" => email})
351 |> User.update_and_set_cache()
353 shell_info("#{nickname}'s email updated")
357 def run(["show", nickname]) do
361 |> User.get_cached_by_nickname()
365 def run(["send_confirmation", nickname]) do
368 with %User{} = user <- User.get_cached_by_nickname(nickname) do
370 |> Pleroma.Emails.UserEmail.account_confirmation_email()
372 |> Pleroma.Emails.Mailer.deliver!()
374 shell_info("#{nickname}'s email sent")
378 def run(["confirm", nickname]) do
381 with %User{} = user <- User.get_cached_by_nickname(nickname) do
382 {:ok, user} = User.confirm(user)
384 message = if !user.is_confirmed, do: "needs", else: "doesn't need"
386 shell_info("#{nickname} #{message} confirmation.")
389 shell_error("No local user #{nickname}")
393 def run(["confirm_all"]) do
396 Pleroma.User.Query.build(%{
403 |> Pleroma.Repo.chunk_stream(500, :batches)
404 |> Stream.each(fn users ->
406 |> Enum.each(fn user -> User.set_confirmation(user, true) end)
411 def run(["unconfirm_all"]) do
414 Pleroma.User.Query.build(%{
421 |> Pleroma.Repo.chunk_stream(500, :batches)
422 |> Stream.each(fn users ->
424 |> Enum.each(fn user -> User.set_confirmation(user, false) end)
429 def run(["sign_out", nickname]) do
432 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
433 User.global_sign_out(user)
435 shell_info("#{nickname} signed out from all apps.")
438 shell_error("No local user #{nickname}")
442 def run(["blocking", nickname]) do
445 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
446 blocks = User.following_ap_ids(user)
447 IO.inspect(blocks, limit: :infinity)
451 def run(["timeline_query", nickname]) do
453 params = %{local: true}
455 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
458 |> Map.put(:type, ["Create", "Announce"])
459 |> Map.put(:limit, 20)
460 |> Map.put(:blocking_user, user)
461 |> Map.put(:muting_user, user)
462 |> Map.put(:reply_filtering_user, user)
463 |> Map.put(:announce_filtering_user, user)
464 |> Map.put(:user, user)
465 |> Map.put(:local_only, params[:local])
466 |> Map.delete(:local)
469 [user.ap_id | User.following(user)]
470 |> ActivityPub.fetch_activities(params)
477 Pleroma.User.Query.build(%{local: true})
478 |> Pleroma.Repo.chunk_stream(500, :batches)
479 |> Stream.each(fn users ->
481 |> Enum.each(fn user ->
483 "#{user.nickname} moderator: #{user.is_moderator}, admin: #{user.is_admin}, locked: #{user.is_locked}, is_active: #{user.is_active}"
490 def run(["fix_follow_state", local_user, remote_user]) do
493 with {:local, %User{} = local} <- {:local, User.get_by_nickname(local_user)},
494 {:remote, %User{} = remote} <- {:remote, User.get_by_nickname(remote_user)},
495 {:follow_data, %{data: %{"state" => request_state}}} <-
496 {:follow_data, Pleroma.Web.ActivityPub.Utils.fetch_latest_follow(local, remote)} do
497 calculated_state = User.following?(local, remote)
500 "Request state is #{request_state}, vs calculated state of following=#{calculated_state}"
503 if calculated_state == false && request_state == "accept" do
504 IO.puts("Discrepancy found, fixing")
505 Pleroma.Web.CommonAPI.reject_follow_request(local, remote)
506 shell_info("Relationship fixed")
508 shell_info("No discrepancy found")
512 shell_error("No local user #{local_user}")
515 shell_error("No remote user #{remote_user}")
518 shell_error("No follow data for #{local_user} and #{remote_user}")
522 defp set_moderator(user, value) do
525 |> Changeset.change(%{is_moderator: value})
526 |> User.update_and_set_cache()
528 shell_info("Moderator status of #{user.nickname}: #{user.is_moderator}")
532 defp set_admin(user, value) do
533 {:ok, user} = User.admin_api_update(user, %{is_admin: value})
535 shell_info("Admin status of #{user.nickname}: #{user.is_admin}")
539 defp set_locked(user, value) do
542 |> Changeset.change(%{is_locked: value})
543 |> User.update_and_set_cache()
545 shell_info("Locked status of #{user.nickname}: #{user.is_locked}")
549 defp set_confirmation(user, value) do
550 {:ok, user} = User.set_confirmation(user, value)
552 shell_info("Confirmation status of #{user.nickname}: #{user.is_confirmed}")