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