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
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(:bookmarks, {:array, :string}, default: [])
56 field(:last_refreshed_at, :naive_datetime_usec)
57 has_many(:notifications, Notification)
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([:email, :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)
230 if changeset.valid? do
231 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
232 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
233 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
236 |> put_change(:password_hash, hashed)
237 |> put_change(:ap_id, ap_id)
238 |> unique_constraint(:ap_id)
239 |> put_change(:following, [followers])
240 |> put_change(:follower_address, followers)
246 defp autofollow_users(user) do
247 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
251 where: u.local == true,
252 where: u.nickname in ^candidates
256 follow_all(user, autofollowed_users)
259 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
260 def register(%Ecto.Changeset{} = changeset) do
261 with {:ok, user} <- Repo.insert(changeset),
262 {:ok, user} <- autofollow_users(user),
263 {:ok, _} <- Pleroma.User.WelcomeMessage.post_welcome_message_to_user(user),
264 {:ok, _} <- try_send_confirmation_email(user) do
269 def try_send_confirmation_email(%User{} = user) do
270 if user.info.confirmation_pending &&
271 Pleroma.Config.get([:instance, :account_activation_required]) do
273 |> Pleroma.UserEmail.account_confirmation_email()
274 |> Pleroma.Mailer.deliver_async()
280 def needs_update?(%User{local: true}), do: false
282 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
284 def needs_update?(%User{local: false} = user) do
285 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
288 def needs_update?(_), do: true
290 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
294 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
295 follow(follower, followed)
298 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
299 if not User.ap_enabled?(followed) do
300 follow(follower, followed)
306 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
307 if not following?(follower, followed) do
308 follow(follower, followed)
314 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
315 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
316 def follow_all(follower, followeds) do
319 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
320 |> Enum.map(fn %{follower_address: fa} -> fa end)
324 where: u.id == ^follower.id,
329 "array(select distinct unnest (array_cat(?, ?)))",
338 {1, [follower]} = Repo.update_all(q, [])
340 Enum.each(followeds, fn followed ->
341 update_follower_count(followed)
347 def follow(%User{} = follower, %User{info: info} = followed) do
348 user_config = Application.get_env(:pleroma, :user)
349 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
351 ap_followers = followed.follower_address
354 following?(follower, followed) or info.deactivated ->
355 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
357 deny_follow_blocked and blocks?(followed, follower) ->
358 {:error, "Could not follow user: #{followed.nickname} blocked you."}
361 if !followed.local && follower.local && !ap_enabled?(followed) do
362 Websub.subscribe(follower, followed)
367 where: u.id == ^follower.id,
368 update: [push: [following: ^ap_followers]],
372 {1, [follower]} = Repo.update_all(q, [])
374 {:ok, _} = update_follower_count(followed)
380 def unfollow(%User{} = follower, %User{} = followed) do
381 ap_followers = followed.follower_address
383 if following?(follower, followed) and follower.ap_id != followed.ap_id do
386 where: u.id == ^follower.id,
387 update: [pull: [following: ^ap_followers]],
391 {1, [follower]} = Repo.update_all(q, [])
393 {:ok, followed} = update_follower_count(followed)
397 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
399 {:error, "Not subscribed!"}
403 @spec following?(User.t(), User.t()) :: boolean
404 def following?(%User{} = follower, %User{} = followed) do
405 Enum.member?(follower.following, followed.follower_address)
408 def follow_import(%User{} = follower, followed_identifiers)
409 when is_list(followed_identifiers) do
411 followed_identifiers,
412 fn followed_identifier ->
413 with %User{} = followed <- get_or_fetch(followed_identifier),
414 {:ok, follower} <- maybe_direct_follow(follower, followed),
415 {:ok, _} <- ActivityPub.follow(follower, followed) do
419 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
426 def locked?(%User{} = user) do
427 user.info.locked || false
431 Repo.get_by(User, id: id)
434 def get_by_ap_id(ap_id) do
435 Repo.get_by(User, ap_id: ap_id)
438 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
439 # of the ap_id and the domain and tries to get that user
440 def get_by_guessed_nickname(ap_id) do
441 domain = URI.parse(ap_id).host
442 name = List.last(String.split(ap_id, "/"))
443 nickname = "#{name}@#{domain}"
445 get_by_nickname(nickname)
448 def set_cache(user) do
449 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
450 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
451 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
455 def update_and_set_cache(changeset) do
456 with {:ok, user} <- Repo.update(changeset) do
463 def invalidate_cache(user) do
464 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
465 Cachex.del(:user_cache, "nickname:#{user.nickname}")
466 Cachex.del(:user_cache, "user_info:#{user.id}")
469 def get_cached_by_ap_id(ap_id) do
470 key = "ap_id:#{ap_id}"
471 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
474 def get_cached_by_id(id) do
478 Cachex.fetch!(:user_cache, key, fn _ ->
482 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
483 {:commit, user.ap_id}
489 get_cached_by_ap_id(ap_id)
492 def get_cached_by_nickname(nickname) do
493 key = "nickname:#{nickname}"
494 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
497 def get_cached_by_nickname_or_id(nickname_or_id) do
498 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
501 def get_by_nickname(nickname) do
502 Repo.get_by(User, nickname: nickname) ||
503 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
504 Repo.get_by(User, nickname: local_nickname(nickname))
508 def get_by_nickname_or_email(nickname_or_email) do
509 case user = Repo.get_by(User, nickname: nickname_or_email) do
511 nil -> Repo.get_by(User, email: nickname_or_email)
515 def get_cached_user_info(user) do
516 key = "user_info:#{user.id}"
517 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
520 def fetch_by_nickname(nickname) do
521 ap_try = ActivityPub.make_user_from_nickname(nickname)
524 {:ok, user} -> {:ok, user}
525 _ -> OStatus.make_user(nickname)
529 def get_or_fetch_by_nickname(nickname) do
530 with %User{} = user <- get_by_nickname(nickname) do
534 with [_nick, _domain] <- String.split(nickname, "@"),
535 {:ok, user} <- fetch_by_nickname(nickname) do
536 if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
537 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
547 @doc "Fetch some posts when the user has just been federated with"
548 def fetch_initial_posts(user) do
549 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
552 # Insert all the posts in reverse order, so they're in the right order on the timeline
553 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
554 &Pleroma.Web.Federator.incoming_ap_doc/1
558 def get_followers_query(%User{id: id, follower_address: follower_address}, nil) do
561 where: fragment("? <@ ?", ^[follower_address], u.following),
566 def get_followers_query(user, page) do
567 from(u in get_followers_query(user, nil))
568 |> paginate(page, 20)
571 def get_followers_query(user), do: get_followers_query(user, nil)
573 def get_followers(user, page \\ nil) do
574 q = get_followers_query(user, page)
579 def get_followers_ids(user, page \\ nil) do
580 q = get_followers_query(user, page)
582 Repo.all(from(u in q, select: u.id))
585 def get_friends_query(%User{id: id, following: following}, nil) do
588 where: u.follower_address in ^following,
593 def get_friends_query(user, page) do
594 from(u in get_friends_query(user, nil))
595 |> paginate(page, 20)
598 def get_friends_query(user), do: get_friends_query(user, nil)
600 def get_friends(user, page \\ nil) do
601 q = get_friends_query(user, page)
606 def get_friends_ids(user, page \\ nil) do
607 q = get_friends_query(user, page)
609 Repo.all(from(u in q, select: u.id))
612 def get_follow_requests_query(%User{} = user) do
617 "? ->> 'type' = 'Follow'",
622 "? ->> 'state' = 'pending'",
627 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
635 def get_follow_requests(%User{} = user) do
638 |> User.get_follow_requests_query()
639 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
640 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
641 |> group_by([a, u], u.id)
648 def increase_note_count(%User{} = user) do
650 |> where(id: ^user.id)
655 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
662 |> Repo.update_all([])
664 {1, [user]} -> set_cache(user)
669 def decrease_note_count(%User{} = user) do
671 |> where(id: ^user.id)
676 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
683 |> Repo.update_all([])
685 {1, [user]} -> set_cache(user)
690 def update_note_count(%User{} = user) do
694 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
698 note_count = Repo.one(note_count_query)
700 info_cng = User.Info.set_note_count(user.info, note_count)
704 |> put_embed(:info, info_cng)
706 update_and_set_cache(cng)
709 def update_follower_count(%User{} = user) do
710 follower_count_query =
712 |> where([u], ^user.follower_address in u.following)
713 |> where([u], u.id != ^user.id)
714 |> select([u], %{count: count(u.id)})
717 |> where(id: ^user.id)
718 |> join(:inner, [u], s in subquery(follower_count_query))
723 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
730 |> Repo.update_all([])
732 {1, [user]} -> set_cache(user)
737 def get_users_from_set_query(ap_ids, false) do
740 where: u.ap_id in ^ap_ids
744 def get_users_from_set_query(ap_ids, true) do
745 query = get_users_from_set_query(ap_ids, false)
749 where: u.local == true
753 def get_users_from_set(ap_ids, local_only \\ true) do
754 get_users_from_set_query(ap_ids, local_only)
758 def get_recipients_from_activity(%Activity{recipients: to}) do
762 where: u.ap_id in ^to,
763 or_where: fragment("? && ?", u.following, ^to)
766 query = from(u in query, where: u.local == true)
771 def search(query, resolve \\ false, for_user \\ nil) do
772 # Strip the beginning @ off if there is a query
773 query = String.trim_leading(query, "@")
775 if resolve, do: get_or_fetch(query)
778 Repo.transaction(fn ->
779 Ecto.Adapters.SQL.query(Repo, "select set_limit(0.25)", [])
780 Repo.all(search_query(query, for_user))
786 def search_query(query, for_user) do
787 fts_subquery = fts_search_subquery(query)
788 trigram_subquery = trigram_search_subquery(query)
789 union_query = from(s in trigram_subquery, union_all: ^fts_subquery)
790 distinct_query = from(s in subquery(union_query), order_by: s.search_type, distinct: s.id)
792 from(s in subquery(boost_search_rank_query(distinct_query, for_user)),
793 order_by: [desc: s.search_rank],
798 defp boost_search_rank_query(query, nil), do: query
800 defp boost_search_rank_query(query, for_user) do
801 friends_ids = get_friends_ids(for_user)
802 followers_ids = get_followers_ids(for_user)
804 from(u in subquery(query),
809 CASE WHEN (?) THEN (?) * 1.3
810 WHEN (?) THEN (?) * 1.2
811 WHEN (?) THEN (?) * 1.1
814 u.id in ^friends_ids and u.id in ^followers_ids,
816 u.id in ^friends_ids,
818 u.id in ^followers_ids,
826 defp fts_search_subquery(term, query \\ User) do
829 |> String.replace(~r/\W+/, " ")
832 |> Enum.map(&(&1 <> ":*"))
843 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
844 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
845 to_tsquery('simple', ?),
857 (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
858 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
867 defp trigram_search_subquery(term) do
871 # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
872 search_type: fragment("?", 1),
875 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
881 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
885 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
888 fn blocked_identifier ->
889 with %User{} = blocked <- get_or_fetch(blocked_identifier),
890 {:ok, blocker} <- block(blocker, blocked),
891 {:ok, _} <- ActivityPub.block(blocker, blocked) do
895 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
902 def mute(muter, %User{ap_id: ap_id}) do
905 |> User.Info.add_to_mutes(ap_id)
909 |> put_embed(:info, info_cng)
911 update_and_set_cache(cng)
914 def unmute(muter, %{ap_id: ap_id}) do
917 |> User.Info.remove_from_mutes(ap_id)
921 |> put_embed(:info, info_cng)
923 update_and_set_cache(cng)
926 def block(blocker, %User{ap_id: ap_id} = blocked) do
927 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
929 if following?(blocker, blocked) do
930 {:ok, blocker, _} = unfollow(blocker, blocked)
936 if following?(blocked, blocker) do
937 unfollow(blocked, blocker)
942 |> User.Info.add_to_block(ap_id)
946 |> put_embed(:info, info_cng)
948 update_and_set_cache(cng)
951 # helper to handle the block given only an actor's AP id
952 def block(blocker, %{ap_id: ap_id}) do
953 block(blocker, User.get_by_ap_id(ap_id))
956 def unblock(blocker, %{ap_id: ap_id}) do
959 |> User.Info.remove_from_block(ap_id)
963 |> put_embed(:info, info_cng)
965 update_and_set_cache(cng)
968 def mutes?(nil, _), do: false
969 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
971 def blocks?(user, %{ap_id: ap_id}) do
972 blocks = user.info.blocks
973 domain_blocks = user.info.domain_blocks
974 %{host: host} = URI.parse(ap_id)
976 Enum.member?(blocks, ap_id) ||
977 Enum.any?(domain_blocks, fn domain ->
982 def muted_users(user),
983 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.mutes))
985 def blocked_users(user),
986 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
988 def block_domain(user, domain) do
991 |> User.Info.add_to_domain_block(domain)
995 |> put_embed(:info, info_cng)
997 update_and_set_cache(cng)
1000 def unblock_domain(user, domain) do
1003 |> User.Info.remove_from_domain_block(domain)
1007 |> put_embed(:info, info_cng)
1009 update_and_set_cache(cng)
1012 def maybe_local_user_query(query, local) do
1013 if local, do: local_user_query(query), else: query
1016 def local_user_query(query \\ User) do
1019 where: u.local == true,
1020 where: not is_nil(u.nickname)
1024 def maybe_external_user_query(query, external) do
1025 if external, do: external_user_query(query), else: query
1028 def external_user_query(query \\ User) do
1031 where: u.local == false,
1032 where: not is_nil(u.nickname)
1036 def maybe_active_user_query(query, active) do
1037 if active, do: active_user_query(query), else: query
1040 def active_user_query(query \\ User) do
1043 where: fragment("not (?->'deactivated' @> 'true')", u.info),
1044 where: not is_nil(u.nickname)
1048 def maybe_deactivated_user_query(query, deactivated) do
1049 if deactivated, do: deactivated_user_query(query), else: query
1052 def deactivated_user_query(query \\ User) do
1055 where: fragment("(?->'deactivated' @> 'true')", u.info),
1056 where: not is_nil(u.nickname)
1060 def active_local_user_query do
1062 u in local_user_query(),
1063 where: fragment("not (?->'deactivated' @> 'true')", u.info)
1067 def moderator_user_query do
1070 where: u.local == true,
1071 where: fragment("?->'is_moderator' @> 'true'", u.info)
1075 def deactivate(%User{} = user, status \\ true) do
1076 info_cng = User.Info.set_activation_status(user.info, status)
1080 |> put_embed(:info, info_cng)
1082 update_and_set_cache(cng)
1085 def delete(%User{} = user) do
1086 {:ok, user} = User.deactivate(user)
1088 # Remove all relationships
1089 {:ok, followers} = User.get_followers(user)
1091 Enum.each(followers, fn follower -> User.unfollow(follower, user) end)
1093 {:ok, friends} = User.get_friends(user)
1095 Enum.each(friends, fn followed -> User.unfollow(user, followed) end)
1097 delete_user_activities(user)
1100 def delete_user_activities(%User{ap_id: ap_id} = user) do
1102 |> where(actor: ^ap_id)
1103 |> Activity.with_preloaded_object()
1106 %{data: %{"type" => "Create"}} = activity ->
1107 activity |> Object.normalize() |> ActivityPub.delete()
1109 # TODO: Do something with likes, follows, repeats.
1117 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1118 Pleroma.HTML.Scrubber.TwitterText
1121 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
1123 def html_filter_policy(_), do: @default_scrubbers
1125 def fetch_by_ap_id(ap_id) do
1126 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1133 case OStatus.make_user(ap_id) do
1135 _ -> {:error, "Could not fetch by AP id"}
1140 def get_or_fetch_by_ap_id(ap_id) do
1141 user = get_by_ap_id(ap_id)
1143 if !is_nil(user) and !User.needs_update?(user) do
1146 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1147 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1149 user = fetch_by_ap_id(ap_id)
1151 if should_fetch_initial do
1152 with %User{} = user do
1153 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
1161 def get_or_create_instance_user do
1162 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1164 if user = get_by_ap_id(relay_uri) do
1168 %User{info: %User.Info{}}
1169 |> cast(%{}, [:ap_id, :nickname, :local])
1170 |> put_change(:ap_id, relay_uri)
1171 |> put_change(:nickname, nil)
1172 |> put_change(:local, true)
1173 |> put_change(:follower_address, relay_uri <> "/followers")
1175 {:ok, user} = Repo.insert(changes)
1181 def public_key_from_info(%{
1182 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1186 |> :public_key.pem_decode()
1188 |> :public_key.pem_entry_decode()
1194 def public_key_from_info(%{magic_key: magic_key}) do
1195 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1198 def get_public_key_for_ap_id(ap_id) do
1199 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
1200 {:ok, public_key} <- public_key_from_info(user.info) do
1207 defp blank?(""), do: nil
1208 defp blank?(n), do: n
1210 def insert_or_update_user(data) do
1213 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1215 cs = User.remote_user_creation(data)
1217 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
1220 def ap_enabled?(%User{local: true}), do: true
1221 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1222 def ap_enabled?(_), do: false
1224 @doc "Gets or fetch a user by uri or nickname."
1225 @spec get_or_fetch(String.t()) :: User.t()
1226 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1227 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1229 # wait a period of time and return newest version of the User structs
1230 # this is because we have synchronous follow APIs and need to simulate them
1231 # with an async handshake
1232 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1233 with %User{} = a <- User.get_by_id(a.id),
1234 %User{} = b <- User.get_by_id(b.id) do
1242 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1243 with :ok <- :timer.sleep(timeout),
1244 %User{} = a <- User.get_by_id(a.id),
1245 %User{} = b <- User.get_by_id(b.id) do
1253 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
1254 def parse_bio(nil, _user), do: ""
1255 def parse_bio(bio, _user) when bio == "", do: bio
1257 def parse_bio(bio, user) do
1259 (user.info.source_data["tag"] || [])
1260 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
1261 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
1262 {String.trim(name, ":"), url}
1265 # TODO: get profile URLs other than user.ap_id
1266 profile_urls = [user.ap_id]
1269 |> CommonUtils.format_input("text/plain",
1270 mentions_format: :full,
1271 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1274 |> Formatter.emojify(emoji)
1277 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1278 Repo.transaction(fn ->
1279 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1283 def tag(nickname, tags) when is_binary(nickname),
1284 do: tag(User.get_by_nickname(nickname), tags)
1286 def tag(%User{} = user, tags),
1287 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1289 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1290 Repo.transaction(fn ->
1291 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1295 def untag(nickname, tags) when is_binary(nickname),
1296 do: untag(User.get_by_nickname(nickname), tags)
1298 def untag(%User{} = user, tags),
1299 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1301 defp update_tags(%User{} = user, new_tags) do
1302 {:ok, updated_user} =
1304 |> change(%{tags: new_tags})
1305 |> update_and_set_cache()
1310 def bookmark(%User{} = user, status_id) do
1311 bookmarks = Enum.uniq(user.bookmarks ++ [status_id])
1312 update_bookmarks(user, bookmarks)
1315 def unbookmark(%User{} = user, status_id) do
1316 bookmarks = Enum.uniq(user.bookmarks -- [status_id])
1317 update_bookmarks(user, bookmarks)
1320 def update_bookmarks(%User{} = user, bookmarks) do
1322 |> change(%{bookmarks: bookmarks})
1323 |> update_and_set_cache
1326 defp normalize_tags(tags) do
1329 |> Enum.map(&String.downcase(&1))
1332 defp local_nickname_regex do
1333 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1334 @extended_local_nickname_regex
1336 @strict_local_nickname_regex
1340 def local_nickname(nickname_or_mention) do
1343 |> String.split("@")
1347 def full_nickname(nickname_or_mention),
1348 do: String.trim_leading(nickname_or_mention, "@")
1350 def error_user(ap_id) do
1355 nickname: "erroruser@example.com",
1356 inserted_at: NaiveDateTime.utc_now()
1360 def all_superusers do
1363 where: u.local == true,
1364 where: fragment("?->'is_admin' @> 'true' OR ?->'is_moderator' @> 'true'", u.info, u.info)
1369 defp paginate(query, page, page_size) do
1372 offset: ^((page - 1) * page_size)
1376 def showing_reblogs?(%User{} = user, %User{} = target) do
1377 target.ap_id not in user.info.muted_reblogs