1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.User do
10 import Ecto, only: [assoc: 2]
13 alias Pleroma.Activity
15 alias Pleroma.Conversation.Participation
16 alias Pleroma.Delivery
17 alias Pleroma.EctoType.ActivityPub.ObjectValidators
19 alias Pleroma.FollowingRelationship
20 alias Pleroma.Formatter
24 alias Pleroma.Notification
26 alias Pleroma.Registration
29 alias Pleroma.UserRelationship
30 alias Pleroma.Web.ActivityPub.ActivityPub
31 alias Pleroma.Web.ActivityPub.Builder
32 alias Pleroma.Web.ActivityPub.Pipeline
33 alias Pleroma.Web.ActivityPub.Utils
34 alias Pleroma.Web.CommonAPI
35 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
36 alias Pleroma.Web.Endpoint
37 alias Pleroma.Web.OAuth
38 alias Pleroma.Web.RelMe
39 alias Pleroma.Workers.BackgroundWorker
43 @type t :: %__MODULE__{}
44 @type account_status ::
47 | :password_reset_pending
48 | :confirmation_pending
50 @primary_key {:id, FlakeId.Ecto.CompatType, autogenerate: true}
52 # credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
53 @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])?)*$/
55 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
56 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
58 # AP ID user relationships (blocks, mutes etc.)
59 # Format: [rel_type: [outgoing_rel: :outgoing_rel_target, incoming_rel: :incoming_rel_source]]
60 @user_relationships_config [
62 blocker_blocks: :blocked_users,
63 blockee_blocks: :blocker_users
66 muter_mutes: :muted_users,
67 mutee_mutes: :muter_users
70 reblog_muter_mutes: :reblog_muted_users,
71 reblog_mutee_mutes: :reblog_muter_users
74 notification_muter_mutes: :notification_muted_users,
75 notification_mutee_mutes: :notification_muter_users
77 # Note: `inverse_subscription` relationship is inverse: subscriber acts as relationship target
78 inverse_subscription: [
79 subscribee_subscriptions: :subscriber_users,
80 subscriber_subscriptions: :subscribee_users
84 @cachex Pleroma.Config.get([:cachex, :provider], Cachex)
87 field(:bio, :string, default: "")
88 field(:raw_bio, :string)
89 field(:email, :string)
91 field(:nickname, :string)
92 field(:password_hash, :string)
93 field(:password, :string, virtual: true)
94 field(:password_confirmation, :string, virtual: true)
96 field(:public_key, :string)
97 field(:ap_id, :string)
98 field(:avatar, :map, default: %{})
99 field(:local, :boolean, default: true)
100 field(:follower_address, :string)
101 field(:following_address, :string)
102 field(:featured_address, :string)
103 field(:search_rank, :float, virtual: true)
104 field(:search_type, :integer, virtual: true)
105 field(:tags, {:array, :string}, default: [])
106 field(:last_refreshed_at, :naive_datetime_usec)
107 field(:last_digest_emailed_at, :naive_datetime)
108 field(:banner, :map, default: %{})
109 field(:background, :map, default: %{})
110 field(:note_count, :integer, default: 0)
111 field(:follower_count, :integer, default: 0)
112 field(:following_count, :integer, default: 0)
113 field(:is_locked, :boolean, default: false)
114 field(:is_confirmed, :boolean, default: true)
115 field(:password_reset_pending, :boolean, default: false)
116 field(:is_approved, :boolean, default: true)
117 field(:registration_reason, :string, default: nil)
118 field(:confirmation_token, :string, default: nil)
119 field(:default_scope, :string, default: "public")
120 field(:domain_blocks, {:array, :string}, default: [])
121 field(:is_active, :boolean, default: true)
122 field(:no_rich_text, :boolean, default: false)
123 field(:ap_enabled, :boolean, default: false)
124 field(:is_moderator, :boolean, default: false)
125 field(:is_admin, :boolean, default: false)
126 field(:show_role, :boolean, default: true)
127 field(:mastofe_settings, :map, default: nil)
128 field(:uri, ObjectValidators.Uri, default: nil)
129 field(:hide_followers_count, :boolean, default: false)
130 field(:hide_follows_count, :boolean, default: false)
131 field(:hide_followers, :boolean, default: false)
132 field(:hide_follows, :boolean, default: false)
133 field(:hide_favorites, :boolean, default: true)
134 field(:email_notifications, :map, default: %{"digest" => false})
135 field(:mascot, :map, default: nil)
136 field(:emoji, :map, default: %{})
137 field(:pleroma_settings_store, :map, default: %{})
138 field(:fields, {:array, :map}, default: [])
139 field(:raw_fields, {:array, :map}, default: [])
140 field(:is_discoverable, :boolean, default: false)
141 field(:invisible, :boolean, default: false)
142 field(:allow_following_move, :boolean, default: true)
143 field(:skip_thread_containment, :boolean, default: false)
144 field(:actor_type, :string, default: "Person")
145 field(:also_known_as, {:array, ObjectValidators.ObjectID}, default: [])
146 field(:inbox, :string)
147 field(:shared_inbox, :string)
148 field(:last_active_at, :naive_datetime)
149 field(:disclose_client, :boolean, default: true)
150 field(:pinned_objects, :map, default: %{})
151 field(:is_suggested, :boolean, default: false)
152 field(:last_status_at, :naive_datetime)
153 field(:language, :string)
156 :notification_settings,
157 Pleroma.User.NotificationSetting,
161 has_many(:notifications, Notification)
162 has_many(:registrations, Registration)
163 has_many(:deliveries, Delivery)
165 has_many(:outgoing_relationships, UserRelationship, foreign_key: :source_id)
166 has_many(:incoming_relationships, UserRelationship, foreign_key: :target_id)
168 for {relationship_type,
170 {outgoing_relation, outgoing_relation_target},
171 {incoming_relation, incoming_relation_source}
172 ]} <- @user_relationships_config do
173 # Definitions of `has_many` relations: :blocker_blocks, :muter_mutes, :reblog_muter_mutes,
174 # :notification_muter_mutes, :subscribee_subscriptions
175 has_many(outgoing_relation, UserRelationship,
176 foreign_key: :source_id,
177 where: [relationship_type: relationship_type]
180 # Definitions of `has_many` relations: :blockee_blocks, :mutee_mutes, :reblog_mutee_mutes,
181 # :notification_mutee_mutes, :subscriber_subscriptions
182 has_many(incoming_relation, UserRelationship,
183 foreign_key: :target_id,
184 where: [relationship_type: relationship_type]
187 # Definitions of `has_many` relations: :blocked_users, :muted_users, :reblog_muted_users,
188 # :notification_muted_users, :subscriber_users
189 has_many(outgoing_relation_target, through: [outgoing_relation, :target])
191 # Definitions of `has_many` relations: :blocker_users, :muter_users, :reblog_muter_users,
192 # :notification_muter_users, :subscribee_users
193 has_many(incoming_relation_source, through: [incoming_relation, :source])
197 :multi_factor_authentication_settings,
205 for {_relationship_type, [{_outgoing_relation, outgoing_relation_target}, _]} <-
206 @user_relationships_config do
207 # `def blocked_users_relation/2`, `def muted_users_relation/2`,
208 # `def reblog_muted_users_relation/2`, `def notification_muted_users/2`,
209 # `def subscriber_users/2`
210 def unquote(:"#{outgoing_relation_target}_relation")(user, restrict_deactivated? \\ false) do
211 target_users_query = assoc(user, unquote(outgoing_relation_target))
213 if restrict_deactivated? do
215 |> User.Query.build(%{deactivated: false})
221 # `def blocked_users/2`, `def muted_users/2`, `def reblog_muted_users/2`,
222 # `def notification_muted_users/2`, `def subscriber_users/2`
223 def unquote(outgoing_relation_target)(user, restrict_deactivated? \\ false) do
225 |> apply(unquote(:"#{outgoing_relation_target}_relation"), [
227 restrict_deactivated?
232 # `def blocked_users_ap_ids/2`, `def muted_users_ap_ids/2`, `def reblog_muted_users_ap_ids/2`,
233 # `def notification_muted_users_ap_ids/2`, `def subscriber_users_ap_ids/2`
234 def unquote(:"#{outgoing_relation_target}_ap_ids")(user, restrict_deactivated? \\ false) do
236 |> apply(unquote(:"#{outgoing_relation_target}_relation"), [
238 restrict_deactivated?
240 |> select([u], u.ap_id)
245 def cached_blocked_users_ap_ids(user) do
246 @cachex.fetch!(:user_cache, "blocked_users_ap_ids:#{user.ap_id}", fn _ ->
247 blocked_users_ap_ids(user)
251 def cached_muted_users_ap_ids(user) do
252 @cachex.fetch!(:user_cache, "muted_users_ap_ids:#{user.ap_id}", fn _ ->
253 muted_users_ap_ids(user)
257 defdelegate following_count(user), to: FollowingRelationship
258 defdelegate following(user), to: FollowingRelationship
259 defdelegate following?(follower, followed), to: FollowingRelationship
260 defdelegate following_ap_ids(user), to: FollowingRelationship
261 defdelegate get_follow_requests(user), to: FollowingRelationship
262 defdelegate search(query, opts \\ []), to: User.Search
265 Dumps Flake Id to SQL-compatible format (16-byte UUID).
266 E.g. "9pQtDGXuq4p3VlcJEm" -> <<0, 0, 1, 110, 179, 218, 42, 92, 213, 41, 44, 227, 95, 213, 0, 0>>
268 def binary_id(source_id) when is_binary(source_id) do
269 with {:ok, dumped_id} <- FlakeId.Ecto.CompatType.dump(source_id) do
276 def binary_id(source_ids) when is_list(source_ids) do
277 Enum.map(source_ids, &binary_id/1)
280 def binary_id(%User{} = user), do: binary_id(user.id)
282 @doc "Returns status account"
283 @spec account_status(User.t()) :: account_status()
284 def account_status(%User{is_active: false}), do: :deactivated
285 def account_status(%User{password_reset_pending: true}), do: :password_reset_pending
286 def account_status(%User{local: true, is_approved: false}), do: :approval_pending
287 def account_status(%User{local: true, is_confirmed: false}), do: :confirmation_pending
288 def account_status(%User{}), do: :active
290 @spec visible_for(User.t(), User.t() | nil) ::
293 | :restricted_unauthenticated
295 | :confirmation_pending
296 def visible_for(user, for_user \\ nil)
298 def visible_for(%User{invisible: true}, _), do: :invisible
300 def visible_for(%User{id: user_id}, %User{id: user_id}), do: :visible
302 def visible_for(%User{} = user, nil) do
303 if restrict_unauthenticated?(user) do
304 :restrict_unauthenticated
306 visible_account_status(user)
310 def visible_for(%User{} = user, for_user) do
311 if superuser?(for_user) do
314 visible_account_status(user)
318 def visible_for(_, _), do: :invisible
320 defp restrict_unauthenticated?(%User{local: true}) do
321 Config.restrict_unauthenticated_access?(:profiles, :local)
324 defp restrict_unauthenticated?(%User{local: _}) do
325 Config.restrict_unauthenticated_access?(:profiles, :remote)
328 defp visible_account_status(user) do
329 status = account_status(user)
331 if status in [:active, :password_reset_pending] do
338 @spec superuser?(User.t()) :: boolean()
339 def superuser?(%User{local: true, is_admin: true}), do: true
340 def superuser?(%User{local: true, is_moderator: true}), do: true
341 def superuser?(_), do: false
343 @spec invisible?(User.t()) :: boolean()
344 def invisible?(%User{invisible: true}), do: true
345 def invisible?(_), do: false
347 def avatar_url(user, options \\ []) do
349 %{"url" => [%{"href" => href} | _]} ->
353 unless options[:no_default] do
354 Config.get([:assets, :default_user_avatar], "#{Endpoint.url()}/images/avi.png")
359 def banner_url(user, options \\ []) do
361 %{"url" => [%{"href" => href} | _]} -> href
362 _ -> !options[:no_default] && "#{Endpoint.url()}/images/banner.png"
366 # Should probably be renamed or removed
367 @spec ap_id(User.t()) :: String.t()
368 def ap_id(%User{nickname: nickname}), do: "#{Endpoint.url()}/users/#{nickname}"
370 @spec ap_followers(User.t()) :: String.t()
371 def ap_followers(%User{follower_address: fa}) when is_binary(fa), do: fa
372 def ap_followers(%User{} = user), do: "#{ap_id(user)}/followers"
374 @spec ap_following(User.t()) :: String.t()
375 def ap_following(%User{following_address: fa}) when is_binary(fa), do: fa
376 def ap_following(%User{} = user), do: "#{ap_id(user)}/following"
378 @spec ap_featured_collection(User.t()) :: String.t()
379 def ap_featured_collection(%User{featured_address: fa}) when is_binary(fa), do: fa
381 def ap_featured_collection(%User{} = user), do: "#{ap_id(user)}/collections/featured"
383 defp truncate_fields_param(params) do
384 if Map.has_key?(params, :fields) do
385 Map.put(params, :fields, Enum.map(params[:fields], &truncate_field/1))
391 defp truncate_if_exists(params, key, max_length) do
392 if Map.has_key?(params, key) and is_binary(params[key]) do
393 {value, _chopped} = String.split_at(params[key], max_length)
394 Map.put(params, key, value)
400 defp fix_follower_address(%{follower_address: _, following_address: _} = params), do: params
402 defp fix_follower_address(%{nickname: nickname} = params),
403 do: Map.put(params, :follower_address, ap_followers(%User{nickname: nickname}))
405 defp fix_follower_address(params), do: params
407 def remote_user_changeset(struct \\ %User{local: false}, params) do
408 bio_limit = Config.get([:instance, :user_bio_length], 5000)
409 name_limit = Config.get([:instance, :user_name_length], 100)
412 case params[:name] do
413 name when is_binary(name) and byte_size(name) > 0 -> name
414 _ -> params[:nickname]
419 |> Map.put(:name, name)
420 |> Map.put_new(:last_refreshed_at, NaiveDateTime.utc_now())
421 |> truncate_if_exists(:name, name_limit)
422 |> truncate_if_exists(:bio, bio_limit)
423 |> truncate_fields_param()
424 |> fix_follower_address()
448 :hide_followers_count,
460 |> cast(params, [:name], empty_values: [])
461 |> validate_required([:ap_id])
462 |> validate_required([:name], trim: false)
463 |> unique_constraint(:nickname)
464 |> validate_format(:nickname, @email_regex)
465 |> validate_length(:bio, max: bio_limit)
466 |> validate_length(:name, max: name_limit)
467 |> validate_fields(true)
468 |> validate_non_local()
471 defp validate_non_local(cng) do
472 local? = get_field(cng, :local)
476 |> add_error(:local, "User is local, can't update with this changeset.")
482 def update_changeset(struct, params \\ %{}) do
483 bio_limit = Config.get([:instance, :user_bio_length], 5000)
484 name_limit = Config.get([:instance, :user_name_length], 100)
504 :hide_followers_count,
507 :allow_following_move,
511 :skip_thread_containment,
514 :pleroma_settings_store,
520 |> unique_constraint(:nickname)
521 |> validate_format(:nickname, local_nickname_regex())
522 |> validate_length(:bio, max: bio_limit)
523 |> validate_length(:name, min: 1, max: name_limit)
524 |> validate_inclusion(:actor_type, ["Person", "Service"])
527 |> put_change_if_present(:bio, &{:ok, parse_bio(&1, struct)})
528 |> put_change_if_present(:avatar, &put_upload(&1, :avatar))
529 |> put_change_if_present(:banner, &put_upload(&1, :banner))
530 |> put_change_if_present(:background, &put_upload(&1, :background))
531 |> put_change_if_present(
532 :pleroma_settings_store,
533 &{:ok, Map.merge(struct.pleroma_settings_store, &1)}
535 |> validate_fields(false)
538 defp put_fields(changeset) do
539 if raw_fields = get_change(changeset, :raw_fields) do
542 |> Enum.filter(fn %{"name" => n} -> n != "" end)
546 |> Enum.map(fn f -> Map.update!(f, "value", &parse_fields(&1)) end)
549 |> put_change(:raw_fields, raw_fields)
550 |> put_change(:fields, fields)
556 defp parse_fields(value) do
558 |> Formatter.linkify(mentions_format: :full)
562 defp put_emoji(changeset) do
563 emojified_fields = [:bio, :name, :raw_fields]
565 if Enum.any?(changeset.changes, fn {k, _} -> k in emojified_fields end) do
566 bio = Emoji.Formatter.get_emoji_map(get_field(changeset, :bio))
567 name = Emoji.Formatter.get_emoji_map(get_field(changeset, :name))
569 emoji = Map.merge(bio, name)
573 |> get_field(:raw_fields)
574 |> Enum.reduce(emoji, fn x, acc ->
575 Map.merge(acc, Emoji.Formatter.get_emoji_map(x["name"] <> x["value"]))
578 put_change(changeset, :emoji, emoji)
584 defp put_change_if_present(changeset, map_field, value_function) do
585 with {:ok, value} <- fetch_change(changeset, map_field),
586 {:ok, new_value} <- value_function.(value) do
587 put_change(changeset, map_field, new_value)
593 defp put_upload(value, type) do
594 with %Plug.Upload{} <- value,
595 {:ok, object} <- ActivityPub.upload(value, type: type) do
600 def update_as_admin_changeset(struct, params) do
602 |> update_changeset(params)
603 |> cast(params, [:email])
604 |> delete_change(:also_known_as)
605 |> unique_constraint(:email)
606 |> validate_format(:email, @email_regex)
607 |> validate_inclusion(:actor_type, ["Person", "Service"])
610 @spec update_as_admin(User.t(), map()) :: {:ok, User.t()} | {:error, Changeset.t()}
611 def update_as_admin(user, params) do
612 params = Map.put(params, "password_confirmation", params["password"])
613 changeset = update_as_admin_changeset(user, params)
615 if params["password"] do
616 reset_password(user, changeset, params)
618 User.update_and_set_cache(changeset)
622 def password_update_changeset(struct, params) do
624 |> cast(params, [:password, :password_confirmation])
625 |> validate_required([:password, :password_confirmation])
626 |> validate_confirmation(:password)
627 |> put_password_hash()
628 |> put_change(:password_reset_pending, false)
631 @spec reset_password(User.t(), map()) :: {:ok, User.t()} | {:error, Changeset.t()}
632 def reset_password(%User{} = user, params) do
633 reset_password(user, user, params)
636 def reset_password(%User{id: user_id} = user, struct, params) do
639 |> Multi.update(:user, password_update_changeset(struct, params))
640 |> Multi.delete_all(:tokens, OAuth.Token.Query.get_by_user(user_id))
641 |> Multi.delete_all(:auth, OAuth.Authorization.delete_by_user_query(user))
643 case Repo.transaction(multi) do
644 {:ok, %{user: user} = _} -> set_cache(user)
645 {:error, _, changeset, _} -> {:error, changeset}
649 def update_password_reset_pending(user, value) do
652 |> put_change(:password_reset_pending, value)
653 |> update_and_set_cache()
656 def force_password_reset_async(user) do
657 BackgroundWorker.enqueue("force_password_reset", %{"user_id" => user.id})
660 @spec force_password_reset(User.t()) :: {:ok, User.t()} | {:error, Ecto.Changeset.t()}
661 def force_password_reset(user), do: update_password_reset_pending(user, true)
663 def register_changeset(struct, params \\ %{}, opts \\ []) do
664 bio_limit = Config.get([:instance, :user_bio_length], 5000)
665 name_limit = Config.get([:instance, :user_name_length], 100)
666 reason_limit = Config.get([:instance, :registration_reason_length], 500)
669 if is_nil(opts[:confirmed]) do
670 !Config.get([:instance, :account_activation_required])
676 if is_nil(opts[:approved]) do
677 !Config.get([:instance, :account_approval_required])
683 |> confirmation_changeset(set_confirmation: confirmed?)
684 |> approval_changeset(set_approval: approved?)
692 :password_confirmation,
694 :registration_reason,
697 |> validate_required([:name, :nickname, :password, :password_confirmation])
698 |> validate_confirmation(:password)
699 |> unique_constraint(:email)
700 |> validate_format(:email, @email_regex)
701 |> validate_change(:email, fn :email, email ->
703 Config.get([User, :email_blacklist])
704 |> Enum.all?(fn blacklisted_domain ->
705 !String.ends_with?(email, ["@" <> blacklisted_domain, "." <> blacklisted_domain])
708 if valid?, do: [], else: [email: "Invalid email"]
710 |> unique_constraint(:nickname)
711 |> validate_exclusion(:nickname, Config.get([User, :restricted_nicknames]))
712 |> validate_format(:nickname, local_nickname_regex())
713 |> validate_length(:bio, max: bio_limit)
714 |> validate_length(:name, min: 1, max: name_limit)
715 |> validate_length(:registration_reason, max: reason_limit)
716 |> maybe_validate_required_email(opts[:external])
719 |> unique_constraint(:ap_id)
720 |> put_following_and_follower_and_featured_address()
723 def maybe_validate_required_email(changeset, true), do: changeset
725 def maybe_validate_required_email(changeset, _) do
726 if Config.get([:instance, :account_activation_required]) do
727 validate_required(changeset, [:email])
733 defp put_ap_id(changeset) do
734 ap_id = ap_id(%User{nickname: get_field(changeset, :nickname)})
735 put_change(changeset, :ap_id, ap_id)
738 defp put_following_and_follower_and_featured_address(changeset) do
739 user = %User{nickname: get_field(changeset, :nickname)}
740 followers = ap_followers(user)
741 following = ap_following(user)
742 featured = ap_featured_collection(user)
745 |> put_change(:follower_address, followers)
746 |> put_change(:following_address, following)
747 |> put_change(:featured_address, featured)
750 defp autofollow_users(user) do
751 candidates = Config.get([:instance, :autofollowed_nicknames])
754 User.Query.build(%{nickname: candidates, local: true, is_active: true})
757 follow_all(user, autofollowed_users)
760 defp autofollowing_users(user) do
761 candidates = Config.get([:instance, :autofollowing_nicknames])
763 User.Query.build(%{nickname: candidates, local: true, deactivated: false})
765 |> Enum.each(&follow(&1, user, :follow_accept))
770 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
771 def register(%Ecto.Changeset{} = changeset) do
772 with {:ok, user} <- Repo.insert(changeset) do
773 post_register_action(user)
777 def post_register_action(%User{is_confirmed: false} = user) do
778 with {:ok, _} <- maybe_send_confirmation_email(user) do
783 def post_register_action(%User{is_approved: false} = user) do
784 with {:ok, _} <- send_user_approval_email(user),
785 {:ok, _} <- send_admin_approval_emails(user) do
790 def post_register_action(%User{is_approved: true, is_confirmed: true} = user) do
791 with {:ok, user} <- autofollow_users(user),
792 {:ok, _} <- autofollowing_users(user),
793 {:ok, user} <- set_cache(user),
794 {:ok, _} <- maybe_send_registration_email(user),
795 {:ok, _} <- maybe_send_welcome_email(user),
796 {:ok, _} <- maybe_send_welcome_message(user) do
801 defp send_user_approval_email(user) do
803 |> Pleroma.Emails.UserEmail.approval_pending_email()
804 |> Pleroma.Emails.Mailer.deliver_async()
809 defp send_admin_approval_emails(user) do
811 |> Enum.filter(fn user -> not is_nil(user.email) end)
812 |> Enum.each(fn superuser ->
814 |> Pleroma.Emails.AdminEmail.new_unapproved_registration(user)
815 |> Pleroma.Emails.Mailer.deliver_async()
821 defp maybe_send_welcome_message(user) do
822 if User.WelcomeMessage.enabled?() do
823 User.WelcomeMessage.post_message(user)
830 defp maybe_send_welcome_email(%User{email: email} = user) when is_binary(email) do
831 if User.WelcomeEmail.enabled?() do
832 User.WelcomeEmail.send_email(user)
839 defp maybe_send_welcome_email(_), do: {:ok, :noop}
841 @spec maybe_send_confirmation_email(User.t()) :: {:ok, :enqueued | :noop}
842 def maybe_send_confirmation_email(%User{is_confirmed: false, email: email} = user)
843 when is_binary(email) do
844 if Config.get([:instance, :account_activation_required]) do
845 send_confirmation_email(user)
852 def maybe_send_confirmation_email(_), do: {:ok, :noop}
854 @spec send_confirmation_email(Uset.t()) :: User.t()
855 def send_confirmation_email(%User{} = user) do
857 |> Pleroma.Emails.UserEmail.account_confirmation_email()
858 |> Pleroma.Emails.Mailer.deliver_async()
863 @spec maybe_send_registration_email(User.t()) :: {:ok, :enqueued | :noop}
864 defp maybe_send_registration_email(%User{email: email} = user) when is_binary(email) do
865 with false <- User.WelcomeEmail.enabled?(),
866 false <- Config.get([:instance, :account_activation_required], false),
867 false <- Config.get([:instance, :account_approval_required], false) do
869 |> Pleroma.Emails.UserEmail.successful_registration_email()
870 |> Pleroma.Emails.Mailer.deliver_async()
879 defp maybe_send_registration_email(_), do: {:ok, :noop}
881 def needs_update?(%User{local: true}), do: false
883 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
885 def needs_update?(%User{local: false} = user) do
886 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
889 def needs_update?(_), do: true
891 @spec maybe_direct_follow(User.t(), User.t()) :: {:ok, User.t()} | {:error, String.t()}
893 # "Locked" (self-locked) users demand explicit authorization of follow requests
894 def maybe_direct_follow(%User{} = follower, %User{local: true, is_locked: true} = followed) do
895 follow(follower, followed, :follow_pending)
898 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
899 follow(follower, followed)
902 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
903 if not ap_enabled?(followed) do
904 follow(follower, followed)
906 {:ok, follower, followed}
910 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
911 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
912 def follow_all(follower, followeds) do
914 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
915 |> Enum.each(&follow(follower, &1, :follow_accept))
920 def follow(%User{} = follower, %User{} = followed, state \\ :follow_accept) do
921 deny_follow_blocked = Config.get([:user, :deny_follow_blocked])
924 not followed.is_active ->
925 {:error, "Could not follow user: #{followed.nickname} is deactivated."}
927 deny_follow_blocked and blocks?(followed, follower) ->
928 {:error, "Could not follow user: #{followed.nickname} blocked you."}
931 FollowingRelationship.follow(follower, followed, state)
935 def unfollow(%User{ap_id: ap_id}, %User{ap_id: ap_id}) do
936 {:error, "Not subscribed!"}
939 @spec unfollow(User.t(), User.t()) :: {:ok, User.t(), Activity.t()} | {:error, String.t()}
940 def unfollow(%User{} = follower, %User{} = followed) do
941 case do_unfollow(follower, followed) do
942 {:ok, follower, followed} ->
943 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
950 @spec do_unfollow(User.t(), User.t()) :: {:ok, User.t(), User.t()} | {:error, String.t()}
951 defp do_unfollow(%User{} = follower, %User{} = followed) do
952 case get_follow_state(follower, followed) do
953 state when state in [:follow_pending, :follow_accept] ->
954 FollowingRelationship.unfollow(follower, followed)
957 {:error, "Not subscribed!"}
961 @doc "Returns follow state as Pleroma.FollowingRelationship.State value"
962 def get_follow_state(%User{} = follower, %User{} = following) do
963 following_relationship = FollowingRelationship.get(follower, following)
964 get_follow_state(follower, following, following_relationship)
967 def get_follow_state(
970 following_relationship
972 case {following_relationship, following.local} do
974 case Utils.fetch_latest_follow(follower, following) do
975 %Activity{data: %{"state" => state}} when state in ["pending", "accept"] ->
976 FollowingRelationship.state_to_enum(state)
982 {%{state: state}, _} ->
990 def locked?(%User{} = user) do
991 user.is_locked || false
995 Repo.get_by(User, id: id)
998 def get_by_ap_id(ap_id) do
999 Repo.get_by(User, ap_id: ap_id)
1002 def get_all_by_ap_id(ap_ids) do
1003 from(u in __MODULE__,
1004 where: u.ap_id in ^ap_ids
1009 def get_all_by_ids(ids) do
1010 from(u in __MODULE__, where: u.id in ^ids)
1014 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
1015 # of the ap_id and the domain and tries to get that user
1016 def get_by_guessed_nickname(ap_id) do
1017 domain = URI.parse(ap_id).host
1018 name = List.last(String.split(ap_id, "/"))
1019 nickname = "#{name}@#{domain}"
1021 get_cached_by_nickname(nickname)
1024 def set_cache({:ok, user}), do: set_cache(user)
1025 def set_cache({:error, err}), do: {:error, err}
1027 def set_cache(%User{} = user) do
1028 @cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
1029 @cachex.put(:user_cache, "nickname:#{user.nickname}", user)
1030 @cachex.put(:user_cache, "friends_ap_ids:#{user.nickname}", get_user_friends_ap_ids(user))
1034 def update_and_set_cache(struct, params) do
1036 |> update_changeset(params)
1037 |> update_and_set_cache()
1040 def update_and_set_cache(%{data: %Pleroma.User{} = user} = changeset) do
1041 was_superuser_before_update = User.superuser?(user)
1043 with {:ok, user} <- Repo.update(changeset, stale_error_field: :id) do
1046 |> maybe_remove_report_notifications(was_superuser_before_update)
1049 defp maybe_remove_report_notifications({:ok, %Pleroma.User{} = user} = result, true) do
1050 if not User.superuser?(user),
1051 do: user |> Notification.destroy_multiple_from_types(["pleroma:report"])
1056 defp maybe_remove_report_notifications(result, _) do
1060 def get_user_friends_ap_ids(user) do
1061 from(u in User.get_friends_query(user), select: u.ap_id)
1065 @spec get_cached_user_friends_ap_ids(User.t()) :: [String.t()]
1066 def get_cached_user_friends_ap_ids(user) do
1067 @cachex.fetch!(:user_cache, "friends_ap_ids:#{user.ap_id}", fn _ ->
1068 get_user_friends_ap_ids(user)
1072 def invalidate_cache(user) do
1073 @cachex.del(:user_cache, "ap_id:#{user.ap_id}")
1074 @cachex.del(:user_cache, "nickname:#{user.nickname}")
1075 @cachex.del(:user_cache, "friends_ap_ids:#{user.ap_id}")
1076 @cachex.del(:user_cache, "blocked_users_ap_ids:#{user.ap_id}")
1077 @cachex.del(:user_cache, "muted_users_ap_ids:#{user.ap_id}")
1080 @spec get_cached_by_ap_id(String.t()) :: User.t() | nil
1081 def get_cached_by_ap_id(ap_id) do
1082 key = "ap_id:#{ap_id}"
1084 with {:ok, nil} <- @cachex.get(:user_cache, key),
1085 user when not is_nil(user) <- get_by_ap_id(ap_id),
1086 {:ok, true} <- @cachex.put(:user_cache, key, user) do
1094 def get_cached_by_id(id) do
1098 @cachex.fetch!(:user_cache, key, fn _ ->
1099 user = get_by_id(id)
1102 @cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
1103 {:commit, user.ap_id}
1109 get_cached_by_ap_id(ap_id)
1112 def get_cached_by_nickname(nickname) do
1113 key = "nickname:#{nickname}"
1115 @cachex.fetch!(:user_cache, key, fn _ ->
1116 case get_or_fetch_by_nickname(nickname) do
1117 {:ok, user} -> {:commit, user}
1118 {:error, _error} -> {:ignore, nil}
1123 def get_cached_by_nickname_or_id(nickname_or_id, opts \\ []) do
1124 restrict_to_local = Config.get([:instance, :limit_to_local_content])
1127 is_integer(nickname_or_id) or FlakeId.flake_id?(nickname_or_id) ->
1128 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
1130 restrict_to_local == false or not String.contains?(nickname_or_id, "@") ->
1131 get_cached_by_nickname(nickname_or_id)
1133 restrict_to_local == :unauthenticated and match?(%User{}, opts[:for]) ->
1134 get_cached_by_nickname(nickname_or_id)
1141 @spec get_by_nickname(String.t()) :: User.t() | nil
1142 def get_by_nickname(nickname) do
1143 Repo.get_by(User, nickname: nickname) ||
1144 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
1145 Repo.get_by(User, nickname: local_nickname(nickname))
1149 def get_by_email(email), do: Repo.get_by(User, email: email)
1151 def get_by_nickname_or_email(nickname_or_email) do
1152 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
1155 def fetch_by_nickname(nickname), do: ActivityPub.make_user_from_nickname(nickname)
1157 def get_or_fetch_by_nickname(nickname) do
1158 with %User{} = user <- get_by_nickname(nickname) do
1162 with [_nick, _domain] <- String.split(nickname, "@"),
1163 {:ok, user} <- fetch_by_nickname(nickname) do
1166 _e -> {:error, "not found " <> nickname}
1171 @spec get_followers_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
1172 def get_followers_query(%User{} = user, nil) do
1173 User.Query.build(%{followers: user, is_active: true})
1176 def get_followers_query(%User{} = user, page) do
1178 |> get_followers_query(nil)
1179 |> User.Query.paginate(page, 20)
1182 @spec get_followers_query(User.t()) :: Ecto.Query.t()
1183 def get_followers_query(%User{} = user), do: get_followers_query(user, nil)
1185 @spec get_followers(User.t(), pos_integer() | nil) :: {:ok, list(User.t())}
1186 def get_followers(%User{} = user, page \\ nil) do
1188 |> get_followers_query(page)
1192 @spec get_external_followers(User.t(), pos_integer() | nil) :: {:ok, list(User.t())}
1193 def get_external_followers(%User{} = user, page \\ nil) do
1195 |> get_followers_query(page)
1196 |> User.Query.build(%{external: true})
1200 def get_followers_ids(%User{} = user, page \\ nil) do
1202 |> get_followers_query(page)
1203 |> select([u], u.id)
1207 @spec get_friends_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
1208 def get_friends_query(%User{} = user, nil) do
1209 User.Query.build(%{friends: user, deactivated: false})
1212 def get_friends_query(%User{} = user, page) do
1214 |> get_friends_query(nil)
1215 |> User.Query.paginate(page, 20)
1218 @spec get_friends_query(User.t()) :: Ecto.Query.t()
1219 def get_friends_query(%User{} = user), do: get_friends_query(user, nil)
1221 def get_friends(%User{} = user, page \\ nil) do
1223 |> get_friends_query(page)
1227 def get_friends_ap_ids(%User{} = user) do
1229 |> get_friends_query(nil)
1230 |> select([u], u.ap_id)
1234 def get_friends_ids(%User{} = user, page \\ nil) do
1236 |> get_friends_query(page)
1237 |> select([u], u.id)
1241 def increase_note_count(%User{} = user) do
1243 |> where(id: ^user.id)
1244 |> update([u], inc: [note_count: 1])
1246 |> Repo.update_all([])
1248 {1, [user]} -> set_cache(user)
1253 def decrease_note_count(%User{} = user) do
1255 |> where(id: ^user.id)
1258 note_count: fragment("greatest(0, note_count - 1)")
1262 |> Repo.update_all([])
1264 {1, [user]} -> set_cache(user)
1269 def update_note_count(%User{} = user, note_count \\ nil) do
1274 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
1280 |> cast(%{note_count: note_count}, [:note_count])
1281 |> update_and_set_cache()
1284 @spec maybe_fetch_follow_information(User.t()) :: User.t()
1285 def maybe_fetch_follow_information(user) do
1286 with {:ok, user} <- fetch_follow_information(user) do
1290 Logger.error("Follower/Following counter update for #{user.ap_id} failed.\n#{inspect(e)}")
1296 def fetch_follow_information(user) do
1297 with {:ok, info} <- ActivityPub.fetch_follow_information_for_user(user) do
1299 |> follow_information_changeset(info)
1300 |> update_and_set_cache()
1304 defp follow_information_changeset(user, params) do
1311 :hide_followers_count,
1316 @spec update_follower_count(User.t()) :: {:ok, User.t()}
1317 def update_follower_count(%User{} = user) do
1318 if user.local or !Config.get([:instance, :external_user_synchronization]) do
1319 follower_count = FollowingRelationship.follower_count(user)
1322 |> follow_information_changeset(%{follower_count: follower_count})
1323 |> update_and_set_cache
1325 {:ok, maybe_fetch_follow_information(user)}
1329 @spec update_following_count(User.t()) :: {:ok, User.t()}
1330 def update_following_count(%User{local: false} = user) do
1331 if Config.get([:instance, :external_user_synchronization]) do
1332 {:ok, maybe_fetch_follow_information(user)}
1338 def update_following_count(%User{local: true} = user) do
1339 following_count = FollowingRelationship.following_count(user)
1342 |> follow_information_changeset(%{following_count: following_count})
1343 |> update_and_set_cache()
1346 @spec get_users_from_set([String.t()], keyword()) :: [User.t()]
1347 def get_users_from_set(ap_ids, opts \\ []) do
1348 local_only = Keyword.get(opts, :local_only, true)
1349 criteria = %{ap_id: ap_ids, is_active: true}
1350 criteria = if local_only, do: Map.put(criteria, :local, true), else: criteria
1352 User.Query.build(criteria)
1356 @spec get_recipients_from_activity(Activity.t()) :: [User.t()]
1357 def get_recipients_from_activity(%Activity{recipients: to, actor: actor}) do
1360 query = User.Query.build(%{recipients_from_activity: to, local: true, is_active: true})
1366 @spec mute(User.t(), User.t(), map()) ::
1367 {:ok, list(UserRelationship.t())} | {:error, String.t()}
1368 def mute(%User{} = muter, %User{} = mutee, params \\ %{}) do
1369 notifications? = Map.get(params, :notifications, true)
1370 expires_in = Map.get(params, :expires_in, 0)
1372 with {:ok, user_mute} <- UserRelationship.create_mute(muter, mutee),
1373 {:ok, user_notification_mute} <-
1374 (notifications? && UserRelationship.create_notification_mute(muter, mutee)) ||
1376 if expires_in > 0 do
1377 Pleroma.Workers.MuteExpireWorker.enqueue(
1379 %{"muter_id" => muter.id, "mutee_id" => mutee.id},
1380 schedule_in: expires_in
1384 @cachex.del(:user_cache, "muted_users_ap_ids:#{muter.ap_id}")
1386 {:ok, Enum.filter([user_mute, user_notification_mute], & &1)}
1390 def unmute(%User{} = muter, %User{} = mutee) do
1391 with {:ok, user_mute} <- UserRelationship.delete_mute(muter, mutee),
1392 {:ok, user_notification_mute} <-
1393 UserRelationship.delete_notification_mute(muter, mutee) do
1394 @cachex.del(:user_cache, "muted_users_ap_ids:#{muter.ap_id}")
1395 {:ok, [user_mute, user_notification_mute]}
1399 def unmute(muter_id, mutee_id) do
1400 with {:muter, %User{} = muter} <- {:muter, User.get_by_id(muter_id)},
1401 {:mutee, %User{} = mutee} <- {:mutee, User.get_by_id(mutee_id)} do
1402 unmute(muter, mutee)
1404 {who, result} = error ->
1406 "User.unmute/2 failed. #{who}: #{result}, muter_id: #{muter_id}, mutee_id: #{mutee_id}"
1413 def subscribe(%User{} = subscriber, %User{} = target) do
1414 deny_follow_blocked = Config.get([:user, :deny_follow_blocked])
1416 if blocks?(target, subscriber) and deny_follow_blocked do
1417 {:error, "Could not subscribe: #{target.nickname} is blocking you"}
1419 # Note: the relationship is inverse: subscriber acts as relationship target
1420 UserRelationship.create_inverse_subscription(target, subscriber)
1424 def subscribe(%User{} = subscriber, %{ap_id: ap_id}) do
1425 with %User{} = subscribee <- get_cached_by_ap_id(ap_id) do
1426 subscribe(subscriber, subscribee)
1430 def unsubscribe(%User{} = unsubscriber, %User{} = target) do
1431 # Note: the relationship is inverse: subscriber acts as relationship target
1432 UserRelationship.delete_inverse_subscription(target, unsubscriber)
1435 def unsubscribe(%User{} = unsubscriber, %{ap_id: ap_id}) do
1436 with %User{} = user <- get_cached_by_ap_id(ap_id) do
1437 unsubscribe(unsubscriber, user)
1441 def block(%User{} = blocker, %User{} = blocked) do
1442 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
1444 if following?(blocker, blocked) do
1445 {:ok, blocker, _} = unfollow(blocker, blocked)
1451 # clear any requested follows as well
1453 case CommonAPI.reject_follow_request(blocked, blocker) do
1454 {:ok, %User{} = updated_blocked} -> updated_blocked
1458 unsubscribe(blocked, blocker)
1460 unfollowing_blocked = Config.get([:activitypub, :unfollow_blocked], true)
1461 if unfollowing_blocked && following?(blocked, blocker), do: unfollow(blocked, blocker)
1463 {:ok, blocker} = update_follower_count(blocker)
1464 {:ok, blocker, _} = Participation.mark_all_as_read(blocker, blocked)
1465 add_to_block(blocker, blocked)
1468 # helper to handle the block given only an actor's AP id
1469 def block(%User{} = blocker, %{ap_id: ap_id}) do
1470 block(blocker, get_cached_by_ap_id(ap_id))
1473 def unblock(%User{} = blocker, %User{} = blocked) do
1474 remove_from_block(blocker, blocked)
1477 # helper to handle the block given only an actor's AP id
1478 def unblock(%User{} = blocker, %{ap_id: ap_id}) do
1479 unblock(blocker, get_cached_by_ap_id(ap_id))
1482 def mutes?(nil, _), do: false
1483 def mutes?(%User{} = user, %User{} = target), do: mutes_user?(user, target)
1485 def mutes_user?(%User{} = user, %User{} = target) do
1486 UserRelationship.mute_exists?(user, target)
1489 @spec muted_notifications?(User.t() | nil, User.t() | map()) :: boolean()
1490 def muted_notifications?(nil, _), do: false
1492 def muted_notifications?(%User{} = user, %User{} = target),
1493 do: UserRelationship.notification_mute_exists?(user, target)
1495 def blocks?(nil, _), do: false
1497 def blocks?(%User{} = user, %User{} = target) do
1498 blocks_user?(user, target) ||
1499 (blocks_domain?(user, target) and not User.following?(user, target))
1502 def blocks_user?(%User{} = user, %User{} = target) do
1503 UserRelationship.block_exists?(user, target)
1506 def blocks_user?(_, _), do: false
1508 def blocks_domain?(%User{} = user, %User{} = target) do
1509 domain_blocks = Pleroma.Web.ActivityPub.MRF.subdomains_regex(user.domain_blocks)
1510 %{host: host} = URI.parse(target.ap_id)
1511 Pleroma.Web.ActivityPub.MRF.subdomain_match?(domain_blocks, host)
1514 def blocks_domain?(_, _), do: false
1516 def subscribed_to?(%User{} = user, %User{} = target) do
1517 # Note: the relationship is inverse: subscriber acts as relationship target
1518 UserRelationship.inverse_subscription_exists?(target, user)
1521 def subscribed_to?(%User{} = user, %{ap_id: ap_id}) do
1522 with %User{} = target <- get_cached_by_ap_id(ap_id) do
1523 subscribed_to?(user, target)
1528 Returns map of outgoing (blocked, muted etc.) relationships' user AP IDs by relation type.
1529 E.g. `outgoing_relationships_ap_ids(user, [:block])` -> `%{block: ["https://some.site/users/userapid"]}`
1531 @spec outgoing_relationships_ap_ids(User.t(), list(atom())) :: %{atom() => list(String.t())}
1532 def outgoing_relationships_ap_ids(_user, []), do: %{}
1534 def outgoing_relationships_ap_ids(nil, _relationship_types), do: %{}
1536 def outgoing_relationships_ap_ids(%User{} = user, relationship_types)
1537 when is_list(relationship_types) do
1540 |> assoc(:outgoing_relationships)
1541 |> join(:inner, [user_rel], u in assoc(user_rel, :target))
1542 |> where([user_rel, u], user_rel.relationship_type in ^relationship_types)
1543 |> select([user_rel, u], [user_rel.relationship_type, fragment("array_agg(?)", u.ap_id)])
1544 |> group_by([user_rel, u], user_rel.relationship_type)
1546 |> Enum.into(%{}, fn [k, v] -> {k, v} end)
1551 fn rel_type -> {rel_type, db_result[rel_type] || []} end
1555 def incoming_relationships_ungrouped_ap_ids(user, relationship_types, ap_ids \\ nil)
1557 def incoming_relationships_ungrouped_ap_ids(_user, [], _ap_ids), do: []
1559 def incoming_relationships_ungrouped_ap_ids(nil, _relationship_types, _ap_ids), do: []
1561 def incoming_relationships_ungrouped_ap_ids(%User{} = user, relationship_types, ap_ids)
1562 when is_list(relationship_types) do
1564 |> assoc(:incoming_relationships)
1565 |> join(:inner, [user_rel], u in assoc(user_rel, :source))
1566 |> where([user_rel, u], user_rel.relationship_type in ^relationship_types)
1567 |> maybe_filter_on_ap_id(ap_ids)
1568 |> select([user_rel, u], u.ap_id)
1573 defp maybe_filter_on_ap_id(query, ap_ids) when is_list(ap_ids) do
1574 where(query, [user_rel, u], u.ap_id in ^ap_ids)
1577 defp maybe_filter_on_ap_id(query, _ap_ids), do: query
1579 def set_activation_async(user, status \\ true) do
1580 BackgroundWorker.enqueue("user_activation", %{"user_id" => user.id, "status" => status})
1583 @spec set_activation([User.t()], boolean()) :: {:ok, User.t()} | {:error, Changeset.t()}
1584 def set_activation(users, status) when is_list(users) do
1585 Repo.transaction(fn ->
1586 for user <- users, do: set_activation(user, status)
1590 @spec set_activation(User.t(), boolean()) :: {:ok, User.t()} | {:error, Changeset.t()}
1591 def set_activation(%User{} = user, status) do
1592 with {:ok, user} <- set_activation_status(user, status) do
1595 |> Enum.filter(& &1.local)
1596 |> Enum.each(&set_cache(update_following_count(&1)))
1598 # Only update local user counts, remote will be update during the next pull.
1601 |> Enum.filter(& &1.local)
1602 |> Enum.each(&do_unfollow(user, &1))
1608 def approve(users) when is_list(users) do
1609 Repo.transaction(fn ->
1610 Enum.map(users, fn user ->
1611 with {:ok, user} <- approve(user), do: user
1616 def approve(%User{is_approved: false} = user) do
1617 with chg <- change(user, is_approved: true),
1618 {:ok, user} <- update_and_set_cache(chg) do
1619 post_register_action(user)
1624 def approve(%User{} = user), do: {:ok, user}
1626 def confirm(users) when is_list(users) do
1627 Repo.transaction(fn ->
1628 Enum.map(users, fn user ->
1629 with {:ok, user} <- confirm(user), do: user
1634 def confirm(%User{is_confirmed: false} = user) do
1635 with chg <- confirmation_changeset(user, set_confirmation: true),
1636 {:ok, user} <- update_and_set_cache(chg) do
1637 post_register_action(user)
1642 def confirm(%User{} = user), do: {:ok, user}
1644 def set_suggestion(users, is_suggested) when is_list(users) do
1645 Repo.transaction(fn ->
1646 Enum.map(users, fn user ->
1647 with {:ok, user} <- set_suggestion(user, is_suggested), do: user
1652 def set_suggestion(%User{is_suggested: is_suggested} = user, is_suggested), do: {:ok, user}
1654 def set_suggestion(%User{} = user, is_suggested) when is_boolean(is_suggested) do
1656 |> change(is_suggested: is_suggested)
1657 |> update_and_set_cache()
1660 def update_notification_settings(%User{} = user, settings) do
1662 |> cast(%{notification_settings: settings}, [])
1663 |> cast_embed(:notification_settings)
1664 |> validate_required([:notification_settings])
1665 |> update_and_set_cache()
1668 @spec purge_user_changeset(User.t()) :: Changeset.t()
1669 def purge_user_changeset(user) do
1670 # "Right to be forgotten"
1671 # https://gdpr.eu/right-to-be-forgotten/
1680 last_refreshed_at: nil,
1681 last_digest_emailed_at: nil,
1688 password_reset_pending: false,
1689 registration_reason: nil,
1690 confirmation_token: nil,
1694 is_moderator: false,
1696 mastofe_settings: nil,
1699 pleroma_settings_store: %{},
1702 is_discoverable: false,
1706 # nickname: preserved
1710 # Purge doesn't delete the user from the database.
1711 # It just nulls all its fields and deactivates it.
1712 # See `User.purge_user_changeset/1` above.
1713 defp purge(%User{} = user) do
1715 |> purge_user_changeset()
1716 |> update_and_set_cache()
1719 def delete(users) when is_list(users) do
1720 for user <- users, do: delete(user)
1723 def delete(%User{} = user) do
1724 # Purge the user immediately
1726 BackgroundWorker.enqueue("delete_user", %{"user_id" => user.id})
1729 # *Actually* delete the user from the DB
1730 defp delete_from_db(%User{} = user) do
1731 invalidate_cache(user)
1735 # If the user never finalized their account, it's safe to delete them.
1736 defp maybe_delete_from_db(%User{local: true, is_confirmed: false} = user),
1737 do: delete_from_db(user)
1739 defp maybe_delete_from_db(%User{local: true, is_approved: false} = user),
1740 do: delete_from_db(user)
1742 defp maybe_delete_from_db(user), do: {:ok, user}
1744 def perform(:force_password_reset, user), do: force_password_reset(user)
1746 @spec perform(atom(), User.t()) :: {:ok, User.t()}
1747 def perform(:delete, %User{} = user) do
1748 # Purge the user again, in case perform/2 is called directly
1751 # Remove all relationships
1754 |> Enum.each(fn follower ->
1755 ActivityPub.unfollow(follower, user)
1756 unfollow(follower, user)
1761 |> Enum.each(fn followed ->
1762 ActivityPub.unfollow(user, followed)
1763 unfollow(user, followed)
1766 delete_user_activities(user)
1767 delete_notifications_from_user_activities(user)
1768 delete_outgoing_pending_follow_requests(user)
1770 maybe_delete_from_db(user)
1773 def perform(:set_activation_async, user, status), do: set_activation(user, status)
1775 @spec external_users_query() :: Ecto.Query.t()
1776 def external_users_query do
1784 @spec external_users(keyword()) :: [User.t()]
1785 def external_users(opts \\ []) do
1787 external_users_query()
1788 |> select([u], struct(u, [:id, :ap_id]))
1792 do: where(query, [u], u.id > ^opts[:max_id]),
1797 do: limit(query, ^opts[:limit]),
1803 def delete_notifications_from_user_activities(%User{ap_id: ap_id}) do
1805 |> join(:inner, [n], activity in assoc(n, :activity))
1806 |> where([n, a], fragment("? = ?", a.actor, ^ap_id))
1807 |> Repo.delete_all()
1810 def delete_user_activities(%User{ap_id: ap_id} = user) do
1812 |> Activity.Queries.by_actor()
1813 |> Repo.chunk_stream(50, :batches)
1814 |> Stream.each(fn activities ->
1815 Enum.each(activities, fn activity -> delete_activity(activity, user) end)
1820 defp delete_activity(%{data: %{"type" => "Create", "object" => object}} = activity, user) do
1821 with {_, %Object{}} <- {:find_object, Object.get_by_ap_id(object)},
1822 {:ok, delete_data, _} <- Builder.delete(user, object) do
1823 Pipeline.common_pipeline(delete_data, local: user.local)
1825 {:find_object, nil} ->
1826 # We have the create activity, but not the object, it was probably pruned.
1827 # Insert a tombstone and try again
1828 with {:ok, tombstone_data, _} <- Builder.tombstone(user.ap_id, object),
1829 {:ok, _tombstone} <- Object.create(tombstone_data) do
1830 delete_activity(activity, user)
1834 Logger.error("Could not delete #{object} created by #{activity.data["ap_id"]}")
1835 Logger.error("Error: #{inspect(e)}")
1839 defp delete_activity(%{data: %{"type" => type}} = activity, user)
1840 when type in ["Like", "Announce"] do
1841 {:ok, undo, _} = Builder.undo(user, activity)
1842 Pipeline.common_pipeline(undo, local: user.local)
1845 defp delete_activity(_activity, _user), do: "Doing nothing"
1847 defp delete_outgoing_pending_follow_requests(user) do
1849 |> FollowingRelationship.outgoing_pending_follow_requests_query()
1850 |> Repo.delete_all()
1853 def html_filter_policy(%User{no_rich_text: true}) do
1854 Pleroma.HTML.Scrubber.TwitterText
1857 def html_filter_policy(_), do: Config.get([:markup, :scrub_policy])
1859 def fetch_by_ap_id(ap_id), do: ActivityPub.make_user_from_ap_id(ap_id)
1861 def get_or_fetch_by_ap_id(ap_id) do
1862 cached_user = get_cached_by_ap_id(ap_id)
1864 maybe_fetched_user = needs_update?(cached_user) && fetch_by_ap_id(ap_id)
1866 case {cached_user, maybe_fetched_user} do
1867 {_, {:ok, %User{} = user}} ->
1870 {%User{} = user, _} ->
1874 {:error, :not_found}
1879 Creates an internal service actor by URI if missing.
1880 Optionally takes nickname for addressing.
1882 @spec get_or_create_service_actor_by_ap_id(String.t(), String.t()) :: User.t() | nil
1883 def get_or_create_service_actor_by_ap_id(uri, nickname) do
1885 case get_cached_by_ap_id(uri) do
1887 with {:error, %{errors: errors}} <- create_service_actor(uri, nickname) do
1888 Logger.error("Cannot create service actor: #{uri}/.\n#{inspect(errors)}")
1892 %User{invisible: false} = user ->
1902 @spec set_invisible(User.t()) :: {:ok, User.t()}
1903 defp set_invisible(user) do
1905 |> change(%{invisible: true})
1906 |> update_and_set_cache()
1909 @spec create_service_actor(String.t(), String.t()) ::
1910 {:ok, User.t()} | {:error, Ecto.Changeset.t()}
1911 defp create_service_actor(uri, nickname) do
1917 follower_address: uri <> "/followers"
1920 |> unique_constraint(:nickname)
1925 def public_key(%{public_key: public_key_pem}) when is_binary(public_key_pem) do
1928 |> :public_key.pem_decode()
1930 |> :public_key.pem_entry_decode()
1935 def public_key(_), do: {:error, "key not found"}
1937 def get_public_key_for_ap_id(ap_id) do
1938 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id),
1939 {:ok, public_key} <- public_key(user) do
1946 def ap_enabled?(%User{local: true}), do: true
1947 def ap_enabled?(%User{ap_enabled: ap_enabled}), do: ap_enabled
1948 def ap_enabled?(_), do: false
1950 @doc "Gets or fetch a user by uri or nickname."
1951 @spec get_or_fetch(String.t()) :: {:ok, User.t()} | {:error, String.t()}
1952 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1953 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1955 # wait a period of time and return newest version of the User structs
1956 # this is because we have synchronous follow APIs and need to simulate them
1957 # with an async handshake
1958 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1959 with %User{} = a <- get_cached_by_id(a.id),
1960 %User{} = b <- get_cached_by_id(b.id) do
1967 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1968 with :ok <- :timer.sleep(timeout),
1969 %User{} = a <- get_cached_by_id(a.id),
1970 %User{} = b <- get_cached_by_id(b.id) do
1977 def parse_bio(bio) when is_binary(bio) and bio != "" do
1979 |> CommonUtils.format_input("text/plain", mentions_format: :full)
1983 def parse_bio(_), do: ""
1985 def parse_bio(bio, user) when is_binary(bio) and bio != "" do
1986 # TODO: get profile URLs other than user.ap_id
1987 profile_urls = [user.ap_id]
1990 |> CommonUtils.format_input("text/plain",
1991 mentions_format: :full,
1992 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1997 def parse_bio(_, _), do: ""
1999 def tag(user_identifiers, tags) when is_list(user_identifiers) do
2000 Repo.transaction(fn ->
2001 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
2005 def tag(nickname, tags) when is_binary(nickname),
2006 do: tag(get_by_nickname(nickname), tags)
2008 def tag(%User{} = user, tags),
2009 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
2011 def untag(user_identifiers, tags) when is_list(user_identifiers) do
2012 Repo.transaction(fn ->
2013 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
2017 def untag(nickname, tags) when is_binary(nickname),
2018 do: untag(get_by_nickname(nickname), tags)
2020 def untag(%User{} = user, tags),
2021 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
2023 defp update_tags(%User{} = user, new_tags) do
2024 {:ok, updated_user} =
2026 |> change(%{tags: new_tags})
2027 |> update_and_set_cache()
2032 defp normalize_tags(tags) do
2035 |> Enum.map(&String.downcase/1)
2038 defp local_nickname_regex do
2039 if Config.get([:instance, :extended_nickname_format]) do
2040 @extended_local_nickname_regex
2042 @strict_local_nickname_regex
2046 def local_nickname(nickname_or_mention) do
2049 |> String.split("@")
2053 def full_nickname(%User{} = user) do
2054 if String.contains?(user.nickname, "@") do
2057 %{host: host} = URI.parse(user.ap_id)
2058 user.nickname <> "@" <> host
2062 def full_nickname(nickname_or_mention),
2063 do: String.trim_leading(nickname_or_mention, "@")
2065 def error_user(ap_id) do
2069 nickname: "erroruser@example.com",
2070 inserted_at: NaiveDateTime.utc_now()
2074 @spec all_superusers() :: [User.t()]
2075 def all_superusers do
2076 User.Query.build(%{super_users: true, local: true, is_active: true})
2080 def muting_reblogs?(%User{} = user, %User{} = target) do
2081 UserRelationship.reblog_mute_exists?(user, target)
2084 def showing_reblogs?(%User{} = user, %User{} = target) do
2085 not muting_reblogs?(user, target)
2089 The function returns a query to get users with no activity for given interval of days.
2090 Inactive users are those who didn't read any notification, or had any activity where
2091 the user is the activity's actor, during `inactivity_threshold` days.
2092 Deactivated users will not appear in this list.
2096 iex> Pleroma.User.list_inactive_users()
2099 @spec list_inactive_users_query(integer()) :: Ecto.Query.t()
2100 def list_inactive_users_query(inactivity_threshold \\ 7) do
2101 negative_inactivity_threshold = -inactivity_threshold
2102 now = NaiveDateTime.truncate(NaiveDateTime.utc_now(), :second)
2103 # Subqueries are not supported in `where` clauses, join gets too complicated.
2104 has_read_notifications =
2105 from(n in Pleroma.Notification,
2106 where: n.seen == true,
2108 having: max(n.updated_at) > datetime_add(^now, ^negative_inactivity_threshold, "day"),
2111 |> Pleroma.Repo.all()
2113 from(u in Pleroma.User,
2114 left_join: a in Pleroma.Activity,
2115 on: u.ap_id == a.actor,
2116 where: not is_nil(u.nickname),
2117 where: u.is_active == ^true,
2118 where: u.id not in ^has_read_notifications,
2121 max(a.inserted_at) < datetime_add(^now, ^negative_inactivity_threshold, "day") or
2122 is_nil(max(a.inserted_at))
2127 Enable or disable email notifications for user
2131 iex> Pleroma.User.switch_email_notifications(Pleroma.User{email_notifications: %{"digest" => false}}, "digest", true)
2132 Pleroma.User{email_notifications: %{"digest" => true}}
2134 iex> Pleroma.User.switch_email_notifications(Pleroma.User{email_notifications: %{"digest" => true}}, "digest", false)
2135 Pleroma.User{email_notifications: %{"digest" => false}}
2137 @spec switch_email_notifications(t(), String.t(), boolean()) ::
2138 {:ok, t()} | {:error, Ecto.Changeset.t()}
2139 def switch_email_notifications(user, type, status) do
2140 User.update_email_notifications(user, %{type => status})
2144 Set `last_digest_emailed_at` value for the user to current time
2146 @spec touch_last_digest_emailed_at(t()) :: t()
2147 def touch_last_digest_emailed_at(user) do
2148 now = NaiveDateTime.truncate(NaiveDateTime.utc_now(), :second)
2150 {:ok, updated_user} =
2152 |> change(%{last_digest_emailed_at: now})
2153 |> update_and_set_cache()
2158 @spec set_confirmation(User.t(), boolean()) :: {:ok, User.t()} | {:error, Changeset.t()}
2159 def set_confirmation(%User{} = user, bool) do
2161 |> confirmation_changeset(set_confirmation: bool)
2162 |> update_and_set_cache()
2165 def get_mascot(%{mascot: %{} = mascot}) when not is_nil(mascot) do
2169 def get_mascot(%{mascot: mascot}) when is_nil(mascot) do
2170 # use instance-default
2171 config = Config.get([:assets, :mascots])
2172 default_mascot = Config.get([:assets, :default_mascot])
2173 mascot = Keyword.get(config, default_mascot)
2176 "id" => "default-mascot",
2177 "url" => mascot[:url],
2178 "preview_url" => mascot[:url],
2180 "mime_type" => mascot[:mime_type]
2185 def ensure_keys_present(%{keys: keys} = user) when not is_nil(keys), do: {:ok, user}
2187 def ensure_keys_present(%User{} = user) do
2188 with {:ok, pem} <- Keys.generate_rsa_pem() do
2190 |> cast(%{keys: pem}, [:keys])
2191 |> validate_required([:keys])
2192 |> update_and_set_cache()
2196 def get_ap_ids_by_nicknames(nicknames) do
2198 where: u.nickname in ^nicknames,
2204 defp put_password_hash(
2205 %Ecto.Changeset{valid?: true, changes: %{password: password}} = changeset
2207 change(changeset, password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt(password))
2210 defp put_password_hash(changeset), do: changeset
2212 def is_internal_user?(%User{nickname: nil}), do: true
2213 def is_internal_user?(%User{local: true, nickname: "internal." <> _}), do: true
2214 def is_internal_user?(_), do: false
2216 # A hack because user delete activities have a fake id for whatever reason
2217 # TODO: Get rid of this
2218 def get_delivered_users_by_object_id("pleroma:fake_object_id"), do: []
2220 def get_delivered_users_by_object_id(object_id) do
2222 inner_join: delivery in assoc(u, :deliveries),
2223 where: delivery.object_id == ^object_id
2228 def change_email(user, email) do
2230 |> cast(%{email: email}, [:email])
2231 |> maybe_validate_required_email(false)
2232 |> unique_constraint(:email)
2233 |> validate_format(:email, @email_regex)
2234 |> update_and_set_cache()
2237 def alias_users(user) do
2239 |> Enum.map(&User.get_cached_by_ap_id/1)
2240 |> Enum.filter(fn user -> user != nil end)
2243 def add_alias(user, new_alias_user) do
2244 current_aliases = user.also_known_as || []
2245 new_alias_ap_id = new_alias_user.ap_id
2247 if new_alias_ap_id in current_aliases do
2251 |> cast(%{also_known_as: current_aliases ++ [new_alias_ap_id]}, [:also_known_as])
2252 |> update_and_set_cache()
2256 def delete_alias(user, alias_user) do
2257 current_aliases = user.also_known_as || []
2258 alias_ap_id = alias_user.ap_id
2260 if alias_ap_id in current_aliases do
2262 |> cast(%{also_known_as: current_aliases -- [alias_ap_id]}, [:also_known_as])
2263 |> update_and_set_cache()
2265 {:error, :no_such_alias}
2269 # Internal function; public one is `deactivate/2`
2270 defp set_activation_status(user, status) do
2272 |> cast(%{is_active: status}, [:is_active])
2273 |> update_and_set_cache()
2276 def update_banner(user, banner) do
2278 |> cast(%{banner: banner}, [:banner])
2279 |> update_and_set_cache()
2282 def update_background(user, background) do
2284 |> cast(%{background: background}, [:background])
2285 |> update_and_set_cache()
2288 def validate_fields(changeset, remote? \\ false) do
2289 limit_name = if remote?, do: :max_remote_account_fields, else: :max_account_fields
2290 limit = Config.get([:instance, limit_name], 0)
2293 |> validate_length(:fields, max: limit)
2294 |> validate_change(:fields, fn :fields, fields ->
2295 if Enum.all?(fields, &valid_field?/1) do
2303 defp valid_field?(%{"name" => name, "value" => value}) do
2304 name_limit = Config.get([:instance, :account_field_name_length], 255)
2305 value_limit = Config.get([:instance, :account_field_value_length], 255)
2307 is_binary(name) && is_binary(value) && String.length(name) <= name_limit &&
2308 String.length(value) <= value_limit
2311 defp valid_field?(_), do: false
2313 defp truncate_field(%{"name" => name, "value" => value}) do
2315 String.split_at(name, Config.get([:instance, :account_field_name_length], 255))
2318 String.split_at(value, Config.get([:instance, :account_field_value_length], 255))
2320 %{"name" => name, "value" => value}
2323 def admin_api_update(user, params) do
2330 |> update_and_set_cache()
2333 @doc "Signs user out of all applications"
2334 def global_sign_out(user) do
2335 OAuth.Authorization.delete_user_authorizations(user)
2336 OAuth.Token.delete_user_tokens(user)
2339 def mascot_update(user, url) do
2341 |> cast(%{mascot: url}, [:mascot])
2342 |> validate_required([:mascot])
2343 |> update_and_set_cache()
2346 def mastodon_settings_update(user, settings) do
2348 |> cast(%{mastofe_settings: settings}, [:mastofe_settings])
2349 |> validate_required([:mastofe_settings])
2350 |> update_and_set_cache()
2353 @spec confirmation_changeset(User.t(), keyword()) :: Changeset.t()
2354 def confirmation_changeset(user, set_confirmation: confirmed?) do
2359 confirmation_token: nil
2363 is_confirmed: false,
2364 confirmation_token: :crypto.strong_rand_bytes(32) |> Base.url_encode64()
2368 cast(user, params, [:is_confirmed, :confirmation_token])
2371 @spec approval_changeset(User.t(), keyword()) :: Changeset.t()
2372 def approval_changeset(user, set_approval: approved?) do
2373 cast(user, %{is_approved: approved?}, [:is_approved])
2376 @spec add_pinned_object_id(User.t(), String.t()) :: {:ok, User.t()} | {:error, term()}
2377 def add_pinned_object_id(%User{} = user, object_id) do
2378 if !user.pinned_objects[object_id] do
2379 params = %{pinned_objects: Map.put(user.pinned_objects, object_id, NaiveDateTime.utc_now())}
2382 |> cast(params, [:pinned_objects])
2383 |> validate_change(:pinned_objects, fn :pinned_objects, pinned_objects ->
2384 max_pinned_statuses = Config.get([:instance, :max_pinned_statuses], 0)
2386 if Enum.count(pinned_objects) <= max_pinned_statuses do
2389 [pinned_objects: "You have already pinned the maximum number of statuses"]
2395 |> update_and_set_cache()
2398 @spec remove_pinned_object_id(User.t(), String.t()) :: {:ok, t()} | {:error, term()}
2399 def remove_pinned_object_id(%User{} = user, object_id) do
2402 %{pinned_objects: Map.delete(user.pinned_objects, object_id)},
2405 |> update_and_set_cache()
2408 def update_email_notifications(user, settings) do
2409 email_notifications =
2410 user.email_notifications
2411 |> Map.merge(settings)
2412 |> Map.take(["digest"])
2414 params = %{email_notifications: email_notifications}
2415 fields = [:email_notifications]
2418 |> cast(params, fields)
2419 |> validate_required(fields)
2420 |> update_and_set_cache()
2423 defp set_domain_blocks(user, domain_blocks) do
2424 params = %{domain_blocks: domain_blocks}
2427 |> cast(params, [:domain_blocks])
2428 |> validate_required([:domain_blocks])
2429 |> update_and_set_cache()
2432 def block_domain(user, domain_blocked) do
2433 set_domain_blocks(user, Enum.uniq([domain_blocked | user.domain_blocks]))
2436 def unblock_domain(user, domain_blocked) do
2437 set_domain_blocks(user, List.delete(user.domain_blocks, domain_blocked))
2440 @spec add_to_block(User.t(), User.t()) ::
2441 {:ok, UserRelationship.t()} | {:error, Ecto.Changeset.t()}
2442 defp add_to_block(%User{} = user, %User{} = blocked) do
2443 with {:ok, relationship} <- UserRelationship.create_block(user, blocked) do
2444 @cachex.del(:user_cache, "blocked_users_ap_ids:#{user.ap_id}")
2449 @spec add_to_block(User.t(), User.t()) ::
2450 {:ok, UserRelationship.t()} | {:ok, nil} | {:error, Ecto.Changeset.t()}
2451 defp remove_from_block(%User{} = user, %User{} = blocked) do
2452 with {:ok, relationship} <- UserRelationship.delete_block(user, blocked) do
2453 @cachex.del(:user_cache, "blocked_users_ap_ids:#{user.ap_id}")
2458 def set_invisible(user, invisible) do
2459 params = %{invisible: invisible}
2462 |> cast(params, [:invisible])
2463 |> validate_required([:invisible])
2464 |> update_and_set_cache()
2467 def sanitize_html(%User{} = user) do
2468 sanitize_html(user, nil)
2471 # User data that mastodon isn't filtering (treated as plaintext):
2474 def sanitize_html(%User{} = user, filter) do
2476 Enum.map(user.fields, fn %{"name" => name, "value" => value} ->
2479 "value" => HTML.filter_tags(value, Pleroma.HTML.Scrubber.LinksOnly)
2484 |> Map.put(:bio, HTML.filter_tags(user.bio, filter))
2485 |> Map.put(:fields, fields)
2488 def get_host(%User{ap_id: ap_id} = _user) do
2489 URI.parse(ap_id).host
2492 def update_last_active_at(%__MODULE__{local: true} = user) do
2494 |> cast(%{last_active_at: NaiveDateTime.utc_now()}, [:last_active_at])
2495 |> update_and_set_cache()
2498 def active_user_count(days \\ 30) do
2499 active_after = Timex.shift(NaiveDateTime.utc_now(), days: -days)
2502 |> where([u], u.last_active_at >= ^active_after)
2503 |> where([u], u.local == true)
2504 |> Repo.aggregate(:count)
2507 def update_last_status_at(user) do
2509 |> where(id: ^user.id)
2510 |> update([u], set: [last_status_at: fragment("NOW()")])
2512 |> Repo.update_all([])
2514 {1, [user]} -> set_cache(user)