Provide pleroma.user mix task for both activate and deactivate
[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) do
166 shell_info("Deactivating #{user.nickname}")
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 unsubscribed all local followers from #{user.nickname}")
174 end
175 else
176 _ ->
177 shell_error("No user #{nickname}")
178 end
179 end
180
181 def run(["deactivate_all_from_instance", instance]) do
182 start_pleroma()
183
184 Pleroma.User.Query.build(%{nickname: "@#{instance}"})
185 |> Pleroma.Repo.chunk_stream(500, :batches)
186 |> Stream.each(fn users ->
187 users
188 |> Enum.each(fn user ->
189 run(["deactivate", user.nickname])
190 end)
191 end)
192 |> Stream.run()
193 end
194
195 def run(["set", nickname | rest]) do
196 start_pleroma()
197
198 {options, [], []} =
199 OptionParser.parse(
200 rest,
201 strict: [
202 admin: :boolean,
203 confirmed: :boolean,
204 locked: :boolean,
205 moderator: :boolean
206 ]
207 )
208
209 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
210 user =
211 case Keyword.get(options, :admin) do
212 nil -> user
213 value -> set_admin(user, value)
214 end
215
216 user =
217 case Keyword.get(options, :confirmed) do
218 nil -> user
219 value -> set_confirmation(user, value)
220 end
221
222 user =
223 case Keyword.get(options, :locked) do
224 nil -> user
225 value -> set_locked(user, value)
226 end
227
228 _user =
229 case Keyword.get(options, :moderator) do
230 nil -> user
231 value -> set_moderator(user, value)
232 end
233 else
234 _ ->
235 shell_error("No local user #{nickname}")
236 end
237 end
238
239 def run(["tag", nickname | tags]) do
240 start_pleroma()
241
242 with %User{} = user <- User.get_cached_by_nickname(nickname) do
243 user = user |> User.tag(tags)
244
245 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
246 else
247 _ ->
248 shell_error("Could not change user tags for #{nickname}")
249 end
250 end
251
252 def run(["untag", nickname | tags]) do
253 start_pleroma()
254
255 with %User{} = user <- User.get_cached_by_nickname(nickname) do
256 user = user |> User.untag(tags)
257
258 shell_info("Tags of #{user.nickname}: #{inspect(user.tags)}")
259 else
260 _ ->
261 shell_error("Could not change user tags for #{nickname}")
262 end
263 end
264
265 def run(["invite" | rest]) do
266 {options, [], []} =
267 OptionParser.parse(rest,
268 strict: [
269 expires_at: :string,
270 max_use: :integer
271 ]
272 )
273
274 options =
275 options
276 |> Keyword.update(:expires_at, {:ok, nil}, fn
277 nil -> {:ok, nil}
278 val -> Date.from_iso8601(val)
279 end)
280 |> Enum.into(%{})
281
282 start_pleroma()
283
284 with {:ok, val} <- options[:expires_at],
285 options = Map.put(options, :expires_at, val),
286 {:ok, invite} <- UserInviteToken.create_invite(options) do
287 shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
288
289 url =
290 Pleroma.Web.Router.Helpers.redirect_url(
291 Pleroma.Web.Endpoint,
292 :registration_page,
293 invite.token
294 )
295
296 IO.puts(url)
297 else
298 error ->
299 shell_error("Could not create invite token: #{inspect(error)}")
300 end
301 end
302
303 def run(["invites"]) do
304 start_pleroma()
305
306 shell_info("Invites list:")
307
308 UserInviteToken.list_invites()
309 |> Enum.each(fn invite ->
310 expire_info =
311 with expires_at when not is_nil(expires_at) <- invite.expires_at do
312 " | Expires at: #{Date.to_string(expires_at)}"
313 end
314
315 using_info =
316 with max_use when not is_nil(max_use) <- invite.max_use do
317 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
318 end
319
320 shell_info(
321 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
322 invite.used
323 }#{expire_info}#{using_info}"
324 )
325 end)
326 end
327
328 def run(["revoke_invite", token]) do
329 start_pleroma()
330
331 with {:ok, invite} <- UserInviteToken.find_by_token(token),
332 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
333 shell_info("Invite for token #{token} was revoked.")
334 else
335 _ -> shell_error("No invite found with token #{token}")
336 end
337 end
338
339 def run(["delete_activities", nickname]) do
340 start_pleroma()
341
342 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
343 User.delete_user_activities(user)
344 shell_info("User #{nickname} statuses deleted.")
345 else
346 _ ->
347 shell_error("No local user #{nickname}")
348 end
349 end
350
351 def run(["confirm", nickname]) do
352 start_pleroma()
353
354 with %User{} = user <- User.get_cached_by_nickname(nickname) do
355 {:ok, user} = User.confirm(user)
356
357 message = if !user.is_confirmed, do: "needs", else: "doesn't need"
358
359 shell_info("#{nickname} #{message} confirmation.")
360 else
361 _ ->
362 shell_error("No local user #{nickname}")
363 end
364 end
365
366 def run(["confirm_all"]) do
367 start_pleroma()
368
369 Pleroma.User.Query.build(%{
370 local: true,
371 is_active: true,
372 is_moderator: false,
373 is_admin: false,
374 invisible: false
375 })
376 |> Pleroma.Repo.chunk_stream(500, :batches)
377 |> Stream.each(fn users ->
378 users
379 |> Enum.each(fn user -> User.set_confirmation(user, true) end)
380 end)
381 |> Stream.run()
382 end
383
384 def run(["unconfirm_all"]) do
385 start_pleroma()
386
387 Pleroma.User.Query.build(%{
388 local: true,
389 is_active: true,
390 is_moderator: false,
391 is_admin: false,
392 invisible: false
393 })
394 |> Pleroma.Repo.chunk_stream(500, :batches)
395 |> Stream.each(fn users ->
396 users
397 |> Enum.each(fn user -> User.set_confirmation(user, false) end)
398 end)
399 |> Stream.run()
400 end
401
402 def run(["sign_out", nickname]) do
403 start_pleroma()
404
405 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
406 User.global_sign_out(user)
407
408 shell_info("#{nickname} signed out from all apps.")
409 else
410 _ ->
411 shell_error("No local user #{nickname}")
412 end
413 end
414
415 def run(["list"]) do
416 start_pleroma()
417
418 Pleroma.User.Query.build(%{local: true})
419 |> Pleroma.Repo.chunk_stream(500, :batches)
420 |> Stream.each(fn users ->
421 users
422 |> Enum.each(fn user ->
423 shell_info(
424 "#{user.nickname} moderator: #{user.is_moderator}, admin: #{user.is_admin}, locked: #{
425 user.is_locked
426 }, is_active: #{user.is_active}"
427 )
428 end)
429 end)
430 |> Stream.run()
431 end
432
433 defp set_moderator(user, value) do
434 {:ok, user} =
435 user
436 |> Changeset.change(%{is_moderator: value})
437 |> User.update_and_set_cache()
438
439 shell_info("Moderator status of #{user.nickname}: #{user.is_moderator}")
440 user
441 end
442
443 defp set_admin(user, value) do
444 {:ok, user} = User.admin_api_update(user, %{is_admin: value})
445
446 shell_info("Admin status of #{user.nickname}: #{user.is_admin}")
447 user
448 end
449
450 defp set_locked(user, value) do
451 {:ok, user} =
452 user
453 |> Changeset.change(%{is_locked: value})
454 |> User.update_and_set_cache()
455
456 shell_info("Locked status of #{user.nickname}: #{user.is_locked}")
457 user
458 end
459
460 defp set_confirmation(user, value) do
461 {:ok, user} = User.set_confirmation(user, value)
462
463 shell_info("Confirmation status of #{user.nickname}: #{user.is_confirmed}")
464 user
465 end
466 end