Merge branch 'develop' of https://git.pleroma.social/pleroma/pleroma into develop
[akkoma] / lib / mix / tasks / pleroma / user.ex
1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
4
5 defmodule Mix.Tasks.Pleroma.User do
6 use Mix.Task
7 import Mix.Pleroma
8 alias Ecto.Changeset
9 alias Pleroma.User
10 alias Pleroma.Web.ActivityPub.ActivityPub
11 alias Pleroma.UserInviteToken
12 alias Pleroma.Web.ActivityPub.Builder
13 alias Pleroma.Web.ActivityPub.Pipeline
14
15 @shortdoc "Manages Pleroma users"
16 @moduledoc File.read!("docs/administration/CLI_tasks/user.md")
17
18 def run(["new", nickname, email | rest]) do
19 {options, [], []} =
20 OptionParser.parse(
21 rest,
22 strict: [
23 name: :string,
24 bio: :string,
25 password: :string,
26 moderator: :boolean,
27 admin: :boolean,
28 assume_yes: :boolean
29 ],
30 aliases: [
31 y: :assume_yes
32 ]
33 )
34
35 name = Keyword.get(options, :name, nickname)
36 bio = Keyword.get(options, :bio, "")
37
38 {password, generated_password?} =
39 case Keyword.get(options, :password) do
40 nil ->
41 {:crypto.strong_rand_bytes(16) |> Base.encode64(), true}
42
43 password ->
44 {password, false}
45 end
46
47 moderator? = Keyword.get(options, :moderator, false)
48 admin? = Keyword.get(options, :admin, false)
49 assume_yes? = Keyword.get(options, :assume_yes, false)
50
51 shell_info("""
52 A user will be created with the following information:
53 - nickname: #{nickname}
54 - email: #{email}
55 - password: #{if(generated_password?, do: "[generated; a reset link will be created]", else: password)}
56 - name: #{name}
57 - bio: #{bio}
58 - moderator: #{if(moderator?, do: "true", else: "false")}
59 - admin: #{if(admin?, do: "true", else: "false")}
60 """)
61
62 proceed? = assume_yes? or shell_prompt("Continue?", "n") in ~w(Yn Y y)
63
64 if proceed? do
65 start_pleroma()
66
67 params = %{
68 nickname: nickname,
69 email: email,
70 password: password,
71 password_confirmation: password,
72 name: name,
73 bio: bio
74 }
75
76 changeset = User.register_changeset(%User{}, params, is_confirmed: true)
77 {:ok, _user} = User.register(changeset)
78
79 shell_info("User #{nickname} created")
80
81 if moderator? do
82 run(["set", nickname, "--moderator"])
83 end
84
85 if admin? do
86 run(["set", nickname, "--admin"])
87 end
88
89 if generated_password? do
90 run(["reset_password", nickname])
91 end
92 else
93 shell_info("User will not be created.")
94 end
95 end
96
97 def run(["rm", nickname]) do
98 start_pleroma()
99
100 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
101 {:ok, delete_data, _} <- Builder.delete(user, user.ap_id),
102 {:ok, _delete, _} <- Pipeline.common_pipeline(delete_data, local: true) do
103 shell_info("User #{nickname} deleted.")
104 else
105 _ -> shell_error("No local user #{nickname}")
106 end
107 end
108
109 def run(["reset_password", nickname]) do
110 start_pleroma()
111
112 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
113 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
114 shell_info("Generated password reset token for #{user.nickname}")
115
116 IO.puts("URL: #{Pleroma.Web.Router.Helpers.reset_password_url(Pleroma.Web.Endpoint,
117 :reset,
118 token.token)}")
119 else
120 _ ->
121 shell_error("No local user #{nickname}")
122 end
123 end
124
125 def run(["reset_mfa", nickname]) do
126 start_pleroma()
127
128 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
129 {:ok, _token} <- Pleroma.MFA.disable(user) do
130 shell_info("Multi-Factor Authentication disabled for #{user.nickname}")
131 else
132 _ ->
133 shell_error("No local user #{nickname}")
134 end
135 end
136
137 def run(["activate", nickname]) do
138 start_pleroma()
139
140 with %User{} = user <- User.get_cached_by_nickname(nickname),
141 false <- user.is_active do
142 User.set_activation(user, true)
143 :timer.sleep(500)
144
145 shell_info("Successfully activated #{nickname}")
146 else
147 true ->
148 shell_info("User #{nickname} already activated")
149
150 _ ->
151 shell_error("No user #{nickname}")
152 end
153 end
154
155 def run(["deactivate", nickname]) do
156 start_pleroma()
157
158 with %User{} = user <- User.get_cached_by_nickname(nickname),
159 true <- user.is_active do
160 User.set_activation(user, false)
161 :timer.sleep(500)
162
163 user = User.get_cached_by_id(user.id)
164
165 if Enum.empty?(Enum.filter(User.get_friends(user), & &1.local)) do
166 shell_info("Successfully deactivated #{nickname} and unsubscribed all local followers")
167 end
168 else
169 false ->
170 shell_info("User #{nickname} already deactivated")
171
172 _ ->
173 shell_error("No user #{nickname}")
174 end
175 end
176
177 def run(["deactivate_all_from_instance", instance]) do
178 start_pleroma()
179
180 Pleroma.User.Query.build(%{nickname: "@#{instance}"})
181 |> Pleroma.Repo.chunk_stream(500, :batches)
182 |> Stream.each(fn users ->
183 users
184 |> Enum.each(fn user ->
185 run(["deactivate", user.nickname])
186 end)
187 end)
188 |> Stream.run()
189 end
190
191 def run(["set", nickname | rest]) do
192 start_pleroma()
193
194 {options, [], []} =
195 OptionParser.parse(
196 rest,
197 strict: [
198 admin: :boolean,
199 confirmed: :boolean,
200 locked: :boolean,
201 moderator: :boolean
202 ]
203 )
204
205 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
206 user =
207 case Keyword.get(options, :admin) do
208 nil -> user
209 value -> set_admin(user, value)
210 end
211
212 user =
213 case Keyword.get(options, :confirmed) do
214 nil -> user
215 value -> set_confirmation(user, value)
216 end
217
218 user =
219 case Keyword.get(options, :locked) do
220 nil -> user
221 value -> set_locked(user, value)
222 end
223
224 _user =
225 case Keyword.get(options, :moderator) do
226 nil -> user
227 value -> set_moderator(user, value)
228 end
229 else
230 _ ->
231 shell_error("No local user #{nickname}")
232 end
233 end
234
235 def run(["tag", nickname | tags]) do
236 start_pleroma()
237
238 with %User{} = user <- User.get_cached_by_nickname(nickname) do
239 user = user |> User.tag(tags)
240
241 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
242 else
243 _ ->
244 shell_error("Could not change user tags for #{nickname}")
245 end
246 end
247
248 def run(["untag", nickname | tags]) do
249 start_pleroma()
250
251 with %User{} = user <- User.get_cached_by_nickname(nickname) do
252 user = user |> User.untag(tags)
253
254 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
255 else
256 _ ->
257 shell_error("Could not change user tags for #{nickname}")
258 end
259 end
260
261 def run(["invite" | rest]) do
262 {options, [], []} =
263 OptionParser.parse(rest,
264 strict: [
265 expires_at: :string,
266 max_use: :integer
267 ]
268 )
269
270 options =
271 options
272 |> Keyword.update(:expires_at, {:ok, nil}, fn
273 nil -> {:ok, nil}
274 val -> Date.from_iso8601(val)
275 end)
276 |> Enum.into(%{})
277
278 start_pleroma()
279
280 with {:ok, val} <- options[:expires_at],
281 options = Map.put(options, :expires_at, val),
282 {:ok, invite} <- UserInviteToken.create_invite(options) do
283 shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
284
285 url =
286 Pleroma.Web.Router.Helpers.redirect_url(
287 Pleroma.Web.Endpoint,
288 :registration_page,
289 invite.token
290 )
291
292 IO.puts(url)
293 else
294 error ->
295 shell_error("Could not create invite token: #{inspect(error)}")
296 end
297 end
298
299 def run(["invites"]) do
300 start_pleroma()
301
302 shell_info("Invites list:")
303
304 UserInviteToken.list_invites()
305 |> Enum.each(fn invite ->
306 expire_info =
307 with expires_at when not is_nil(expires_at) <- invite.expires_at do
308 " | Expires at: #{Date.to_string(expires_at)}"
309 end
310
311 using_info =
312 with max_use when not is_nil(max_use) <- invite.max_use do
313 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
314 end
315
316 shell_info(
317 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{invite.used}#{expire_info}#{using_info}"
318 )
319 end)
320 end
321
322 def run(["revoke_invite", token]) do
323 start_pleroma()
324
325 with {:ok, invite} <- UserInviteToken.find_by_token(token),
326 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
327 shell_info("Invite for token #{token} was revoked.")
328 else
329 _ -> shell_error("No invite found with token #{token}")
330 end
331 end
332
333 def run(["delete_activities", nickname]) do
334 start_pleroma()
335
336 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
337 User.delete_user_activities(user)
338 shell_info("User #{nickname} statuses deleted.")
339 else
340 _ ->
341 shell_error("No local user #{nickname}")
342 end
343 end
344
345 def run(["change_email", nickname, email]) do
346 start_pleroma()
347
348 with %User{} = user <- User.get_cached_by_nickname(nickname) do
349 user
350 |> User.update_changeset(%{"email" => email})
351 |> User.update_and_set_cache()
352
353 shell_info("#{nickname}'s email updated")
354 end
355 end
356
357 def run(["show", nickname]) do
358 start_pleroma()
359
360 nickname
361 |> User.get_cached_by_nickname()
362 |> IO.inspect()
363 end
364
365 def run(["send_confirmation", nickname]) do
366 start_pleroma()
367
368 with %User{} = user <- User.get_cached_by_nickname(nickname) do
369 user
370 |> Pleroma.Emails.UserEmail.account_confirmation_email()
371 |> IO.inspect()
372 |> Pleroma.Emails.Mailer.deliver!()
373
374 shell_info("#{nickname}'s email sent")
375 end
376 end
377
378 def run(["confirm", nickname]) do
379 start_pleroma()
380
381 with %User{} = user <- User.get_cached_by_nickname(nickname) do
382 {:ok, user} = User.confirm(user)
383
384 message = if !user.is_confirmed, do: "needs", else: "doesn't need"
385
386 shell_info("#{nickname} #{message} confirmation.")
387 else
388 _ ->
389 shell_error("No local user #{nickname}")
390 end
391 end
392
393 def run(["confirm_all"]) do
394 start_pleroma()
395
396 Pleroma.User.Query.build(%{
397 local: true,
398 is_active: true,
399 is_moderator: false,
400 is_admin: false,
401 invisible: false
402 })
403 |> Pleroma.Repo.chunk_stream(500, :batches)
404 |> Stream.each(fn users ->
405 users
406 |> Enum.each(fn user -> User.set_confirmation(user, true) end)
407 end)
408 |> Stream.run()
409 end
410
411 def run(["unconfirm_all"]) do
412 start_pleroma()
413
414 Pleroma.User.Query.build(%{
415 local: true,
416 is_active: true,
417 is_moderator: false,
418 is_admin: false,
419 invisible: false
420 })
421 |> Pleroma.Repo.chunk_stream(500, :batches)
422 |> Stream.each(fn users ->
423 users
424 |> Enum.each(fn user -> User.set_confirmation(user, false) end)
425 end)
426 |> Stream.run()
427 end
428
429 def run(["sign_out", nickname]) do
430 start_pleroma()
431
432 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
433 User.global_sign_out(user)
434
435 shell_info("#{nickname} signed out from all apps.")
436 else
437 _ ->
438 shell_error("No local user #{nickname}")
439 end
440 end
441
442 def run(["blocking", nickname]) do
443 start_pleroma()
444 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
445 blocks = User.following_ap_ids(user)
446 IO.inspect(blocks, limit: :infinity)
447 end
448 end
449
450 def run(["timeline_query", nickname]) do
451 start_pleroma()
452 params = %{ local: true }
453 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
454 params =
455 params
456 |> Map.put(:type, ["Create", "Announce"])
457 |> Map.put(:limit, 20)
458 |> Map.put(:blocking_user, user)
459 |> Map.put(:muting_user, user)
460 |> Map.put(:reply_filtering_user, user)
461 |> Map.put(:announce_filtering_user, user)
462 |> Map.put(:user, user)
463 |> Map.put(:local_only, params[:local])
464 |> Map.delete(:local)
465 _activities =
466 [user.ap_id | User.following(user)]
467 |> ActivityPub.fetch_activities(params)
468 end
469 end
470
471 def run(["list"]) do
472 start_pleroma()
473
474 Pleroma.User.Query.build(%{local: true})
475 |> Pleroma.Repo.chunk_stream(500, :batches)
476 |> Stream.each(fn users ->
477 users
478 |> Enum.each(fn user ->
479 shell_info(
480 "#{user.nickname} moderator: #{user.is_moderator}, admin: #{user.is_admin}, locked: #{user.is_locked}, is_active: #{user.is_active}"
481 )
482 end)
483 end)
484 |> Stream.run()
485 end
486
487 defp set_moderator(user, value) do
488 {:ok, user} =
489 user
490 |> Changeset.change(%{is_moderator: value})
491 |> User.update_and_set_cache()
492
493 shell_info("Moderator status of #{user.nickname}: #{user.is_moderator}")
494 user
495 end
496
497 defp set_admin(user, value) do
498 {:ok, user} = User.admin_api_update(user, %{is_admin: value})
499
500 shell_info("Admin status of #{user.nickname}: #{user.is_admin}")
501 user
502 end
503
504 defp set_locked(user, value) do
505 {:ok, user} =
506 user
507 |> Changeset.change(%{is_locked: value})
508 |> User.update_and_set_cache()
509
510 shell_info("Locked status of #{user.nickname}: #{user.is_locked}")
511 user
512 end
513
514 defp set_confirmation(user, value) do
515 {:ok, user} = User.set_confirmation(user, value)
516
517 shell_info("Confirmation status of #{user.nickname}: #{user.is_confirmed}")
518 user
519 end
520 end