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} <- post_register_action(user) do
285 def post_register_action(%User{} = user) do
286 with {:ok, user} <- autofollow_users(user),
287 {:ok, user} <- set_cache(user),
288 {:ok, _} <- User.WelcomeMessage.post_welcome_message_to_user(user),
289 {:ok, _} <- try_send_confirmation_email(user) do
294 def try_send_confirmation_email(%User{} = user) do
295 if user.info.confirmation_pending &&
296 Pleroma.Config.get([:instance, :account_activation_required]) do
298 |> Pleroma.Emails.UserEmail.account_confirmation_email()
299 |> Pleroma.Emails.Mailer.deliver_async()
307 def needs_update?(%User{local: true}), do: false
309 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
311 def needs_update?(%User{local: false} = user) do
312 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
315 def needs_update?(_), do: true
317 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
321 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
322 follow(follower, followed)
325 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
326 if not User.ap_enabled?(followed) do
327 follow(follower, followed)
333 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
334 if not following?(follower, followed) do
335 follow(follower, followed)
341 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
342 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
343 def follow_all(follower, followeds) do
346 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
347 |> Enum.map(fn %{follower_address: fa} -> fa end)
351 where: u.id == ^follower.id,
356 "array(select distinct unnest (array_cat(?, ?)))",
365 {1, [follower]} = Repo.update_all(q, [])
367 Enum.each(followeds, fn followed ->
368 update_follower_count(followed)
374 def follow(%User{} = follower, %User{info: info} = followed) do
375 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
376 ap_followers = followed.follower_address
379 following?(follower, followed) or info.deactivated ->
380 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
382 deny_follow_blocked and blocks?(followed, follower) ->
383 {:error, "Could not follow user: #{followed.nickname} blocked you."}
386 if !followed.local && follower.local && !ap_enabled?(followed) do
387 Websub.subscribe(follower, followed)
392 where: u.id == ^follower.id,
393 update: [push: [following: ^ap_followers]],
397 {1, [follower]} = Repo.update_all(q, [])
399 {:ok, _} = update_follower_count(followed)
405 def unfollow(%User{} = follower, %User{} = followed) do
406 ap_followers = followed.follower_address
408 if following?(follower, followed) and follower.ap_id != followed.ap_id do
411 where: u.id == ^follower.id,
412 update: [pull: [following: ^ap_followers]],
416 {1, [follower]} = Repo.update_all(q, [])
418 {:ok, followed} = update_follower_count(followed)
422 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
424 {:error, "Not subscribed!"}
428 @spec following?(User.t(), User.t()) :: boolean
429 def following?(%User{} = follower, %User{} = followed) do
430 Enum.member?(follower.following, followed.follower_address)
433 def locked?(%User{} = user) do
434 user.info.locked || false
438 Repo.get_by(User, id: id)
441 def get_by_ap_id(ap_id) do
442 Repo.get_by(User, ap_id: ap_id)
445 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
446 # of the ap_id and the domain and tries to get that user
447 def get_by_guessed_nickname(ap_id) do
448 domain = URI.parse(ap_id).host
449 name = List.last(String.split(ap_id, "/"))
450 nickname = "#{name}@#{domain}"
452 get_cached_by_nickname(nickname)
455 def set_cache({:ok, user}), do: set_cache(user)
456 def set_cache({:error, err}), do: {:error, err}
458 def set_cache(%User{} = user) do
459 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
460 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
461 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
465 def update_and_set_cache(changeset) do
466 with {:ok, user} <- Repo.update(changeset) do
473 def invalidate_cache(user) do
474 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
475 Cachex.del(:user_cache, "nickname:#{user.nickname}")
476 Cachex.del(:user_cache, "user_info:#{user.id}")
479 def get_cached_by_ap_id(ap_id) do
480 key = "ap_id:#{ap_id}"
481 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
484 def get_cached_by_id(id) do
488 Cachex.fetch!(:user_cache, key, fn _ ->
492 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
493 {:commit, user.ap_id}
499 get_cached_by_ap_id(ap_id)
502 def get_cached_by_nickname(nickname) do
503 key = "nickname:#{nickname}"
505 Cachex.fetch!(:user_cache, key, fn ->
506 user_result = get_or_fetch_by_nickname(nickname)
509 {:ok, user} -> {:commit, user}
510 {:error, _error} -> {:ignore, nil}
515 def get_cached_by_nickname_or_id(nickname_or_id) do
516 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
519 def get_by_nickname(nickname) do
520 Repo.get_by(User, nickname: nickname) ||
521 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
522 Repo.get_by(User, nickname: local_nickname(nickname))
526 def get_by_email(email), do: Repo.get_by(User, email: email)
528 def get_by_nickname_or_email(nickname_or_email) do
529 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
532 def get_cached_user_info(user) do
533 key = "user_info:#{user.id}"
534 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
537 def fetch_by_nickname(nickname) do
538 ap_try = ActivityPub.make_user_from_nickname(nickname)
541 {:ok, user} -> {:ok, user}
542 _ -> OStatus.make_user(nickname)
546 def get_or_fetch_by_nickname(nickname) do
547 with %User{} = user <- get_by_nickname(nickname) do
551 with [_nick, _domain] <- String.split(nickname, "@"),
552 {:ok, user} <- fetch_by_nickname(nickname) do
553 if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
554 fetch_initial_posts(user)
559 _e -> {:error, "not found " <> nickname}
564 @doc "Fetch some posts when the user has just been federated with"
565 def fetch_initial_posts(user),
566 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:fetch_initial_posts, user])
568 @spec get_followers_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
569 def get_followers_query(%User{} = user, nil) do
570 User.Query.build(%{followers: user, deactivated: false})
573 def get_followers_query(user, page) do
574 from(u in get_followers_query(user, nil))
575 |> User.Query.paginate(page, 20)
578 @spec get_followers_query(User.t()) :: Ecto.Query.t()
579 def get_followers_query(user), do: get_followers_query(user, nil)
581 def get_followers(user, page \\ nil) do
582 q = get_followers_query(user, page)
587 def get_followers_ids(user, page \\ nil) do
588 q = get_followers_query(user, page)
590 Repo.all(from(u in q, select: u.id))
593 @spec get_friends_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
594 def get_friends_query(%User{} = user, nil) do
595 User.Query.build(%{friends: user, deactivated: false})
598 def get_friends_query(user, page) do
599 from(u in get_friends_query(user, nil))
600 |> User.Query.paginate(page, 20)
603 @spec get_friends_query(User.t()) :: Ecto.Query.t()
604 def get_friends_query(user), do: get_friends_query(user, nil)
606 def get_friends(user, page \\ nil) do
607 q = get_friends_query(user, page)
612 def get_friends_ids(user, page \\ nil) do
613 q = get_friends_query(user, page)
615 Repo.all(from(u in q, select: u.id))
618 @spec get_follow_requests(User.t()) :: {:ok, [User.t()]}
619 def get_follow_requests(%User{} = user) do
621 Activity.follow_requests_for_actor(user)
622 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
623 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
624 |> group_by([a, u], u.id)
631 def increase_note_count(%User{} = user) do
633 |> where(id: ^user.id)
638 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
645 |> Repo.update_all([])
647 {1, [user]} -> set_cache(user)
652 def decrease_note_count(%User{} = user) do
654 |> where(id: ^user.id)
659 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
666 |> Repo.update_all([])
668 {1, [user]} -> set_cache(user)
673 def update_note_count(%User{} = user) do
677 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
681 note_count = Repo.one(note_count_query)
683 info_cng = User.Info.set_note_count(user.info, note_count)
687 |> put_embed(:info, info_cng)
688 |> update_and_set_cache()
691 def update_follower_count(%User{} = user) do
692 follower_count_query =
693 User.Query.build(%{followers: user, deactivated: false})
694 |> select([u], %{count: count(u.id)})
697 |> where(id: ^user.id)
698 |> join(:inner, [u], s in subquery(follower_count_query))
703 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
710 |> Repo.update_all([])
712 {1, [user]} -> set_cache(user)
717 def remove_duplicated_following(%User{following: following} = user) do
718 uniq_following = Enum.uniq(following)
720 if length(following) == length(uniq_following) do
724 |> update_changeset(%{following: uniq_following})
725 |> update_and_set_cache()
729 @spec get_users_from_set([String.t()], boolean()) :: [User.t()]
730 def get_users_from_set(ap_ids, local_only \\ true) do
731 criteria = %{ap_id: ap_ids, deactivated: false}
732 criteria = if local_only, do: Map.put(criteria, :local, true), else: criteria
734 User.Query.build(criteria)
738 @spec get_recipients_from_activity(Activity.t()) :: [User.t()]
739 def get_recipients_from_activity(%Activity{recipients: to}) do
740 User.Query.build(%{recipients_from_activity: to, local: true, deactivated: false})
744 def search(query, resolve \\ false, for_user \\ nil) do
745 # Strip the beginning @ off if there is a query
746 query = String.trim_leading(query, "@")
748 if resolve, do: get_or_fetch(query)
751 Repo.transaction(fn ->
752 Ecto.Adapters.SQL.query(Repo, "select set_limit(0.25)", [])
753 Repo.all(search_query(query, for_user))
759 def search_query(query, for_user) do
760 fts_subquery = fts_search_subquery(query)
761 trigram_subquery = trigram_search_subquery(query)
762 union_query = from(s in trigram_subquery, union_all: ^fts_subquery)
763 distinct_query = from(s in subquery(union_query), order_by: s.search_type, distinct: s.id)
765 from(s in subquery(boost_search_rank_query(distinct_query, for_user)),
766 order_by: [desc: s.search_rank],
771 defp boost_search_rank_query(query, nil), do: query
773 defp boost_search_rank_query(query, for_user) do
774 friends_ids = get_friends_ids(for_user)
775 followers_ids = get_followers_ids(for_user)
777 from(u in subquery(query),
782 CASE WHEN (?) THEN (?) * 1.3
783 WHEN (?) THEN (?) * 1.2
784 WHEN (?) THEN (?) * 1.1
787 u.id in ^friends_ids and u.id in ^followers_ids,
789 u.id in ^friends_ids,
791 u.id in ^followers_ids,
799 defp fts_search_subquery(term, query \\ User) do
802 |> String.replace(~r/\W+/, " ")
805 |> Enum.map(&(&1 <> ":*"))
816 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
817 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
818 to_tsquery('simple', ?),
830 (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
831 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
838 |> restrict_deactivated()
841 defp trigram_search_subquery(term) do
845 # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
846 search_type: fragment("?", 1),
849 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
855 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
857 |> restrict_deactivated()
860 def mute(muter, %User{ap_id: ap_id}) do
863 |> User.Info.add_to_mutes(ap_id)
867 |> put_embed(:info, info_cng)
869 update_and_set_cache(cng)
872 def unmute(muter, %{ap_id: ap_id}) do
875 |> User.Info.remove_from_mutes(ap_id)
879 |> put_embed(:info, info_cng)
881 update_and_set_cache(cng)
884 def subscribe(subscriber, %{ap_id: ap_id}) do
885 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
887 with %User{} = subscribed <- get_cached_by_ap_id(ap_id) do
888 blocked = blocks?(subscribed, subscriber) and deny_follow_blocked
891 {:error, "Could not subscribe: #{subscribed.nickname} is blocking you"}
895 |> User.Info.add_to_subscribers(subscriber.ap_id)
898 |> put_embed(:info, info_cng)
899 |> update_and_set_cache()
904 def unsubscribe(unsubscriber, %{ap_id: ap_id}) do
905 with %User{} = user <- get_cached_by_ap_id(ap_id) do
908 |> User.Info.remove_from_subscribers(unsubscriber.ap_id)
911 |> put_embed(:info, info_cng)
912 |> update_and_set_cache()
916 def block(blocker, %User{ap_id: ap_id} = blocked) do
917 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
919 if following?(blocker, blocked) do
920 {:ok, blocker, _} = unfollow(blocker, blocked)
927 if subscribed_to?(blocked, blocker) do
928 {:ok, blocker} = unsubscribe(blocked, blocker)
934 if following?(blocked, blocker) do
935 unfollow(blocked, blocker)
938 {:ok, blocker} = update_follower_count(blocker)
942 |> User.Info.add_to_block(ap_id)
946 |> put_embed(:info, info_cng)
948 update_and_set_cache(cng)
951 # helper to handle the block given only an actor's AP id
952 def block(blocker, %{ap_id: ap_id}) do
953 block(blocker, get_cached_by_ap_id(ap_id))
956 def unblock(blocker, %{ap_id: ap_id}) do
959 |> User.Info.remove_from_block(ap_id)
963 |> put_embed(:info, info_cng)
965 update_and_set_cache(cng)
968 def mutes?(nil, _), do: false
969 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
971 def blocks?(user, %{ap_id: ap_id}) do
972 blocks = user.info.blocks
973 domain_blocks = user.info.domain_blocks
974 %{host: host} = URI.parse(ap_id)
976 Enum.member?(blocks, ap_id) ||
977 Enum.any?(domain_blocks, fn domain ->
982 def subscribed_to?(user, %{ap_id: ap_id}) do
983 with %User{} = target <- get_cached_by_ap_id(ap_id) do
984 Enum.member?(target.info.subscribers, user.ap_id)
988 @spec muted_users(User.t()) :: [User.t()]
989 def muted_users(user) do
990 User.Query.build(%{ap_id: user.info.mutes, deactivated: false})
994 @spec blocked_users(User.t()) :: [User.t()]
995 def blocked_users(user) do
996 User.Query.build(%{ap_id: user.info.blocks, deactivated: false})
1000 @spec subscribers(User.t()) :: [User.t()]
1001 def subscribers(user) do
1002 User.Query.build(%{ap_id: user.info.subscribers, deactivated: false})
1006 def block_domain(user, domain) do
1009 |> User.Info.add_to_domain_block(domain)
1013 |> put_embed(:info, info_cng)
1015 update_and_set_cache(cng)
1018 def unblock_domain(user, domain) do
1021 |> User.Info.remove_from_domain_block(domain)
1025 |> put_embed(:info, info_cng)
1027 update_and_set_cache(cng)
1030 def deactivate_async(user, status \\ true) do
1031 PleromaJobQueue.enqueue(:background, __MODULE__, [:deactivate_async, user, status])
1034 def deactivate(%User{} = user, status \\ true) do
1035 info_cng = User.Info.set_activation_status(user.info, status)
1037 with {:ok, friends} <- User.get_friends(user),
1038 {:ok, followers} <- User.get_followers(user),
1042 |> put_embed(:info, info_cng)
1043 |> update_and_set_cache() do
1044 Enum.each(followers, &invalidate_cache(&1))
1045 Enum.each(friends, &update_follower_count(&1))
1051 def update_notification_settings(%User{} = user, settings \\ %{}) do
1052 info_changeset = User.Info.update_notification_settings(user.info, settings)
1055 |> put_embed(:info, info_changeset)
1056 |> update_and_set_cache()
1059 @spec delete(User.t()) :: :ok
1060 def delete(%User{} = user),
1061 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:delete, user])
1063 @spec perform(atom(), User.t()) :: {:ok, User.t()}
1064 def perform(:delete, %User{} = user) do
1065 {:ok, user} = User.deactivate(user)
1067 # Remove all relationships
1068 {:ok, followers} = User.get_followers(user)
1070 Enum.each(followers, fn follower -> User.unfollow(follower, user) end)
1072 {:ok, friends} = User.get_friends(user)
1074 Enum.each(friends, fn followed -> User.unfollow(user, followed) end)
1076 delete_user_activities(user)
1079 @spec perform(atom(), User.t()) :: {:ok, User.t()}
1080 def perform(:fetch_initial_posts, %User{} = user) do
1081 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
1084 # Insert all the posts in reverse order, so they're in the right order on the timeline
1085 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
1086 &Pleroma.Web.Federator.incoming_ap_doc/1
1092 def perform(:deactivate_async, user, status), do: deactivate(user, status)
1094 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
1095 def perform(:blocks_import, %User{} = blocker, blocked_identifiers)
1096 when is_list(blocked_identifiers) do
1098 blocked_identifiers,
1099 fn blocked_identifier ->
1100 with {:ok, %User{} = blocked} <- get_or_fetch(blocked_identifier),
1101 {:ok, blocker} <- block(blocker, blocked),
1102 {:ok, _} <- ActivityPub.block(blocker, blocked) do
1106 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
1113 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
1114 def perform(:follow_import, %User{} = follower, followed_identifiers)
1115 when is_list(followed_identifiers) do
1117 followed_identifiers,
1118 fn followed_identifier ->
1119 with {:ok, %User{} = followed} <- get_or_fetch(followed_identifier),
1120 {:ok, follower} <- maybe_direct_follow(follower, followed),
1121 {:ok, _} <- ActivityPub.follow(follower, followed) do
1125 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
1132 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers),
1134 PleromaJobQueue.enqueue(:background, __MODULE__, [
1140 def follow_import(%User{} = follower, followed_identifiers) when is_list(followed_identifiers),
1142 PleromaJobQueue.enqueue(:background, __MODULE__, [
1145 followed_identifiers
1148 def delete_user_activities(%User{ap_id: ap_id} = user) do
1151 |> Activity.query_by_actor()
1154 Repo.transaction(fn -> Enum.each(stream, &delete_activity(&1)) end, timeout: :infinity)
1159 defp delete_activity(%{data: %{"type" => "Create"}} = activity) do
1160 Object.normalize(activity) |> ActivityPub.delete()
1163 defp delete_activity(_activity), do: "Doing nothing"
1165 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1166 Pleroma.HTML.Scrubber.TwitterText
1169 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
1171 def html_filter_policy(_), do: @default_scrubbers
1173 def fetch_by_ap_id(ap_id) do
1174 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1181 case OStatus.make_user(ap_id) do
1182 {:ok, user} -> {:ok, user}
1183 _ -> {:error, "Could not fetch by AP id"}
1188 def get_or_fetch_by_ap_id(ap_id) do
1189 user = get_cached_by_ap_id(ap_id)
1191 if !is_nil(user) and !User.needs_update?(user) do
1194 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1195 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1197 resp = fetch_by_ap_id(ap_id)
1199 if should_fetch_initial do
1200 with {:ok, %User{} = user} <- resp do
1201 fetch_initial_posts(user)
1209 def get_or_create_instance_user do
1210 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1212 if user = get_cached_by_ap_id(relay_uri) do
1216 %User{info: %User.Info{}}
1217 |> cast(%{}, [:ap_id, :nickname, :local])
1218 |> put_change(:ap_id, relay_uri)
1219 |> put_change(:nickname, nil)
1220 |> put_change(:local, true)
1221 |> put_change(:follower_address, relay_uri <> "/followers")
1223 {:ok, user} = Repo.insert(changes)
1229 def public_key_from_info(%{
1230 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1234 |> :public_key.pem_decode()
1236 |> :public_key.pem_entry_decode()
1242 def public_key_from_info(%{magic_key: magic_key}) do
1243 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1246 def get_public_key_for_ap_id(ap_id) do
1247 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id),
1248 {:ok, public_key} <- public_key_from_info(user.info) do
1255 defp blank?(""), do: nil
1256 defp blank?(n), do: n
1258 def insert_or_update_user(data) do
1260 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1261 |> remote_user_creation()
1262 |> Repo.insert(on_conflict: :replace_all, conflict_target: :nickname)
1266 def ap_enabled?(%User{local: true}), do: true
1267 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1268 def ap_enabled?(_), do: false
1270 @doc "Gets or fetch a user by uri or nickname."
1271 @spec get_or_fetch(String.t()) :: {:ok, User.t()} | {:error, String.t()}
1272 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1273 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1275 # wait a period of time and return newest version of the User structs
1276 # this is because we have synchronous follow APIs and need to simulate them
1277 # with an async handshake
1278 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1279 with %User{} = a <- User.get_cached_by_id(a.id),
1280 %User{} = b <- User.get_cached_by_id(b.id) do
1288 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1289 with :ok <- :timer.sleep(timeout),
1290 %User{} = a <- User.get_cached_by_id(a.id),
1291 %User{} = b <- User.get_cached_by_id(b.id) do
1299 def parse_bio(bio) when is_binary(bio) and bio != "" do
1301 |> CommonUtils.format_input("text/plain", mentions_format: :full)
1305 def parse_bio(_), do: ""
1307 def parse_bio(bio, user) when is_binary(bio) and bio != "" do
1308 # TODO: get profile URLs other than user.ap_id
1309 profile_urls = [user.ap_id]
1312 |> CommonUtils.format_input("text/plain",
1313 mentions_format: :full,
1314 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1319 def parse_bio(_, _), do: ""
1321 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1322 Repo.transaction(fn ->
1323 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1327 def tag(nickname, tags) when is_binary(nickname),
1328 do: tag(get_by_nickname(nickname), tags)
1330 def tag(%User{} = user, tags),
1331 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1333 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1334 Repo.transaction(fn ->
1335 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1339 def untag(nickname, tags) when is_binary(nickname),
1340 do: untag(get_by_nickname(nickname), tags)
1342 def untag(%User{} = user, tags),
1343 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1345 defp update_tags(%User{} = user, new_tags) do
1346 {:ok, updated_user} =
1348 |> change(%{tags: new_tags})
1349 |> update_and_set_cache()
1354 defp normalize_tags(tags) do
1357 |> Enum.map(&String.downcase(&1))
1360 defp local_nickname_regex do
1361 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1362 @extended_local_nickname_regex
1364 @strict_local_nickname_regex
1368 def local_nickname(nickname_or_mention) do
1371 |> String.split("@")
1375 def full_nickname(nickname_or_mention),
1376 do: String.trim_leading(nickname_or_mention, "@")
1378 def error_user(ap_id) do
1383 nickname: "erroruser@example.com",
1384 inserted_at: NaiveDateTime.utc_now()
1388 @spec all_superusers() :: [User.t()]
1389 def all_superusers do
1390 User.Query.build(%{super_users: true, local: true, deactivated: false})
1394 def showing_reblogs?(%User{} = user, %User{} = target) do
1395 target.ap_id not in user.info.muted_reblogs
1398 @spec toggle_confirmation(User.t()) :: {:ok, User.t()} | {:error, Changeset.t()}
1399 def toggle_confirmation(%User{} = user) do
1400 need_confirmation? = !user.info.confirmation_pending
1403 User.Info.confirmation_changeset(user.info, need_confirmation: need_confirmation?)
1407 |> put_embed(:info, info_changeset)
1408 |> update_and_set_cache()
1411 def get_mascot(%{info: %{mascot: %{} = mascot}}) when not is_nil(mascot) do
1415 def get_mascot(%{info: %{mascot: mascot}}) when is_nil(mascot) do
1416 # use instance-default
1417 config = Pleroma.Config.get([:assets, :mascots])
1418 default_mascot = Pleroma.Config.get([:assets, :default_mascot])
1419 mascot = Keyword.get(config, default_mascot)
1422 "id" => "default-mascot",
1423 "url" => mascot[:url],
1424 "preview_url" => mascot[:url],
1426 "mime_type" => mascot[:mime_type]
1431 def ensure_keys_present(user) do
1437 {:ok, pem} = Keys.generate_rsa_pem()
1441 |> User.Info.set_keys(pem)
1444 Ecto.Changeset.change(user)
1445 |> Ecto.Changeset.put_embed(:info, info_cng)
1447 update_and_set_cache(cng)