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
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
32 ## Delete the user's account.
34 mix pleroma.user rm NICKNAME
36 ## Deactivate or activate the user's account.
38 mix pleroma.user toggle_activated NICKNAME
40 ## Unsubscribe local users from user's account and deactivate it
42 mix pleroma.user unsubscribe NICKNAME
44 ## Create a password reset link.
46 mix pleroma.user reset_password NICKNAME
48 ## Set the value of the given user's settings.
50 mix pleroma.user set NICKNAME [OPTION...]
53 - `--locked`/`--no-locked` - whether the user's account is locked
54 - `--moderator`/`--no-moderator` - whether the user is a moderator
55 - `--admin`/`--no-admin` - whether the user is an admin
57 ## Add tags to a user.
59 mix pleroma.user tag NICKNAME TAGS
61 ## Delete tags from a user.
63 mix pleroma.user untag NICKNAME TAGS
65 def run(["new", nickname, email | rest]) do
82 name = Keyword.get(options, :name, nickname)
83 bio = Keyword.get(options, :bio, "")
85 {password, generated_password?} =
86 case Keyword.get(options, :password) do
88 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
94 moderator? = Keyword.get(options, :moderator, false)
95 admin? = Keyword.get(options, :admin, false)
96 assume_yes? = Keyword.get(options, :assume_yes, false)
99 A user will be created with the following information:
100 - nickname: #{nickname}
103 if(generated_password?, do: "[generated; a reset link will be created]", else: password)
107 - moderator: #{if(moderator?, do: "true", else: "false")}
108 - admin: #{if(admin?, do: "true", else: "false")}
111 proceed? = assume_yes? or Mix.shell().yes?("Continue?")
113 unless not proceed? do
114 Common.start_pleroma()
120 password_confirmation: password,
125 changeset = User.register_changeset(%User{}, params, confirmed: true)
126 {:ok, _user} = User.register(changeset)
128 Mix.shell().info("User #{nickname} created")
131 run(["set", nickname, "--moderator"])
135 run(["set", nickname, "--admin"])
138 if generated_password? do
139 run(["reset_password", nickname])
142 Mix.shell().info("User will not be created.")
146 def run(["rm", nickname]) do
147 Common.start_pleroma()
149 with %User{local: true} = user <- User.get_by_nickname(nickname) do
151 Mix.shell().info("User #{nickname} deleted.")
154 Mix.shell().error("No local user #{nickname}")
158 def run(["toggle_activated", nickname]) do
159 Common.start_pleroma()
161 with %User{} = user <- User.get_by_nickname(nickname) do
162 {:ok, user} = User.deactivate(user, !user.info.deactivated)
165 "Activation status of #{nickname}: #{if(user.info.deactivated, do: "de", else: "")}activated"
169 Mix.shell().error("No user #{nickname}")
173 def run(["reset_password", nickname]) do
174 Common.start_pleroma()
176 with %User{local: true} = user <- User.get_by_nickname(nickname),
177 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
178 Mix.shell().info("Generated password reset token for #{user.nickname}")
182 Pleroma.Web.Router.Helpers.util_url(
183 Pleroma.Web.Endpoint,
184 :show_password_reset,
191 Mix.shell().error("No local user #{nickname}")
195 def run(["unsubscribe", nickname]) do
196 Common.start_pleroma()
198 with %User{} = user <- User.get_by_nickname(nickname) do
199 Mix.shell().info("Deactivating #{user.nickname}")
200 User.deactivate(user)
202 {:ok, friends} = User.get_friends(user)
204 Enum.each(friends, fn friend ->
205 user = Repo.get(User, user.id)
207 Mix.shell().info("Unsubscribing #{friend.nickname} from #{user.nickname}")
208 User.unfollow(user, friend)
213 user = Repo.get(User, user.id)
215 if Enum.empty?(user.following) do
216 Mix.shell().info("Successfully unsubscribed all followers from #{user.nickname}")
220 Mix.shell().error("No user #{nickname}")
224 def run(["set", nickname | rest]) do
225 Common.start_pleroma()
237 with %User{local: true} = user <- User.get_by_nickname(nickname) do
239 case Keyword.get(options, :moderator) do
241 value -> set_moderator(user, value)
245 case Keyword.get(options, :locked) do
247 value -> set_locked(user, value)
251 case Keyword.get(options, :admin) do
253 value -> set_admin(user, value)
257 Mix.shell().error("No local user #{nickname}")
261 def run(["tag", nickname | tags]) do
262 Common.start_pleroma()
264 with %User{} = user <- User.get_by_nickname(nickname) do
265 user = user |> User.tag(tags)
267 Mix.shell().info("Tags of #{user.nickname}: #{inspect(tags)}")
270 Mix.shell().error("Could not change user tags for #{nickname}")
274 def run(["untag", nickname | tags]) do
275 Common.start_pleroma()
277 with %User{} = user <- User.get_by_nickname(nickname) do
278 user = user |> User.untag(tags)
280 Mix.shell().info("Tags of #{user.nickname}: #{inspect(tags)}")
283 Mix.shell().error("Could not change user tags for #{nickname}")
287 def run(["invite"]) do
288 Common.start_pleroma()
290 with {:ok, token} <- Pleroma.UserInviteToken.create_token() do
291 Mix.shell().info("Generated user invite token")
294 Pleroma.Web.Router.Helpers.redirect_url(
295 Pleroma.Web.Endpoint,
303 Mix.shell().error("Could not create invite token.")
307 defp set_moderator(user, value) do
308 info_cng = User.Info.admin_api_update(user.info, %{is_moderator: value})
311 Ecto.Changeset.change(user)
312 |> put_embed(:info, info_cng)
314 {:ok, user} = User.update_and_set_cache(user_cng)
316 Mix.shell().info("Moderator status of #{user.nickname}: #{user.info.is_moderator}")
320 defp set_admin(user, value) do
321 info_cng = User.Info.admin_api_update(user.info, %{is_admin: value})
324 Ecto.Changeset.change(user)
325 |> put_embed(:info, info_cng)
327 {:ok, user} = User.update_and_set_cache(user_cng)
329 Mix.shell().info("Admin status of #{user.nickname}: #{user.info.is_admin}")
333 defp set_locked(user, value) do
334 info_cng = User.Info.user_upgrade(user.info, %{locked: value})
337 Ecto.Changeset.change(user)
338 |> put_embed(:info, info_cng)
340 {:ok, user} = User.update_and_set_cache(user_cng)
342 Mix.shell().info("Locked status of #{user.nickname}: #{user.info.locked}")