1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.User.Info do
9 alias Pleroma.User.Info
11 @type t :: %__MODULE__{}
14 field(:banner, :map, default: %{})
15 field(:background, :map, default: %{})
16 field(:source_data, :map, default: %{})
17 field(:note_count, :integer, default: 0)
18 field(:follower_count, :integer, default: 0)
19 # Should be filled in only for remote users
20 field(:following_count, :integer, default: nil)
21 field(:locked, :boolean, default: false)
22 field(:confirmation_pending, :boolean, default: false)
23 field(:confirmation_token, :string, default: nil)
24 field(:default_scope, :string, default: "public")
25 field(:blocks, {:array, :string}, default: [])
26 field(:domain_blocks, {:array, :string}, default: [])
27 field(:mutes, {:array, :string}, default: [])
28 field(:muted_reblogs, {:array, :string}, default: [])
29 field(:muted_notifications, {:array, :string}, default: [])
30 field(:subscribers, {:array, :string}, default: [])
31 field(:deactivated, :boolean, default: false)
32 field(:no_rich_text, :boolean, default: false)
33 field(:ap_enabled, :boolean, default: false)
34 field(:is_moderator, :boolean, default: false)
35 field(:is_admin, :boolean, default: false)
36 field(:show_role, :boolean, default: true)
37 field(:keys, :string, default: nil)
38 field(:settings, :map, default: nil)
39 field(:magic_key, :string, default: nil)
40 field(:uri, :string, default: nil)
41 field(:topic, :string, default: nil)
42 field(:hub, :string, default: nil)
43 field(:salmon, :string, default: nil)
44 field(:hide_followers, :boolean, default: false)
45 field(:hide_follows, :boolean, default: false)
46 field(:hide_favorites, :boolean, default: true)
47 field(:pinned_activities, {:array, :string}, default: [])
48 field(:email_notifications, :map, default: %{"digest" => false})
49 field(:mascot, :map, default: nil)
50 field(:emoji, {:array, :map}, default: [])
51 field(:pleroma_settings_store, :map, default: %{})
53 field(:notification_settings, :map,
57 "non_follows" => true,
58 "non_followers" => true
62 field(:skip_thread_containment, :boolean, default: false)
65 # ap_id -> Where is this used?
66 # bio -> Where is this used?
67 # avatar -> Where is this used?
68 # fqn -> Where is this used?
69 # host -> Where is this used?
70 # subject _> Where is this used?
73 def set_activation_status(info, deactivated) do
74 params = %{deactivated: deactivated}
77 |> cast(params, [:deactivated])
78 |> validate_required([:deactivated])
81 def update_notification_settings(info, settings) do
84 |> Enum.map(fn {k, v} -> {k, v in [true, "true", "True", "1"]} end)
87 notification_settings =
88 info.notification_settings
89 |> Map.merge(settings)
90 |> Map.take(["followers", "follows", "non_follows", "non_followers"])
92 params = %{notification_settings: notification_settings}
95 |> cast(params, [:notification_settings])
96 |> validate_required([:notification_settings])
100 Update email notifications in the given User.Info struct.
104 iex> update_email_notifications(%Pleroma.User.Info{email_notifications: %{"digest" => false}}, %{"digest" => true})
105 %Pleroma.User.Info{email_notifications: %{"digest" => true}}
108 @spec update_email_notifications(t(), map()) :: Ecto.Changeset.t()
109 def update_email_notifications(info, settings) do
110 email_notifications =
111 info.email_notifications
112 |> Map.merge(settings)
113 |> Map.take(["digest"])
115 params = %{email_notifications: email_notifications}
116 fields = [:email_notifications]
119 |> cast(params, fields)
120 |> validate_required(fields)
123 def add_to_note_count(info, number) do
124 set_note_count(info, info.note_count + number)
127 def set_note_count(info, number) do
128 params = %{note_count: Enum.max([0, number])}
131 |> cast(params, [:note_count])
132 |> validate_required([:note_count])
135 def set_follower_count(info, number) do
136 params = %{follower_count: Enum.max([0, number])}
139 |> cast(params, [:follower_count])
140 |> validate_required([:follower_count])
143 def set_mutes(info, mutes) do
144 params = %{mutes: mutes}
147 |> cast(params, [:mutes])
148 |> validate_required([:mutes])
151 @spec set_notification_mutes(Changeset.t(), [String.t()], boolean()) :: Changeset.t()
152 def set_notification_mutes(changeset, muted_notifications, notifications?) do
154 put_change(changeset, :muted_notifications, muted_notifications)
155 |> validate_required([:muted_notifications])
161 def set_blocks(info, blocks) do
162 params = %{blocks: blocks}
165 |> cast(params, [:blocks])
166 |> validate_required([:blocks])
169 def set_subscribers(info, subscribers) do
170 params = %{subscribers: subscribers}
173 |> cast(params, [:subscribers])
174 |> validate_required([:subscribers])
177 @spec add_to_mutes(Info.t(), String.t()) :: Changeset.t()
178 def add_to_mutes(info, muted) do
179 set_mutes(info, Enum.uniq([muted | info.mutes]))
182 @spec add_to_muted_notifications(Changeset.t(), Info.t(), String.t(), boolean()) ::
184 def add_to_muted_notifications(changeset, info, muted, notifications?) do
185 set_notification_mutes(
187 Enum.uniq([muted | info.muted_notifications]),
192 @spec remove_from_mutes(Info.t(), String.t()) :: Changeset.t()
193 def remove_from_mutes(info, muted) do
194 set_mutes(info, List.delete(info.mutes, muted))
197 @spec remove_from_muted_notifications(Changeset.t(), Info.t(), String.t()) :: Changeset.t()
198 def remove_from_muted_notifications(changeset, info, muted) do
199 set_notification_mutes(changeset, List.delete(info.muted_notifications, muted), true)
202 def add_to_block(info, blocked) do
203 set_blocks(info, Enum.uniq([blocked | info.blocks]))
206 def remove_from_block(info, blocked) do
207 set_blocks(info, List.delete(info.blocks, blocked))
210 def add_to_subscribers(info, subscribed) do
211 set_subscribers(info, Enum.uniq([subscribed | info.subscribers]))
214 def remove_from_subscribers(info, subscribed) do
215 set_subscribers(info, List.delete(info.subscribers, subscribed))
218 def set_domain_blocks(info, domain_blocks) do
219 params = %{domain_blocks: domain_blocks}
222 |> cast(params, [:domain_blocks])
223 |> validate_required([:domain_blocks])
226 def add_to_domain_block(info, domain_blocked) do
227 set_domain_blocks(info, Enum.uniq([domain_blocked | info.domain_blocks]))
230 def remove_from_domain_block(info, domain_blocked) do
231 set_domain_blocks(info, List.delete(info.domain_blocks, domain_blocked))
234 def set_keys(info, keys) do
235 params = %{keys: keys}
238 |> cast(params, [:keys])
239 |> validate_required([:keys])
242 def remote_user_creation(info, params) do
261 def user_upgrade(info, params) do
276 def profile_update(info, params) do
288 :skip_thread_containment,
289 :pleroma_settings_store
293 @spec confirmation_changeset(Info.t(), keyword()) :: Changeset.t()
294 def confirmation_changeset(info, opts) do
295 need_confirmation? = Keyword.get(opts, :need_confirmation)
298 if need_confirmation? do
300 confirmation_pending: true,
301 confirmation_token: :crypto.strong_rand_bytes(32) |> Base.url_encode64()
305 confirmation_pending: false,
306 confirmation_token: nil
310 cast(info, params, [:confirmation_pending, :confirmation_token])
313 def mastodon_settings_update(info, settings) do
314 params = %{settings: settings}
317 |> cast(params, [:settings])
318 |> validate_required([:settings])
321 def mascot_update(info, url) do
322 params = %{mascot: url}
325 |> cast(params, [:mascot])
326 |> validate_required([:mascot])
329 def set_source_data(info, source_data) do
330 params = %{source_data: source_data}
333 |> cast(params, [:source_data])
334 |> validate_required([:source_data])
337 def admin_api_update(info, params) do
346 def add_pinnned_activity(info, %Pleroma.Activity{id: id}) do
347 if id not in info.pinned_activities do
348 max_pinned_statuses = Pleroma.Config.get([:instance, :max_pinned_statuses], 0)
349 params = %{pinned_activities: info.pinned_activities ++ [id]}
352 |> cast(params, [:pinned_activities])
353 |> validate_length(:pinned_activities,
354 max: max_pinned_statuses,
355 message: "You have already pinned the maximum number of statuses"
362 def remove_pinnned_activity(info, %Pleroma.Activity{id: id}) do
363 params = %{pinned_activities: List.delete(info.pinned_activities, id)}
365 cast(info, params, [:pinned_activities])
368 def roles(%Info{is_moderator: is_moderator, is_admin: is_admin}) do
371 moderator: is_moderator
375 def add_reblog_mute(info, ap_id) do
376 params = %{muted_reblogs: info.muted_reblogs ++ [ap_id]}
378 cast(info, params, [:muted_reblogs])
381 def remove_reblog_mute(info, ap_id) do
382 params = %{muted_reblogs: List.delete(info.muted_reblogs, ap_id)}
384 cast(info, params, [:muted_reblogs])
387 def follow_information_update(info, params) do