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.UserInviteToken
11 alias Pleroma.Web.ActivityPub.Builder
12 alias Pleroma.Web.ActivityPub.Pipeline
14 @shortdoc "Manages Pleroma users"
15 @moduledoc File.read!("docs/administration/CLI_tasks/user.md")
17 def run(["new", nickname, email | rest]) do
34 name = Keyword.get(options, :name, nickname)
35 bio = Keyword.get(options, :bio, "")
37 {password, generated_password?} =
38 case Keyword.get(options, :password) do
40 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
46 moderator? = Keyword.get(options, :moderator, false)
47 admin? = Keyword.get(options, :admin, false)
48 assume_yes? = Keyword.get(options, :assume_yes, false)
51 A user will be created with the following information:
52 - nickname: #{nickname}
54 - password: #{if(generated_password?, do: "[generated; a reset link will be created]", else: password)}
57 - moderator: #{if(moderator?, do: "true", else: "false")}
58 - admin: #{if(admin?, do: "true", else: "false")}
61 proceed? = assume_yes? or shell_prompt("Continue?", "n") in ~w(Yn Y y)
70 password_confirmation: password,
75 changeset = User.register_changeset(%User{}, params, is_confirmed: true)
76 {:ok, _user} = User.register(changeset)
78 shell_info("User #{nickname} created")
81 run(["set", nickname, "--moderator"])
85 run(["set", nickname, "--admin"])
88 if generated_password? do
89 run(["reset_password", nickname])
92 shell_info("User will not be created.")
96 def run(["rm", nickname]) do
99 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
100 {:ok, delete_data, _} <- Builder.delete(user, user.ap_id),
101 {:ok, _delete, _} <- Pipeline.common_pipeline(delete_data, local: true) do
102 shell_info("User #{nickname} deleted.")
104 _ -> shell_error("No local user #{nickname}")
108 def run(["reset_password", nickname]) do
111 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
112 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
113 shell_info("Generated password reset token for #{user.nickname}")
115 IO.puts("URL: #{Pleroma.Web.Router.Helpers.reset_password_url(Pleroma.Web.Endpoint,
120 shell_error("No local user #{nickname}")
124 def run(["reset_mfa", nickname]) do
127 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
128 {:ok, _token} <- Pleroma.MFA.disable(user) do
129 shell_info("Multi-Factor Authentication disabled for #{user.nickname}")
132 shell_error("No local user #{nickname}")
136 def run(["activate", nickname]) do
139 with %User{} = user <- User.get_cached_by_nickname(nickname),
140 false <- user.is_active do
141 User.set_activation(user, true)
144 shell_info("Successfully activated #{nickname}")
147 shell_info("User #{nickname} already activated")
150 shell_error("No user #{nickname}")
154 def run(["deactivate", nickname]) do
157 with %User{} = user <- User.get_cached_by_nickname(nickname),
158 true <- user.is_active do
159 User.set_activation(user, false)
162 user = User.get_cached_by_id(user.id)
164 if Enum.empty?(Enum.filter(User.get_friends(user), & &1.local)) do
165 shell_info("Successfully deactivated #{nickname} and unsubscribed all local followers")
169 shell_info("User #{nickname} already deactivated")
172 shell_error("No user #{nickname}")
176 def run(["deactivate_all_from_instance", instance]) do
179 Pleroma.User.Query.build(%{nickname: "@#{instance}"})
180 |> Pleroma.Repo.chunk_stream(500, :batches)
181 |> Stream.each(fn users ->
183 |> Enum.each(fn user ->
184 run(["deactivate", user.nickname])
190 def run(["set", nickname | rest]) do
204 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
206 case Keyword.get(options, :admin) do
208 value -> set_admin(user, value)
212 case Keyword.get(options, :confirmed) do
214 value -> set_confirmation(user, value)
218 case Keyword.get(options, :locked) do
220 value -> set_locked(user, value)
224 case Keyword.get(options, :moderator) do
226 value -> set_moderator(user, value)
230 shell_error("No local user #{nickname}")
234 def run(["tag", nickname | tags]) do
237 with %User{} = user <- User.get_cached_by_nickname(nickname) do
238 user = user |> User.tag(tags)
240 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
243 shell_error("Could not change user tags for #{nickname}")
247 def run(["untag", nickname | tags]) do
250 with %User{} = user <- User.get_cached_by_nickname(nickname) do
251 user = user |> User.untag(tags)
253 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
256 shell_error("Could not change user tags for #{nickname}")
260 def run(["invite" | rest]) do
262 OptionParser.parse(rest,
271 |> Keyword.update(:expires_at, {:ok, nil}, fn
273 val -> Date.from_iso8601(val)
279 with {:ok, val} <- options[:expires_at],
280 options = Map.put(options, :expires_at, val),
281 {:ok, invite} <- UserInviteToken.create_invite(options) do
282 shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
285 Pleroma.Web.Router.Helpers.redirect_url(
286 Pleroma.Web.Endpoint,
294 shell_error("Could not create invite token: #{inspect(error)}")
298 def run(["invites"]) do
301 shell_info("Invites list:")
303 UserInviteToken.list_invites()
304 |> Enum.each(fn invite ->
306 with expires_at when not is_nil(expires_at) <- invite.expires_at do
307 " | Expires at: #{Date.to_string(expires_at)}"
311 with max_use when not is_nil(max_use) <- invite.max_use do
312 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
316 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{invite.used}#{expire_info}#{using_info}"
321 def run(["revoke_invite", token]) do
324 with {:ok, invite} <- UserInviteToken.find_by_token(token),
325 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
326 shell_info("Invite for token #{token} was revoked.")
328 _ -> shell_error("No invite found with token #{token}")
332 def run(["delete_activities", nickname]) do
335 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
336 User.delete_user_activities(user)
337 shell_info("User #{nickname} statuses deleted.")
340 shell_error("No local user #{nickname}")
344 def run(["confirm", nickname]) do
347 with %User{} = user <- User.get_cached_by_nickname(nickname) do
348 {:ok, user} = User.confirm(user)
350 message = if !user.is_confirmed, do: "needs", else: "doesn't need"
352 shell_info("#{nickname} #{message} confirmation.")
355 shell_error("No local user #{nickname}")
359 def run(["confirm_all"]) do
362 Pleroma.User.Query.build(%{
369 |> Pleroma.Repo.chunk_stream(500, :batches)
370 |> Stream.each(fn users ->
372 |> Enum.each(fn user -> User.set_confirmation(user, true) end)
377 def run(["unconfirm_all"]) do
380 Pleroma.User.Query.build(%{
387 |> Pleroma.Repo.chunk_stream(500, :batches)
388 |> Stream.each(fn users ->
390 |> Enum.each(fn user -> User.set_confirmation(user, false) end)
395 def run(["sign_out", nickname]) do
398 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
399 User.global_sign_out(user)
401 shell_info("#{nickname} signed out from all apps.")
404 shell_error("No local user #{nickname}")
411 Pleroma.User.Query.build(%{local: true})
412 |> Pleroma.Repo.chunk_stream(500, :batches)
413 |> Stream.each(fn users ->
415 |> Enum.each(fn user ->
417 "#{user.nickname} moderator: #{user.is_moderator}, admin: #{user.is_admin}, locked: #{user.is_locked}, is_active: #{user.is_active}"
424 defp set_moderator(user, value) do
427 |> Changeset.change(%{is_moderator: value})
428 |> User.update_and_set_cache()
430 shell_info("Moderator status of #{user.nickname}: #{user.is_moderator}")
434 defp set_admin(user, value) do
435 {:ok, user} = User.admin_api_update(user, %{is_admin: value})
437 shell_info("Admin status of #{user.nickname}: #{user.is_admin}")
441 defp set_locked(user, value) do
444 |> Changeset.change(%{is_locked: value})
445 |> User.update_and_set_cache()
447 shell_info("Locked status of #{user.nickname}: #{user.is_locked}")
451 defp set_confirmation(user, value) do
452 {:ok, user} = User.set_confirmation(user, value)
454 shell_info("Confirmation status of #{user.nickname}: #{user.is_confirmed}")