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, args \\ %{}) do
112 if args[:following_count], do: args[:following_count], else: following_count(user)
115 if args[:follower_count], do: args[:follower_count], else: user.info.follower_count
118 note_count: user.info.note_count,
119 locked: user.info.locked,
120 confirmation_pending: user.info.confirmation_pending,
121 default_scope: user.info.default_scope
123 |> Map.put(:following_count, following_count)
124 |> Map.put(:follower_count, follower_count)
127 def set_info_cache(user, args) do
128 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user, args))
131 def restrict_deactivated(query) do
133 where: not fragment("? \\? 'deactivated' AND ?->'deactivated' @> 'true'", u.info, u.info)
137 def following_count(%User{following: []}), do: 0
139 def following_count(%User{} = user) do
141 |> get_friends_query()
142 |> Repo.aggregate(:count, :id)
145 def remote_user_creation(params) do
148 |> Map.put(:info, params[:info] || %{})
150 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
154 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
155 |> validate_required([:name, :ap_id])
156 |> unique_constraint(:nickname)
157 |> validate_format(:nickname, @email_regex)
158 |> validate_length(:bio, max: 5000)
159 |> validate_length(:name, max: 100)
160 |> put_change(:local, false)
161 |> put_embed(:info, info_cng)
164 case info_cng.changes[:source_data] do
165 %{"followers" => followers} ->
167 |> put_change(:follower_address, followers)
170 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
173 |> put_change(:follower_address, followers)
180 def update_changeset(struct, params \\ %{}) do
182 |> cast(params, [:bio, :name, :avatar, :following])
183 |> unique_constraint(:nickname)
184 |> validate_format(:nickname, local_nickname_regex())
185 |> validate_length(:bio, max: 5000)
186 |> validate_length(:name, min: 1, max: 100)
189 def upgrade_changeset(struct, params \\ %{}) do
192 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
196 |> User.Info.user_upgrade(params[:info])
199 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
200 |> unique_constraint(:nickname)
201 |> validate_format(:nickname, local_nickname_regex())
202 |> validate_length(:bio, max: 5000)
203 |> validate_length(:name, max: 100)
204 |> put_embed(:info, info_cng)
207 def password_update_changeset(struct, params) do
209 |> cast(params, [:password, :password_confirmation])
210 |> validate_required([:password, :password_confirmation])
211 |> validate_confirmation(:password)
215 def reset_password(%User{id: user_id} = user, data) do
218 |> Multi.update(:user, password_update_changeset(user, data))
219 |> Multi.delete_all(:tokens, OAuth.Token.Query.get_by_user(user_id))
220 |> Multi.delete_all(:auth, OAuth.Authorization.delete_by_user_query(user))
222 case Repo.transaction(multi) do
223 {:ok, %{user: user} = _} -> set_cache(user)
224 {:error, _, changeset, _} -> {:error, changeset}
228 def register_changeset(struct, params \\ %{}, opts \\ []) do
230 if is_nil(opts[:need_confirmation]) do
231 Pleroma.Config.get([:instance, :account_activation_required])
233 opts[:need_confirmation]
237 User.Info.confirmation_changeset(%User.Info{}, need_confirmation: need_confirmation?)
241 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
242 |> validate_required([:name, :nickname, :password, :password_confirmation])
243 |> validate_confirmation(:password)
244 |> unique_constraint(:email)
245 |> unique_constraint(:nickname)
246 |> validate_exclusion(:nickname, Pleroma.Config.get([User, :restricted_nicknames]))
247 |> validate_format(:nickname, local_nickname_regex())
248 |> validate_format(:email, @email_regex)
249 |> validate_length(:bio, max: 1000)
250 |> validate_length(:name, min: 1, max: 100)
251 |> put_change(:info, info_change)
254 if opts[:external] do
257 validate_required(changeset, [:email])
260 if changeset.valid? do
261 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
262 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
266 |> put_change(:ap_id, ap_id)
267 |> unique_constraint(:ap_id)
268 |> put_change(:following, [followers])
269 |> put_change(:follower_address, followers)
275 defp autofollow_users(user) do
276 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
279 User.Query.build(%{nickname: candidates, local: true, deactivated: false})
282 follow_all(user, autofollowed_users)
285 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
286 def register(%Ecto.Changeset{} = changeset) do
287 with {:ok, user} <- Repo.insert(changeset),
288 {:ok, user} <- autofollow_users(user),
289 {:ok, user} <- set_cache(user),
290 {:ok, _} <- User.WelcomeMessage.post_welcome_message_to_user(user),
291 {:ok, _} <- try_send_confirmation_email(user) do
296 def try_send_confirmation_email(%User{} = user) do
297 if user.info.confirmation_pending &&
298 Pleroma.Config.get([:instance, :account_activation_required]) do
300 |> Pleroma.Emails.UserEmail.account_confirmation_email()
301 |> Pleroma.Emails.Mailer.deliver_async()
309 def needs_update?(%User{local: true}), do: false
311 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
313 def needs_update?(%User{local: false} = user) do
314 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
317 def needs_update?(_), do: true
319 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
323 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
324 follow(follower, followed)
327 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
328 if not User.ap_enabled?(followed) do
329 follow(follower, followed)
335 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
336 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
337 def follow_all(follower, followeds) do
340 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
341 |> Enum.map(fn %{follower_address: fa} -> fa end)
345 where: u.id == ^follower.id,
350 "array(select distinct unnest (array_cat(?, ?)))",
359 {1, [follower]} = Repo.update_all(q, [])
361 Enum.each(followeds, fn followed ->
362 update_follower_count(followed)
368 def follow(%User{} = follower, %User{info: info} = followed) do
369 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
370 ap_followers = followed.follower_address
374 {:error, "Could not follow user: You are deactivated."}
376 deny_follow_blocked and blocks?(followed, follower) ->
377 {:error, "Could not follow user: #{followed.nickname} blocked you."}
380 if !followed.local && follower.local && !ap_enabled?(followed) do
381 Websub.subscribe(follower, followed)
386 where: u.id == ^follower.id,
387 update: [push: [following: ^ap_followers]],
391 {1, [follower]} = Repo.update_all(q, [])
393 {:ok, _} = update_follower_count(followed)
399 def unfollow(%User{} = follower, %User{} = followed) do
400 ap_followers = followed.follower_address
402 if following?(follower, followed) and follower.ap_id != followed.ap_id do
405 where: u.id == ^follower.id,
406 update: [pull: [following: ^ap_followers]],
410 {1, [follower]} = Repo.update_all(q, [])
412 {:ok, followed} = update_follower_count(followed)
416 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
418 {:error, "Not subscribed!"}
422 @spec following?(User.t(), User.t()) :: boolean
423 def following?(%User{} = follower, %User{} = followed) do
424 Enum.member?(follower.following, followed.follower_address)
427 def locked?(%User{} = user) do
428 user.info.locked || false
432 Repo.get_by(User, id: id)
435 def get_by_ap_id(ap_id) do
436 Repo.get_by(User, ap_id: ap_id)
439 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
440 # of the ap_id and the domain and tries to get that user
441 def get_by_guessed_nickname(ap_id) do
442 domain = URI.parse(ap_id).host
443 name = List.last(String.split(ap_id, "/"))
444 nickname = "#{name}@#{domain}"
446 get_cached_by_nickname(nickname)
449 def set_cache({:ok, user}), do: set_cache(user)
450 def set_cache({:error, err}), do: {:error, err}
452 def set_cache(%User{} = user) do
453 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
454 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
455 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
459 def update_and_set_cache(changeset) do
460 with {:ok, user} <- Repo.update(changeset) do
467 def invalidate_cache(user) do
468 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
469 Cachex.del(:user_cache, "nickname:#{user.nickname}")
470 Cachex.del(:user_cache, "user_info:#{user.id}")
473 def get_cached_by_ap_id(ap_id) do
474 key = "ap_id:#{ap_id}"
475 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
478 def get_cached_by_id(id) do
482 Cachex.fetch!(:user_cache, key, fn _ ->
486 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
487 {:commit, user.ap_id}
493 get_cached_by_ap_id(ap_id)
496 def get_cached_by_nickname(nickname) do
497 key = "nickname:#{nickname}"
499 Cachex.fetch!(:user_cache, key, fn ->
500 user_result = get_or_fetch_by_nickname(nickname)
503 {:ok, user} -> {:commit, user}
504 {:error, _error} -> {:ignore, nil}
509 def get_cached_by_nickname_or_id(nickname_or_id) do
510 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
513 def get_by_nickname(nickname) do
514 Repo.get_by(User, nickname: nickname) ||
515 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
516 Repo.get_by(User, nickname: local_nickname(nickname))
520 def get_by_email(email), do: Repo.get_by(User, email: email)
522 def get_by_nickname_or_email(nickname_or_email) do
523 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
526 def get_cached_user_info(user) do
527 key = "user_info:#{user.id}"
528 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
531 def fetch_by_nickname(nickname) do
532 ap_try = ActivityPub.make_user_from_nickname(nickname)
535 {:ok, user} -> {:ok, user}
536 _ -> OStatus.make_user(nickname)
540 def get_or_fetch_by_nickname(nickname) do
541 with %User{} = user <- get_by_nickname(nickname) do
545 with [_nick, _domain] <- String.split(nickname, "@"),
546 {:ok, user} <- fetch_by_nickname(nickname) do
547 if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
548 fetch_initial_posts(user)
553 _e -> {:error, "not found " <> nickname}
558 @doc "Fetch some posts when the user has just been federated with"
559 def fetch_initial_posts(user),
560 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:fetch_initial_posts, user])
562 @spec get_followers_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
563 def get_followers_query(%User{} = user, nil) do
564 User.Query.build(%{followers: user, deactivated: false})
567 def get_followers_query(user, page) do
568 from(u in get_followers_query(user, nil))
569 |> User.Query.paginate(page, 20)
572 @spec get_followers_query(User.t()) :: Ecto.Query.t()
573 def get_followers_query(user), do: get_followers_query(user, nil)
575 def get_followers(user, page \\ nil) do
576 q = get_followers_query(user, page)
581 def get_followers_ids(user, page \\ nil) do
582 q = get_followers_query(user, page)
584 Repo.all(from(u in q, select: u.id))
587 @spec get_friends_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
588 def get_friends_query(%User{} = user, nil) do
589 User.Query.build(%{friends: user, deactivated: false})
592 def get_friends_query(user, page) do
593 from(u in get_friends_query(user, nil))
594 |> User.Query.paginate(page, 20)
597 @spec get_friends_query(User.t()) :: Ecto.Query.t()
598 def get_friends_query(user), do: get_friends_query(user, nil)
600 def get_friends(user, page \\ nil) do
601 q = get_friends_query(user, page)
606 def get_friends_ids(user, page \\ nil) do
607 q = get_friends_query(user, page)
609 Repo.all(from(u in q, select: u.id))
612 @spec get_follow_requests(User.t()) :: {:ok, [User.t()]}
613 def get_follow_requests(%User{} = user) do
615 Activity.follow_requests_for_actor(user)
616 |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
617 |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
618 |> group_by([a, u], u.id)
625 def increase_note_count(%User{} = user) do
627 |> where(id: ^user.id)
632 "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
639 |> Repo.update_all([])
641 {1, [user]} -> set_cache(user)
646 def decrease_note_count(%User{} = user) do
648 |> where(id: ^user.id)
653 "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
660 |> Repo.update_all([])
662 {1, [user]} -> set_cache(user)
667 def update_note_count(%User{} = user) do
671 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
675 note_count = Repo.one(note_count_query)
677 info_cng = User.Info.set_note_count(user.info, note_count)
681 |> put_embed(:info, info_cng)
682 |> update_and_set_cache()
685 def update_follower_count(%User{} = user) do
686 follower_count_query =
687 User.Query.build(%{followers: user, deactivated: false})
688 |> select([u], %{count: count(u.id)})
691 |> where(id: ^user.id)
692 |> join(:inner, [u], s in subquery(follower_count_query))
697 "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
704 |> Repo.update_all([])
706 {1, [user]} -> set_cache(user)
711 def remove_duplicated_following(%User{following: following} = user) do
712 uniq_following = Enum.uniq(following)
714 if length(following) == length(uniq_following) do
718 |> update_changeset(%{following: uniq_following})
719 |> update_and_set_cache()
723 @spec get_users_from_set([String.t()], boolean()) :: [User.t()]
724 def get_users_from_set(ap_ids, local_only \\ true) do
725 criteria = %{ap_id: ap_ids, deactivated: false}
726 criteria = if local_only, do: Map.put(criteria, :local, true), else: criteria
728 User.Query.build(criteria)
732 @spec get_recipients_from_activity(Activity.t()) :: [User.t()]
733 def get_recipients_from_activity(%Activity{recipients: to}) do
734 User.Query.build(%{recipients_from_activity: to, local: true, deactivated: false})
738 def mute(muter, %User{ap_id: ap_id}) do
741 |> User.Info.add_to_mutes(ap_id)
745 |> put_embed(:info, info_cng)
747 update_and_set_cache(cng)
750 def unmute(muter, %{ap_id: ap_id}) do
753 |> User.Info.remove_from_mutes(ap_id)
757 |> put_embed(:info, info_cng)
759 update_and_set_cache(cng)
762 def subscribe(subscriber, %{ap_id: ap_id}) do
763 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
765 with %User{} = subscribed <- get_cached_by_ap_id(ap_id) do
766 blocked = blocks?(subscribed, subscriber) and deny_follow_blocked
769 {:error, "Could not subscribe: #{subscribed.nickname} is blocking you"}
773 |> User.Info.add_to_subscribers(subscriber.ap_id)
776 |> put_embed(:info, info_cng)
777 |> update_and_set_cache()
782 def unsubscribe(unsubscriber, %{ap_id: ap_id}) do
783 with %User{} = user <- get_cached_by_ap_id(ap_id) do
786 |> User.Info.remove_from_subscribers(unsubscriber.ap_id)
789 |> put_embed(:info, info_cng)
790 |> update_and_set_cache()
794 def block(blocker, %User{ap_id: ap_id} = blocked) do
795 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
797 if following?(blocker, blocked) do
798 {:ok, blocker, _} = unfollow(blocker, blocked)
805 if subscribed_to?(blocked, blocker) do
806 {:ok, blocker} = unsubscribe(blocked, blocker)
812 if following?(blocked, blocker) do
813 unfollow(blocked, blocker)
816 {:ok, blocker} = update_follower_count(blocker)
820 |> User.Info.add_to_block(ap_id)
824 |> put_embed(:info, info_cng)
826 update_and_set_cache(cng)
829 # helper to handle the block given only an actor's AP id
830 def block(blocker, %{ap_id: ap_id}) do
831 block(blocker, get_cached_by_ap_id(ap_id))
834 def unblock(blocker, %{ap_id: ap_id}) do
837 |> User.Info.remove_from_block(ap_id)
841 |> put_embed(:info, info_cng)
843 update_and_set_cache(cng)
846 def mutes?(nil, _), do: false
847 def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
849 def blocks?(%User{info: info} = _user, %{ap_id: ap_id}) do
851 domain_blocks = info.domain_blocks
852 %{host: host} = URI.parse(ap_id)
854 Enum.member?(blocks, ap_id) || Enum.any?(domain_blocks, &(&1 == host))
857 def subscribed_to?(user, %{ap_id: ap_id}) do
858 with %User{} = target <- get_cached_by_ap_id(ap_id) do
859 Enum.member?(target.info.subscribers, user.ap_id)
863 @spec muted_users(User.t()) :: [User.t()]
864 def muted_users(user) do
865 User.Query.build(%{ap_id: user.info.mutes, deactivated: false})
869 @spec blocked_users(User.t()) :: [User.t()]
870 def blocked_users(user) do
871 User.Query.build(%{ap_id: user.info.blocks, deactivated: false})
875 @spec subscribers(User.t()) :: [User.t()]
876 def subscribers(user) do
877 User.Query.build(%{ap_id: user.info.subscribers, deactivated: false})
881 def block_domain(user, domain) do
884 |> User.Info.add_to_domain_block(domain)
888 |> put_embed(:info, info_cng)
890 update_and_set_cache(cng)
893 def unblock_domain(user, domain) do
896 |> User.Info.remove_from_domain_block(domain)
900 |> put_embed(:info, info_cng)
902 update_and_set_cache(cng)
905 def deactivate_async(user, status \\ true) do
906 PleromaJobQueue.enqueue(:background, __MODULE__, [:deactivate_async, user, status])
909 def deactivate(%User{} = user, status \\ true) do
910 info_cng = User.Info.set_activation_status(user.info, status)
912 with {:ok, friends} <- User.get_friends(user),
913 {:ok, followers} <- User.get_followers(user),
917 |> put_embed(:info, info_cng)
918 |> update_and_set_cache() do
919 Enum.each(followers, &invalidate_cache(&1))
920 Enum.each(friends, &update_follower_count(&1))
926 def update_notification_settings(%User{} = user, settings \\ %{}) do
927 info_changeset = User.Info.update_notification_settings(user.info, settings)
930 |> put_embed(:info, info_changeset)
931 |> update_and_set_cache()
934 @spec delete(User.t()) :: :ok
935 def delete(%User{} = user),
936 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:delete, user])
938 @spec perform(atom(), User.t()) :: {:ok, User.t()}
939 def perform(:delete, %User{} = user) do
940 {:ok, _user} = ActivityPub.delete(user)
942 # Remove all relationships
943 {:ok, followers} = User.get_followers(user)
945 Enum.each(followers, fn follower ->
946 ActivityPub.unfollow(follower, user)
947 User.unfollow(follower, user)
950 {:ok, friends} = User.get_friends(user)
952 Enum.each(friends, fn followed ->
953 ActivityPub.unfollow(user, followed)
954 User.unfollow(user, followed)
957 delete_user_activities(user)
958 invalidate_cache(user)
962 @spec perform(atom(), User.t()) :: {:ok, User.t()}
963 def perform(:fetch_initial_posts, %User{} = user) do
964 pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])
967 # Insert all the posts in reverse order, so they're in the right order on the timeline
968 Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
969 &Pleroma.Web.Federator.incoming_ap_doc/1
975 def perform(:deactivate_async, user, status), do: deactivate(user, status)
977 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
978 def perform(:blocks_import, %User{} = blocker, blocked_identifiers)
979 when is_list(blocked_identifiers) do
982 fn blocked_identifier ->
983 with {:ok, %User{} = blocked} <- get_or_fetch(blocked_identifier),
984 {:ok, blocker} <- block(blocker, blocked),
985 {:ok, _} <- ActivityPub.block(blocker, blocked) do
989 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
996 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
997 def perform(:follow_import, %User{} = follower, followed_identifiers)
998 when is_list(followed_identifiers) do
1000 followed_identifiers,
1001 fn followed_identifier ->
1002 with {:ok, %User{} = followed} <- get_or_fetch(followed_identifier),
1003 {:ok, follower} <- maybe_direct_follow(follower, followed),
1004 {:ok, _} <- ActivityPub.follow(follower, followed) do
1008 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
1015 @spec sync_follow_counter() :: :ok
1016 def sync_follow_counter,
1017 do: PleromaJobQueue.enqueue(:background, __MODULE__, [:sync_follow_counters])
1019 @spec perform(:sync_follow_counters) :: :ok
1020 def perform(:sync_follow_counters) do
1021 {:ok, _pid} = Agent.start_link(fn -> %{} end, name: :domain_errors)
1022 config = Pleroma.Config.get([:instance, :external_user_synchronization])
1024 :ok = sync_follow_counters(config)
1025 Agent.stop(:domain_errors)
1028 @spec sync_follow_counters(keyword()) :: :ok
1029 def sync_follow_counters(opts \\ []) do
1030 users = external_users(opts)
1032 if length(users) > 0 do
1033 errors = Agent.get(:domain_errors, fn state -> state end)
1034 {last, updated_errors} = User.Synchronization.call(users, errors, opts)
1035 Agent.update(:domain_errors, fn _state -> updated_errors end)
1036 sync_follow_counters(max_id: last.id, limit: opts[:limit])
1042 @spec external_users(keyword()) :: [User.t()]
1043 def external_users(opts \\ []) do
1049 select: [:id, :ap_id, :info]
1054 do: where(query, [u], u.id > ^opts[:max_id]),
1059 do: limit(query, ^opts[:limit]),
1065 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers),
1067 PleromaJobQueue.enqueue(:background, __MODULE__, [
1073 def follow_import(%User{} = follower, followed_identifiers) when is_list(followed_identifiers),
1075 PleromaJobQueue.enqueue(:background, __MODULE__, [
1078 followed_identifiers
1081 def delete_user_activities(%User{ap_id: ap_id} = user) do
1083 |> Activity.query_by_actor()
1084 |> RepoStreamer.chunk_stream(50)
1085 |> Stream.each(fn activities ->
1086 Enum.each(activities, &delete_activity(&1))
1093 defp delete_activity(%{data: %{"type" => "Create"}} = activity) do
1095 |> Object.normalize()
1096 |> ActivityPub.delete()
1099 defp delete_activity(%{data: %{"type" => "Like"}} = activity) do
1100 user = get_cached_by_ap_id(activity.actor)
1101 object = Object.normalize(activity)
1103 ActivityPub.unlike(user, object)
1106 defp delete_activity(%{data: %{"type" => "Announce"}} = activity) do
1107 user = get_cached_by_ap_id(activity.actor)
1108 object = Object.normalize(activity)
1110 ActivityPub.unannounce(user, object)
1113 defp delete_activity(_activity), do: "Doing nothing"
1115 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
1116 Pleroma.HTML.Scrubber.TwitterText
1119 def html_filter_policy(_), do: Pleroma.Config.get([:markup, :scrub_policy])
1121 def fetch_by_ap_id(ap_id) do
1122 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
1129 case OStatus.make_user(ap_id) do
1130 {:ok, user} -> {:ok, user}
1131 _ -> {:error, "Could not fetch by AP id"}
1136 def get_or_fetch_by_ap_id(ap_id) do
1137 user = get_cached_by_ap_id(ap_id)
1139 if !is_nil(user) and !User.needs_update?(user) do
1142 # Whether to fetch initial posts for the user (if it's a new user & the fetching is enabled)
1143 should_fetch_initial = is_nil(user) and Pleroma.Config.get([:fetch_initial_posts, :enabled])
1145 resp = fetch_by_ap_id(ap_id)
1147 if should_fetch_initial do
1148 with {:ok, %User{} = user} <- resp do
1149 fetch_initial_posts(user)
1157 def get_or_create_instance_user do
1158 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
1160 if user = get_cached_by_ap_id(relay_uri) do
1164 %User{info: %User.Info{}}
1165 |> cast(%{}, [:ap_id, :nickname, :local])
1166 |> put_change(:ap_id, relay_uri)
1167 |> put_change(:nickname, nil)
1168 |> put_change(:local, true)
1169 |> put_change(:follower_address, relay_uri <> "/followers")
1171 {:ok, user} = Repo.insert(changes)
1177 def public_key_from_info(%{
1178 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
1182 |> :public_key.pem_decode()
1184 |> :public_key.pem_entry_decode()
1190 def public_key_from_info(%{magic_key: magic_key}) do
1191 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
1194 def get_public_key_for_ap_id(ap_id) do
1195 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id),
1196 {:ok, public_key} <- public_key_from_info(user.info) do
1203 defp blank?(""), do: nil
1204 defp blank?(n), do: n
1206 def insert_or_update_user(data) do
1208 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
1209 |> remote_user_creation()
1210 |> Repo.insert(on_conflict: :replace_all, conflict_target: :nickname)
1214 def ap_enabled?(%User{local: true}), do: true
1215 def ap_enabled?(%User{info: info}), do: info.ap_enabled
1216 def ap_enabled?(_), do: false
1218 @doc "Gets or fetch a user by uri or nickname."
1219 @spec get_or_fetch(String.t()) :: {:ok, User.t()} | {:error, String.t()}
1220 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1221 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1223 # wait a period of time and return newest version of the User structs
1224 # this is because we have synchronous follow APIs and need to simulate them
1225 # with an async handshake
1226 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1227 with %User{} = a <- User.get_cached_by_id(a.id),
1228 %User{} = b <- User.get_cached_by_id(b.id) do
1236 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1237 with :ok <- :timer.sleep(timeout),
1238 %User{} = a <- User.get_cached_by_id(a.id),
1239 %User{} = b <- User.get_cached_by_id(b.id) do
1247 def parse_bio(bio) when is_binary(bio) and bio != "" do
1249 |> CommonUtils.format_input("text/plain", mentions_format: :full)
1253 def parse_bio(_), do: ""
1255 def parse_bio(bio, user) when is_binary(bio) and bio != "" do
1256 # TODO: get profile URLs other than user.ap_id
1257 profile_urls = [user.ap_id]
1260 |> CommonUtils.format_input("text/plain",
1261 mentions_format: :full,
1262 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1267 def parse_bio(_, _), do: ""
1269 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1270 Repo.transaction(fn ->
1271 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1275 def tag(nickname, tags) when is_binary(nickname),
1276 do: tag(get_by_nickname(nickname), tags)
1278 def tag(%User{} = user, tags),
1279 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1281 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1282 Repo.transaction(fn ->
1283 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1287 def untag(nickname, tags) when is_binary(nickname),
1288 do: untag(get_by_nickname(nickname), tags)
1290 def untag(%User{} = user, tags),
1291 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1293 defp update_tags(%User{} = user, new_tags) do
1294 {:ok, updated_user} =
1296 |> change(%{tags: new_tags})
1297 |> update_and_set_cache()
1302 defp normalize_tags(tags) do
1305 |> Enum.map(&String.downcase(&1))
1308 defp local_nickname_regex do
1309 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1310 @extended_local_nickname_regex
1312 @strict_local_nickname_regex
1316 def local_nickname(nickname_or_mention) do
1319 |> String.split("@")
1323 def full_nickname(nickname_or_mention),
1324 do: String.trim_leading(nickname_or_mention, "@")
1326 def error_user(ap_id) do
1331 nickname: "erroruser@example.com",
1332 inserted_at: NaiveDateTime.utc_now()
1336 @spec all_superusers() :: [User.t()]
1337 def all_superusers do
1338 User.Query.build(%{super_users: true, local: true, deactivated: false})
1342 def showing_reblogs?(%User{} = user, %User{} = target) do
1343 target.ap_id not in user.info.muted_reblogs
1346 @spec toggle_confirmation(User.t()) :: {:ok, User.t()} | {:error, Changeset.t()}
1347 def toggle_confirmation(%User{} = user) do
1348 need_confirmation? = !user.info.confirmation_pending
1351 User.Info.confirmation_changeset(user.info, need_confirmation: need_confirmation?)
1355 |> put_embed(:info, info_changeset)
1356 |> update_and_set_cache()
1359 def get_mascot(%{info: %{mascot: %{} = mascot}}) when not is_nil(mascot) do
1363 def get_mascot(%{info: %{mascot: mascot}}) when is_nil(mascot) do
1364 # use instance-default
1365 config = Pleroma.Config.get([:assets, :mascots])
1366 default_mascot = Pleroma.Config.get([:assets, :default_mascot])
1367 mascot = Keyword.get(config, default_mascot)
1370 "id" => "default-mascot",
1371 "url" => mascot[:url],
1372 "preview_url" => mascot[:url],
1374 "mime_type" => mascot[:mime_type]
1379 def ensure_keys_present(user) do
1385 {:ok, pem} = Keys.generate_rsa_pem()
1389 |> User.Info.set_keys(pem)
1392 Ecto.Changeset.change(user)
1393 |> Ecto.Changeset.put_embed(:info, info_cng)
1395 update_and_set_cache(cng)
1399 def get_ap_ids_by_nicknames(nicknames) do
1401 where: u.nickname in ^nicknames,
1407 defdelegate search(query, opts \\ []), to: User.Search
1409 defp put_password_hash(
1410 %Ecto.Changeset{valid?: true, changes: %{password: password}} = changeset
1412 change(changeset, password_hash: Pbkdf2.hashpwsalt(password))
1415 defp put_password_hash(changeset), do: changeset