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 Pleroma.{Repo, User}
9 alias Mix.Tasks.Pleroma.Common
11 @shortdoc "Manages Pleroma users"
13 Manages Pleroma users.
17 mix pleroma.user new NICKNAME EMAIL [OPTION...]
20 - `--name NAME` - the user's name (i.e., "Lain Iwakura")
21 - `--bio BIO` - the user's bio
22 - `--password PASSWORD` - the user's password
23 - `--moderator`/`--no-moderator` - whether the user is a moderator
24 - `--admin`/`--no-admin` - whether the user is an admin
26 ## Generate an invite link.
28 mix pleroma.user invite
30 ## Delete the user's account.
32 mix pleroma.user rm NICKNAME
34 ## Deactivate or activate the user's account.
36 mix pleroma.user toggle_activated NICKNAME
38 ## Unsubscribe local users from user's account and deactivate it
40 mix pleroma.user unsubscribe NICKNAME
42 ## Create a password reset link.
44 mix pleroma.user reset_password NICKNAME
46 ## Set the value of the given user's settings.
48 mix pleroma.user set NICKNAME [OPTION...]
51 - `--locked`/`--no-locked` - whether the user's account is locked
52 - `--moderator`/`--no-moderator` - whether the user is a moderator
53 - `--admin`/`--no-admin` - whether the user is an admin
55 def run(["new", nickname, email | rest]) do
68 name = Keyword.get(options, :name, nickname)
69 bio = Keyword.get(options, :bio, "")
71 {password, generated_password?} =
72 case Keyword.get(options, :password) do
74 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
80 moderator? = Keyword.get(options, :moderator, false)
81 admin? = Keyword.get(options, :admin, false)
84 A user will be created with the following information:
85 - nickname: #{nickname}
88 if(generated_password?, do: "[generated; a reset link will be created]", else: password)
92 - moderator: #{if(moderator?, do: "true", else: "false")}
93 - admin: #{if(admin?, do: "true", else: "false")}
96 proceed? = Mix.shell().yes?("Continue?")
98 unless not proceed? do
99 Common.start_pleroma()
105 password_confirmation: password,
110 changeset = User.register_changeset(%User{}, params, confirmed: true)
111 {:ok, _user} = User.register(changeset)
113 Mix.shell().info("User #{nickname} created")
116 run(["set", nickname, "--moderator"])
120 run(["set", nickname, "--admin"])
123 if generated_password? do
124 run(["reset_password", nickname])
127 Mix.shell().info("User will not be created.")
131 def run(["rm", nickname]) do
132 Common.start_pleroma()
134 with %User{local: true} = user <- User.get_by_nickname(nickname) do
136 Mix.shell().info("User #{nickname} deleted.")
139 Mix.shell().error("No local user #{nickname}")
143 def run(["toggle_activated", nickname]) do
144 Common.start_pleroma()
146 with %User{} = user <- User.get_by_nickname(nickname) do
147 {:ok, user} = User.deactivate(user, !user.info.deactivated)
150 "Activation status of #{nickname}: #{if(user.info.deactivated, do: "de", else: "")}activated"
154 Mix.shell().error("No user #{nickname}")
158 def run(["reset_password", nickname]) do
159 Common.start_pleroma()
161 with %User{local: true} = user <- User.get_by_nickname(nickname),
162 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
163 Mix.shell().info("Generated password reset token for #{user.nickname}")
167 Pleroma.Web.Router.Helpers.util_url(
168 Pleroma.Web.Endpoint,
169 :show_password_reset,
176 Mix.shell().error("No local user #{nickname}")
180 def run(["unsubscribe", nickname]) do
181 Common.start_pleroma()
183 with %User{} = user <- User.get_by_nickname(nickname) do
184 Mix.shell().info("Deactivating #{user.nickname}")
185 User.deactivate(user)
187 {:ok, friends} = User.get_friends(user)
189 Enum.each(friends, fn friend ->
190 user = Repo.get(User, user.id)
192 Mix.shell().info("Unsubscribing #{friend.nickname} from #{user.nickname}")
193 User.unfollow(user, friend)
198 user = Repo.get(User, user.id)
200 if length(user.following) == 0 do
201 Mix.shell().info("Successfully unsubscribed all followers from #{user.nickname}")
205 Mix.shell().error("No user #{nickname}")
209 def run(["set", nickname | rest]) do
210 Common.start_pleroma()
222 with %User{local: true} = user <- User.get_by_nickname(nickname) do
224 case Keyword.get(options, :moderator) do
226 value -> set_moderator(user, value)
230 case Keyword.get(options, :locked) do
232 value -> set_locked(user, value)
236 case Keyword.get(options, :admin) do
238 value -> set_admin(user, value)
242 Mix.shell().error("No local user #{nickname}")
246 def run(["invite"]) do
247 Common.start_pleroma()
249 with {:ok, token} <- Pleroma.UserInviteToken.create_token() do
250 Mix.shell().info("Generated user invite token")
253 Pleroma.Web.Router.Helpers.redirect_url(
254 Pleroma.Web.Endpoint,
262 Mix.shell().error("Could not create invite token.")
266 defp set_moderator(user, value) do
267 info_cng = User.Info.admin_api_update(user.info, %{is_moderator: value})
270 Ecto.Changeset.change(user)
271 |> put_embed(:info, info_cng)
273 {:ok, user} = User.update_and_set_cache(user_cng)
275 Mix.shell().info("Moderator status of #{user.nickname}: #{user.info.is_moderator}")
279 defp set_admin(user, value) do
280 info_cng = User.Info.admin_api_update(user.info, %{is_admin: value})
283 Ecto.Changeset.change(user)
284 |> put_embed(:info, info_cng)
286 {:ok, user} = User.update_and_set_cache(user_cng)
288 Mix.shell().info("Admin status of #{user.nickname}: #{user.info.is_admin}")
292 defp set_locked(user, value) do
293 info_cng = User.Info.user_upgrade(user.info, %{locked: value})
296 Ecto.Changeset.change(user)
297 |> put_embed(:info, info_cng)
299 {:ok, user} = User.update_and_set_cache(user_cng)
301 Mix.shell().info("Locked status of #{user.nickname}: #{user.info.locked}")