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
10 alias Pleroma.UserInviteToken
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 [OPTION...]
33 - `--expires_at DATE` - last day on which token is active (e.g. "2019-04-05")
34 - `--max_use NUMBER` - maximum numbers of token uses
36 ## List generated invites
38 mix pleroma.user invites
42 mix pleroma.user revoke_invite TOKEN OR TOKEN_ID
44 ## Delete the user's account.
46 mix pleroma.user rm NICKNAME
48 ## Delete the user's activities.
50 mix pleroma.user delete_activities NICKNAME
52 ## Deactivate or activate the user's account.
54 mix pleroma.user toggle_activated NICKNAME
56 ## Unsubscribe local users from user's account and deactivate it
58 mix pleroma.user unsubscribe NICKNAME
60 ## Create a password reset link.
62 mix pleroma.user reset_password NICKNAME
64 ## Set the value of the given user's settings.
66 mix pleroma.user set NICKNAME [OPTION...]
69 - `--locked`/`--no-locked` - whether the user's account is locked
70 - `--moderator`/`--no-moderator` - whether the user is a moderator
71 - `--admin`/`--no-admin` - whether the user is an admin
73 ## Add tags to a user.
75 mix pleroma.user tag NICKNAME TAGS
77 ## Delete tags from a user.
79 mix pleroma.user untag NICKNAME TAGS
81 def run(["new", nickname, email | rest]) do
98 name = Keyword.get(options, :name, nickname)
99 bio = Keyword.get(options, :bio, "")
101 {password, generated_password?} =
102 case Keyword.get(options, :password) do
104 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
110 moderator? = Keyword.get(options, :moderator, false)
111 admin? = Keyword.get(options, :admin, false)
112 assume_yes? = Keyword.get(options, :assume_yes, false)
115 A user will be created with the following information:
116 - nickname: #{nickname}
119 if(generated_password?, do: "[generated; a reset link will be created]", else: password)
123 - moderator: #{if(moderator?, do: "true", else: "false")}
124 - admin: #{if(admin?, do: "true", else: "false")}
127 proceed? = assume_yes? or Mix.shell().yes?("Continue?")
130 Common.start_pleroma()
136 password_confirmation: password,
141 changeset = User.register_changeset(%User{}, params, confirmed: true)
142 {:ok, _user} = User.register(changeset)
144 Mix.shell().info("User #{nickname} created")
147 run(["set", nickname, "--moderator"])
151 run(["set", nickname, "--admin"])
154 if generated_password? do
155 run(["reset_password", nickname])
158 Mix.shell().info("User will not be created.")
162 def run(["rm", nickname]) do
163 Common.start_pleroma()
165 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
166 User.perform(:delete, user)
167 Mix.shell().info("User #{nickname} deleted.")
170 Mix.shell().error("No local user #{nickname}")
174 def run(["toggle_activated", nickname]) do
175 Common.start_pleroma()
177 with %User{} = user <- User.get_cached_by_nickname(nickname) do
178 {:ok, user} = User.deactivate(user, !user.info.deactivated)
181 "Activation status of #{nickname}: #{if(user.info.deactivated, do: "de", else: "")}activated"
185 Mix.shell().error("No user #{nickname}")
189 def run(["reset_password", nickname]) do
190 Common.start_pleroma()
192 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
193 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
194 Mix.shell().info("Generated password reset token for #{user.nickname}")
198 Pleroma.Web.Router.Helpers.util_url(
199 Pleroma.Web.Endpoint,
200 :show_password_reset,
207 Mix.shell().error("No local user #{nickname}")
211 def run(["unsubscribe", nickname]) do
212 Common.start_pleroma()
214 with %User{} = user <- User.get_cached_by_nickname(nickname) do
215 Mix.shell().info("Deactivating #{user.nickname}")
216 User.deactivate(user)
218 {:ok, friends} = User.get_friends(user)
220 Enum.each(friends, fn friend ->
221 user = User.get_cached_by_id(user.id)
223 Mix.shell().info("Unsubscribing #{friend.nickname} from #{user.nickname}")
224 User.unfollow(user, friend)
229 user = User.get_cached_by_id(user.id)
231 if Enum.empty?(user.following) do
232 Mix.shell().info("Successfully unsubscribed all followers from #{user.nickname}")
236 Mix.shell().error("No user #{nickname}")
240 def run(["set", nickname | rest]) do
241 Common.start_pleroma()
253 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
255 case Keyword.get(options, :moderator) do
257 value -> set_moderator(user, value)
261 case Keyword.get(options, :locked) do
263 value -> set_locked(user, value)
267 case Keyword.get(options, :admin) do
269 value -> set_admin(user, value)
273 Mix.shell().error("No local user #{nickname}")
277 def run(["tag", nickname | tags]) do
278 Common.start_pleroma()
280 with %User{} = user <- User.get_cached_by_nickname(nickname) do
281 user = user |> User.tag(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(["untag", nickname | tags]) do
291 Common.start_pleroma()
293 with %User{} = user <- User.get_cached_by_nickname(nickname) do
294 user = user |> User.untag(tags)
296 Mix.shell().info("Tags of #{user.nickname}: #{inspect(tags)}")
299 Mix.shell().error("Could not change user tags for #{nickname}")
303 def run(["invite" | rest]) do
305 OptionParser.parse(rest,
314 |> Keyword.update(:expires_at, {:ok, nil}, fn
316 val -> Date.from_iso8601(val)
320 Common.start_pleroma()
322 with {:ok, val} <- options[:expires_at],
323 options = Map.put(options, :expires_at, val),
324 {:ok, invite} <- UserInviteToken.create_invite(options) do
326 "Generated user invite token " <> String.replace(invite.invite_type, "_", " ")
330 Pleroma.Web.Router.Helpers.redirect_url(
331 Pleroma.Web.Endpoint,
339 Mix.shell().error("Could not create invite token: #{inspect(error)}")
343 def run(["invites"]) do
344 Common.start_pleroma()
346 Mix.shell().info("Invites list:")
348 UserInviteToken.list_invites()
349 |> Enum.each(fn invite ->
351 with expires_at when not is_nil(expires_at) <- invite.expires_at do
352 " | Expires at: #{Date.to_string(expires_at)}"
356 with max_use when not is_nil(max_use) <- invite.max_use do
357 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
361 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
363 }#{expire_info}#{using_info}"
368 def run(["revoke_invite", token]) do
369 Common.start_pleroma()
371 with {:ok, invite} <- UserInviteToken.find_by_token(token),
372 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
373 Mix.shell().info("Invite for token #{token} was revoked.")
375 _ -> Mix.shell().error("No invite found with token #{token}")
379 def run(["delete_activities", nickname]) do
380 Common.start_pleroma()
382 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
383 {:ok, _} = User.delete_user_activities(user)
384 Mix.shell().info("User #{nickname} statuses deleted.")
387 Mix.shell().error("No local user #{nickname}")
391 defp set_moderator(user, value) do
392 info_cng = User.Info.admin_api_update(user.info, %{is_moderator: value})
395 Ecto.Changeset.change(user)
396 |> put_embed(:info, info_cng)
398 {:ok, user} = User.update_and_set_cache(user_cng)
400 Mix.shell().info("Moderator status of #{user.nickname}: #{user.info.is_moderator}")
404 defp set_admin(user, value) do
405 info_cng = User.Info.admin_api_update(user.info, %{is_admin: value})
408 Ecto.Changeset.change(user)
409 |> put_embed(:info, info_cng)
411 {:ok, user} = User.update_and_set_cache(user_cng)
413 Mix.shell().info("Admin status of #{user.nickname}: #{user.info.is_admin}")
417 defp set_locked(user, value) do
418 info_cng = User.Info.user_upgrade(user.info, %{locked: value})
421 Ecto.Changeset.change(user)
422 |> put_embed(:info, info_cng)
424 {:ok, user} = User.update_and_set_cache(user_cng)
426 Mix.shell().info("Locked status of #{user.nickname}: #{user.info.locked}")