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
14 alias Pleroma.Notification
16 alias Pleroma.Registration
20 alias Pleroma.Web.ActivityPub.ActivityPub
21 alias Pleroma.Web.ActivityPub.Utils
22 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
23 alias Pleroma.Web.OAuth
24 alias Pleroma.Web.OStatus
25 alias Pleroma.Web.RelMe
26 alias Pleroma.Web.Websub
30 @type t :: %__MODULE__{}
32 @primary_key {:id, Pleroma.FlakeId, autogenerate: true}
34 # credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
35 @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])?)*$/
37 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
38 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
42 field(:email, :string)
44 field(:nickname, :string)
45 field(:password_hash, :string)
46 field(:password, :string, virtual: true)
47 field(:password_confirmation, :string, virtual: true)
48 field(:following, {:array, :string}, default: [])
49 field(:ap_id, :string)
51 field(:local, :boolean, default: true)
52 field(:follower_address, :string)
53 field(:search_rank, :float, virtual: true)
54 field(:search_type, :integer, virtual: true)
55 field(:tags, {:array, :string}, default: [])
56 field(:last_refreshed_at, :naive_datetime_usec)
57 has_many(:notifications, Notification)
58 has_many(:registrations, Registration)
59 embeds_one(:info, User.Info)
64 def auth_active?(%User{info: %User.Info{confirmation_pending: true}}),
65 do: !Pleroma.Config.get([:instance, :account_activation_required])
67 def auth_active?(%User{}), do: true
69 def visible_for?(user, for_user \\ nil)
71 def visible_for?(%User{id: user_id}, %User{id: for_id}) when user_id == for_id, do: true
73 def visible_for?(%User{} = user, for_user) do
74 auth_active?(user) || superuser?(for_user)
77 def visible_for?(_, _), do: false
79 def superuser?(%User{local: true, info: %User.Info{is_admin: true}}), do: true
80 def superuser?(%User{local: true, info: %User.Info{is_moderator: true}}), do: true
81 def superuser?(_), do: false
83 def avatar_url(user, options \\ []) do
85 %{"url" => [%{"href" => href} | _]} -> href
86 _ -> !options[:no_default] && "#{Web.base_url()}/images/avi.png"
90 def banner_url(user, options \\ []) do
91 case user.info.banner do
92 %{"url" => [%{"href" => href} | _]} -> href
93 _ -> !options[:no_default] && "#{Web.base_url()}/images/banner.png"
97 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
98 def profile_url(%User{ap_id: ap_id}), do: ap_id
99 def profile_url(_), do: nil
101 def ap_id(%User{nickname: nickname}) do
102 "#{Web.base_url()}/users/#{nickname}"
105 def ap_followers(%User{follower_address: fa}) when is_binary(fa), do: fa
106 def ap_followers(%User{} = user), do: "#{ap_id(user)}/followers"
108 def user_info(%User{} = user) do
110 following_count: following_count(user),
111 note_count: user.info.note_count,
112 follower_count: user.info.follower_count,
113 locked: user.info.locked,
114 confirmation_pending: user.info.confirmation_pending,
115 default_scope: user.info.default_scope
119 def restrict_deactivated(query) do
121 where: not fragment("? \\? 'deactivated' AND ?->'deactivated' @> 'true'", u.info, u.info)
125 def following_count(%User{following: []}), do: 0
127 def following_count(%User{} = user) do
129 |> get_friends_query()
130 |> Repo.aggregate(:count, :id)
133 def remote_user_creation(params) do
136 |> Map.put(:info, params[:info] || %{})
138 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
142 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
143 |> validate_required([:name, :ap_id])
144 |> unique_constraint(:nickname)
145 |> validate_format(:nickname, @email_regex)
146 |> validate_length(:bio, max: 5000)
147 |> validate_length(:name, max: 100)
148 |> put_change(:local, false)
149 |> put_embed(:info, info_cng)
152 case info_cng.changes[:source_data] do
153 %{"followers" => followers} ->
155 |> put_change(:follower_address, followers)
158 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
161 |> put_change(:follower_address, followers)
168 def update_changeset(struct, params \\ %{}) do
170 |> cast(params, [:bio, :name, :avatar, :following])
171 |> unique_constraint(:nickname)
172 |> validate_format(:nickname, local_nickname_regex())
173 |> validate_length(:bio, max: 5000)
174 |> validate_length(:name, min: 1, max: 100)
177 def upgrade_changeset(struct, params \\ %{}) do
180 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
184 |> User.Info.user_upgrade(params[:info])
187 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
188 |> unique_constraint(:nickname)
189 |> validate_format(:nickname, local_nickname_regex())
190 |> validate_length(:bio, max: 5000)
191 |> validate_length(:name, max: 100)
192 |> put_embed(:info, info_cng)
195 def password_update_changeset(struct, params) do
198 |> cast(params, [:password, :password_confirmation])
199 |> validate_required([:password, :password_confirmation])
200 |> validate_confirmation(:password)
202 OAuth.Token.delete_user_tokens(struct)
203 OAuth.Authorization.delete_user_authorizations(struct)
205 if changeset.valid? do
206 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
209 |> put_change(:password_hash, hashed)
215 def reset_password(user, data) do
216 update_and_set_cache(password_update_changeset(user, data))
219 def register_changeset(struct, params \\ %{}, opts \\ []) do
221 if is_nil(opts[:need_confirmation]) do
222 Pleroma.Config.get([:instance, :account_activation_required])
224 opts[:need_confirmation]
228 User.Info.confirmation_changeset(%User.Info{}, need_confirmation: need_confirmation?)
232 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
233 |> validate_required([:name, :nickname, :password, :password_confirmation])
234 |> validate_confirmation(:password)
235 |> unique_constraint(:email)
236 |> unique_constraint(:nickname)
237 |> validate_exclusion(:nickname, Pleroma.Config.get([User, :restricted_nicknames]))
238 |> validate_format(:nickname, local_nickname_regex())
239 |> validate_format(:email, @email_regex)
240 |> validate_length(:bio, max: 1000)
241 |> validate_length(:name, min: 1, max: 100)
242 |> put_change(:info, info_change)
245 if opts[:external] do
248 validate_required(changeset, [:email])
251 if changeset.valid? do
252 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
253 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
254 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
257 |> put_change(:password_hash, hashed)
258 |> put_change(:ap_id, ap_id)
259 |> unique_constraint(:ap_id)
260 |> put_change(:following, [followers])
261 |> put_change(:follower_address, followers)
267 defp autofollow_users(user) do
268 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
271 User.Query.build(%{nickname: candidates, local: true, deactivated: false})
274 follow_all(user, autofollowed_users)
277 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
278 def register(%Ecto.Changeset{} = changeset) do
279 with {:ok, user} <- Repo.insert(changeset),
280 {:ok, user} <- autofollow_users(user),
281 {:ok, user} <- set_cache(user),
282 {:ok, _} <- User.WelcomeMessage.post_welcome_message_to_user(user),
283 {:ok, _} <- try_send_confirmation_email(user) do
288 def try_send_confirmation_email(%User{} = user) do
289 if user.info.confirmation_pending &&
290 Pleroma.Config.get([:instance, :account_activation_required]) do
292 |> Pleroma.Emails.UserEmail.account_confirmation_email()
293 |> Pleroma.Emails.Mailer.deliver_async()
301 def needs_update?(%User{local: true}), do: false
303 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
305 def needs_update?(%User{local: false} = user) do
306 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
309 def needs_update?(_), do: true
311 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
315 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
316 follow(follower, followed)
319 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
320 if not User.ap_enabled?(followed) do
321 follow(follower, followed)
327 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
328 if not following?(follower, followed) do
329 follow(follower, followed)
335 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
336 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
337 def follow_all(follower, followeds) do
340 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
341 |> Enum.map(fn %{follower_address: fa} -> fa end)
345 where: u.id == ^follower.id,
350 "array(select distinct unnest (array_cat(?, ?)))",
359 {1, [follower]} = Repo.update_all(q, [])
361 Enum.each(followeds, fn followed ->
362 update_follower_count(followed)
368 def follow(%User{} = follower, %User{info: info} = followed) do
369 user_config = Application.get_env(:pleroma, :user)
370 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
372 ap_followers = followed.follower_address
375 following?(follower, followed) or info.deactivated ->
376 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
378 deny_follow_blocked and blocks?(followed, follower) ->
379 {:error, "Could not follow user: #{followed.nickname} blocked you."}
382 if !followed.local && follower.local && !ap_enabled?(followed) do
383 Websub.subscribe(follower, followed)
388 where: u.id == ^follower.id,
389 update: [push: [following: ^ap_followers]],
393 {1, [follower]} = Repo.update_all(q, [])
395 {:ok, _} = update_follower_count(followed)
401 def unfollow(%User{} = follower, %User{} = followed) do
402 ap_followers = followed.follower_address
404 if following?(follower, followed) and follower.ap_id != followed.ap_id do
407 where: u.id == ^follower.id,
408 update: [pull: [following: ^ap_followers]],
412 {1, [follower]} = Repo.update_all(q, [])
414 {:ok, followed} = update_follower_count(followed)
418 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
420 {:error, "Not subscribed!"}
424 @spec following?(User.t(), User.t()) :: boolean
425 def following?(%User{} = follower, %User{} = followed) do
426 Enum.member?(follower.following, followed.follower_address)
429 def locked?(%User{} = user) do
430 user.info.locked || false
434 Repo.get_by(User, id: id)
437 def get_by_ap_id(ap_id) do
438 Repo.get_by(User, ap_id: ap_id)
441 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
442 # of the ap_id and the domain and tries to get that user
443 def get_by_guessed_nickname(ap_id) do
444 domain = URI.parse(ap_id).host
445 name = List.last(String.split(ap_id, "/"))
446 nickname = "#{name}@#{domain}"
448 get_cached_by_nickname(nickname)
451 def set_cache({:ok, user}), do: set_cache(user)
452 def set_cache({:error, err}), do: {:error, err}
454 def set_cache(%User{} = user) do
455 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
456 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
457 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
461 def update_and_set_cache(changeset) do
462 with {:ok, user} <- Repo.update(changeset) do
469 def invalidate_cache(user) do
470 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
471 Cachex.del(:user_cache, "nickname:#{user.nickname}")
472 Cachex.del(:user_cache, "user_info:#{user.id}")
475 def get_cached_by_ap_id(ap_id) do
476 key = "ap_id:#{ap_id}"
477 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
480 def get_cached_by_id(id) do
484 Cachex.fetch!(:user_cache, key, fn _ ->
488 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
489 {:commit, user.ap_id}
495 get_cached_by_ap_id(ap_id)
498 def get_cached_by_nickname(nickname) do
499 key = "nickname:#{nickname}"
501 Cachex.fetch!(:user_cache, key, fn ->
502 user_result = get_or_fetch_by_nickname(nickname)
505 {:ok, user} -> {:commit, user}
506 {:error, _error} -> {:ignore, nil}
511 def get_cached_by_nickname_or_id(nickname_or_id) do
512 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
515 def get_by_nickname(nickname) do
516 Repo.get_by(User, nickname: nickname) ||
517 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
518 Repo.get_by(User, nickname: local_nickname(nickname))
522 def get_by_email(email), do: Repo.get_by(User, email: email)
524 def get_by_nickname_or_email(nickname_or_email) do
525 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
528 def get_cached_user_info(user) do
529 key = "user_info:#{user.id}"
530 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
533 def fetch_by_nickname(nickname) do
534 ap_try = ActivityPub.make_user_from_nickname(nickname)
537 {:ok, user} -> {:ok, user}
538 _ -> OStatus.make_user(nickname)
542 def get_or_fetch_by_nickname(nickname) do
543 with %User{} = user <- get_by_nickname(nickname) do
547 with [_nick, _domain] <- String.split(nickname, "@"),
548 {:ok, user} <- fetch_by_nickname(nickname) do
549 if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
550 fetch_initial_posts(user)
555 _e -> {:error, "not found " <> nickname}
560 @doc "Fetch some posts when the user has just been federated with"
561 def fetch_initial_posts(user),
562 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:fetch_initial_posts, user])
564 @spec get_followers_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
565 def get_followers_query(%User{} = user, nil) do
566 User.Query.build(%{followers: user, deactivated: false})
569 def get_followers_query(user, page) do
570 from(u in get_followers_query(user, nil))
571 |> User.Query.paginate(page, 20)
574 @spec get_followers_query(User.t()) :: Ecto.Query.t()
575 def get_followers_query(user), do: get_followers_query(user, nil)
577 def get_followers(user, page \\ nil) do
578 q = get_followers_query(user, page)
583 def get_followers_ids(user, page \\ nil) do
584 q = get_followers_query(user, page)
586 Repo.all(from(u in q, select: u.id))
589 @spec get_friends_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
590 def get_friends_query(%User{} = user, nil) do
591 User.Query.build(%{friends: user, deactivated: false})
594 def get_friends_query(user, page) do
595 from(u in get_friends_query(user, nil))
596 |> User.Query.paginate(page, 20)
599 @spec get_friends_query(User.t()) :: Ecto.Query.t()
600 def get_friends_query(user), do: get_friends_query(user, nil)
602 def get_friends(user, page \\ nil) do
603 q = get_friends_query(user, page)
608 def get_friends_ids(user, page \\ nil) do
609 q = get_friends_query(user, page)
611 Repo.all(from(u in q, select: u.id))
614 @spec get_follow_requests(User.t()) :: {:ok, [User.t()]}
615 def get_follow_requests(%User{} = user) do
617 Activity.follow_requests_for_actor(user)
618 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
619 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
620 |> group_by([a, u], u.id)
627 def increase_note_count(%User{} = user) do
629 |> where(id: ^user.id)
634 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
641 |> Repo.update_all([])
643 {1, [user]} -> set_cache(user)
648 def decrease_note_count(%User{} = user) do
650 |> where(id: ^user.id)
655 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
662 |> Repo.update_all([])
664 {1, [user]} -> set_cache(user)
669 def update_note_count(%User{} = user) do
673 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
677 note_count = Repo.one(note_count_query)
679 info_cng = User.Info.set_note_count(user.info, note_count)
683 |> put_embed(:info, info_cng)
684 |> update_and_set_cache()
687 def update_follower_count(%User{} = user) do
688 follower_count_query =
689 User.Query.build(%{followers: user, deactivated: false})
690 |> select([u], %{count: count(u.id)})
693 |> where(id: ^user.id)
694 |> join(:inner, [u], s in subquery(follower_count_query))
699 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
706 |> Repo.update_all([])
708 {1, [user]} -> set_cache(user)
713 def remove_duplicated_following(%User{following: following} = user) do
714 uniq_following = Enum.uniq(following)
716 if length(following) == length(uniq_following) do
720 |> update_changeset(%{following: uniq_following})
721 |> update_and_set_cache()
725 @spec get_users_from_set([String.t()], boolean()) :: [User.t()]
726 def get_users_from_set(ap_ids, local_only \\ true) do
727 criteria = %{ap_id: ap_ids, deactivated: false}
728 criteria = if local_only, do: Map.put(criteria, :local, true), else: criteria
730 User.Query.build(criteria)
734 @spec get_recipients_from_activity(Activity.t()) :: [User.t()]
735 def get_recipients_from_activity(%Activity{recipients: to}) do
736 User.Query.build(%{recipients_from_activity: to, local: true, deactivated: false})
740 def search(query, resolve \\ false, for_user \\ nil) do
741 # Strip the beginning @ off if there is a query
742 query = String.trim_leading(query, "@")
744 if resolve, do: get_or_fetch(query)
747 Repo.transaction(fn ->
748 Ecto.Adapters.SQL.query(Repo, "select set_limit(0.25)", [])
749 Repo.all(search_query(query, for_user))
755 def search_query(query, for_user) do
756 fts_subquery = fts_search_subquery(query)
757 trigram_subquery = trigram_search_subquery(query)
758 union_query = from(s in trigram_subquery, union_all: ^fts_subquery)
759 distinct_query = from(s in subquery(union_query), order_by: s.search_type, distinct: s.id)
761 from(s in subquery(boost_search_rank_query(distinct_query, for_user)),
762 order_by: [desc: s.search_rank],
767 defp boost_search_rank_query(query, nil), do: query
769 defp boost_search_rank_query(query, for_user) do
770 friends_ids = get_friends_ids(for_user)
771 followers_ids = get_followers_ids(for_user)
773 from(u in subquery(query),
778 CASE WHEN (?) THEN (?) * 1.3
779 WHEN (?) THEN (?) * 1.2
780 WHEN (?) THEN (?) * 1.1
783 u.id in ^friends_ids and u.id in ^followers_ids,
785 u.id in ^friends_ids,
787 u.id in ^followers_ids,
795 defp fts_search_subquery(term, query \\ User) do
798 |> String.replace(~r/\W+/, " ")
801 |> Enum.map(&(&1 <> ":*"))
812 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
813 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
814 to_tsquery('simple', ?),
826 (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
827 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
834 |> restrict_deactivated()
837 defp trigram_search_subquery(term) do
841 # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
842 search_type: fragment("?", 1),
845 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
851 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
853 |> restrict_deactivated()
856 def mute(muter, %User{ap_id: ap_id}) do
859 |> User.Info.add_to_mutes(ap_id)
863 |> put_embed(:info, info_cng)
865 update_and_set_cache(cng)
868 def unmute(muter, %{ap_id: ap_id}) do
871 |> User.Info.remove_from_mutes(ap_id)
875 |> put_embed(:info, info_cng)
877 update_and_set_cache(cng)
880 def subscribe(subscriber, %{ap_id: ap_id}) do
881 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
883 with %User{} = subscribed <- get_cached_by_ap_id(ap_id) do
884 blocked = blocks?(subscribed, subscriber) and deny_follow_blocked
887 {:error, "Could not subscribe: #{subscribed.nickname} is blocking you"}
891 |> User.Info.add_to_subscribers(subscriber.ap_id)
894 |> put_embed(:info, info_cng)
895 |> update_and_set_cache()
900 def unsubscribe(unsubscriber, %{ap_id: ap_id}) do
901 with %User{} = user <- get_cached_by_ap_id(ap_id) do
904 |> User.Info.remove_from_subscribers(unsubscriber.ap_id)
907 |> put_embed(:info, info_cng)
908 |> update_and_set_cache()
912 def block(blocker, %User{ap_id: ap_id} = blocked) do
913 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
915 if following?(blocker, blocked) do
916 {:ok, blocker, _} = unfollow(blocker, blocked)
923 if subscribed_to?(blocked, blocker) do
924 {:ok, blocker} = unsubscribe(blocked, blocker)
930 if following?(blocked, blocker) do
931 unfollow(blocked, blocker)
934 {:ok, blocker} = update_follower_count(blocker)
938 |> User.Info.add_to_block(ap_id)
942 |> put_embed(:info, info_cng)
944 update_and_set_cache(cng)
947 # helper to handle the block given only an actor's AP id
948 def block(blocker, %{ap_id: ap_id}) do
949 block(blocker, get_cached_by_ap_id(ap_id))
952 def unblock(blocker, %{ap_id: ap_id}) do
955 |> User.Info.remove_from_block(ap_id)
959 |> put_embed(:info, info_cng)
961 update_and_set_cache(cng)
964 def mutes?(nil, _), do: false
965 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
967 def blocks?(user, %{ap_id: ap_id}) do
968 blocks = user.info.blocks
969 domain_blocks = user.info.domain_blocks
970 %{host: host} = URI.parse(ap_id)
972 Enum.member?(blocks, ap_id) ||
973 Enum.any?(domain_blocks, fn domain ->
978 def subscribed_to?(user, %{ap_id: ap_id}) do
979 with %User{} = target <- get_cached_by_ap_id(ap_id) do
980 Enum.member?(target.info.subscribers, user.ap_id)
984 @spec muted_users(User.t()) :: [User.t()]
985 def muted_users(user) do
986 User.Query.build(%{ap_id: user.info.mutes, deactivated: false})
990 @spec blocked_users(User.t()) :: [User.t()]
991 def blocked_users(user) do
992 User.Query.build(%{ap_id: user.info.blocks, deactivated: false})
996 @spec subscribers(User.t()) :: [User.t()]
997 def subscribers(user) do
998 User.Query.build(%{ap_id: user.info.subscribers, deactivated: false})
1002 def block_domain(user, domain) do
1005 |> User.Info.add_to_domain_block(domain)
1009 |> put_embed(:info, info_cng)
1011 update_and_set_cache(cng)
1014 def unblock_domain(user, domain) do
1017 |> User.Info.remove_from_domain_block(domain)
1021 |> put_embed(:info, info_cng)
1023 update_and_set_cache(cng)
1026 def deactivate_async(user, status \\ true) do
1027 PleromaJobQueue.enqueue(:background, __MODULE__, [:deactivate_async, user, status])
1030 def deactivate(%User{} = user, status \\ true) do
1031 info_cng = User.Info.set_activation_status(user.info, status)
1033 with {:ok, friends} <- User.get_friends(user),
1034 {:ok, followers} <- User.get_followers(user),
1038 |> put_embed(:info, info_cng)
1039 |> update_and_set_cache() do
1040 Enum.each(followers, &invalidate_cache(&1))
1041 Enum.each(friends, &update_follower_count(&1))
1047 def update_notification_settings(%User{} = user, settings \\ %{}) do
1048 info_changeset = User.Info.update_notification_settings(user.info, settings)
1051 |> put_embed(:info, info_changeset)
1052 |> update_and_set_cache()
1055 @spec delete(User.t()) :: :ok
1056 def delete(%User{} = user),
1057 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:delete, user])
1059 @spec perform(atom(), User.t()) :: {:ok, User.t()}
1060 def perform(:delete, %User{} = user) do
1061 {:ok, user} = User.deactivate(user)
1063 # Remove all relationships
1064 {:ok, followers} = User.get_followers(user)
1066 Enum.each(followers, fn follower -> User.unfollow(follower, user) end)
1068 {:ok, friends} = User.get_friends(user)
1070 Enum.each(friends, fn followed -> User.unfollow(user, followed) end)
1072 delete_user_activities(user)
1075 @spec perform(atom(), User.t()) :: {:ok, User.t()}
1076 def perform(:fetch_initial_posts, %User{} = user) do
1077 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
1080 # Insert all the posts in reverse order, so they're in the right order on the timeline
1081 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
1082 &Pleroma.Web.Federator.incoming_ap_doc/1
1088 def perform(:deactivate_async, user, status), do: deactivate(user, status)
1090 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
1091 def perform(:blocks_import, %User{} = blocker, blocked_identifiers)
1092 when is_list(blocked_identifiers) do
1094 blocked_identifiers,
1095 fn blocked_identifier ->
1096 with {:ok, %User{} = blocked} <- get_or_fetch(blocked_identifier),
1097 {:ok, blocker} <- block(blocker, blocked),
1098 {:ok, _} <- ActivityPub.block(blocker, blocked) do
1102 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
1109 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
1110 def perform(:follow_import, %User{} = follower, followed_identifiers)
1111 when is_list(followed_identifiers) do
1113 followed_identifiers,
1114 fn followed_identifier ->
1115 with {:ok, %User{} = followed} <- get_or_fetch(followed_identifier),
1116 {:ok, follower} <- maybe_direct_follow(follower, followed),
1117 {:ok, _} <- ActivityPub.follow(follower, followed) do
1121 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
1128 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers),
1130 PleromaJobQueue.enqueue(:background, __MODULE__, [
1136 def follow_import(%User{} = follower, followed_identifiers) when is_list(followed_identifiers),
1138 PleromaJobQueue.enqueue(:background, __MODULE__, [
1141 followed_identifiers
1144 def delete_user_activities(%User{ap_id: ap_id} = user) do
1147 |> Activity.query_by_actor()
1150 Repo.transaction(fn -> Enum.each(stream, &delete_activity(&1)) end, timeout: :infinity)
1155 defp delete_activity(%{data: %{"type" => "Create"}} = activity) do
1156 Object.normalize(activity) |> ActivityPub.delete()
1159 defp delete_activity(_activity), do: "Doing nothing"
1161 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1162 Pleroma.HTML.Scrubber.TwitterText
1165 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
1167 def html_filter_policy(_), do: @default_scrubbers
1169 def fetch_by_ap_id(ap_id) do
1170 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1177 case OStatus.make_user(ap_id) do
1178 {:ok, user} -> {:ok, user}
1179 _ -> {:error, "Could not fetch by AP id"}
1184 def get_or_fetch_by_ap_id(ap_id) do
1185 user = get_cached_by_ap_id(ap_id)
1187 if !is_nil(user) and !User.needs_update?(user) do
1190 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1191 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1193 resp = fetch_by_ap_id(ap_id)
1195 if should_fetch_initial do
1196 with {:ok, %User{} = user} <- resp do
1197 fetch_initial_posts(user)
1205 def get_or_create_instance_user do
1206 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1208 if user = get_cached_by_ap_id(relay_uri) do
1212 %User{info: %User.Info{}}
1213 |> cast(%{}, [:ap_id, :nickname, :local])
1214 |> put_change(:ap_id, relay_uri)
1215 |> put_change(:nickname, nil)
1216 |> put_change(:local, true)
1217 |> put_change(:follower_address, relay_uri <> "/followers")
1219 {:ok, user} = Repo.insert(changes)
1225 def public_key_from_info(%{
1226 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1230 |> :public_key.pem_decode()
1232 |> :public_key.pem_entry_decode()
1238 def public_key_from_info(%{magic_key: magic_key}) do
1239 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1242 def get_public_key_for_ap_id(ap_id) do
1243 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id),
1244 {:ok, public_key} <- public_key_from_info(user.info) do
1251 defp blank?(""), do: nil
1252 defp blank?(n), do: n
1254 def insert_or_update_user(data) do
1256 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1257 |> remote_user_creation()
1258 |> Repo.insert(on_conflict: :replace_all, conflict_target: :nickname)
1262 def ap_enabled?(%User{local: true}), do: true
1263 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1264 def ap_enabled?(_), do: false
1266 @doc "Gets or fetch a user by uri or nickname."
1267 @spec get_or_fetch(String.t()) :: {:ok, User.t()} | {:error, String.t()}
1268 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1269 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1271 # wait a period of time and return newest version of the User structs
1272 # this is because we have synchronous follow APIs and need to simulate them
1273 # with an async handshake
1274 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1275 with %User{} = a <- User.get_cached_by_id(a.id),
1276 %User{} = b <- User.get_cached_by_id(b.id) do
1284 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1285 with :ok <- :timer.sleep(timeout),
1286 %User{} = a <- User.get_cached_by_id(a.id),
1287 %User{} = b <- User.get_cached_by_id(b.id) do
1295 def parse_bio(bio) when is_binary(bio) and bio != "" do
1297 |> CommonUtils.format_input("text/plain", mentions_format: :full)
1301 def parse_bio(_), do: ""
1303 def parse_bio(bio, user) when is_binary(bio) and bio != "" do
1304 # TODO: get profile URLs other than user.ap_id
1305 profile_urls = [user.ap_id]
1308 |> CommonUtils.format_input("text/plain",
1309 mentions_format: :full,
1310 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1315 def parse_bio(_, _), do: ""
1317 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1318 Repo.transaction(fn ->
1319 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1323 def tag(nickname, tags) when is_binary(nickname),
1324 do: tag(get_by_nickname(nickname), tags)
1326 def tag(%User{} = user, tags),
1327 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1329 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1330 Repo.transaction(fn ->
1331 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1335 def untag(nickname, tags) when is_binary(nickname),
1336 do: untag(get_by_nickname(nickname), tags)
1338 def untag(%User{} = user, tags),
1339 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1341 defp update_tags(%User{} = user, new_tags) do
1342 {:ok, updated_user} =
1344 |> change(%{tags: new_tags})
1345 |> update_and_set_cache()
1350 defp normalize_tags(tags) do
1353 |> Enum.map(&String.downcase(&1))
1356 defp local_nickname_regex do
1357 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1358 @extended_local_nickname_regex
1360 @strict_local_nickname_regex
1364 def local_nickname(nickname_or_mention) do
1367 |> String.split("@")
1371 def full_nickname(nickname_or_mention),
1372 do: String.trim_leading(nickname_or_mention, "@")
1374 def error_user(ap_id) do
1379 nickname: "erroruser@example.com",
1380 inserted_at: NaiveDateTime.utc_now()
1384 @spec all_superusers() :: [User.t()]
1385 def all_superusers do
1386 User.Query.build(%{super_users: true, local: true, deactivated: false})
1390 def showing_reblogs?(%User{} = user, %User{} = target) do
1391 target.ap_id not in user.info.muted_reblogs
1394 @spec toggle_confirmation(User.t()) :: {:ok, User.t()} | {:error, Changeset.t()}
1395 def toggle_confirmation(%User{} = user) do
1396 need_confirmation? = !user.info.confirmation_pending
1399 User.Info.confirmation_changeset(user.info, need_confirmation: need_confirmation?)
1403 |> put_embed(:info, info_changeset)
1404 |> update_and_set_cache()
1407 def get_mascot(%{info: %{mascot: %{} = mascot}}) when not is_nil(mascot) do
1411 def get_mascot(%{info: %{mascot: mascot}}) when is_nil(mascot) do
1412 # use instance-default
1413 config = Pleroma.Config.get([:assets, :mascots])
1414 default_mascot = Pleroma.Config.get([:assets, :default_mascot])
1415 mascot = Keyword.get(config, default_mascot)
1418 "id" => "default-mascot",
1419 "url" => mascot[:url],
1420 "preview_url" => mascot[:url],
1422 "mime_type" => mascot[:mime_type]
1427 def ensure_keys_present(user) do
1433 {:ok, pem} = Keys.generate_rsa_pem()
1437 |> User.Info.set_keys(pem)
1440 Ecto.Changeset.change(user)
1441 |> Ecto.Changeset.put_embed(:info, info_cng)
1443 update_and_set_cache(cng)