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
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 ## Delete the user's activities.
37 mix pleroma.user delete_activities NICKNAME
39 ## Deactivate or activate the user's account.
41 mix pleroma.user toggle_activated NICKNAME
43 ## Unsubscribe local users from user's account and deactivate it
45 mix pleroma.user unsubscribe NICKNAME
47 ## Create a password reset link.
49 mix pleroma.user reset_password NICKNAME
51 ## Set the value of the given user's settings.
53 mix pleroma.user set NICKNAME [OPTION...]
56 - `--locked`/`--no-locked` - whether the user's account is locked
57 - `--moderator`/`--no-moderator` - whether the user is a moderator
58 - `--admin`/`--no-admin` - whether the user is an admin
60 ## Add tags to a user.
62 mix pleroma.user tag NICKNAME TAGS
64 ## Delete tags from a user.
66 mix pleroma.user untag NICKNAME TAGS
68 def run(["new", nickname, email | rest]) do
85 name = Keyword.get(options, :name, nickname)
86 bio = Keyword.get(options, :bio, "")
88 {password, generated_password?} =
89 case Keyword.get(options, :password) do
91 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
97 moderator? = Keyword.get(options, :moderator, false)
98 admin? = Keyword.get(options, :admin, false)
99 assume_yes? = Keyword.get(options, :assume_yes, false)
102 A user will be created with the following information:
103 - nickname: #{nickname}
106 if(generated_password?, do: "[generated; a reset link will be created]", else: password)
110 - moderator: #{if(moderator?, do: "true", else: "false")}
111 - admin: #{if(admin?, do: "true", else: "false")}
114 proceed? = assume_yes? or Mix.shell().yes?("Continue?")
116 unless not proceed? do
117 Common.start_pleroma()
123 password_confirmation: password,
128 changeset = User.register_changeset(%User{}, params, confirmed: true)
129 {:ok, _user} = User.register(changeset)
131 Mix.shell().info("User #{nickname} created")
134 run(["set", nickname, "--moderator"])
138 run(["set", nickname, "--admin"])
141 if generated_password? do
142 run(["reset_password", nickname])
145 Mix.shell().info("User will not be created.")
149 def run(["rm", nickname]) do
150 Common.start_pleroma()
152 with %User{local: true} = user <- User.get_by_nickname(nickname) do
154 Mix.shell().info("User #{nickname} deleted.")
157 Mix.shell().error("No local user #{nickname}")
161 def run(["toggle_activated", nickname]) do
162 Common.start_pleroma()
164 with %User{} = user <- User.get_by_nickname(nickname) do
165 {:ok, user} = User.deactivate(user, !user.info.deactivated)
168 "Activation status of #{nickname}: #{if(user.info.deactivated, do: "de", else: "")}activated"
172 Mix.shell().error("No user #{nickname}")
176 def run(["reset_password", nickname]) do
177 Common.start_pleroma()
179 with %User{local: true} = user <- User.get_by_nickname(nickname),
180 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
181 Mix.shell().info("Generated password reset token for #{user.nickname}")
185 Pleroma.Web.Router.Helpers.util_url(
186 Pleroma.Web.Endpoint,
187 :show_password_reset,
194 Mix.shell().error("No local user #{nickname}")
198 def run(["unsubscribe", nickname]) do
199 Common.start_pleroma()
201 with %User{} = user <- User.get_by_nickname(nickname) do
202 Mix.shell().info("Deactivating #{user.nickname}")
203 User.deactivate(user)
205 {:ok, friends} = User.get_friends(user)
207 Enum.each(friends, fn friend ->
208 user = User.get_by_id(user.id)
210 Mix.shell().info("Unsubscribing #{friend.nickname} from #{user.nickname}")
211 User.unfollow(user, friend)
216 user = User.get_by_id(user.id)
218 if Enum.empty?(user.following) do
219 Mix.shell().info("Successfully unsubscribed all followers from #{user.nickname}")
223 Mix.shell().error("No user #{nickname}")
227 def run(["set", nickname | rest]) do
228 Common.start_pleroma()
240 with %User{local: true} = user <- User.get_by_nickname(nickname) do
242 case Keyword.get(options, :moderator) do
244 value -> set_moderator(user, value)
248 case Keyword.get(options, :locked) do
250 value -> set_locked(user, value)
254 case Keyword.get(options, :admin) do
256 value -> set_admin(user, value)
260 Mix.shell().error("No local user #{nickname}")
264 def run(["tag", nickname | tags]) do
265 Common.start_pleroma()
267 with %User{} = user <- User.get_by_nickname(nickname) do
268 user = user |> User.tag(tags)
270 Mix.shell().info("Tags of #{user.nickname}: #{inspect(tags)}")
273 Mix.shell().error("Could not change user tags for #{nickname}")
277 def run(["untag", nickname | tags]) do
278 Common.start_pleroma()
280 with %User{} = user <- User.get_by_nickname(nickname) do
281 user = user |> User.untag(tags)
283 Mix.shell().info("Tags of #{user.nickname}: #{inspect(tags)}")
286 Mix.shell().error("Could not change user tags for #{nickname}")
290 def run(["invite"]) do
291 Common.start_pleroma()
293 with {:ok, token} <- Pleroma.UserInviteToken.create_token() do
294 Mix.shell().info("Generated user invite token")
297 Pleroma.Web.Router.Helpers.redirect_url(
298 Pleroma.Web.Endpoint,
306 Mix.shell().error("Could not create invite token.")
310 def run(["delete_activities", nickname]) do
311 Common.start_pleroma()
313 with %User{local: true} = user <- User.get_by_nickname(nickname) do
314 User.delete_user_activities(user)
315 Mix.shell().info("User #{nickname} statuses deleted.")
318 Mix.shell().error("No local user #{nickname}")
322 defp set_moderator(user, value) do
323 info_cng = User.Info.admin_api_update(user.info, %{is_moderator: value})
326 Ecto.Changeset.change(user)
327 |> put_embed(:info, info_cng)
329 {:ok, user} = User.update_and_set_cache(user_cng)
331 Mix.shell().info("Moderator status of #{user.nickname}: #{user.info.is_moderator}")
335 defp set_admin(user, value) do
336 info_cng = User.Info.admin_api_update(user.info, %{is_admin: value})
339 Ecto.Changeset.change(user)
340 |> put_embed(:info, info_cng)
342 {:ok, user} = User.update_and_set_cache(user_cng)
344 Mix.shell().info("Admin status of #{user.nickname}: #{user.info.is_admin}")
348 defp set_locked(user, value) do
349 info_cng = User.Info.user_upgrade(user.info, %{locked: value})
352 Ecto.Changeset.change(user)
353 |> put_embed(:info, info_cng)
355 {:ok, user} = User.update_and_set_cache(user_cng)
357 Mix.shell().info("Locked status of #{user.nickname}: #{user.info.locked}")