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