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.Bookmark
14 alias Pleroma.Formatter
15 alias Pleroma.Notification
17 alias Pleroma.Registration
21 alias Pleroma.Web.ActivityPub.ActivityPub
22 alias Pleroma.Web.ActivityPub.Utils
23 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
24 alias Pleroma.Web.OAuth
25 alias Pleroma.Web.OStatus
26 alias Pleroma.Web.RelMe
27 alias Pleroma.Web.Websub
31 @type t :: %__MODULE__{}
33 @primary_key {:id, Pleroma.FlakeId, autogenerate: true}
35 # credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
36 @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])?)*$/
38 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
39 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
43 field(:email, :string)
45 field(:nickname, :string)
46 field(:password_hash, :string)
47 field(:password, :string, virtual: true)
48 field(:password_confirmation, :string, virtual: true)
49 field(:following, {:array, :string}, default: [])
50 field(:ap_id, :string)
52 field(:local, :boolean, default: true)
53 field(:follower_address, :string)
54 field(:search_rank, :float, virtual: true)
55 field(:search_type, :integer, virtual: true)
56 field(:tags, {:array, :string}, default: [])
57 field(:last_refreshed_at, :naive_datetime_usec)
58 has_many(:bookmarks, Bookmark)
59 has_many(:notifications, Notification)
60 has_many(:registrations, Registration)
61 embeds_one(:info, Pleroma.User.Info)
66 def auth_active?(%User{info: %User.Info{confirmation_pending: true}}),
67 do: !Pleroma.Config.get([:instance, :account_activation_required])
69 def auth_active?(%User{}), do: true
71 def visible_for?(user, for_user \\ nil)
73 def visible_for?(%User{id: user_id}, %User{id: for_id}) when user_id == for_id, do: true
75 def visible_for?(%User{} = user, for_user) do
76 auth_active?(user) || superuser?(for_user)
79 def visible_for?(_, _), do: false
81 def superuser?(%User{local: true, info: %User.Info{is_admin: true}}), do: true
82 def superuser?(%User{local: true, info: %User.Info{is_moderator: true}}), do: true
83 def superuser?(_), do: false
85 def avatar_url(user, options \\ []) do
87 %{"url" => [%{"href" => href} | _]} -> href
88 _ -> !options[:no_default] && "#{Web.base_url()}/images/avi.png"
92 def banner_url(user, options \\ []) do
93 case user.info.banner do
94 %{"url" => [%{"href" => href} | _]} -> href
95 _ -> !options[:no_default] && "#{Web.base_url()}/images/banner.png"
99 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
100 def profile_url(%User{ap_id: ap_id}), do: ap_id
101 def profile_url(_), do: nil
103 def ap_id(%User{nickname: nickname}) do
104 "#{Web.base_url()}/users/#{nickname}"
107 def ap_followers(%User{follower_address: fa}) when is_binary(fa), do: fa
108 def ap_followers(%User{} = user), do: "#{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([: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)
234 if opts[:external] do
237 validate_required(changeset, [:email])
240 if changeset.valid? do
241 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
242 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
243 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
246 |> put_change(:password_hash, hashed)
247 |> put_change(:ap_id, ap_id)
248 |> unique_constraint(:ap_id)
249 |> put_change(:following, [followers])
250 |> put_change(:follower_address, followers)
256 defp autofollow_users(user) do
257 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
261 where: u.local == true,
262 where: u.nickname in ^candidates
266 follow_all(user, autofollowed_users)
269 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
270 def register(%Ecto.Changeset{} = changeset) do
271 with {:ok, user} <- Repo.insert(changeset),
272 {:ok, user} <- autofollow_users(user),
273 {:ok, user} <- set_cache(user),
274 {:ok, _} <- Pleroma.User.WelcomeMessage.post_welcome_message_to_user(user),
275 {:ok, _} <- try_send_confirmation_email(user) do
280 def try_send_confirmation_email(%User{} = user) do
281 if user.info.confirmation_pending &&
282 Pleroma.Config.get([:instance, :account_activation_required]) do
284 |> Pleroma.Emails.UserEmail.account_confirmation_email()
285 |> Pleroma.Emails.Mailer.deliver_async()
293 def needs_update?(%User{local: true}), do: false
295 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
297 def needs_update?(%User{local: false} = user) do
298 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
301 def needs_update?(_), do: true
303 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
307 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
308 follow(follower, followed)
311 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
312 if not User.ap_enabled?(followed) do
313 follow(follower, followed)
319 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
320 if not following?(follower, followed) do
321 follow(follower, followed)
327 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
328 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
329 def follow_all(follower, followeds) do
332 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
333 |> Enum.map(fn %{follower_address: fa} -> fa end)
337 where: u.id == ^follower.id,
342 "array(select distinct unnest (array_cat(?, ?)))",
351 {1, [follower]} = Repo.update_all(q, [])
353 Enum.each(followeds, fn followed ->
354 update_follower_count(followed)
360 def follow(%User{} = follower, %User{info: info} = followed) do
361 user_config = Application.get_env(:pleroma, :user)
362 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
364 ap_followers = followed.follower_address
367 following?(follower, followed) or info.deactivated ->
368 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
370 deny_follow_blocked and blocks?(followed, follower) ->
371 {:error, "Could not follow user: #{followed.nickname} blocked you."}
374 if !followed.local && follower.local && !ap_enabled?(followed) do
375 Websub.subscribe(follower, followed)
380 where: u.id == ^follower.id,
381 update: [push: [following: ^ap_followers]],
385 {1, [follower]} = Repo.update_all(q, [])
387 {:ok, _} = update_follower_count(followed)
393 def unfollow(%User{} = follower, %User{} = followed) do
394 ap_followers = followed.follower_address
396 if following?(follower, followed) and follower.ap_id != followed.ap_id do
399 where: u.id == ^follower.id,
400 update: [pull: [following: ^ap_followers]],
404 {1, [follower]} = Repo.update_all(q, [])
406 {:ok, followed} = update_follower_count(followed)
410 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
412 {:error, "Not subscribed!"}
416 @spec following?(User.t(), User.t()) :: boolean
417 def following?(%User{} = follower, %User{} = followed) do
418 Enum.member?(follower.following, followed.follower_address)
421 def follow_import(%User{} = follower, followed_identifiers)
422 when is_list(followed_identifiers) do
424 followed_identifiers,
425 fn followed_identifier ->
426 with {:ok, %User{} = followed} <- get_or_fetch(followed_identifier),
427 {:ok, follower} <- maybe_direct_follow(follower, followed),
428 {:ok, _} <- ActivityPub.follow(follower, followed) do
432 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
439 def locked?(%User{} = user) do
440 user.info.locked || false
444 Repo.get_by(User, id: id)
447 def get_by_ap_id(ap_id) do
448 Repo.get_by(User, ap_id: ap_id)
451 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
452 # of the ap_id and the domain and tries to get that user
453 def get_by_guessed_nickname(ap_id) do
454 domain = URI.parse(ap_id).host
455 name = List.last(String.split(ap_id, "/"))
456 nickname = "#{name}@#{domain}"
458 get_cached_by_nickname(nickname)
461 def set_cache({:ok, user}), do: set_cache(user)
462 def set_cache({:error, err}), do: {:error, err}
464 def set_cache(%User{} = user) do
465 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
466 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
467 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
471 def update_and_set_cache(changeset) do
472 with {:ok, user} <- Repo.update(changeset) do
479 def invalidate_cache(user) do
480 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
481 Cachex.del(:user_cache, "nickname:#{user.nickname}")
482 Cachex.del(:user_cache, "user_info:#{user.id}")
485 def get_cached_by_ap_id(ap_id) do
486 key = "ap_id:#{ap_id}"
487 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
490 def get_cached_by_id(id) do
494 Cachex.fetch!(:user_cache, key, fn _ ->
498 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
499 {:commit, user.ap_id}
505 get_cached_by_ap_id(ap_id)
508 def get_cached_by_nickname(nickname) do
509 key = "nickname:#{nickname}"
511 Cachex.fetch!(:user_cache, key, fn ->
512 user_result = get_or_fetch_by_nickname(nickname)
515 {:ok, user} -> {:commit, user}
516 {:error, _error} -> {:ignore, nil}
521 def get_cached_by_nickname_or_id(nickname_or_id) do
522 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
525 def get_by_nickname(nickname) do
526 Repo.get_by(User, nickname: nickname) ||
527 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
528 Repo.get_by(User, nickname: local_nickname(nickname))
532 def get_by_email(email), do: Repo.get_by(User, email: email)
534 def get_by_nickname_or_email(nickname_or_email) do
535 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
538 def get_cached_user_info(user) do
539 key = "user_info:#{user.id}"
540 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
543 def fetch_by_nickname(nickname) do
544 ap_try = ActivityPub.make_user_from_nickname(nickname)
547 {:ok, user} -> {:ok, user}
548 _ -> OStatus.make_user(nickname)
552 def get_or_fetch_by_nickname(nickname) do
553 with %User{} = user <- get_by_nickname(nickname) do
557 with [_nick, _domain] <- String.split(nickname, "@"),
558 {:ok, user} <- fetch_by_nickname(nickname) do
559 if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
561 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
566 _e -> {:error, "not found " <> nickname}
571 @doc "Fetch some posts when the user has just been federated with"
572 def fetch_initial_posts(user) do
573 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
576 # Insert all the posts in reverse order, so they're in the right order on the timeline
577 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
578 &Pleroma.Web.Federator.incoming_ap_doc/1
582 def get_followers_query(%User{id: id, follower_address: follower_address}, nil) do
585 where: fragment("? <@ ?", ^[follower_address], u.following),
590 def get_followers_query(user, page) do
591 from(u in get_followers_query(user, nil))
592 |> paginate(page, 20)
595 def get_followers_query(user), do: get_followers_query(user, nil)
597 def get_followers(user, page \\ nil) do
598 q = get_followers_query(user, page)
603 def get_followers_ids(user, page \\ nil) do
604 q = get_followers_query(user, page)
606 Repo.all(from(u in q, select: u.id))
609 def get_friends_query(%User{id: id, following: following}, nil) do
612 where: u.follower_address in ^following,
617 def get_friends_query(user, page) do
618 from(u in get_friends_query(user, nil))
619 |> paginate(page, 20)
622 def get_friends_query(user), do: get_friends_query(user, nil)
624 def get_friends(user, page \\ nil) do
625 q = get_friends_query(user, page)
630 def get_friends_ids(user, page \\ nil) do
631 q = get_friends_query(user, page)
633 Repo.all(from(u in q, select: u.id))
636 def get_follow_requests_query(%User{} = user) do
641 "? ->> 'type' = 'Follow'",
646 "? ->> 'state' = 'pending'",
651 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
659 def get_follow_requests(%User{} = user) do
662 |> User.get_follow_requests_query()
663 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
664 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
665 |> group_by([a, u], u.id)
672 def increase_note_count(%User{} = user) do
674 |> where(id: ^user.id)
679 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
686 |> Repo.update_all([])
688 {1, [user]} -> set_cache(user)
693 def decrease_note_count(%User{} = user) do
695 |> where(id: ^user.id)
700 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
707 |> Repo.update_all([])
709 {1, [user]} -> set_cache(user)
714 def update_note_count(%User{} = user) do
718 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
722 note_count = Repo.one(note_count_query)
724 info_cng = User.Info.set_note_count(user.info, note_count)
728 |> put_embed(:info, info_cng)
730 update_and_set_cache(cng)
733 def update_follower_count(%User{} = user) do
734 follower_count_query =
736 |> where([u], ^user.follower_address in u.following)
737 |> where([u], u.id != ^user.id)
738 |> select([u], %{count: count(u.id)})
741 |> where(id: ^user.id)
742 |> join(:inner, [u], s in subquery(follower_count_query))
747 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
754 |> Repo.update_all([])
756 {1, [user]} -> set_cache(user)
761 def get_users_from_set_query(ap_ids, false) do
764 where: u.ap_id in ^ap_ids
768 def get_users_from_set_query(ap_ids, true) do
769 query = get_users_from_set_query(ap_ids, false)
773 where: u.local == true
777 def get_users_from_set(ap_ids, local_only \\ true) do
778 get_users_from_set_query(ap_ids, local_only)
782 def get_recipients_from_activity(%Activity{recipients: to}) do
786 where: u.ap_id in ^to,
787 or_where: fragment("? && ?", u.following, ^to)
790 query = from(u in query, where: u.local == true)
795 def search(query, resolve \\ false, for_user \\ nil) do
796 # Strip the beginning @ off if there is a query
797 query = String.trim_leading(query, "@")
799 if resolve, do: get_or_fetch(query)
802 Repo.transaction(fn ->
803 Ecto.Adapters.SQL.query(Repo, "select set_limit(0.25)", [])
804 Repo.all(search_query(query, for_user))
810 def search_query(query, for_user) do
811 fts_subquery = fts_search_subquery(query)
812 trigram_subquery = trigram_search_subquery(query)
813 union_query = from(s in trigram_subquery, union_all: ^fts_subquery)
814 distinct_query = from(s in subquery(union_query), order_by: s.search_type, distinct: s.id)
816 from(s in subquery(boost_search_rank_query(distinct_query, for_user)),
817 order_by: [desc: s.search_rank],
822 defp boost_search_rank_query(query, nil), do: query
824 defp boost_search_rank_query(query, for_user) do
825 friends_ids = get_friends_ids(for_user)
826 followers_ids = get_followers_ids(for_user)
828 from(u in subquery(query),
833 CASE WHEN (?) THEN (?) * 1.3
834 WHEN (?) THEN (?) * 1.2
835 WHEN (?) THEN (?) * 1.1
838 u.id in ^friends_ids and u.id in ^followers_ids,
840 u.id in ^friends_ids,
842 u.id in ^followers_ids,
850 defp fts_search_subquery(term, query \\ User) do
853 |> String.replace(~r/\W+/, " ")
856 |> Enum.map(&(&1 <> ":*"))
867 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
868 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
869 to_tsquery('simple', ?),
881 (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
882 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
891 defp trigram_search_subquery(term) do
895 # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
896 search_type: fragment("?", 1),
899 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
905 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
909 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
912 fn blocked_identifier ->
913 with {:ok, %User{} = blocked} <- get_or_fetch(blocked_identifier),
914 {:ok, blocker} <- block(blocker, blocked),
915 {:ok, _} <- ActivityPub.block(blocker, blocked) do
919 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
926 def mute(muter, %User{ap_id: ap_id}) do
929 |> User.Info.add_to_mutes(ap_id)
933 |> put_embed(:info, info_cng)
935 update_and_set_cache(cng)
938 def unmute(muter, %{ap_id: ap_id}) do
941 |> User.Info.remove_from_mutes(ap_id)
945 |> put_embed(:info, info_cng)
947 update_and_set_cache(cng)
950 def subscribe(subscriber, %{ap_id: ap_id}) do
951 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
953 with %User{} = subscribed <- get_cached_by_ap_id(ap_id) do
954 blocked = blocks?(subscribed, subscriber) and deny_follow_blocked
957 {:error, "Could not subscribe: #{subscribed.nickname} is blocking you"}
961 |> User.Info.add_to_subscribers(subscriber.ap_id)
964 |> put_embed(:info, info_cng)
965 |> update_and_set_cache()
970 def unsubscribe(unsubscriber, %{ap_id: ap_id}) do
971 with %User{} = user <- get_cached_by_ap_id(ap_id) do
974 |> User.Info.remove_from_subscribers(unsubscriber.ap_id)
977 |> put_embed(:info, info_cng)
978 |> update_and_set_cache()
982 def block(blocker, %User{ap_id: ap_id} = blocked) do
983 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
985 if following?(blocker, blocked) do
986 {:ok, blocker, _} = unfollow(blocker, blocked)
993 if subscribed_to?(blocked, blocker) do
994 {:ok, blocker} = unsubscribe(blocked, blocker)
1000 if following?(blocked, blocker) do
1001 unfollow(blocked, blocker)
1004 {:ok, blocker} = update_follower_count(blocker)
1008 |> User.Info.add_to_block(ap_id)
1012 |> put_embed(:info, info_cng)
1014 update_and_set_cache(cng)
1017 # helper to handle the block given only an actor's AP id
1018 def block(blocker, %{ap_id: ap_id}) do
1019 block(blocker, get_cached_by_ap_id(ap_id))
1022 def unblock(blocker, %{ap_id: ap_id}) do
1025 |> User.Info.remove_from_block(ap_id)
1029 |> put_embed(:info, info_cng)
1031 update_and_set_cache(cng)
1034 def mutes?(nil, _), do: false
1035 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
1037 def blocks?(user, %{ap_id: ap_id}) do
1038 blocks = user.info.blocks
1039 domain_blocks = user.info.domain_blocks
1040 %{host: host} = URI.parse(ap_id)
1042 Enum.member?(blocks, ap_id) ||
1043 Enum.any?(domain_blocks, fn domain ->
1048 def subscribed_to?(user, %{ap_id: ap_id}) do
1049 with %User{} = target <- get_cached_by_ap_id(ap_id) do
1050 Enum.member?(target.info.subscribers, user.ap_id)
1054 def muted_users(user),
1055 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.mutes))
1057 def blocked_users(user),
1058 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
1060 def subscribers(user),
1061 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.subscribers))
1063 def block_domain(user, domain) do
1066 |> User.Info.add_to_domain_block(domain)
1070 |> put_embed(:info, info_cng)
1072 update_and_set_cache(cng)
1075 def unblock_domain(user, domain) do
1078 |> User.Info.remove_from_domain_block(domain)
1082 |> put_embed(:info, info_cng)
1084 update_and_set_cache(cng)
1087 def maybe_local_user_query(query, local) do
1088 if local, do: local_user_query(query), else: query
1091 def local_user_query(query \\ User) do
1094 where: u.local == true,
1095 where: not is_nil(u.nickname)
1099 def maybe_external_user_query(query, external) do
1100 if external, do: external_user_query(query), else: query
1103 def external_user_query(query \\ User) do
1106 where: u.local == false,
1107 where: not is_nil(u.nickname)
1111 def maybe_active_user_query(query, active) do
1112 if active, do: active_user_query(query), else: query
1115 def active_user_query(query \\ User) do
1118 where: fragment("not (?->'deactivated' @> 'true')", u.info),
1119 where: not is_nil(u.nickname)
1123 def maybe_deactivated_user_query(query, deactivated) do
1124 if deactivated, do: deactivated_user_query(query), else: query
1127 def deactivated_user_query(query \\ User) do
1130 where: fragment("(?->'deactivated' @> 'true')", u.info),
1131 where: not is_nil(u.nickname)
1135 def active_local_user_query do
1137 u in local_user_query(),
1138 where: fragment("not (?->'deactivated' @> 'true')", u.info)
1142 def moderator_user_query do
1145 where: u.local == true,
1146 where: fragment("?->'is_moderator' @> 'true'", u.info)
1150 def deactivate(%User{} = user, status \\ true) do
1151 info_cng = User.Info.set_activation_status(user.info, status)
1155 |> put_embed(:info, info_cng)
1157 update_and_set_cache(cng)
1160 def update_notification_settings(%User{} = user, settings \\ %{}) do
1161 info_changeset = User.Info.update_notification_settings(user.info, settings)
1164 |> put_embed(:info, info_changeset)
1165 |> update_and_set_cache()
1168 def delete(%User{} = user) do
1169 {:ok, user} = User.deactivate(user)
1171 # Remove all relationships
1172 {:ok, followers} = User.get_followers(user)
1174 Enum.each(followers, fn follower -> User.unfollow(follower, user) end)
1176 {:ok, friends} = User.get_friends(user)
1178 Enum.each(friends, fn followed -> User.unfollow(user, followed) end)
1180 delete_user_activities(user)
1183 def delete_user_activities(%User{ap_id: ap_id} = user) do
1185 |> where(actor: ^ap_id)
1186 |> Activity.with_preloaded_object()
1189 %{data: %{"type" => "Create"}} = activity ->
1190 activity |> Object.normalize() |> ActivityPub.delete()
1192 # TODO: Do something with likes, follows, repeats.
1200 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1201 Pleroma.HTML.Scrubber.TwitterText
1204 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
1206 def html_filter_policy(_), do: @default_scrubbers
1208 def fetch_by_ap_id(ap_id) do
1209 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1216 case OStatus.make_user(ap_id) do
1217 {:ok, user} -> {:ok, user}
1218 _ -> {:error, "Could not fetch by AP id"}
1223 def get_or_fetch_by_ap_id(ap_id) do
1224 user = get_cached_by_ap_id(ap_id)
1226 if !is_nil(user) and !User.needs_update?(user) do
1229 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1230 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1232 resp = fetch_by_ap_id(ap_id)
1234 if should_fetch_initial do
1235 with {:ok, %User{} = user} = resp do
1236 {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
1244 def get_or_create_instance_user do
1245 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1247 if user = get_cached_by_ap_id(relay_uri) do
1251 %User{info: %User.Info{}}
1252 |> cast(%{}, [:ap_id, :nickname, :local])
1253 |> put_change(:ap_id, relay_uri)
1254 |> put_change(:nickname, nil)
1255 |> put_change(:local, true)
1256 |> put_change(:follower_address, relay_uri <> "/followers")
1258 {:ok, user} = Repo.insert(changes)
1264 def public_key_from_info(%{
1265 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1269 |> :public_key.pem_decode()
1271 |> :public_key.pem_entry_decode()
1277 def public_key_from_info(%{magic_key: magic_key}) do
1278 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1281 def get_public_key_for_ap_id(ap_id) do
1282 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id),
1283 {:ok, public_key} <- public_key_from_info(user.info) do
1290 defp blank?(""), do: nil
1291 defp blank?(n), do: n
1293 def insert_or_update_user(data) do
1295 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1296 |> remote_user_creation()
1297 |> Repo.insert(on_conflict: :replace_all, conflict_target: :nickname)
1301 def ap_enabled?(%User{local: true}), do: true
1302 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1303 def ap_enabled?(_), do: false
1305 @doc "Gets or fetch a user by uri or nickname."
1306 @spec get_or_fetch(String.t()) :: User.t()
1307 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1308 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1310 # wait a period of time and return newest version of the User structs
1311 # this is because we have synchronous follow APIs and need to simulate them
1312 # with an async handshake
1313 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1314 with %User{} = a <- User.get_cached_by_id(a.id),
1315 %User{} = b <- User.get_cached_by_id(b.id) do
1323 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1324 with :ok <- :timer.sleep(timeout),
1325 %User{} = a <- User.get_cached_by_id(a.id),
1326 %User{} = b <- User.get_cached_by_id(b.id) do
1334 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
1335 def parse_bio(nil, _user), do: ""
1336 def parse_bio(bio, _user) when bio == "", do: bio
1338 def parse_bio(bio, user) do
1340 (user.info.source_data["tag"] || [])
1341 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
1342 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
1343 {String.trim(name, ":"), url}
1346 # TODO: get profile URLs other than user.ap_id
1347 profile_urls = [user.ap_id]
1350 |> CommonUtils.format_input("text/plain",
1351 mentions_format: :full,
1352 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1355 |> Formatter.emojify(emoji)
1358 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1359 Repo.transaction(fn ->
1360 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1364 def tag(nickname, tags) when is_binary(nickname),
1365 do: tag(get_by_nickname(nickname), tags)
1367 def tag(%User{} = user, tags),
1368 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1370 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1371 Repo.transaction(fn ->
1372 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1376 def untag(nickname, tags) when is_binary(nickname),
1377 do: untag(get_by_nickname(nickname), tags)
1379 def untag(%User{} = user, tags),
1380 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1382 defp update_tags(%User{} = user, new_tags) do
1383 {:ok, updated_user} =
1385 |> change(%{tags: new_tags})
1386 |> update_and_set_cache()
1391 defp normalize_tags(tags) do
1394 |> Enum.map(&String.downcase(&1))
1397 defp local_nickname_regex do
1398 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1399 @extended_local_nickname_regex
1401 @strict_local_nickname_regex
1405 def local_nickname(nickname_or_mention) do
1408 |> String.split("@")
1412 def full_nickname(nickname_or_mention),
1413 do: String.trim_leading(nickname_or_mention, "@")
1415 def error_user(ap_id) do
1420 nickname: "erroruser@example.com",
1421 inserted_at: NaiveDateTime.utc_now()
1425 def all_superusers do
1428 where: u.local == true,
1429 where: fragment("?->'is_admin' @> 'true' OR ?->'is_moderator' @> 'true'", u.info, u.info)
1434 defp paginate(query, page, page_size) do
1437 offset: ^((page - 1) * page_size)
1441 def showing_reblogs?(%User{} = user, %User{} = target) do
1442 target.ap_id not in user.info.muted_reblogs