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 ## Disable or enable the user's account.
58 mix pleroma.user toggle_disabled NICKNAME
60 ## Unsubscribe local users from user's account and deactivate it
62 mix pleroma.user unsubscribe NICKNAME
64 ## Create a password reset link.
66 mix pleroma.user reset_password NICKNAME
68 ## Set the value of the given user's settings.
70 mix pleroma.user set NICKNAME [OPTION...]
73 - `--locked`/`--no-locked` - whether the user's account is locked
74 - `--moderator`/`--no-moderator` - whether the user is a moderator
75 - `--admin`/`--no-admin` - whether the user is an admin
77 ## Add tags to a user.
79 mix pleroma.user tag NICKNAME TAGS
81 ## Delete tags from a user.
83 mix pleroma.user untag NICKNAME TAGS
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?")
133 unless not proceed? do
134 Common.start_pleroma()
140 password_confirmation: password,
145 changeset = User.register_changeset(%User{}, params, confirmed: true)
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_by_nickname(nickname) do
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_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(["toggle_disabled", nickname]) do
194 Common.start_pleroma()
196 case User.get_by_nickname(nickname) do
198 {:ok, user} = User.disable(user, !user.info.disabled)
199 status = if(user.info.disabled, do: "ON", else: "OFF")
200 Mix.shell().info("Disabled status of #{nickname}: #{status}")
203 Mix.shell().error("No user #{nickname}")
207 def run(["reset_password", nickname]) do
208 Common.start_pleroma()
210 with %User{local: true} = user <- User.get_by_nickname(nickname),
211 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
212 Mix.shell().info("Generated password reset token for #{user.nickname}")
216 Pleroma.Web.Router.Helpers.util_url(
217 Pleroma.Web.Endpoint,
218 :show_password_reset,
225 Mix.shell().error("No local user #{nickname}")
229 def run(["unsubscribe", nickname]) do
230 Common.start_pleroma()
232 with %User{} = user <- User.get_by_nickname(nickname) do
233 Mix.shell().info("Deactivating #{user.nickname}")
234 User.deactivate(user)
236 {:ok, friends} = User.get_friends(user)
238 Enum.each(friends, fn friend ->
239 user = User.get_by_id(user.id)
241 Mix.shell().info("Unsubscribing #{friend.nickname} from #{user.nickname}")
242 User.unfollow(user, friend)
247 user = User.get_by_id(user.id)
249 if Enum.empty?(user.following) do
250 Mix.shell().info("Successfully unsubscribed all followers from #{user.nickname}")
254 Mix.shell().error("No user #{nickname}")
258 def run(["set", nickname | rest]) do
259 Common.start_pleroma()
271 with %User{local: true} = user <- User.get_by_nickname(nickname) do
273 case Keyword.get(options, :moderator) do
275 value -> set_moderator(user, value)
279 case Keyword.get(options, :locked) do
281 value -> set_locked(user, value)
285 case Keyword.get(options, :admin) do
287 value -> set_admin(user, value)
291 Mix.shell().error("No local user #{nickname}")
295 def run(["tag", nickname | tags]) do
296 Common.start_pleroma()
298 with %User{} = user <- User.get_by_nickname(nickname) do
299 user = user |> User.tag(tags)
301 Mix.shell().info("Tags of #{user.nickname}: #{inspect(tags)}")
304 Mix.shell().error("Could not change user tags for #{nickname}")
308 def run(["untag", nickname | tags]) do
309 Common.start_pleroma()
311 with %User{} = user <- User.get_by_nickname(nickname) do
312 user = user |> User.untag(tags)
314 Mix.shell().info("Tags of #{user.nickname}: #{inspect(tags)}")
317 Mix.shell().error("Could not change user tags for #{nickname}")
321 def run(["invite" | rest]) do
323 OptionParser.parse(rest,
332 |> Keyword.update(:expires_at, {:ok, nil}, fn
334 val -> Date.from_iso8601(val)
338 Common.start_pleroma()
340 with {:ok, val} <- options[:expires_at],
341 options = Map.put(options, :expires_at, val),
342 {:ok, invite} <- UserInviteToken.create_invite(options) do
344 "Generated user invite token " <> String.replace(invite.invite_type, "_", " ")
348 Pleroma.Web.Router.Helpers.redirect_url(
349 Pleroma.Web.Endpoint,
357 Mix.shell().error("Could not create invite token: #{inspect(error)}")
361 def run(["invites"]) do
362 Common.start_pleroma()
364 Mix.shell().info("Invites list:")
366 UserInviteToken.list_invites()
367 |> Enum.each(fn invite ->
369 with expires_at when not is_nil(expires_at) <- invite.expires_at do
370 " | Expires at: #{Date.to_string(expires_at)}"
374 with max_use when not is_nil(max_use) <- invite.max_use do
375 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
379 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
381 }#{expire_info}#{using_info}"
386 def run(["revoke_invite", token]) do
387 Common.start_pleroma()
389 with {:ok, invite} <- UserInviteToken.find_by_token(token),
390 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
391 Mix.shell().info("Invite for token #{token} was revoked.")
393 _ -> Mix.shell().error("No invite found with token #{token}")
397 def run(["delete_activities", nickname]) do
398 Common.start_pleroma()
400 with %User{local: true} = user <- User.get_by_nickname(nickname) do
401 User.delete_user_activities(user)
402 Mix.shell().info("User #{nickname} statuses deleted.")
405 Mix.shell().error("No local user #{nickname}")
409 defp set_moderator(user, value) do
410 info_cng = User.Info.admin_api_update(user.info, %{is_moderator: value})
413 Ecto.Changeset.change(user)
414 |> put_embed(:info, info_cng)
416 {:ok, user} = User.update_and_set_cache(user_cng)
418 Mix.shell().info("Moderator status of #{user.nickname}: #{user.info.is_moderator}")
422 defp set_admin(user, value) do
423 info_cng = User.Info.admin_api_update(user.info, %{is_admin: value})
426 Ecto.Changeset.change(user)
427 |> put_embed(:info, info_cng)
429 {:ok, user} = User.update_and_set_cache(user_cng)
431 Mix.shell().info("Admin status of #{user.nickname}: #{user.info.is_admin}")
435 defp set_locked(user, value) do
436 info_cng = User.Info.user_upgrade(user.info, %{locked: value})
439 Ecto.Changeset.change(user)
440 |> put_embed(:info, info_cng)
442 {:ok, user} = User.update_and_set_cache(user_cng)
444 Mix.shell().info("Locked status of #{user.nickname}: #{user.info.locked}")