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
8 alias Mix.Tasks.Pleroma.Common
10 alias Pleroma.UserInviteToken
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 ## Deactivate or activate the user's account.
54 mix pleroma.user toggle_activated NICKNAME
56 ## Unsubscribe local users from user's account and deactivate it
58 mix pleroma.user unsubscribe NICKNAME
60 ## Create a password reset link.
62 mix pleroma.user reset_password NICKNAME
64 ## Set the value of the given user's settings.
66 mix pleroma.user set NICKNAME [OPTION...]
69 - `--locked`/`--no-locked` - whether the user's account is locked
70 - `--moderator`/`--no-moderator` - whether the user is a moderator
71 - `--admin`/`--no-admin` - whether the user is an admin
73 ## Add tags to a user.
75 mix pleroma.user tag NICKNAME TAGS
77 ## Delete tags from a user.
79 mix pleroma.user untag NICKNAME TAGS
81 ## Toggle confirmation of the user's account.
83 mix pleroma.user toggle_confirmed NICKNAME
85 def run(["new", nickname, email | rest]) do
102 name = Keyword.get(options, :name, nickname)
103 bio = Keyword.get(options, :bio, "")
105 {password, generated_password?} =
106 case Keyword.get(options, :password) do
108 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
114 moderator? = Keyword.get(options, :moderator, false)
115 admin? = Keyword.get(options, :admin, false)
116 assume_yes? = Keyword.get(options, :assume_yes, false)
119 A user will be created with the following information:
120 - nickname: #{nickname}
123 if(generated_password?, do: "[generated; a reset link will be created]", else: password)
127 - moderator: #{if(moderator?, do: "true", else: "false")}
128 - admin: #{if(admin?, do: "true", else: "false")}
131 proceed? = assume_yes? or Mix.shell().yes?("Continue?")
134 Common.start_pleroma()
140 password_confirmation: password,
145 changeset = User.register_changeset(%User{}, params, need_confirmation: false)
146 {:ok, _user} = User.register(changeset)
148 Mix.shell().info("User #{nickname} created")
151 run(["set", nickname, "--moderator"])
155 run(["set", nickname, "--admin"])
158 if generated_password? do
159 run(["reset_password", nickname])
162 Mix.shell().info("User will not be created.")
166 def run(["rm", nickname]) do
167 Common.start_pleroma()
169 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
170 User.perform(:delete, user)
171 Mix.shell().info("User #{nickname} deleted.")
174 Mix.shell().error("No local user #{nickname}")
178 def run(["toggle_activated", nickname]) do
179 Common.start_pleroma()
181 with %User{} = user <- User.get_cached_by_nickname(nickname) do
182 {:ok, user} = User.deactivate(user, !user.info.deactivated)
185 "Activation status of #{nickname}: #{if(user.info.deactivated, do: "de", else: "")}activated"
189 Mix.shell().error("No user #{nickname}")
193 def run(["reset_password", nickname]) do
194 Common.start_pleroma()
196 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
197 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
198 Mix.shell().info("Generated password reset token for #{user.nickname}")
202 Pleroma.Web.Router.Helpers.util_url(
203 Pleroma.Web.Endpoint,
204 :show_password_reset,
211 Mix.shell().error("No local user #{nickname}")
215 def run(["unsubscribe", nickname]) do
216 Common.start_pleroma()
218 with %User{} = user <- User.get_cached_by_nickname(nickname) do
219 Mix.shell().info("Deactivating #{user.nickname}")
220 User.deactivate(user)
222 {:ok, friends} = User.get_friends(user)
224 Enum.each(friends, fn friend ->
225 user = User.get_cached_by_id(user.id)
227 Mix.shell().info("Unsubscribing #{friend.nickname} from #{user.nickname}")
228 User.unfollow(user, friend)
233 user = User.get_cached_by_id(user.id)
235 if Enum.empty?(user.following) do
236 Mix.shell().info("Successfully unsubscribed all followers from #{user.nickname}")
240 Mix.shell().error("No user #{nickname}")
244 def run(["set", nickname | rest]) do
245 Common.start_pleroma()
257 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
259 case Keyword.get(options, :moderator) do
261 value -> set_moderator(user, value)
265 case Keyword.get(options, :locked) do
267 value -> set_locked(user, value)
271 case Keyword.get(options, :admin) do
273 value -> set_admin(user, value)
277 Mix.shell().error("No local user #{nickname}")
281 def run(["tag", nickname | tags]) do
282 Common.start_pleroma()
284 with %User{} = user <- User.get_cached_by_nickname(nickname) do
285 user = user |> User.tag(tags)
287 Mix.shell().info("Tags of #{user.nickname}: #{inspect(tags)}")
290 Mix.shell().error("Could not change user tags for #{nickname}")
294 def run(["untag", nickname | tags]) do
295 Common.start_pleroma()
297 with %User{} = user <- User.get_cached_by_nickname(nickname) do
298 user = user |> User.untag(tags)
300 Mix.shell().info("Tags of #{user.nickname}: #{inspect(tags)}")
303 Mix.shell().error("Could not change user tags for #{nickname}")
307 def run(["invite" | rest]) do
309 OptionParser.parse(rest,
318 |> Keyword.update(:expires_at, {:ok, nil}, fn
320 val -> Date.from_iso8601(val)
324 Common.start_pleroma()
326 with {:ok, val} <- options[:expires_at],
327 options = Map.put(options, :expires_at, val),
328 {:ok, invite} <- UserInviteToken.create_invite(options) do
330 "Generated user invite token " <> String.replace(invite.invite_type, "_", " ")
334 Pleroma.Web.Router.Helpers.redirect_url(
335 Pleroma.Web.Endpoint,
343 Mix.shell().error("Could not create invite token: #{inspect(error)}")
347 def run(["invites"]) do
348 Common.start_pleroma()
350 Mix.shell().info("Invites list:")
352 UserInviteToken.list_invites()
353 |> Enum.each(fn invite ->
355 with expires_at when not is_nil(expires_at) <- invite.expires_at do
356 " | Expires at: #{Date.to_string(expires_at)}"
360 with max_use when not is_nil(max_use) <- invite.max_use do
361 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
365 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
367 }#{expire_info}#{using_info}"
372 def run(["revoke_invite", token]) do
373 Common.start_pleroma()
375 with {:ok, invite} <- UserInviteToken.find_by_token(token),
376 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
377 Mix.shell().info("Invite for token #{token} was revoked.")
379 _ -> Mix.shell().error("No invite found with token #{token}")
383 def run(["delete_activities", nickname]) do
384 Common.start_pleroma()
386 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
387 {:ok, _} = User.delete_user_activities(user)
388 Mix.shell().info("User #{nickname} statuses deleted.")
391 Mix.shell().error("No local user #{nickname}")
395 def run(["toggle_confirmed", nickname]) do
396 Common.start_pleroma()
398 with %User{} = user <- User.get_cached_by_nickname(nickname) do
399 {:ok, user} = User.toggle_confirmation(user)
401 message = if user.info.confirmation_pending, do: "needs", else: "doesn't need"
403 Mix.shell().info("#{nickname} #{message} confirmation.")
406 Mix.shell().error("No local user #{nickname}")
410 defp set_moderator(user, value) do
411 info_cng = User.Info.admin_api_update(user.info, %{is_moderator: value})
414 Ecto.Changeset.change(user)
415 |> put_embed(:info, info_cng)
417 {:ok, user} = User.update_and_set_cache(user_cng)
419 Mix.shell().info("Moderator status of #{user.nickname}: #{user.info.is_moderator}")
423 defp set_admin(user, value) do
424 info_cng = User.Info.admin_api_update(user.info, %{is_admin: value})
427 Ecto.Changeset.change(user)
428 |> put_embed(:info, info_cng)
430 {:ok, user} = User.update_and_set_cache(user_cng)
432 Mix.shell().info("Admin status of #{user.nickname}: #{user.info.is_admin}")
436 defp set_locked(user, value) do
437 info_cng = User.Info.user_upgrade(user.info, %{locked: value})
440 Ecto.Changeset.change(user)
441 |> put_embed(:info, info_cng)
443 {:ok, user} = User.update_and_set_cache(user_cng)
445 Mix.shell().info("Locked status of #{user.nickname}: #{user.info.locked}")