Merge branch 'autofollow' into 'develop'
[akkoma] / lib / pleroma / user.ex
1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
4
5 defmodule Pleroma.User do
6 use Ecto.Schema
7
8 import Ecto.{Changeset, Query}
9 alias Pleroma.{Repo, User, Object, Web, Activity, Notification}
10 alias Comeonin.Pbkdf2
11 alias Pleroma.Formatter
12 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
13 alias Pleroma.Web.{OStatus, Websub, OAuth}
14 alias Pleroma.Web.ActivityPub.{Utils, ActivityPub}
15
16 require Logger
17
18 @type t :: %__MODULE__{}
19
20 @email_regex ~r/^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/
21
22 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
23 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
24
25 schema "users" do
26 field(:bio, :string)
27 field(:email, :string)
28 field(:name, :string)
29 field(:nickname, :string)
30 field(:password_hash, :string)
31 field(:password, :string, virtual: true)
32 field(:password_confirmation, :string, virtual: true)
33 field(:following, {:array, :string}, default: [])
34 field(:ap_id, :string)
35 field(:avatar, :map)
36 field(:local, :boolean, default: true)
37 field(:follower_address, :string)
38 field(:search_distance, :float, virtual: true)
39 field(:tags, {:array, :string}, default: [])
40 field(:last_refreshed_at, :naive_datetime)
41 has_many(:notifications, Notification)
42 embeds_one(:info, Pleroma.User.Info)
43
44 timestamps()
45 end
46
47 def auth_active?(%User{} = user) do
48 (user.info && !user.info.confirmation_pending) ||
49 !Pleroma.Config.get([:instance, :account_activation_required])
50 end
51
52 def remote_or_auth_active?(%User{} = user), do: !user.local || auth_active?(user)
53
54 def visible_for?(%User{} = user, for_user \\ nil) do
55 User.remote_or_auth_active?(user) || (for_user && for_user.id == user.id) ||
56 User.superuser?(for_user)
57 end
58
59 def superuser?(nil), do: false
60 def superuser?(%User{} = user), do: user.info && User.Info.superuser?(user.info)
61
62 def avatar_url(user) do
63 case user.avatar do
64 %{"url" => [%{"href" => href} | _]} -> href
65 _ -> "#{Web.base_url()}/images/avi.png"
66 end
67 end
68
69 def banner_url(user) do
70 case user.info.banner do
71 %{"url" => [%{"href" => href} | _]} -> href
72 _ -> "#{Web.base_url()}/images/banner.png"
73 end
74 end
75
76 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
77 def profile_url(%User{ap_id: ap_id}), do: ap_id
78 def profile_url(_), do: nil
79
80 def ap_id(%User{nickname: nickname}) do
81 "#{Web.base_url()}/users/#{nickname}"
82 end
83
84 def ap_followers(%User{} = user) do
85 "#{ap_id(user)}/followers"
86 end
87
88 def follow_changeset(struct, params \\ %{}) do
89 struct
90 |> cast(params, [:following])
91 |> validate_required([:following])
92 end
93
94 def user_info(%User{} = user) do
95 oneself = if user.local, do: 1, else: 0
96
97 %{
98 following_count: length(user.following) - oneself,
99 note_count: user.info.note_count,
100 follower_count: user.info.follower_count,
101 locked: user.info.locked,
102 confirmation_pending: user.info.confirmation_pending,
103 default_scope: user.info.default_scope
104 }
105 end
106
107 def remote_user_creation(params) do
108 params =
109 params
110 |> Map.put(:info, params[:info] || %{})
111
112 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
113
114 changes =
115 %User{}
116 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
117 |> validate_required([:name, :ap_id])
118 |> unique_constraint(:nickname)
119 |> validate_format(:nickname, @email_regex)
120 |> validate_length(:bio, max: 5000)
121 |> validate_length(:name, max: 100)
122 |> put_change(:local, false)
123 |> put_embed(:info, info_cng)
124
125 if changes.valid? do
126 case info_cng.changes[:source_data] do
127 %{"followers" => followers} ->
128 changes
129 |> put_change(:follower_address, followers)
130
131 _ ->
132 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
133
134 changes
135 |> put_change(:follower_address, followers)
136 end
137 else
138 changes
139 end
140 end
141
142 def update_changeset(struct, params \\ %{}) do
143 struct
144 |> cast(params, [:bio, :name, :avatar])
145 |> unique_constraint(:nickname)
146 |> validate_format(:nickname, local_nickname_regex())
147 |> validate_length(:bio, max: 5000)
148 |> validate_length(:name, min: 1, max: 100)
149 end
150
151 def upgrade_changeset(struct, params \\ %{}) do
152 params =
153 params
154 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
155
156 info_cng =
157 struct.info
158 |> User.Info.user_upgrade(params[:info])
159
160 struct
161 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
162 |> unique_constraint(:nickname)
163 |> validate_format(:nickname, local_nickname_regex())
164 |> validate_length(:bio, max: 5000)
165 |> validate_length(:name, max: 100)
166 |> put_embed(:info, info_cng)
167 end
168
169 def password_update_changeset(struct, params) do
170 changeset =
171 struct
172 |> cast(params, [:password, :password_confirmation])
173 |> validate_required([:password, :password_confirmation])
174 |> validate_confirmation(:password)
175
176 OAuth.Token.delete_user_tokens(struct)
177 OAuth.Authorization.delete_user_authorizations(struct)
178
179 if changeset.valid? do
180 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
181
182 changeset
183 |> put_change(:password_hash, hashed)
184 else
185 changeset
186 end
187 end
188
189 def reset_password(user, data) do
190 update_and_set_cache(password_update_changeset(user, data))
191 end
192
193 def register_changeset(struct, params \\ %{}, opts \\ []) do
194 confirmation_status =
195 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
196 :confirmed
197 else
198 :unconfirmed
199 end
200
201 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
202
203 changeset =
204 struct
205 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
206 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
207 |> validate_confirmation(:password)
208 |> unique_constraint(:email)
209 |> unique_constraint(:nickname)
210 |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
211 |> validate_format(:nickname, local_nickname_regex())
212 |> validate_format(:email, @email_regex)
213 |> validate_length(:bio, max: 1000)
214 |> validate_length(:name, min: 1, max: 100)
215 |> put_change(:info, info_change)
216
217 if changeset.valid? do
218 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
219 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
220 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
221
222 changeset
223 |> put_change(:password_hash, hashed)
224 |> put_change(:ap_id, ap_id)
225 |> put_change(:following, [followers])
226 |> put_change(:follower_address, followers)
227 else
228 changeset
229 end
230 end
231
232 defp autofollow_users(user) do
233 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
234
235 autofollowed_users =
236 from(u in User,
237 where: u.local == true,
238 where: u.nickname in ^candidates
239 )
240 |> Repo.all()
241
242 autofollowed_users
243 |> Enum.reduce({:ok, user}, fn other_user, {:ok, user} ->
244 follow(user, other_user)
245 end)
246 end
247
248 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
249 def register(%Ecto.Changeset{} = changeset) do
250 with {:ok, user} <- Repo.insert(changeset),
251 {:ok, _} <- try_send_confirmation_email(user),
252 {:ok, user} <- autofollow_users(user) do
253 {:ok, user}
254 end
255 end
256
257 def try_send_confirmation_email(%User{} = user) do
258 if user.info.confirmation_pending &&
259 Pleroma.Config.get([:instance, :account_activation_required]) do
260 user
261 |> Pleroma.UserEmail.account_confirmation_email()
262 |> Pleroma.Mailer.deliver()
263 else
264 {:ok, :noop}
265 end
266 end
267
268 def needs_update?(%User{local: true}), do: false
269
270 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
271
272 def needs_update?(%User{local: false} = user) do
273 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
274 end
275
276 def needs_update?(_), do: true
277
278 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
279 {:ok, follower}
280 end
281
282 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
283 follow(follower, followed)
284 end
285
286 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
287 if not User.ap_enabled?(followed) do
288 follow(follower, followed)
289 else
290 {:ok, follower}
291 end
292 end
293
294 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
295 if not following?(follower, followed) do
296 follow(follower, followed)
297 else
298 {:ok, follower}
299 end
300 end
301
302 def follow(%User{} = follower, %User{info: info} = followed) do
303 user_config = Application.get_env(:pleroma, :user)
304 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
305
306 ap_followers = followed.follower_address
307
308 cond do
309 following?(follower, followed) or info.deactivated ->
310 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
311
312 deny_follow_blocked and blocks?(followed, follower) ->
313 {:error, "Could not follow user: #{followed.nickname} blocked you."}
314
315 true ->
316 if !followed.local && follower.local && !ap_enabled?(followed) do
317 Websub.subscribe(follower, followed)
318 end
319
320 following =
321 [ap_followers | follower.following]
322 |> Enum.uniq()
323
324 follower =
325 follower
326 |> follow_changeset(%{following: following})
327 |> update_and_set_cache
328
329 {:ok, _} = update_follower_count(followed)
330
331 follower
332 end
333 end
334
335 def unfollow(%User{} = follower, %User{} = followed) do
336 ap_followers = followed.follower_address
337
338 if following?(follower, followed) and follower.ap_id != followed.ap_id do
339 following =
340 follower.following
341 |> List.delete(ap_followers)
342
343 {:ok, follower} =
344 follower
345 |> follow_changeset(%{following: following})
346 |> update_and_set_cache
347
348 {:ok, followed} = update_follower_count(followed)
349
350 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
351 else
352 {:error, "Not subscribed!"}
353 end
354 end
355
356 @spec following?(User.t(), User.t()) :: boolean
357 def following?(%User{} = follower, %User{} = followed) do
358 Enum.member?(follower.following, followed.follower_address)
359 end
360
361 def follow_import(%User{} = follower, followed_identifiers)
362 when is_list(followed_identifiers) do
363 Enum.map(
364 followed_identifiers,
365 fn followed_identifier ->
366 with %User{} = followed <- get_or_fetch(followed_identifier),
367 {:ok, follower} <- maybe_direct_follow(follower, followed),
368 {:ok, _} <- ActivityPub.follow(follower, followed) do
369 followed
370 else
371 err ->
372 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
373 err
374 end
375 end
376 )
377 end
378
379 def locked?(%User{} = user) do
380 user.info.locked || false
381 end
382
383 def get_by_ap_id(ap_id) do
384 Repo.get_by(User, ap_id: ap_id)
385 end
386
387 # This is mostly an SPC migration fix. This guesses the user nickname (by taking the last part of the ap_id and the domain) and tries to get that user
388 def get_by_guessed_nickname(ap_id) do
389 domain = URI.parse(ap_id).host
390 name = List.last(String.split(ap_id, "/"))
391 nickname = "#{name}@#{domain}"
392
393 get_by_nickname(nickname)
394 end
395
396 def update_and_set_cache(changeset) do
397 with {:ok, user} <- Repo.update(changeset) do
398 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
399 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
400 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
401 {:ok, user}
402 else
403 e -> e
404 end
405 end
406
407 def invalidate_cache(user) do
408 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
409 Cachex.del(:user_cache, "nickname:#{user.nickname}")
410 Cachex.del(:user_cache, "user_info:#{user.id}")
411 end
412
413 def get_cached_by_ap_id(ap_id) do
414 key = "ap_id:#{ap_id}"
415 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
416 end
417
418 def get_cached_by_nickname(nickname) do
419 key = "nickname:#{nickname}"
420 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
421 end
422
423 def get_by_nickname(nickname) do
424 Repo.get_by(User, nickname: nickname) ||
425 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
426 [local_nickname, _] = String.split(nickname, "@")
427 Repo.get_by(User, nickname: local_nickname)
428 end
429 end
430
431 def get_by_nickname_or_email(nickname_or_email) do
432 case user = Repo.get_by(User, nickname: nickname_or_email) do
433 %User{} -> user
434 nil -> Repo.get_by(User, email: nickname_or_email)
435 end
436 end
437
438 def get_cached_user_info(user) do
439 key = "user_info:#{user.id}"
440 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
441 end
442
443 def fetch_by_nickname(nickname) do
444 ap_try = ActivityPub.make_user_from_nickname(nickname)
445
446 case ap_try do
447 {:ok, user} -> {:ok, user}
448 _ -> OStatus.make_user(nickname)
449 end
450 end
451
452 def get_or_fetch_by_nickname(nickname) do
453 with %User{} = user <- get_by_nickname(nickname) do
454 user
455 else
456 _e ->
457 with [_nick, _domain] <- String.split(nickname, "@"),
458 {:ok, user} <- fetch_by_nickname(nickname) do
459 user
460 else
461 _e -> nil
462 end
463 end
464 end
465
466 def get_followers_query(%User{id: id, follower_address: follower_address}) do
467 from(
468 u in User,
469 where: fragment("? <@ ?", ^[follower_address], u.following),
470 where: u.id != ^id
471 )
472 end
473
474 def get_followers(user) do
475 q = get_followers_query(user)
476
477 {:ok, Repo.all(q)}
478 end
479
480 def get_friends_query(%User{id: id, following: following}) do
481 from(
482 u in User,
483 where: u.follower_address in ^following,
484 where: u.id != ^id
485 )
486 end
487
488 def get_friends(user) do
489 q = get_friends_query(user)
490
491 {:ok, Repo.all(q)}
492 end
493
494 def get_follow_requests_query(%User{} = user) do
495 from(
496 a in Activity,
497 where:
498 fragment(
499 "? ->> 'type' = 'Follow'",
500 a.data
501 ),
502 where:
503 fragment(
504 "? ->> 'state' = 'pending'",
505 a.data
506 ),
507 where:
508 fragment(
509 "? @> ?",
510 a.data,
511 ^%{"object" => user.ap_id}
512 )
513 )
514 end
515
516 def get_follow_requests(%User{} = user) do
517 q = get_follow_requests_query(user)
518 reqs = Repo.all(q)
519
520 users =
521 Enum.map(reqs, fn req -> req.actor end)
522 |> Enum.uniq()
523 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
524 |> Enum.filter(fn u -> !is_nil(u) end)
525 |> Enum.filter(fn u -> !following?(u, user) end)
526
527 {:ok, users}
528 end
529
530 def increase_note_count(%User{} = user) do
531 info_cng = User.Info.add_to_note_count(user.info, 1)
532
533 cng =
534 change(user)
535 |> put_embed(:info, info_cng)
536
537 update_and_set_cache(cng)
538 end
539
540 def decrease_note_count(%User{} = user) do
541 info_cng = User.Info.add_to_note_count(user.info, -1)
542
543 cng =
544 change(user)
545 |> put_embed(:info, info_cng)
546
547 update_and_set_cache(cng)
548 end
549
550 def update_note_count(%User{} = user) do
551 note_count_query =
552 from(
553 a in Object,
554 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
555 select: count(a.id)
556 )
557
558 note_count = Repo.one(note_count_query)
559
560 info_cng = User.Info.set_note_count(user.info, note_count)
561
562 cng =
563 change(user)
564 |> put_embed(:info, info_cng)
565
566 update_and_set_cache(cng)
567 end
568
569 def update_follower_count(%User{} = user) do
570 follower_count_query =
571 from(
572 u in User,
573 where: ^user.follower_address in u.following,
574 where: u.id != ^user.id,
575 select: count(u.id)
576 )
577
578 follower_count = Repo.one(follower_count_query)
579
580 info_cng =
581 user.info
582 |> User.Info.set_follower_count(follower_count)
583
584 cng =
585 change(user)
586 |> put_embed(:info, info_cng)
587
588 update_and_set_cache(cng)
589 end
590
591 def get_users_from_set_query(ap_ids, false) do
592 from(
593 u in User,
594 where: u.ap_id in ^ap_ids
595 )
596 end
597
598 def get_users_from_set_query(ap_ids, true) do
599 query = get_users_from_set_query(ap_ids, false)
600
601 from(
602 u in query,
603 where: u.local == true
604 )
605 end
606
607 def get_users_from_set(ap_ids, local_only \\ true) do
608 get_users_from_set_query(ap_ids, local_only)
609 |> Repo.all()
610 end
611
612 def get_recipients_from_activity(%Activity{recipients: to}) do
613 query =
614 from(
615 u in User,
616 where: u.ap_id in ^to,
617 or_where: fragment("? && ?", u.following, ^to)
618 )
619
620 query = from(u in query, where: u.local == true)
621
622 Repo.all(query)
623 end
624
625 def search(query, resolve \\ false) do
626 # strip the beginning @ off if there is a query
627 query = String.trim_leading(query, "@")
628
629 if resolve do
630 User.get_or_fetch_by_nickname(query)
631 end
632
633 inner =
634 from(
635 u in User,
636 select_merge: %{
637 search_distance:
638 fragment(
639 "? <-> (? || coalesce(?, ''))",
640 ^query,
641 u.nickname,
642 u.name
643 )
644 },
645 where: not is_nil(u.nickname)
646 )
647
648 q =
649 from(
650 s in subquery(inner),
651 order_by: s.search_distance,
652 limit: 20
653 )
654
655 Repo.all(q)
656 end
657
658 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
659 Enum.map(
660 blocked_identifiers,
661 fn blocked_identifier ->
662 with %User{} = blocked <- get_or_fetch(blocked_identifier),
663 {:ok, blocker} <- block(blocker, blocked),
664 {:ok, _} <- ActivityPub.block(blocker, blocked) do
665 blocked
666 else
667 err ->
668 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
669 err
670 end
671 end
672 )
673 end
674
675 def block(blocker, %User{ap_id: ap_id} = blocked) do
676 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
677 blocker =
678 if following?(blocker, blocked) do
679 {:ok, blocker, _} = unfollow(blocker, blocked)
680 blocker
681 else
682 blocker
683 end
684
685 if following?(blocked, blocker) do
686 unfollow(blocked, blocker)
687 end
688
689 info_cng =
690 blocker.info
691 |> User.Info.add_to_block(ap_id)
692
693 cng =
694 change(blocker)
695 |> put_embed(:info, info_cng)
696
697 update_and_set_cache(cng)
698 end
699
700 # helper to handle the block given only an actor's AP id
701 def block(blocker, %{ap_id: ap_id}) do
702 block(blocker, User.get_by_ap_id(ap_id))
703 end
704
705 def unblock(blocker, %{ap_id: ap_id}) do
706 info_cng =
707 blocker.info
708 |> User.Info.remove_from_block(ap_id)
709
710 cng =
711 change(blocker)
712 |> put_embed(:info, info_cng)
713
714 update_and_set_cache(cng)
715 end
716
717 def blocks?(user, %{ap_id: ap_id}) do
718 blocks = user.info.blocks
719 domain_blocks = user.info.domain_blocks
720 %{host: host} = URI.parse(ap_id)
721
722 Enum.member?(blocks, ap_id) ||
723 Enum.any?(domain_blocks, fn domain ->
724 host == domain
725 end)
726 end
727
728 def blocked_users(user),
729 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
730
731 def block_domain(user, domain) do
732 info_cng =
733 user.info
734 |> User.Info.add_to_domain_block(domain)
735
736 cng =
737 change(user)
738 |> put_embed(:info, info_cng)
739
740 update_and_set_cache(cng)
741 end
742
743 def unblock_domain(user, domain) do
744 info_cng =
745 user.info
746 |> User.Info.remove_from_domain_block(domain)
747
748 cng =
749 change(user)
750 |> put_embed(:info, info_cng)
751
752 update_and_set_cache(cng)
753 end
754
755 def local_user_query() do
756 from(
757 u in User,
758 where: u.local == true,
759 where: not is_nil(u.nickname)
760 )
761 end
762
763 def moderator_user_query() do
764 from(
765 u in User,
766 where: u.local == true,
767 where: fragment("?->'is_moderator' @> 'true'", u.info)
768 )
769 end
770
771 def deactivate(%User{} = user, status \\ true) do
772 info_cng = User.Info.set_activation_status(user.info, status)
773
774 cng =
775 change(user)
776 |> put_embed(:info, info_cng)
777
778 update_and_set_cache(cng)
779 end
780
781 def delete(%User{} = user) do
782 {:ok, user} = User.deactivate(user)
783
784 # Remove all relationships
785 {:ok, followers} = User.get_followers(user)
786
787 followers
788 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
789
790 {:ok, friends} = User.get_friends(user)
791
792 friends
793 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
794
795 query = from(a in Activity, where: a.actor == ^user.ap_id)
796
797 Repo.all(query)
798 |> Enum.each(fn activity ->
799 case activity.data["type"] do
800 "Create" ->
801 ActivityPub.delete(Object.normalize(activity.data["object"]))
802
803 # TODO: Do something with likes, follows, repeats.
804 _ ->
805 "Doing nothing"
806 end
807 end)
808
809 {:ok, user}
810 end
811
812 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
813 Pleroma.HTML.Scrubber.TwitterText
814 end
815
816 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
817
818 def html_filter_policy(_), do: @default_scrubbers
819
820 def get_or_fetch_by_ap_id(ap_id) do
821 user = get_by_ap_id(ap_id)
822
823 if !is_nil(user) and !User.needs_update?(user) do
824 user
825 else
826 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
827
828 case ap_try do
829 {:ok, user} ->
830 user
831
832 _ ->
833 case OStatus.make_user(ap_id) do
834 {:ok, user} -> user
835 _ -> {:error, "Could not fetch by AP id"}
836 end
837 end
838 end
839 end
840
841 def get_or_create_instance_user do
842 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
843
844 if user = get_by_ap_id(relay_uri) do
845 user
846 else
847 changes =
848 %User{info: %User.Info{}}
849 |> cast(%{}, [:ap_id, :nickname, :local])
850 |> put_change(:ap_id, relay_uri)
851 |> put_change(:nickname, nil)
852 |> put_change(:local, true)
853 |> put_change(:follower_address, relay_uri <> "/followers")
854
855 {:ok, user} = Repo.insert(changes)
856 user
857 end
858 end
859
860 # AP style
861 def public_key_from_info(%{
862 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
863 }) do
864 key =
865 public_key_pem
866 |> :public_key.pem_decode()
867 |> hd()
868 |> :public_key.pem_entry_decode()
869
870 {:ok, key}
871 end
872
873 # OStatus Magic Key
874 def public_key_from_info(%{magic_key: magic_key}) do
875 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
876 end
877
878 def get_public_key_for_ap_id(ap_id) do
879 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
880 {:ok, public_key} <- public_key_from_info(user.info) do
881 {:ok, public_key}
882 else
883 _ -> :error
884 end
885 end
886
887 defp blank?(""), do: nil
888 defp blank?(n), do: n
889
890 def insert_or_update_user(data) do
891 data =
892 data
893 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
894
895 cs = User.remote_user_creation(data)
896
897 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
898 end
899
900 def ap_enabled?(%User{local: true}), do: true
901 def ap_enabled?(%User{info: info}), do: info.ap_enabled
902 def ap_enabled?(_), do: false
903
904 @doc "Gets or fetch a user by uri or nickname."
905 @spec get_or_fetch(String.t()) :: User.t()
906 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
907 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
908
909 # wait a period of time and return newest version of the User structs
910 # this is because we have synchronous follow APIs and need to simulate them
911 # with an async handshake
912 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
913 with %User{} = a <- Repo.get(User, a.id),
914 %User{} = b <- Repo.get(User, b.id) do
915 {:ok, a, b}
916 else
917 _e ->
918 :error
919 end
920 end
921
922 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
923 with :ok <- :timer.sleep(timeout),
924 %User{} = a <- Repo.get(User, a.id),
925 %User{} = b <- Repo.get(User, b.id) do
926 {:ok, a, b}
927 else
928 _e ->
929 :error
930 end
931 end
932
933 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
934 def parse_bio(nil, _user), do: ""
935 def parse_bio(bio, _user) when bio == "", do: bio
936
937 def parse_bio(bio, user) do
938 mentions = Formatter.parse_mentions(bio)
939 tags = Formatter.parse_tags(bio)
940
941 emoji =
942 (user.info.source_data["tag"] || [])
943 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
944 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
945 {String.trim(name, ":"), url}
946 end)
947
948 bio
949 |> CommonUtils.format_input(mentions, tags, "text/plain")
950 |> Formatter.emojify(emoji)
951 end
952
953 def tag(user_identifiers, tags) when is_list(user_identifiers) do
954 Repo.transaction(fn ->
955 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
956 end)
957 end
958
959 def tag(nickname, tags) when is_binary(nickname),
960 do: tag(User.get_by_nickname(nickname), tags)
961
962 def tag(%User{} = user, tags),
963 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
964
965 def untag(user_identifiers, tags) when is_list(user_identifiers) do
966 Repo.transaction(fn ->
967 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
968 end)
969 end
970
971 def untag(nickname, tags) when is_binary(nickname),
972 do: untag(User.get_by_nickname(nickname), tags)
973
974 def untag(%User{} = user, tags),
975 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
976
977 defp update_tags(%User{} = user, new_tags) do
978 {:ok, updated_user} =
979 user
980 |> change(%{tags: new_tags})
981 |> Repo.update()
982
983 updated_user
984 end
985
986 defp normalize_tags(tags) do
987 [tags]
988 |> List.flatten()
989 |> Enum.map(&String.downcase(&1))
990 end
991
992 defp local_nickname_regex() do
993 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
994 @extended_local_nickname_regex
995 else
996 @strict_local_nickname_regex
997 end
998 end
999 end