1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 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
18 Application.ensure_all_started(:flake_id)
36 name = Keyword.get(options, :name, nickname)
37 bio = Keyword.get(options, :bio, "")
39 {password, generated_password?} =
40 case Keyword.get(options, :password) do
42 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
48 moderator? = Keyword.get(options, :moderator, false)
49 admin? = Keyword.get(options, :admin, false)
50 assume_yes? = Keyword.get(options, :assume_yes, false)
53 A user will be created with the following information:
54 - nickname: #{nickname}
57 if(generated_password?, do: "[generated; a reset link will be created]", else: password)
61 - moderator: #{if(moderator?, do: "true", else: "false")}
62 - admin: #{if(admin?, do: "true", else: "false")}
65 proceed? = assume_yes? or shell_yes?("Continue?")
74 password_confirmation: password,
79 changeset = User.register_changeset(%User{}, params, need_confirmation: false)
80 {:ok, _user} = User.register(changeset)
82 shell_info("User #{nickname} created")
85 run(["set", nickname, "--moderator"])
89 run(["set", nickname, "--admin"])
92 if generated_password? do
93 run(["reset_password", nickname])
96 shell_info("User will not be created.")
100 def run(["rm", nickname]) do
102 Application.ensure_all_started(:flake_id)
104 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
105 {:ok, delete_data, _} <- Builder.delete(user, user.ap_id),
106 {:ok, _delete, _} <- Pipeline.common_pipeline(delete_data, local: true) do
107 shell_info("User #{nickname} deleted.")
109 _ -> shell_error("No local user #{nickname}")
113 def run(["toggle_activated", nickname]) do
116 with %User{} = user <- User.get_cached_by_nickname(nickname) do
117 {:ok, user} = User.deactivate(user, !user.deactivated)
120 "Activation status of #{nickname}: #{if(user.deactivated, do: "de", else: "")}activated"
124 shell_error("No user #{nickname}")
128 def run(["reset_password", nickname]) do
131 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
132 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
133 shell_info("Generated password reset token for #{user.nickname}")
137 Pleroma.Web.Router.Helpers.reset_password_url(
138 Pleroma.Web.Endpoint,
146 shell_error("No local user #{nickname}")
150 def run(["reset_mfa", nickname]) do
153 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
154 {:ok, _token} <- Pleroma.MFA.disable(user) do
155 shell_info("Multi-Factor Authentication disabled for #{user.nickname}")
158 shell_error("No local user #{nickname}")
162 def run(["deactivate", nickname]) do
165 with %User{} = user <- User.get_cached_by_nickname(nickname) do
166 shell_info("Deactivating #{user.nickname}")
167 User.deactivate(user)
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 unsubscribed all local followers from #{user.nickname}")
177 shell_error("No user #{nickname}")
181 def run(["deactivate_all_from_instance", instance]) do
184 Pleroma.User.Query.build(%{nickname: "@#{instance}"})
185 |> Pleroma.RepoStreamer.chunk_stream(500)
186 |> Stream.each(fn users ->
188 |> Enum.each(fn user ->
189 run(["deactivate", user.nickname])
195 def run(["set", nickname | rest]) do
208 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
210 case Keyword.get(options, :moderator) do
212 value -> set_moderator(user, value)
216 case Keyword.get(options, :locked) do
218 value -> set_locked(user, value)
222 case Keyword.get(options, :admin) do
224 value -> set_admin(user, value)
228 shell_error("No local user #{nickname}")
232 def run(["tag", nickname | tags]) do
235 with %User{} = user <- User.get_cached_by_nickname(nickname) do
236 user = user |> User.tag(tags)
238 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
241 shell_error("Could not change user tags for #{nickname}")
245 def run(["untag", nickname | tags]) do
248 with %User{} = user <- User.get_cached_by_nickname(nickname) do
249 user = user |> User.untag(tags)
251 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
254 shell_error("Could not change user tags for #{nickname}")
258 def run(["invite" | rest]) do
260 OptionParser.parse(rest,
269 |> Keyword.update(:expires_at, {:ok, nil}, fn
271 val -> Date.from_iso8601(val)
277 with {:ok, val} <- options[:expires_at],
278 options = Map.put(options, :expires_at, val),
279 {:ok, invite} <- UserInviteToken.create_invite(options) do
280 shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
283 Pleroma.Web.Router.Helpers.redirect_url(
284 Pleroma.Web.Endpoint,
292 shell_error("Could not create invite token: #{inspect(error)}")
296 def run(["invites"]) do
299 shell_info("Invites list:")
301 UserInviteToken.list_invites()
302 |> Enum.each(fn invite ->
304 with expires_at when not is_nil(expires_at) <- invite.expires_at do
305 " | Expires at: #{Date.to_string(expires_at)}"
309 with max_use when not is_nil(max_use) <- invite.max_use do
310 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
314 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
316 }#{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
334 Application.ensure_all_started(:flake_id)
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(["toggle_confirmed", nickname]) do
348 with %User{} = user <- User.get_cached_by_nickname(nickname) do
349 {:ok, user} = User.toggle_confirmation(user)
351 message = if user.confirmation_pending, do: "needs", else: "doesn't need"
353 shell_info("#{nickname} #{message} confirmation.")
356 shell_error("No local user #{nickname}")
360 def run(["sign_out", nickname]) do
363 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
364 User.global_sign_out(user)
366 shell_info("#{nickname} signed out from all apps.")
369 shell_error("No local user #{nickname}")
376 Pleroma.User.Query.build(%{local: true})
377 |> Pleroma.RepoStreamer.chunk_stream(500)
378 |> Stream.each(fn users ->
380 |> Enum.each(fn user ->
382 "#{user.nickname} moderator: #{user.is_moderator}, admin: #{user.is_admin}, locked: #{
384 }, deactivated: #{user.deactivated}"
391 defp set_moderator(user, value) do
394 |> Changeset.change(%{is_moderator: value})
395 |> User.update_and_set_cache()
397 shell_info("Moderator status of #{user.nickname}: #{user.is_moderator}")
401 defp set_admin(user, value) do
402 {:ok, user} = User.admin_api_update(user, %{is_admin: value})
404 shell_info("Admin status of #{user.nickname}: #{user.is_admin}")
408 defp set_locked(user, value) do
411 |> Changeset.change(%{locked: value})
412 |> User.update_and_set_cache()
414 shell_info("Locked status of #{user.nickname}: #{user.locked}")