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 ## Add tags to a user.
58 mix pleroma.user tag NICKNAME TAGS
60 ## Delete tags from a user.
62 mix pleroma.user untag NICKNAME TAGS
64 def run(["new", nickname, email | rest]) do
81 name = Keyword.get(options, :name, nickname)
82 bio = Keyword.get(options, :bio, "")
84 {password, generated_password?} =
85 case Keyword.get(options, :password) do
87 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
93 moderator? = Keyword.get(options, :moderator, false)
94 admin? = Keyword.get(options, :admin, false)
95 assume_yes? = Keyword.get(options, :assume_yes, false)
98 A user will be created with the following information:
99 - nickname: #{nickname}
102 if(generated_password?, do: "[generated; a reset link will be created]", else: password)
106 - moderator: #{if(moderator?, do: "true", else: "false")}
107 - admin: #{if(admin?, do: "true", else: "false")}
110 proceed? = assume_yes? or Mix.shell().yes?("Continue?")
112 unless not proceed? do
113 Common.start_pleroma()
119 password_confirmation: password,
124 changeset = User.register_changeset(%User{}, params, confirmed: true)
125 {:ok, _user} = User.register(changeset)
127 Mix.shell().info("User #{nickname} created")
130 run(["set", nickname, "--moderator"])
134 run(["set", nickname, "--admin"])
137 if generated_password? do
138 run(["reset_password", nickname])
141 Mix.shell().info("User will not be created.")
145 def run(["rm", nickname]) do
146 Common.start_pleroma()
148 with %User{local: true} = user <- User.get_by_nickname(nickname) do
150 Mix.shell().info("User #{nickname} deleted.")
153 Mix.shell().error("No local user #{nickname}")
157 def run(["toggle_activated", nickname]) do
158 Common.start_pleroma()
160 with %User{} = user <- User.get_by_nickname(nickname) do
161 {:ok, user} = User.deactivate(user, !user.info.deactivated)
164 "Activation status of #{nickname}: #{if(user.info.deactivated, do: "de", else: "")}activated"
168 Mix.shell().error("No user #{nickname}")
172 def run(["reset_password", nickname]) do
173 Common.start_pleroma()
175 with %User{local: true} = user <- User.get_by_nickname(nickname),
176 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
177 Mix.shell().info("Generated password reset token for #{user.nickname}")
181 Pleroma.Web.Router.Helpers.util_url(
182 Pleroma.Web.Endpoint,
183 :show_password_reset,
190 Mix.shell().error("No local user #{nickname}")
194 def run(["unsubscribe", nickname]) do
195 Common.start_pleroma()
197 with %User{} = user <- User.get_by_nickname(nickname) do
198 Mix.shell().info("Deactivating #{user.nickname}")
199 User.deactivate(user)
201 {:ok, friends} = User.get_friends(user)
203 Enum.each(friends, fn friend ->
204 user = Repo.get(User, user.id)
206 Mix.shell().info("Unsubscribing #{friend.nickname} from #{user.nickname}")
207 User.unfollow(user, friend)
212 user = Repo.get(User, user.id)
214 if length(user.following) == 0 do
215 Mix.shell().info("Successfully unsubscribed all followers from #{user.nickname}")
219 Mix.shell().error("No user #{nickname}")
223 def run(["set", nickname | rest]) do
224 Common.start_pleroma()
236 with %User{local: true} = user <- User.get_by_nickname(nickname) do
238 case Keyword.get(options, :moderator) do
240 value -> set_moderator(user, value)
244 case Keyword.get(options, :locked) do
246 value -> set_locked(user, value)
250 case Keyword.get(options, :admin) do
252 value -> set_admin(user, value)
256 Mix.shell().error("No local user #{nickname}")
260 def run(["tag", nickname | tags]) do
261 Common.start_pleroma()
263 with %User{} = user <- User.get_by_nickname(nickname) do
264 user = user |> User.tag(tags)
266 Mix.shell().info("Tags of #{user.nickname}: #{inspect(tags)}")
269 Mix.shell().error("Could not change user tags for #{nickname}")
273 def run(["untag", nickname | tags]) do
274 Common.start_pleroma()
276 with %User{} = user <- User.get_by_nickname(nickname) do
277 user = user |> User.untag(tags)
279 Mix.shell().info("Tags of #{user.nickname}: #{inspect(tags)}")
282 Mix.shell().error("Could not change user tags for #{nickname}")
286 def run(["invite"]) do
287 Common.start_pleroma()
289 with {:ok, token} <- Pleroma.UserInviteToken.create_token() do
290 Mix.shell().info("Generated user invite token")
293 Pleroma.Web.Router.Helpers.redirect_url(
294 Pleroma.Web.Endpoint,
302 Mix.shell().error("Could not create invite token.")
306 defp set_moderator(user, value) do
307 info_cng = User.Info.admin_api_update(user.info, %{is_moderator: value})
310 Ecto.Changeset.change(user)
311 |> put_embed(:info, info_cng)
313 {:ok, user} = User.update_and_set_cache(user_cng)
315 Mix.shell().info("Moderator status of #{user.nickname}: #{user.info.is_moderator}")
319 defp set_admin(user, value) do
320 info_cng = User.Info.admin_api_update(user.info, %{is_admin: value})
323 Ecto.Changeset.change(user)
324 |> put_embed(:info, info_cng)
326 {:ok, user} = User.update_and_set_cache(user_cng)
328 Mix.shell().info("Admin status of #{user.nickname}: #{user.info.is_admin}")
332 defp set_locked(user, value) do
333 info_cng = User.Info.user_upgrade(user.info, %{locked: value})
336 Ecto.Changeset.change(user)
337 |> put_embed(:info, info_cng)
339 {:ok, user} = User.update_and_set_cache(user_cng)
341 Mix.shell().info("Locked status of #{user.nickname}: #{user.info.locked}")