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-2020 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_yes?("Continue?")
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, need_confirmation: false)
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(["toggle_activated", nickname]) do
111 start_pleroma()
112
113 with %User{} = user <- User.get_cached_by_nickname(nickname) do
114 {:ok, user} = User.deactivate(user, !user.deactivated)
115
116 shell_info(
117 "Activation status of #{nickname}: #{if(user.deactivated, do: "de", else: "")}activated"
118 )
119 else
120 _ ->
121 shell_error("No user #{nickname}")
122 end
123 end
124
125 def run(["reset_password", nickname]) do
126 start_pleroma()
127
128 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
129 {:ok, token} <- Pleroma.PasswordResetToken.create_token(user) do
130 shell_info("Generated password reset token for #{user.nickname}")
131
132 IO.puts(
133 "URL: #{
134 Pleroma.Web.Router.Helpers.reset_password_url(
135 Pleroma.Web.Endpoint,
136 :reset,
137 token.token
138 )
139 }"
140 )
141 else
142 _ ->
143 shell_error("No local user #{nickname}")
144 end
145 end
146
147 def run(["reset_mfa", nickname]) do
148 start_pleroma()
149
150 with %User{local: true} = user <- User.get_cached_by_nickname(nickname),
151 {:ok, _token} <- Pleroma.MFA.disable(user) do
152 shell_info("Multi-Factor Authentication disabled for #{user.nickname}")
153 else
154 _ ->
155 shell_error("No local user #{nickname}")
156 end
157 end
158
159 def run(["deactivate", nickname]) do
160 start_pleroma()
161
162 with %User{} = user <- User.get_cached_by_nickname(nickname) do
163 shell_info("Deactivating #{user.nickname}")
164 User.deactivate(user)
165 :timer.sleep(500)
166
167 user = User.get_cached_by_id(user.id)
168
169 if Enum.empty?(Enum.filter(User.get_friends(user), & &1.local)) do
170 shell_info("Successfully unsubscribed all local followers from #{user.nickname}")
171 end
172 else
173 _ ->
174 shell_error("No user #{nickname}")
175 end
176 end
177
178 def run(["deactivate_all_from_instance", instance]) do
179 start_pleroma()
180
181 Pleroma.User.Query.build(%{nickname: "@#{instance}"})
182 |> Pleroma.RepoStreamer.chunk_stream(500)
183 |> Stream.each(fn users ->
184 users
185 |> Enum.each(fn user ->
186 run(["deactivate", user.nickname])
187 end)
188 end)
189 |> Stream.run()
190 end
191
192 def run(["set", nickname | rest]) do
193 start_pleroma()
194
195 {options, [], []} =
196 OptionParser.parse(
197 rest,
198 strict: [
199 moderator: :boolean,
200 admin: :boolean,
201 locked: :boolean
202 ]
203 )
204
205 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
206 user =
207 case Keyword.get(options, :moderator) do
208 nil -> user
209 value -> set_moderator(user, value)
210 end
211
212 user =
213 case Keyword.get(options, :locked) do
214 nil -> user
215 value -> set_locked(user, value)
216 end
217
218 _user =
219 case Keyword.get(options, :admin) do
220 nil -> user
221 value -> set_admin(user, value)
222 end
223 else
224 _ ->
225 shell_error("No local user #{nickname}")
226 end
227 end
228
229 def run(["tag", nickname | tags]) do
230 start_pleroma()
231
232 with %User{} = user <- User.get_cached_by_nickname(nickname) do
233 user = user |> User.tag(tags)
234
235 shell_info("Tags of #{user.nickname}: #{inspect(tags)}")
236 else
237 _ ->
238 shell_error("Could not change user tags for #{nickname}")
239 end
240 end
241
242 def run(["untag", nickname | tags]) do
243 start_pleroma()
244
245 with %User{} = user <- User.get_cached_by_nickname(nickname) do
246 user = user |> User.untag(tags)
247
248 shell_info("Tags of #{user.nickname}: #{inspect(tags)}")
249 else
250 _ ->
251 shell_error("Could not change user tags for #{nickname}")
252 end
253 end
254
255 def run(["invite" | rest]) do
256 {options, [], []} =
257 OptionParser.parse(rest,
258 strict: [
259 expires_at: :string,
260 max_use: :integer
261 ]
262 )
263
264 options =
265 options
266 |> Keyword.update(:expires_at, {:ok, nil}, fn
267 nil -> {:ok, nil}
268 val -> Date.from_iso8601(val)
269 end)
270 |> Enum.into(%{})
271
272 start_pleroma()
273
274 with {:ok, val} <- options[:expires_at],
275 options = Map.put(options, :expires_at, val),
276 {:ok, invite} <- UserInviteToken.create_invite(options) do
277 shell_info("Generated user invite token " <> String.replace(invite.invite_type, "_", " "))
278
279 url =
280 Pleroma.Web.Router.Helpers.redirect_url(
281 Pleroma.Web.Endpoint,
282 :registration_page,
283 invite.token
284 )
285
286 IO.puts(url)
287 else
288 error ->
289 shell_error("Could not create invite token: #{inspect(error)}")
290 end
291 end
292
293 def run(["invites"]) do
294 start_pleroma()
295
296 shell_info("Invites list:")
297
298 UserInviteToken.list_invites()
299 |> Enum.each(fn invite ->
300 expire_info =
301 with expires_at when not is_nil(expires_at) <- invite.expires_at do
302 " | Expires at: #{Date.to_string(expires_at)}"
303 end
304
305 using_info =
306 with max_use when not is_nil(max_use) <- invite.max_use do
307 " | Max use: #{max_use} Left use: #{max_use - invite.uses}"
308 end
309
310 shell_info(
311 "ID: #{invite.id} | Token: #{invite.token} | Token type: #{invite.invite_type} | Used: #{
312 invite.used
313 }#{expire_info}#{using_info}"
314 )
315 end)
316 end
317
318 def run(["revoke_invite", token]) do
319 start_pleroma()
320
321 with {:ok, invite} <- UserInviteToken.find_by_token(token),
322 {:ok, _} <- UserInviteToken.update_invite(invite, %{used: true}) do
323 shell_info("Invite for token #{token} was revoked.")
324 else
325 _ -> shell_error("No invite found with token #{token}")
326 end
327 end
328
329 def run(["delete_activities", nickname]) do
330 start_pleroma()
331
332 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
333 User.delete_user_activities(user)
334 shell_info("User #{nickname} statuses deleted.")
335 else
336 _ ->
337 shell_error("No local user #{nickname}")
338 end
339 end
340
341 def run(["change_email", nickname, email]) do
342 start_pleroma()
343
344 with %User{} = user <- User.get_cached_by_nickname(nickname) do
345 user
346 |> User.update_changeset(%{"email" => email})
347 |> User.update_and_set_cache()
348
349 shell_info("#{nickname}'s email updated")
350 end
351 end
352
353 def run(["show", nickname]) do
354 start_pleroma()
355
356 nickname
357 |> User.get_cached_by_nickname()
358 |> IO.inspect()
359 end
360
361 def run(["send_confirmation", nickname]) do
362 start_pleroma()
363
364 with %User{} = user <- User.get_cached_by_nickname(nickname) do
365 user
366 |> Pleroma.Emails.UserEmail.account_confirmation_email()
367 |> IO.inspect()
368 |> Pleroma.Emails.Mailer.deliver!()
369
370 shell_info("#{nickname}'s email sent")
371 end
372 end
373
374 def run(["toggle_confirmed", nickname]) do
375 start_pleroma()
376
377 with %User{} = user <- User.get_cached_by_nickname(nickname) do
378 {:ok, user} = User.toggle_confirmation(user)
379
380 message = if user.confirmation_pending, do: "needs", else: "doesn't need"
381
382 shell_info("#{nickname} #{message} confirmation.")
383 else
384 _ ->
385 shell_error("No local user #{nickname}")
386 end
387 end
388
389 def run(["sign_out", nickname]) do
390 start_pleroma()
391
392 with %User{local: true} = user <- User.get_cached_by_nickname(nickname) do
393 User.global_sign_out(user)
394
395 shell_info("#{nickname} signed out from all apps.")
396 else
397 _ ->
398 shell_error("No local user #{nickname}")
399 end
400 end
401
402 def run(["list"]) do
403 start_pleroma()
404
405 Pleroma.User.Query.build(%{local: true})
406 |> Pleroma.RepoStreamer.chunk_stream(500)
407 |> Stream.each(fn users ->
408 users
409 |> Enum.each(fn user ->
410 shell_info(
411 "#{user.nickname} moderator: #{user.is_moderator}, admin: #{user.is_admin}, locked: #{
412 user.locked
413 }, deactivated: #{user.deactivated}"
414 )
415 end)
416 end)
417 |> Stream.run()
418 end
419
420 defp set_moderator(user, value) do
421 {:ok, user} =
422 user
423 |> Changeset.change(%{is_moderator: value})
424 |> User.update_and_set_cache()
425
426 shell_info("Moderator status of #{user.nickname}: #{user.is_moderator}")
427 user
428 end
429
430 defp set_admin(user, value) do
431 {:ok, user} = User.admin_api_update(user, %{is_admin: value})
432
433 shell_info("Admin status of #{user.nickname}: #{user.is_admin}")
434 user
435 end
436
437 defp set_locked(user, value) do
438 {:ok, user} =
439 user
440 |> Changeset.change(%{locked: value})
441 |> User.update_and_set_cache()
442
443 shell_info("Locked status of #{user.nickname}: #{user.locked}")
444 user
445 end
446 end