1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Mix.Tasks.Pleroma.User do
9 alias Pleroma.UserInviteToken
10 alias Pleroma.Web.OAuth
12 @shortdoc "Manages Pleroma users"
14 Manages Pleroma users.
18 mix pleroma.user new NICKNAME EMAIL [OPTION...]
21 - `--name NAME` - the user's name (i.e., "Lain Iwakura")
22 - `--bio BIO` - the user's bio
23 - `--password PASSWORD` - the user's password
24 - `--moderator`/`--no-moderator` - whether the user is a moderator
25 - `--admin`/`--no-admin` - whether the user is an admin
26 - `-y`, `--assume-yes`/`--no-assume-yes` - whether to assume yes to all questions
28 ## Generate an invite link.
30 mix pleroma.user invite [OPTION...]
33 - `--expires-at DATE` - last day on which token is active (e.g. "2019-04-05")
34 - `--max-use NUMBER` - maximum numbers of token uses
36 ## List generated invites
38 mix pleroma.user invites
42 mix pleroma.user revoke_invite TOKEN OR TOKEN_ID
44 ## Delete the user's account.
46 mix pleroma.user rm NICKNAME
48 ## Delete the user's activities.
50 mix pleroma.user delete_activities NICKNAME
52 ## Sign user out from all applications (delete user's OAuth tokens and authorizations).
54 mix pleroma.user sign_out NICKNAME
56 ## Deactivate or activate the user's account.
58 mix pleroma.user toggle_activated NICKNAME
60 ## Unsubscribe local users from user's account and deactivate it
62 mix pleroma.user unsubscribe NICKNAME
64 ## Unsubscribe local users from an entire instance and deactivate all accounts
66 mix pleroma.user unsubscribe_all_from_instance INSTANCE
68 ## Create a password reset link.
70 mix pleroma.user reset_password NICKNAME
72 ## Set the value of the given user's settings.
74 mix pleroma.user set NICKNAME [OPTION...]
77 - `--locked`/`--no-locked` - whether the user's account is locked
78 - `--moderator`/`--no-moderator` - whether the user is a moderator
79 - `--admin`/`--no-admin` - whether the user is an admin
81 ## Add tags to a user.
83 mix pleroma.user tag NICKNAME TAGS
85 ## Delete tags from a user.
87 mix pleroma.user untag NICKNAME TAGS
89 ## Toggle confirmation of the user's account.
91 mix pleroma.user toggle_confirmed NICKNAME
93 def run(["new", nickname, email | rest]) do
110 name = Keyword.get(options, :name, nickname)
111 bio = Keyword.get(options, :bio, "")
113 {password, generated_password?} =
114 case Keyword.get(options, :password) do
116 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
122 moderator? = Keyword.get(options, :moderator, false)
123 admin? = Keyword.get(options, :admin, false)
124 assume_yes? = Keyword.get(options, :assume_yes, false)
127 A user will be created with the following information:
128 - nickname: #{nickname}
131 if(generated_password?, do: "[generated; a reset link will be created]", else: password)
135 - moderator: #{if(moderator?, do: "true", else: "false")}
136 - admin: #{if(admin?, do: "true", else: "false")}
139 proceed? = assume_yes? or shell_yes?("Continue?")
148 password_confirmation: password,
153 changeset = User.register_changeset(%User{}, params, need_confirmation: false)
154 {:ok, _user} = User.register(changeset)
156 shell_info("User #{nickname} created")
159 run(["set", nickname, "--moderator"])
163 run(["set", nickname, "--admin"])
166 if generated_password? do
167 run(["reset_password", nickname])
170 shell_info("User will not be created.")
174 def run(["rm", nickname]) do
177 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
178 User.perform(:delete, user)
179 shell_info("User #{nickname} deleted.")
182 shell_error("No local user #{nickname}")
186 def run(["toggle_activated", nickname]) do
189 with %User{} = user <- User.get_cached_by_nickname(nickname) do
190 {:ok, user} = User.deactivate(user, !user.info.deactivated)
193 "Activation status of #{nickname}: #{if(user.info.deactivated, do: "de", else: "")}activated"
197 shell_error("No user #{nickname}")
201 def run(["reset_password", nickname]) do
204 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
205 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
206 shell_info("Generated password reset token for #{user.nickname}")
210 Pleroma.Web.Router.Helpers.reset_password_url(
211 Pleroma.Web.Endpoint,
219 shell_error("No local user #{nickname}")
223 def run(["unsubscribe", nickname]) do
226 with %User{} = user <- User.get_cached_by_nickname(nickname) do
227 shell_info("Deactivating #{user.nickname}")
228 User.deactivate(user)
231 |> User.get_friends()
232 |> Enum.each(fn friend ->
233 user = User.get_cached_by_id(user.id)
235 shell_info("Unsubscribing #{friend.nickname} from #{user.nickname}")
236 User.unfollow(user, friend)
241 user = User.get_cached_by_id(user.id)
243 if Enum.empty?(user.following) do
244 shell_info("Successfully unsubscribed all followers from #{user.nickname}")
248 shell_error("No user #{nickname}")
252 def run(["unsubscribe_all_from_instance", instance]) do
255 Pleroma.User.Query.build(%{nickname: "@#{instance}"})
256 |> Pleroma.RepoStreamer.chunk_stream(500)
257 |> Stream.each(fn users ->
259 |> Enum.each(fn user ->
260 run(["unsubscribe", user.nickname])
266 def run(["set", nickname | rest]) do
279 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
281 case Keyword.get(options, :moderator) do
283 value -> set_moderator(user, value)
287 case Keyword.get(options, :locked) do
289 value -> set_locked(user, value)
293 case Keyword.get(options, :admin) do
295 value -> set_admin(user, value)
299 shell_error("No local user #{nickname}")
303 def run(["tag", nickname | tags]) do
306 with %User{} = user <- User.get_cached_by_nickname(nickname) do
307 user = user |> User.tag(tags)
309 shell_info("Tags of #{user.nickname}: #{inspect(tags)}")
312 shell_error("Could not change user tags for #{nickname}")
316 def run(["untag", nickname | tags]) do
319 with %User{} = user <- User.get_cached_by_nickname(nickname) do
320 user = user |> User.untag(tags)
322 shell_info("Tags of #{user.nickname}: #{inspect(tags)}")
325 shell_error("Could not change user tags for #{nickname}")
329 def run(["invite" | rest]) do
331 OptionParser.parse(rest,
340 |> Keyword.update(:expires_at, {:ok, nil}, fn
342 val -> Date.from_iso8601(val)
348 with {:ok, val} <- options[:expires_at],
349 options = Map.put(options, :expires_at, val),
350 {:ok, invite} <- UserInviteToken.create_invite(options) do
351 shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
354 Pleroma.Web.Router.Helpers.redirect_url(
355 Pleroma.Web.Endpoint,
363 shell_error("Could not create invite token: #{inspect(error)}")
367 def run(["invites"]) do
370 shell_info("Invites list:")
372 UserInviteToken.list_invites()
373 |> Enum.each(fn invite ->
375 with expires_at when not is_nil(expires_at) <- invite.expires_at do
376 " | Expires at: #{Date.to_string(expires_at)}"
380 with max_use when not is_nil(max_use) <- invite.max_use do
381 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
385 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
387 }#{expire_info}#{using_info}"
392 def run(["revoke_invite", token]) do
395 with {:ok, invite} <- UserInviteToken.find_by_token(token),
396 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
397 shell_info("Invite for token #{token} was revoked.")
399 _ -> shell_error("No invite found with token #{token}")
403 def run(["delete_activities", nickname]) do
406 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
407 User.delete_user_activities(user)
408 shell_info("User #{nickname} statuses deleted.")
411 shell_error("No local user #{nickname}")
415 def run(["toggle_confirmed", nickname]) do
418 with %User{} = user <- User.get_cached_by_nickname(nickname) do
419 {:ok, user} = User.toggle_confirmation(user)
421 message = if user.info.confirmation_pending, do: "needs", else: "doesn't need"
423 shell_info("#{nickname} #{message} confirmation.")
426 shell_error("No local user #{nickname}")
430 def run(["sign_out", nickname]) do
433 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
434 OAuth.Token.delete_user_tokens(user)
435 OAuth.Authorization.delete_user_authorizations(user)
437 shell_info("#{nickname} signed out from all apps.")
440 shell_error("No local user #{nickname}")
444 defp set_moderator(user, value) do
445 {:ok, user} = User.update_info(user, &User.Info.admin_api_update(&1, %{is_moderator: value}))
447 shell_info("Moderator status of #{user.nickname}: #{user.info.is_moderator}")
451 defp set_admin(user, value) do
452 {:ok, user} = User.update_info(user, &User.Info.admin_api_update(&1, %{is_admin: value}))
454 shell_info("Admin status of #{user.nickname}: #{user.info.is_admin}")
458 defp set_locked(user, value) do
459 {:ok, user} = User.update_info(user, &User.Info.user_upgrade(&1, %{locked: value}))
461 shell_info("Locked status of #{user.nickname}: #{user.info.locked}")