1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.User do
12 alias Pleroma.Activity
13 alias Pleroma.Notification
15 alias Pleroma.Registration
19 alias Pleroma.Web.ActivityPub.ActivityPub
20 alias Pleroma.Web.ActivityPub.Utils
21 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
22 alias Pleroma.Web.OAuth
23 alias Pleroma.Web.OStatus
24 alias Pleroma.Web.RelMe
25 alias Pleroma.Web.Websub
29 @type t :: %__MODULE__{}
31 @primary_key {:id, Pleroma.FlakeId, autogenerate: true}
33 # credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
34 @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])?)*$/
36 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
37 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
41 field(:email, :string)
43 field(:nickname, :string)
44 field(:password_hash, :string)
45 field(:password, :string, virtual: true)
46 field(:password_confirmation, :string, virtual: true)
47 field(:following, {:array, :string}, default: [])
48 field(:ap_id, :string)
50 field(:local, :boolean, default: true)
51 field(:follower_address, :string)
52 field(:search_rank, :float, virtual: true)
53 field(:search_type, :integer, virtual: true)
54 field(:tags, {:array, :string}, default: [])
55 field(:last_refreshed_at, :naive_datetime_usec)
56 has_many(:notifications, Notification)
57 has_many(:registrations, Registration)
58 embeds_one(:info, Pleroma.User.Info)
63 def auth_active?(%User{info: %User.Info{confirmation_pending: true}}),
64 do: !Pleroma.Config.get([:instance, :account_activation_required])
66 def auth_active?(%User{}), do: true
68 def visible_for?(user, for_user \\ nil)
70 def visible_for?(%User{id: user_id}, %User{id: for_id}) when user_id == for_id, do: true
72 def visible_for?(%User{} = user, for_user) do
73 auth_active?(user) || superuser?(for_user)
76 def visible_for?(_, _), do: false
78 def superuser?(%User{local: true, info: %User.Info{is_admin: true}}), do: true
79 def superuser?(%User{local: true, info: %User.Info{is_moderator: true}}), do: true
80 def superuser?(_), do: false
82 def avatar_url(user, options \\ []) do
84 %{"url" => [%{"href" => href} | _]} -> href
85 _ -> !options[:no_default] && "#{Web.base_url()}/images/avi.png"
89 def banner_url(user, options \\ []) do
90 case user.info.banner do
91 %{"url" => [%{"href" => href} | _]} -> href
92 _ -> !options[:no_default] && "#{Web.base_url()}/images/banner.png"
96 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
97 def profile_url(%User{ap_id: ap_id}), do: ap_id
98 def profile_url(_), do: nil
100 def ap_id(%User{nickname: nickname}) do
101 "#{Web.base_url()}/users/#{nickname}"
104 def ap_followers(%User{follower_address: fa}) when is_binary(fa), do: fa
105 def ap_followers(%User{} = user), do: "#{ap_id(user)}/followers"
107 def user_info(%User{} = user) do
108 oneself = if user.local, do: 1, else: 0
111 following_count: length(user.following) - oneself,
112 note_count: user.info.note_count,
113 follower_count: user.info.follower_count,
114 locked: user.info.locked,
115 confirmation_pending: user.info.confirmation_pending,
116 default_scope: user.info.default_scope
120 def remote_user_creation(params) do
123 |> Map.put(:info, params[:info] || %{})
125 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
129 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
130 |> validate_required([:name, :ap_id])
131 |> unique_constraint(:nickname)
132 |> validate_format(:nickname, @email_regex)
133 |> validate_length(:bio, max: 5000)
134 |> validate_length(:name, max: 100)
135 |> put_change(:local, false)
136 |> put_embed(:info, info_cng)
139 case info_cng.changes[:source_data] do
140 %{"followers" => followers} ->
142 |> put_change(:follower_address, followers)
145 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
148 |> put_change(:follower_address, followers)
155 def update_changeset(struct, params \\ %{}) do
157 |> cast(params, [:bio, :name, :avatar])
158 |> unique_constraint(:nickname)
159 |> validate_format(:nickname, local_nickname_regex())
160 |> validate_length(:bio, max: 5000)
161 |> validate_length(:name, min: 1, max: 100)
164 def upgrade_changeset(struct, params \\ %{}) do
167 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
171 |> User.Info.user_upgrade(params[:info])
174 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
175 |> unique_constraint(:nickname)
176 |> validate_format(:nickname, local_nickname_regex())
177 |> validate_length(:bio, max: 5000)
178 |> validate_length(:name, max: 100)
179 |> put_embed(:info, info_cng)
182 def password_update_changeset(struct, params) do
185 |> cast(params, [:password, :password_confirmation])
186 |> validate_required([:password, :password_confirmation])
187 |> validate_confirmation(:password)
189 OAuth.Token.delete_user_tokens(struct)
190 OAuth.Authorization.delete_user_authorizations(struct)
192 if changeset.valid? do
193 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
196 |> put_change(:password_hash, hashed)
202 def reset_password(user, data) do
203 update_and_set_cache(password_update_changeset(user, data))
206 def register_changeset(struct, params \\ %{}, opts \\ []) do
207 confirmation_status =
208 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
214 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
218 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
219 |> validate_required([:name, :nickname, :password, :password_confirmation])
220 |> validate_confirmation(:password)
221 |> unique_constraint(:email)
222 |> unique_constraint(:nickname)
223 |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
224 |> validate_format(:nickname, local_nickname_regex())
225 |> validate_format(:email, @email_regex)
226 |> validate_length(:bio, max: 1000)
227 |> validate_length(:name, min: 1, max: 100)
228 |> put_change(:info, info_change)
231 if opts[:external] do
234 validate_required(changeset, [:email])
237 if changeset.valid? do
238 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
239 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
240 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
243 |> put_change(:password_hash, hashed)
244 |> put_change(:ap_id, ap_id)
245 |> unique_constraint(:ap_id)
246 |> put_change(:following, [followers])
247 |> put_change(:follower_address, followers)
253 defp autofollow_users(user) do
254 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
258 where: u.local == true,
259 where: u.nickname in ^candidates
263 follow_all(user, autofollowed_users)
266 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
267 def register(%Ecto.Changeset{} = changeset) do
268 with {:ok, user} <- Repo.insert(changeset),
269 {:ok, user} <- autofollow_users(user),
270 {:ok, user} <- set_cache(user),
271 {:ok, _} <- Pleroma.User.WelcomeMessage.post_welcome_message_to_user(user),
272 {:ok, _} <- try_send_confirmation_email(user) do
277 def try_send_confirmation_email(%User{} = user) do
278 if user.info.confirmation_pending &&
279 Pleroma.Config.get([:instance, :account_activation_required]) do
281 |> Pleroma.Emails.UserEmail.account_confirmation_email()
282 |> Pleroma.Emails.Mailer.deliver_async()
290 def needs_update?(%User{local: true}), do: false
292 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
294 def needs_update?(%User{local: false} = user) do
295 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
298 def needs_update?(_), do: true
300 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
304 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
305 follow(follower, followed)
308 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
309 if not User.ap_enabled?(followed) do
310 follow(follower, followed)
316 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
317 if not following?(follower, followed) do
318 follow(follower, followed)
324 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
325 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
326 def follow_all(follower, followeds) do
329 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
330 |> Enum.map(fn %{follower_address: fa} -> fa end)
334 where: u.id == ^follower.id,
339 "array(select distinct unnest (array_cat(?, ?)))",
348 {1, [follower]} = Repo.update_all(q, [])
350 Enum.each(followeds, fn followed ->
351 update_follower_count(followed)
357 def follow(%User{} = follower, %User{info: info} = followed) do
358 user_config = Application.get_env(:pleroma, :user)
359 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
361 ap_followers = followed.follower_address
364 following?(follower, followed) or info.deactivated ->
365 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
367 deny_follow_blocked and blocks?(followed, follower) ->
368 {:error, "Could not follow user: #{followed.nickname} blocked you."}
371 if !followed.local && follower.local && !ap_enabled?(followed) do
372 Websub.subscribe(follower, followed)
377 where: u.id == ^follower.id,
378 update: [push: [following: ^ap_followers]],
382 {1, [follower]} = Repo.update_all(q, [])
384 {:ok, _} = update_follower_count(followed)
390 def unfollow(%User{} = follower, %User{} = followed) do
391 ap_followers = followed.follower_address
393 if following?(follower, followed) and follower.ap_id != followed.ap_id do
396 where: u.id == ^follower.id,
397 update: [pull: [following: ^ap_followers]],
401 {1, [follower]} = Repo.update_all(q, [])
403 {:ok, followed} = update_follower_count(followed)
407 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
409 {:error, "Not subscribed!"}
413 @spec following?(User.t(), User.t()) :: boolean
414 def following?(%User{} = follower, %User{} = followed) do
415 Enum.member?(follower.following, followed.follower_address)
418 def follow_import(%User{} = follower, followed_identifiers)
419 when is_list(followed_identifiers) do
421 followed_identifiers,
422 fn followed_identifier ->
423 with {:ok, %User{} = followed} <- get_or_fetch(followed_identifier),
424 {:ok, follower} <- maybe_direct_follow(follower, followed),
425 {:ok, _} <- ActivityPub.follow(follower, followed) do
429 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
436 def locked?(%User{} = user) do
437 user.info.locked || false
441 Repo.get_by(User, id: id)
444 def get_by_ap_id(ap_id) do
445 Repo.get_by(User, ap_id: ap_id)
448 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
449 # of the ap_id and the domain and tries to get that user
450 def get_by_guessed_nickname(ap_id) do
451 domain = URI.parse(ap_id).host
452 name = List.last(String.split(ap_id, "/"))
453 nickname = "#{name}@#{domain}"
455 get_cached_by_nickname(nickname)
458 def set_cache({:ok, user}), do: set_cache(user)
459 def set_cache({:error, err}), do: {:error, err}
461 def set_cache(%User{} = user) do
462 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
463 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
464 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
468 def update_and_set_cache(changeset) do
469 with {:ok, user} <- Repo.update(changeset) do
476 def invalidate_cache(user) do
477 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
478 Cachex.del(:user_cache, "nickname:#{user.nickname}")
479 Cachex.del(:user_cache, "user_info:#{user.id}")
482 def get_cached_by_ap_id(ap_id) do
483 key = "ap_id:#{ap_id}"
484 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
487 def get_cached_by_id(id) do
491 Cachex.fetch!(:user_cache, key, fn _ ->
495 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
496 {:commit, user.ap_id}
502 get_cached_by_ap_id(ap_id)
505 def get_cached_by_nickname(nickname) do
506 key = "nickname:#{nickname}"
508 Cachex.fetch!(:user_cache, key, fn ->
509 user_result = get_or_fetch_by_nickname(nickname)
512 {:ok, user} -> {:commit, user}
513 {:error, _error} -> {:ignore, nil}
518 def get_cached_by_nickname_or_id(nickname_or_id) do
519 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
522 def get_by_nickname(nickname) do
523 Repo.get_by(User, nickname: nickname) ||
524 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
525 Repo.get_by(User, nickname: local_nickname(nickname))
529 def get_by_email(email), do: Repo.get_by(User, email: email)
531 def get_by_nickname_or_email(nickname_or_email) do
532 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
535 def get_cached_user_info(user) do
536 key = "user_info:#{user.id}"
537 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
540 def fetch_by_nickname(nickname) do
541 ap_try = ActivityPub.make_user_from_nickname(nickname)
544 {:ok, user} -> {:ok, user}
545 _ -> OStatus.make_user(nickname)
549 def get_or_fetch_by_nickname(nickname) do
550 with %User{} = user <- get_by_nickname(nickname) do
554 with [_nick, _domain] <- String.split(nickname, "@"),
555 {:ok, user} <- fetch_by_nickname(nickname) do
556 if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
558 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
563 _e -> {:error, "not found " <> nickname}
568 @doc "Fetch some posts when the user has just been federated with"
569 def fetch_initial_posts(user) do
570 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
573 # Insert all the posts in reverse order, so they're in the right order on the timeline
574 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
575 &Pleroma.Web.Federator.incoming_ap_doc/1
579 def get_followers_query(%User{id: id, follower_address: follower_address}, nil) do
582 where: fragment("? <@ ?", ^[follower_address], u.following),
587 def get_followers_query(user, page) do
588 from(u in get_followers_query(user, nil))
589 |> paginate(page, 20)
592 def get_followers_query(user), do: get_followers_query(user, nil)
594 def get_followers(user, page \\ nil) do
595 q = get_followers_query(user, page)
600 def get_followers_ids(user, page \\ nil) do
601 q = get_followers_query(user, page)
603 Repo.all(from(u in q, select: u.id))
606 def get_friends_query(%User{id: id, following: following}, nil) do
609 where: u.follower_address in ^following,
614 def get_friends_query(user, page) do
615 from(u in get_friends_query(user, nil))
616 |> paginate(page, 20)
619 def get_friends_query(user), do: get_friends_query(user, nil)
621 def get_friends(user, page \\ nil) do
622 q = get_friends_query(user, page)
627 def get_friends_ids(user, page \\ nil) do
628 q = get_friends_query(user, page)
630 Repo.all(from(u in q, select: u.id))
633 def get_follow_requests_query(%User{} = user) do
638 "? ->> 'type' = 'Follow'",
643 "? ->> 'state' = 'pending'",
648 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
656 def get_follow_requests(%User{} = user) do
659 |> User.get_follow_requests_query()
660 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
661 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
662 |> group_by([a, u], u.id)
669 def increase_note_count(%User{} = user) do
671 |> where(id: ^user.id)
676 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
683 |> Repo.update_all([])
685 {1, [user]} -> set_cache(user)
690 def decrease_note_count(%User{} = user) do
692 |> where(id: ^user.id)
697 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
704 |> Repo.update_all([])
706 {1, [user]} -> set_cache(user)
711 def update_note_count(%User{} = user) do
715 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
719 note_count = Repo.one(note_count_query)
721 info_cng = User.Info.set_note_count(user.info, note_count)
725 |> put_embed(:info, info_cng)
727 update_and_set_cache(cng)
730 def update_follower_count(%User{} = user) do
731 follower_count_query =
733 |> where([u], ^user.follower_address in u.following)
734 |> where([u], u.id != ^user.id)
735 |> select([u], %{count: count(u.id)})
738 |> where(id: ^user.id)
739 |> join(:inner, [u], s in subquery(follower_count_query))
744 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
751 |> Repo.update_all([])
753 {1, [user]} -> set_cache(user)
758 def get_users_from_set_query(ap_ids, false) do
761 where: u.ap_id in ^ap_ids
765 def get_users_from_set_query(ap_ids, true) do
766 query = get_users_from_set_query(ap_ids, false)
770 where: u.local == true
774 def get_users_from_set(ap_ids, local_only \\ true) do
775 get_users_from_set_query(ap_ids, local_only)
779 def get_recipients_from_activity(%Activity{recipients: to}) do
783 where: u.ap_id in ^to,
784 or_where: fragment("? && ?", u.following, ^to)
787 query = from(u in query, where: u.local == true)
792 def search(query, resolve \\ false, for_user \\ nil) do
793 # Strip the beginning @ off if there is a query
794 query = String.trim_leading(query, "@")
796 if resolve, do: get_or_fetch(query)
799 Repo.transaction(fn ->
800 Ecto.Adapters.SQL.query(Repo, "select set_limit(0.25)", [])
801 Repo.all(search_query(query, for_user))
807 def search_query(query, for_user) do
808 fts_subquery = fts_search_subquery(query)
809 trigram_subquery = trigram_search_subquery(query)
810 union_query = from(s in trigram_subquery, union_all: ^fts_subquery)
811 distinct_query = from(s in subquery(union_query), order_by: s.search_type, distinct: s.id)
813 from(s in subquery(boost_search_rank_query(distinct_query, for_user)),
814 order_by: [desc: s.search_rank],
819 defp boost_search_rank_query(query, nil), do: query
821 defp boost_search_rank_query(query, for_user) do
822 friends_ids = get_friends_ids(for_user)
823 followers_ids = get_followers_ids(for_user)
825 from(u in subquery(query),
830 CASE WHEN (?) THEN (?) * 1.3
831 WHEN (?) THEN (?) * 1.2
832 WHEN (?) THEN (?) * 1.1
835 u.id in ^friends_ids and u.id in ^followers_ids,
837 u.id in ^friends_ids,
839 u.id in ^followers_ids,
847 defp fts_search_subquery(term, query \\ User) do
850 |> String.replace(~r/\W+/, " ")
853 |> Enum.map(&(&1 <> ":*"))
864 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
865 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
866 to_tsquery('simple', ?),
878 (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
879 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
888 defp trigram_search_subquery(term) do
892 # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
893 search_type: fragment("?", 1),
896 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
902 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
906 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
909 fn blocked_identifier ->
910 with {:ok, %User{} = blocked} <- get_or_fetch(blocked_identifier),
911 {:ok, blocker} <- block(blocker, blocked),
912 {:ok, _} <- ActivityPub.block(blocker, blocked) do
916 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
923 def mute(muter, %User{ap_id: ap_id}) do
926 |> User.Info.add_to_mutes(ap_id)
930 |> put_embed(:info, info_cng)
932 update_and_set_cache(cng)
935 def unmute(muter, %{ap_id: ap_id}) do
938 |> User.Info.remove_from_mutes(ap_id)
942 |> put_embed(:info, info_cng)
944 update_and_set_cache(cng)
947 def subscribe(subscriber, %{ap_id: ap_id}) do
948 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
950 with %User{} = subscribed <- get_cached_by_ap_id(ap_id) do
951 blocked = blocks?(subscribed, subscriber) and deny_follow_blocked
954 {:error, "Could not subscribe: #{subscribed.nickname} is blocking you"}
958 |> User.Info.add_to_subscribers(subscriber.ap_id)
961 |> put_embed(:info, info_cng)
962 |> update_and_set_cache()
967 def unsubscribe(unsubscriber, %{ap_id: ap_id}) do
968 with %User{} = user <- get_cached_by_ap_id(ap_id) do
971 |> User.Info.remove_from_subscribers(unsubscriber.ap_id)
974 |> put_embed(:info, info_cng)
975 |> update_and_set_cache()
979 def block(blocker, %User{ap_id: ap_id} = blocked) do
980 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
982 if following?(blocker, blocked) do
983 {:ok, blocker, _} = unfollow(blocker, blocked)
990 if subscribed_to?(blocked, blocker) do
991 {:ok, blocker} = unsubscribe(blocked, blocker)
997 if following?(blocked, blocker) do
998 unfollow(blocked, blocker)
1001 {:ok, blocker} = update_follower_count(blocker)
1005 |> User.Info.add_to_block(ap_id)
1009 |> put_embed(:info, info_cng)
1011 update_and_set_cache(cng)
1014 # helper to handle the block given only an actor's AP id
1015 def block(blocker, %{ap_id: ap_id}) do
1016 block(blocker, get_cached_by_ap_id(ap_id))
1019 def unblock(blocker, %{ap_id: ap_id}) do
1022 |> User.Info.remove_from_block(ap_id)
1026 |> put_embed(:info, info_cng)
1028 update_and_set_cache(cng)
1031 def mutes?(nil, _), do: false
1032 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
1034 def blocks?(user, %{ap_id: ap_id}) do
1035 blocks = user.info.blocks
1036 domain_blocks = user.info.domain_blocks
1037 %{host: host} = URI.parse(ap_id)
1039 Enum.member?(blocks, ap_id) ||
1040 Enum.any?(domain_blocks, fn domain ->
1045 def subscribed_to?(user, %{ap_id: ap_id}) do
1046 with %User{} = target <- get_cached_by_ap_id(ap_id) do
1047 Enum.member?(target.info.subscribers, user.ap_id)
1051 def muted_users(user),
1052 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.mutes))
1054 def blocked_users(user),
1055 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
1057 def subscribers(user),
1058 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.subscribers))
1060 def block_domain(user, domain) do
1063 |> User.Info.add_to_domain_block(domain)
1067 |> put_embed(:info, info_cng)
1069 update_and_set_cache(cng)
1072 def unblock_domain(user, domain) do
1075 |> User.Info.remove_from_domain_block(domain)
1079 |> put_embed(:info, info_cng)
1081 update_and_set_cache(cng)
1084 def maybe_local_user_query(query, local) do
1085 if local, do: local_user_query(query), else: query
1088 def local_user_query(query \\ User) do
1091 where: u.local == true,
1092 where: not is_nil(u.nickname)
1096 def maybe_external_user_query(query, external) do
1097 if external, do: external_user_query(query), else: query
1100 def external_user_query(query \\ User) do
1103 where: u.local == false,
1104 where: not is_nil(u.nickname)
1108 def maybe_active_user_query(query, active) do
1109 if active, do: active_user_query(query), else: query
1112 def active_user_query(query \\ User) do
1115 where: fragment("not (?->'deactivated' @> 'true')", u.info),
1116 where: not is_nil(u.nickname)
1120 def maybe_deactivated_user_query(query, deactivated) do
1121 if deactivated, do: deactivated_user_query(query), else: query
1124 def deactivated_user_query(query \\ User) do
1127 where: fragment("(?->'deactivated' @> 'true')", u.info),
1128 where: not is_nil(u.nickname)
1132 def active_local_user_query do
1134 u in local_user_query(),
1135 where: fragment("not (?->'deactivated' @> 'true')", u.info)
1139 def moderator_user_query do
1142 where: u.local == true,
1143 where: fragment("?->'is_moderator' @> 'true'", u.info)
1147 def deactivate(%User{} = user, status \\ true) do
1148 info_cng = User.Info.set_activation_status(user.info, status)
1152 |> put_embed(:info, info_cng)
1154 update_and_set_cache(cng)
1157 def update_notification_settings(%User{} = user, settings \\ %{}) do
1158 info_changeset = User.Info.update_notification_settings(user.info, settings)
1161 |> put_embed(:info, info_changeset)
1162 |> update_and_set_cache()
1165 @spec delete(User.t()) :: :ok
1166 def delete(%User{} = user),
1167 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:delete, user])
1169 @spec perform(atom(), User.t()) :: {:ok, User.t()}
1170 def perform(:delete, %User{} = user) do
1171 {:ok, user} = User.deactivate(user)
1173 # Remove all relationships
1174 {:ok, followers} = User.get_followers(user)
1176 Enum.each(followers, fn follower -> User.unfollow(follower, user) end)
1178 {:ok, friends} = User.get_friends(user)
1180 Enum.each(friends, fn followed -> User.unfollow(user, followed) end)
1182 delete_user_activities(user)
1185 def delete_user_activities(%User{ap_id: ap_id} = user) do
1188 |> Activity.query_by_actor()
1189 |> Activity.with_preloaded_object()
1192 Repo.transaction(fn -> Enum.each(stream, &delete_activity(&1)) end, timeout: :infinity)
1197 defp delete_activity(%{data: %{"type" => "Create"}} = activity) do
1198 Object.normalize(activity) |> ActivityPub.delete()
1201 defp delete_activity(_activity), do: "Doing nothing"
1203 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1204 Pleroma.HTML.Scrubber.TwitterText
1207 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
1209 def html_filter_policy(_), do: @default_scrubbers
1211 def fetch_by_ap_id(ap_id) do
1212 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1219 case OStatus.make_user(ap_id) do
1220 {:ok, user} -> {:ok, user}
1221 _ -> {:error, "Could not fetch by AP id"}
1226 def get_or_fetch_by_ap_id(ap_id) do
1227 user = get_cached_by_ap_id(ap_id)
1229 if !is_nil(user) and !User.needs_update?(user) do
1232 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1233 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1235 resp = fetch_by_ap_id(ap_id)
1237 if should_fetch_initial do
1238 with {:ok, %User{} = user} = resp do
1239 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
1247 def get_or_create_instance_user do
1248 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1250 if user = get_cached_by_ap_id(relay_uri) do
1254 %User{info: %User.Info{}}
1255 |> cast(%{}, [:ap_id, :nickname, :local])
1256 |> put_change(:ap_id, relay_uri)
1257 |> put_change(:nickname, nil)
1258 |> put_change(:local, true)
1259 |> put_change(:follower_address, relay_uri <> "/followers")
1261 {:ok, user} = Repo.insert(changes)
1267 def public_key_from_info(%{
1268 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1272 |> :public_key.pem_decode()
1274 |> :public_key.pem_entry_decode()
1280 def public_key_from_info(%{magic_key: magic_key}) do
1281 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1284 def get_public_key_for_ap_id(ap_id) do
1285 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id),
1286 {:ok, public_key} <- public_key_from_info(user.info) do
1293 defp blank?(""), do: nil
1294 defp blank?(n), do: n
1296 def insert_or_update_user(data) do
1298 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1299 |> remote_user_creation()
1300 |> Repo.insert(on_conflict: :replace_all, conflict_target: :nickname)
1304 def ap_enabled?(%User{local: true}), do: true
1305 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1306 def ap_enabled?(_), do: false
1308 @doc "Gets or fetch a user by uri or nickname."
1309 @spec get_or_fetch(String.t()) :: User.t()
1310 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1311 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1313 # wait a period of time and return newest version of the User structs
1314 # this is because we have synchronous follow APIs and need to simulate them
1315 # with an async handshake
1316 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1317 with %User{} = a <- User.get_cached_by_id(a.id),
1318 %User{} = b <- User.get_cached_by_id(b.id) do
1326 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1327 with :ok <- :timer.sleep(timeout),
1328 %User{} = a <- User.get_cached_by_id(a.id),
1329 %User{} = b <- User.get_cached_by_id(b.id) do
1337 def parse_bio(bio) when is_binary(bio) and bio != "" do
1339 |> CommonUtils.format_input("text/plain", mentions_format: :full)
1343 def parse_bio(_), do: ""
1345 def parse_bio(bio, user) when is_binary(bio) and bio != "" do
1346 # TODO: get profile URLs other than user.ap_id
1347 profile_urls = [user.ap_id]
1350 |> CommonUtils.format_input("text/plain",
1351 mentions_format: :full,
1352 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1357 def parse_bio(_, _), do: ""
1359 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1360 Repo.transaction(fn ->
1361 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1365 def tag(nickname, tags) when is_binary(nickname),
1366 do: tag(get_by_nickname(nickname), tags)
1368 def tag(%User{} = user, tags),
1369 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1371 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1372 Repo.transaction(fn ->
1373 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1377 def untag(nickname, tags) when is_binary(nickname),
1378 do: untag(get_by_nickname(nickname), tags)
1380 def untag(%User{} = user, tags),
1381 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1383 defp update_tags(%User{} = user, new_tags) do
1384 {:ok, updated_user} =
1386 |> change(%{tags: new_tags})
1387 |> update_and_set_cache()
1392 defp normalize_tags(tags) do
1395 |> Enum.map(&String.downcase(&1))
1398 defp local_nickname_regex do
1399 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1400 @extended_local_nickname_regex
1402 @strict_local_nickname_regex
1406 def local_nickname(nickname_or_mention) do
1409 |> String.split("@")
1413 def full_nickname(nickname_or_mention),
1414 do: String.trim_leading(nickname_or_mention, "@")
1416 def error_user(ap_id) do
1421 nickname: "erroruser@example.com",
1422 inserted_at: NaiveDateTime.utc_now()
1426 def all_superusers do
1429 where: u.local == true,
1430 where: fragment("?->'is_admin' @> 'true' OR ?->'is_moderator' @> 'true'", u.info, u.info)
1435 defp paginate(query, page, page_size) do
1438 offset: ^((page - 1) * page_size)
1442 def showing_reblogs?(%User{} = user, %User{} = target) do
1443 target.ap_id not in user.info.muted_reblogs