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, _} <- Pleroma.User.WelcomeMessage.post_welcome_message_to_user(user),
288 {:ok, _} <- try_send_confirmation_email(user) do
293 def try_send_confirmation_email(%User{} = user) do
294 if user.info.confirmation_pending &&
295 Pleroma.Config.get([:instance, :account_activation_required]) do
297 |> Pleroma.Emails.UserEmail.account_confirmation_email()
298 |> Pleroma.Emails.Mailer.deliver_async()
306 def needs_update?(%User{local: true}), do: false
308 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
310 def needs_update?(%User{local: false} = user) do
311 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
314 def needs_update?(_), do: true
316 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
320 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
321 follow(follower, followed)
324 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
325 if not User.ap_enabled?(followed) do
326 follow(follower, followed)
332 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
333 if not following?(follower, followed) do
334 follow(follower, followed)
340 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
341 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
342 def follow_all(follower, followeds) do
345 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
346 |> Enum.map(fn %{follower_address: fa} -> fa end)
350 where: u.id == ^follower.id,
355 "array(select distinct unnest (array_cat(?, ?)))",
364 {1, [follower]} = Repo.update_all(q, [])
366 Enum.each(followeds, fn followed ->
367 update_follower_count(followed)
373 def follow(%User{} = follower, %User{info: info} = followed) do
374 user_config = Application.get_env(:pleroma, :user)
375 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
377 ap_followers = followed.follower_address
380 following?(follower, followed) or info.deactivated ->
381 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
383 deny_follow_blocked and blocks?(followed, follower) ->
384 {:error, "Could not follow user: #{followed.nickname} blocked you."}
387 if !followed.local && follower.local && !ap_enabled?(followed) do
388 Websub.subscribe(follower, followed)
393 where: u.id == ^follower.id,
394 update: [push: [following: ^ap_followers]],
398 {1, [follower]} = Repo.update_all(q, [])
400 {:ok, _} = update_follower_count(followed)
406 def unfollow(%User{} = follower, %User{} = followed) do
407 ap_followers = followed.follower_address
409 if following?(follower, followed) and follower.ap_id != followed.ap_id do
412 where: u.id == ^follower.id,
413 update: [pull: [following: ^ap_followers]],
417 {1, [follower]} = Repo.update_all(q, [])
419 {:ok, followed} = update_follower_count(followed)
423 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
425 {:error, "Not subscribed!"}
429 @spec following?(User.t(), User.t()) :: boolean
430 def following?(%User{} = follower, %User{} = followed) do
431 Enum.member?(follower.following, followed.follower_address)
434 def follow_import(%User{} = follower, followed_identifiers)
435 when is_list(followed_identifiers) do
437 followed_identifiers,
438 fn followed_identifier ->
439 with %User{} = followed <- get_or_fetch(followed_identifier),
440 {:ok, follower} <- maybe_direct_follow(follower, followed),
441 {:ok, _} <- ActivityPub.follow(follower, followed) do
445 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
452 def locked?(%User{} = user) do
453 user.info.locked || false
457 Repo.get_by(User, id: id)
460 def get_by_ap_id(ap_id) do
461 Repo.get_by(User, ap_id: ap_id)
464 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
465 # of the ap_id and the domain and tries to get that user
466 def get_by_guessed_nickname(ap_id) do
467 domain = URI.parse(ap_id).host
468 name = List.last(String.split(ap_id, "/"))
469 nickname = "#{name}@#{domain}"
471 get_by_nickname(nickname)
474 def set_cache(user) do
475 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
476 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
477 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
481 def update_and_set_cache(changeset) do
482 with {:ok, user} <- Repo.update(changeset) do
489 def invalidate_cache(user) do
490 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
491 Cachex.del(:user_cache, "nickname:#{user.nickname}")
492 Cachex.del(:user_cache, "user_info:#{user.id}")
495 def get_cached_by_ap_id(ap_id) do
496 key = "ap_id:#{ap_id}"
497 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
500 def get_cached_by_id(id) do
504 Cachex.fetch!(:user_cache, key, fn _ ->
508 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
509 {:commit, user.ap_id}
515 get_cached_by_ap_id(ap_id)
518 def get_cached_by_nickname(nickname) do
519 key = "nickname:#{nickname}"
520 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
523 def get_cached_by_nickname_or_id(nickname_or_id) do
524 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
527 def get_by_nickname(nickname) do
528 Repo.get_by(User, nickname: nickname) ||
529 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
530 Repo.get_by(User, nickname: local_nickname(nickname))
534 def get_by_email(email), do: Repo.get_by(User, email: email)
536 def get_by_nickname_or_email(nickname_or_email) do
537 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
540 def get_cached_user_info(user) do
541 key = "user_info:#{user.id}"
542 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
545 def fetch_by_nickname(nickname) do
546 ap_try = ActivityPub.make_user_from_nickname(nickname)
549 {:ok, user} -> {:ok, user}
550 _ -> OStatus.make_user(nickname)
554 def get_or_fetch_by_nickname(nickname) do
555 with %User{} = user <- get_by_nickname(nickname) do
559 with [_nick, _domain] <- String.split(nickname, "@"),
560 {:ok, user} <- fetch_by_nickname(nickname) do
561 if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
562 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
572 @doc "Fetch some posts when the user has just been federated with"
573 def fetch_initial_posts(user) do
574 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
577 # Insert all the posts in reverse order, so they're in the right order on the timeline
578 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
579 &Pleroma.Web.Federator.incoming_ap_doc/1
583 def get_followers_query(%User{id: id, follower_address: follower_address}, nil) do
586 where: fragment("? <@ ?", ^[follower_address], u.following),
589 |> restrict_deactivated()
592 def get_followers_query(user, page) do
593 from(u in get_followers_query(user, nil))
594 |> paginate(page, 20)
597 def get_followers_query(user), do: get_followers_query(user, nil)
599 def get_followers(user, page \\ nil) do
600 q = get_followers_query(user, page)
605 def get_followers_ids(user, page \\ nil) do
606 q = get_followers_query(user, page)
608 Repo.all(from(u in q, select: u.id))
611 def get_friends_query(%User{id: id, following: following}, nil) do
614 where: u.follower_address in ^following,
617 |> restrict_deactivated()
620 def get_friends_query(user, page) do
621 from(u in get_friends_query(user, nil))
622 |> paginate(page, 20)
625 def get_friends_query(user), do: get_friends_query(user, nil)
627 def get_friends(user, page \\ nil) do
628 q = get_friends_query(user, page)
633 def get_friends_ids(user, page \\ nil) do
634 q = get_friends_query(user, page)
636 Repo.all(from(u in q, select: u.id))
639 def get_follow_requests_query(%User{} = user) do
644 "? ->> 'type' = 'Follow'",
649 "? ->> 'state' = 'pending'",
654 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
662 def get_follow_requests(%User{} = user) do
665 |> User.get_follow_requests_query()
666 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
667 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
668 |> group_by([a, u], u.id)
675 def increase_note_count(%User{} = user) do
677 |> where(id: ^user.id)
682 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
689 |> Repo.update_all([])
691 {1, [user]} -> set_cache(user)
696 def decrease_note_count(%User{} = user) do
698 |> where(id: ^user.id)
703 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
710 |> Repo.update_all([])
712 {1, [user]} -> set_cache(user)
717 def update_note_count(%User{} = user) do
721 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
725 note_count = Repo.one(note_count_query)
727 info_cng = User.Info.set_note_count(user.info, note_count)
731 |> put_embed(:info, info_cng)
732 |> update_and_set_cache()
735 def update_follower_count(%User{} = user) do
736 follower_count_query =
738 |> where([u], ^user.follower_address in u.following)
739 |> where([u], u.id != ^user.id)
740 |> select([u], %{count: count(u.id)})
741 |> restrict_deactivated()
744 |> where(id: ^user.id)
745 |> join(:inner, [u], s in subquery(follower_count_query))
750 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
757 |> Repo.update_all([])
759 {1, [user]} -> set_cache(user)
764 def get_users_from_set_query(ap_ids, false) do
767 where: u.ap_id in ^ap_ids
771 def get_users_from_set_query(ap_ids, true) do
772 query = get_users_from_set_query(ap_ids, false)
776 where: u.local == true
780 def get_users_from_set(ap_ids, local_only \\ true) do
781 get_users_from_set_query(ap_ids, local_only)
785 def get_recipients_from_activity(%Activity{recipients: to}) do
789 where: u.ap_id in ^to,
790 or_where: fragment("? && ?", u.following, ^to)
793 query = from(u in query, where: u.local == true)
798 def search(query, resolve \\ false, for_user \\ nil) do
799 # Strip the beginning @ off if there is a query
800 query = String.trim_leading(query, "@")
802 if resolve, do: get_or_fetch(query)
805 Repo.transaction(fn ->
806 Ecto.Adapters.SQL.query(Repo, "select set_limit(0.25)", [])
807 Repo.all(search_query(query, for_user))
813 def search_query(query, for_user) do
814 fts_subquery = fts_search_subquery(query)
815 trigram_subquery = trigram_search_subquery(query)
816 union_query = from(s in trigram_subquery, union_all: ^fts_subquery)
817 distinct_query = from(s in subquery(union_query), order_by: s.search_type, distinct: s.id)
819 from(s in subquery(boost_search_rank_query(distinct_query, for_user)),
820 order_by: [desc: s.search_rank],
825 defp boost_search_rank_query(query, nil), do: query
827 defp boost_search_rank_query(query, for_user) do
828 friends_ids = get_friends_ids(for_user)
829 followers_ids = get_followers_ids(for_user)
831 from(u in subquery(query),
836 CASE WHEN (?) THEN (?) * 1.3
837 WHEN (?) THEN (?) * 1.2
838 WHEN (?) THEN (?) * 1.1
841 u.id in ^friends_ids and u.id in ^followers_ids,
843 u.id in ^friends_ids,
845 u.id in ^followers_ids,
853 defp fts_search_subquery(term, query \\ User) do
856 |> String.replace(~r/\W+/, " ")
859 |> Enum.map(&(&1 <> ":*"))
870 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
871 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
872 to_tsquery('simple', ?),
884 (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
885 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
892 |> restrict_deactivated()
895 defp trigram_search_subquery(term) do
899 # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
900 search_type: fragment("?", 1),
903 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
909 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
911 |> restrict_deactivated()
914 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
917 fn blocked_identifier ->
918 with %User{} = blocked <- get_or_fetch(blocked_identifier),
919 {:ok, blocker} <- block(blocker, blocked),
920 {:ok, _} <- ActivityPub.block(blocker, blocked) do
924 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
931 def mute(muter, %User{ap_id: ap_id}) do
934 |> User.Info.add_to_mutes(ap_id)
938 |> put_embed(:info, info_cng)
940 update_and_set_cache(cng)
943 def unmute(muter, %{ap_id: ap_id}) do
946 |> User.Info.remove_from_mutes(ap_id)
950 |> put_embed(:info, info_cng)
952 update_and_set_cache(cng)
955 def subscribe(subscriber, %{ap_id: ap_id}) do
956 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
958 with %User{} = subscribed <- get_cached_by_ap_id(ap_id) do
959 blocked = blocks?(subscribed, subscriber) and deny_follow_blocked
962 {:error, "Could not subscribe: #{subscribed.nickname} is blocking you"}
966 |> User.Info.add_to_subscribers(subscriber.ap_id)
969 |> put_embed(:info, info_cng)
970 |> update_and_set_cache()
975 def unsubscribe(unsubscriber, %{ap_id: ap_id}) do
976 with %User{} = user <- get_cached_by_ap_id(ap_id) do
979 |> User.Info.remove_from_subscribers(unsubscriber.ap_id)
982 |> put_embed(:info, info_cng)
983 |> update_and_set_cache()
987 def block(blocker, %User{ap_id: ap_id} = blocked) do
988 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
990 if following?(blocker, blocked) do
991 {:ok, blocker, _} = unfollow(blocker, blocked)
998 if subscribed_to?(blocked, blocker) do
999 {:ok, blocker} = unsubscribe(blocked, blocker)
1005 if following?(blocked, blocker) do
1006 unfollow(blocked, blocker)
1009 {:ok, blocker} = update_follower_count(blocker)
1013 |> User.Info.add_to_block(ap_id)
1017 |> put_embed(:info, info_cng)
1019 update_and_set_cache(cng)
1022 # helper to handle the block given only an actor's AP id
1023 def block(blocker, %{ap_id: ap_id}) do
1024 block(blocker, User.get_by_ap_id(ap_id))
1027 def unblock(blocker, %{ap_id: ap_id}) do
1030 |> User.Info.remove_from_block(ap_id)
1034 |> put_embed(:info, info_cng)
1036 update_and_set_cache(cng)
1039 def mutes?(nil, _), do: false
1040 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
1042 def blocks?(user, %{ap_id: ap_id}) do
1043 blocks = user.info.blocks
1044 domain_blocks = user.info.domain_blocks
1045 %{host: host} = URI.parse(ap_id)
1047 Enum.member?(blocks, ap_id) ||
1048 Enum.any?(domain_blocks, fn domain ->
1053 def subscribed_to?(user, %{ap_id: ap_id}) do
1054 with %User{} = target <- User.get_by_ap_id(ap_id) do
1055 Enum.member?(target.info.subscribers, user.ap_id)
1059 def muted_users(user),
1060 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.mutes))
1062 def blocked_users(user),
1063 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
1065 def subscribers(user),
1066 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.subscribers))
1068 def block_domain(user, domain) do
1071 |> User.Info.add_to_domain_block(domain)
1075 |> put_embed(:info, info_cng)
1077 update_and_set_cache(cng)
1080 def unblock_domain(user, domain) do
1083 |> User.Info.remove_from_domain_block(domain)
1087 |> put_embed(:info, info_cng)
1089 update_and_set_cache(cng)
1092 def maybe_local_user_query(query, local) do
1093 if local, do: local_user_query(query), else: query
1096 def local_user_query(query \\ User) do
1099 where: u.local == true,
1100 where: not is_nil(u.nickname)
1104 def maybe_external_user_query(query, external) do
1105 if external, do: external_user_query(query), else: query
1108 def external_user_query(query \\ User) do
1111 where: u.local == false,
1112 where: not is_nil(u.nickname)
1116 def maybe_active_user_query(query, active) do
1117 if active, do: active_user_query(query), else: query
1120 def active_user_query(query \\ User) do
1123 where: fragment("not (?->'deactivated' @> 'true')", u.info),
1124 where: not is_nil(u.nickname)
1128 def maybe_deactivated_user_query(query, deactivated) do
1129 if deactivated, do: deactivated_user_query(query), else: query
1132 def deactivated_user_query(query \\ User) do
1135 where: fragment("(?->'deactivated' @> 'true')", u.info),
1136 where: not is_nil(u.nickname)
1140 def active_local_user_query do
1142 u in local_user_query(),
1143 where: fragment("not (?->'deactivated' @> 'true')", u.info)
1147 def moderator_user_query do
1150 where: u.local == true,
1151 where: fragment("?->'is_moderator' @> 'true'", u.info)
1155 def deactivate_async(user, status \\ true) do
1156 PleromaJobQueue.enqueue(:user, __MODULE__, [:deactivate_async, user, status])
1159 def perform(:deactivate_async, user, status), do: deactivate(user, status)
1161 def deactivate(%User{} = user, status \\ true) do
1162 info_cng = User.Info.set_activation_status(user.info, status)
1164 with {:ok, friends} <- User.get_friends(user),
1165 {:ok, followers} <- User.get_followers(user),
1169 |> put_embed(:info, info_cng)
1170 |> update_and_set_cache() do
1171 Enum.each(followers, &invalidate_cache(&1))
1172 Enum.each(friends, &update_follower_count(&1))
1178 def update_notification_settings(%User{} = user, settings \\ %{}) do
1179 info_changeset = User.Info.update_notification_settings(user.info, settings)
1182 |> put_embed(:info, info_changeset)
1183 |> update_and_set_cache()
1186 def delete(%User{} = user) do
1187 {:ok, user} = User.deactivate(user)
1189 # Remove all relationships
1190 {:ok, followers} = User.get_followers(user)
1192 Enum.each(followers, fn follower -> User.unfollow(follower, user) end)
1194 {:ok, friends} = User.get_friends(user)
1196 Enum.each(friends, fn followed -> User.unfollow(user, followed) end)
1198 delete_user_activities(user)
1201 def delete_user_activities(%User{ap_id: ap_id} = user) do
1203 |> where(actor: ^ap_id)
1204 |> Activity.with_preloaded_object()
1207 %{data: %{"type" => "Create"}} = activity ->
1208 activity |> Object.normalize() |> ActivityPub.delete()
1210 # TODO: Do something with likes, follows, repeats.
1218 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1219 Pleroma.HTML.Scrubber.TwitterText
1222 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
1224 def html_filter_policy(_), do: @default_scrubbers
1226 def fetch_by_ap_id(ap_id) do
1227 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1234 case OStatus.make_user(ap_id) do
1236 _ -> {:error, "Could not fetch by AP id"}
1241 def get_or_fetch_by_ap_id(ap_id) do
1242 user = get_by_ap_id(ap_id)
1244 if !is_nil(user) and !User.needs_update?(user) do
1247 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1248 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1250 user = fetch_by_ap_id(ap_id)
1252 if should_fetch_initial do
1253 with %User{} = user do
1254 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
1262 def get_or_create_instance_user do
1263 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1265 if user = get_by_ap_id(relay_uri) do
1269 %User{info: %User.Info{}}
1270 |> cast(%{}, [:ap_id, :nickname, :local])
1271 |> put_change(:ap_id, relay_uri)
1272 |> put_change(:nickname, nil)
1273 |> put_change(:local, true)
1274 |> put_change(:follower_address, relay_uri <> "/followers")
1276 {:ok, user} = Repo.insert(changes)
1282 def public_key_from_info(%{
1283 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1287 |> :public_key.pem_decode()
1289 |> :public_key.pem_entry_decode()
1295 def public_key_from_info(%{magic_key: magic_key}) do
1296 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1299 def get_public_key_for_ap_id(ap_id) do
1300 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
1301 {:ok, public_key} <- public_key_from_info(user.info) do
1308 defp blank?(""), do: nil
1309 defp blank?(n), do: n
1311 def insert_or_update_user(data) do
1314 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1316 cs = User.remote_user_creation(data)
1318 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
1321 def ap_enabled?(%User{local: true}), do: true
1322 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1323 def ap_enabled?(_), do: false
1325 @doc "Gets or fetch a user by uri or nickname."
1326 @spec get_or_fetch(String.t()) :: User.t()
1327 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1328 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1330 # wait a period of time and return newest version of the User structs
1331 # this is because we have synchronous follow APIs and need to simulate them
1332 # with an async handshake
1333 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1334 with %User{} = a <- User.get_by_id(a.id),
1335 %User{} = b <- User.get_by_id(b.id) do
1343 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1344 with :ok <- :timer.sleep(timeout),
1345 %User{} = a <- User.get_by_id(a.id),
1346 %User{} = b <- User.get_by_id(b.id) do
1354 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
1355 def parse_bio(nil, _user), do: ""
1356 def parse_bio(bio, _user) when bio == "", do: bio
1358 def parse_bio(bio, user) do
1360 (user.info.source_data["tag"] || [])
1361 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
1362 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
1363 {String.trim(name, ":"), url}
1366 # TODO: get profile URLs other than user.ap_id
1367 profile_urls = [user.ap_id]
1370 |> CommonUtils.format_input("text/plain",
1371 mentions_format: :full,
1372 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1375 |> Formatter.emojify(emoji)
1378 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1379 Repo.transaction(fn ->
1380 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1384 def tag(nickname, tags) when is_binary(nickname),
1385 do: tag(User.get_by_nickname(nickname), tags)
1387 def tag(%User{} = user, tags),
1388 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1390 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1391 Repo.transaction(fn ->
1392 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1396 def untag(nickname, tags) when is_binary(nickname),
1397 do: untag(User.get_by_nickname(nickname), tags)
1399 def untag(%User{} = user, tags),
1400 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1402 defp update_tags(%User{} = user, new_tags) do
1403 {:ok, updated_user} =
1405 |> change(%{tags: new_tags})
1406 |> update_and_set_cache()
1411 def bookmark(%User{} = user, status_id) do
1412 bookmarks = Enum.uniq(user.bookmarks ++ [status_id])
1413 update_bookmarks(user, bookmarks)
1416 def unbookmark(%User{} = user, status_id) do
1417 bookmarks = Enum.uniq(user.bookmarks -- [status_id])
1418 update_bookmarks(user, bookmarks)
1421 def update_bookmarks(%User{} = user, bookmarks) do
1423 |> change(%{bookmarks: bookmarks})
1424 |> update_and_set_cache
1427 defp normalize_tags(tags) do
1430 |> Enum.map(&String.downcase(&1))
1433 defp local_nickname_regex do
1434 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1435 @extended_local_nickname_regex
1437 @strict_local_nickname_regex
1441 def local_nickname(nickname_or_mention) do
1444 |> String.split("@")
1448 def full_nickname(nickname_or_mention),
1449 do: String.trim_leading(nickname_or_mention, "@")
1451 def error_user(ap_id) do
1456 nickname: "erroruser@example.com",
1457 inserted_at: NaiveDateTime.utc_now()
1461 def all_superusers do
1464 where: u.local == true,
1465 where: fragment("?->'is_admin' @> 'true' OR ?->'is_moderator' @> 'true'", u.info, u.info)
1470 defp paginate(query, page, page_size) do
1473 offset: ^((page - 1) * page_size)
1477 def showing_reblogs?(%User{} = user, %User{} = target) do
1478 target.ap_id not in user.info.muted_reblogs