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