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.Formatter
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(:bookmarks, {:array, :string}, default: [])
57 field(:last_refreshed_at, :naive_datetime_usec)
58 has_many(:notifications, Notification)
59 has_many(:registrations, Registration)
60 embeds_one(:info, Pleroma.User.Info)
65 def auth_active?(%User{info: %User.Info{confirmation_pending: true}}),
66 do: !Pleroma.Config.get([:instance, :account_activation_required])
68 def auth_active?(%User{}), do: true
70 def visible_for?(user, for_user \\ nil)
72 def visible_for?(%User{id: user_id}, %User{id: for_id}) when user_id == for_id, do: true
74 def visible_for?(%User{} = user, for_user) do
75 auth_active?(user) || superuser?(for_user)
78 def visible_for?(_, _), do: false
80 def superuser?(%User{local: true, info: %User.Info{is_admin: true}}), do: true
81 def superuser?(%User{local: true, info: %User.Info{is_moderator: true}}), do: true
82 def superuser?(_), do: false
84 def avatar_url(user, options \\ []) do
86 %{"url" => [%{"href" => href} | _]} -> href
87 _ -> !options[:no_default] && "#{Web.base_url()}/images/avi.png"
91 def banner_url(user, options \\ []) do
92 case user.info.banner do
93 %{"url" => [%{"href" => href} | _]} -> href
94 _ -> !options[:no_default] && "#{Web.base_url()}/images/banner.png"
98 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
99 def profile_url(%User{ap_id: ap_id}), do: ap_id
100 def profile_url(_), do: nil
102 def ap_id(%User{nickname: nickname}) do
103 "#{Web.base_url()}/users/#{nickname}"
106 def ap_followers(%User{follower_address: fa}) when is_binary(fa), do: fa
107 def ap_followers(%User{} = user), do: "#{ap_id(user)}/followers"
109 def user_info(%User{} = user) do
111 following_count: following_count(user),
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 defp restrict_deactivated(query) do
122 where: not fragment("? \\? 'deactivated' AND ?->'deactivated' @> 'true'", u.info, u.info)
126 def following_count(%User{following: []}), do: 0
128 def following_count(%User{following: following, id: id}) do
130 where: u.follower_address in ^following,
133 |> restrict_deactivated()
134 |> Repo.aggregate(:count, :id)
137 def remote_user_creation(params) do
140 |> Map.put(:info, params[:info] || %{})
142 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
146 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
147 |> validate_required([:name, :ap_id])
148 |> unique_constraint(:nickname)
149 |> validate_format(:nickname, @email_regex)
150 |> validate_length(:bio, max: 5000)
151 |> validate_length(:name, max: 100)
152 |> put_change(:local, false)
153 |> put_embed(:info, info_cng)
156 case info_cng.changes[:source_data] do
157 %{"followers" => followers} ->
159 |> put_change(:follower_address, followers)
162 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
165 |> put_change(:follower_address, followers)
172 def update_changeset(struct, params \\ %{}) do
174 |> cast(params, [:bio, :name, :avatar])
175 |> unique_constraint(:nickname)
176 |> validate_format(:nickname, local_nickname_regex())
177 |> validate_length(:bio, max: 5000)
178 |> validate_length(:name, min: 1, max: 100)
181 def upgrade_changeset(struct, params \\ %{}) do
184 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
188 |> User.Info.user_upgrade(params[:info])
191 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
192 |> unique_constraint(:nickname)
193 |> validate_format(:nickname, local_nickname_regex())
194 |> validate_length(:bio, max: 5000)
195 |> validate_length(:name, max: 100)
196 |> put_embed(:info, info_cng)
199 def password_update_changeset(struct, params) do
202 |> cast(params, [:password, :password_confirmation])
203 |> validate_required([:password, :password_confirmation])
204 |> validate_confirmation(:password)
206 OAuth.Token.delete_user_tokens(struct)
207 OAuth.Authorization.delete_user_authorizations(struct)
209 if changeset.valid? do
210 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
213 |> put_change(:password_hash, hashed)
219 def reset_password(user, data) do
220 update_and_set_cache(password_update_changeset(user, data))
223 def register_changeset(struct, params \\ %{}, opts \\ []) do
224 confirmation_status =
225 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
231 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
235 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
236 |> validate_required([:name, :nickname, :password, :password_confirmation])
237 |> validate_confirmation(:password)
238 |> unique_constraint(:email)
239 |> unique_constraint(:nickname)
240 |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
241 |> validate_format(:nickname, local_nickname_regex())
242 |> validate_format(:email, @email_regex)
243 |> validate_length(:bio, max: 1000)
244 |> validate_length(:name, min: 1, max: 100)
245 |> put_change(:info, info_change)
248 if opts[:external] do
251 validate_required(changeset, [:email])
254 if changeset.valid? do
255 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
256 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
257 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
260 |> put_change(:password_hash, hashed)
261 |> put_change(:ap_id, ap_id)
262 |> unique_constraint(:ap_id)
263 |> put_change(:following, [followers])
264 |> put_change(:follower_address, followers)
270 defp autofollow_users(user) do
271 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
275 where: u.local == true,
276 where: u.nickname in ^candidates
280 follow_all(user, autofollowed_users)
283 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
284 def register(%Ecto.Changeset{} = changeset) do
285 with {:ok, user} <- Repo.insert(changeset),
286 {:ok, user} <- autofollow_users(user),
287 {:ok, user} <- set_cache(user),
288 {:ok, _} <- Pleroma.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 user_config = Application.get_env(:pleroma, :user)
376 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
378 ap_followers = followed.follower_address
381 following?(follower, followed) or info.deactivated ->
382 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
384 deny_follow_blocked and blocks?(followed, follower) ->
385 {:error, "Could not follow user: #{followed.nickname} blocked you."}
388 if !followed.local && follower.local && !ap_enabled?(followed) do
389 Websub.subscribe(follower, followed)
394 where: u.id == ^follower.id,
395 update: [push: [following: ^ap_followers]],
399 {1, [follower]} = Repo.update_all(q, [])
401 {:ok, _} = update_follower_count(followed)
407 def unfollow(%User{} = follower, %User{} = followed) do
408 ap_followers = followed.follower_address
410 if following?(follower, followed) and follower.ap_id != followed.ap_id do
413 where: u.id == ^follower.id,
414 update: [pull: [following: ^ap_followers]],
418 {1, [follower]} = Repo.update_all(q, [])
420 {:ok, followed} = update_follower_count(followed)
424 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
426 {:error, "Not subscribed!"}
430 @spec following?(User.t(), User.t()) :: boolean
431 def following?(%User{} = follower, %User{} = followed) do
432 Enum.member?(follower.following, followed.follower_address)
435 def follow_import(%User{} = follower, followed_identifiers)
436 when is_list(followed_identifiers) do
438 followed_identifiers,
439 fn followed_identifier ->
440 with %User{} = followed <- get_or_fetch(followed_identifier),
441 {:ok, follower} <- maybe_direct_follow(follower, followed),
442 {:ok, _} <- ActivityPub.follow(follower, followed) do
446 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
453 def locked?(%User{} = user) do
454 user.info.locked || false
458 Repo.get_by(User, id: id)
461 def get_by_ap_id(ap_id) do
462 Repo.get_by(User, ap_id: ap_id)
465 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
466 # of the ap_id and the domain and tries to get that user
467 def get_by_guessed_nickname(ap_id) do
468 domain = URI.parse(ap_id).host
469 name = List.last(String.split(ap_id, "/"))
470 nickname = "#{name}@#{domain}"
472 get_cached_by_nickname(nickname)
475 def set_cache({:ok, user}), do: set_cache(user)
476 def set_cache({:error, err}), do: {:error, err}
478 def set_cache(%User{} = user) do
479 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
480 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
481 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
485 def update_and_set_cache(changeset) do
486 with {:ok, user} <- Repo.update(changeset) do
493 def invalidate_cache(user) do
494 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
495 Cachex.del(:user_cache, "nickname:#{user.nickname}")
496 Cachex.del(:user_cache, "user_info:#{user.id}")
499 def get_cached_by_ap_id(ap_id) do
500 key = "ap_id:#{ap_id}"
501 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
504 def get_cached_by_id(id) do
508 Cachex.fetch!(:user_cache, key, fn _ ->
512 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
513 {:commit, user.ap_id}
519 get_cached_by_ap_id(ap_id)
522 def get_cached_by_nickname(nickname) do
523 key = "nickname:#{nickname}"
524 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
527 def get_cached_by_nickname_or_id(nickname_or_id) do
528 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
531 def get_by_nickname(nickname) do
532 Repo.get_by(User, nickname: nickname) ||
533 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
534 Repo.get_by(User, nickname: local_nickname(nickname))
538 def get_by_email(email), do: Repo.get_by(User, email: email)
540 def get_by_nickname_or_email(nickname_or_email) do
541 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
544 def get_cached_user_info(user) do
545 key = "user_info:#{user.id}"
546 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
549 def fetch_by_nickname(nickname) do
550 ap_try = ActivityPub.make_user_from_nickname(nickname)
553 {:ok, user} -> {:ok, user}
554 _ -> OStatus.make_user(nickname)
558 def get_or_fetch_by_nickname(nickname) do
559 with %User{} = user <- get_by_nickname(nickname) do
563 with [_nick, _domain] <- String.split(nickname, "@"),
564 {:ok, user} <- fetch_by_nickname(nickname) do
565 if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
567 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
577 @doc "Fetch some posts when the user has just been federated with"
578 def fetch_initial_posts(user) do
579 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
582 # Insert all the posts in reverse order, so they're in the right order on the timeline
583 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
584 &Pleroma.Web.Federator.incoming_ap_doc/1
588 def get_followers_query(%User{id: id, follower_address: follower_address}, nil) do
591 where: fragment("? <@ ?", ^[follower_address], u.following),
594 |> restrict_deactivated()
597 def get_followers_query(user, page) do
598 from(u in get_followers_query(user, nil))
599 |> paginate(page, 20)
602 def get_followers_query(user), do: get_followers_query(user, nil)
604 def get_followers(user, page \\ nil) do
605 q = get_followers_query(user, page)
610 def get_followers_ids(user, page \\ nil) do
611 q = get_followers_query(user, page)
613 Repo.all(from(u in q, select: u.id))
616 def get_friends_query(%User{id: id, following: following}, nil) do
619 where: u.follower_address in ^following,
622 |> restrict_deactivated()
625 def get_friends_query(user, page) do
626 from(u in get_friends_query(user, nil))
627 |> paginate(page, 20)
630 def get_friends_query(user), do: get_friends_query(user, nil)
632 def get_friends(user, page \\ nil) do
633 q = get_friends_query(user, page)
638 def get_friends_ids(user, page \\ nil) do
639 q = get_friends_query(user, page)
641 Repo.all(from(u in q, select: u.id))
644 def get_follow_requests_query(%User{} = user) do
649 "? ->> 'type' = 'Follow'",
654 "? ->> 'state' = 'pending'",
659 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
667 def get_follow_requests(%User{} = user) do
670 |> User.get_follow_requests_query()
671 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
672 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
673 |> group_by([a, u], u.id)
680 def increase_note_count(%User{} = user) do
682 |> where(id: ^user.id)
687 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
694 |> Repo.update_all([])
696 {1, [user]} -> set_cache(user)
701 def decrease_note_count(%User{} = user) do
703 |> where(id: ^user.id)
708 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
715 |> Repo.update_all([])
717 {1, [user]} -> set_cache(user)
722 def update_note_count(%User{} = user) do
726 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
730 note_count = Repo.one(note_count_query)
732 info_cng = User.Info.set_note_count(user.info, note_count)
736 |> put_embed(:info, info_cng)
737 |> update_and_set_cache()
740 def update_follower_count(%User{} = user) do
741 follower_count_query =
743 |> where([u], ^user.follower_address in u.following)
744 |> where([u], u.id != ^user.id)
745 |> select([u], %{count: count(u.id)})
746 |> restrict_deactivated()
749 |> where(id: ^user.id)
750 |> join(:inner, [u], s in subquery(follower_count_query))
755 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
762 |> Repo.update_all([])
764 {1, [user]} -> set_cache(user)
769 def get_users_from_set_query(ap_ids, false) do
772 where: u.ap_id in ^ap_ids
776 def get_users_from_set_query(ap_ids, true) do
777 query = get_users_from_set_query(ap_ids, false)
781 where: u.local == true
785 def get_users_from_set(ap_ids, local_only \\ true) do
786 get_users_from_set_query(ap_ids, local_only)
790 def get_recipients_from_activity(%Activity{recipients: to}) do
794 where: u.ap_id in ^to,
795 or_where: fragment("? && ?", u.following, ^to)
798 query = from(u in query, where: u.local == true)
803 def search(query, resolve \\ false, for_user \\ nil) do
804 # Strip the beginning @ off if there is a query
805 query = String.trim_leading(query, "@")
807 if resolve, do: get_or_fetch(query)
810 Repo.transaction(fn ->
811 Ecto.Adapters.SQL.query(Repo, "select set_limit(0.25)", [])
812 Repo.all(search_query(query, for_user))
818 def search_query(query, for_user) do
819 fts_subquery = fts_search_subquery(query)
820 trigram_subquery = trigram_search_subquery(query)
821 union_query = from(s in trigram_subquery, union_all: ^fts_subquery)
822 distinct_query = from(s in subquery(union_query), order_by: s.search_type, distinct: s.id)
824 from(s in subquery(boost_search_rank_query(distinct_query, for_user)),
825 order_by: [desc: s.search_rank],
830 defp boost_search_rank_query(query, nil), do: query
832 defp boost_search_rank_query(query, for_user) do
833 friends_ids = get_friends_ids(for_user)
834 followers_ids = get_followers_ids(for_user)
836 from(u in subquery(query),
841 CASE WHEN (?) THEN (?) * 1.3
842 WHEN (?) THEN (?) * 1.2
843 WHEN (?) THEN (?) * 1.1
846 u.id in ^friends_ids and u.id in ^followers_ids,
848 u.id in ^friends_ids,
850 u.id in ^followers_ids,
858 defp fts_search_subquery(term, query \\ User) do
861 |> String.replace(~r/\W+/, " ")
864 |> Enum.map(&(&1 <> ":*"))
875 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
876 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
877 to_tsquery('simple', ?),
889 (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
890 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
897 |> restrict_deactivated()
900 defp trigram_search_subquery(term) do
904 # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
905 search_type: fragment("?", 1),
908 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
914 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
916 |> restrict_deactivated()
919 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
922 fn blocked_identifier ->
923 with %User{} = blocked <- get_or_fetch(blocked_identifier),
924 {:ok, blocker} <- block(blocker, blocked),
925 {:ok, _} <- ActivityPub.block(blocker, blocked) do
929 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
936 def mute(muter, %User{ap_id: ap_id}) do
939 |> User.Info.add_to_mutes(ap_id)
943 |> put_embed(:info, info_cng)
945 update_and_set_cache(cng)
948 def unmute(muter, %{ap_id: ap_id}) do
951 |> User.Info.remove_from_mutes(ap_id)
955 |> put_embed(:info, info_cng)
957 update_and_set_cache(cng)
960 def subscribe(subscriber, %{ap_id: ap_id}) do
961 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
963 with %User{} = subscribed <- get_cached_by_ap_id(ap_id) do
964 blocked = blocks?(subscribed, subscriber) and deny_follow_blocked
967 {:error, "Could not subscribe: #{subscribed.nickname} is blocking you"}
971 |> User.Info.add_to_subscribers(subscriber.ap_id)
974 |> put_embed(:info, info_cng)
975 |> update_and_set_cache()
980 def unsubscribe(unsubscriber, %{ap_id: ap_id}) do
981 with %User{} = user <- get_cached_by_ap_id(ap_id) do
984 |> User.Info.remove_from_subscribers(unsubscriber.ap_id)
987 |> put_embed(:info, info_cng)
988 |> update_and_set_cache()
992 def block(blocker, %User{ap_id: ap_id} = blocked) do
993 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
995 if following?(blocker, blocked) do
996 {:ok, blocker, _} = unfollow(blocker, blocked)
1003 if subscribed_to?(blocked, blocker) do
1004 {:ok, blocker} = unsubscribe(blocked, blocker)
1010 if following?(blocked, blocker) do
1011 unfollow(blocked, blocker)
1014 {:ok, blocker} = update_follower_count(blocker)
1018 |> User.Info.add_to_block(ap_id)
1022 |> put_embed(:info, info_cng)
1024 update_and_set_cache(cng)
1027 # helper to handle the block given only an actor's AP id
1028 def block(blocker, %{ap_id: ap_id}) do
1029 block(blocker, get_cached_by_ap_id(ap_id))
1032 def unblock(blocker, %{ap_id: ap_id}) do
1035 |> User.Info.remove_from_block(ap_id)
1039 |> put_embed(:info, info_cng)
1041 update_and_set_cache(cng)
1044 def mutes?(nil, _), do: false
1045 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
1047 def blocks?(user, %{ap_id: ap_id}) do
1048 blocks = user.info.blocks
1049 domain_blocks = user.info.domain_blocks
1050 %{host: host} = URI.parse(ap_id)
1052 Enum.member?(blocks, ap_id) ||
1053 Enum.any?(domain_blocks, fn domain ->
1058 def subscribed_to?(user, %{ap_id: ap_id}) do
1059 with %User{} = target <- get_cached_by_ap_id(ap_id) do
1060 Enum.member?(target.info.subscribers, user.ap_id)
1064 def muted_users(user),
1065 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.mutes))
1067 def blocked_users(user),
1068 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
1070 def subscribers(user),
1071 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.subscribers))
1073 def block_domain(user, domain) do
1076 |> User.Info.add_to_domain_block(domain)
1080 |> put_embed(:info, info_cng)
1082 update_and_set_cache(cng)
1085 def unblock_domain(user, domain) do
1088 |> User.Info.remove_from_domain_block(domain)
1092 |> put_embed(:info, info_cng)
1094 update_and_set_cache(cng)
1097 def maybe_local_user_query(query, local) do
1098 if local, do: local_user_query(query), else: query
1101 def local_user_query(query \\ User) do
1104 where: u.local == true,
1105 where: not is_nil(u.nickname)
1109 def maybe_external_user_query(query, external) do
1110 if external, do: external_user_query(query), else: query
1113 def external_user_query(query \\ User) do
1116 where: u.local == false,
1117 where: not is_nil(u.nickname)
1121 def maybe_active_user_query(query, active) do
1122 if active, do: active_user_query(query), else: query
1125 def active_user_query(query \\ User) do
1128 where: fragment("not (?->'deactivated' @> 'true')", u.info),
1129 where: not is_nil(u.nickname)
1133 def maybe_deactivated_user_query(query, deactivated) do
1134 if deactivated, do: deactivated_user_query(query), else: query
1137 def deactivated_user_query(query \\ User) do
1140 where: fragment("(?->'deactivated' @> 'true')", u.info),
1141 where: not is_nil(u.nickname)
1145 def active_local_user_query do
1147 u in local_user_query(),
1148 where: fragment("not (?->'deactivated' @> 'true')", u.info)
1152 def moderator_user_query do
1155 where: u.local == true,
1156 where: fragment("?->'is_moderator' @> 'true'", u.info)
1160 def deactivate_async(user, status \\ true) do
1161 PleromaJobQueue.enqueue(:user, __MODULE__, [:deactivate_async, user, status])
1164 def perform(:deactivate_async, user, status), do: deactivate(user, status)
1166 def deactivate(%User{} = user, status \\ true) do
1167 info_cng = User.Info.set_activation_status(user.info, status)
1169 with {:ok, friends} <- User.get_friends(user),
1170 {:ok, followers} <- User.get_followers(user),
1174 |> put_embed(:info, info_cng)
1175 |> update_and_set_cache() do
1176 Enum.each(followers, &invalidate_cache(&1))
1177 Enum.each(friends, &update_follower_count(&1))
1183 def update_notification_settings(%User{} = user, settings \\ %{}) do
1184 info_changeset = User.Info.update_notification_settings(user.info, settings)
1187 |> put_embed(:info, info_changeset)
1188 |> update_and_set_cache()
1191 def delete(%User{} = user) do
1192 {:ok, user} = User.deactivate(user)
1194 # Remove all relationships
1195 {:ok, followers} = User.get_followers(user)
1197 Enum.each(followers, fn follower -> User.unfollow(follower, user) end)
1199 {:ok, friends} = User.get_friends(user)
1201 Enum.each(friends, fn followed -> User.unfollow(user, followed) end)
1203 delete_user_activities(user)
1206 def delete_user_activities(%User{ap_id: ap_id} = user) do
1208 |> where(actor: ^ap_id)
1209 |> Activity.with_preloaded_object()
1212 %{data: %{"type" => "Create"}} = activity ->
1213 activity |> Object.normalize() |> ActivityPub.delete()
1215 # TODO: Do something with likes, follows, repeats.
1223 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1224 Pleroma.HTML.Scrubber.TwitterText
1227 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
1229 def html_filter_policy(_), do: @default_scrubbers
1231 def fetch_by_ap_id(ap_id) do
1232 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1239 case OStatus.make_user(ap_id) do
1241 _ -> {:error, "Could not fetch by AP id"}
1246 def get_or_fetch_by_ap_id(ap_id) do
1247 user = get_cached_by_ap_id(ap_id)
1249 if !is_nil(user) and !User.needs_update?(user) do
1252 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1253 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1255 user = fetch_by_ap_id(ap_id)
1257 if should_fetch_initial do
1258 with %User{} = user do
1259 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
1267 def get_or_create_instance_user do
1268 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1270 if user = get_cached_by_ap_id(relay_uri) do
1274 %User{info: %User.Info{}}
1275 |> cast(%{}, [:ap_id, :nickname, :local])
1276 |> put_change(:ap_id, relay_uri)
1277 |> put_change(:nickname, nil)
1278 |> put_change(:local, true)
1279 |> put_change(:follower_address, relay_uri <> "/followers")
1281 {:ok, user} = Repo.insert(changes)
1287 def public_key_from_info(%{
1288 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1292 |> :public_key.pem_decode()
1294 |> :public_key.pem_entry_decode()
1300 def public_key_from_info(%{magic_key: magic_key}) do
1301 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1304 def get_public_key_for_ap_id(ap_id) do
1305 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
1306 {:ok, public_key} <- public_key_from_info(user.info) do
1313 defp blank?(""), do: nil
1314 defp blank?(n), do: n
1316 def insert_or_update_user(data) do
1318 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1319 |> remote_user_creation()
1320 |> Repo.insert(on_conflict: :replace_all, conflict_target: :nickname)
1324 def ap_enabled?(%User{local: true}), do: true
1325 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1326 def ap_enabled?(_), do: false
1328 @doc "Gets or fetch a user by uri or nickname."
1329 @spec get_or_fetch(String.t()) :: User.t()
1330 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1331 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1333 # wait a period of time and return newest version of the User structs
1334 # this is because we have synchronous follow APIs and need to simulate them
1335 # with an async handshake
1336 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1337 with %User{} = a <- User.get_cached_by_id(a.id),
1338 %User{} = b <- User.get_cached_by_id(b.id) do
1346 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1347 with :ok <- :timer.sleep(timeout),
1348 %User{} = a <- User.get_cached_by_id(a.id),
1349 %User{} = b <- User.get_cached_by_id(b.id) do
1357 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
1358 def parse_bio(nil, _user), do: ""
1359 def parse_bio(bio, _user) when bio == "", do: bio
1361 def parse_bio(bio, user) do
1363 (user.info.source_data["tag"] || [])
1364 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
1365 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
1366 {String.trim(name, ":"), url}
1369 # TODO: get profile URLs other than user.ap_id
1370 profile_urls = [user.ap_id]
1373 |> CommonUtils.format_input("text/plain",
1374 mentions_format: :full,
1375 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1378 |> Formatter.emojify(emoji)
1381 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1382 Repo.transaction(fn ->
1383 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1387 def tag(nickname, tags) when is_binary(nickname),
1388 do: tag(get_by_nickname(nickname), tags)
1390 def tag(%User{} = user, tags),
1391 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1393 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1394 Repo.transaction(fn ->
1395 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1399 def untag(nickname, tags) when is_binary(nickname),
1400 do: untag(get_by_nickname(nickname), tags)
1402 def untag(%User{} = user, tags),
1403 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1405 defp update_tags(%User{} = user, new_tags) do
1406 {:ok, updated_user} =
1408 |> change(%{tags: new_tags})
1409 |> update_and_set_cache()
1414 def bookmark(%User{} = user, status_id) do
1415 bookmarks = Enum.uniq(user.bookmarks ++ [status_id])
1416 update_bookmarks(user, bookmarks)
1419 def unbookmark(%User{} = user, status_id) do
1420 bookmarks = Enum.uniq(user.bookmarks -- [status_id])
1421 update_bookmarks(user, bookmarks)
1424 def update_bookmarks(%User{} = user, bookmarks) do
1426 |> change(%{bookmarks: bookmarks})
1427 |> update_and_set_cache
1430 defp normalize_tags(tags) do
1433 |> Enum.map(&String.downcase(&1))
1436 defp local_nickname_regex do
1437 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1438 @extended_local_nickname_regex
1440 @strict_local_nickname_regex
1444 def local_nickname(nickname_or_mention) do
1447 |> String.split("@")
1451 def full_nickname(nickname_or_mention),
1452 do: String.trim_leading(nickname_or_mention, "@")
1454 def error_user(ap_id) do
1459 nickname: "erroruser@example.com",
1460 inserted_at: NaiveDateTime.utc_now()
1464 def all_superusers do
1467 where: u.local == true,
1468 where: fragment("?->'is_admin' @> 'true' OR ?->'is_moderator' @> 'true'", u.info, u.info)
1473 defp paginate(query, page, page_size) do
1476 offset: ^((page - 1) * page_size)
1480 def showing_reblogs?(%User{} = user, %User{} = target) do
1481 target.ap_id not in user.info.muted_reblogs