spc-pleroma/lib/pleroma/user/info.ex

478 lines
13 KiB
Elixir
Raw Normal View History

# Pleroma: A lightweight social networking server
2018-12-31 15:41:47 +00:00
# Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only
defmodule Pleroma.User.Info do
use Ecto.Schema
import Ecto.Changeset
2019-03-12 19:15:28 +00:00
alias Pleroma.User.Info
2019-04-13 10:40:42 +00:00
@type t :: %__MODULE__{}
embedded_schema do
2018-11-18 17:27:04 +00:00
field(:banner, :map, default: %{})
2018-12-02 10:20:38 +00:00
field(:background, :map, default: %{})
2018-11-18 17:27:04 +00:00
field(:source_data, :map, default: %{})
field(:note_count, :integer, default: 0)
field(:follower_count, :integer, default: 0)
# Should be filled in only for remote users
field(:following_count, :integer, default: nil)
2018-11-18 17:27:04 +00:00
field(:locked, :boolean, default: false)
field(:confirmation_pending, :boolean, default: false)
field(:password_reset_pending, :boolean, default: false)
field(:confirmation_token, :string, default: nil)
2018-11-18 17:27:04 +00:00
field(:default_scope, :string, default: "public")
field(:blocks, {:array, :string}, default: [])
field(:domain_blocks, {:array, :string}, default: [])
field(:mutes, {:array, :string}, default: [])
field(:muted_reblogs, {:array, :string}, default: [])
2019-07-14 13:29:31 +00:00
field(:muted_notifications, {:array, :string}, default: [])
field(:subscribers, {:array, :string}, default: [])
2018-11-18 17:27:04 +00:00
field(:deactivated, :boolean, default: false)
field(:no_rich_text, :boolean, default: false)
field(:ap_enabled, :boolean, default: false)
field(:is_moderator, :boolean, default: false)
2018-12-01 08:03:16 +00:00
field(:is_admin, :boolean, default: false)
field(:show_role, :boolean, default: true)
2018-11-18 18:33:43 +00:00
field(:keys, :string, default: nil)
2018-11-20 19:12:39 +00:00
field(:settings, :map, default: nil)
2018-11-27 17:12:03 +00:00
field(:magic_key, :string, default: nil)
2018-11-27 17:37:46 +00:00
field(:uri, :string, default: nil)
2018-11-30 16:08:02 +00:00
field(:topic, :string, default: nil)
field(:hub, :string, default: nil)
2018-12-01 11:46:08 +00:00
field(:salmon, :string, default: nil)
field(:hide_followers_count, :boolean, default: false)
field(:hide_follows_count, :boolean, default: false)
field(:hide_followers, :boolean, default: false)
field(:hide_follows, :boolean, default: false)
field(:hide_favorites, :boolean, default: true)
2019-01-16 15:15:46 +00:00
field(:pinned_activities, {:array, :string}, default: [])
2019-04-21 09:36:25 +00:00
field(:email_notifications, :map, default: %{"digest" => false})
field(:mascot, :map, default: nil)
2019-02-12 13:59:34 +00:00
field(:emoji, {:array, :map}, default: [])
field(:pleroma_settings_store, :map, default: %{})
field(:fields, {:array, :map}, default: nil)
field(:raw_fields, {:array, :map}, default: [])
field(:discoverable, :boolean, default: false)
field(:notification_settings, :map,
default: %{
"followers" => true,
"follows" => true,
"non_follows" => true,
"non_followers" => true
}
)
2019-06-03 13:04:39 +00:00
field(:skip_thread_containment, :boolean, default: false)
# Found in the wild
# ap_id -> Where is this used?
# bio -> Where is this used?
# avatar -> Where is this used?
# fqn -> Where is this used?
# host -> Where is this used?
# subject _> Where is this used?
end
def set_activation_status(info, deactivated) do
params = %{deactivated: deactivated}
info
|> cast(params, [:deactivated])
|> validate_required([:deactivated])
end
2018-11-18 17:17:56 +00:00
def set_password_reset_pending(info, pending) do
params = %{password_reset_pending: pending}
info
|> cast(params, [:password_reset_pending])
|> validate_required([:password_reset_pending])
end
def update_notification_settings(info, settings) do
settings =
settings
|> Enum.map(fn {k, v} -> {k, v in [true, "true", "True", "1"]} end)
|> Map.new()
notification_settings =
info.notification_settings
|> Map.merge(settings)
|> Map.take(["followers", "follows", "non_follows", "non_followers"])
params = %{notification_settings: notification_settings}
info
|> cast(params, [:notification_settings])
|> validate_required([:notification_settings])
end
2019-04-13 10:40:42 +00:00
@doc """
Update email notifications in the given User.Info struct.
Examples:
iex> update_email_notifications(%Pleroma.User.Info{email_notifications: %{"digest" => false}}, %{"digest" => true})
%Pleroma.User.Info{email_notifications: %{"digest" => true}}
"""
@spec update_email_notifications(t(), map()) :: Ecto.Changeset.t()
def update_email_notifications(info, settings) do
email_notifications =
info.email_notifications
|> Map.merge(settings)
|> Map.take(["digest"])
params = %{email_notifications: email_notifications}
fields = [:email_notifications]
info
|> cast(params, fields)
|> validate_required(fields)
end
2018-11-18 17:17:56 +00:00
def add_to_note_count(info, number) do
2018-11-18 17:52:21 +00:00
set_note_count(info, info.note_count + number)
end
def set_note_count(info, number) do
2018-11-18 17:27:04 +00:00
params = %{note_count: Enum.max([0, number])}
2018-11-18 17:17:56 +00:00
info
|> cast(params, [:note_count])
|> validate_required([:note_count])
end
2018-11-18 17:24:16 +00:00
def set_follower_count(info, number) do
params = %{follower_count: Enum.max([0, number])}
info
|> cast(params, [:follower_count])
|> validate_required([:follower_count])
end
2018-11-18 17:40:31 +00:00
def set_mutes(info, mutes) do
params = %{mutes: mutes}
info
|> cast(params, [:mutes])
|> validate_required([:mutes])
end
2019-07-14 13:29:31 +00:00
@spec set_notification_mutes(Changeset.t(), [String.t()], boolean()) :: Changeset.t()
def set_notification_mutes(changeset, muted_notifications, notifications?) do
if notifications? do
put_change(changeset, :muted_notifications, muted_notifications)
|> validate_required([:muted_notifications])
else
changeset
end
end
2018-11-18 17:40:31 +00:00
def set_blocks(info, blocks) do
params = %{blocks: blocks}
info
|> cast(params, [:blocks])
|> validate_required([:blocks])
end
def set_subscribers(info, subscribers) do
params = %{subscribers: subscribers}
info
|> cast(params, [:subscribers])
|> validate_required([:subscribers])
end
@spec add_to_mutes(Info.t(), String.t(), boolean()) :: Changeset.t()
def add_to_mutes(info, muted, notifications?) do
info
|> set_mutes(Enum.uniq([muted | info.mutes]))
|> set_notification_mutes(
2019-07-14 13:29:31 +00:00
Enum.uniq([muted | info.muted_notifications]),
notifications?
)
end
@spec remove_from_mutes(Info.t(), String.t()) :: Changeset.t()
def remove_from_mutes(info, muted) do
info
|> set_mutes(List.delete(info.mutes, muted))
|> set_notification_mutes(List.delete(info.muted_notifications, muted), true)
2019-07-14 13:29:31 +00:00
end
2018-11-18 17:40:31 +00:00
def add_to_block(info, blocked) do
set_blocks(info, Enum.uniq([blocked | info.blocks]))
end
def remove_from_block(info, blocked) do
set_blocks(info, List.delete(info.blocks, blocked))
end
2018-11-18 18:33:43 +00:00
def add_to_subscribers(info, subscribed) do
set_subscribers(info, Enum.uniq([subscribed | info.subscribers]))
end
def remove_from_subscribers(info, subscribed) do
set_subscribers(info, List.delete(info.subscribers, subscribed))
end
2018-11-18 20:40:52 +00:00
def set_domain_blocks(info, domain_blocks) do
params = %{domain_blocks: domain_blocks}
info
|> cast(params, [:domain_blocks])
|> validate_required([:domain_blocks])
end
def add_to_domain_block(info, domain_blocked) do
set_domain_blocks(info, Enum.uniq([domain_blocked | info.domain_blocks]))
end
def remove_from_domain_block(info, domain_blocked) do
set_domain_blocks(info, List.delete(info.domain_blocks, domain_blocked))
end
2018-11-18 18:33:43 +00:00
def set_keys(info, keys) do
params = %{keys: keys}
info
|> cast(params, [:keys])
|> validate_required([:keys])
end
2018-11-18 20:40:52 +00:00
def remote_user_creation(info, params) do
2019-09-02 11:31:23 +00:00
params =
if Map.has_key?(params, :fields) do
Map.put(params, :fields, Enum.map(params[:fields], &truncate_field/1))
else
params
end
2019-09-02 11:15:40 +00:00
2018-11-18 20:40:52 +00:00
info
2018-11-20 18:07:01 +00:00
|> cast(params, [
:ap_enabled,
:source_data,
:banner,
2018-11-27 17:12:03 +00:00
:locked,
2018-11-27 17:37:46 +00:00
:magic_key,
2018-11-30 16:08:02 +00:00
:uri,
:hub,
2018-12-01 11:46:08 +00:00
:topic,
:salmon,
:hide_followers,
:hide_follows,
:hide_followers_count,
:hide_follows_count,
:follower_count,
:fields,
:following_count,
:discoverable
2018-11-20 18:07:01 +00:00
])
|> validate_fields(true)
2018-11-18 20:40:52 +00:00
end
2018-11-18 21:15:03 +00:00
def user_upgrade(info, params, remote? \\ false) do
2018-11-27 16:42:45 +00:00
info
|> cast(params, [
:ap_enabled,
:source_data,
:banner,
2018-11-27 17:12:03 +00:00
:locked,
:magic_key,
:follower_count,
:following_count,
:hide_follows,
:fields,
:hide_followers,
:discoverable,
:hide_followers_count,
:hide_follows_count
2018-11-27 16:42:45 +00:00
])
|> validate_fields(remote?)
2018-11-27 16:42:45 +00:00
end
2018-11-30 16:07:37 +00:00
def profile_update(info, params) do
info
|> cast(params, [
:locked,
:no_rich_text,
:default_scope,
2018-12-05 18:22:40 +00:00
:banner,
:hide_follows,
:hide_followers,
:hide_followers_count,
:hide_follows_count,
:hide_favorites,
:background,
2019-06-03 13:04:39 +00:00
:show_role,
2019-06-04 06:49:08 +00:00
:skip_thread_containment,
2019-07-24 12:26:35 +00:00
:fields,
:raw_fields,
:pleroma_settings_store,
:discoverable
2018-11-30 16:07:37 +00:00
])
2019-07-24 12:26:35 +00:00
|> validate_fields()
2018-11-30 16:07:37 +00:00
end
def validate_fields(changeset, remote? \\ false) do
limit_name = if remote?, do: :max_remote_account_fields, else: :max_account_fields
limit = Pleroma.Config.get([:instance, limit_name], 0)
2019-07-24 12:26:35 +00:00
changeset
|> validate_length(:fields, max: limit)
|> validate_change(:fields, fn :fields, fields ->
if Enum.all?(fields, &valid_field?/1) do
[]
else
[fields: "invalid"]
end
end)
end
defp valid_field?(%{"name" => name, "value" => value}) do
name_limit = Pleroma.Config.get([:instance, :account_field_name_length], 255)
value_limit = Pleroma.Config.get([:instance, :account_field_value_length], 255)
2019-08-27 17:48:16 +00:00
is_binary(name) && is_binary(value) && String.length(name) <= name_limit &&
String.length(value) <= value_limit
2019-07-24 12:26:35 +00:00
end
defp valid_field?(_), do: false
defp truncate_field(%{"name" => name, "value" => value}) do
2019-09-02 11:15:40 +00:00
{name, _chopped} =
String.split_at(name, Pleroma.Config.get([:instance, :account_field_name_length], 255))
{value, _chopped} =
String.split_at(value, Pleroma.Config.get([:instance, :account_field_value_length], 255))
%{"name" => name, "value" => value}
end
2019-05-16 13:23:41 +00:00
@spec confirmation_changeset(Info.t(), keyword()) :: Changeset.t()
def confirmation_changeset(info, opts) do
need_confirmation? = Keyword.get(opts, :need_confirmation)
params =
if need_confirmation? do
%{
confirmation_pending: true,
confirmation_token: :crypto.strong_rand_bytes(32) |> Base.url_encode64()
}
else
%{
confirmation_pending: false,
confirmation_token: nil
}
end
cast(info, params, [:confirmation_pending, :confirmation_token])
end
def mastodon_settings_update(info, settings) do
params = %{settings: settings}
2018-12-06 14:42:07 +00:00
info
|> cast(params, [:settings])
|> validate_required([:settings])
2018-12-06 14:42:07 +00:00
end
def mascot_update(info, url) do
params = %{mascot: url}
info
|> cast(params, [:mascot])
|> validate_required([:mascot])
end
2018-11-20 19:12:39 +00:00
def set_source_data(info, source_data) do
params = %{source_data: source_data}
2018-11-18 21:15:03 +00:00
info
2018-11-20 19:12:39 +00:00
|> cast(params, [:source_data])
|> validate_required([:source_data])
2018-11-18 21:15:03 +00:00
end
2018-12-01 08:03:16 +00:00
def admin_api_update(info, params) do
info
|> cast(params, [
:is_moderator,
:is_admin,
:show_role
2018-12-01 08:03:16 +00:00
])
end
2019-01-07 13:45:33 +00:00
def add_pinnned_activity(info, %Pleroma.Activity{id: id}) do
if id not in info.pinned_activities do
2019-01-08 08:25:50 +00:00
max_pinned_statuses = Pleroma.Config.get([:instance, :max_pinned_statuses], 0)
2019-01-07 13:45:33 +00:00
params = %{pinned_activities: info.pinned_activities ++ [id]}
info
|> cast(params, [:pinned_activities])
|> validate_length(:pinned_activities,
2019-01-08 08:25:50 +00:00
max: max_pinned_statuses,
message: "You have already pinned the maximum number of statuses"
2019-01-07 13:45:33 +00:00
)
else
change(info)
end
end
def remove_pinnned_activity(info, %Pleroma.Activity{id: id}) do
params = %{pinned_activities: List.delete(info.pinned_activities, id)}
cast(info, params, [:pinned_activities])
end
2019-03-12 19:15:28 +00:00
def roles(%Info{is_moderator: is_moderator, is_admin: is_admin}) do
%{
admin: is_admin,
moderator: is_moderator
}
end
2019-03-15 13:28:14 +00:00
def add_reblog_mute(info, ap_id) do
params = %{muted_reblogs: info.muted_reblogs ++ [ap_id]}
cast(info, params, [:muted_reblogs])
end
def remove_reblog_mute(info, ap_id) do
params = %{muted_reblogs: List.delete(info.muted_reblogs, ap_id)}
cast(info, params, [:muted_reblogs])
end
# ``fields`` is an array of mastodon profile field, containing ``{"name": "…", "value": "…"}``.
# For example: [{"name": "Pronoun", "value": "she/her"}, …]
def fields(%{fields: nil, source_data: %{"attachment" => attachment}}) do
limit = Pleroma.Config.get([:instance, :max_remote_account_fields], 0)
2019-07-24 12:26:35 +00:00
attachment
|> Enum.filter(fn %{"type" => t} -> t == "PropertyValue" end)
|> Enum.map(fn fields -> Map.take(fields, ["name", "value"]) end)
|> Enum.take(limit)
2019-07-24 12:26:35 +00:00
end
def fields(%{fields: nil}), do: []
2019-07-24 12:26:35 +00:00
def fields(%{fields: fields}), do: fields
def follow_information_update(info, params) do
info
|> cast(params, [
:hide_followers,
:hide_follows,
:follower_count,
:following_count,
:hide_followers_count,
:hide_follows_count
])
end
end