1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 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
31 alias Pleroma.Web.ActivityPub.ActivityPub
32 alias Pleroma.Web.ActivityPub.Builder
33 alias Pleroma.Web.ActivityPub.Pipeline
34 alias Pleroma.Web.ActivityPub.Utils
35 alias Pleroma.Web.CommonAPI
36 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
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])?)*$/
54 @url_regex ~r/^https?:\/\/[^\s]{1,256}$/
56 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
57 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
59 # AP ID user relationships (blocks, mutes etc.)
60 # Format: [rel_type: [outgoing_rel: :outgoing_rel_target, incoming_rel: :incoming_rel_source]]
61 @user_relationships_config [
63 blocker_blocks: :blocked_users,
64 blockee_blocks: :blocker_users
67 muter_mutes: :muted_users,
68 mutee_mutes: :muter_users
71 reblog_muter_mutes: :reblog_muted_users,
72 reblog_mutee_mutes: :reblog_muter_users
75 notification_muter_mutes: :notification_muted_users,
76 notification_mutee_mutes: :notification_muter_users
78 # Note: `inverse_subscription` relationship is inverse: subscriber acts as relationship target
79 inverse_subscription: [
80 subscribee_subscriptions: :subscriber_users,
81 subscriber_subscriptions: :subscribee_users
86 field(:bio, :string, default: "")
87 field(:raw_bio, :string)
88 field(:email, :string)
90 field(:nickname, :string)
91 field(:password_hash, :string)
92 field(:password, :string, virtual: true)
93 field(:password_confirmation, :string, virtual: true)
95 field(:public_key, :string)
96 field(:ap_id, :string)
97 field(:avatar, :map, default: %{})
98 field(:local, :boolean, default: true)
99 field(:follower_address, :string)
100 field(:following_address, :string)
101 field(:search_rank, :float, virtual: true)
102 field(:search_type, :integer, virtual: true)
103 field(:tags, {:array, :string}, default: [])
104 field(:last_refreshed_at, :naive_datetime_usec)
105 field(:last_digest_emailed_at, :naive_datetime)
106 field(:banner, :map, default: %{})
107 field(:background, :map, default: %{})
108 field(:note_count, :integer, default: 0)
109 field(:follower_count, :integer, default: 0)
110 field(:following_count, :integer, default: 0)
111 field(:locked, :boolean, default: false)
112 field(:confirmation_pending, :boolean, default: false)
113 field(:password_reset_pending, :boolean, default: false)
114 field(:approval_pending, :boolean, default: false)
115 field(:registration_reason, :string, default: nil)
116 field(:confirmation_token, :string, default: nil)
117 field(:default_scope, :string, default: "public")
118 field(:domain_blocks, {:array, :string}, default: [])
119 field(:deactivated, :boolean, default: false)
120 field(:no_rich_text, :boolean, default: false)
121 field(:ap_enabled, :boolean, default: false)
122 field(:is_moderator, :boolean, default: false)
123 field(:is_admin, :boolean, default: false)
124 field(:show_role, :boolean, default: true)
125 field(:mastofe_settings, :map, default: nil)
126 field(:uri, ObjectValidators.Uri, default: nil)
127 field(:hide_followers_count, :boolean, default: false)
128 field(:hide_follows_count, :boolean, default: false)
129 field(:hide_followers, :boolean, default: false)
130 field(:hide_follows, :boolean, default: false)
131 field(:hide_favorites, :boolean, default: true)
132 field(:unread_conversation_count, :integer, default: 0)
133 field(:pinned_activities, {:array, :string}, default: [])
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(: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, :string}, default: [])
146 field(:inbox, :string)
147 field(:shared_inbox, :string)
148 field(:accepts_chat_messages, :boolean, default: nil)
151 :notification_settings,
152 Pleroma.User.NotificationSetting,
156 has_many(:notifications, Notification)
157 has_many(:registrations, Registration)
158 has_many(:deliveries, Delivery)
160 has_many(:outgoing_relationships, UserRelationship, foreign_key: :source_id)
161 has_many(:incoming_relationships, UserRelationship, foreign_key: :target_id)
163 for {relationship_type,
165 {outgoing_relation, outgoing_relation_target},
166 {incoming_relation, incoming_relation_source}
167 ]} <- @user_relationships_config do
168 # Definitions of `has_many` relations: :blocker_blocks, :muter_mutes, :reblog_muter_mutes,
169 # :notification_muter_mutes, :subscribee_subscriptions
170 has_many(outgoing_relation, UserRelationship,
171 foreign_key: :source_id,
172 where: [relationship_type: relationship_type]
175 # Definitions of `has_many` relations: :blockee_blocks, :mutee_mutes, :reblog_mutee_mutes,
176 # :notification_mutee_mutes, :subscriber_subscriptions
177 has_many(incoming_relation, UserRelationship,
178 foreign_key: :target_id,
179 where: [relationship_type: relationship_type]
182 # Definitions of `has_many` relations: :blocked_users, :muted_users, :reblog_muted_users,
183 # :notification_muted_users, :subscriber_users
184 has_many(outgoing_relation_target, through: [outgoing_relation, :target])
186 # Definitions of `has_many` relations: :blocker_users, :muter_users, :reblog_muter_users,
187 # :notification_muter_users, :subscribee_users
188 has_many(incoming_relation_source, through: [incoming_relation, :source])
191 # `:blocks` is deprecated (replaced with `blocked_users` relation)
192 field(:blocks, {:array, :string}, default: [])
193 # `:mutes` is deprecated (replaced with `muted_users` relation)
194 field(:mutes, {:array, :string}, default: [])
195 # `:muted_reblogs` is deprecated (replaced with `reblog_muted_users` relation)
196 field(:muted_reblogs, {:array, :string}, default: [])
197 # `:muted_notifications` is deprecated (replaced with `notification_muted_users` relation)
198 field(:muted_notifications, {:array, :string}, default: [])
199 # `:subscribers` is deprecated (replaced with `subscriber_users` relation)
200 field(:subscribers, {:array, :string}, default: [])
203 :multi_factor_authentication_settings,
211 for {_relationship_type, [{_outgoing_relation, outgoing_relation_target}, _]} <-
212 @user_relationships_config do
213 # `def blocked_users_relation/2`, `def muted_users_relation/2`,
214 # `def reblog_muted_users_relation/2`, `def notification_muted_users/2`,
215 # `def subscriber_users/2`
216 def unquote(:"#{outgoing_relation_target}_relation")(user, restrict_deactivated? \\ false) do
217 target_users_query = assoc(user, unquote(outgoing_relation_target))
219 if restrict_deactivated? do
220 restrict_deactivated(target_users_query)
226 # `def blocked_users/2`, `def muted_users/2`, `def reblog_muted_users/2`,
227 # `def notification_muted_users/2`, `def subscriber_users/2`
228 def unquote(outgoing_relation_target)(user, restrict_deactivated? \\ false) do
230 |> apply(unquote(:"#{outgoing_relation_target}_relation"), [
232 restrict_deactivated?
237 # `def blocked_users_ap_ids/2`, `def muted_users_ap_ids/2`, `def reblog_muted_users_ap_ids/2`,
238 # `def notification_muted_users_ap_ids/2`, `def subscriber_users_ap_ids/2`
239 def unquote(:"#{outgoing_relation_target}_ap_ids")(user, restrict_deactivated? \\ false) do
241 |> apply(unquote(:"#{outgoing_relation_target}_relation"), [
243 restrict_deactivated?
245 |> select([u], u.ap_id)
250 defdelegate following_count(user), to: FollowingRelationship
251 defdelegate following(user), to: FollowingRelationship
252 defdelegate following?(follower, followed), to: FollowingRelationship
253 defdelegate following_ap_ids(user), to: FollowingRelationship
254 defdelegate get_follow_requests(user), to: FollowingRelationship
255 defdelegate search(query, opts \\ []), to: User.Search
258 Dumps Flake Id to SQL-compatible format (16-byte UUID).
259 E.g. "9pQtDGXuq4p3VlcJEm" -> <<0, 0, 1, 110, 179, 218, 42, 92, 213, 41, 44, 227, 95, 213, 0, 0>>
261 def binary_id(source_id) when is_binary(source_id) do
262 with {:ok, dumped_id} <- FlakeId.Ecto.CompatType.dump(source_id) do
269 def binary_id(source_ids) when is_list(source_ids) do
270 Enum.map(source_ids, &binary_id/1)
273 def binary_id(%User{} = user), do: binary_id(user.id)
275 @doc "Returns status account"
276 @spec account_status(User.t()) :: account_status()
277 def account_status(%User{deactivated: true}), do: :deactivated
278 def account_status(%User{password_reset_pending: true}), do: :password_reset_pending
279 def account_status(%User{local: true, approval_pending: true}), do: :approval_pending
281 def account_status(%User{local: true, confirmation_pending: true}) do
282 if Config.get([:instance, :account_activation_required]) do
283 :confirmation_pending
289 def account_status(%User{}), do: :active
291 @spec visible_for(User.t(), User.t() | nil) ::
294 | :restricted_unauthenticated
296 | :confirmation_pending
297 def visible_for(user, for_user \\ nil)
299 def visible_for(%User{invisible: true}, _), do: :invisible
301 def visible_for(%User{id: user_id}, %User{id: user_id}), do: :visible
303 def visible_for(%User{} = user, nil) do
304 if restrict_unauthenticated?(user) do
305 :restrict_unauthenticated
307 visible_account_status(user)
311 def visible_for(%User{} = user, for_user) do
312 if superuser?(for_user) do
315 visible_account_status(user)
319 def visible_for(_, _), do: :invisible
321 defp restrict_unauthenticated?(%User{local: true}) do
322 Config.restrict_unauthenticated_access?(:profiles, :local)
325 defp restrict_unauthenticated?(%User{local: _}) do
326 Config.restrict_unauthenticated_access?(:profiles, :remote)
329 defp visible_account_status(user) do
330 status = account_status(user)
332 if status in [:active, :password_reset_pending] do
339 @spec superuser?(User.t()) :: boolean()
340 def superuser?(%User{local: true, is_admin: true}), do: true
341 def superuser?(%User{local: true, is_moderator: true}), do: true
342 def superuser?(_), do: false
344 @spec invisible?(User.t()) :: boolean()
345 def invisible?(%User{invisible: true}), do: true
346 def invisible?(_), do: false
348 def avatar_url(user, options \\ []) do
350 %{"url" => [%{"href" => href} | _]} ->
354 unless options[:no_default] do
355 Config.get([:assets, :default_user_avatar], "#{Web.base_url()}/images/avi.png")
360 def banner_url(user, options \\ []) do
362 %{"url" => [%{"href" => href} | _]} -> href
363 _ -> !options[:no_default] && "#{Web.base_url()}/images/banner.png"
367 # Should probably be renamed or removed
368 def ap_id(%User{nickname: nickname}), do: "#{Web.base_url()}/users/#{nickname}"
370 def ap_followers(%User{follower_address: fa}) when is_binary(fa), do: fa
371 def ap_followers(%User{} = user), do: "#{ap_id(user)}/followers"
373 @spec ap_following(User.t()) :: String.t()
374 def ap_following(%User{following_address: fa}) when is_binary(fa), do: fa
375 def ap_following(%User{} = user), do: "#{ap_id(user)}/following"
377 @spec restrict_deactivated(Ecto.Query.t()) :: Ecto.Query.t()
378 def restrict_deactivated(query) do
379 from(u in query, where: u.deactivated != ^true)
382 defp truncate_fields_param(params) do
383 if Map.has_key?(params, :fields) do
384 Map.put(params, :fields, Enum.map(params[:fields], &truncate_field/1))
390 defp truncate_if_exists(params, key, max_length) do
391 if Map.has_key?(params, key) and is_binary(params[key]) do
392 {value, _chopped} = String.split_at(params[key], max_length)
393 Map.put(params, key, value)
399 defp fix_follower_address(%{follower_address: _, following_address: _} = params), do: params
401 defp fix_follower_address(%{nickname: nickname} = params),
402 do: Map.put(params, :follower_address, ap_followers(%User{nickname: nickname}))
404 defp fix_follower_address(params), do: params
406 def remote_user_changeset(struct \\ %User{local: false}, params) do
407 bio_limit = Config.get([:instance, :user_bio_length], 5000)
408 name_limit = Config.get([:instance, :user_name_length], 100)
411 case params[:name] do
412 name when is_binary(name) and byte_size(name) > 0 -> name
413 _ -> params[:nickname]
418 |> Map.put(:name, name)
419 |> Map.put_new(:last_refreshed_at, NaiveDateTime.utc_now())
420 |> truncate_if_exists(:name, name_limit)
421 |> truncate_if_exists(:bio, bio_limit)
422 |> truncate_fields_param()
423 |> fix_follower_address()
447 :hide_followers_count,
456 :accepts_chat_messages
459 |> validate_required([:name, :ap_id])
460 |> unique_constraint(:nickname)
461 |> validate_format(:nickname, @email_regex)
462 |> validate_length(:bio, max: bio_limit)
463 |> validate_length(:name, max: name_limit)
464 |> validate_fields(true)
467 def update_changeset(struct, params \\ %{}) do
468 bio_limit = Config.get([:instance, :user_bio_length], 5000)
469 name_limit = Config.get([:instance, :user_name_length], 100)
489 :hide_followers_count,
492 :allow_following_move,
496 :skip_thread_containment,
499 :pleroma_settings_store,
502 :accepts_chat_messages
505 |> unique_constraint(:nickname)
506 |> validate_format(:nickname, local_nickname_regex())
507 |> validate_also_known_as()
508 |> validate_length(:bio, max: bio_limit)
509 |> validate_length(:name, min: 1, max: name_limit)
510 |> validate_inclusion(:actor_type, ["Person", "Service"])
513 |> put_change_if_present(:bio, &{:ok, parse_bio(&1, struct)})
514 |> put_change_if_present(:avatar, &put_upload(&1, :avatar))
515 |> put_change_if_present(:banner, &put_upload(&1, :banner))
516 |> put_change_if_present(:background, &put_upload(&1, :background))
517 |> put_change_if_present(
518 :pleroma_settings_store,
519 &{:ok, Map.merge(struct.pleroma_settings_store, &1)}
521 |> validate_fields(false)
524 defp put_fields(changeset) do
525 if raw_fields = get_change(changeset, :raw_fields) do
528 |> Enum.filter(fn %{"name" => n} -> n != "" end)
532 |> Enum.map(fn f -> Map.update!(f, "value", &parse_fields(&1)) end)
535 |> put_change(:raw_fields, raw_fields)
536 |> put_change(:fields, fields)
542 defp parse_fields(value) do
544 |> Formatter.linkify(mentions_format: :full)
548 defp put_emoji(changeset) do
549 emojified_fields = [:bio, :name, :raw_fields]
551 if Enum.any?(changeset.changes, fn {k, _} -> k in emojified_fields end) do
552 bio = Emoji.Formatter.get_emoji_map(get_field(changeset, :bio))
553 name = Emoji.Formatter.get_emoji_map(get_field(changeset, :name))
555 emoji = Map.merge(bio, name)
559 |> get_field(:raw_fields)
560 |> Enum.reduce(emoji, fn x, acc ->
561 Map.merge(acc, Emoji.Formatter.get_emoji_map(x["name"] <> x["value"]))
564 put_change(changeset, :emoji, emoji)
570 defp put_change_if_present(changeset, map_field, value_function) do
571 with {:ok, value} <- fetch_change(changeset, map_field),
572 {:ok, new_value} <- value_function.(value) do
573 put_change(changeset, map_field, new_value)
579 defp put_upload(value, type) do
580 with %Plug.Upload{} <- value,
581 {:ok, object} <- ActivityPub.upload(value, type: type) do
586 def update_as_admin_changeset(struct, params) do
588 |> update_changeset(params)
589 |> cast(params, [:email])
590 |> delete_change(:also_known_as)
591 |> unique_constraint(:email)
592 |> validate_format(:email, @email_regex)
593 |> validate_inclusion(:actor_type, ["Person", "Service"])
596 @spec update_as_admin(User.t(), map()) :: {:ok, User.t()} | {:error, Changeset.t()}
597 def update_as_admin(user, params) do
598 params = Map.put(params, "password_confirmation", params["password"])
599 changeset = update_as_admin_changeset(user, params)
601 if params["password"] do
602 reset_password(user, changeset, params)
604 User.update_and_set_cache(changeset)
608 def password_update_changeset(struct, params) do
610 |> cast(params, [:password, :password_confirmation])
611 |> validate_required([:password, :password_confirmation])
612 |> validate_confirmation(:password)
613 |> put_password_hash()
614 |> put_change(:password_reset_pending, false)
617 @spec reset_password(User.t(), map()) :: {:ok, User.t()} | {:error, Changeset.t()}
618 def reset_password(%User{} = user, params) do
619 reset_password(user, user, params)
622 def reset_password(%User{id: user_id} = user, struct, params) do
625 |> Multi.update(:user, password_update_changeset(struct, params))
626 |> Multi.delete_all(:tokens, OAuth.Token.Query.get_by_user(user_id))
627 |> Multi.delete_all(:auth, OAuth.Authorization.delete_by_user_query(user))
629 case Repo.transaction(multi) do
630 {:ok, %{user: user} = _} -> set_cache(user)
631 {:error, _, changeset, _} -> {:error, changeset}
635 def update_password_reset_pending(user, value) do
638 |> put_change(:password_reset_pending, value)
639 |> update_and_set_cache()
642 def force_password_reset_async(user) do
643 BackgroundWorker.enqueue("force_password_reset", %{"user_id" => user.id})
646 @spec force_password_reset(User.t()) :: {:ok, User.t()} | {:error, Ecto.Changeset.t()}
647 def force_password_reset(user), do: update_password_reset_pending(user, true)
649 # Used to auto-register LDAP accounts which won't have a password hash stored locally
650 def register_changeset_ldap(struct, params = %{password: password})
651 when is_nil(password) do
652 params = Map.put_new(params, :accepts_chat_messages, true)
655 if Map.has_key?(params, :email) do
656 Map.put_new(params, :email, params[:email])
666 :accepts_chat_messages
668 |> validate_required([:name, :nickname])
669 |> unique_constraint(:nickname)
670 |> validate_exclusion(:nickname, Config.get([User, :restricted_nicknames]))
671 |> validate_format(:nickname, local_nickname_regex())
673 |> unique_constraint(:ap_id)
674 |> put_following_and_follower_address()
677 def register_changeset(struct, params \\ %{}, opts \\ []) do
678 bio_limit = Config.get([:instance, :user_bio_length], 5000)
679 name_limit = Config.get([:instance, :user_name_length], 100)
680 reason_limit = Config.get([:instance, :registration_reason_length], 500)
681 params = Map.put_new(params, :accepts_chat_messages, true)
684 if is_nil(opts[:need_confirmation]) do
685 Config.get([:instance, :account_activation_required])
687 opts[:need_confirmation]
691 if is_nil(opts[:need_approval]) do
692 Config.get([:instance, :account_approval_required])
698 |> confirmation_changeset(need_confirmation: need_confirmation?)
699 |> approval_changeset(need_approval: need_approval?)
707 :password_confirmation,
709 :accepts_chat_messages,
712 |> validate_required([:name, :nickname, :password, :password_confirmation])
713 |> validate_confirmation(:password)
714 |> unique_constraint(:email)
715 |> validate_format(:email, @email_regex)
716 |> validate_change(:email, fn :email, email ->
718 Config.get([User, :email_blacklist])
719 |> Enum.all?(fn blacklisted_domain ->
720 !String.ends_with?(email, ["@" <> blacklisted_domain, "." <> blacklisted_domain])
723 if valid?, do: [], else: [email: "Invalid email"]
725 |> unique_constraint(:nickname)
726 |> validate_exclusion(:nickname, Config.get([User, :restricted_nicknames]))
727 |> validate_format(:nickname, local_nickname_regex())
728 |> validate_length(:bio, max: bio_limit)
729 |> validate_length(:name, min: 1, max: name_limit)
730 |> validate_length(:registration_reason, max: reason_limit)
731 |> maybe_validate_required_email(opts[:external])
734 |> unique_constraint(:ap_id)
735 |> put_following_and_follower_address()
738 def maybe_validate_required_email(changeset, true), do: changeset
740 def maybe_validate_required_email(changeset, _) do
741 if Config.get([:instance, :account_activation_required]) do
742 validate_required(changeset, [:email])
748 defp put_ap_id(changeset) do
749 ap_id = ap_id(%User{nickname: get_field(changeset, :nickname)})
750 put_change(changeset, :ap_id, ap_id)
753 defp put_following_and_follower_address(changeset) do
754 followers = ap_followers(%User{nickname: get_field(changeset, :nickname)})
757 |> put_change(:follower_address, followers)
760 defp autofollow_users(user) do
761 candidates = Config.get([:instance, :autofollowed_nicknames])
764 User.Query.build(%{nickname: candidates, local: true, deactivated: false})
767 follow_all(user, autofollowed_users)
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{} = user) do
778 with {:ok, user} <- autofollow_users(user),
779 {:ok, user} <- set_cache(user),
780 {:ok, _} <- send_welcome_email(user),
781 {:ok, _} <- send_welcome_message(user),
782 {:ok, _} <- send_welcome_chat_message(user),
783 {:ok, _} <- try_send_confirmation_email(user) do
788 def send_welcome_message(user) do
789 if User.WelcomeMessage.enabled?() do
790 User.WelcomeMessage.post_message(user)
797 def send_welcome_chat_message(user) do
798 if User.WelcomeChatMessage.enabled?() do
799 User.WelcomeChatMessage.post_message(user)
806 def send_welcome_email(%User{email: email} = user) when is_binary(email) do
807 if User.WelcomeEmail.enabled?() do
808 User.WelcomeEmail.send_email(user)
815 def send_welcome_email(_), do: {:ok, :noop}
817 @spec try_send_confirmation_email(User.t()) :: {:ok, :enqueued | :noop}
818 def try_send_confirmation_email(%User{confirmation_pending: true, email: email} = user)
819 when is_binary(email) do
820 if Config.get([:instance, :account_activation_required]) do
821 send_confirmation_email(user)
828 def try_send_confirmation_email(_), do: {:ok, :noop}
830 @spec send_confirmation_email(Uset.t()) :: User.t()
831 def send_confirmation_email(%User{} = user) do
833 |> Pleroma.Emails.UserEmail.account_confirmation_email()
834 |> Pleroma.Emails.Mailer.deliver_async()
839 def needs_update?(%User{local: true}), do: false
841 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
843 def needs_update?(%User{local: false} = user) do
844 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
847 def needs_update?(_), do: true
849 @spec maybe_direct_follow(User.t(), User.t()) :: {:ok, User.t()} | {:error, String.t()}
851 # "Locked" (self-locked) users demand explicit authorization of follow requests
852 def maybe_direct_follow(%User{} = follower, %User{local: true, locked: true} = followed) do
853 follow(follower, followed, :follow_pending)
856 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
857 follow(follower, followed)
860 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
861 if not ap_enabled?(followed) do
862 follow(follower, followed)
868 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
869 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
870 def follow_all(follower, followeds) do
872 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
873 |> Enum.each(&follow(follower, &1, :follow_accept))
878 def follow(%User{} = follower, %User{} = followed, state \\ :follow_accept) do
879 deny_follow_blocked = Config.get([:user, :deny_follow_blocked])
882 followed.deactivated ->
883 {:error, "Could not follow user: #{followed.nickname} is deactivated."}
885 deny_follow_blocked and blocks?(followed, follower) ->
886 {:error, "Could not follow user: #{followed.nickname} blocked you."}
889 FollowingRelationship.follow(follower, followed, state)
891 {:ok, _} = update_follower_count(followed)
894 |> update_following_count()
898 def unfollow(%User{ap_id: ap_id}, %User{ap_id: ap_id}) do
899 {:error, "Not subscribed!"}
902 @spec unfollow(User.t(), User.t()) :: {:ok, User.t(), Activity.t()} | {:error, String.t()}
903 def unfollow(%User{} = follower, %User{} = followed) do
904 case do_unfollow(follower, followed) do
905 {:ok, follower, followed} ->
906 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
913 @spec do_unfollow(User.t(), User.t()) :: {:ok, User.t(), User.t()} | {:error, String.t()}
914 defp do_unfollow(%User{} = follower, %User{} = followed) do
915 case get_follow_state(follower, followed) do
916 state when state in [:follow_pending, :follow_accept] ->
917 FollowingRelationship.unfollow(follower, followed)
918 {:ok, followed} = update_follower_count(followed)
920 {:ok, follower} = update_following_count(follower)
922 {:ok, follower, followed}
925 {:error, "Not subscribed!"}
929 @doc "Returns follow state as Pleroma.FollowingRelationship.State value"
930 def get_follow_state(%User{} = follower, %User{} = following) do
931 following_relationship = FollowingRelationship.get(follower, following)
932 get_follow_state(follower, following, following_relationship)
935 def get_follow_state(
938 following_relationship
940 case {following_relationship, following.local} do
942 case Utils.fetch_latest_follow(follower, following) do
943 %Activity{data: %{"state" => state}} when state in ["pending", "accept"] ->
944 FollowingRelationship.state_to_enum(state)
950 {%{state: state}, _} ->
958 def locked?(%User{} = user) do
963 Repo.get_by(User, id: id)
966 def get_by_ap_id(ap_id) do
967 Repo.get_by(User, ap_id: ap_id)
970 def get_all_by_ap_id(ap_ids) do
971 from(u in __MODULE__,
972 where: u.ap_id in ^ap_ids
977 def get_all_by_ids(ids) do
978 from(u in __MODULE__, where: u.id in ^ids)
982 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
983 # of the ap_id and the domain and tries to get that user
984 def get_by_guessed_nickname(ap_id) do
985 domain = URI.parse(ap_id).host
986 name = List.last(String.split(ap_id, "/"))
987 nickname = "#{name}@#{domain}"
989 get_cached_by_nickname(nickname)
992 def set_cache({:ok, user}), do: set_cache(user)
993 def set_cache({:error, err}), do: {:error, err}
995 def set_cache(%User{} = user) do
996 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
997 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
998 Cachex.put(:user_cache, "friends_ap_ids:#{user.nickname}", get_user_friends_ap_ids(user))
1002 def update_and_set_cache(struct, params) do
1004 |> update_changeset(params)
1005 |> update_and_set_cache()
1008 def update_and_set_cache(changeset) do
1009 with {:ok, user} <- Repo.update(changeset, stale_error_field: :id) do
1014 def get_user_friends_ap_ids(user) do
1015 from(u in User.get_friends_query(user), select: u.ap_id)
1019 @spec get_cached_user_friends_ap_ids(User.t()) :: [String.t()]
1020 def get_cached_user_friends_ap_ids(user) do
1021 Cachex.fetch!(:user_cache, "friends_ap_ids:#{user.ap_id}", fn _ ->
1022 get_user_friends_ap_ids(user)
1026 def invalidate_cache(user) do
1027 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
1028 Cachex.del(:user_cache, "nickname:#{user.nickname}")
1029 Cachex.del(:user_cache, "friends_ap_ids:#{user.ap_id}")
1032 @spec get_cached_by_ap_id(String.t()) :: User.t() | nil
1033 def get_cached_by_ap_id(ap_id) do
1034 key = "ap_id:#{ap_id}"
1036 with {:ok, nil} <- Cachex.get(:user_cache, key),
1037 user when not is_nil(user) <- get_by_ap_id(ap_id),
1038 {:ok, true} <- Cachex.put(:user_cache, key, user) do
1046 def get_cached_by_id(id) do
1050 Cachex.fetch!(:user_cache, key, fn _ ->
1051 user = get_by_id(id)
1054 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
1055 {:commit, user.ap_id}
1061 get_cached_by_ap_id(ap_id)
1064 def get_cached_by_nickname(nickname) do
1065 key = "nickname:#{nickname}"
1067 Cachex.fetch!(:user_cache, key, fn ->
1068 case get_or_fetch_by_nickname(nickname) do
1069 {:ok, user} -> {:commit, user}
1070 {:error, _error} -> {:ignore, nil}
1075 def get_cached_by_nickname_or_id(nickname_or_id, opts \\ []) do
1076 restrict_to_local = Config.get([:instance, :limit_to_local_content])
1079 is_integer(nickname_or_id) or FlakeId.flake_id?(nickname_or_id) ->
1080 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
1082 restrict_to_local == false or not String.contains?(nickname_or_id, "@") ->
1083 get_cached_by_nickname(nickname_or_id)
1085 restrict_to_local == :unauthenticated and match?(%User{}, opts[:for]) ->
1086 get_cached_by_nickname(nickname_or_id)
1093 @spec get_by_nickname(String.t()) :: User.t() | nil
1094 def get_by_nickname(nickname) do
1095 Repo.get_by(User, nickname: nickname) ||
1096 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
1097 Repo.get_by(User, nickname: local_nickname(nickname))
1101 def get_by_email(email), do: Repo.get_by(User, email: email)
1103 def get_by_nickname_or_email(nickname_or_email) do
1104 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
1107 def fetch_by_nickname(nickname), do: ActivityPub.make_user_from_nickname(nickname)
1109 def get_or_fetch_by_nickname(nickname) do
1110 with %User{} = user <- get_by_nickname(nickname) do
1114 with [_nick, _domain] <- String.split(nickname, "@"),
1115 {:ok, user} <- fetch_by_nickname(nickname) do
1118 _e -> {:error, "not found " <> nickname}
1123 @spec get_followers_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
1124 def get_followers_query(%User{} = user, nil) do
1125 User.Query.build(%{followers: user, deactivated: false})
1128 def get_followers_query(%User{} = user, page) do
1130 |> get_followers_query(nil)
1131 |> User.Query.paginate(page, 20)
1134 @spec get_followers_query(User.t()) :: Ecto.Query.t()
1135 def get_followers_query(%User{} = user), do: get_followers_query(user, nil)
1137 @spec get_followers(User.t(), pos_integer() | nil) :: {:ok, list(User.t())}
1138 def get_followers(%User{} = user, page \\ nil) do
1140 |> get_followers_query(page)
1144 @spec get_external_followers(User.t(), pos_integer() | nil) :: {:ok, list(User.t())}
1145 def get_external_followers(%User{} = user, page \\ nil) do
1147 |> get_followers_query(page)
1148 |> User.Query.build(%{external: true})
1152 def get_followers_ids(%User{} = user, page \\ nil) do
1154 |> get_followers_query(page)
1155 |> select([u], u.id)
1159 @spec get_friends_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
1160 def get_friends_query(%User{} = user, nil) do
1161 User.Query.build(%{friends: user, deactivated: false})
1164 def get_friends_query(%User{} = user, page) do
1166 |> get_friends_query(nil)
1167 |> User.Query.paginate(page, 20)
1170 @spec get_friends_query(User.t()) :: Ecto.Query.t()
1171 def get_friends_query(%User{} = user), do: get_friends_query(user, nil)
1173 def get_friends(%User{} = user, page \\ nil) do
1175 |> get_friends_query(page)
1179 def get_friends_ap_ids(%User{} = user) do
1181 |> get_friends_query(nil)
1182 |> select([u], u.ap_id)
1186 def get_friends_ids(%User{} = user, page \\ nil) do
1188 |> get_friends_query(page)
1189 |> select([u], u.id)
1193 def increase_note_count(%User{} = user) do
1195 |> where(id: ^user.id)
1196 |> update([u], inc: [note_count: 1])
1198 |> Repo.update_all([])
1200 {1, [user]} -> set_cache(user)
1205 def decrease_note_count(%User{} = user) do
1207 |> where(id: ^user.id)
1210 note_count: fragment("greatest(0, note_count - 1)")
1214 |> Repo.update_all([])
1216 {1, [user]} -> set_cache(user)
1221 def update_note_count(%User{} = user, note_count \\ nil) do
1226 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
1232 |> cast(%{note_count: note_count}, [:note_count])
1233 |> update_and_set_cache()
1236 @spec maybe_fetch_follow_information(User.t()) :: User.t()
1237 def maybe_fetch_follow_information(user) do
1238 with {:ok, user} <- fetch_follow_information(user) do
1242 Logger.error("Follower/Following counter update for #{user.ap_id} failed.\n#{inspect(e)}")
1248 def fetch_follow_information(user) do
1249 with {:ok, info} <- ActivityPub.fetch_follow_information_for_user(user) do
1251 |> follow_information_changeset(info)
1252 |> update_and_set_cache()
1256 defp follow_information_changeset(user, params) do
1263 :hide_followers_count,
1268 @spec update_follower_count(User.t()) :: {:ok, User.t()}
1269 def update_follower_count(%User{} = user) do
1270 if user.local or !Config.get([:instance, :external_user_synchronization]) do
1271 follower_count = FollowingRelationship.follower_count(user)
1274 |> follow_information_changeset(%{follower_count: follower_count})
1275 |> update_and_set_cache
1277 {:ok, maybe_fetch_follow_information(user)}
1281 @spec update_following_count(User.t()) :: {:ok, User.t()}
1282 def update_following_count(%User{local: false} = user) do
1283 if Config.get([:instance, :external_user_synchronization]) do
1284 {:ok, maybe_fetch_follow_information(user)}
1290 def update_following_count(%User{local: true} = user) do
1291 following_count = FollowingRelationship.following_count(user)
1294 |> follow_information_changeset(%{following_count: following_count})
1295 |> update_and_set_cache()
1298 def set_unread_conversation_count(%User{local: true} = user) do
1299 unread_query = Participation.unread_conversation_count_for_user(user)
1302 |> join(:inner, [u], p in subquery(unread_query))
1304 set: [unread_conversation_count: p.count]
1306 |> where([u], u.id == ^user.id)
1308 |> Repo.update_all([])
1310 {1, [user]} -> set_cache(user)
1315 def set_unread_conversation_count(user), do: {:ok, user}
1317 def increment_unread_conversation_count(conversation, %User{local: true} = user) do
1319 Participation.unread_conversation_count_for_user(user)
1320 |> where([p], p.conversation_id == ^conversation.id)
1323 |> join(:inner, [u], p in subquery(unread_query))
1325 inc: [unread_conversation_count: 1]
1327 |> where([u], u.id == ^user.id)
1328 |> where([u, p], p.count == 0)
1330 |> Repo.update_all([])
1332 {1, [user]} -> set_cache(user)
1337 def increment_unread_conversation_count(_, user), do: {:ok, user}
1339 @spec get_users_from_set([String.t()], keyword()) :: [User.t()]
1340 def get_users_from_set(ap_ids, opts \\ []) do
1341 local_only = Keyword.get(opts, :local_only, true)
1342 criteria = %{ap_id: ap_ids, deactivated: false}
1343 criteria = if local_only, do: Map.put(criteria, :local, true), else: criteria
1345 User.Query.build(criteria)
1349 @spec get_recipients_from_activity(Activity.t()) :: [User.t()]
1350 def get_recipients_from_activity(%Activity{recipients: to, actor: actor}) do
1353 query = User.Query.build(%{recipients_from_activity: to, local: true, deactivated: false})
1359 @spec mute(User.t(), User.t(), boolean()) ::
1360 {:ok, list(UserRelationship.t())} | {:error, String.t()}
1361 def mute(%User{} = muter, %User{} = mutee, notifications? \\ true) do
1362 add_to_mutes(muter, mutee, notifications?)
1365 def unmute(%User{} = muter, %User{} = mutee) do
1366 remove_from_mutes(muter, mutee)
1369 def subscribe(%User{} = subscriber, %User{} = target) do
1370 deny_follow_blocked = Config.get([:user, :deny_follow_blocked])
1372 if blocks?(target, subscriber) and deny_follow_blocked do
1373 {:error, "Could not subscribe: #{target.nickname} is blocking you"}
1375 # Note: the relationship is inverse: subscriber acts as relationship target
1376 UserRelationship.create_inverse_subscription(target, subscriber)
1380 def subscribe(%User{} = subscriber, %{ap_id: ap_id}) do
1381 with %User{} = subscribee <- get_cached_by_ap_id(ap_id) do
1382 subscribe(subscriber, subscribee)
1386 def unsubscribe(%User{} = unsubscriber, %User{} = target) do
1387 # Note: the relationship is inverse: subscriber acts as relationship target
1388 UserRelationship.delete_inverse_subscription(target, unsubscriber)
1391 def unsubscribe(%User{} = unsubscriber, %{ap_id: ap_id}) do
1392 with %User{} = user <- get_cached_by_ap_id(ap_id) do
1393 unsubscribe(unsubscriber, user)
1397 def block(%User{} = blocker, %User{} = blocked) do
1398 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
1400 if following?(blocker, blocked) do
1401 {:ok, blocker, _} = unfollow(blocker, blocked)
1407 # clear any requested follows as well
1409 case CommonAPI.reject_follow_request(blocked, blocker) do
1410 {:ok, %User{} = updated_blocked} -> updated_blocked
1414 unsubscribe(blocked, blocker)
1416 unfollowing_blocked = Config.get([:activitypub, :unfollow_blocked], true)
1417 if unfollowing_blocked && following?(blocked, blocker), do: unfollow(blocked, blocker)
1419 {:ok, blocker} = update_follower_count(blocker)
1420 {:ok, blocker, _} = Participation.mark_all_as_read(blocker, blocked)
1421 add_to_block(blocker, blocked)
1424 # helper to handle the block given only an actor's AP id
1425 def block(%User{} = blocker, %{ap_id: ap_id}) do
1426 block(blocker, get_cached_by_ap_id(ap_id))
1429 def unblock(%User{} = blocker, %User{} = blocked) do
1430 remove_from_block(blocker, blocked)
1433 # helper to handle the block given only an actor's AP id
1434 def unblock(%User{} = blocker, %{ap_id: ap_id}) do
1435 unblock(blocker, get_cached_by_ap_id(ap_id))
1438 def mutes?(nil, _), do: false
1439 def mutes?(%User{} = user, %User{} = target), do: mutes_user?(user, target)
1441 def mutes_user?(%User{} = user, %User{} = target) do
1442 UserRelationship.mute_exists?(user, target)
1445 @spec muted_notifications?(User.t() | nil, User.t() | map()) :: boolean()
1446 def muted_notifications?(nil, _), do: false
1448 def muted_notifications?(%User{} = user, %User{} = target),
1449 do: UserRelationship.notification_mute_exists?(user, target)
1451 def blocks?(nil, _), do: false
1453 def blocks?(%User{} = user, %User{} = target) do
1454 blocks_user?(user, target) ||
1455 (blocks_domain?(user, target) and not User.following?(user, target))
1458 def blocks_user?(%User{} = user, %User{} = target) do
1459 UserRelationship.block_exists?(user, target)
1462 def blocks_user?(_, _), do: false
1464 def blocks_domain?(%User{} = user, %User{} = target) do
1465 domain_blocks = Pleroma.Web.ActivityPub.MRF.subdomains_regex(user.domain_blocks)
1466 %{host: host} = URI.parse(target.ap_id)
1467 Pleroma.Web.ActivityPub.MRF.subdomain_match?(domain_blocks, host)
1470 def blocks_domain?(_, _), do: false
1472 def subscribed_to?(%User{} = user, %User{} = target) do
1473 # Note: the relationship is inverse: subscriber acts as relationship target
1474 UserRelationship.inverse_subscription_exists?(target, user)
1477 def subscribed_to?(%User{} = user, %{ap_id: ap_id}) do
1478 with %User{} = target <- get_cached_by_ap_id(ap_id) do
1479 subscribed_to?(user, target)
1484 Returns map of outgoing (blocked, muted etc.) relationships' user AP IDs by relation type.
1485 E.g. `outgoing_relationships_ap_ids(user, [:block])` -> `%{block: ["https://some.site/users/userapid"]}`
1487 @spec outgoing_relationships_ap_ids(User.t(), list(atom())) :: %{atom() => list(String.t())}
1488 def outgoing_relationships_ap_ids(_user, []), do: %{}
1490 def outgoing_relationships_ap_ids(nil, _relationship_types), do: %{}
1492 def outgoing_relationships_ap_ids(%User{} = user, relationship_types)
1493 when is_list(relationship_types) do
1496 |> assoc(:outgoing_relationships)
1497 |> join(:inner, [user_rel], u in assoc(user_rel, :target))
1498 |> where([user_rel, u], user_rel.relationship_type in ^relationship_types)
1499 |> select([user_rel, u], [user_rel.relationship_type, fragment("array_agg(?)", u.ap_id)])
1500 |> group_by([user_rel, u], user_rel.relationship_type)
1502 |> Enum.into(%{}, fn [k, v] -> {k, v} end)
1507 fn rel_type -> {rel_type, db_result[rel_type] || []} end
1511 def incoming_relationships_ungrouped_ap_ids(user, relationship_types, ap_ids \\ nil)
1513 def incoming_relationships_ungrouped_ap_ids(_user, [], _ap_ids), do: []
1515 def incoming_relationships_ungrouped_ap_ids(nil, _relationship_types, _ap_ids), do: []
1517 def incoming_relationships_ungrouped_ap_ids(%User{} = user, relationship_types, ap_ids)
1518 when is_list(relationship_types) do
1520 |> assoc(:incoming_relationships)
1521 |> join(:inner, [user_rel], u in assoc(user_rel, :source))
1522 |> where([user_rel, u], user_rel.relationship_type in ^relationship_types)
1523 |> maybe_filter_on_ap_id(ap_ids)
1524 |> select([user_rel, u], u.ap_id)
1529 defp maybe_filter_on_ap_id(query, ap_ids) when is_list(ap_ids) do
1530 where(query, [user_rel, u], u.ap_id in ^ap_ids)
1533 defp maybe_filter_on_ap_id(query, _ap_ids), do: query
1535 def deactivate_async(user, status \\ true) do
1536 BackgroundWorker.enqueue("deactivate_user", %{"user_id" => user.id, "status" => status})
1539 def deactivate(user, status \\ true)
1541 def deactivate(users, status) when is_list(users) do
1542 Repo.transaction(fn ->
1543 for user <- users, do: deactivate(user, status)
1547 def deactivate(%User{} = user, status) do
1548 with {:ok, user} <- set_activation_status(user, status) do
1551 |> Enum.filter(& &1.local)
1552 |> Enum.each(&set_cache(update_following_count(&1)))
1554 # Only update local user counts, remote will be update during the next pull.
1557 |> Enum.filter(& &1.local)
1558 |> Enum.each(&do_unfollow(user, &1))
1564 def approve(users) when is_list(users) do
1565 Repo.transaction(fn ->
1566 Enum.map(users, fn user ->
1567 with {:ok, user} <- approve(user), do: user
1572 def approve(%User{} = user) do
1573 change(user, approval_pending: false)
1574 |> update_and_set_cache()
1577 def update_notification_settings(%User{} = user, settings) do
1579 |> cast(%{notification_settings: settings}, [])
1580 |> cast_embed(:notification_settings)
1581 |> validate_required([:notification_settings])
1582 |> update_and_set_cache()
1585 @spec purge_user_changeset(User.t()) :: Changeset.t()
1586 def purge_user_changeset(user) do
1587 # "Right to be forgotten"
1588 # https://gdpr.eu/right-to-be-forgotten/
1599 last_refreshed_at: nil,
1600 last_digest_emailed_at: nil,
1607 confirmation_pending: false,
1608 password_reset_pending: false,
1609 approval_pending: false,
1610 registration_reason: nil,
1611 confirmation_token: nil,
1615 is_moderator: false,
1617 mastofe_settings: nil,
1620 pleroma_settings_store: %{},
1623 discoverable: false,
1628 def delete(users) when is_list(users) do
1629 for user <- users, do: delete(user)
1632 def delete(%User{} = user) do
1633 BackgroundWorker.enqueue("delete_user", %{"user_id" => user.id})
1636 defp delete_and_invalidate_cache(%User{} = user) do
1637 invalidate_cache(user)
1641 defp delete_or_deactivate(%User{local: false} = user), do: delete_and_invalidate_cache(user)
1643 defp delete_or_deactivate(%User{local: true} = user) do
1644 status = account_status(user)
1647 :confirmation_pending ->
1648 delete_and_invalidate_cache(user)
1650 :approval_pending ->
1651 delete_and_invalidate_cache(user)
1655 |> purge_user_changeset()
1656 |> update_and_set_cache()
1660 def perform(:force_password_reset, user), do: force_password_reset(user)
1662 @spec perform(atom(), User.t()) :: {:ok, User.t()}
1663 def perform(:delete, %User{} = user) do
1664 # Remove all relationships
1667 |> Enum.each(fn follower ->
1668 ActivityPub.unfollow(follower, user)
1669 unfollow(follower, user)
1674 |> Enum.each(fn followed ->
1675 ActivityPub.unfollow(user, followed)
1676 unfollow(user, followed)
1679 delete_user_activities(user)
1680 delete_notifications_from_user_activities(user)
1682 delete_outgoing_pending_follow_requests(user)
1684 delete_or_deactivate(user)
1687 def perform(:deactivate_async, user, status), do: deactivate(user, status)
1689 @spec external_users_query() :: Ecto.Query.t()
1690 def external_users_query do
1698 @spec external_users(keyword()) :: [User.t()]
1699 def external_users(opts \\ []) do
1701 external_users_query()
1702 |> select([u], struct(u, [:id, :ap_id]))
1706 do: where(query, [u], u.id > ^opts[:max_id]),
1711 do: limit(query, ^opts[:limit]),
1717 def delete_notifications_from_user_activities(%User{ap_id: ap_id}) do
1719 |> join(:inner, [n], activity in assoc(n, :activity))
1720 |> where([n, a], fragment("? = ?", a.actor, ^ap_id))
1721 |> Repo.delete_all()
1724 def delete_user_activities(%User{ap_id: ap_id} = user) do
1726 |> Activity.Queries.by_actor()
1727 |> Repo.chunk_stream(50, :batches)
1728 |> Stream.each(fn activities ->
1729 Enum.each(activities, fn activity -> delete_activity(activity, user) end)
1734 defp delete_activity(%{data: %{"type" => "Create", "object" => object}} = activity, user) do
1735 with {_, %Object{}} <- {:find_object, Object.get_by_ap_id(object)},
1736 {:ok, delete_data, _} <- Builder.delete(user, object) do
1737 Pipeline.common_pipeline(delete_data, local: user.local)
1739 {:find_object, nil} ->
1740 # We have the create activity, but not the object, it was probably pruned.
1741 # Insert a tombstone and try again
1742 with {:ok, tombstone_data, _} <- Builder.tombstone(user.ap_id, object),
1743 {:ok, _tombstone} <- Object.create(tombstone_data) do
1744 delete_activity(activity, user)
1748 Logger.error("Could not delete #{object} created by #{activity.data["ap_id"]}")
1749 Logger.error("Error: #{inspect(e)}")
1753 defp delete_activity(%{data: %{"type" => type}} = activity, user)
1754 when type in ["Like", "Announce"] do
1755 {:ok, undo, _} = Builder.undo(user, activity)
1756 Pipeline.common_pipeline(undo, local: user.local)
1759 defp delete_activity(_activity, _user), do: "Doing nothing"
1761 defp delete_outgoing_pending_follow_requests(user) do
1763 |> FollowingRelationship.outgoing_pending_follow_requests_query()
1764 |> Repo.delete_all()
1767 def html_filter_policy(%User{no_rich_text: true}) do
1768 Pleroma.HTML.Scrubber.TwitterText
1771 def html_filter_policy(_), do: Config.get([:markup, :scrub_policy])
1773 def fetch_by_ap_id(ap_id, opts \\ []), do: ActivityPub.make_user_from_ap_id(ap_id, opts)
1775 def get_or_fetch_by_ap_id(ap_id, opts \\ []) do
1776 cached_user = get_cached_by_ap_id(ap_id)
1778 maybe_fetched_user = needs_update?(cached_user) && fetch_by_ap_id(ap_id, opts)
1780 case {cached_user, maybe_fetched_user} do
1781 {_, {:ok, %User{} = user}} ->
1784 {%User{} = user, _} ->
1788 {:error, :not_found}
1793 Creates an internal service actor by URI if missing.
1794 Optionally takes nickname for addressing.
1796 @spec get_or_create_service_actor_by_ap_id(String.t(), String.t()) :: User.t() | nil
1797 def get_or_create_service_actor_by_ap_id(uri, nickname) do
1799 case get_cached_by_ap_id(uri) do
1801 with {:error, %{errors: errors}} <- create_service_actor(uri, nickname) do
1802 Logger.error("Cannot create service actor: #{uri}/.\n#{inspect(errors)}")
1806 %User{invisible: false} = user ->
1816 @spec set_invisible(User.t()) :: {:ok, User.t()}
1817 defp set_invisible(user) do
1819 |> change(%{invisible: true})
1820 |> update_and_set_cache()
1823 @spec create_service_actor(String.t(), String.t()) ::
1824 {:ok, User.t()} | {:error, Ecto.Changeset.t()}
1825 defp create_service_actor(uri, nickname) do
1831 follower_address: uri <> "/followers"
1834 |> unique_constraint(:nickname)
1839 def public_key(%{public_key: public_key_pem}) when is_binary(public_key_pem) do
1842 |> :public_key.pem_decode()
1844 |> :public_key.pem_entry_decode()
1849 def public_key(_), do: {:error, "key not found"}
1851 def get_public_key_for_ap_id(ap_id, opts \\ []) do
1852 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id, opts),
1853 {:ok, public_key} <- public_key(user) do
1860 def ap_enabled?(%User{local: true}), do: true
1861 def ap_enabled?(%User{ap_enabled: ap_enabled}), do: ap_enabled
1862 def ap_enabled?(_), do: false
1864 @doc "Gets or fetch a user by uri or nickname."
1865 @spec get_or_fetch(String.t()) :: {:ok, User.t()} | {:error, String.t()}
1866 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1867 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1869 # wait a period of time and return newest version of the User structs
1870 # this is because we have synchronous follow APIs and need to simulate them
1871 # with an async handshake
1872 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1873 with %User{} = a <- get_cached_by_id(a.id),
1874 %User{} = b <- get_cached_by_id(b.id) do
1881 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1882 with :ok <- :timer.sleep(timeout),
1883 %User{} = a <- get_cached_by_id(a.id),
1884 %User{} = b <- get_cached_by_id(b.id) do
1891 def parse_bio(bio) when is_binary(bio) and bio != "" do
1893 |> CommonUtils.format_input("text/plain", mentions_format: :full)
1897 def parse_bio(_), do: ""
1899 def parse_bio(bio, user) when is_binary(bio) and bio != "" do
1900 # TODO: get profile URLs other than user.ap_id
1901 profile_urls = [user.ap_id]
1904 |> CommonUtils.format_input("text/plain",
1905 mentions_format: :full,
1906 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1911 def parse_bio(_, _), do: ""
1913 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1914 Repo.transaction(fn ->
1915 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1919 def tag(nickname, tags) when is_binary(nickname),
1920 do: tag(get_by_nickname(nickname), tags)
1922 def tag(%User{} = user, tags),
1923 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1925 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1926 Repo.transaction(fn ->
1927 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1931 def untag(nickname, tags) when is_binary(nickname),
1932 do: untag(get_by_nickname(nickname), tags)
1934 def untag(%User{} = user, tags),
1935 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1937 defp update_tags(%User{} = user, new_tags) do
1938 {:ok, updated_user} =
1940 |> change(%{tags: new_tags})
1941 |> update_and_set_cache()
1946 defp normalize_tags(tags) do
1949 |> Enum.map(&String.downcase/1)
1952 defp local_nickname_regex do
1953 if Config.get([:instance, :extended_nickname_format]) do
1954 @extended_local_nickname_regex
1956 @strict_local_nickname_regex
1960 def local_nickname(nickname_or_mention) do
1963 |> String.split("@")
1967 def full_nickname(nickname_or_mention),
1968 do: String.trim_leading(nickname_or_mention, "@")
1970 def error_user(ap_id) do
1974 nickname: "erroruser@example.com",
1975 inserted_at: NaiveDateTime.utc_now()
1979 @spec all_superusers() :: [User.t()]
1980 def all_superusers do
1981 User.Query.build(%{super_users: true, local: true, deactivated: false})
1985 def muting_reblogs?(%User{} = user, %User{} = target) do
1986 UserRelationship.reblog_mute_exists?(user, target)
1989 def showing_reblogs?(%User{} = user, %User{} = target) do
1990 not muting_reblogs?(user, target)
1994 The function returns a query to get users with no activity for given interval of days.
1995 Inactive users are those who didn't read any notification, or had any activity where
1996 the user is the activity's actor, during `inactivity_threshold` days.
1997 Deactivated users will not appear in this list.
2001 iex> Pleroma.User.list_inactive_users()
2004 @spec list_inactive_users_query(integer()) :: Ecto.Query.t()
2005 def list_inactive_users_query(inactivity_threshold \\ 7) do
2006 negative_inactivity_threshold = -inactivity_threshold
2007 now = NaiveDateTime.truncate(NaiveDateTime.utc_now(), :second)
2008 # Subqueries are not supported in `where` clauses, join gets too complicated.
2009 has_read_notifications =
2010 from(n in Pleroma.Notification,
2011 where: n.seen == true,
2013 having: max(n.updated_at) > datetime_add(^now, ^negative_inactivity_threshold, "day"),
2016 |> Pleroma.Repo.all()
2018 from(u in Pleroma.User,
2019 left_join: a in Pleroma.Activity,
2020 on: u.ap_id == a.actor,
2021 where: not is_nil(u.nickname),
2022 where: u.deactivated != ^true,
2023 where: u.id not in ^has_read_notifications,
2026 max(a.inserted_at) < datetime_add(^now, ^negative_inactivity_threshold, "day") or
2027 is_nil(max(a.inserted_at))
2032 Enable or disable email notifications for user
2036 iex> Pleroma.User.switch_email_notifications(Pleroma.User{email_notifications: %{"digest" => false}}, "digest", true)
2037 Pleroma.User{email_notifications: %{"digest" => true}}
2039 iex> Pleroma.User.switch_email_notifications(Pleroma.User{email_notifications: %{"digest" => true}}, "digest", false)
2040 Pleroma.User{email_notifications: %{"digest" => false}}
2042 @spec switch_email_notifications(t(), String.t(), boolean()) ::
2043 {:ok, t()} | {:error, Ecto.Changeset.t()}
2044 def switch_email_notifications(user, type, status) do
2045 User.update_email_notifications(user, %{type => status})
2049 Set `last_digest_emailed_at` value for the user to current time
2051 @spec touch_last_digest_emailed_at(t()) :: t()
2052 def touch_last_digest_emailed_at(user) do
2053 now = NaiveDateTime.truncate(NaiveDateTime.utc_now(), :second)
2055 {:ok, updated_user} =
2057 |> change(%{last_digest_emailed_at: now})
2058 |> update_and_set_cache()
2063 @spec toggle_confirmation(User.t()) :: {:ok, User.t()} | {:error, Changeset.t()}
2064 def toggle_confirmation(%User{} = user) do
2066 |> confirmation_changeset(need_confirmation: !user.confirmation_pending)
2067 |> update_and_set_cache()
2070 @spec toggle_confirmation([User.t()]) :: [{:ok, User.t()} | {:error, Changeset.t()}]
2071 def toggle_confirmation(users) do
2072 Enum.map(users, &toggle_confirmation/1)
2075 @spec need_confirmation(User.t(), boolean()) :: {:ok, User.t()} | {:error, Changeset.t()}
2076 def need_confirmation(%User{} = user, bool) do
2078 |> confirmation_changeset(need_confirmation: bool)
2079 |> update_and_set_cache()
2082 def get_mascot(%{mascot: %{} = mascot}) when not is_nil(mascot) do
2086 def get_mascot(%{mascot: mascot}) when is_nil(mascot) do
2087 # use instance-default
2088 config = Config.get([:assets, :mascots])
2089 default_mascot = Config.get([:assets, :default_mascot])
2090 mascot = Keyword.get(config, default_mascot)
2093 "id" => "default-mascot",
2094 "url" => mascot[:url],
2095 "preview_url" => mascot[:url],
2097 "mime_type" => mascot[:mime_type]
2102 def ensure_keys_present(%{keys: keys} = user) when not is_nil(keys), do: {:ok, user}
2104 def ensure_keys_present(%User{} = user) do
2105 with {:ok, pem} <- Keys.generate_rsa_pem() do
2107 |> cast(%{keys: pem}, [:keys])
2108 |> validate_required([:keys])
2109 |> update_and_set_cache()
2113 def get_ap_ids_by_nicknames(nicknames) do
2115 where: u.nickname in ^nicknames,
2121 defp put_password_hash(
2122 %Ecto.Changeset{valid?: true, changes: %{password: password}} = changeset
2124 change(changeset, password_hash: Pbkdf2.hash_pwd_salt(password))
2127 defp put_password_hash(changeset), do: changeset
2129 def is_internal_user?(%User{nickname: nil}), do: true
2130 def is_internal_user?(%User{local: true, nickname: "internal." <> _}), do: true
2131 def is_internal_user?(_), do: false
2133 # A hack because user delete activities have a fake id for whatever reason
2134 # TODO: Get rid of this
2135 def get_delivered_users_by_object_id("pleroma:fake_object_id"), do: []
2137 def get_delivered_users_by_object_id(object_id) do
2139 inner_join: delivery in assoc(u, :deliveries),
2140 where: delivery.object_id == ^object_id
2145 def change_email(user, email) do
2147 |> cast(%{email: email}, [:email])
2148 |> validate_required([:email])
2149 |> unique_constraint(:email)
2150 |> validate_format(:email, @email_regex)
2151 |> update_and_set_cache()
2154 # Internal function; public one is `deactivate/2`
2155 defp set_activation_status(user, deactivated) do
2157 |> cast(%{deactivated: deactivated}, [:deactivated])
2158 |> update_and_set_cache()
2161 def update_banner(user, banner) do
2163 |> cast(%{banner: banner}, [:banner])
2164 |> update_and_set_cache()
2167 def update_background(user, background) do
2169 |> cast(%{background: background}, [:background])
2170 |> update_and_set_cache()
2173 def roles(%{is_moderator: is_moderator, is_admin: is_admin}) do
2176 moderator: is_moderator
2180 def validate_fields(changeset, remote? \\ false) do
2181 limit_name = if remote?, do: :max_remote_account_fields, else: :max_account_fields
2182 limit = Config.get([:instance, limit_name], 0)
2185 |> validate_length(:fields, max: limit)
2186 |> validate_change(:fields, fn :fields, fields ->
2187 if Enum.all?(fields, &valid_field?/1) do
2195 defp valid_field?(%{"name" => name, "value" => value}) do
2196 name_limit = Config.get([:instance, :account_field_name_length], 255)
2197 value_limit = Config.get([:instance, :account_field_value_length], 255)
2199 is_binary(name) && is_binary(value) && String.length(name) <= name_limit &&
2200 String.length(value) <= value_limit
2203 defp valid_field?(_), do: false
2205 defp truncate_field(%{"name" => name, "value" => value}) do
2207 String.split_at(name, Config.get([:instance, :account_field_name_length], 255))
2210 String.split_at(value, Config.get([:instance, :account_field_value_length], 255))
2212 %{"name" => name, "value" => value}
2215 def admin_api_update(user, params) do
2222 |> update_and_set_cache()
2225 @doc "Signs user out of all applications"
2226 def global_sign_out(user) do
2227 OAuth.Authorization.delete_user_authorizations(user)
2228 OAuth.Token.delete_user_tokens(user)
2231 def mascot_update(user, url) do
2233 |> cast(%{mascot: url}, [:mascot])
2234 |> validate_required([:mascot])
2235 |> update_and_set_cache()
2238 def mastodon_settings_update(user, settings) do
2240 |> cast(%{mastofe_settings: settings}, [:mastofe_settings])
2241 |> validate_required([:mastofe_settings])
2242 |> update_and_set_cache()
2245 @spec confirmation_changeset(User.t(), keyword()) :: Changeset.t()
2246 def confirmation_changeset(user, need_confirmation: need_confirmation?) do
2248 if need_confirmation? do
2250 confirmation_pending: true,
2251 confirmation_token: :crypto.strong_rand_bytes(32) |> Base.url_encode64()
2255 confirmation_pending: false,
2256 confirmation_token: nil
2260 cast(user, params, [:confirmation_pending, :confirmation_token])
2263 @spec approval_changeset(User.t(), keyword()) :: Changeset.t()
2264 def approval_changeset(user, need_approval: need_approval?) do
2265 params = if need_approval?, do: %{approval_pending: true}, else: %{approval_pending: false}
2266 cast(user, params, [:approval_pending])
2269 def add_pinnned_activity(user, %Pleroma.Activity{id: id}) do
2270 if id not in user.pinned_activities do
2271 max_pinned_statuses = Config.get([:instance, :max_pinned_statuses], 0)
2272 params = %{pinned_activities: user.pinned_activities ++ [id]}
2274 # if pinned activity was scheduled for deletion, we remove job
2275 if expiration = Pleroma.Workers.PurgeExpiredActivity.get_expiration(id) do
2276 Oban.cancel_job(expiration.id)
2280 |> cast(params, [:pinned_activities])
2281 |> validate_length(:pinned_activities,
2282 max: max_pinned_statuses,
2283 message: "You have already pinned the maximum number of statuses"
2288 |> update_and_set_cache()
2291 def remove_pinnned_activity(user, %Pleroma.Activity{id: id, data: data}) do
2292 params = %{pinned_activities: List.delete(user.pinned_activities, id)}
2294 # if pinned activity was scheduled for deletion, we reschedule it for deletion
2295 if data["expires_at"] do
2296 # MRF.ActivityExpirationPolicy used UTC timestamps for expires_at in original implementation
2298 data["expires_at"] |> Pleroma.EctoType.ActivityPub.ObjectValidators.DateTime.cast()
2300 Pleroma.Workers.PurgeExpiredActivity.enqueue(%{
2302 expires_at: expires_at
2307 |> cast(params, [:pinned_activities])
2308 |> update_and_set_cache()
2311 def update_email_notifications(user, settings) do
2312 email_notifications =
2313 user.email_notifications
2314 |> Map.merge(settings)
2315 |> Map.take(["digest"])
2317 params = %{email_notifications: email_notifications}
2318 fields = [:email_notifications]
2321 |> cast(params, fields)
2322 |> validate_required(fields)
2323 |> update_and_set_cache()
2326 defp set_domain_blocks(user, domain_blocks) do
2327 params = %{domain_blocks: domain_blocks}
2330 |> cast(params, [:domain_blocks])
2331 |> validate_required([:domain_blocks])
2332 |> update_and_set_cache()
2335 def block_domain(user, domain_blocked) do
2336 set_domain_blocks(user, Enum.uniq([domain_blocked | user.domain_blocks]))
2339 def unblock_domain(user, domain_blocked) do
2340 set_domain_blocks(user, List.delete(user.domain_blocks, domain_blocked))
2343 @spec add_to_block(User.t(), User.t()) ::
2344 {:ok, UserRelationship.t()} | {:error, Ecto.Changeset.t()}
2345 defp add_to_block(%User{} = user, %User{} = blocked) do
2346 UserRelationship.create_block(user, blocked)
2349 @spec add_to_block(User.t(), User.t()) ::
2350 {:ok, UserRelationship.t()} | {:ok, nil} | {:error, Ecto.Changeset.t()}
2351 defp remove_from_block(%User{} = user, %User{} = blocked) do
2352 UserRelationship.delete_block(user, blocked)
2355 defp add_to_mutes(%User{} = user, %User{} = muted_user, notifications?) do
2356 with {:ok, user_mute} <- UserRelationship.create_mute(user, muted_user),
2357 {:ok, user_notification_mute} <-
2358 (notifications? && UserRelationship.create_notification_mute(user, muted_user)) ||
2360 {:ok, Enum.filter([user_mute, user_notification_mute], & &1)}
2364 defp remove_from_mutes(user, %User{} = muted_user) do
2365 with {:ok, user_mute} <- UserRelationship.delete_mute(user, muted_user),
2366 {:ok, user_notification_mute} <-
2367 UserRelationship.delete_notification_mute(user, muted_user) do
2368 {:ok, [user_mute, user_notification_mute]}
2372 def set_invisible(user, invisible) do
2373 params = %{invisible: invisible}
2376 |> cast(params, [:invisible])
2377 |> validate_required([:invisible])
2378 |> update_and_set_cache()
2381 def sanitize_html(%User{} = user) do
2382 sanitize_html(user, nil)
2385 # User data that mastodon isn't filtering (treated as plaintext):
2388 def sanitize_html(%User{} = user, filter) do
2390 Enum.map(user.fields, fn %{"name" => name, "value" => value} ->
2393 "value" => HTML.filter_tags(value, Pleroma.HTML.Scrubber.LinksOnly)
2398 |> Map.put(:bio, HTML.filter_tags(user.bio, filter))
2399 |> Map.put(:fields, fields)
2402 defp validate_also_known_as(changeset) do
2403 validate_change(changeset, :also_known_as, fn :also_known_as, also_known_as ->
2404 case Enum.all?(also_known_as, fn a -> Regex.match?(@url_regex, a) end) do
2406 false -> [also_known_as: "Invalid ap_id format. Must be a URL."]