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
13 alias Pleroma.Activity
15 alias Pleroma.Notification
17 alias Pleroma.Registration
19 alias Pleroma.RepoStreamer
22 alias Pleroma.Web.ActivityPub.ActivityPub
23 alias Pleroma.Web.ActivityPub.Utils
24 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
25 alias Pleroma.Web.OAuth
26 alias Pleroma.Web.OStatus
27 alias Pleroma.Web.RelMe
28 alias Pleroma.Web.Websub
32 @type t :: %__MODULE__{}
34 @primary_key {:id, Pleroma.FlakeId, autogenerate: true}
36 # credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
37 @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])?)*$/
39 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
40 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
44 field(:email, :string)
46 field(:nickname, :string)
47 field(:password_hash, :string)
48 field(:password, :string, virtual: true)
49 field(:password_confirmation, :string, virtual: true)
50 field(:following, {:array, :string}, default: [])
51 field(:ap_id, :string)
53 field(:local, :boolean, default: true)
54 field(:follower_address, :string)
55 field(:following_address, :string)
56 field(:search_rank, :float, virtual: true)
57 field(:search_type, :integer, virtual: true)
58 field(:tags, {:array, :string}, default: [])
59 field(:last_refreshed_at, :naive_datetime_usec)
60 has_many(:notifications, Notification)
61 has_many(:registrations, Registration)
62 embeds_one(:info, User.Info)
67 def auth_active?(%User{info: %User.Info{confirmation_pending: true}}),
68 do: !Pleroma.Config.get([:instance, :account_activation_required])
70 def auth_active?(%User{}), do: true
72 def visible_for?(user, for_user \\ nil)
74 def visible_for?(%User{id: user_id}, %User{id: for_id}) when user_id == for_id, do: true
76 def visible_for?(%User{} = user, for_user) do
77 auth_active?(user) || superuser?(for_user)
80 def visible_for?(_, _), do: false
82 def superuser?(%User{local: true, info: %User.Info{is_admin: true}}), do: true
83 def superuser?(%User{local: true, info: %User.Info{is_moderator: true}}), do: true
84 def superuser?(_), do: false
86 def avatar_url(user, options \\ []) do
88 %{"url" => [%{"href" => href} | _]} -> href
89 _ -> !options[:no_default] && "#{Web.base_url()}/images/avi.png"
93 def banner_url(user, options \\ []) do
94 case user.info.banner do
95 %{"url" => [%{"href" => href} | _]} -> href
96 _ -> !options[:no_default] && "#{Web.base_url()}/images/banner.png"
100 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
101 def profile_url(%User{ap_id: ap_id}), do: ap_id
102 def profile_url(_), do: nil
104 def ap_id(%User{nickname: nickname}) do
105 "#{Web.base_url()}/users/#{nickname}"
108 def ap_followers(%User{follower_address: fa}) when is_binary(fa), do: fa
109 def ap_followers(%User{} = user), do: "#{ap_id(user)}/followers"
111 @spec ap_following(User.t()) :: Sring.t()
112 def ap_following(%User{following_address: fa}) when is_binary(fa), do: fa
113 def ap_following(%User{} = user), do: "#{ap_id(user)}/following"
115 def user_info(%User{} = user, args \\ %{}) do
117 if args[:following_count],
118 do: args[:following_count],
119 else: user.info.following_count || following_count(user)
122 if args[:follower_count], do: args[:follower_count], else: user.info.follower_count
125 note_count: user.info.note_count,
126 locked: user.info.locked,
127 confirmation_pending: user.info.confirmation_pending,
128 default_scope: user.info.default_scope
130 |> Map.put(:following_count, following_count)
131 |> Map.put(:follower_count, follower_count)
134 def set_info_cache(user, args) do
135 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user, args))
138 @spec restrict_deactivated(Ecto.Query.t()) :: Ecto.Query.t()
139 def restrict_deactivated(query) do
141 where: not fragment("? \\? 'deactivated' AND ?->'deactivated' @> 'true'", u.info, u.info)
145 def following_count(%User{following: []}), do: 0
147 def following_count(%User{} = user) do
149 |> get_friends_query()
150 |> Repo.aggregate(:count, :id)
153 def remote_user_creation(params) do
156 |> Map.put(:info, params[:info] || %{})
158 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
162 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
163 |> validate_required([:name, :ap_id])
164 |> unique_constraint(:nickname)
165 |> validate_format(:nickname, @email_regex)
166 |> validate_length(:bio, max: 5000)
167 |> validate_length(:name, max: 100)
168 |> put_change(:local, false)
169 |> put_embed(:info, info_cng)
172 case info_cng.changes[:source_data] do
173 %{"followers" => followers, "following" => following} ->
175 |> put_change(:follower_address, followers)
176 |> put_change(:following_address, following)
179 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
182 |> put_change(:follower_address, followers)
189 def update_changeset(struct, params \\ %{}) do
191 |> cast(params, [:bio, :name, :avatar, :following])
192 |> unique_constraint(:nickname)
193 |> validate_format(:nickname, local_nickname_regex())
194 |> validate_length(:bio, max: 5000)
195 |> validate_length(:name, min: 1, max: 100)
198 def upgrade_changeset(struct, params \\ %{}) do
201 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
205 |> User.Info.user_upgrade(params[:info])
216 |> unique_constraint(:nickname)
217 |> validate_format(:nickname, local_nickname_regex())
218 |> validate_length(:bio, max: 5000)
219 |> validate_length(:name, max: 100)
220 |> put_embed(:info, info_cng)
223 def password_update_changeset(struct, params) do
225 |> cast(params, [:password, :password_confirmation])
226 |> validate_required([:password, :password_confirmation])
227 |> validate_confirmation(:password)
231 def reset_password(%User{id: user_id} = user, data) do
234 |> Multi.update(:user, password_update_changeset(user, data))
235 |> Multi.delete_all(:tokens, OAuth.Token.Query.get_by_user(user_id))
236 |> Multi.delete_all(:auth, OAuth.Authorization.delete_by_user_query(user))
238 case Repo.transaction(multi) do
239 {:ok, %{user: user} = _} -> set_cache(user)
240 {:error, _, changeset, _} -> {:error, changeset}
244 def register_changeset(struct, params \\ %{}, opts \\ []) do
246 if is_nil(opts[:need_confirmation]) do
247 Pleroma.Config.get([:instance, :account_activation_required])
249 opts[:need_confirmation]
253 User.Info.confirmation_changeset(%User.Info{}, need_confirmation: need_confirmation?)
257 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
258 |> validate_required([:name, :nickname, :password, :password_confirmation])
259 |> validate_confirmation(:password)
260 |> unique_constraint(:email)
261 |> unique_constraint(:nickname)
262 |> validate_exclusion(:nickname, Pleroma.Config.get([User, :restricted_nicknames]))
263 |> validate_format(:nickname, local_nickname_regex())
264 |> validate_format(:email, @email_regex)
265 |> validate_length(:bio, max: 1000)
266 |> validate_length(:name, min: 1, max: 100)
267 |> put_change(:info, info_change)
270 if opts[:external] do
273 validate_required(changeset, [:email])
276 if changeset.valid? do
277 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
278 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
282 |> put_change(:ap_id, ap_id)
283 |> unique_constraint(:ap_id)
284 |> put_change(:following, [followers])
285 |> put_change(:follower_address, followers)
291 defp autofollow_users(user) do
292 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
295 User.Query.build(%{nickname: candidates, local: true, deactivated: false})
298 follow_all(user, autofollowed_users)
301 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
302 def register(%Ecto.Changeset{} = changeset) do
303 with {:ok, user} <- Repo.insert(changeset),
304 {:ok, user} <- autofollow_users(user),
305 {:ok, user} <- set_cache(user),
306 {:ok, _} <- User.WelcomeMessage.post_welcome_message_to_user(user),
307 {:ok, _} <- try_send_confirmation_email(user) do
312 def try_send_confirmation_email(%User{} = user) do
313 if user.info.confirmation_pending &&
314 Pleroma.Config.get([:instance, :account_activation_required]) do
316 |> Pleroma.Emails.UserEmail.account_confirmation_email()
317 |> Pleroma.Emails.Mailer.deliver_async()
325 def needs_update?(%User{local: true}), do: false
327 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
329 def needs_update?(%User{local: false} = user) do
330 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
333 def needs_update?(_), do: true
335 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
339 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
340 follow(follower, followed)
343 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
344 if not User.ap_enabled?(followed) do
345 follow(follower, followed)
351 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
352 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
353 def follow_all(follower, followeds) do
356 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
357 |> Enum.map(fn %{follower_address: fa} -> fa end)
361 where: u.id == ^follower.id,
366 "array(select distinct unnest (array_cat(?, ?)))",
375 {1, [follower]} = Repo.update_all(q, [])
377 Enum.each(followeds, fn followed ->
378 update_follower_count(followed)
384 def follow(%User{} = follower, %User{info: info} = followed) do
385 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
386 ap_followers = followed.follower_address
390 {:error, "Could not follow user: You are deactivated."}
392 deny_follow_blocked and blocks?(followed, follower) ->
393 {:error, "Could not follow user: #{followed.nickname} blocked you."}
396 if !followed.local && follower.local && !ap_enabled?(followed) do
397 Websub.subscribe(follower, followed)
402 where: u.id == ^follower.id,
403 update: [push: [following: ^ap_followers]],
407 {1, [follower]} = Repo.update_all(q, [])
409 follower = maybe_update_following_count(follower)
411 {:ok, _} = update_follower_count(followed)
417 def unfollow(%User{} = follower, %User{} = followed) do
418 ap_followers = followed.follower_address
420 if following?(follower, followed) and follower.ap_id != followed.ap_id do
423 where: u.id == ^follower.id,
424 update: [pull: [following: ^ap_followers]],
428 {1, [follower]} = Repo.update_all(q, [])
430 follower = maybe_update_following_count(follower)
432 {:ok, followed} = update_follower_count(followed)
436 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
438 {:error, "Not subscribed!"}
442 @spec following?(User.t(), User.t()) :: boolean
443 def following?(%User{} = follower, %User{} = followed) do
444 Enum.member?(follower.following, followed.follower_address)
447 def locked?(%User{} = user) do
448 user.info.locked || false
452 Repo.get_by(User, id: id)
455 def get_by_ap_id(ap_id) do
456 Repo.get_by(User, ap_id: ap_id)
459 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
460 # of the ap_id and the domain and tries to get that user
461 def get_by_guessed_nickname(ap_id) do
462 domain = URI.parse(ap_id).host
463 name = List.last(String.split(ap_id, "/"))
464 nickname = "#{name}@#{domain}"
466 get_cached_by_nickname(nickname)
469 def set_cache({:ok, user}), do: set_cache(user)
470 def set_cache({:error, err}), do: {:error, err}
472 def set_cache(%User{} = user) do
473 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
474 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
475 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
479 def update_and_set_cache(changeset) do
480 with {:ok, user} <- Repo.update(changeset) do
487 def invalidate_cache(user) do
488 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
489 Cachex.del(:user_cache, "nickname:#{user.nickname}")
490 Cachex.del(:user_cache, "user_info:#{user.id}")
493 def get_cached_by_ap_id(ap_id) do
494 key = "ap_id:#{ap_id}"
495 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
498 def get_cached_by_id(id) do
502 Cachex.fetch!(:user_cache, key, fn _ ->
506 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
507 {:commit, user.ap_id}
513 get_cached_by_ap_id(ap_id)
516 def get_cached_by_nickname(nickname) do
517 key = "nickname:#{nickname}"
519 Cachex.fetch!(:user_cache, key, fn ->
520 user_result = get_or_fetch_by_nickname(nickname)
523 {:ok, user} -> {:commit, user}
524 {:error, _error} -> {:ignore, nil}
529 def get_cached_by_nickname_or_id(nickname_or_id) do
530 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
533 def get_by_nickname(nickname) do
534 Repo.get_by(User, nickname: nickname) ||
535 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
536 Repo.get_by(User, nickname: local_nickname(nickname))
540 def get_by_email(email), do: Repo.get_by(User, email: email)
542 def get_by_nickname_or_email(nickname_or_email) do
543 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
546 def get_cached_user_info(user) do
547 key = "user_info:#{user.id}"
548 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
551 def fetch_by_nickname(nickname) do
552 ap_try = ActivityPub.make_user_from_nickname(nickname)
555 {:ok, user} -> {:ok, user}
556 _ -> OStatus.make_user(nickname)
560 def get_or_fetch_by_nickname(nickname) do
561 with %User{} = user <- get_by_nickname(nickname) do
565 with [_nick, _domain] <- String.split(nickname, "@"),
566 {:ok, user} <- fetch_by_nickname(nickname) do
567 if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
568 fetch_initial_posts(user)
573 _e -> {:error, "not found " <> nickname}
578 @doc "Fetch some posts when the user has just been federated with"
579 def fetch_initial_posts(user),
580 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:fetch_initial_posts, user])
582 @spec get_followers_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
583 def get_followers_query(%User{} = user, nil) do
584 User.Query.build(%{followers: user, deactivated: false})
587 def get_followers_query(user, page) do
588 from(u in get_followers_query(user, nil))
589 |> User.Query.paginate(page, 20)
592 @spec get_followers_query(User.t()) :: Ecto.Query.t()
593 def get_followers_query(user), do: get_followers_query(user, nil)
595 def get_followers(user, page \\ nil) do
596 q = get_followers_query(user, page)
601 def get_followers_ids(user, page \\ nil) do
602 q = get_followers_query(user, page)
604 Repo.all(from(u in q, select: u.id))
607 @spec get_friends_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
608 def get_friends_query(%User{} = user, nil) do
609 User.Query.build(%{friends: user, deactivated: false})
612 def get_friends_query(user, page) do
613 from(u in get_friends_query(user, nil))
614 |> User.Query.paginate(page, 20)
617 @spec get_friends_query(User.t()) :: Ecto.Query.t()
618 def get_friends_query(user), do: get_friends_query(user, nil)
620 def get_friends(user, page \\ nil) do
621 q = get_friends_query(user, page)
626 def get_friends_ids(user, page \\ nil) do
627 q = get_friends_query(user, page)
629 Repo.all(from(u in q, select: u.id))
632 @spec get_follow_requests(User.t()) :: {:ok, [User.t()]}
633 def get_follow_requests(%User{} = user) do
635 Activity.follow_requests_for_actor(user)
636 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
637 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
638 |> group_by([a, u], u.id)
645 def increase_note_count(%User{} = user) do
647 |> where(id: ^user.id)
652 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
659 |> Repo.update_all([])
661 {1, [user]} -> set_cache(user)
666 def decrease_note_count(%User{} = user) do
668 |> where(id: ^user.id)
673 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
680 |> Repo.update_all([])
682 {1, [user]} -> set_cache(user)
687 def update_note_count(%User{} = user) do
691 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
695 note_count = Repo.one(note_count_query)
697 info_cng = User.Info.set_note_count(user.info, note_count)
701 |> put_embed(:info, info_cng)
702 |> update_and_set_cache()
705 def maybe_fetch_follow_information(user) do
706 with {:ok, user} <- fetch_follow_information(user) do
710 Logger.error("Follower/Following counter update for #{user.ap_id} failed.\n#{inspect(e)}")
716 def fetch_follow_information(user) do
717 with {:ok, info} <- ActivityPub.fetch_follow_information_for_user(user) do
718 info_cng = User.Info.follow_information_update(user.info, info)
723 |> put_embed(:info, info_cng)
725 update_and_set_cache(changeset)
732 def update_follower_count(%User{} = user) do
733 unless user.local == false and Pleroma.Config.get([:instance, :external_user_synchronization]) do
734 follower_count_query =
735 User.Query.build(%{followers: user, deactivated: false})
736 |> select([u], %{count: count(u.id)})
739 |> where(id: ^user.id)
740 |> join(:inner, [u], s in subquery(follower_count_query))
745 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
752 |> Repo.update_all([])
754 {1, [user]} -> set_cache(user)
758 {:ok, maybe_fetch_follow_information(user)}
762 def maybe_update_following_count(%User{local: false} = user) do
763 if Pleroma.Config.get([:instance, :external_user_synchronization]) do
764 {:ok, maybe_fetch_follow_information(user)}
770 def maybe_update_following_count(user), do: user
772 def remove_duplicated_following(%User{following: following} = user) do
773 uniq_following = Enum.uniq(following)
775 if length(following) == length(uniq_following) do
779 |> update_changeset(%{following: uniq_following})
780 |> update_and_set_cache()
784 @spec get_users_from_set([String.t()], boolean()) :: [User.t()]
785 def get_users_from_set(ap_ids, local_only \\ true) do
786 criteria = %{ap_id: ap_ids, deactivated: false}
787 criteria = if local_only, do: Map.put(criteria, :local, true), else: criteria
789 User.Query.build(criteria)
793 @spec get_recipients_from_activity(Activity.t()) :: [User.t()]
794 def get_recipients_from_activity(%Activity{recipients: to}) do
795 User.Query.build(%{recipients_from_activity: to, local: true, deactivated: false})
799 @spec mute(User.t(), User.t(), boolean()) :: {:ok, User.t()} | {:error, String.t()}
800 def mute(muter, %User{ap_id: ap_id}, notifications? \\ true) do
804 User.Info.add_to_mutes(info, ap_id)
805 |> User.Info.add_to_muted_notifications(info, ap_id, notifications?)
809 |> put_embed(:info, info_cng)
811 update_and_set_cache(cng)
814 def unmute(muter, %{ap_id: ap_id}) do
818 User.Info.remove_from_mutes(info, ap_id)
819 |> User.Info.remove_from_muted_notifications(info, ap_id)
823 |> put_embed(:info, info_cng)
825 update_and_set_cache(cng)
828 def subscribe(subscriber, %{ap_id: ap_id}) do
829 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
831 with %User{} = subscribed <- get_cached_by_ap_id(ap_id) do
832 blocked = blocks?(subscribed, subscriber) and deny_follow_blocked
835 {:error, "Could not subscribe: #{subscribed.nickname} is blocking you"}
839 |> User.Info.add_to_subscribers(subscriber.ap_id)
842 |> put_embed(:info, info_cng)
843 |> update_and_set_cache()
848 def unsubscribe(unsubscriber, %{ap_id: ap_id}) do
849 with %User{} = user <- get_cached_by_ap_id(ap_id) do
852 |> User.Info.remove_from_subscribers(unsubscriber.ap_id)
855 |> put_embed(:info, info_cng)
856 |> update_and_set_cache()
860 def block(blocker, %User{ap_id: ap_id} = blocked) do
861 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
863 if following?(blocker, blocked) do
864 {:ok, blocker, _} = unfollow(blocker, blocked)
871 if subscribed_to?(blocked, blocker) do
872 {:ok, blocker} = unsubscribe(blocked, blocker)
878 if following?(blocked, blocker) do
879 unfollow(blocked, blocker)
882 {:ok, blocker} = update_follower_count(blocker)
886 |> User.Info.add_to_block(ap_id)
890 |> put_embed(:info, info_cng)
892 update_and_set_cache(cng)
895 # helper to handle the block given only an actor's AP id
896 def block(blocker, %{ap_id: ap_id}) do
897 block(blocker, get_cached_by_ap_id(ap_id))
900 def unblock(blocker, %{ap_id: ap_id}) do
903 |> User.Info.remove_from_block(ap_id)
907 |> put_embed(:info, info_cng)
909 update_and_set_cache(cng)
912 def mutes?(nil, _), do: false
913 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
915 @spec muted_notifications?(User.t() | nil, User.t() | map()) :: boolean()
916 def muted_notifications?(nil, _), do: false
918 def muted_notifications?(user, %{ap_id: ap_id}),
919 do: Enum.member?(user.info.muted_notifications, ap_id)
921 def blocks?(%User{info: info} = _user, %{ap_id: ap_id}) do
923 domain_blocks = info.domain_blocks
924 %{host: host} = URI.parse(ap_id)
926 Enum.member?(blocks, ap_id) || Enum.any?(domain_blocks, &(&1 == host))
929 def subscribed_to?(user, %{ap_id: ap_id}) do
930 with %User{} = target <- get_cached_by_ap_id(ap_id) do
931 Enum.member?(target.info.subscribers, user.ap_id)
935 @spec muted_users(User.t()) :: [User.t()]
936 def muted_users(user) do
937 User.Query.build(%{ap_id: user.info.mutes, deactivated: false})
941 @spec blocked_users(User.t()) :: [User.t()]
942 def blocked_users(user) do
943 User.Query.build(%{ap_id: user.info.blocks, deactivated: false})
947 @spec subscribers(User.t()) :: [User.t()]
948 def subscribers(user) do
949 User.Query.build(%{ap_id: user.info.subscribers, deactivated: false})
953 def block_domain(user, domain) do
956 |> User.Info.add_to_domain_block(domain)
960 |> put_embed(:info, info_cng)
962 update_and_set_cache(cng)
965 def unblock_domain(user, domain) do
968 |> User.Info.remove_from_domain_block(domain)
972 |> put_embed(:info, info_cng)
974 update_and_set_cache(cng)
977 def deactivate_async(user, status \\ true) do
978 PleromaJobQueue.enqueue(:background, __MODULE__, [:deactivate_async, user, status])
981 def deactivate(%User{} = user, status \\ true) do
982 info_cng = User.Info.set_activation_status(user.info, status)
984 with {:ok, friends} <- User.get_friends(user),
985 {:ok, followers} <- User.get_followers(user),
989 |> put_embed(:info, info_cng)
990 |> update_and_set_cache() do
991 Enum.each(followers, &invalidate_cache(&1))
992 Enum.each(friends, &update_follower_count(&1))
998 def update_notification_settings(%User{} = user, settings \\ %{}) do
999 info_changeset = User.Info.update_notification_settings(user.info, settings)
1002 |> put_embed(:info, info_changeset)
1003 |> update_and_set_cache()
1006 @spec delete(User.t()) :: :ok
1007 def delete(%User{} = user),
1008 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:delete, user])
1010 @spec perform(atom(), User.t()) :: {:ok, User.t()}
1011 def perform(:delete, %User{} = user) do
1012 {:ok, _user} = ActivityPub.delete(user)
1014 # Remove all relationships
1015 {:ok, followers} = User.get_followers(user)
1017 Enum.each(followers, fn follower ->
1018 ActivityPub.unfollow(follower, user)
1019 User.unfollow(follower, user)
1022 {:ok, friends} = User.get_friends(user)
1024 Enum.each(friends, fn followed ->
1025 ActivityPub.unfollow(user, followed)
1026 User.unfollow(user, followed)
1029 delete_user_activities(user)
1030 invalidate_cache(user)
1034 @spec perform(atom(), User.t()) :: {:ok, User.t()}
1035 def perform(:fetch_initial_posts, %User{} = user) do
1036 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
1039 # Insert all the posts in reverse order, so they're in the right order on the timeline
1040 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
1041 &Pleroma.Web.Federator.incoming_ap_doc/1
1047 def perform(:deactivate_async, user, status), do: deactivate(user, status)
1049 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
1050 def perform(:blocks_import, %User{} = blocker, blocked_identifiers)
1051 when is_list(blocked_identifiers) do
1053 blocked_identifiers,
1054 fn blocked_identifier ->
1055 with {:ok, %User{} = blocked} <- get_or_fetch(blocked_identifier),
1056 {:ok, blocker} <- block(blocker, blocked),
1057 {:ok, _} <- ActivityPub.block(blocker, blocked) do
1061 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
1068 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
1069 def perform(:follow_import, %User{} = follower, followed_identifiers)
1070 when is_list(followed_identifiers) do
1072 followed_identifiers,
1073 fn followed_identifier ->
1074 with {:ok, %User{} = followed} <- get_or_fetch(followed_identifier),
1075 {:ok, follower} <- maybe_direct_follow(follower, followed),
1076 {:ok, _} <- ActivityPub.follow(follower, followed) do
1080 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
1087 @spec external_users_query() :: Ecto.Query.t()
1088 def external_users_query do
1096 @spec external_users(keyword()) :: [User.t()]
1097 def external_users(opts \\ []) do
1099 external_users_query()
1100 |> select([u], struct(u, [:id, :ap_id, :info]))
1104 do: where(query, [u], u.id > ^opts[:max_id]),
1109 do: limit(query, ^opts[:limit]),
1115 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers),
1117 PleromaJobQueue.enqueue(:background, __MODULE__, [
1123 def follow_import(%User{} = follower, followed_identifiers) when is_list(followed_identifiers),
1125 PleromaJobQueue.enqueue(:background, __MODULE__, [
1128 followed_identifiers
1131 def delete_user_activities(%User{ap_id: ap_id} = user) do
1133 |> Activity.query_by_actor()
1134 |> RepoStreamer.chunk_stream(50)
1135 |> Stream.each(fn activities ->
1136 Enum.each(activities, &delete_activity(&1))
1143 defp delete_activity(%{data: %{"type" => "Create"}} = activity) do
1145 |> Object.normalize()
1146 |> ActivityPub.delete()
1149 defp delete_activity(%{data: %{"type" => "Like"}} = activity) do
1150 user = get_cached_by_ap_id(activity.actor)
1151 object = Object.normalize(activity)
1153 ActivityPub.unlike(user, object)
1156 defp delete_activity(%{data: %{"type" => "Announce"}} = activity) do
1157 user = get_cached_by_ap_id(activity.actor)
1158 object = Object.normalize(activity)
1160 ActivityPub.unannounce(user, object)
1163 defp delete_activity(_activity), do: "Doing nothing"
1165 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1166 Pleroma.HTML.Scrubber.TwitterText
1169 def html_filter_policy(_), do: Pleroma.Config.get([:markup, :scrub_policy])
1171 def fetch_by_ap_id(ap_id) do
1172 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1179 case OStatus.make_user(ap_id) do
1180 {:ok, user} -> {:ok, user}
1181 _ -> {:error, "Could not fetch by AP id"}
1186 def get_or_fetch_by_ap_id(ap_id) do
1187 user = get_cached_by_ap_id(ap_id)
1189 if !is_nil(user) and !User.needs_update?(user) do
1192 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1193 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1195 resp = fetch_by_ap_id(ap_id)
1197 if should_fetch_initial do
1198 with {:ok, %User{} = user} <- resp do
1199 fetch_initial_posts(user)
1207 @doc "Creates an internal service actor by URI if missing. Optionally takes nickname for addressing."
1208 def get_or_create_service_actor_by_ap_id(uri, nickname \\ nil) do
1209 if user = get_cached_by_ap_id(uri) do
1213 %User{info: %User.Info{}}
1214 |> cast(%{}, [:ap_id, :nickname, :local])
1215 |> put_change(:ap_id, uri)
1216 |> put_change(:nickname, nickname)
1217 |> put_change(:local, true)
1218 |> put_change(:follower_address, uri <> "/followers")
1220 {:ok, user} = Repo.insert(changes)
1226 def public_key_from_info(%{
1227 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1231 |> :public_key.pem_decode()
1233 |> :public_key.pem_entry_decode()
1239 def public_key_from_info(%{magic_key: magic_key}) when not is_nil(magic_key) do
1240 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1243 def public_key_from_info(_), do: {:error, "not found key"}
1245 def get_public_key_for_ap_id(ap_id) do
1246 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id),
1247 {:ok, public_key} <- public_key_from_info(user.info) do
1254 defp blank?(""), do: nil
1255 defp blank?(n), do: n
1257 def insert_or_update_user(data) do
1259 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1260 |> remote_user_creation()
1261 |> Repo.insert(on_conflict: :replace_all_except_primary_key, conflict_target: :nickname)
1265 def ap_enabled?(%User{local: true}), do: true
1266 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1267 def ap_enabled?(_), do: false
1269 @doc "Gets or fetch a user by uri or nickname."
1270 @spec get_or_fetch(String.t()) :: {:ok, User.t()} | {:error, String.t()}
1271 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1272 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1274 # wait a period of time and return newest version of the User structs
1275 # this is because we have synchronous follow APIs and need to simulate them
1276 # with an async handshake
1277 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1278 with %User{} = a <- User.get_cached_by_id(a.id),
1279 %User{} = b <- User.get_cached_by_id(b.id) do
1287 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1288 with :ok <- :timer.sleep(timeout),
1289 %User{} = a <- User.get_cached_by_id(a.id),
1290 %User{} = b <- User.get_cached_by_id(b.id) do
1298 def parse_bio(bio) when is_binary(bio) and bio != "" do
1300 |> CommonUtils.format_input("text/plain", mentions_format: :full)
1304 def parse_bio(_), do: ""
1306 def parse_bio(bio, user) when is_binary(bio) and bio != "" do
1307 # TODO: get profile URLs other than user.ap_id
1308 profile_urls = [user.ap_id]
1311 |> CommonUtils.format_input("text/plain",
1312 mentions_format: :full,
1313 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1318 def parse_bio(_, _), do: ""
1320 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1321 Repo.transaction(fn ->
1322 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1326 def tag(nickname, tags) when is_binary(nickname),
1327 do: tag(get_by_nickname(nickname), tags)
1329 def tag(%User{} = user, tags),
1330 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1332 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1333 Repo.transaction(fn ->
1334 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1338 def untag(nickname, tags) when is_binary(nickname),
1339 do: untag(get_by_nickname(nickname), tags)
1341 def untag(%User{} = user, tags),
1342 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1344 defp update_tags(%User{} = user, new_tags) do
1345 {:ok, updated_user} =
1347 |> change(%{tags: new_tags})
1348 |> update_and_set_cache()
1353 defp normalize_tags(tags) do
1356 |> Enum.map(&String.downcase(&1))
1359 defp local_nickname_regex do
1360 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1361 @extended_local_nickname_regex
1363 @strict_local_nickname_regex
1367 def local_nickname(nickname_or_mention) do
1370 |> String.split("@")
1374 def full_nickname(nickname_or_mention),
1375 do: String.trim_leading(nickname_or_mention, "@")
1377 def error_user(ap_id) do
1382 nickname: "erroruser@example.com",
1383 inserted_at: NaiveDateTime.utc_now()
1387 @spec all_superusers() :: [User.t()]
1388 def all_superusers do
1389 User.Query.build(%{super_users: true, local: true, deactivated: false})
1393 def showing_reblogs?(%User{} = user, %User{} = target) do
1394 target.ap_id not in user.info.muted_reblogs
1397 @spec toggle_confirmation(User.t()) :: {:ok, User.t()} | {:error, Changeset.t()}
1398 def toggle_confirmation(%User{} = user) do
1399 need_confirmation? = !user.info.confirmation_pending
1402 User.Info.confirmation_changeset(user.info, need_confirmation: need_confirmation?)
1406 |> put_embed(:info, info_changeset)
1407 |> update_and_set_cache()
1410 def get_mascot(%{info: %{mascot: %{} = mascot}}) when not is_nil(mascot) do
1414 def get_mascot(%{info: %{mascot: mascot}}) when is_nil(mascot) do
1415 # use instance-default
1416 config = Pleroma.Config.get([:assets, :mascots])
1417 default_mascot = Pleroma.Config.get([:assets, :default_mascot])
1418 mascot = Keyword.get(config, default_mascot)
1421 "id" => "default-mascot",
1422 "url" => mascot[:url],
1423 "preview_url" => mascot[:url],
1425 "mime_type" => mascot[:mime_type]
1430 def ensure_keys_present(%User{info: info} = user) do
1434 {:ok, pem} = Keys.generate_rsa_pem()
1437 |> Ecto.Changeset.change()
1438 |> Ecto.Changeset.put_embed(:info, User.Info.set_keys(info, pem))
1439 |> update_and_set_cache()
1443 def get_ap_ids_by_nicknames(nicknames) do
1445 where: u.nickname in ^nicknames,
1451 defdelegate search(query, opts \\ []), to: User.Search
1453 defp put_password_hash(
1454 %Ecto.Changeset{valid?: true, changes: %{password: password}} = changeset
1456 change(changeset, password_hash: Pbkdf2.hashpwsalt(password))
1459 defp put_password_hash(changeset), do: changeset
1461 def is_internal_user?(%User{nickname: nil}), do: true
1462 def is_internal_user?(%User{local: true, nickname: "internal." <> _}), do: true
1463 def is_internal_user?(_), do: false