Move comments for email_notifications config to docs
[akkoma] / lib / pleroma / user / info.ex
1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
4
5 defmodule Pleroma.User.Info do
6 use Ecto.Schema
7 import Ecto.Changeset
8
9 alias Pleroma.User.Info
10
11 @type t :: %__MODULE__{}
12
13 embedded_schema do
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 field(:locked, :boolean, default: false)
20 field(:confirmation_pending, :boolean, default: false)
21 field(:confirmation_token, :string, default: nil)
22 field(:default_scope, :string, default: "public")
23 field(:blocks, {:array, :string}, default: [])
24 field(:domain_blocks, {:array, :string}, default: [])
25 field(:mutes, {:array, :string}, default: [])
26 field(:muted_reblogs, {:array, :string}, default: [])
27 field(:subscribers, {:array, :string}, default: [])
28 field(:deactivated, :boolean, default: false)
29 field(:no_rich_text, :boolean, default: false)
30 field(:ap_enabled, :boolean, default: false)
31 field(:is_moderator, :boolean, default: false)
32 field(:is_admin, :boolean, default: false)
33 field(:show_role, :boolean, default: true)
34 field(:keys, :string, default: nil)
35 field(:settings, :map, default: nil)
36 field(:magic_key, :string, default: nil)
37 field(:uri, :string, default: nil)
38 field(:topic, :string, default: nil)
39 field(:hub, :string, default: nil)
40 field(:salmon, :string, default: nil)
41 field(:hide_followers, :boolean, default: false)
42 field(:hide_follows, :boolean, default: false)
43 field(:pinned_activities, {:array, :string}, default: [])
44 field(:flavour, :string, default: nil)
45 field(:email_notifications, :map, default: %{"digest" => false})
46
47 field(:notification_settings, :map,
48 default: %{"remote" => true, "local" => true, "followers" => true, "follows" => true}
49 )
50
51 # Found in the wild
52 # ap_id -> Where is this used?
53 # bio -> Where is this used?
54 # avatar -> Where is this used?
55 # fqn -> Where is this used?
56 # host -> Where is this used?
57 # subject _> Where is this used?
58 end
59
60 def set_activation_status(info, deactivated) do
61 params = %{deactivated: deactivated}
62
63 info
64 |> cast(params, [:deactivated])
65 |> validate_required([:deactivated])
66 end
67
68 def update_notification_settings(info, settings) do
69 notification_settings =
70 info.notification_settings
71 |> Map.merge(settings)
72 |> Map.take(["remote", "local", "followers", "follows"])
73
74 params = %{notification_settings: notification_settings}
75
76 info
77 |> cast(params, [:notification_settings])
78 |> validate_required([:notification_settings])
79 end
80
81 @doc """
82 Update email notifications in the given User.Info struct.
83
84 Examples:
85
86 iex> update_email_notifications(%Pleroma.User.Info{email_notifications: %{"digest" => false}}, %{"digest" => true})
87 %Pleroma.User.Info{email_notifications: %{"digest" => true}}
88
89 """
90 @spec update_email_notifications(t(), map()) :: Ecto.Changeset.t()
91 def update_email_notifications(info, settings) do
92 email_notifications =
93 info.email_notifications
94 |> Map.merge(settings)
95 |> Map.take(["digest"])
96
97 params = %{email_notifications: email_notifications}
98 fields = [:email_notifications]
99
100 info
101 |> cast(params, fields)
102 |> validate_required(fields)
103 end
104
105 def add_to_note_count(info, number) do
106 set_note_count(info, info.note_count + number)
107 end
108
109 def set_note_count(info, number) do
110 params = %{note_count: Enum.max([0, number])}
111
112 info
113 |> cast(params, [:note_count])
114 |> validate_required([:note_count])
115 end
116
117 def set_follower_count(info, number) do
118 params = %{follower_count: Enum.max([0, number])}
119
120 info
121 |> cast(params, [:follower_count])
122 |> validate_required([:follower_count])
123 end
124
125 def set_mutes(info, mutes) do
126 params = %{mutes: mutes}
127
128 info
129 |> cast(params, [:mutes])
130 |> validate_required([:mutes])
131 end
132
133 def set_blocks(info, blocks) do
134 params = %{blocks: blocks}
135
136 info
137 |> cast(params, [:blocks])
138 |> validate_required([:blocks])
139 end
140
141 def set_subscribers(info, subscribers) do
142 params = %{subscribers: subscribers}
143
144 info
145 |> cast(params, [:subscribers])
146 |> validate_required([:subscribers])
147 end
148
149 def add_to_mutes(info, muted) do
150 set_mutes(info, Enum.uniq([muted | info.mutes]))
151 end
152
153 def remove_from_mutes(info, muted) do
154 set_mutes(info, List.delete(info.mutes, muted))
155 end
156
157 def add_to_block(info, blocked) do
158 set_blocks(info, Enum.uniq([blocked | info.blocks]))
159 end
160
161 def remove_from_block(info, blocked) do
162 set_blocks(info, List.delete(info.blocks, blocked))
163 end
164
165 def add_to_subscribers(info, subscribed) do
166 set_subscribers(info, Enum.uniq([subscribed | info.subscribers]))
167 end
168
169 def remove_from_subscribers(info, subscribed) do
170 set_subscribers(info, List.delete(info.subscribers, subscribed))
171 end
172
173 def set_domain_blocks(info, domain_blocks) do
174 params = %{domain_blocks: domain_blocks}
175
176 info
177 |> cast(params, [:domain_blocks])
178 |> validate_required([:domain_blocks])
179 end
180
181 def add_to_domain_block(info, domain_blocked) do
182 set_domain_blocks(info, Enum.uniq([domain_blocked | info.domain_blocks]))
183 end
184
185 def remove_from_domain_block(info, domain_blocked) do
186 set_domain_blocks(info, List.delete(info.domain_blocks, domain_blocked))
187 end
188
189 def set_keys(info, keys) do
190 params = %{keys: keys}
191
192 info
193 |> cast(params, [:keys])
194 |> validate_required([:keys])
195 end
196
197 def remote_user_creation(info, params) do
198 info
199 |> cast(params, [
200 :ap_enabled,
201 :source_data,
202 :banner,
203 :locked,
204 :magic_key,
205 :uri,
206 :hub,
207 :topic,
208 :salmon
209 ])
210 end
211
212 def user_upgrade(info, params) do
213 info
214 |> cast(params, [
215 :ap_enabled,
216 :source_data,
217 :banner,
218 :locked,
219 :magic_key
220 ])
221 end
222
223 def profile_update(info, params) do
224 info
225 |> cast(params, [
226 :locked,
227 :no_rich_text,
228 :default_scope,
229 :banner,
230 :hide_follows,
231 :hide_followers,
232 :background,
233 :show_role
234 ])
235 end
236
237 def confirmation_changeset(info, :confirmed) do
238 confirmation_changeset(info, %{
239 confirmation_pending: false,
240 confirmation_token: nil
241 })
242 end
243
244 def confirmation_changeset(info, :unconfirmed) do
245 confirmation_changeset(info, %{
246 confirmation_pending: true,
247 confirmation_token: :crypto.strong_rand_bytes(32) |> Base.url_encode64()
248 })
249 end
250
251 def confirmation_changeset(info, params) do
252 cast(info, params, [:confirmation_pending, :confirmation_token])
253 end
254
255 def mastodon_profile_update(info, params) do
256 info
257 |> cast(params, [
258 :locked,
259 :banner
260 ])
261 end
262
263 def mastodon_settings_update(info, settings) do
264 params = %{settings: settings}
265
266 info
267 |> cast(params, [:settings])
268 |> validate_required([:settings])
269 end
270
271 def mastodon_flavour_update(info, flavour) do
272 params = %{flavour: flavour}
273
274 info
275 |> cast(params, [:flavour])
276 |> validate_required([:flavour])
277 end
278
279 def set_source_data(info, source_data) do
280 params = %{source_data: source_data}
281
282 info
283 |> cast(params, [:source_data])
284 |> validate_required([:source_data])
285 end
286
287 def admin_api_update(info, params) do
288 info
289 |> cast(params, [
290 :is_moderator,
291 :is_admin,
292 :show_role
293 ])
294 end
295
296 def add_pinnned_activity(info, %Pleroma.Activity{id: id}) do
297 if id not in info.pinned_activities do
298 max_pinned_statuses = Pleroma.Config.get([:instance, :max_pinned_statuses], 0)
299 params = %{pinned_activities: info.pinned_activities ++ [id]}
300
301 info
302 |> cast(params, [:pinned_activities])
303 |> validate_length(:pinned_activities,
304 max: max_pinned_statuses,
305 message: "You have already pinned the maximum number of statuses"
306 )
307 else
308 change(info)
309 end
310 end
311
312 def remove_pinnned_activity(info, %Pleroma.Activity{id: id}) do
313 params = %{pinned_activities: List.delete(info.pinned_activities, id)}
314
315 cast(info, params, [:pinned_activities])
316 end
317
318 def roles(%Info{is_moderator: is_moderator, is_admin: is_admin}) do
319 %{
320 admin: is_admin,
321 moderator: is_moderator
322 }
323 end
324
325 def add_reblog_mute(info, ap_id) do
326 params = %{muted_reblogs: info.muted_reblogs ++ [ap_id]}
327
328 cast(info, params, [:muted_reblogs])
329 end
330
331 def remove_reblog_mute(info, ap_id) do
332 params = %{muted_reblogs: List.delete(info.muted_reblogs, ap_id)}
333
334 cast(info, params, [:muted_reblogs])
335 end
336 end