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
110 oneself = if user.local, do: 1, else: 0
113 following_count: length(user.following) - oneself,
114 note_count: user.info.note_count,
115 follower_count: user.info.follower_count,
116 locked: user.info.locked,
117 confirmation_pending: user.info.confirmation_pending,
118 default_scope: user.info.default_scope
122 def remote_user_creation(params) do
125 |> Map.put(:info, params[:info] || %{})
127 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
131 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
132 |> validate_required([:name, :ap_id])
133 |> unique_constraint(:nickname)
134 |> validate_format(:nickname, @email_regex)
135 |> validate_length(:bio, max: 5000)
136 |> validate_length(:name, max: 100)
137 |> put_change(:local, false)
138 |> put_embed(:info, info_cng)
141 case info_cng.changes[:source_data] do
142 %{"followers" => followers} ->
144 |> put_change(:follower_address, followers)
147 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
150 |> put_change(:follower_address, followers)
157 def update_changeset(struct, params \\ %{}) do
159 |> cast(params, [:bio, :name, :avatar])
160 |> unique_constraint(:nickname)
161 |> validate_format(:nickname, local_nickname_regex())
162 |> validate_length(:bio, max: 5000)
163 |> validate_length(:name, min: 1, max: 100)
166 def upgrade_changeset(struct, params \\ %{}) do
169 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
173 |> User.Info.user_upgrade(params[:info])
176 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
177 |> unique_constraint(:nickname)
178 |> validate_format(:nickname, local_nickname_regex())
179 |> validate_length(:bio, max: 5000)
180 |> validate_length(:name, max: 100)
181 |> put_embed(:info, info_cng)
184 def password_update_changeset(struct, params) do
187 |> cast(params, [:password, :password_confirmation])
188 |> validate_required([:password, :password_confirmation])
189 |> validate_confirmation(:password)
191 OAuth.Token.delete_user_tokens(struct)
192 OAuth.Authorization.delete_user_authorizations(struct)
194 if changeset.valid? do
195 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
198 |> put_change(:password_hash, hashed)
204 def reset_password(user, data) do
205 update_and_set_cache(password_update_changeset(user, data))
208 def register_changeset(struct, params \\ %{}, opts \\ []) do
209 confirmation_status =
210 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
216 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
220 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
221 |> validate_required([:name, :nickname, :password, :password_confirmation])
222 |> validate_confirmation(:password)
223 |> unique_constraint(:email)
224 |> unique_constraint(:nickname)
225 |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
226 |> validate_format(:nickname, local_nickname_regex())
227 |> validate_format(:email, @email_regex)
228 |> validate_length(:bio, max: 1000)
229 |> validate_length(:name, min: 1, max: 100)
230 |> put_change(:info, info_change)
233 if opts[:external] do
236 validate_required(changeset, [:email])
239 if changeset.valid? do
240 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
241 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
242 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
245 |> put_change(:password_hash, hashed)
246 |> put_change(:ap_id, ap_id)
247 |> unique_constraint(:ap_id)
248 |> put_change(:following, [followers])
249 |> put_change(:follower_address, followers)
255 defp autofollow_users(user) do
256 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
260 where: u.local == true,
261 where: u.nickname in ^candidates
265 follow_all(user, autofollowed_users)
268 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
269 def register(%Ecto.Changeset{} = changeset) do
270 with {:ok, user} <- Repo.insert(changeset),
271 {:ok, user} <- autofollow_users(user),
272 {:ok, _} <- Pleroma.User.WelcomeMessage.post_welcome_message_to_user(user),
273 {:ok, _} <- try_send_confirmation_email(user) do
278 def try_send_confirmation_email(%User{} = user) do
279 if user.info.confirmation_pending &&
280 Pleroma.Config.get([:instance, :account_activation_required]) do
282 |> Pleroma.UserEmail.account_confirmation_email()
283 |> Pleroma.Mailer.deliver_async()
289 def needs_update?(%User{local: true}), do: false
291 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
293 def needs_update?(%User{local: false} = user) do
294 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
297 def needs_update?(_), do: true
299 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
303 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
304 follow(follower, followed)
307 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
308 if not User.ap_enabled?(followed) do
309 follow(follower, followed)
315 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
316 if not following?(follower, followed) do
317 follow(follower, followed)
323 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
324 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
325 def follow_all(follower, followeds) do
328 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
329 |> Enum.map(fn %{follower_address: fa} -> fa end)
333 where: u.id == ^follower.id,
338 "array(select distinct unnest (array_cat(?, ?)))",
347 {1, [follower]} = Repo.update_all(q, [])
349 Enum.each(followeds, fn followed ->
350 update_follower_count(followed)
356 def follow(%User{} = follower, %User{info: info} = followed) do
357 user_config = Application.get_env(:pleroma, :user)
358 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
360 ap_followers = followed.follower_address
363 following?(follower, followed) or info.deactivated ->
364 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
366 deny_follow_blocked and blocks?(followed, follower) ->
367 {:error, "Could not follow user: #{followed.nickname} blocked you."}
370 if !followed.local && follower.local && !ap_enabled?(followed) do
371 Websub.subscribe(follower, followed)
376 where: u.id == ^follower.id,
377 update: [push: [following: ^ap_followers]],
381 {1, [follower]} = Repo.update_all(q, [])
383 {:ok, _} = update_follower_count(followed)
389 def unfollow(%User{} = follower, %User{} = followed) do
390 ap_followers = followed.follower_address
392 if following?(follower, followed) and follower.ap_id != followed.ap_id do
395 where: u.id == ^follower.id,
396 update: [pull: [following: ^ap_followers]],
400 {1, [follower]} = Repo.update_all(q, [])
402 {:ok, followed} = update_follower_count(followed)
406 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
408 {:error, "Not subscribed!"}
412 @spec following?(User.t(), User.t()) :: boolean
413 def following?(%User{} = follower, %User{} = followed) do
414 Enum.member?(follower.following, followed.follower_address)
417 def follow_import(%User{} = follower, followed_identifiers)
418 when is_list(followed_identifiers) do
420 followed_identifiers,
421 fn followed_identifier ->
422 with %User{} = followed <- get_or_fetch(followed_identifier),
423 {:ok, follower} <- maybe_direct_follow(follower, followed),
424 {:ok, _} <- ActivityPub.follow(follower, followed) do
428 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
435 def locked?(%User{} = user) do
436 user.info.locked || false
440 Repo.get_by(User, id: id)
443 def get_by_ap_id(ap_id) do
444 Repo.get_by(User, ap_id: ap_id)
447 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
448 # of the ap_id and the domain and tries to get that user
449 def get_by_guessed_nickname(ap_id) do
450 domain = URI.parse(ap_id).host
451 name = List.last(String.split(ap_id, "/"))
452 nickname = "#{name}@#{domain}"
454 get_by_nickname(nickname)
457 def set_cache(user) do
458 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
459 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
460 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
464 def update_and_set_cache(changeset) do
465 with {:ok, user} <- Repo.update(changeset) do
472 def invalidate_cache(user) do
473 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
474 Cachex.del(:user_cache, "nickname:#{user.nickname}")
475 Cachex.del(:user_cache, "user_info:#{user.id}")
478 def get_cached_by_ap_id(ap_id) do
479 key = "ap_id:#{ap_id}"
480 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
483 def get_cached_by_id(id) do
487 Cachex.fetch!(:user_cache, key, fn _ ->
491 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
492 {:commit, user.ap_id}
498 get_cached_by_ap_id(ap_id)
501 def get_cached_by_nickname(nickname) do
502 key = "nickname:#{nickname}"
503 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
506 def get_cached_by_nickname_or_id(nickname_or_id) do
507 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
510 def get_by_nickname(nickname) do
511 Repo.get_by(User, nickname: nickname) ||
512 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
513 Repo.get_by(User, nickname: local_nickname(nickname))
517 def get_by_email(email), do: Repo.get_by(User, email: email)
519 def get_by_nickname_or_email(nickname_or_email) do
520 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
523 def get_cached_user_info(user) do
524 key = "user_info:#{user.id}"
525 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
528 def fetch_by_nickname(nickname) do
529 ap_try = ActivityPub.make_user_from_nickname(nickname)
532 {:ok, user} -> {:ok, user}
533 _ -> OStatus.make_user(nickname)
537 def get_or_fetch_by_nickname(nickname) do
538 with %User{} = user <- get_by_nickname(nickname) do
542 with [_nick, _domain] <- String.split(nickname, "@"),
543 {:ok, user} <- fetch_by_nickname(nickname) do
544 if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
545 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
555 @doc "Fetch some posts when the user has just been federated with"
556 def fetch_initial_posts(user) do
557 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
560 # Insert all the posts in reverse order, so they're in the right order on the timeline
561 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
562 &Pleroma.Web.Federator.incoming_ap_doc/1
566 def get_followers_query(%User{id: id, follower_address: follower_address}, nil) do
569 where: fragment("? <@ ?", ^[follower_address], u.following),
574 def get_followers_query(user, page) do
575 from(u in get_followers_query(user, nil))
576 |> paginate(page, 20)
579 def get_followers_query(user), do: get_followers_query(user, nil)
581 def get_followers(user, page \\ nil) do
582 q = get_followers_query(user, page)
587 def get_followers_ids(user, page \\ nil) do
588 q = get_followers_query(user, page)
590 Repo.all(from(u in q, select: u.id))
593 def get_friends_query(%User{id: id, following: following}, nil) do
596 where: u.follower_address in ^following,
601 def get_friends_query(user, page) do
602 from(u in get_friends_query(user, nil))
603 |> paginate(page, 20)
606 def get_friends_query(user), do: get_friends_query(user, nil)
608 def get_friends(user, page \\ nil) do
609 q = get_friends_query(user, page)
614 def get_friends_ids(user, page \\ nil) do
615 q = get_friends_query(user, page)
617 Repo.all(from(u in q, select: u.id))
620 def get_follow_requests_query(%User{} = user) do
625 "? ->> 'type' = 'Follow'",
630 "? ->> 'state' = 'pending'",
635 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
643 def get_follow_requests(%User{} = user) do
646 |> User.get_follow_requests_query()
647 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
648 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
649 |> group_by([a, u], u.id)
656 def increase_note_count(%User{} = user) do
658 |> where(id: ^user.id)
663 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
670 |> Repo.update_all([])
672 {1, [user]} -> set_cache(user)
677 def decrease_note_count(%User{} = user) do
679 |> where(id: ^user.id)
684 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
691 |> Repo.update_all([])
693 {1, [user]} -> set_cache(user)
698 def update_note_count(%User{} = user) do
702 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
706 note_count = Repo.one(note_count_query)
708 info_cng = User.Info.set_note_count(user.info, note_count)
712 |> put_embed(:info, info_cng)
714 update_and_set_cache(cng)
717 def update_follower_count(%User{} = user) do
718 follower_count_query =
720 |> where([u], ^user.follower_address in u.following)
721 |> where([u], u.id != ^user.id)
722 |> select([u], %{count: count(u.id)})
725 |> where(id: ^user.id)
726 |> join(:inner, [u], s in subquery(follower_count_query))
731 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
738 |> Repo.update_all([])
740 {1, [user]} -> set_cache(user)
745 def get_users_from_set_query(ap_ids, false) do
748 where: u.ap_id in ^ap_ids
752 def get_users_from_set_query(ap_ids, true) do
753 query = get_users_from_set_query(ap_ids, false)
757 where: u.local == true
761 def get_users_from_set(ap_ids, local_only \\ true) do
762 get_users_from_set_query(ap_ids, local_only)
766 def get_recipients_from_activity(%Activity{recipients: to}) do
770 where: u.ap_id in ^to,
771 or_where: fragment("? && ?", u.following, ^to)
774 query = from(u in query, where: u.local == true)
779 def search(query, resolve \\ false, for_user \\ nil) do
780 # Strip the beginning @ off if there is a query
781 query = String.trim_leading(query, "@")
783 if resolve, do: get_or_fetch(query)
786 Repo.transaction(fn ->
787 Ecto.Adapters.SQL.query(Repo, "select set_limit(0.25)", [])
788 Repo.all(search_query(query, for_user))
794 def search_query(query, for_user) do
795 fts_subquery = fts_search_subquery(query)
796 trigram_subquery = trigram_search_subquery(query)
797 union_query = from(s in trigram_subquery, union_all: ^fts_subquery)
798 distinct_query = from(s in subquery(union_query), order_by: s.search_type, distinct: s.id)
800 from(s in subquery(boost_search_rank_query(distinct_query, for_user)),
801 order_by: [desc: s.search_rank],
806 defp boost_search_rank_query(query, nil), do: query
808 defp boost_search_rank_query(query, for_user) do
809 friends_ids = get_friends_ids(for_user)
810 followers_ids = get_followers_ids(for_user)
812 from(u in subquery(query),
817 CASE WHEN (?) THEN (?) * 1.3
818 WHEN (?) THEN (?) * 1.2
819 WHEN (?) THEN (?) * 1.1
822 u.id in ^friends_ids and u.id in ^followers_ids,
824 u.id in ^friends_ids,
826 u.id in ^followers_ids,
834 defp fts_search_subquery(term, query \\ User) do
837 |> String.replace(~r/\W+/, " ")
840 |> Enum.map(&(&1 <> ":*"))
851 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
852 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
853 to_tsquery('simple', ?),
865 (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
866 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
875 defp trigram_search_subquery(term) do
879 # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
880 search_type: fragment("?", 1),
883 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
889 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
893 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
896 fn blocked_identifier ->
897 with %User{} = blocked <- get_or_fetch(blocked_identifier),
898 {:ok, blocker} <- block(blocker, blocked),
899 {:ok, _} <- ActivityPub.block(blocker, blocked) do
903 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
910 def mute(muter, %User{ap_id: ap_id}) do
913 |> User.Info.add_to_mutes(ap_id)
917 |> put_embed(:info, info_cng)
919 update_and_set_cache(cng)
922 def unmute(muter, %{ap_id: ap_id}) do
925 |> User.Info.remove_from_mutes(ap_id)
929 |> put_embed(:info, info_cng)
931 update_and_set_cache(cng)
934 def block(blocker, %User{ap_id: ap_id} = blocked) do
935 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
937 if following?(blocker, blocked) do
938 {:ok, blocker, _} = unfollow(blocker, blocked)
944 if following?(blocked, blocker) do
945 unfollow(blocked, blocker)
950 |> User.Info.add_to_block(ap_id)
954 |> put_embed(:info, info_cng)
956 update_and_set_cache(cng)
959 # helper to handle the block given only an actor's AP id
960 def block(blocker, %{ap_id: ap_id}) do
961 block(blocker, User.get_by_ap_id(ap_id))
964 def unblock(blocker, %{ap_id: ap_id}) do
967 |> User.Info.remove_from_block(ap_id)
971 |> put_embed(:info, info_cng)
973 update_and_set_cache(cng)
976 def mutes?(nil, _), do: false
977 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
979 def blocks?(user, %{ap_id: ap_id}) do
980 blocks = user.info.blocks
981 domain_blocks = user.info.domain_blocks
982 %{host: host} = URI.parse(ap_id)
984 Enum.member?(blocks, ap_id) ||
985 Enum.any?(domain_blocks, fn domain ->
990 def muted_users(user),
991 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.mutes))
993 def blocked_users(user),
994 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
996 def block_domain(user, domain) do
999 |> User.Info.add_to_domain_block(domain)
1003 |> put_embed(:info, info_cng)
1005 update_and_set_cache(cng)
1008 def unblock_domain(user, domain) do
1011 |> User.Info.remove_from_domain_block(domain)
1015 |> put_embed(:info, info_cng)
1017 update_and_set_cache(cng)
1020 def maybe_local_user_query(query, local) do
1021 if local, do: local_user_query(query), else: query
1024 def local_user_query(query \\ User) do
1027 where: u.local == true,
1028 where: not is_nil(u.nickname)
1032 def maybe_external_user_query(query, external) do
1033 if external, do: external_user_query(query), else: query
1036 def external_user_query(query \\ User) do
1039 where: u.local == false,
1040 where: not is_nil(u.nickname)
1044 def maybe_active_user_query(query, active) do
1045 if active, do: active_user_query(query), else: query
1048 def active_user_query(query \\ User) do
1051 where: fragment("not (?->'deactivated' @> 'true')", u.info),
1052 where: not is_nil(u.nickname)
1056 def maybe_deactivated_user_query(query, deactivated) do
1057 if deactivated, do: deactivated_user_query(query), else: query
1060 def deactivated_user_query(query \\ User) do
1063 where: fragment("(?->'deactivated' @> 'true')", u.info),
1064 where: not is_nil(u.nickname)
1068 def active_local_user_query do
1070 u in local_user_query(),
1071 where: fragment("not (?->'deactivated' @> 'true')", u.info)
1075 def moderator_user_query do
1078 where: u.local == true,
1079 where: fragment("?->'is_moderator' @> 'true'", u.info)
1083 def deactivate(%User{} = user, status \\ true) do
1084 info_cng = User.Info.set_activation_status(user.info, status)
1088 |> put_embed(:info, info_cng)
1090 update_and_set_cache(cng)
1093 def delete(%User{} = user) do
1094 {:ok, user} = User.deactivate(user)
1096 # Remove all relationships
1097 {:ok, followers} = User.get_followers(user)
1100 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
1102 {:ok, friends} = User.get_friends(user)
1105 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
1108 from(a in Activity, where: a.actor == ^user.ap_id)
1109 |> Activity.with_preloaded_object()
1112 |> Enum.each(fn activity ->
1113 case activity.data["type"] do
1115 ActivityPub.delete(Object.normalize(activity))
1117 # TODO: Do something with likes, follows, repeats.
1126 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1127 Pleroma.HTML.Scrubber.TwitterText
1130 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
1132 def html_filter_policy(_), do: @default_scrubbers
1134 def fetch_by_ap_id(ap_id) do
1135 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1142 case OStatus.make_user(ap_id) do
1144 _ -> {:error, "Could not fetch by AP id"}
1149 def get_or_fetch_by_ap_id(ap_id) do
1150 user = get_by_ap_id(ap_id)
1152 if !is_nil(user) and !User.needs_update?(user) do
1155 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1156 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1158 user = fetch_by_ap_id(ap_id)
1160 if should_fetch_initial do
1161 with %User{} = user do
1162 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
1170 def get_or_create_instance_user do
1171 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1173 if user = get_by_ap_id(relay_uri) do
1177 %User{info: %User.Info{}}
1178 |> cast(%{}, [:ap_id, :nickname, :local])
1179 |> put_change(:ap_id, relay_uri)
1180 |> put_change(:nickname, nil)
1181 |> put_change(:local, true)
1182 |> put_change(:follower_address, relay_uri <> "/followers")
1184 {:ok, user} = Repo.insert(changes)
1190 def public_key_from_info(%{
1191 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1195 |> :public_key.pem_decode()
1197 |> :public_key.pem_entry_decode()
1203 def public_key_from_info(%{magic_key: magic_key}) do
1204 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1207 def get_public_key_for_ap_id(ap_id) do
1208 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
1209 {:ok, public_key} <- public_key_from_info(user.info) do
1216 defp blank?(""), do: nil
1217 defp blank?(n), do: n
1219 def insert_or_update_user(data) do
1222 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1224 cs = User.remote_user_creation(data)
1226 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
1229 def ap_enabled?(%User{local: true}), do: true
1230 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1231 def ap_enabled?(_), do: false
1233 @doc "Gets or fetch a user by uri or nickname."
1234 @spec get_or_fetch(String.t()) :: User.t()
1235 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1236 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1238 # wait a period of time and return newest version of the User structs
1239 # this is because we have synchronous follow APIs and need to simulate them
1240 # with an async handshake
1241 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1242 with %User{} = a <- Repo.get(User, a.id),
1243 %User{} = b <- Repo.get(User, b.id) do
1251 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1252 with :ok <- :timer.sleep(timeout),
1253 %User{} = a <- Repo.get(User, a.id),
1254 %User{} = b <- Repo.get(User, b.id) do
1262 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
1263 def parse_bio(nil, _user), do: ""
1264 def parse_bio(bio, _user) when bio == "", do: bio
1266 def parse_bio(bio, user) do
1268 (user.info.source_data["tag"] || [])
1269 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
1270 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
1271 {String.trim(name, ":"), url}
1274 # TODO: get profile URLs other than user.ap_id
1275 profile_urls = [user.ap_id]
1278 |> CommonUtils.format_input("text/plain",
1279 mentions_format: :full,
1280 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1283 |> Formatter.emojify(emoji)
1286 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1287 Repo.transaction(fn ->
1288 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1292 def tag(nickname, tags) when is_binary(nickname),
1293 do: tag(User.get_by_nickname(nickname), tags)
1295 def tag(%User{} = user, tags),
1296 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1298 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1299 Repo.transaction(fn ->
1300 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1304 def untag(nickname, tags) when is_binary(nickname),
1305 do: untag(User.get_by_nickname(nickname), tags)
1307 def untag(%User{} = user, tags),
1308 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1310 defp update_tags(%User{} = user, new_tags) do
1311 {:ok, updated_user} =
1313 |> change(%{tags: new_tags})
1314 |> update_and_set_cache()
1319 def bookmark(%User{} = user, status_id) do
1320 bookmarks = Enum.uniq(user.bookmarks ++ [status_id])
1321 update_bookmarks(user, bookmarks)
1324 def unbookmark(%User{} = user, status_id) do
1325 bookmarks = Enum.uniq(user.bookmarks -- [status_id])
1326 update_bookmarks(user, bookmarks)
1329 def update_bookmarks(%User{} = user, bookmarks) do
1331 |> change(%{bookmarks: bookmarks})
1332 |> update_and_set_cache
1335 defp normalize_tags(tags) do
1338 |> Enum.map(&String.downcase(&1))
1341 defp local_nickname_regex do
1342 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1343 @extended_local_nickname_regex
1345 @strict_local_nickname_regex
1349 def local_nickname(nickname_or_mention) do
1352 |> String.split("@")
1356 def full_nickname(nickname_or_mention),
1357 do: String.trim_leading(nickname_or_mention, "@")
1359 def error_user(ap_id) do
1364 nickname: "erroruser@example.com",
1365 inserted_at: NaiveDateTime.utc_now()
1369 def all_superusers do
1372 where: u.local == true,
1373 where: fragment("?->'is_admin' @> 'true' OR ?->'is_moderator' @> 'true'", u.info, u.info)
1378 defp paginate(query, page, page_size) do
1381 offset: ^((page - 1) * page_size)
1385 def showing_reblogs?(%User{} = user, %User{} = target) do
1386 target.ap_id not in user.info.muted_reblogs