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}
55 if(generated_password?, do: "[generated; a reset link will be created]", else: password)
59 - moderator: #{if(moderator?, do: "true", else: "false")}
60 - admin: #{if(admin?, do: "true", else: "false")}
63 proceed? = assume_yes? or shell_prompt("Continue?", "n") in ~w(Yn Y y)
72 password_confirmation: password,
77 changeset = User.register_changeset(%User{}, params, is_confirmed: true)
78 {:ok, _user} = User.register(changeset)
80 shell_info("User #{nickname} created")
83 run(["set", nickname, "--moderator"])
87 run(["set", nickname, "--admin"])
90 if generated_password? do
91 run(["reset_password", nickname])
94 shell_info("User will not be created.")
98 def run(["rm", nickname]) do
101 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
102 {:ok, delete_data, _} <- Builder.delete(user, user.ap_id),
103 {:ok, _delete, _} <- Pipeline.common_pipeline(delete_data, local: true) do
104 shell_info("User #{nickname} deleted.")
106 _ -> shell_error("No local user #{nickname}")
110 def run(["reset_password", nickname]) do
113 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
114 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
115 shell_info("Generated password reset token for #{user.nickname}")
119 Pleroma.Web.Router.Helpers.reset_password_url(
120 Pleroma.Web.Endpoint,
128 shell_error("No local user #{nickname}")
132 def run(["reset_mfa", nickname]) do
135 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
136 {:ok, _token} <- Pleroma.MFA.disable(user) do
137 shell_info("Multi-Factor Authentication disabled for #{user.nickname}")
140 shell_error("No local user #{nickname}")
144 def run(["activate", nickname]) do
147 with %User{} = user <- User.get_cached_by_nickname(nickname),
148 false <- user.is_active do
149 User.set_activation(user, true)
152 shell_info("Successfully activated #{nickname}")
155 shell_info("User #{nickname} already activated")
158 shell_error("No user #{nickname}")
162 def run(["deactivate", nickname]) do
165 with %User{} = user <- User.get_cached_by_nickname(nickname),
166 true <- user.is_active do
167 User.set_activation(user, false)
170 user = User.get_cached_by_id(user.id)
172 if Enum.empty?(Enum.filter(User.get_friends(user), & &1.local)) do
173 shell_info("Successfully deactivated #{nickname} and unsubscribed all local followers")
177 shell_info("User #{nickname} already deactivated")
180 shell_error("No user #{nickname}")
184 def run(["deactivate_all_from_instance", instance]) do
187 Pleroma.User.Query.build(%{nickname: "@#{instance}"})
188 |> Pleroma.Repo.chunk_stream(500, :batches)
189 |> Stream.each(fn users ->
191 |> Enum.each(fn user ->
192 run(["deactivate", user.nickname])
198 def run(["set", nickname | rest]) do
212 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
214 case Keyword.get(options, :admin) do
216 value -> set_admin(user, value)
220 case Keyword.get(options, :confirmed) do
222 value -> set_confirmation(user, value)
226 case Keyword.get(options, :locked) do
228 value -> set_locked(user, value)
232 case Keyword.get(options, :moderator) do
234 value -> set_moderator(user, value)
238 shell_error("No local user #{nickname}")
242 def run(["tag", nickname | tags]) do
245 with %User{} = user <- User.get_cached_by_nickname(nickname) do
246 user = user |> User.tag(tags)
248 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
251 shell_error("Could not change user tags for #{nickname}")
255 def run(["untag", nickname | tags]) do
258 with %User{} = user <- User.get_cached_by_nickname(nickname) do
259 user = user |> User.untag(tags)
261 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
264 shell_error("Could not change user tags for #{nickname}")
268 def run(["invite" | rest]) do
270 OptionParser.parse(rest,
279 |> Keyword.update(:expires_at, {:ok, nil}, fn
281 val -> Date.from_iso8601(val)
287 with {:ok, val} <- options[:expires_at],
288 options = Map.put(options, :expires_at, val),
289 {:ok, invite} <- UserInviteToken.create_invite(options) do
290 shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
293 Pleroma.Web.Router.Helpers.redirect_url(
294 Pleroma.Web.Endpoint,
302 shell_error("Could not create invite token: #{inspect(error)}")
306 def run(["invites"]) do
309 shell_info("Invites list:")
311 UserInviteToken.list_invites()
312 |> Enum.each(fn invite ->
314 with expires_at when not is_nil(expires_at) <- invite.expires_at do
315 " | Expires at: #{Date.to_string(expires_at)}"
319 with max_use when not is_nil(max_use) <- invite.max_use do
320 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
324 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
326 }#{expire_info}#{using_info}"
331 def run(["revoke_invite", token]) do
334 with {:ok, invite} <- UserInviteToken.find_by_token(token),
335 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
336 shell_info("Invite for token #{token} was revoked.")
338 _ -> shell_error("No invite found with token #{token}")
342 def run(["delete_activities", nickname]) do
345 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
346 User.delete_user_activities(user)
347 shell_info("User #{nickname} statuses deleted.")
350 shell_error("No local user #{nickname}")
354 def run(["confirm", nickname]) do
357 with %User{} = user <- User.get_cached_by_nickname(nickname) do
358 {:ok, user} = User.confirm(user)
360 message = if !user.is_confirmed, do: "needs", else: "doesn't need"
362 shell_info("#{nickname} #{message} confirmation.")
365 shell_error("No local user #{nickname}")
369 def run(["confirm_all"]) do
372 Pleroma.User.Query.build(%{
379 |> Pleroma.Repo.chunk_stream(500, :batches)
380 |> Stream.each(fn users ->
382 |> Enum.each(fn user -> User.set_confirmation(user, true) end)
387 def run(["unconfirm_all"]) do
390 Pleroma.User.Query.build(%{
397 |> Pleroma.Repo.chunk_stream(500, :batches)
398 |> Stream.each(fn users ->
400 |> Enum.each(fn user -> User.set_confirmation(user, false) end)
405 def run(["sign_out", nickname]) do
408 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
409 User.global_sign_out(user)
411 shell_info("#{nickname} signed out from all apps.")
414 shell_error("No local user #{nickname}")
421 Pleroma.User.Query.build(%{local: true})
422 |> Pleroma.Repo.chunk_stream(500, :batches)
423 |> Stream.each(fn users ->
425 |> Enum.each(fn user ->
427 "#{user.nickname} moderator: #{user.is_moderator}, admin: #{user.is_admin}, locked: #{
429 }, is_active: #{user.is_active}"
436 defp set_moderator(user, value) do
439 |> Changeset.change(%{is_moderator: value})
440 |> User.update_and_set_cache()
442 shell_info("Moderator status of #{user.nickname}: #{user.is_moderator}")
446 defp set_admin(user, value) do
447 {:ok, user} = User.admin_api_update(user, %{is_admin: value})
449 shell_info("Admin status of #{user.nickname}: #{user.is_admin}")
453 defp set_locked(user, value) do
456 |> Changeset.change(%{is_locked: value})
457 |> User.update_and_set_cache()
459 shell_info("Locked status of #{user.nickname}: #{user.is_locked}")
463 defp set_confirmation(user, value) do
464 {:ok, user} = User.set_confirmation(user, value)
466 shell_info("Confirmation status of #{user.nickname}: #{user.is_confirmed}")