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(:search_rank, :float, virtual: true)
56 field(:search_type, :integer, virtual: true)
57 field(:tags, {:array, :string}, default: [])
58 field(:last_refreshed_at, :naive_datetime_usec)
59 has_many(:notifications, Notification)
60 has_many(:registrations, Registration)
61 embeds_one(:info, 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
112 following_count: following_count(user),
113 note_count: user.info.note_count,
114 follower_count: user.info.follower_count,
115 locked: user.info.locked,
116 confirmation_pending: user.info.confirmation_pending,
117 default_scope: user.info.default_scope
121 def restrict_deactivated(query) do
123 where: not fragment("? \\? 'deactivated' AND ?->'deactivated' @> 'true'", u.info, u.info)
127 def following_count(%User{following: []}), do: 0
129 def following_count(%User{} = user) do
131 |> get_friends_query()
132 |> Repo.aggregate(:count, :id)
135 def remote_user_creation(params) do
138 |> Map.put(:info, params[:info] || %{})
140 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
144 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
145 |> validate_required([:name, :ap_id])
146 |> unique_constraint(:nickname)
147 |> validate_format(:nickname, @email_regex)
148 |> validate_length(:bio, max: 5000)
149 |> validate_length(:name, max: 100)
150 |> put_change(:local, false)
151 |> put_embed(:info, info_cng)
154 case info_cng.changes[:source_data] do
155 %{"followers" => followers} ->
157 |> put_change(:follower_address, followers)
160 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
163 |> put_change(:follower_address, followers)
170 def update_changeset(struct, params \\ %{}) do
172 |> cast(params, [:bio, :name, :avatar, :following])
173 |> unique_constraint(:nickname)
174 |> validate_format(:nickname, local_nickname_regex())
175 |> validate_length(:bio, max: 5000)
176 |> validate_length(:name, min: 1, max: 100)
179 def upgrade_changeset(struct, params \\ %{}) do
182 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
186 |> User.Info.user_upgrade(params[:info])
189 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
190 |> unique_constraint(:nickname)
191 |> validate_format(:nickname, local_nickname_regex())
192 |> validate_length(:bio, max: 5000)
193 |> validate_length(:name, max: 100)
194 |> put_embed(:info, info_cng)
197 def password_update_changeset(struct, params) do
199 |> cast(params, [:password, :password_confirmation])
200 |> validate_required([:password, :password_confirmation])
201 |> validate_confirmation(:password)
205 def reset_password(%User{id: user_id} = user, data) do
208 |> Multi.update(:user, password_update_changeset(user, data))
209 |> Multi.delete_all(:tokens, OAuth.Token.Query.get_by_user(user_id))
210 |> Multi.delete_all(:auth, OAuth.Authorization.delete_by_user_query(user))
212 case Repo.transaction(multi) do
213 {:ok, %{user: user} = _} -> set_cache(user)
214 {:error, _, changeset, _} -> {:error, changeset}
218 def register_changeset(struct, params \\ %{}, opts \\ []) do
220 if is_nil(opts[:need_confirmation]) do
221 Pleroma.Config.get([:instance, :account_activation_required])
223 opts[:need_confirmation]
227 User.Info.confirmation_changeset(%User.Info{}, need_confirmation: need_confirmation?)
231 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
232 |> validate_required([:name, :nickname, :password, :password_confirmation])
233 |> validate_confirmation(:password)
234 |> unique_constraint(:email)
235 |> unique_constraint(:nickname)
236 |> validate_exclusion(:nickname, Pleroma.Config.get([User, :restricted_nicknames]))
237 |> validate_format(:nickname, local_nickname_regex())
238 |> validate_format(:email, @email_regex)
239 |> validate_length(:bio, max: 1000)
240 |> validate_length(:name, min: 1, max: 100)
241 |> put_change(:info, info_change)
244 if opts[:external] do
247 validate_required(changeset, [:email])
250 if changeset.valid? do
251 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
252 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
256 |> put_change(:ap_id, ap_id)
257 |> unique_constraint(:ap_id)
258 |> put_change(:following, [followers])
259 |> put_change(:follower_address, followers)
265 defp autofollow_users(user) do
266 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
269 User.Query.build(%{nickname: candidates, local: true, deactivated: false})
272 follow_all(user, autofollowed_users)
275 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
276 def register(%Ecto.Changeset{} = changeset) do
277 with {:ok, user} <- Repo.insert(changeset),
278 {:ok, user} <- autofollow_users(user),
279 {:ok, user} <- set_cache(user),
280 {:ok, _} <- User.WelcomeMessage.post_welcome_message_to_user(user),
281 {:ok, _} <- try_send_confirmation_email(user) do
286 def try_send_confirmation_email(%User{} = user) do
287 if user.info.confirmation_pending &&
288 Pleroma.Config.get([:instance, :account_activation_required]) do
290 |> Pleroma.Emails.UserEmail.account_confirmation_email()
291 |> Pleroma.Emails.Mailer.deliver_async()
299 def needs_update?(%User{local: true}), do: false
301 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
303 def needs_update?(%User{local: false} = user) do
304 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
307 def needs_update?(_), do: true
309 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
313 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
314 follow(follower, followed)
317 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
318 if not User.ap_enabled?(followed) do
319 follow(follower, followed)
325 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
326 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
327 def follow_all(follower, followeds) do
330 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
331 |> Enum.map(fn %{follower_address: fa} -> fa end)
335 where: u.id == ^follower.id,
340 "array(select distinct unnest (array_cat(?, ?)))",
349 {1, [follower]} = Repo.update_all(q, [])
351 Enum.each(followeds, fn followed ->
352 update_follower_count(followed)
358 def follow(%User{} = follower, %User{info: info} = followed) do
359 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
360 ap_followers = followed.follower_address
364 {:error, "Could not follow user: You are deactivated."}
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 locked?(%User{} = user) do
418 user.info.locked || false
422 Repo.get_by(User, id: id)
425 def get_by_ap_id(ap_id) do
426 Repo.get_by(User, ap_id: ap_id)
429 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
430 # of the ap_id and the domain and tries to get that user
431 def get_by_guessed_nickname(ap_id) do
432 domain = URI.parse(ap_id).host
433 name = List.last(String.split(ap_id, "/"))
434 nickname = "#{name}@#{domain}"
436 get_cached_by_nickname(nickname)
439 def set_cache({:ok, user}), do: set_cache(user)
440 def set_cache({:error, err}), do: {:error, err}
442 def set_cache(%User{} = user) do
443 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
444 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
445 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
449 def update_and_set_cache(changeset) do
450 with {:ok, user} <- Repo.update(changeset) do
457 def invalidate_cache(user) do
458 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
459 Cachex.del(:user_cache, "nickname:#{user.nickname}")
460 Cachex.del(:user_cache, "user_info:#{user.id}")
463 def get_cached_by_ap_id(ap_id) do
464 key = "ap_id:#{ap_id}"
465 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
468 def get_cached_by_id(id) do
472 Cachex.fetch!(:user_cache, key, fn _ ->
476 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
477 {:commit, user.ap_id}
483 get_cached_by_ap_id(ap_id)
486 def get_cached_by_nickname(nickname) do
487 key = "nickname:#{nickname}"
489 Cachex.fetch!(:user_cache, key, fn ->
490 user_result = get_or_fetch_by_nickname(nickname)
493 {:ok, user} -> {:commit, user}
494 {:error, _error} -> {:ignore, nil}
499 def get_cached_by_nickname_or_id(nickname_or_id) do
500 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
503 def get_by_nickname(nickname) do
504 Repo.get_by(User, nickname: nickname) ||
505 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
506 Repo.get_by(User, nickname: local_nickname(nickname))
510 def get_by_email(email), do: Repo.get_by(User, email: email)
512 def get_by_nickname_or_email(nickname_or_email) do
513 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
516 def get_cached_user_info(user) do
517 key = "user_info:#{user.id}"
518 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
521 def fetch_by_nickname(nickname) do
522 ap_try = ActivityPub.make_user_from_nickname(nickname)
525 {:ok, user} -> {:ok, user}
526 _ -> OStatus.make_user(nickname)
530 def get_or_fetch_by_nickname(nickname) do
531 with %User{} = user <- get_by_nickname(nickname) do
535 with [_nick, _domain] <- String.split(nickname, "@"),
536 {:ok, user} <- fetch_by_nickname(nickname) do
537 if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
538 fetch_initial_posts(user)
543 _e -> {:error, "not found " <> nickname}
548 @doc "Fetch some posts when the user has just been federated with"
549 def fetch_initial_posts(user),
550 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:fetch_initial_posts, user])
552 @spec get_followers_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
553 def get_followers_query(%User{} = user, nil) do
554 User.Query.build(%{followers: user, deactivated: false})
557 def get_followers_query(user, page) do
558 from(u in get_followers_query(user, nil))
559 |> User.Query.paginate(page, 20)
562 @spec get_followers_query(User.t()) :: Ecto.Query.t()
563 def get_followers_query(user), do: get_followers_query(user, nil)
565 def get_followers(user, page \\ nil) do
566 q = get_followers_query(user, page)
571 def get_followers_ids(user, page \\ nil) do
572 q = get_followers_query(user, page)
574 Repo.all(from(u in q, select: u.id))
577 @spec get_friends_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
578 def get_friends_query(%User{} = user, nil) do
579 User.Query.build(%{friends: user, deactivated: false})
582 def get_friends_query(user, page) do
583 from(u in get_friends_query(user, nil))
584 |> User.Query.paginate(page, 20)
587 @spec get_friends_query(User.t()) :: Ecto.Query.t()
588 def get_friends_query(user), do: get_friends_query(user, nil)
590 def get_friends(user, page \\ nil) do
591 q = get_friends_query(user, page)
596 def get_friends_ids(user, page \\ nil) do
597 q = get_friends_query(user, page)
599 Repo.all(from(u in q, select: u.id))
602 @spec get_follow_requests(User.t()) :: {:ok, [User.t()]}
603 def get_follow_requests(%User{} = user) do
605 Activity.follow_requests_for_actor(user)
606 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
607 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
608 |> group_by([a, u], u.id)
615 def increase_note_count(%User{} = user) do
617 |> where(id: ^user.id)
622 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
629 |> Repo.update_all([])
631 {1, [user]} -> set_cache(user)
636 def decrease_note_count(%User{} = user) do
638 |> where(id: ^user.id)
643 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
650 |> Repo.update_all([])
652 {1, [user]} -> set_cache(user)
657 def update_note_count(%User{} = user) do
661 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
665 note_count = Repo.one(note_count_query)
667 info_cng = User.Info.set_note_count(user.info, note_count)
671 |> put_embed(:info, info_cng)
672 |> update_and_set_cache()
675 def update_follower_count(%User{} = user) do
676 follower_count_query =
677 User.Query.build(%{followers: user, deactivated: false})
678 |> select([u], %{count: count(u.id)})
681 |> where(id: ^user.id)
682 |> join(:inner, [u], s in subquery(follower_count_query))
687 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
694 |> Repo.update_all([])
696 {1, [user]} -> set_cache(user)
701 def remove_duplicated_following(%User{following: following} = user) do
702 uniq_following = Enum.uniq(following)
704 if length(following) == length(uniq_following) do
708 |> update_changeset(%{following: uniq_following})
709 |> update_and_set_cache()
713 @spec get_users_from_set([String.t()], boolean()) :: [User.t()]
714 def get_users_from_set(ap_ids, local_only \\ true) do
715 criteria = %{ap_id: ap_ids, deactivated: false}
716 criteria = if local_only, do: Map.put(criteria, :local, true), else: criteria
718 User.Query.build(criteria)
722 @spec get_recipients_from_activity(Activity.t()) :: [User.t()]
723 def get_recipients_from_activity(%Activity{recipients: to}) do
724 User.Query.build(%{recipients_from_activity: to, local: true, deactivated: false})
728 def mute(muter, %User{ap_id: ap_id}) do
731 |> User.Info.add_to_mutes(ap_id)
735 |> put_embed(:info, info_cng)
737 update_and_set_cache(cng)
740 def unmute(muter, %{ap_id: ap_id}) do
743 |> User.Info.remove_from_mutes(ap_id)
747 |> put_embed(:info, info_cng)
749 update_and_set_cache(cng)
752 def subscribe(subscriber, %{ap_id: ap_id}) do
753 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
755 with %User{} = subscribed <- get_cached_by_ap_id(ap_id) do
756 blocked = blocks?(subscribed, subscriber) and deny_follow_blocked
759 {:error, "Could not subscribe: #{subscribed.nickname} is blocking you"}
763 |> User.Info.add_to_subscribers(subscriber.ap_id)
766 |> put_embed(:info, info_cng)
767 |> update_and_set_cache()
772 def unsubscribe(unsubscriber, %{ap_id: ap_id}) do
773 with %User{} = user <- get_cached_by_ap_id(ap_id) do
776 |> User.Info.remove_from_subscribers(unsubscriber.ap_id)
779 |> put_embed(:info, info_cng)
780 |> update_and_set_cache()
784 def block(blocker, %User{ap_id: ap_id} = blocked) do
785 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
787 if following?(blocker, blocked) do
788 {:ok, blocker, _} = unfollow(blocker, blocked)
795 if subscribed_to?(blocked, blocker) do
796 {:ok, blocker} = unsubscribe(blocked, blocker)
802 if following?(blocked, blocker) do
803 unfollow(blocked, blocker)
806 {:ok, blocker} = update_follower_count(blocker)
810 |> User.Info.add_to_block(ap_id)
814 |> put_embed(:info, info_cng)
816 update_and_set_cache(cng)
819 # helper to handle the block given only an actor's AP id
820 def block(blocker, %{ap_id: ap_id}) do
821 block(blocker, get_cached_by_ap_id(ap_id))
824 def unblock(blocker, %{ap_id: ap_id}) do
827 |> User.Info.remove_from_block(ap_id)
831 |> put_embed(:info, info_cng)
833 update_and_set_cache(cng)
836 def mutes?(nil, _), do: false
837 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
839 def blocks?(user, %{ap_id: ap_id}) do
840 blocks = user.info.blocks
841 domain_blocks = user.info.domain_blocks
842 %{host: host} = URI.parse(ap_id)
844 Enum.member?(blocks, ap_id) ||
845 Enum.any?(domain_blocks, fn domain ->
850 def subscribed_to?(user, %{ap_id: ap_id}) do
851 with %User{} = target <- get_cached_by_ap_id(ap_id) do
852 Enum.member?(target.info.subscribers, user.ap_id)
856 @spec muted_users(User.t()) :: [User.t()]
857 def muted_users(user) do
858 User.Query.build(%{ap_id: user.info.mutes, deactivated: false})
862 @spec blocked_users(User.t()) :: [User.t()]
863 def blocked_users(user) do
864 User.Query.build(%{ap_id: user.info.blocks, deactivated: false})
868 @spec subscribers(User.t()) :: [User.t()]
869 def subscribers(user) do
870 User.Query.build(%{ap_id: user.info.subscribers, deactivated: false})
874 def block_domain(user, domain) do
877 |> User.Info.add_to_domain_block(domain)
881 |> put_embed(:info, info_cng)
883 update_and_set_cache(cng)
886 def unblock_domain(user, domain) do
889 |> User.Info.remove_from_domain_block(domain)
893 |> put_embed(:info, info_cng)
895 update_and_set_cache(cng)
898 def deactivate_async(user, status \\ true) do
899 PleromaJobQueue.enqueue(:background, __MODULE__, [:deactivate_async, user, status])
902 def deactivate(%User{} = user, status \\ true) do
903 info_cng = User.Info.set_activation_status(user.info, status)
905 with {:ok, friends} <- User.get_friends(user),
906 {:ok, followers} <- User.get_followers(user),
910 |> put_embed(:info, info_cng)
911 |> update_and_set_cache() do
912 Enum.each(followers, &invalidate_cache(&1))
913 Enum.each(friends, &update_follower_count(&1))
919 def update_notification_settings(%User{} = user, settings \\ %{}) do
920 info_changeset = User.Info.update_notification_settings(user.info, settings)
923 |> put_embed(:info, info_changeset)
924 |> update_and_set_cache()
927 @spec delete(User.t()) :: :ok
928 def delete(%User{} = user),
929 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:delete, user])
931 @spec perform(atom(), User.t()) :: {:ok, User.t()}
932 def perform(:delete, %User{} = user) do
933 # Remove all relationships
934 {:ok, followers} = User.get_followers(user)
936 Enum.each(followers, fn follower ->
937 ActivityPub.unfollow(follower, user)
938 User.unfollow(follower, user)
941 {:ok, friends} = User.get_friends(user)
943 Enum.each(friends, fn followed ->
944 ActivityPub.unfollow(user, followed)
945 User.unfollow(user, followed)
948 delete_user_activities(user)
950 {:ok, _user} = Repo.delete(user)
953 @spec perform(atom(), User.t()) :: {:ok, User.t()}
954 def perform(:fetch_initial_posts, %User{} = user) do
955 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
958 # Insert all the posts in reverse order, so they're in the right order on the timeline
959 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
960 &Pleroma.Web.Federator.incoming_ap_doc/1
966 def perform(:deactivate_async, user, status), do: deactivate(user, status)
968 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
969 def perform(:blocks_import, %User{} = blocker, blocked_identifiers)
970 when is_list(blocked_identifiers) do
973 fn blocked_identifier ->
974 with {:ok, %User{} = blocked} <- get_or_fetch(blocked_identifier),
975 {:ok, blocker} <- block(blocker, blocked),
976 {:ok, _} <- ActivityPub.block(blocker, blocked) do
980 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
987 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
988 def perform(:follow_import, %User{} = follower, followed_identifiers)
989 when is_list(followed_identifiers) do
991 followed_identifiers,
992 fn followed_identifier ->
993 with {:ok, %User{} = followed} <- get_or_fetch(followed_identifier),
994 {:ok, follower} <- maybe_direct_follow(follower, followed),
995 {:ok, _} <- ActivityPub.follow(follower, followed) do
999 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
1006 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers),
1008 PleromaJobQueue.enqueue(:background, __MODULE__, [
1014 def follow_import(%User{} = follower, followed_identifiers) when is_list(followed_identifiers),
1016 PleromaJobQueue.enqueue(:background, __MODULE__, [
1019 followed_identifiers
1022 def delete_user_activities(%User{ap_id: ap_id} = user) do
1024 |> Activity.query_by_actor()
1025 |> RepoStreamer.chunk_stream(50)
1026 |> Stream.each(fn activities ->
1027 Enum.each(activities, &delete_activity(&1))
1034 defp delete_activity(%{data: %{"type" => "Create"}} = activity) do
1036 |> Object.normalize()
1037 |> ActivityPub.delete()
1040 defp delete_activity(%{data: %{"type" => "Like"}} = activity) do
1041 user = get_cached_by_ap_id(activity.actor)
1042 object = Object.normalize(activity)
1044 ActivityPub.unlike(user, object)
1047 defp delete_activity(%{data: %{"type" => "Announce"}} = activity) do
1048 user = get_cached_by_ap_id(activity.actor)
1049 object = Object.normalize(activity)
1051 ActivityPub.unannounce(user, object)
1054 defp delete_activity(_activity), do: "Doing nothing"
1056 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1057 Pleroma.HTML.Scrubber.TwitterText
1060 def html_filter_policy(_), do: Pleroma.Config.get([:markup, :scrub_policy])
1062 def fetch_by_ap_id(ap_id) do
1063 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1070 case OStatus.make_user(ap_id) do
1071 {:ok, user} -> {:ok, user}
1072 _ -> {:error, "Could not fetch by AP id"}
1077 def get_or_fetch_by_ap_id(ap_id) do
1078 user = get_cached_by_ap_id(ap_id)
1080 if !is_nil(user) and !User.needs_update?(user) do
1083 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1084 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1086 resp = fetch_by_ap_id(ap_id)
1088 if should_fetch_initial do
1089 with {:ok, %User{} = user} <- resp do
1090 fetch_initial_posts(user)
1098 def get_or_create_instance_user do
1099 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1101 if user = get_cached_by_ap_id(relay_uri) do
1105 %User{info: %User.Info{}}
1106 |> cast(%{}, [:ap_id, :nickname, :local])
1107 |> put_change(:ap_id, relay_uri)
1108 |> put_change(:nickname, nil)
1109 |> put_change(:local, true)
1110 |> put_change(:follower_address, relay_uri <> "/followers")
1112 {:ok, user} = Repo.insert(changes)
1118 def public_key_from_info(%{
1119 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1123 |> :public_key.pem_decode()
1125 |> :public_key.pem_entry_decode()
1131 def public_key_from_info(%{magic_key: magic_key}) do
1132 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1135 def get_public_key_for_ap_id(ap_id) do
1136 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id),
1137 {:ok, public_key} <- public_key_from_info(user.info) do
1144 defp blank?(""), do: nil
1145 defp blank?(n), do: n
1147 def insert_or_update_user(data) do
1149 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1150 |> remote_user_creation()
1151 |> Repo.insert(on_conflict: :replace_all, conflict_target: :nickname)
1155 def ap_enabled?(%User{local: true}), do: true
1156 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1157 def ap_enabled?(_), do: false
1159 @doc "Gets or fetch a user by uri or nickname."
1160 @spec get_or_fetch(String.t()) :: {:ok, User.t()} | {:error, String.t()}
1161 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1162 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1164 # wait a period of time and return newest version of the User structs
1165 # this is because we have synchronous follow APIs and need to simulate them
1166 # with an async handshake
1167 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1168 with %User{} = a <- User.get_cached_by_id(a.id),
1169 %User{} = b <- User.get_cached_by_id(b.id) do
1177 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1178 with :ok <- :timer.sleep(timeout),
1179 %User{} = a <- User.get_cached_by_id(a.id),
1180 %User{} = b <- User.get_cached_by_id(b.id) do
1188 def parse_bio(bio) when is_binary(bio) and bio != "" do
1190 |> CommonUtils.format_input("text/plain", mentions_format: :full)
1194 def parse_bio(_), do: ""
1196 def parse_bio(bio, user) when is_binary(bio) and bio != "" do
1197 # TODO: get profile URLs other than user.ap_id
1198 profile_urls = [user.ap_id]
1201 |> CommonUtils.format_input("text/plain",
1202 mentions_format: :full,
1203 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1208 def parse_bio(_, _), do: ""
1210 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1211 Repo.transaction(fn ->
1212 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1216 def tag(nickname, tags) when is_binary(nickname),
1217 do: tag(get_by_nickname(nickname), tags)
1219 def tag(%User{} = user, tags),
1220 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1222 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1223 Repo.transaction(fn ->
1224 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1228 def untag(nickname, tags) when is_binary(nickname),
1229 do: untag(get_by_nickname(nickname), tags)
1231 def untag(%User{} = user, tags),
1232 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1234 defp update_tags(%User{} = user, new_tags) do
1235 {:ok, updated_user} =
1237 |> change(%{tags: new_tags})
1238 |> update_and_set_cache()
1243 defp normalize_tags(tags) do
1246 |> Enum.map(&String.downcase(&1))
1249 defp local_nickname_regex do
1250 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1251 @extended_local_nickname_regex
1253 @strict_local_nickname_regex
1257 def local_nickname(nickname_or_mention) do
1260 |> String.split("@")
1264 def full_nickname(nickname_or_mention),
1265 do: String.trim_leading(nickname_or_mention, "@")
1267 def error_user(ap_id) do
1272 nickname: "erroruser@example.com",
1273 inserted_at: NaiveDateTime.utc_now()
1277 @spec all_superusers() :: [User.t()]
1278 def all_superusers do
1279 User.Query.build(%{super_users: true, local: true, deactivated: false})
1283 def showing_reblogs?(%User{} = user, %User{} = target) do
1284 target.ap_id not in user.info.muted_reblogs
1287 @spec toggle_confirmation(User.t()) :: {:ok, User.t()} | {:error, Changeset.t()}
1288 def toggle_confirmation(%User{} = user) do
1289 need_confirmation? = !user.info.confirmation_pending
1292 User.Info.confirmation_changeset(user.info, need_confirmation: need_confirmation?)
1296 |> put_embed(:info, info_changeset)
1297 |> update_and_set_cache()
1300 def get_mascot(%{info: %{mascot: %{} = mascot}}) when not is_nil(mascot) do
1304 def get_mascot(%{info: %{mascot: mascot}}) when is_nil(mascot) do
1305 # use instance-default
1306 config = Pleroma.Config.get([:assets, :mascots])
1307 default_mascot = Pleroma.Config.get([:assets, :default_mascot])
1308 mascot = Keyword.get(config, default_mascot)
1311 "id" => "default-mascot",
1312 "url" => mascot[:url],
1313 "preview_url" => mascot[:url],
1315 "mime_type" => mascot[:mime_type]
1320 def ensure_keys_present(user) do
1326 {:ok, pem} = Keys.generate_rsa_pem()
1330 |> User.Info.set_keys(pem)
1333 Ecto.Changeset.change(user)
1334 |> Ecto.Changeset.put_embed(:info, info_cng)
1336 update_and_set_cache(cng)
1340 def get_ap_ids_by_nicknames(nicknames) do
1342 where: u.nickname in ^nicknames,
1348 defdelegate search(query, opts \\ []), to: User.Search
1350 defp put_password_hash(
1351 %Ecto.Changeset{valid?: true, changes: %{password: password}} = changeset
1353 change(changeset, password_hash: Pbkdf2.hashpwsalt(password))
1356 defp put_password_hash(changeset), do: changeset