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