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
15 alias Pleroma.Activity
16 alias Pleroma.Notification
18 alias Pleroma.Formatter
19 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
20 alias Pleroma.Web.OStatus
21 alias Pleroma.Web.Websub
22 alias Pleroma.Web.OAuth
23 alias Pleroma.Web.ActivityPub.Utils
24 alias Pleroma.Web.ActivityPub.ActivityPub
25 alias Pleroma.Web.RelMe
29 @type t :: %__MODULE__{}
31 @primary_key {:id, Pleroma.FlakeId, autogenerate: true}
33 @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])?)*$/
35 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
36 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
40 field(:email, :string)
42 field(:nickname, :string)
43 field(:password_hash, :string)
44 field(:password, :string, virtual: true)
45 field(:password_confirmation, :string, virtual: true)
46 field(:following, {:array, :string}, default: [])
47 field(:ap_id, :string)
49 field(:local, :boolean, default: true)
50 field(:follower_address, :string)
51 field(:search_rank, :float, virtual: true)
52 field(:tags, {:array, :string}, default: [])
53 field(:bookmarks, {:array, :string}, default: [])
54 field(:last_refreshed_at, :naive_datetime)
55 has_many(:notifications, Notification)
56 embeds_one(:info, Pleroma.User.Info)
61 def auth_active?(%User{local: false}), do: true
63 def auth_active?(%User{info: %User.Info{confirmation_pending: false}}), do: true
65 def auth_active?(%User{info: %User.Info{confirmation_pending: true}}),
66 do: !Pleroma.Config.get([:instance, :account_activation_required])
68 def auth_active?(_), do: false
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) do
86 %{"url" => [%{"href" => href} | _]} -> href
87 _ -> "#{Web.base_url()}/images/avi.png"
91 def banner_url(user) do
92 case user.info.banner do
93 %{"url" => [%{"href" => href} | _]} -> href
94 _ -> "#{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{} = user) do
107 "#{ap_id(user)}/followers"
110 def user_info(%User{} = user) do
111 oneself = if user.local, do: 1, else: 0
114 following_count: length(user.following) - oneself,
115 note_count: user.info.note_count,
116 follower_count: user.info.follower_count,
117 locked: user.info.locked,
118 confirmation_pending: user.info.confirmation_pending,
119 default_scope: user.info.default_scope
123 def remote_user_creation(params) do
126 |> Map.put(:info, params[:info] || %{})
128 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
132 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
133 |> validate_required([:name, :ap_id])
134 |> unique_constraint(:nickname)
135 |> validate_format(:nickname, @email_regex)
136 |> validate_length(:bio, max: 5000)
137 |> validate_length(:name, max: 100)
138 |> put_change(:local, false)
139 |> put_embed(:info, info_cng)
142 case info_cng.changes[:source_data] do
143 %{"followers" => followers} ->
145 |> put_change(:follower_address, followers)
148 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
151 |> put_change(:follower_address, followers)
158 def update_changeset(struct, params \\ %{}) do
160 |> cast(params, [:bio, :name, :avatar])
161 |> unique_constraint(:nickname)
162 |> validate_format(:nickname, local_nickname_regex())
163 |> validate_length(:bio, max: 5000)
164 |> validate_length(:name, min: 1, max: 100)
167 def upgrade_changeset(struct, params \\ %{}) do
170 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
174 |> User.Info.user_upgrade(params[:info])
177 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
178 |> unique_constraint(:nickname)
179 |> validate_format(:nickname, local_nickname_regex())
180 |> validate_length(:bio, max: 5000)
181 |> validate_length(:name, max: 100)
182 |> put_embed(:info, info_cng)
185 def password_update_changeset(struct, params) do
188 |> cast(params, [:password, :password_confirmation])
189 |> validate_required([:password, :password_confirmation])
190 |> validate_confirmation(:password)
192 OAuth.Token.delete_user_tokens(struct)
193 OAuth.Authorization.delete_user_authorizations(struct)
195 if changeset.valid? do
196 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
199 |> put_change(:password_hash, hashed)
205 def reset_password(user, data) do
206 update_and_set_cache(password_update_changeset(user, data))
209 def register_changeset(struct, params \\ %{}, opts \\ []) do
210 confirmation_status =
211 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
217 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
221 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
222 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
223 |> validate_confirmation(:password)
224 |> unique_constraint(:email)
225 |> unique_constraint(:nickname)
226 |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
227 |> validate_format(:nickname, local_nickname_regex())
228 |> validate_format(:email, @email_regex)
229 |> validate_length(:bio, max: 1000)
230 |> validate_length(:name, min: 1, max: 100)
231 |> put_change(:info, info_change)
233 if changeset.valid? do
234 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
235 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
236 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
239 |> put_change(:password_hash, hashed)
240 |> put_change(:ap_id, ap_id)
241 |> unique_constraint(:ap_id)
242 |> put_change(:following, [followers])
243 |> put_change(:follower_address, followers)
249 defp autofollow_users(user) do
250 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
254 where: u.local == true,
255 where: u.nickname in ^candidates
259 follow_all(user, autofollowed_users)
262 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
263 def register(%Ecto.Changeset{} = changeset) do
264 with {:ok, user} <- Repo.insert(changeset),
265 {:ok, user} <- autofollow_users(user),
266 {:ok, _} <- Pleroma.User.WelcomeMessage.post_welcome_message_to_user(user),
267 {:ok, _} <- try_send_confirmation_email(user) do
272 def try_send_confirmation_email(%User{} = user) do
273 if user.info.confirmation_pending &&
274 Pleroma.Config.get([:instance, :account_activation_required]) do
276 |> Pleroma.UserEmail.account_confirmation_email()
277 |> Pleroma.Mailer.deliver_async()
283 def needs_update?(%User{local: true}), do: false
285 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
287 def needs_update?(%User{local: false} = user) do
288 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
291 def needs_update?(_), do: true
293 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
297 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
298 follow(follower, followed)
301 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
302 if not User.ap_enabled?(followed) do
303 follow(follower, followed)
309 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
310 if not following?(follower, followed) do
311 follow(follower, followed)
317 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
318 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
319 def follow_all(follower, followeds) do
322 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
323 |> Enum.map(fn %{follower_address: fa} -> fa end)
327 where: u.id == ^follower.id,
332 "array(select distinct unnest (array_cat(?, ?)))",
340 {1, [follower]} = Repo.update_all(q, [], returning: true)
342 Enum.each(followeds, fn followed ->
343 update_follower_count(followed)
349 def follow(%User{} = follower, %User{info: info} = followed) do
350 user_config = Application.get_env(:pleroma, :user)
351 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
353 ap_followers = followed.follower_address
356 following?(follower, followed) or info.deactivated ->
357 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
359 deny_follow_blocked and blocks?(followed, follower) ->
360 {:error, "Could not follow user: #{followed.nickname} blocked you."}
363 if !followed.local && follower.local && !ap_enabled?(followed) do
364 Websub.subscribe(follower, followed)
369 where: u.id == ^follower.id,
370 update: [push: [following: ^ap_followers]]
373 {1, [follower]} = Repo.update_all(q, [], returning: true)
375 {:ok, _} = update_follower_count(followed)
381 def unfollow(%User{} = follower, %User{} = followed) do
382 ap_followers = followed.follower_address
384 if following?(follower, followed) and follower.ap_id != followed.ap_id do
387 where: u.id == ^follower.id,
388 update: [pull: [following: ^ap_followers]]
391 {1, [follower]} = Repo.update_all(q, [], returning: true)
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 of the ap_id and the domain) and tries to get that user
439 def get_by_guessed_nickname(ap_id) do
440 domain = URI.parse(ap_id).host
441 name = List.last(String.split(ap_id, "/"))
442 nickname = "#{name}@#{domain}"
444 get_by_nickname(nickname)
447 def set_cache(user) do
448 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
449 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
450 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
454 def update_and_set_cache(changeset) do
455 with {:ok, user} <- Repo.update(changeset) do
462 def invalidate_cache(user) do
463 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
464 Cachex.del(:user_cache, "nickname:#{user.nickname}")
465 Cachex.del(:user_cache, "user_info:#{user.id}")
468 def get_cached_by_ap_id(ap_id) do
469 key = "ap_id:#{ap_id}"
470 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
473 def get_cached_by_id(id) do
477 Cachex.fetch!(:user_cache, key, fn _ ->
481 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
482 {:commit, user.ap_id}
488 get_cached_by_ap_id(ap_id)
491 def get_cached_by_nickname(nickname) do
492 key = "nickname:#{nickname}"
493 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
496 def get_cached_by_nickname_or_id(nickname_or_id) do
497 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
500 def get_by_nickname(nickname) do
501 Repo.get_by(User, nickname: nickname) ||
502 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
503 Repo.get_by(User, nickname: local_nickname(nickname))
507 def get_by_nickname_or_email(nickname_or_email) do
508 case user = Repo.get_by(User, nickname: nickname_or_email) do
510 nil -> Repo.get_by(User, email: nickname_or_email)
514 def get_cached_user_info(user) do
515 key = "user_info:#{user.id}"
516 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
519 def fetch_by_nickname(nickname) do
520 ap_try = ActivityPub.make_user_from_nickname(nickname)
523 {:ok, user} -> {:ok, user}
524 _ -> OStatus.make_user(nickname)
528 def get_or_fetch_by_nickname(nickname) do
529 with %User{} = user <- get_by_nickname(nickname) do
533 with [_nick, _domain] <- String.split(nickname, "@"),
534 {:ok, user} <- fetch_by_nickname(nickname) do
542 def get_followers_query(%User{id: id, follower_address: follower_address}, nil) do
545 where: fragment("? <@ ?", ^[follower_address], u.following),
550 def get_followers_query(user, page) do
551 from(u in get_followers_query(user, nil))
552 |> paginate(page, 20)
555 def get_followers_query(user), do: get_followers_query(user, nil)
557 def get_followers(user, page \\ nil) do
558 q = get_followers_query(user, page)
563 def get_followers_ids(user, page \\ nil) do
564 q = get_followers_query(user, page)
566 Repo.all(from(u in q, select: u.id))
569 def get_friends_query(%User{id: id, following: following}, nil) do
572 where: u.follower_address in ^following,
577 def get_friends_query(user, page) do
578 from(u in get_friends_query(user, nil))
579 |> paginate(page, 20)
582 def get_friends_query(user), do: get_friends_query(user, nil)
584 def get_friends(user, page \\ nil) do
585 q = get_friends_query(user, page)
590 def get_friends_ids(user, page \\ nil) do
591 q = get_friends_query(user, page)
593 Repo.all(from(u in q, select: u.id))
596 def get_follow_requests_query(%User{} = user) do
601 "? ->> 'type' = 'Follow'",
606 "? ->> 'state' = 'pending'",
611 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
619 def get_follow_requests(%User{} = user) do
622 |> User.get_follow_requests_query()
623 |> join(:inner, [a], u in User, a.actor == u.ap_id)
624 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
625 |> group_by([a, u], u.id)
632 def increase_note_count(%User{} = user) do
634 |> where(id: ^user.id)
639 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
645 |> Repo.update_all([], returning: true)
647 {1, [user]} -> set_cache(user)
652 def decrease_note_count(%User{} = user) do
654 |> where(id: ^user.id)
659 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
665 |> Repo.update_all([], returning: true)
667 {1, [user]} -> set_cache(user)
672 def update_note_count(%User{} = user) do
676 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
680 note_count = Repo.one(note_count_query)
682 info_cng = User.Info.set_note_count(user.info, note_count)
686 |> put_embed(:info, info_cng)
688 update_and_set_cache(cng)
691 def update_follower_count(%User{} = user) do
692 follower_count_query =
694 |> where([u], ^user.follower_address in u.following)
695 |> where([u], u.id != ^user.id)
696 |> select([u], %{count: count(u.id)})
699 |> where(id: ^user.id)
700 |> join(:inner, [u], s in subquery(follower_count_query))
705 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
711 |> Repo.update_all([], returning: true)
713 {1, [user]} -> set_cache(user)
718 def get_users_from_set_query(ap_ids, false) do
721 where: u.ap_id in ^ap_ids
725 def get_users_from_set_query(ap_ids, true) do
726 query = get_users_from_set_query(ap_ids, false)
730 where: u.local == true
734 def get_users_from_set(ap_ids, local_only \\ true) do
735 get_users_from_set_query(ap_ids, local_only)
739 def get_recipients_from_activity(%Activity{recipients: to}) do
743 where: u.ap_id in ^to,
744 or_where: fragment("? && ?", u.following, ^to)
747 query = from(u in query, where: u.local == true)
752 @spec search_for_admin(binary(), %{
753 admin: Pleroma.User.t(),
757 }) :: {:ok, [Pleroma.User.t()], number()}
758 def search_for_admin(term, %{admin: admin, local: local, page: page, page_size: page_size}) do
759 term = String.trim_leading(term, "@")
761 local_paginated_query =
763 |> maybe_local_user_query(local)
764 |> paginate(page, page_size)
766 search_query = fts_search_subquery(term, local_paginated_query)
770 |> fts_search_subquery()
771 |> maybe_local_user_query(local)
772 |> Repo.aggregate(:count, :id)
774 {:ok, do_search(search_query, admin), count}
777 @spec all_for_admin(number(), number()) :: {:ok, [Pleroma.User.t()], number()}
778 def all_for_admin(page, page_size) do
779 query = from(u in User, order_by: u.id)
783 |> paginate(page, page_size)
787 |> Repo.aggregate(:count, :id)
789 {:ok, Repo.all(paginated_query), count}
792 def search(query, resolve \\ false, for_user \\ nil) do
793 # Strip the beginning @ off if there is a query
794 query = String.trim_leading(query, "@")
796 if resolve, do: get_or_fetch(query)
798 fts_results = do_search(fts_search_subquery(query), for_user)
800 {:ok, trigram_results} =
801 Repo.transaction(fn ->
802 Ecto.Adapters.SQL.query(Repo, "select set_limit(0.25)", [])
803 do_search(trigram_search_subquery(query), for_user)
806 Enum.uniq_by(fts_results ++ trigram_results, & &1.id)
809 defp do_search(subquery, for_user, options \\ []) do
812 s in subquery(subquery),
813 order_by: [desc: s.search_rank],
814 limit: ^(options[:limit] || 20)
820 |> Enum.filter(&(&1.search_rank > 0))
822 boost_search_results(results, for_user)
825 defp fts_search_subquery(term, query \\ User) do
828 |> String.replace(~r/\W+/, " ")
831 |> Enum.map(&(&1 <> ":*"))
841 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
842 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
843 to_tsquery('simple', ?),
855 (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
856 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
865 defp trigram_search_subquery(term) do
871 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
877 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
881 defp boost_search_results(results, nil), do: results
883 defp boost_search_results(results, for_user) do
884 friends_ids = get_friends_ids(for_user)
885 followers_ids = get_followers_ids(for_user)
892 u.id in friends_ids ->
895 u.id in followers_ids ->
902 Map.put(u, :search_rank, u.search_rank * search_rank_coef)
905 |> Enum.sort_by(&(-&1.search_rank))
908 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
911 fn blocked_identifier ->
912 with %User{} = blocked <- get_or_fetch(blocked_identifier),
913 {:ok, blocker} <- block(blocker, blocked),
914 {:ok, _} <- ActivityPub.block(blocker, blocked) do
918 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
925 def mute(muter, %User{ap_id: ap_id}) do
928 |> User.Info.add_to_mutes(ap_id)
932 |> put_embed(:info, info_cng)
934 update_and_set_cache(cng)
937 def unmute(muter, %{ap_id: ap_id}) do
940 |> User.Info.remove_from_mutes(ap_id)
944 |> put_embed(:info, info_cng)
946 update_and_set_cache(cng)
949 def block(blocker, %User{ap_id: ap_id} = blocked) do
950 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
952 if following?(blocker, blocked) do
953 {:ok, blocker, _} = unfollow(blocker, blocked)
959 if following?(blocked, blocker) do
960 unfollow(blocked, blocker)
965 |> User.Info.add_to_block(ap_id)
969 |> put_embed(:info, info_cng)
971 update_and_set_cache(cng)
974 # helper to handle the block given only an actor's AP id
975 def block(blocker, %{ap_id: ap_id}) do
976 block(blocker, User.get_by_ap_id(ap_id))
979 def unblock(blocker, %{ap_id: ap_id}) do
982 |> User.Info.remove_from_block(ap_id)
986 |> put_embed(:info, info_cng)
988 update_and_set_cache(cng)
991 def mutes?(nil, _), do: false
992 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
994 def blocks?(user, %{ap_id: ap_id}) do
995 blocks = user.info.blocks
996 domain_blocks = user.info.domain_blocks
997 %{host: host} = URI.parse(ap_id)
999 Enum.member?(blocks, ap_id) ||
1000 Enum.any?(domain_blocks, fn domain ->
1005 def muted_users(user),
1006 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.mutes))
1008 def blocked_users(user),
1009 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
1011 def block_domain(user, domain) do
1014 |> User.Info.add_to_domain_block(domain)
1018 |> put_embed(:info, info_cng)
1020 update_and_set_cache(cng)
1023 def unblock_domain(user, domain) do
1026 |> User.Info.remove_from_domain_block(domain)
1030 |> put_embed(:info, info_cng)
1032 update_and_set_cache(cng)
1035 def maybe_local_user_query(query, local) do
1036 if local, do: local_user_query(query), else: query
1039 def local_user_query(query \\ User) do
1042 where: u.local == true,
1043 where: not is_nil(u.nickname)
1047 def active_local_user_query do
1049 u in local_user_query(),
1050 where: fragment("not (?->'deactivated' @> 'true')", u.info)
1054 def moderator_user_query do
1057 where: u.local == true,
1058 where: fragment("?->'is_moderator' @> 'true'", u.info)
1062 def deactivate(%User{} = user, status \\ true) do
1063 info_cng = User.Info.set_activation_status(user.info, status)
1067 |> put_embed(:info, info_cng)
1069 update_and_set_cache(cng)
1072 def delete(%User{} = user) do
1073 {:ok, user} = User.deactivate(user)
1075 # Remove all relationships
1076 {:ok, followers} = User.get_followers(user)
1079 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
1081 {:ok, friends} = User.get_friends(user)
1084 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
1086 delete_user_activities(user)
1091 def delete_user_activities(user) do
1092 query = from(a in Activity, where: a.actor == ^user.ap_id)
1095 |> Enum.each(fn activity ->
1096 case activity.data["type"] do
1098 ActivityPub.delete(Object.normalize(activity.data["object"]))
1100 # TODO: Do something with likes, follows, repeats.
1107 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1108 Pleroma.HTML.Scrubber.TwitterText
1111 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
1113 def html_filter_policy(_), do: @default_scrubbers
1115 def get_or_fetch_by_ap_id(ap_id) do
1116 user = get_by_ap_id(ap_id)
1118 if !is_nil(user) and !User.needs_update?(user) do
1121 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1128 case OStatus.make_user(ap_id) do
1130 _ -> {:error, "Could not fetch by AP id"}
1136 def get_or_create_instance_user do
1137 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1139 if user = get_by_ap_id(relay_uri) do
1143 %User{info: %User.Info{}}
1144 |> cast(%{}, [:ap_id, :nickname, :local])
1145 |> put_change(:ap_id, relay_uri)
1146 |> put_change(:nickname, nil)
1147 |> put_change(:local, true)
1148 |> put_change(:follower_address, relay_uri <> "/followers")
1150 {:ok, user} = Repo.insert(changes)
1156 def public_key_from_info(%{
1157 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1161 |> :public_key.pem_decode()
1163 |> :public_key.pem_entry_decode()
1169 def public_key_from_info(%{magic_key: magic_key}) do
1170 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1173 def get_public_key_for_ap_id(ap_id) do
1174 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
1175 {:ok, public_key} <- public_key_from_info(user.info) do
1182 defp blank?(""), do: nil
1183 defp blank?(n), do: n
1185 def insert_or_update_user(data) do
1188 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1190 cs = User.remote_user_creation(data)
1192 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
1195 def ap_enabled?(%User{local: true}), do: true
1196 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1197 def ap_enabled?(_), do: false
1199 @doc "Gets or fetch a user by uri or nickname."
1200 @spec get_or_fetch(String.t()) :: User.t()
1201 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1202 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1204 # wait a period of time and return newest version of the User structs
1205 # this is because we have synchronous follow APIs and need to simulate them
1206 # with an async handshake
1207 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1208 with %User{} = a <- Repo.get(User, a.id),
1209 %User{} = b <- Repo.get(User, b.id) do
1217 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1218 with :ok <- :timer.sleep(timeout),
1219 %User{} = a <- Repo.get(User, a.id),
1220 %User{} = b <- Repo.get(User, b.id) do
1228 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
1229 def parse_bio(nil, _user), do: ""
1230 def parse_bio(bio, _user) when bio == "", do: bio
1232 def parse_bio(bio, user) do
1234 (user.info.source_data["tag"] || [])
1235 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
1236 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
1237 {String.trim(name, ":"), url}
1240 # TODO: get profile URLs other than user.ap_id
1241 profile_urls = [user.ap_id]
1244 |> CommonUtils.format_input("text/plain",
1245 mentions_format: :full,
1246 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1249 |> Formatter.emojify(emoji)
1252 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1253 Repo.transaction(fn ->
1254 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1258 def tag(nickname, tags) when is_binary(nickname),
1259 do: tag(User.get_by_nickname(nickname), tags)
1261 def tag(%User{} = user, tags),
1262 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1264 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1265 Repo.transaction(fn ->
1266 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1270 def untag(nickname, tags) when is_binary(nickname),
1271 do: untag(User.get_by_nickname(nickname), tags)
1273 def untag(%User{} = user, tags),
1274 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1276 defp update_tags(%User{} = user, new_tags) do
1277 {:ok, updated_user} =
1279 |> change(%{tags: new_tags})
1280 |> update_and_set_cache()
1285 def bookmark(%User{} = user, status_id) do
1286 bookmarks = Enum.uniq(user.bookmarks ++ [status_id])
1287 update_bookmarks(user, bookmarks)
1290 def unbookmark(%User{} = user, status_id) do
1291 bookmarks = Enum.uniq(user.bookmarks -- [status_id])
1292 update_bookmarks(user, bookmarks)
1295 def update_bookmarks(%User{} = user, bookmarks) do
1297 |> change(%{bookmarks: bookmarks})
1298 |> update_and_set_cache
1301 defp normalize_tags(tags) do
1304 |> Enum.map(&String.downcase(&1))
1307 defp local_nickname_regex() do
1308 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1309 @extended_local_nickname_regex
1311 @strict_local_nickname_regex
1315 def local_nickname(nickname_or_mention) do
1318 |> String.split("@")
1322 def full_nickname(nickname_or_mention),
1323 do: String.trim_leading(nickname_or_mention, "@")
1325 def error_user(ap_id) do
1330 nickname: "erroruser@example.com",
1331 inserted_at: NaiveDateTime.utc_now()
1335 def all_superusers do
1338 where: u.local == true,
1339 where: fragment("?->'is_admin' @> 'true' OR ?->'is_moderator' @> 'true'", u.info, u.info)
1344 defp paginate(query, page, page_size) do
1347 offset: ^((page - 1) * page_size)