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
25 - `-y`, `--assume-yes`/`--no-assume-yes` - whether to assume yes to all questions
27 ## Generate an invite link.
29 mix pleroma.user invite
31 ## Delete the user's account.
33 mix pleroma.user rm NICKNAME
35 ## Deactivate or activate the user's account.
37 mix pleroma.user toggle_activated NICKNAME
39 ## Unsubscribe local users from user's account and deactivate it
41 mix pleroma.user unsubscribe NICKNAME
43 ## Create a password reset link.
45 mix pleroma.user reset_password NICKNAME
47 ## Set the value of the given user's settings.
49 mix pleroma.user set NICKNAME [OPTION...]
52 - `--locked`/`--no-locked` - whether the user's account is locked
53 - `--moderator`/`--no-moderator` - whether the user is a moderator
54 - `--admin`/`--no-admin` - whether the user is an admin
56 def run(["new", nickname, email | rest]) do
73 name = Keyword.get(options, :name, nickname)
74 bio = Keyword.get(options, :bio, "")
76 {password, generated_password?} =
77 case Keyword.get(options, :password) do
79 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
85 moderator? = Keyword.get(options, :moderator, false)
86 admin? = Keyword.get(options, :admin, false)
87 assume_yes? = Keyword.get(options, :assume_yes, false)
90 A user will be created with the following information:
91 - nickname: #{nickname}
94 if(generated_password?, do: "[generated; a reset link will be created]", else: password)
98 - moderator: #{if(moderator?, do: "true", else: "false")}
99 - admin: #{if(admin?, do: "true", else: "false")}
102 proceed? = assume_yes? or Mix.shell().yes?("Continue?")
104 unless not proceed? do
105 Common.start_pleroma()
111 password_confirmation: password,
116 changeset = User.register_changeset(%User{}, params, confirmed: true)
117 {:ok, _user} = User.register(changeset)
119 Mix.shell().info("User #{nickname} created")
122 run(["set", nickname, "--moderator"])
126 run(["set", nickname, "--admin"])
129 if generated_password? do
130 run(["reset_password", nickname])
133 Mix.shell().info("User will not be created.")
137 def run(["rm", nickname]) do
138 Common.start_pleroma()
140 with %User{local: true} = user <- User.get_by_nickname(nickname) do
142 Mix.shell().info("User #{nickname} deleted.")
145 Mix.shell().error("No local user #{nickname}")
149 def run(["toggle_activated", nickname]) do
150 Common.start_pleroma()
152 with %User{} = user <- User.get_by_nickname(nickname) do
153 {:ok, user} = User.deactivate(user, !user.info.deactivated)
156 "Activation status of #{nickname}: #{if(user.info.deactivated, do: "de", else: "")}activated"
160 Mix.shell().error("No user #{nickname}")
164 def run(["reset_password", nickname]) do
165 Common.start_pleroma()
167 with %User{local: true} = user <- User.get_by_nickname(nickname),
168 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
169 Mix.shell().info("Generated password reset token for #{user.nickname}")
173 Pleroma.Web.Router.Helpers.util_url(
174 Pleroma.Web.Endpoint,
175 :show_password_reset,
182 Mix.shell().error("No local user #{nickname}")
186 def run(["unsubscribe", nickname]) do
187 Common.start_pleroma()
189 with %User{} = user <- User.get_by_nickname(nickname) do
190 Mix.shell().info("Deactivating #{user.nickname}")
191 User.deactivate(user)
193 {:ok, friends} = User.get_friends(user)
195 Enum.each(friends, fn friend ->
196 user = Repo.get(User, user.id)
198 Mix.shell().info("Unsubscribing #{friend.nickname} from #{user.nickname}")
199 User.unfollow(user, friend)
204 user = Repo.get(User, user.id)
206 if length(user.following) == 0 do
207 Mix.shell().info("Successfully unsubscribed all followers from #{user.nickname}")
211 Mix.shell().error("No user #{nickname}")
215 def run(["set", nickname | rest]) do
216 Common.start_pleroma()
228 with %User{local: true} = user <- User.get_by_nickname(nickname) do
230 case Keyword.get(options, :moderator) do
232 value -> set_moderator(user, value)
236 case Keyword.get(options, :locked) do
238 value -> set_locked(user, value)
242 case Keyword.get(options, :admin) do
244 value -> set_admin(user, value)
248 Mix.shell().error("No local user #{nickname}")
252 def run(["invite"]) do
253 Common.start_pleroma()
255 with {:ok, token} <- Pleroma.UserInviteToken.create_token() do
256 Mix.shell().info("Generated user invite token")
259 Pleroma.Web.Router.Helpers.redirect_url(
260 Pleroma.Web.Endpoint,
268 Mix.shell().error("Could not create invite token.")
272 defp set_moderator(user, value) do
273 info_cng = User.Info.admin_api_update(user.info, %{is_moderator: value})
276 Ecto.Changeset.change(user)
277 |> put_embed(:info, info_cng)
279 {:ok, user} = User.update_and_set_cache(user_cng)
281 Mix.shell().info("Moderator status of #{user.nickname}: #{user.info.is_moderator}")
285 defp set_admin(user, value) do
286 info_cng = User.Info.admin_api_update(user.info, %{is_admin: value})
289 Ecto.Changeset.change(user)
290 |> put_embed(:info, info_cng)
292 {:ok, user} = User.update_and_set_cache(user_cng)
294 Mix.shell().info("Admin status of #{user.nickname}: #{user.info.is_admin}")
298 defp set_locked(user, value) do
299 info_cng = User.Info.user_upgrade(user.info, %{locked: value})
302 Ecto.Changeset.change(user)
303 |> put_embed(:info, info_cng)
305 {:ok, user} = User.update_and_set_cache(user_cng)
307 Mix.shell().info("Locked status of #{user.nickname}: #{user.info.locked}")