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
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_yes?("Continue?")
72 password_confirmation: password,
77 changeset = User.register_changeset(%User{}, params, need_confirmation: false)
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(["toggle_activated", nickname]) do
113 with %User{} = user <- User.get_cached_by_nickname(nickname) do
114 {:ok, user} = User.deactivate(user, !user.deactivated)
117 "Activation status of #{nickname}: #{if(user.deactivated, do: "de", else: "")}activated"
121 shell_error("No user #{nickname}")
125 def run(["reset_password", nickname]) do
128 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
129 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
130 shell_info("Generated password reset token for #{user.nickname}")
134 Pleroma.Web.Router.Helpers.reset_password_url(
135 Pleroma.Web.Endpoint,
143 shell_error("No local user #{nickname}")
147 def run(["unsubscribe", nickname]) do
150 with %User{} = user <- User.get_cached_by_nickname(nickname) do
151 shell_info("Deactivating #{user.nickname}")
152 User.deactivate(user)
155 |> User.get_friends()
156 |> Enum.each(fn friend ->
157 user = User.get_cached_by_id(user.id)
159 shell_info("Unsubscribing #{friend.nickname} from #{user.nickname}")
160 User.unfollow(user, friend)
165 user = User.get_cached_by_id(user.id)
167 if Enum.empty?(User.get_friends(user)) do
168 shell_info("Successfully unsubscribed all followers from #{user.nickname}")
172 shell_error("No user #{nickname}")
176 def run(["unsubscribe_all_from_instance", instance]) do
179 Pleroma.User.Query.build(%{nickname: "@#{instance}"})
180 |> Pleroma.RepoStreamer.chunk_stream(500)
181 |> Stream.each(fn users ->
183 |> Enum.each(fn user ->
184 run(["unsubscribe", user.nickname])
190 def run(["set", nickname | rest]) do
203 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
205 case Keyword.get(options, :moderator) do
207 value -> set_moderator(user, value)
211 case Keyword.get(options, :locked) do
213 value -> set_locked(user, value)
217 case Keyword.get(options, :admin) do
219 value -> set_admin(user, value)
223 shell_error("No local user #{nickname}")
227 def run(["tag", nickname | tags]) do
230 with %User{} = user <- User.get_cached_by_nickname(nickname) do
231 user = user |> User.tag(tags)
233 shell_info("Tags of #{user.nickname}: #{inspect(tags)}")
236 shell_error("Could not change user tags for #{nickname}")
240 def run(["untag", nickname | tags]) do
243 with %User{} = user <- User.get_cached_by_nickname(nickname) do
244 user = user |> User.untag(tags)
246 shell_info("Tags of #{user.nickname}: #{inspect(tags)}")
249 shell_error("Could not change user tags for #{nickname}")
253 def run(["invite" | rest]) do
255 OptionParser.parse(rest,
264 |> Keyword.update(:expires_at, {:ok, nil}, fn
266 val -> Date.from_iso8601(val)
272 with {:ok, val} <- options[:expires_at],
273 options = Map.put(options, :expires_at, val),
274 {:ok, invite} <- UserInviteToken.create_invite(options) do
275 shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
278 Pleroma.Web.Router.Helpers.redirect_url(
279 Pleroma.Web.Endpoint,
287 shell_error("Could not create invite token: #{inspect(error)}")
291 def run(["invites"]) do
294 shell_info("Invites list:")
296 UserInviteToken.list_invites()
297 |> Enum.each(fn invite ->
299 with expires_at when not is_nil(expires_at) <- invite.expires_at do
300 " | Expires at: #{Date.to_string(expires_at)}"
304 with max_use when not is_nil(max_use) <- invite.max_use do
305 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
309 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
311 }#{expire_info}#{using_info}"
316 def run(["revoke_invite", token]) do
319 with {:ok, invite} <- UserInviteToken.find_by_token(token),
320 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
321 shell_info("Invite for token #{token} was revoked.")
323 _ -> shell_error("No invite found with token #{token}")
327 def run(["delete_activities", nickname]) do
330 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
331 User.delete_user_activities(user)
332 shell_info("User #{nickname} statuses deleted.")
335 shell_error("No local user #{nickname}")
339 def run(["toggle_confirmed", nickname]) do
342 with %User{} = user <- User.get_cached_by_nickname(nickname) do
343 {:ok, user} = User.toggle_confirmation(user)
345 message = if user.confirmation_pending, do: "needs", else: "doesn't need"
347 shell_info("#{nickname} #{message} confirmation.")
350 shell_error("No local user #{nickname}")
354 def run(["sign_out", nickname]) do
357 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
358 User.global_sign_out(user)
360 shell_info("#{nickname} signed out from all apps.")
363 shell_error("No local user #{nickname}")
370 Pleroma.User.Query.build(%{local: true})
371 |> Pleroma.RepoStreamer.chunk_stream(500)
372 |> Stream.each(fn users ->
374 |> Enum.each(fn user ->
376 "#{user.nickname} moderator: #{user.is_moderator}, admin: #{user.is_admin}, locked: #{
378 }, deactivated: #{user.deactivated}"
385 defp set_moderator(user, value) do
388 |> Changeset.change(%{is_moderator: value})
389 |> User.update_and_set_cache()
391 shell_info("Moderator status of #{user.nickname}: #{user.is_moderator}")
395 defp set_admin(user, value) do
396 {:ok, user} = User.admin_api_update(user, %{is_admin: value})
398 shell_info("Admin status of #{user.nickname}: #{user.is_admin}")
402 defp set_locked(user, value) do
405 |> Changeset.change(%{locked: value})
406 |> User.update_and_set_cache()
408 shell_info("Locked status of #{user.nickname}: #{user.locked}")