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])
257 User.Query.build(%{nickname: candidates, local: true})
260 follow_all(user, autofollowed_users)
263 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
264 def register(%Ecto.Changeset{} = changeset) do
265 with {:ok, user} <- Repo.insert(changeset),
266 {:ok, user} <- autofollow_users(user),
267 {:ok, user} <- set_cache(user),
268 {:ok, _} <- Pleroma.User.WelcomeMessage.post_welcome_message_to_user(user),
269 {:ok, _} <- try_send_confirmation_email(user) do
274 def try_send_confirmation_email(%User{} = user) do
275 if user.info.confirmation_pending &&
276 Pleroma.Config.get([:instance, :account_activation_required]) do
278 |> Pleroma.Emails.UserEmail.account_confirmation_email()
279 |> Pleroma.Emails.Mailer.deliver_async()
287 def needs_update?(%User{local: true}), do: false
289 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
291 def needs_update?(%User{local: false} = user) do
292 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
295 def needs_update?(_), do: true
297 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
301 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
302 follow(follower, followed)
305 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
306 if not User.ap_enabled?(followed) do
307 follow(follower, followed)
313 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
314 if not following?(follower, followed) do
315 follow(follower, followed)
321 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
322 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
323 def follow_all(follower, followeds) do
326 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
327 |> Enum.map(fn %{follower_address: fa} -> fa end)
331 where: u.id == ^follower.id,
336 "array(select distinct unnest (array_cat(?, ?)))",
345 {1, [follower]} = Repo.update_all(q, [])
347 Enum.each(followeds, fn followed ->
348 update_follower_count(followed)
354 def follow(%User{} = follower, %User{info: info} = followed) do
355 user_config = Application.get_env(:pleroma, :user)
356 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
358 ap_followers = followed.follower_address
361 following?(follower, followed) or info.deactivated ->
362 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
364 deny_follow_blocked and blocks?(followed, follower) ->
365 {:error, "Could not follow user: #{followed.nickname} blocked you."}
368 if !followed.local && follower.local && !ap_enabled?(followed) do
369 Websub.subscribe(follower, followed)
374 where: u.id == ^follower.id,
375 update: [push: [following: ^ap_followers]],
379 {1, [follower]} = Repo.update_all(q, [])
381 {:ok, _} = update_follower_count(followed)
387 def unfollow(%User{} = follower, %User{} = followed) do
388 ap_followers = followed.follower_address
390 if following?(follower, followed) and follower.ap_id != followed.ap_id do
393 where: u.id == ^follower.id,
394 update: [pull: [following: ^ap_followers]],
398 {1, [follower]} = Repo.update_all(q, [])
400 {:ok, followed} = update_follower_count(followed)
404 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
406 {:error, "Not subscribed!"}
410 @spec following?(User.t(), User.t()) :: boolean
411 def following?(%User{} = follower, %User{} = followed) do
412 Enum.member?(follower.following, followed.follower_address)
415 def follow_import(%User{} = follower, followed_identifiers)
416 when is_list(followed_identifiers) do
418 followed_identifiers,
419 fn followed_identifier ->
420 with {:ok, %User{} = followed} <- get_or_fetch(followed_identifier),
421 {:ok, follower} <- maybe_direct_follow(follower, followed),
422 {:ok, _} <- ActivityPub.follow(follower, followed) do
426 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
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
555 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
560 _e -> {:error, "not found " <> nickname}
565 @doc "Fetch some posts when the user has just been federated with"
566 def fetch_initial_posts(user) do
567 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
570 # Insert all the posts in reverse order, so they're in the right order on the timeline
571 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
572 &Pleroma.Web.Federator.incoming_ap_doc/1
576 @spec get_followers_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
577 def get_followers_query(%User{} = user, nil) do
578 User.Query.build(%{followers: user})
581 def get_followers_query(user, page) do
582 from(u in get_followers_query(user, nil))
583 |> User.Query.paginate(page, 20)
586 @spec get_followers_query(User.t()) :: Ecto.Query.t()
587 def get_followers_query(user), do: get_followers_query(user, nil)
589 def get_followers(user, page \\ nil) do
590 q = get_followers_query(user, page)
595 def get_followers_ids(user, page \\ nil) do
596 q = get_followers_query(user, page)
598 Repo.all(from(u in q, select: u.id))
601 @spec get_friends_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
602 def get_friends_query(%User{} = user, nil) do
603 User.Query.build(%{friends: user})
606 def get_friends_query(user, page) do
607 from(u in get_friends_query(user, nil))
608 |> User.Query.paginate(page, 20)
611 @spec get_friends_query(User.t()) :: Ecto.Query.t()
612 def get_friends_query(user), do: get_friends_query(user, nil)
614 def get_friends(user, page \\ nil) do
615 q = get_friends_query(user, page)
620 def get_friends_ids(user, page \\ nil) do
621 q = get_friends_query(user, page)
623 Repo.all(from(u in q, select: u.id))
626 @spec get_follow_requests(User.t()) :: {:ok, [User.t()]}
627 def get_follow_requests(%User{} = user) do
629 Activity.follow_requests_for_actor(user)
630 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
631 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
632 |> group_by([a, u], u.id)
639 def increase_note_count(%User{} = user) do
641 |> where(id: ^user.id)
646 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
653 |> Repo.update_all([])
655 {1, [user]} -> set_cache(user)
660 def decrease_note_count(%User{} = user) do
662 |> where(id: ^user.id)
667 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
674 |> Repo.update_all([])
676 {1, [user]} -> set_cache(user)
681 def update_note_count(%User{} = user) do
685 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
689 note_count = Repo.one(note_count_query)
691 info_cng = User.Info.set_note_count(user.info, note_count)
695 |> put_embed(:info, info_cng)
697 update_and_set_cache(cng)
700 def update_follower_count(%User{} = user) do
701 follower_count_query =
702 User.Query.build(%{followers: user}) |> select([u], %{count: count(u.id)})
705 |> where(id: ^user.id)
706 |> join(:inner, [u], s in subquery(follower_count_query))
711 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
718 |> Repo.update_all([])
720 {1, [user]} -> set_cache(user)
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}
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})
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', ?)
836 defp trigram_search_subquery(term) do
840 # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
841 search_type: fragment("?", 1),
844 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
850 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
854 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
857 fn blocked_identifier ->
858 with {:ok, %User{} = blocked} <- get_or_fetch(blocked_identifier),
859 {:ok, blocker} <- block(blocker, blocked),
860 {:ok, _} <- ActivityPub.block(blocker, blocked) do
864 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
871 def mute(muter, %User{ap_id: ap_id}) do
874 |> User.Info.add_to_mutes(ap_id)
878 |> put_embed(:info, info_cng)
880 update_and_set_cache(cng)
883 def unmute(muter, %{ap_id: ap_id}) do
886 |> User.Info.remove_from_mutes(ap_id)
890 |> put_embed(:info, info_cng)
892 update_and_set_cache(cng)
895 def subscribe(subscriber, %{ap_id: ap_id}) do
896 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
898 with %User{} = subscribed <- get_cached_by_ap_id(ap_id) do
899 blocked = blocks?(subscribed, subscriber) and deny_follow_blocked
902 {:error, "Could not subscribe: #{subscribed.nickname} is blocking you"}
906 |> User.Info.add_to_subscribers(subscriber.ap_id)
909 |> put_embed(:info, info_cng)
910 |> update_and_set_cache()
915 def unsubscribe(unsubscriber, %{ap_id: ap_id}) do
916 with %User{} = user <- get_cached_by_ap_id(ap_id) do
919 |> User.Info.remove_from_subscribers(unsubscriber.ap_id)
922 |> put_embed(:info, info_cng)
923 |> update_and_set_cache()
927 def block(blocker, %User{ap_id: ap_id} = blocked) do
928 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
930 if following?(blocker, blocked) do
931 {:ok, blocker, _} = unfollow(blocker, blocked)
938 if subscribed_to?(blocked, blocker) do
939 {:ok, blocker} = unsubscribe(blocked, blocker)
945 if following?(blocked, blocker) do
946 unfollow(blocked, blocker)
949 {:ok, blocker} = update_follower_count(blocker)
953 |> User.Info.add_to_block(ap_id)
957 |> put_embed(:info, info_cng)
959 update_and_set_cache(cng)
962 # helper to handle the block given only an actor's AP id
963 def block(blocker, %{ap_id: ap_id}) do
964 block(blocker, get_cached_by_ap_id(ap_id))
967 def unblock(blocker, %{ap_id: ap_id}) do
970 |> User.Info.remove_from_block(ap_id)
974 |> put_embed(:info, info_cng)
976 update_and_set_cache(cng)
979 def mutes?(nil, _), do: false
980 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
982 def blocks?(user, %{ap_id: ap_id}) do
983 blocks = user.info.blocks
984 domain_blocks = user.info.domain_blocks
985 %{host: host} = URI.parse(ap_id)
987 Enum.member?(blocks, ap_id) ||
988 Enum.any?(domain_blocks, fn domain ->
993 def subscribed_to?(user, %{ap_id: ap_id}) do
994 with %User{} = target <- get_cached_by_ap_id(ap_id) do
995 Enum.member?(target.info.subscribers, user.ap_id)
999 @spec muted_users(User.t()) :: [User.t()]
1000 def muted_users(user) do
1001 User.Query.build(%{ap_id: user.info.mutes})
1005 @spec blocked_users(User.t()) :: [User.t()]
1006 def blocked_users(user) do
1007 User.Query.build(%{ap_id: user.info.blocks})
1011 @spec subscribers(User.t()) :: [User.t()]
1012 def subscribers(user) do
1013 User.Query.build(%{ap_id: user.info.subscribers})
1017 def block_domain(user, domain) do
1020 |> User.Info.add_to_domain_block(domain)
1024 |> put_embed(:info, info_cng)
1026 update_and_set_cache(cng)
1029 def unblock_domain(user, domain) do
1032 |> User.Info.remove_from_domain_block(domain)
1036 |> put_embed(:info, info_cng)
1038 update_and_set_cache(cng)
1041 def deactivate(%User{} = user, status \\ true) do
1042 info_cng = User.Info.set_activation_status(user.info, status)
1046 |> put_embed(:info, info_cng)
1048 update_and_set_cache(cng)
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 def delete_user_activities(%User{ap_id: ap_id} = user) do
1082 |> Activity.query_by_actor()
1083 |> Activity.with_preloaded_object()
1086 Repo.transaction(fn -> Enum.each(stream, &delete_activity(&1)) end, timeout: :infinity)
1091 defp delete_activity(%{data: %{"type" => "Create"}} = activity) do
1092 Object.normalize(activity) |> ActivityPub.delete()
1095 defp delete_activity(_activity), do: "Doing nothing"
1097 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1098 Pleroma.HTML.Scrubber.TwitterText
1101 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
1103 def html_filter_policy(_), do: @default_scrubbers
1105 def fetch_by_ap_id(ap_id) do
1106 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1113 case OStatus.make_user(ap_id) do
1114 {:ok, user} -> {:ok, user}
1115 _ -> {:error, "Could not fetch by AP id"}
1120 def get_or_fetch_by_ap_id(ap_id) do
1121 user = get_cached_by_ap_id(ap_id)
1123 if !is_nil(user) and !User.needs_update?(user) do
1126 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1127 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1129 resp = fetch_by_ap_id(ap_id)
1131 if should_fetch_initial do
1132 with {:ok, %User{} = user} = resp do
1133 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
1141 def get_or_create_instance_user do
1142 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1144 if user = get_cached_by_ap_id(relay_uri) do
1148 %User{info: %User.Info{}}
1149 |> cast(%{}, [:ap_id, :nickname, :local])
1150 |> put_change(:ap_id, relay_uri)
1151 |> put_change(:nickname, nil)
1152 |> put_change(:local, true)
1153 |> put_change(:follower_address, relay_uri <> "/followers")
1155 {:ok, user} = Repo.insert(changes)
1161 def public_key_from_info(%{
1162 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1166 |> :public_key.pem_decode()
1168 |> :public_key.pem_entry_decode()
1174 def public_key_from_info(%{magic_key: magic_key}) do
1175 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1178 def get_public_key_for_ap_id(ap_id) do
1179 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id),
1180 {:ok, public_key} <- public_key_from_info(user.info) do
1187 defp blank?(""), do: nil
1188 defp blank?(n), do: n
1190 def insert_or_update_user(data) do
1192 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1193 |> remote_user_creation()
1194 |> Repo.insert(on_conflict: :replace_all, conflict_target: :nickname)
1198 def ap_enabled?(%User{local: true}), do: true
1199 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1200 def ap_enabled?(_), do: false
1202 @doc "Gets or fetch a user by uri or nickname."
1203 @spec get_or_fetch(String.t()) :: {:ok, User.t()} | {:error, String.t()}
1204 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1205 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1207 # wait a period of time and return newest version of the User structs
1208 # this is because we have synchronous follow APIs and need to simulate them
1209 # with an async handshake
1210 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1211 with %User{} = a <- User.get_cached_by_id(a.id),
1212 %User{} = b <- User.get_cached_by_id(b.id) do
1220 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1221 with :ok <- :timer.sleep(timeout),
1222 %User{} = a <- User.get_cached_by_id(a.id),
1223 %User{} = b <- User.get_cached_by_id(b.id) do
1231 def parse_bio(bio) when is_binary(bio) and bio != "" do
1233 |> CommonUtils.format_input("text/plain", mentions_format: :full)
1237 def parse_bio(_), do: ""
1239 def parse_bio(bio, user) when is_binary(bio) and bio != "" do
1240 # TODO: get profile URLs other than user.ap_id
1241 profile_urls = [user.ap_id]
1244 |> CommonUtils.format_input("text/plain",
1245 mentions_format: :full,
1246 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1251 def parse_bio(_, _), do: ""
1253 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1254 Repo.transaction(fn ->
1255 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1259 def tag(nickname, tags) when is_binary(nickname),
1260 do: tag(get_by_nickname(nickname), tags)
1262 def tag(%User{} = user, tags),
1263 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1265 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1266 Repo.transaction(fn ->
1267 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1271 def untag(nickname, tags) when is_binary(nickname),
1272 do: untag(get_by_nickname(nickname), tags)
1274 def untag(%User{} = user, tags),
1275 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1277 defp update_tags(%User{} = user, new_tags) do
1278 {:ok, updated_user} =
1280 |> change(%{tags: new_tags})
1281 |> update_and_set_cache()
1286 defp normalize_tags(tags) do
1289 |> Enum.map(&String.downcase(&1))
1292 defp local_nickname_regex do
1293 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1294 @extended_local_nickname_regex
1296 @strict_local_nickname_regex
1300 def local_nickname(nickname_or_mention) do
1303 |> String.split("@")
1307 def full_nickname(nickname_or_mention),
1308 do: String.trim_leading(nickname_or_mention, "@")
1310 def error_user(ap_id) do
1315 nickname: "erroruser@example.com",
1316 inserted_at: NaiveDateTime.utc_now()
1320 @spec all_superusers() :: [User.t()]
1321 def all_superusers do
1322 User.Query.build(%{super_users: true, local: true})
1326 def showing_reblogs?(%User{} = user, %User{} = target) do
1327 target.ap_id not in user.info.muted_reblogs