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
12 @shortdoc "Manages Pleroma users"
13 @moduledoc File.read!("docs/administration/CLI_tasks/user.md")
15 def run(["new", nickname, email | rest]) do
32 name = Keyword.get(options, :name, nickname)
33 bio = Keyword.get(options, :bio, "")
35 {password, generated_password?} =
36 case Keyword.get(options, :password) do
38 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
44 moderator? = Keyword.get(options, :moderator, false)
45 admin? = Keyword.get(options, :admin, false)
46 assume_yes? = Keyword.get(options, :assume_yes, false)
49 A user will be created with the following information:
50 - nickname: #{nickname}
53 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_yes?("Continue?")
70 password_confirmation: password,
75 changeset = User.register_changeset(%User{}, params, need_confirmation: false)
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) do
100 User.perform(:delete, user)
101 shell_info("User #{nickname} deleted.")
103 _ -> shell_error("No local user #{nickname}")
107 def run(["toggle_activated", nickname]) do
110 with %User{} = user <- User.get_cached_by_nickname(nickname) do
111 {:ok, user} = User.deactivate(user, !user.deactivated)
114 "Activation status of #{nickname}: #{if(user.deactivated, do: "de", else: "")}activated"
118 shell_error("No user #{nickname}")
122 def run(["reset_password", nickname]) do
125 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
126 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
127 shell_info("Generated password reset token for #{user.nickname}")
131 Pleroma.Web.Router.Helpers.reset_password_url(
132 Pleroma.Web.Endpoint,
140 shell_error("No local user #{nickname}")
144 def run(["unsubscribe", nickname]) do
147 with %User{} = user <- User.get_cached_by_nickname(nickname) do
148 shell_info("Deactivating #{user.nickname}")
149 User.deactivate(user)
152 |> User.get_friends()
153 |> Enum.each(fn friend ->
154 user = User.get_cached_by_id(user.id)
156 shell_info("Unsubscribing #{friend.nickname} from #{user.nickname}")
157 User.unfollow(user, friend)
162 user = User.get_cached_by_id(user.id)
164 if Enum.empty?(User.get_friends(user)) do
165 shell_info("Successfully unsubscribed all followers from #{user.nickname}")
169 shell_error("No user #{nickname}")
173 def run(["unsubscribe_all_from_instance", instance]) do
176 Pleroma.User.Query.build(%{nickname: "@#{instance}"})
177 |> Pleroma.RepoStreamer.chunk_stream(500)
178 |> Stream.each(fn users ->
180 |> Enum.each(fn user ->
181 run(["unsubscribe", user.nickname])
187 def run(["set", nickname | rest]) do
200 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
202 case Keyword.get(options, :moderator) do
204 value -> set_moderator(user, value)
208 case Keyword.get(options, :locked) do
210 value -> set_locked(user, value)
214 case Keyword.get(options, :admin) do
216 value -> set_admin(user, value)
220 shell_error("No local user #{nickname}")
224 def run(["tag", nickname | tags]) do
227 with %User{} = user <- User.get_cached_by_nickname(nickname) do
228 user = user |> User.tag(tags)
230 shell_info("Tags of #{user.nickname}: #{inspect(tags)}")
233 shell_error("Could not change user tags for #{nickname}")
237 def run(["untag", nickname | tags]) do
240 with %User{} = user <- User.get_cached_by_nickname(nickname) do
241 user = user |> User.untag(tags)
243 shell_info("Tags of #{user.nickname}: #{inspect(tags)}")
246 shell_error("Could not change user tags for #{nickname}")
250 def run(["invite" | rest]) do
252 OptionParser.parse(rest,
261 |> Keyword.update(:expires_at, {:ok, nil}, fn
263 val -> Date.from_iso8601(val)
269 with {:ok, val} <- options[:expires_at],
270 options = Map.put(options, :expires_at, val),
271 {:ok, invite} <- UserInviteToken.create_invite(options) do
272 shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
275 Pleroma.Web.Router.Helpers.redirect_url(
276 Pleroma.Web.Endpoint,
284 shell_error("Could not create invite token: #{inspect(error)}")
288 def run(["invites"]) do
291 shell_info("Invites list:")
293 UserInviteToken.list_invites()
294 |> Enum.each(fn invite ->
296 with expires_at when not is_nil(expires_at) <- invite.expires_at do
297 " | Expires at: #{Date.to_string(expires_at)}"
301 with max_use when not is_nil(max_use) <- invite.max_use do
302 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
306 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
308 }#{expire_info}#{using_info}"
313 def run(["revoke_invite", token]) do
316 with {:ok, invite} <- UserInviteToken.find_by_token(token),
317 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
318 shell_info("Invite for token #{token} was revoked.")
320 _ -> shell_error("No invite found with token #{token}")
324 def run(["delete_activities", nickname]) do
327 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
328 User.delete_user_activities(user)
329 shell_info("User #{nickname} statuses deleted.")
332 shell_error("No local user #{nickname}")
336 def run(["toggle_confirmed", nickname]) do
339 with %User{} = user <- User.get_cached_by_nickname(nickname) do
340 {:ok, user} = User.toggle_confirmation(user)
342 message = if user.confirmation_pending, do: "needs", else: "doesn't need"
344 shell_info("#{nickname} #{message} confirmation.")
347 shell_error("No local user #{nickname}")
351 def run(["sign_out", nickname]) do
354 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
355 User.global_sign_out(user)
357 shell_info("#{nickname} signed out from all apps.")
360 shell_error("No local user #{nickname}")
367 Pleroma.User.Query.build(%{local: true})
368 |> Pleroma.RepoStreamer.chunk_stream(500)
369 |> Stream.each(fn users ->
371 |> Enum.each(fn user ->
373 "#{user.nickname} moderator: #{user.is_moderator}, admin: #{user.is_admin}, locked: #{
375 }, deactivated: #{user.deactivated}"
382 defp set_moderator(user, value) do
385 |> Changeset.change(%{is_moderator: value})
386 |> User.update_and_set_cache()
388 shell_info("Moderator status of #{user.nickname}: #{user.is_moderator}")
392 defp set_admin(user, value) do
393 {:ok, user} = User.admin_api_update(user, %{is_admin: value})
395 shell_info("Admin status of #{user.nickname}: #{user.is_admin}")
399 defp set_locked(user, value) do
402 |> Changeset.change(%{locked: value})
403 |> User.update_and_set_cache()
405 shell_info("Locked status of #{user.nickname}: #{user.locked}")