1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2018 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.OAuth
13 @shortdoc "Manages Pleroma users"
15 Manages Pleroma users.
19 mix pleroma.user new NICKNAME EMAIL [OPTION...]
22 - `--name NAME` - the user's name (i.e., "Lain Iwakura")
23 - `--bio BIO` - the user's bio
24 - `--password PASSWORD` - the user's password
25 - `--moderator`/`--no-moderator` - whether the user is a moderator
26 - `--admin`/`--no-admin` - whether the user is an admin
27 - `-y`, `--assume-yes`/`--no-assume-yes` - whether to assume yes to all questions
29 ## Generate an invite link.
31 mix pleroma.user invite [OPTION...]
34 - `--expires_at DATE` - last day on which token is active (e.g. "2019-04-05")
35 - `--max_use NUMBER` - maximum numbers of token uses
37 ## List generated invites
39 mix pleroma.user invites
43 mix pleroma.user revoke_invite TOKEN OR TOKEN_ID
45 ## Delete the user's account.
47 mix pleroma.user rm NICKNAME
49 ## Delete the user's activities.
51 mix pleroma.user delete_activities NICKNAME
53 ## Sign user out from all applications (delete user's OAuth tokens and authorizations).
55 mix pleroma.user sign_out NICKNAME
57 ## Deactivate or activate the user's account.
59 mix pleroma.user toggle_activated NICKNAME
61 ## Unsubscribe local users from user's account and deactivate it
63 mix pleroma.user unsubscribe NICKNAME
65 ## Create a password reset link.
67 mix pleroma.user reset_password NICKNAME
69 ## Set the value of the given user's settings.
71 mix pleroma.user set NICKNAME [OPTION...]
74 - `--locked`/`--no-locked` - whether the user's account is locked
75 - `--moderator`/`--no-moderator` - whether the user is a moderator
76 - `--admin`/`--no-admin` - whether the user is an admin
78 ## Add tags to a user.
80 mix pleroma.user tag NICKNAME TAGS
82 ## Delete tags from a user.
84 mix pleroma.user untag NICKNAME TAGS
86 ## Toggle confirmation of the user's account.
88 mix pleroma.user toggle_confirmed NICKNAME
90 def run(["new", nickname, email | rest]) do
107 name = Keyword.get(options, :name, nickname)
108 bio = Keyword.get(options, :bio, "")
110 {password, generated_password?} =
111 case Keyword.get(options, :password) do
113 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
119 moderator? = Keyword.get(options, :moderator, false)
120 admin? = Keyword.get(options, :admin, false)
121 assume_yes? = Keyword.get(options, :assume_yes, false)
124 A user will be created with the following information:
125 - nickname: #{nickname}
128 if(generated_password?, do: "[generated; a reset link will be created]", else: password)
132 - moderator: #{if(moderator?, do: "true", else: "false")}
133 - admin: #{if(admin?, do: "true", else: "false")}
136 proceed? = assume_yes? or shell_yes?("Continue?")
145 password_confirmation: password,
150 changeset = User.register_changeset(%User{}, params, need_confirmation: false)
151 {:ok, _user} = User.register(changeset)
153 shell_info("User #{nickname} created")
156 run(["set", nickname, "--moderator"])
160 run(["set", nickname, "--admin"])
163 if generated_password? do
164 run(["reset_password", nickname])
167 shell_info("User will not be created.")
171 def run(["rm", nickname]) do
174 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
175 User.perform(:delete, user)
176 shell_info("User #{nickname} deleted.")
179 shell_error("No local user #{nickname}")
183 def run(["toggle_activated", nickname]) do
186 with %User{} = user <- User.get_cached_by_nickname(nickname) do
187 {:ok, user} = User.deactivate(user, !user.info.deactivated)
190 "Activation status of #{nickname}: #{if(user.info.deactivated, do: "de", else: "")}activated"
194 shell_error("No user #{nickname}")
198 def run(["reset_password", nickname]) do
201 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
202 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
203 shell_info("Generated password reset token for #{user.nickname}")
207 Pleroma.Web.Router.Helpers.reset_password_url(
208 Pleroma.Web.Endpoint,
216 shell_error("No local user #{nickname}")
220 def run(["unsubscribe", nickname]) do
223 with %User{} = user <- User.get_cached_by_nickname(nickname) do
224 shell_info("Deactivating #{user.nickname}")
225 User.deactivate(user)
227 {:ok, friends} = User.get_friends(user)
229 Enum.each(friends, fn friend ->
230 user = User.get_cached_by_id(user.id)
232 shell_info("Unsubscribing #{friend.nickname} from #{user.nickname}")
233 User.unfollow(user, friend)
238 user = User.get_cached_by_id(user.id)
240 if Enum.empty?(user.following) do
241 shell_info("Successfully unsubscribed all followers from #{user.nickname}")
245 shell_error("No user #{nickname}")
249 def run(["set", nickname | rest]) do
262 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
264 case Keyword.get(options, :moderator) do
266 value -> set_moderator(user, value)
270 case Keyword.get(options, :locked) do
272 value -> set_locked(user, value)
276 case Keyword.get(options, :admin) do
278 value -> set_admin(user, value)
282 shell_error("No local user #{nickname}")
286 def run(["tag", nickname | tags]) do
289 with %User{} = user <- User.get_cached_by_nickname(nickname) do
290 user = user |> User.tag(tags)
292 shell_info("Tags of #{user.nickname}: #{inspect(tags)}")
295 shell_error("Could not change user tags for #{nickname}")
299 def run(["untag", nickname | tags]) do
302 with %User{} = user <- User.get_cached_by_nickname(nickname) do
303 user = user |> User.untag(tags)
305 shell_info("Tags of #{user.nickname}: #{inspect(tags)}")
308 shell_error("Could not change user tags for #{nickname}")
312 def run(["invite" | rest]) do
314 OptionParser.parse(rest,
323 |> Keyword.update(:expires_at, {:ok, nil}, fn
325 val -> Date.from_iso8601(val)
331 with {:ok, val} <- options[:expires_at],
332 options = Map.put(options, :expires_at, val),
333 {:ok, invite} <- UserInviteToken.create_invite(options) do
334 shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
337 Pleroma.Web.Router.Helpers.redirect_url(
338 Pleroma.Web.Endpoint,
346 shell_error("Could not create invite token: #{inspect(error)}")
350 def run(["invites"]) do
353 shell_info("Invites list:")
355 UserInviteToken.list_invites()
356 |> Enum.each(fn invite ->
358 with expires_at when not is_nil(expires_at) <- invite.expires_at do
359 " | Expires at: #{Date.to_string(expires_at)}"
363 with max_use when not is_nil(max_use) <- invite.max_use do
364 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
368 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
370 }#{expire_info}#{using_info}"
375 def run(["revoke_invite", token]) do
378 with {:ok, invite} <- UserInviteToken.find_by_token(token),
379 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
380 shell_info("Invite for token #{token} was revoked.")
382 _ -> shell_error("No invite found with token #{token}")
386 def run(["delete_activities", nickname]) do
389 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
390 {:ok, _} = User.delete_user_activities(user)
391 shell_info("User #{nickname} statuses deleted.")
394 shell_error("No local user #{nickname}")
398 def run(["toggle_confirmed", nickname]) do
401 with %User{} = user <- User.get_cached_by_nickname(nickname) do
402 {:ok, user} = User.toggle_confirmation(user)
404 message = if user.info.confirmation_pending, do: "needs", else: "doesn't need"
406 shell_info("#{nickname} #{message} confirmation.")
409 shell_error("No local user #{nickname}")
413 def run(["sign_out", nickname]) do
416 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
417 OAuth.Token.delete_user_tokens(user)
418 OAuth.Authorization.delete_user_authorizations(user)
420 shell_info("#{nickname} signed out from all apps.")
423 shell_error("No local user #{nickname}")
427 defp set_moderator(user, value) do
428 info_cng = User.Info.admin_api_update(user.info, %{is_moderator: value})
431 Ecto.Changeset.change(user)
432 |> put_embed(:info, info_cng)
434 {:ok, user} = User.update_and_set_cache(user_cng)
436 shell_info("Moderator status of #{user.nickname}: #{user.info.is_moderator}")
440 defp set_admin(user, value) do
441 info_cng = User.Info.admin_api_update(user.info, %{is_admin: value})
444 Ecto.Changeset.change(user)
445 |> put_embed(:info, info_cng)
447 {:ok, user} = User.update_and_set_cache(user_cng)
449 shell_info("Admin status of #{user.nickname}: #{user.info.is_admin}")
453 defp set_locked(user, value) do
454 info_cng = User.Info.user_upgrade(user.info, %{locked: value})
457 Ecto.Changeset.change(user)
458 |> put_embed(:info, info_cng)
460 {:ok, user} = User.update_and_set_cache(user_cng)
462 shell_info("Locked status of #{user.nickname}: #{user.info.locked}")