spc-pleroma/lib/mix/tasks/pleroma/user.ex

458 lines
12 KiB
Elixir
Raw Normal View History

2018-12-23 20:05:55 +00:00
# Pleroma: A lightweight social networking server
2022-02-26 06:11:42 +00:00
# Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
2018-12-23 20:05:55 +00:00
# SPDX-License-Identifier: AGPL-3.0-only
defmodule Mix.Tasks.Pleroma.User do
use Mix.Task
import Mix.Pleroma
alias Ecto.Changeset
2019-02-09 15:16:26 +00:00
alias Pleroma.User
2019-04-06 09:58:22 +00:00
alias Pleroma.UserInviteToken
alias Pleroma.Web.ActivityPub.Builder
alias Pleroma.Web.ActivityPub.Pipeline
@shortdoc "Manages Pleroma users"
@moduledoc File.read!("docs/administration/CLI_tasks/user.md")
def run(["new", nickname, email | rest]) do
{options, [], []} =
OptionParser.parse(
rest,
strict: [
name: :string,
bio: :string,
password: :string,
moderator: :boolean,
admin: :boolean,
assume_yes: :boolean
],
aliases: [
y: :assume_yes
]
)
name = Keyword.get(options, :name, nickname)
bio = Keyword.get(options, :bio, "")
{password, generated_password?} =
case Keyword.get(options, :password) do
nil ->
{:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
password ->
{password, false}
end
moderator? = Keyword.get(options, :moderator, false)
admin? = Keyword.get(options, :admin, false)
assume_yes? = Keyword.get(options, :assume_yes, false)
shell_info("""
A user will be created with the following information:
- nickname: #{nickname}
- email: #{email}
- password: #{if(generated_password?, do: "[generated; a reset link will be created]", else: password)}
- name: #{name}
- bio: #{bio}
- moderator: #{if(moderator?, do: "true", else: "false")}
- admin: #{if(admin?, do: "true", else: "false")}
""")
proceed? = assume_yes? or shell_prompt("Continue?", "n") in ~w(Yn Y y)
2019-05-01 09:09:53 +00:00
if proceed? do
start_pleroma()
params = %{
nickname: nickname,
email: email,
password: password,
password_confirmation: password,
name: name,
bio: bio
}
changeset = User.register_changeset(%User{}, params, is_confirmed: true)
{:ok, _user} = User.register(changeset)
shell_info("User #{nickname} created")
if moderator? do
run(["set", nickname, "--moderator"])
end
if admin? do
run(["set", nickname, "--admin"])
end
if generated_password? do
run(["reset_password", nickname])
end
else
shell_info("User will not be created.")
end
end
def run(["rm", nickname]) do
start_pleroma()
with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
{:ok, delete_data, _} <- Builder.delete(user, user.ap_id),
{:ok, _delete, _} <- Pipeline.common_pipeline(delete_data, local: true) do
shell_info("User #{nickname} deleted.")
else
2020-02-25 14:34:56 +00:00
_ -> shell_error("No local user #{nickname}")
end
end
def run(["reset_password", nickname]) do
start_pleroma()
2019-04-22 07:20:43 +00:00
with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
{:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
shell_info("Generated password reset token for #{user.nickname}")
IO.puts("URL: #{Pleroma.Web.Router.Helpers.reset_password_url(Pleroma.Web.Endpoint,
:reset,
token.token)}")
else
_ ->
shell_error("No local user #{nickname}")
end
end
def run(["reset_mfa", nickname]) do
start_pleroma()
with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
{:ok, _token} <- Pleroma.MFA.disable(user) do
shell_info("Multi-Factor Authentication disabled for #{user.nickname}")
else
_ ->
shell_error("No local user #{nickname}")
end
end
def run(["activate", nickname]) do
start_pleroma()
with %User{} = user <- User.get_cached_by_nickname(nickname),
false <- user.is_active do
User.set_activation(user, true)
:timer.sleep(500)
shell_info("Successfully activated #{nickname}")
else
true ->
shell_info("User #{nickname} already activated")
_ ->
shell_error("No user #{nickname}")
end
end
def run(["deactivate", nickname]) do
start_pleroma()
with %User{} = user <- User.get_cached_by_nickname(nickname),
true <- user.is_active do
User.set_activation(user, false)
:timer.sleep(500)
2019-04-22 07:20:43 +00:00
user = User.get_cached_by_id(user.id)
if Enum.empty?(Enum.filter(User.get_friends(user), & &1.local)) do
shell_info("Successfully deactivated #{nickname} and unsubscribed all local followers")
end
else
false ->
shell_info("User #{nickname} already deactivated")
_ ->
shell_error("No user #{nickname}")
end
end
def run(["deactivate_all_from_instance", instance]) do
start_pleroma()
Pleroma.User.Query.build(%{nickname: "@#{instance}"})
|> Pleroma.Repo.chunk_stream(500, :batches)
|> Stream.each(fn users ->
users
|> Enum.each(fn user ->
run(["deactivate", user.nickname])
end)
end)
|> Stream.run()
end
def run(["set", nickname | rest]) do
start_pleroma()
{options, [], []} =
OptionParser.parse(
rest,
strict: [
admin: :boolean,
confirmed: :boolean,
locked: :boolean,
moderator: :boolean
]
)
2019-04-22 07:20:43 +00:00
with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
user =
case Keyword.get(options, :admin) do
nil -> user
value -> set_admin(user, value)
end
user =
case Keyword.get(options, :confirmed) do
nil -> user
value -> set_confirmation(user, value)
end
user =
case Keyword.get(options, :locked) do
nil -> user
value -> set_locked(user, value)
end
_user =
case Keyword.get(options, :moderator) do
nil -> user
value -> set_moderator(user, value)
end
else
_ ->
shell_error("No local user #{nickname}")
end
end
2019-02-04 02:33:11 +00:00
def run(["tag", nickname | tags]) do
start_pleroma()
2019-02-04 02:33:11 +00:00
2019-04-22 07:20:43 +00:00
with %User{} = user <- User.get_cached_by_nickname(nickname) do
2019-02-04 02:33:11 +00:00
user = user |> User.tag(tags)
2020-07-09 15:59:48 +00:00
shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
2019-02-04 02:33:11 +00:00
else
_ ->
shell_error("Could not change user tags for #{nickname}")
2019-02-04 02:33:11 +00:00
end
end
def run(["untag", nickname | tags]) do
start_pleroma()
2019-02-04 02:33:11 +00:00
2019-04-22 07:20:43 +00:00
with %User{} = user <- User.get_cached_by_nickname(nickname) do
2019-02-04 02:33:11 +00:00
user = user |> User.untag(tags)
2020-07-09 15:59:48 +00:00
shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
2019-02-04 02:33:11 +00:00
else
_ ->
shell_error("Could not change user tags for #{nickname}")
2019-02-04 02:33:11 +00:00
end
end
2019-04-06 09:58:22 +00:00
def run(["invite" | rest]) do
{options, [], []} =
OptionParser.parse(rest,
strict: [
expires_at: :string,
2019-04-06 09:58:22 +00:00
max_use: :integer
]
)
2019-04-06 15:38:35 +00:00
options =
options
|> Keyword.update(:expires_at, {:ok, nil}, fn
2019-04-06 15:38:35 +00:00
nil -> {:ok, nil}
val -> Date.from_iso8601(val)
end)
|> Enum.into(%{})
2019-04-06 09:58:22 +00:00
start_pleroma()
2018-12-09 09:12:48 +00:00
with {:ok, val} <- options[:expires_at],
options = Map.put(options, :expires_at, val),
2019-04-06 15:38:35 +00:00
{:ok, invite} <- UserInviteToken.create_invite(options) do
shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
2018-12-09 09:12:48 +00:00
url =
Pleroma.Web.Router.Helpers.redirect_url(
Pleroma.Web.Endpoint,
:registration_page,
2019-04-06 13:24:22 +00:00
invite.token
2018-12-09 09:12:48 +00:00
)
IO.puts(url)
else
2019-04-06 15:38:35 +00:00
error ->
shell_error("Could not create invite token: #{inspect(error)}")
2018-12-09 09:12:48 +00:00
end
end
2019-04-06 15:38:35 +00:00
def run(["invites"]) do
start_pleroma()
2019-04-06 09:58:22 +00:00
shell_info("Invites list:")
2019-04-06 09:58:22 +00:00
UserInviteToken.list_invites()
|> Enum.each(fn invite ->
2019-04-06 15:38:35 +00:00
expire_info =
with expires_at when not is_nil(expires_at) <- invite.expires_at do
" | Expires at: #{Date.to_string(expires_at)}"
2019-04-06 09:58:22 +00:00
end
using_info =
2019-04-06 15:38:35 +00:00
with max_use when not is_nil(max_use) <- invite.max_use do
" | Max use: #{max_use} Left use: #{max_use - invite.uses}"
2019-04-06 09:58:22 +00:00
end
shell_info(
"ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{invite.used}#{expire_info}#{using_info}"
2019-04-06 09:58:22 +00:00
)
end)
end
2019-04-06 15:38:35 +00:00
def run(["revoke_invite", token]) do
start_pleroma()
2019-04-06 09:58:22 +00:00
2019-04-06 15:38:35 +00:00
with {:ok, invite} <- UserInviteToken.find_by_token(token),
{:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
shell_info("Invite for token #{token} was revoked.")
2019-04-06 09:58:22 +00:00
else
_ -> shell_error("No invite found with token #{token}")
2019-04-06 09:58:22 +00:00
end
end
def run(["delete_activities", nickname]) do
start_pleroma()
2019-04-22 07:20:43 +00:00
with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
2019-09-24 07:16:52 +00:00
User.delete_user_activities(user)
shell_info("User #{nickname} statuses deleted.")
else
_ ->
shell_error("No local user #{nickname}")
end
end
def run(["confirm", nickname]) do
start_pleroma()
2019-05-16 13:23:41 +00:00
with %User{} = user <- User.get_cached_by_nickname(nickname) do
{:ok, user} = User.confirm(user)
2019-05-16 13:23:41 +00:00
message = if !user.is_confirmed, do: "needs", else: "doesn't need"
2019-05-16 13:23:41 +00:00
shell_info("#{nickname} #{message} confirmation.")
2019-05-16 13:23:41 +00:00
else
_ ->
shell_error("No local user #{nickname}")
2019-05-16 13:23:41 +00:00
end
end
def run(["confirm_all"]) do
start_pleroma()
Pleroma.User.Query.build(%{
local: true,
is_active: true,
is_moderator: false,
is_admin: false,
invisible: false
})
|> Pleroma.Repo.chunk_stream(500, :batches)
|> Stream.each(fn users ->
users
|> Enum.each(fn user -> User.set_confirmation(user, true) end)
end)
|> Stream.run()
end
def run(["unconfirm_all"]) do
start_pleroma()
Pleroma.User.Query.build(%{
local: true,
is_active: true,
is_moderator: false,
is_admin: false,
invisible: false
})
|> Pleroma.Repo.chunk_stream(500, :batches)
|> Stream.each(fn users ->
users
|> Enum.each(fn user -> User.set_confirmation(user, false) end)
end)
|> Stream.run()
end
2019-06-19 19:29:36 +00:00
def run(["sign_out", nickname]) do
start_pleroma()
2019-06-19 19:29:36 +00:00
with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
User.global_sign_out(user)
2019-06-19 19:29:36 +00:00
shell_info("#{nickname} signed out from all apps.")
2019-06-19 19:29:36 +00:00
else
_ ->
shell_error("No local user #{nickname}")
2019-06-19 19:29:36 +00:00
end
end
2019-11-17 20:58:30 +00:00
def run(["list"]) do
start_pleroma()
Pleroma.User.Query.build(%{local: true})
|> Pleroma.Repo.chunk_stream(500, :batches)
2019-11-17 20:58:30 +00:00
|> Stream.each(fn users ->
users
|> Enum.each(fn user ->
shell_info(
"#{user.nickname} moderator: #{user.is_moderator}, admin: #{user.is_admin}, locked: #{user.is_locked}, is_active: #{user.is_active}"
2019-11-17 20:58:30 +00:00
)
end)
end)
|> Stream.run()
end
defp set_moderator(user, value) do
{:ok, user} =
user
|> Changeset.change(%{is_moderator: value})
|> User.update_and_set_cache()
shell_info("Moderator status of #{user.nickname}: #{user.is_moderator}")
user
end
defp set_admin(user, value) do
{:ok, user} = User.admin_api_update(user, %{is_admin: value})
shell_info("Admin status of #{user.nickname}: #{user.is_admin}")
user
end
defp set_locked(user, value) do
{:ok, user} =
user
|> Changeset.change(%{is_locked: value})
|> User.update_and_set_cache()
shell_info("Locked status of #{user.nickname}: #{user.is_locked}")
user
end
defp set_confirmation(user, value) do
{:ok, user} = User.set_confirmation(user, value)
shell_info("Confirmation status of #{user.nickname}: #{user.is_confirmed}")
user
end
end