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

465 lines
12 KiB
Elixir
Raw Normal View History

2018-12-23 20:05:55 +00:00
# Pleroma: A lightweight social networking server
# Copyright © 2017-2019 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
2019-02-09 15:16:26 +00:00
alias Pleroma.User
2019-04-06 09:58:22 +00:00
alias Pleroma.UserInviteToken
2019-06-19 19:29:36 +00:00
alias Pleroma.Web.OAuth
@shortdoc "Manages Pleroma users"
@moduledoc """
Manages Pleroma users.
## Create a new user.
mix pleroma.user new NICKNAME EMAIL [OPTION...]
Options:
- `--name NAME` - the user's name (i.e., "Lain Iwakura")
- `--bio BIO` - the user's bio
- `--password PASSWORD` - the user's password
- `--moderator`/`--no-moderator` - whether the user is a moderator
- `--admin`/`--no-admin` - whether the user is an admin
- `-y`, `--assume-yes`/`--no-assume-yes` - whether to assume yes to all questions
2018-12-02 19:27:49 +00:00
2018-12-02 19:26:15 +00:00
## Generate an invite link.
2018-12-09 09:12:48 +00:00
2019-04-06 09:58:22 +00:00
mix pleroma.user invite [OPTION...]
Options:
- `--expires-at DATE` - last day on which token is active (e.g. "2019-04-05")
- `--max-use NUMBER` - maximum numbers of token uses
2019-04-06 09:58:22 +00:00
2019-04-06 15:38:35 +00:00
## List generated invites
2019-04-06 09:58:22 +00:00
2019-04-06 15:38:35 +00:00
mix pleroma.user invites
2019-04-06 09:58:22 +00:00
## Revoke invite
2019-04-06 15:38:35 +00:00
mix pleroma.user revoke_invite TOKEN OR TOKEN_ID
## Delete the user's account.
mix pleroma.user rm NICKNAME
2019-04-02 09:30:11 +00:00
## Delete the user's activities.
mix pleroma.user delete_activities NICKNAME
2019-06-19 19:29:36 +00:00
## Sign user out from all applications (delete user's OAuth tokens and authorizations).
mix pleroma.user sign_out NICKNAME
## Deactivate or activate the user's account.
mix pleroma.user toggle_activated NICKNAME
2018-12-07 07:44:54 +00:00
## Unsubscribe local users from user's account and deactivate it
2018-12-09 09:12:48 +00:00
mix pleroma.user unsubscribe NICKNAME
## Unsubscribe local users from an entire instance and deactivate all accounts
mix pleroma.user unsubscribe_all_from_instance INSTANCE
## Create a password reset link.
mix pleroma.user reset_password NICKNAME
## Set the value of the given user's settings.
mix pleroma.user set NICKNAME [OPTION...]
Options:
- `--locked`/`--no-locked` - whether the user's account is locked
- `--moderator`/`--no-moderator` - whether the user is a moderator
- `--admin`/`--no-admin` - whether the user is an admin
2019-02-04 02:33:11 +00:00
## Add tags to a user.
mix pleroma.user tag NICKNAME TAGS
## Delete tags from a user.
mix pleroma.user untag NICKNAME TAGS
2019-05-16 13:23:41 +00:00
## Toggle confirmation of the user's account.
mix pleroma.user toggle_confirmed NICKNAME
"""
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_yes?("Continue?")
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, need_confirmation: false)
{: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()
2019-04-22 07:20:43 +00:00
with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
User.perform(:delete, user)
shell_info("User #{nickname} deleted.")
else
_ ->
shell_error("No local user #{nickname}")
end
end
def run(["toggle_activated", nickname]) do
start_pleroma()
2019-04-22 07:20:43 +00:00
with %User{} = user <- User.get_cached_by_nickname(nickname) do
2018-12-12 20:30:16 +00:00
{:ok, user} = User.deactivate(user, !user.info.deactivated)
shell_info(
2018-12-12 20:30:16 +00:00
"Activation status of #{nickname}: #{if(user.info.deactivated, do: "de", else: "")}activated"
)
else
_ ->
shell_error("No 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(["unsubscribe", nickname]) do
start_pleroma()
2019-04-22 07:20:43 +00:00
with %User{} = user <- User.get_cached_by_nickname(nickname) do
shell_info("Deactivating #{user.nickname}")
User.deactivate(user)
2019-09-24 07:16:52 +00:00
user
|> User.get_friends()
|> Enum.each(fn friend ->
2019-04-22 07:20:43 +00:00
user = User.get_cached_by_id(user.id)
shell_info("Unsubscribing #{friend.nickname} from #{user.nickname}")
User.unfollow(user, friend)
end)
:timer.sleep(500)
2019-04-22 07:20:43 +00:00
user = User.get_cached_by_id(user.id)
2019-02-03 17:44:18 +00:00
if Enum.empty?(user.following) do
shell_info("Successfully unsubscribed all followers from #{user.nickname}")
end
else
_ ->
shell_error("No user #{nickname}")
end
end
def run(["unsubscribe_all_from_instance", instance]) do
start_pleroma()
Pleroma.User.Query.build(%{nickname: "@#{instance}"})
|> Pleroma.RepoStreamer.chunk_stream(500)
|> Stream.each(fn users ->
users
|> Enum.each(fn user ->
run(["unsubscribe", user.nickname])
end)
end)
|> Stream.run()
end
def run(["set", nickname | rest]) do
start_pleroma()
{options, [], []} =
OptionParser.parse(
rest,
strict: [
moderator: :boolean,
admin: :boolean,
locked: :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, :moderator) do
nil -> user
value -> set_moderator(user, value)
end
user =
case Keyword.get(options, :locked) do
nil -> user
value -> set_locked(user, value)
end
_user =
case Keyword.get(options, :admin) do
nil -> user
value -> set_admin(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)
shell_info("Tags of #{user.nickname}: #{inspect(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)
shell_info("Tags of #{user.nickname}: #{inspect(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(
2019-04-06 15:38:35 +00:00
"ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
2019-04-06 09:58:22 +00:00
invite.used
2019-04-06 15:38:35 +00:00
}#{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
2019-05-16 13:23:41 +00:00
def run(["toggle_confirmed", 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.toggle_confirmation(user)
message = if user.info.confirmation_pending, do: "needs", else: "doesn't need"
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
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
2019-06-19 19:29:36 +00:00
OAuth.Token.delete_user_tokens(user)
OAuth.Authorization.delete_user_authorizations(user)
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
defp set_moderator(user, value) do
{:ok, user} = User.update_info(user, &User.Info.admin_api_update(&1, %{is_moderator: value}))
shell_info("Moderator status of #{user.nickname}: #{user.info.is_moderator}")
user
end
defp set_admin(user, value) do
{:ok, user} = User.update_info(user, &User.Info.admin_api_update(&1, %{is_admin: value}))
shell_info("Admin status of #{user.nickname}: #{user.info.is_admin}")
user
end
defp set_locked(user, value) do
{:ok, user} = User.update_info(user, &User.Info.user_upgrade(&1, %{locked: value}))
shell_info("Locked status of #{user.nickname}: #{user.info.locked}")
user
end
end