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]
14 alias Pleroma.Activity
16 alias Pleroma.Conversation.Participation
17 alias Pleroma.Delivery
19 alias Pleroma.FollowingRelationship
20 alias Pleroma.Formatter
23 alias Pleroma.Notification
25 alias Pleroma.Registration
27 alias Pleroma.RepoStreamer
29 alias Pleroma.UserRelationship
31 alias Pleroma.Web.ActivityPub.ActivityPub
32 alias Pleroma.Web.ActivityPub.ObjectValidators.Types
33 alias Pleroma.Web.ActivityPub.Utils
34 alias Pleroma.Web.CommonAPI
35 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
36 alias Pleroma.Web.OAuth
37 alias Pleroma.Web.RelMe
38 alias Pleroma.Workers.BackgroundWorker
42 @type t :: %__MODULE__{}
43 @type account_status :: :active | :deactivated | :password_reset_pending | :confirmation_pending
44 @primary_key {:id, FlakeId.Ecto.CompatType, autogenerate: true}
46 # credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
47 @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])?)*$/
49 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
50 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
52 # AP ID user relationships (blocks, mutes etc.)
53 # Format: [rel_type: [outgoing_rel: :outgoing_rel_target, incoming_rel: :incoming_rel_source]]
54 @user_relationships_config [
56 blocker_blocks: :blocked_users,
57 blockee_blocks: :blocker_users
60 muter_mutes: :muted_users,
61 mutee_mutes: :muter_users
64 reblog_muter_mutes: :reblog_muted_users,
65 reblog_mutee_mutes: :reblog_muter_users
68 notification_muter_mutes: :notification_muted_users,
69 notification_mutee_mutes: :notification_muter_users
71 # Note: `inverse_subscription` relationship is inverse: subscriber acts as relationship target
72 inverse_subscription: [
73 subscribee_subscriptions: :subscriber_users,
74 subscriber_subscriptions: :subscribee_users
80 field(:email, :string)
82 field(:nickname, :string)
83 field(:password_hash, :string)
84 field(:password, :string, virtual: true)
85 field(:password_confirmation, :string, virtual: true)
87 field(:public_key, :string)
88 field(:ap_id, :string)
90 field(:local, :boolean, default: true)
91 field(:follower_address, :string)
92 field(:following_address, :string)
93 field(:search_rank, :float, virtual: true)
94 field(:search_type, :integer, virtual: true)
95 field(:tags, {:array, :string}, default: [])
96 field(:last_refreshed_at, :naive_datetime_usec)
97 field(:last_digest_emailed_at, :naive_datetime)
98 field(:banner, :map, default: %{})
99 field(:background, :map, default: %{})
100 field(:note_count, :integer, default: 0)
101 field(:follower_count, :integer, default: 0)
102 field(:following_count, :integer, default: 0)
103 field(:locked, :boolean, default: false)
104 field(:confirmation_pending, :boolean, default: false)
105 field(:password_reset_pending, :boolean, default: false)
106 field(:confirmation_token, :string, default: nil)
107 field(:default_scope, :string, default: "public")
108 field(:domain_blocks, {:array, :string}, default: [])
109 field(:deactivated, :boolean, default: false)
110 field(:no_rich_text, :boolean, default: false)
111 field(:ap_enabled, :boolean, default: false)
112 field(:is_moderator, :boolean, default: false)
113 field(:is_admin, :boolean, default: false)
114 field(:show_role, :boolean, default: true)
115 field(:settings, :map, default: nil)
116 field(:magic_key, :string, default: nil)
117 field(:uri, Types.Uri, default: nil)
118 field(:hide_followers_count, :boolean, default: false)
119 field(:hide_follows_count, :boolean, default: false)
120 field(:hide_followers, :boolean, default: false)
121 field(:hide_follows, :boolean, default: false)
122 field(:hide_favorites, :boolean, default: true)
123 field(:unread_conversation_count, :integer, default: 0)
124 field(:pinned_activities, {:array, :string}, default: [])
125 field(:email_notifications, :map, default: %{"digest" => false})
126 field(:mascot, :map, default: nil)
127 field(:emoji, :map, default: %{})
128 field(:pleroma_settings_store, :map, default: %{})
129 field(:fields, {:array, :map}, default: [])
130 field(:raw_fields, {:array, :map}, default: [])
131 field(:discoverable, :boolean, default: false)
132 field(:invisible, :boolean, default: false)
133 field(:allow_following_move, :boolean, default: true)
134 field(:skip_thread_containment, :boolean, default: false)
135 field(:actor_type, :string, default: "Person")
136 field(:also_known_as, {:array, :string}, default: [])
137 field(:inbox, :string)
138 field(:shared_inbox, :string)
141 :notification_settings,
142 Pleroma.User.NotificationSetting,
146 has_many(:notifications, Notification)
147 has_many(:registrations, Registration)
148 has_many(:deliveries, Delivery)
150 has_many(:outgoing_relationships, UserRelationship, foreign_key: :source_id)
151 has_many(:incoming_relationships, UserRelationship, foreign_key: :target_id)
153 for {relationship_type,
155 {outgoing_relation, outgoing_relation_target},
156 {incoming_relation, incoming_relation_source}
157 ]} <- @user_relationships_config do
158 # Definitions of `has_many` relations: :blocker_blocks, :muter_mutes, :reblog_muter_mutes,
159 # :notification_muter_mutes, :subscribee_subscriptions
160 has_many(outgoing_relation, UserRelationship,
161 foreign_key: :source_id,
162 where: [relationship_type: relationship_type]
165 # Definitions of `has_many` relations: :blockee_blocks, :mutee_mutes, :reblog_mutee_mutes,
166 # :notification_mutee_mutes, :subscriber_subscriptions
167 has_many(incoming_relation, UserRelationship,
168 foreign_key: :target_id,
169 where: [relationship_type: relationship_type]
172 # Definitions of `has_many` relations: :blocked_users, :muted_users, :reblog_muted_users,
173 # :notification_muted_users, :subscriber_users
174 has_many(outgoing_relation_target, through: [outgoing_relation, :target])
176 # Definitions of `has_many` relations: :blocker_users, :muter_users, :reblog_muter_users,
177 # :notification_muter_users, :subscribee_users
178 has_many(incoming_relation_source, through: [incoming_relation, :source])
181 # `:blocks` is deprecated (replaced with `blocked_users` relation)
182 field(:blocks, {:array, :string}, default: [])
183 # `:mutes` is deprecated (replaced with `muted_users` relation)
184 field(:mutes, {:array, :string}, default: [])
185 # `:muted_reblogs` is deprecated (replaced with `reblog_muted_users` relation)
186 field(:muted_reblogs, {:array, :string}, default: [])
187 # `:muted_notifications` is deprecated (replaced with `notification_muted_users` relation)
188 field(:muted_notifications, {:array, :string}, default: [])
189 # `:subscribers` is deprecated (replaced with `subscriber_users` relation)
190 field(:subscribers, {:array, :string}, default: [])
195 for {_relationship_type, [{_outgoing_relation, outgoing_relation_target}, _]} <-
196 @user_relationships_config do
197 # `def blocked_users_relation/2`, `def muted_users_relation/2`,
198 # `def reblog_muted_users_relation/2`, `def notification_muted_users/2`,
199 # `def subscriber_users/2`
200 def unquote(:"#{outgoing_relation_target}_relation")(user, restrict_deactivated? \\ false) do
201 target_users_query = assoc(user, unquote(outgoing_relation_target))
203 if restrict_deactivated? do
204 restrict_deactivated(target_users_query)
210 # `def blocked_users/2`, `def muted_users/2`, `def reblog_muted_users/2`,
211 # `def notification_muted_users/2`, `def subscriber_users/2`
212 def unquote(outgoing_relation_target)(user, restrict_deactivated? \\ false) do
214 |> apply(unquote(:"#{outgoing_relation_target}_relation"), [
216 restrict_deactivated?
221 # `def blocked_users_ap_ids/2`, `def muted_users_ap_ids/2`, `def reblog_muted_users_ap_ids/2`,
222 # `def notification_muted_users_ap_ids/2`, `def subscriber_users_ap_ids/2`
223 def unquote(:"#{outgoing_relation_target}_ap_ids")(user, restrict_deactivated? \\ false) do
225 |> apply(unquote(:"#{outgoing_relation_target}_relation"), [
227 restrict_deactivated?
229 |> select([u], u.ap_id)
235 Dumps Flake Id to SQL-compatible format (16-byte UUID).
236 E.g. "9pQtDGXuq4p3VlcJEm" -> <<0, 0, 1, 110, 179, 218, 42, 92, 213, 41, 44, 227, 95, 213, 0, 0>>
238 def binary_id(source_id) when is_binary(source_id) do
239 with {:ok, dumped_id} <- FlakeId.Ecto.CompatType.dump(source_id) do
246 def binary_id(source_ids) when is_list(source_ids) do
247 Enum.map(source_ids, &binary_id/1)
250 def binary_id(%User{} = user), do: binary_id(user.id)
252 @doc "Returns status account"
253 @spec account_status(User.t()) :: account_status()
254 def account_status(%User{deactivated: true}), do: :deactivated
255 def account_status(%User{password_reset_pending: true}), do: :password_reset_pending
257 def account_status(%User{confirmation_pending: true}) do
258 case Config.get([:instance, :account_activation_required]) do
259 true -> :confirmation_pending
264 def account_status(%User{}), do: :active
266 @spec visible_for?(User.t(), User.t() | nil) :: boolean()
267 def visible_for?(user, for_user \\ nil)
269 def visible_for?(%User{invisible: true}, _), do: false
271 def visible_for?(%User{id: user_id}, %User{id: user_id}), do: true
273 def visible_for?(%User{local: local} = user, nil) do
279 if Config.get([:restrict_unauthenticated, :profiles, cfg_key]),
281 else: account_status(user) == :active
284 def visible_for?(%User{} = user, for_user) do
285 account_status(user) == :active || superuser?(for_user)
288 def visible_for?(_, _), do: false
290 @spec superuser?(User.t()) :: boolean()
291 def superuser?(%User{local: true, is_admin: true}), do: true
292 def superuser?(%User{local: true, is_moderator: true}), do: true
293 def superuser?(_), do: false
295 @spec invisible?(User.t()) :: boolean()
296 def invisible?(%User{invisible: true}), do: true
297 def invisible?(_), do: false
299 def avatar_url(user, options \\ []) do
301 %{"url" => [%{"href" => href} | _]} -> href
302 _ -> !options[:no_default] && "#{Web.base_url()}/images/avi.png"
306 def banner_url(user, options \\ []) do
308 %{"url" => [%{"href" => href} | _]} -> href
309 _ -> !options[:no_default] && "#{Web.base_url()}/images/banner.png"
313 # Should probably be renamed or removed
314 def ap_id(%User{nickname: nickname}), do: "#{Web.base_url()}/users/#{nickname}"
316 def ap_followers(%User{follower_address: fa}) when is_binary(fa), do: fa
317 def ap_followers(%User{} = user), do: "#{ap_id(user)}/followers"
319 @spec ap_following(User.t()) :: String.t()
320 def ap_following(%User{following_address: fa}) when is_binary(fa), do: fa
321 def ap_following(%User{} = user), do: "#{ap_id(user)}/following"
323 @spec restrict_deactivated(Ecto.Query.t()) :: Ecto.Query.t()
324 def restrict_deactivated(query) do
325 from(u in query, where: u.deactivated != ^true)
328 defdelegate following_count(user), to: FollowingRelationship
330 defp truncate_fields_param(params) do
331 if Map.has_key?(params, :fields) do
332 Map.put(params, :fields, Enum.map(params[:fields], &truncate_field/1))
338 defp truncate_if_exists(params, key, max_length) do
339 if Map.has_key?(params, key) and is_binary(params[key]) do
340 {value, _chopped} = String.split_at(params[key], max_length)
341 Map.put(params, key, value)
347 defp fix_follower_address(%{follower_address: _, following_address: _} = params), do: params
349 defp fix_follower_address(%{nickname: nickname} = params),
350 do: Map.put(params, :follower_address, ap_followers(%User{nickname: nickname}))
352 defp fix_follower_address(params), do: params
354 def remote_user_changeset(struct \\ %User{local: false}, params) do
355 bio_limit = Pleroma.Config.get([:instance, :user_bio_length], 5000)
356 name_limit = Pleroma.Config.get([:instance, :user_name_length], 100)
359 case params[:name] do
360 name when is_binary(name) and byte_size(name) > 0 -> name
361 _ -> params[:nickname]
366 |> Map.put(:name, name)
367 |> Map.put_new(:last_refreshed_at, NaiveDateTime.utc_now())
368 |> truncate_if_exists(:name, name_limit)
369 |> truncate_if_exists(:bio, bio_limit)
370 |> truncate_fields_param()
371 |> fix_follower_address()
396 :hide_followers_count,
407 |> validate_required([:name, :ap_id])
408 |> unique_constraint(:nickname)
409 |> validate_format(:nickname, @email_regex)
410 |> validate_length(:bio, max: bio_limit)
411 |> validate_length(:name, max: name_limit)
412 |> validate_fields(true)
415 def update_changeset(struct, params \\ %{}) do
416 bio_limit = Pleroma.Config.get([:instance, :user_bio_length], 5000)
417 name_limit = Pleroma.Config.get([:instance, :user_name_length], 100)
436 :hide_followers_count,
439 :allow_following_move,
442 :skip_thread_containment,
445 :pleroma_settings_store,
451 |> unique_constraint(:nickname)
452 |> validate_format(:nickname, local_nickname_regex())
453 |> validate_length(:bio, max: bio_limit)
454 |> validate_length(:name, min: 1, max: name_limit)
457 |> put_change_if_present(:bio, &{:ok, parse_bio(&1, struct)})
458 |> put_change_if_present(:avatar, &put_upload(&1, :avatar))
459 |> put_change_if_present(:banner, &put_upload(&1, :banner))
460 |> put_change_if_present(:background, &put_upload(&1, :background))
461 |> put_change_if_present(
462 :pleroma_settings_store,
463 &{:ok, Map.merge(struct.pleroma_settings_store, &1)}
465 |> validate_fields(false)
468 defp put_fields(changeset) do
469 if raw_fields = get_change(changeset, :raw_fields) do
472 |> Enum.filter(fn %{"name" => n} -> n != "" end)
476 |> Enum.map(fn f -> Map.update!(f, "value", &parse_fields(&1)) end)
479 |> put_change(:raw_fields, raw_fields)
480 |> put_change(:fields, fields)
486 defp parse_fields(value) do
488 |> Formatter.linkify(mentions_format: :full)
492 defp put_emoji(changeset) do
493 bio = get_change(changeset, :bio)
494 name = get_change(changeset, :name)
497 emoji = Map.merge(Emoji.Formatter.get_emoji_map(bio), Emoji.Formatter.get_emoji_map(name))
498 put_change(changeset, :emoji, emoji)
504 defp put_change_if_present(changeset, map_field, value_function) do
505 if value = get_change(changeset, map_field) do
506 with {:ok, new_value} <- value_function.(value) do
507 put_change(changeset, map_field, new_value)
516 defp put_upload(value, type) do
517 with %Plug.Upload{} <- value,
518 {:ok, object} <- ActivityPub.upload(value, type: type) do
523 def update_as_admin_changeset(struct, params) do
525 |> update_changeset(params)
526 |> cast(params, [:email])
527 |> delete_change(:also_known_as)
528 |> unique_constraint(:email)
529 |> validate_format(:email, @email_regex)
532 @spec update_as_admin(%User{}, map) :: {:ok, User.t()} | {:error, Ecto.Changeset.t()}
533 def update_as_admin(user, params) do
534 params = Map.put(params, "password_confirmation", params["password"])
535 changeset = update_as_admin_changeset(user, params)
537 if params["password"] do
538 reset_password(user, changeset, params)
540 User.update_and_set_cache(changeset)
544 def password_update_changeset(struct, params) do
546 |> cast(params, [:password, :password_confirmation])
547 |> validate_required([:password, :password_confirmation])
548 |> validate_confirmation(:password)
549 |> put_password_hash()
550 |> put_change(:password_reset_pending, false)
553 @spec reset_password(User.t(), map) :: {:ok, User.t()} | {:error, Ecto.Changeset.t()}
554 def reset_password(%User{} = user, params) do
555 reset_password(user, user, params)
558 def reset_password(%User{id: user_id} = user, struct, params) do
561 |> Multi.update(:user, password_update_changeset(struct, params))
562 |> Multi.delete_all(:tokens, OAuth.Token.Query.get_by_user(user_id))
563 |> Multi.delete_all(:auth, OAuth.Authorization.delete_by_user_query(user))
565 case Repo.transaction(multi) do
566 {:ok, %{user: user} = _} -> set_cache(user)
567 {:error, _, changeset, _} -> {:error, changeset}
571 def update_password_reset_pending(user, value) do
574 |> put_change(:password_reset_pending, value)
575 |> update_and_set_cache()
578 def force_password_reset_async(user) do
579 BackgroundWorker.enqueue("force_password_reset", %{"user_id" => user.id})
582 @spec force_password_reset(User.t()) :: {:ok, User.t()} | {:error, Ecto.Changeset.t()}
583 def force_password_reset(user), do: update_password_reset_pending(user, true)
585 def register_changeset(struct, params \\ %{}, opts \\ []) do
586 bio_limit = Pleroma.Config.get([:instance, :user_bio_length], 5000)
587 name_limit = Pleroma.Config.get([:instance, :user_name_length], 100)
590 if is_nil(opts[:need_confirmation]) do
591 Pleroma.Config.get([:instance, :account_activation_required])
593 opts[:need_confirmation]
597 |> confirmation_changeset(need_confirmation: need_confirmation?)
598 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation, :emoji])
599 |> validate_required([:name, :nickname, :password, :password_confirmation])
600 |> validate_confirmation(:password)
601 |> unique_constraint(:email)
602 |> unique_constraint(:nickname)
603 |> validate_exclusion(:nickname, Pleroma.Config.get([User, :restricted_nicknames]))
604 |> validate_format(:nickname, local_nickname_regex())
605 |> validate_format(:email, @email_regex)
606 |> validate_length(:bio, max: bio_limit)
607 |> validate_length(:name, min: 1, max: name_limit)
608 |> maybe_validate_required_email(opts[:external])
611 |> unique_constraint(:ap_id)
612 |> put_following_and_follower_address()
615 def maybe_validate_required_email(changeset, true), do: changeset
617 def maybe_validate_required_email(changeset, _) do
618 if Pleroma.Config.get([:instance, :account_activation_required]) do
619 validate_required(changeset, [:email])
625 defp put_ap_id(changeset) do
626 ap_id = ap_id(%User{nickname: get_field(changeset, :nickname)})
627 put_change(changeset, :ap_id, ap_id)
630 defp put_following_and_follower_address(changeset) do
631 followers = ap_followers(%User{nickname: get_field(changeset, :nickname)})
634 |> put_change(:follower_address, followers)
637 defp autofollow_users(user) do
638 candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])
641 User.Query.build(%{nickname: candidates, local: true, deactivated: false})
644 follow_all(user, autofollowed_users)
647 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
648 def register(%Ecto.Changeset{} = changeset) do
649 with {:ok, user} <- Repo.insert(changeset) do
650 post_register_action(user)
654 def post_register_action(%User{} = user) do
655 with {:ok, user} <- autofollow_users(user),
656 {:ok, user} <- set_cache(user),
657 {:ok, _} <- User.WelcomeMessage.post_welcome_message_to_user(user),
658 {:ok, _} <- try_send_confirmation_email(user) do
663 def try_send_confirmation_email(%User{} = user) do
664 if user.confirmation_pending &&
665 Pleroma.Config.get([:instance, :account_activation_required]) do
667 |> Pleroma.Emails.UserEmail.account_confirmation_email()
668 |> Pleroma.Emails.Mailer.deliver_async()
676 def try_send_confirmation_email(users) do
677 Enum.each(users, &try_send_confirmation_email/1)
680 def needs_update?(%User{local: true}), do: false
682 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
684 def needs_update?(%User{local: false} = user) do
685 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
688 def needs_update?(_), do: true
690 @spec maybe_direct_follow(User.t(), User.t()) :: {:ok, User.t()} | {:error, String.t()}
692 # "Locked" (self-locked) users demand explicit authorization of follow requests
693 def maybe_direct_follow(%User{} = follower, %User{local: true, locked: true} = followed) do
694 follow(follower, followed, :follow_pending)
697 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
698 follow(follower, followed)
701 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
702 if not ap_enabled?(followed) do
703 follow(follower, followed)
709 @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
710 @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
711 def follow_all(follower, followeds) do
713 |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
714 |> Enum.each(&follow(follower, &1, :follow_accept))
719 defdelegate following(user), to: FollowingRelationship
721 def follow(%User{} = follower, %User{} = followed, state \\ :follow_accept) do
722 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
725 followed.deactivated ->
726 {:error, "Could not follow user: #{followed.nickname} is deactivated."}
728 deny_follow_blocked and blocks?(followed, follower) ->
729 {:error, "Could not follow user: #{followed.nickname} blocked you."}
732 FollowingRelationship.follow(follower, followed, state)
734 {:ok, _} = update_follower_count(followed)
737 |> update_following_count()
742 def unfollow(%User{ap_id: ap_id}, %User{ap_id: ap_id}) do
743 {:error, "Not subscribed!"}
746 def unfollow(%User{} = follower, %User{} = followed) do
747 case get_follow_state(follower, followed) do
748 state when state in [:follow_pending, :follow_accept] ->
749 FollowingRelationship.unfollow(follower, followed)
750 {:ok, followed} = update_follower_count(followed)
754 |> update_following_count()
757 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
760 {:error, "Not subscribed!"}
764 defdelegate following?(follower, followed), to: FollowingRelationship
766 @doc "Returns follow state as Pleroma.FollowingRelationship.State value"
767 def get_follow_state(%User{} = follower, %User{} = following) do
768 following_relationship = FollowingRelationship.get(follower, following)
769 get_follow_state(follower, following, following_relationship)
772 def get_follow_state(
775 following_relationship
777 case {following_relationship, following.local} do
779 case Utils.fetch_latest_follow(follower, following) do
780 %Activity{data: %{"state" => state}} when state in ["pending", "accept"] ->
781 FollowingRelationship.state_to_enum(state)
787 {%{state: state}, _} ->
795 def locked?(%User{} = user) do
800 Repo.get_by(User, id: id)
803 def get_by_ap_id(ap_id) do
804 Repo.get_by(User, ap_id: ap_id)
807 def get_all_by_ap_id(ap_ids) do
808 from(u in __MODULE__,
809 where: u.ap_id in ^ap_ids
814 def get_all_by_ids(ids) do
815 from(u in __MODULE__, where: u.id in ^ids)
819 # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
820 # of the ap_id and the domain and tries to get that user
821 def get_by_guessed_nickname(ap_id) do
822 domain = URI.parse(ap_id).host
823 name = List.last(String.split(ap_id, "/"))
824 nickname = "#{name}@#{domain}"
826 get_cached_by_nickname(nickname)
829 def set_cache({:ok, user}), do: set_cache(user)
830 def set_cache({:error, err}), do: {:error, err}
832 def set_cache(%User{} = user) do
833 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
834 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
838 def update_and_set_cache(struct, params) do
840 |> update_changeset(params)
841 |> update_and_set_cache()
844 def update_and_set_cache(changeset) do
845 with {:ok, user} <- Repo.update(changeset, stale_error_field: :id) do
850 def invalidate_cache(user) do
851 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
852 Cachex.del(:user_cache, "nickname:#{user.nickname}")
855 @spec get_cached_by_ap_id(String.t()) :: User.t() | nil
856 def get_cached_by_ap_id(ap_id) do
857 key = "ap_id:#{ap_id}"
859 with {:ok, nil} <- Cachex.get(:user_cache, key),
860 user when not is_nil(user) <- get_by_ap_id(ap_id),
861 {:ok, true} <- Cachex.put(:user_cache, key, user) do
869 def get_cached_by_id(id) do
873 Cachex.fetch!(:user_cache, key, fn _ ->
877 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
878 {:commit, user.ap_id}
884 get_cached_by_ap_id(ap_id)
887 def get_cached_by_nickname(nickname) do
888 key = "nickname:#{nickname}"
890 Cachex.fetch!(:user_cache, key, fn ->
891 case get_or_fetch_by_nickname(nickname) do
892 {:ok, user} -> {:commit, user}
893 {:error, _error} -> {:ignore, nil}
898 def get_cached_by_nickname_or_id(nickname_or_id, opts \\ []) do
899 restrict_to_local = Pleroma.Config.get([:instance, :limit_to_local_content])
902 is_integer(nickname_or_id) or FlakeId.flake_id?(nickname_or_id) ->
903 get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
905 restrict_to_local == false or not String.contains?(nickname_or_id, "@") ->
906 get_cached_by_nickname(nickname_or_id)
908 restrict_to_local == :unauthenticated and match?(%User{}, opts[:for]) ->
909 get_cached_by_nickname(nickname_or_id)
916 def get_by_nickname(nickname) do
917 Repo.get_by(User, nickname: nickname) ||
918 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
919 Repo.get_by(User, nickname: local_nickname(nickname))
923 def get_by_email(email), do: Repo.get_by(User, email: email)
925 def get_by_nickname_or_email(nickname_or_email) do
926 get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
929 def fetch_by_nickname(nickname), do: ActivityPub.make_user_from_nickname(nickname)
931 def get_or_fetch_by_nickname(nickname) do
932 with %User{} = user <- get_by_nickname(nickname) do
936 with [_nick, _domain] <- String.split(nickname, "@"),
937 {:ok, user} <- fetch_by_nickname(nickname) do
940 _e -> {:error, "not found " <> nickname}
945 @spec get_followers_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
946 def get_followers_query(%User{} = user, nil) do
947 User.Query.build(%{followers: user, deactivated: false})
950 def get_followers_query(user, page) do
952 |> get_followers_query(nil)
953 |> User.Query.paginate(page, 20)
956 @spec get_followers_query(User.t()) :: Ecto.Query.t()
957 def get_followers_query(user), do: get_followers_query(user, nil)
959 @spec get_followers(User.t(), pos_integer() | nil) :: {:ok, list(User.t())}
960 def get_followers(user, page \\ nil) do
962 |> get_followers_query(page)
966 @spec get_external_followers(User.t(), pos_integer() | nil) :: {:ok, list(User.t())}
967 def get_external_followers(user, page \\ nil) do
969 |> get_followers_query(page)
970 |> User.Query.build(%{external: true})
974 def get_followers_ids(user, page \\ nil) do
976 |> get_followers_query(page)
981 @spec get_friends_query(User.t(), pos_integer() | nil) :: Ecto.Query.t()
982 def get_friends_query(%User{} = user, nil) do
983 User.Query.build(%{friends: user, deactivated: false})
986 def get_friends_query(user, page) do
988 |> get_friends_query(nil)
989 |> User.Query.paginate(page, 20)
992 @spec get_friends_query(User.t()) :: Ecto.Query.t()
993 def get_friends_query(user), do: get_friends_query(user, nil)
995 def get_friends(user, page \\ nil) do
997 |> get_friends_query(page)
1001 def get_friends_ap_ids(user) do
1003 |> get_friends_query(nil)
1004 |> select([u], u.ap_id)
1008 def get_friends_ids(user, page \\ nil) do
1010 |> get_friends_query(page)
1011 |> select([u], u.id)
1015 defdelegate get_follow_requests(user), to: FollowingRelationship
1017 def increase_note_count(%User{} = user) do
1019 |> where(id: ^user.id)
1020 |> update([u], inc: [note_count: 1])
1022 |> Repo.update_all([])
1024 {1, [user]} -> set_cache(user)
1029 def decrease_note_count(%User{} = user) do
1031 |> where(id: ^user.id)
1034 note_count: fragment("greatest(0, note_count - 1)")
1038 |> Repo.update_all([])
1040 {1, [user]} -> set_cache(user)
1045 def update_note_count(%User{} = user, note_count \\ nil) do
1050 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
1056 |> cast(%{note_count: note_count}, [:note_count])
1057 |> update_and_set_cache()
1060 @spec maybe_fetch_follow_information(User.t()) :: User.t()
1061 def maybe_fetch_follow_information(user) do
1062 with {:ok, user} <- fetch_follow_information(user) do
1066 Logger.error("Follower/Following counter update for #{user.ap_id} failed.\n#{inspect(e)}")
1072 def fetch_follow_information(user) do
1073 with {:ok, info} <- ActivityPub.fetch_follow_information_for_user(user) do
1075 |> follow_information_changeset(info)
1076 |> update_and_set_cache()
1080 defp follow_information_changeset(user, params) do
1087 :hide_followers_count,
1092 def update_follower_count(%User{} = user) do
1093 if user.local or !Pleroma.Config.get([:instance, :external_user_synchronization]) do
1094 follower_count_query =
1095 User.Query.build(%{followers: user, deactivated: false})
1096 |> select([u], %{count: count(u.id)})
1099 |> where(id: ^user.id)
1100 |> join(:inner, [u], s in subquery(follower_count_query))
1102 set: [follower_count: s.count]
1105 |> Repo.update_all([])
1107 {1, [user]} -> set_cache(user)
1111 {:ok, maybe_fetch_follow_information(user)}
1115 @spec update_following_count(User.t()) :: User.t()
1116 def update_following_count(%User{local: false} = user) do
1117 if Pleroma.Config.get([:instance, :external_user_synchronization]) do
1118 maybe_fetch_follow_information(user)
1124 def update_following_count(%User{local: true} = user) do
1125 following_count = FollowingRelationship.following_count(user)
1128 |> follow_information_changeset(%{following_count: following_count})
1132 def set_unread_conversation_count(%User{local: true} = user) do
1133 unread_query = Participation.unread_conversation_count_for_user(user)
1136 |> join(:inner, [u], p in subquery(unread_query))
1138 set: [unread_conversation_count: p.count]
1140 |> where([u], u.id == ^user.id)
1142 |> Repo.update_all([])
1144 {1, [user]} -> set_cache(user)
1149 def set_unread_conversation_count(user), do: {:ok, user}
1151 def increment_unread_conversation_count(conversation, %User{local: true} = user) do
1153 Participation.unread_conversation_count_for_user(user)
1154 |> where([p], p.conversation_id == ^conversation.id)
1157 |> join(:inner, [u], p in subquery(unread_query))
1159 inc: [unread_conversation_count: 1]
1161 |> where([u], u.id == ^user.id)
1162 |> where([u, p], p.count == 0)
1164 |> Repo.update_all([])
1166 {1, [user]} -> set_cache(user)
1171 def increment_unread_conversation_count(_, user), do: {:ok, user}
1173 @spec get_users_from_set([String.t()], boolean()) :: [User.t()]
1174 def get_users_from_set(ap_ids, local_only \\ true) do
1175 criteria = %{ap_id: ap_ids, deactivated: false}
1176 criteria = if local_only, do: Map.put(criteria, :local, true), else: criteria
1178 User.Query.build(criteria)
1182 @spec get_recipients_from_activity(Activity.t()) :: [User.t()]
1183 def get_recipients_from_activity(%Activity{recipients: to, actor: actor}) do
1186 User.Query.build(%{recipients_from_activity: to, local: true, deactivated: false})
1190 @spec mute(User.t(), User.t(), boolean()) ::
1191 {:ok, list(UserRelationship.t())} | {:error, String.t()}
1192 def mute(%User{} = muter, %User{} = mutee, notifications? \\ true) do
1193 add_to_mutes(muter, mutee, notifications?)
1196 def unmute(%User{} = muter, %User{} = mutee) do
1197 remove_from_mutes(muter, mutee)
1200 def subscribe(%User{} = subscriber, %User{} = target) do
1201 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
1203 if blocks?(target, subscriber) and deny_follow_blocked do
1204 {:error, "Could not subscribe: #{target.nickname} is blocking you"}
1206 # Note: the relationship is inverse: subscriber acts as relationship target
1207 UserRelationship.create_inverse_subscription(target, subscriber)
1211 def subscribe(%User{} = subscriber, %{ap_id: ap_id}) do
1212 with %User{} = subscribee <- get_cached_by_ap_id(ap_id) do
1213 subscribe(subscriber, subscribee)
1217 def unsubscribe(%User{} = unsubscriber, %User{} = target) do
1218 # Note: the relationship is inverse: subscriber acts as relationship target
1219 UserRelationship.delete_inverse_subscription(target, unsubscriber)
1222 def unsubscribe(%User{} = unsubscriber, %{ap_id: ap_id}) do
1223 with %User{} = user <- get_cached_by_ap_id(ap_id) do
1224 unsubscribe(unsubscriber, user)
1228 def block(%User{} = blocker, %User{} = blocked) do
1229 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
1231 if following?(blocker, blocked) do
1232 {:ok, blocker, _} = unfollow(blocker, blocked)
1238 # clear any requested follows as well
1240 case CommonAPI.reject_follow_request(blocked, blocker) do
1241 {:ok, %User{} = updated_blocked} -> updated_blocked
1245 unsubscribe(blocked, blocker)
1247 if following?(blocked, blocker), do: unfollow(blocked, blocker)
1249 {:ok, blocker} = update_follower_count(blocker)
1250 {:ok, blocker, _} = Participation.mark_all_as_read(blocker, blocked)
1251 add_to_block(blocker, blocked)
1254 # helper to handle the block given only an actor's AP id
1255 def block(%User{} = blocker, %{ap_id: ap_id}) do
1256 block(blocker, get_cached_by_ap_id(ap_id))
1259 def unblock(%User{} = blocker, %User{} = blocked) do
1260 remove_from_block(blocker, blocked)
1263 # helper to handle the block given only an actor's AP id
1264 def unblock(%User{} = blocker, %{ap_id: ap_id}) do
1265 unblock(blocker, get_cached_by_ap_id(ap_id))
1268 def mutes?(nil, _), do: false
1269 def mutes?(%User{} = user, %User{} = target), do: mutes_user?(user, target)
1271 def mutes_user?(%User{} = user, %User{} = target) do
1272 UserRelationship.mute_exists?(user, target)
1275 @spec muted_notifications?(User.t() | nil, User.t() | map()) :: boolean()
1276 def muted_notifications?(nil, _), do: false
1278 def muted_notifications?(%User{} = user, %User{} = target),
1279 do: UserRelationship.notification_mute_exists?(user, target)
1281 def blocks?(nil, _), do: false
1283 def blocks?(%User{} = user, %User{} = target) do
1284 blocks_user?(user, target) ||
1285 (blocks_domain?(user, target) and not User.following?(user, target))
1288 def blocks_user?(%User{} = user, %User{} = target) do
1289 UserRelationship.block_exists?(user, target)
1292 def blocks_user?(_, _), do: false
1294 def blocks_domain?(%User{} = user, %User{} = target) do
1295 domain_blocks = Pleroma.Web.ActivityPub.MRF.subdomains_regex(user.domain_blocks)
1296 %{host: host} = URI.parse(target.ap_id)
1297 Pleroma.Web.ActivityPub.MRF.subdomain_match?(domain_blocks, host)
1300 def blocks_domain?(_, _), do: false
1302 def subscribed_to?(%User{} = user, %User{} = target) do
1303 # Note: the relationship is inverse: subscriber acts as relationship target
1304 UserRelationship.inverse_subscription_exists?(target, user)
1307 def subscribed_to?(%User{} = user, %{ap_id: ap_id}) do
1308 with %User{} = target <- get_cached_by_ap_id(ap_id) do
1309 subscribed_to?(user, target)
1314 Returns map of outgoing (blocked, muted etc.) relationships' user AP IDs by relation type.
1315 E.g. `outgoing_relationships_ap_ids(user, [:block])` -> `%{block: ["https://some.site/users/userapid"]}`
1317 @spec outgoing_relationships_ap_ids(User.t(), list(atom())) :: %{atom() => list(String.t())}
1318 def outgoing_relationships_ap_ids(_user, []), do: %{}
1320 def outgoing_relationships_ap_ids(nil, _relationship_types), do: %{}
1322 def outgoing_relationships_ap_ids(%User{} = user, relationship_types)
1323 when is_list(relationship_types) do
1326 |> assoc(:outgoing_relationships)
1327 |> join(:inner, [user_rel], u in assoc(user_rel, :target))
1328 |> where([user_rel, u], user_rel.relationship_type in ^relationship_types)
1329 |> select([user_rel, u], [user_rel.relationship_type, fragment("array_agg(?)", u.ap_id)])
1330 |> group_by([user_rel, u], user_rel.relationship_type)
1332 |> Enum.into(%{}, fn [k, v] -> {k, v} end)
1337 fn rel_type -> {rel_type, db_result[rel_type] || []} end
1341 def incoming_relationships_ungrouped_ap_ids(user, relationship_types, ap_ids \\ nil)
1343 def incoming_relationships_ungrouped_ap_ids(_user, [], _ap_ids), do: []
1345 def incoming_relationships_ungrouped_ap_ids(nil, _relationship_types, _ap_ids), do: []
1347 def incoming_relationships_ungrouped_ap_ids(%User{} = user, relationship_types, ap_ids)
1348 when is_list(relationship_types) do
1350 |> assoc(:incoming_relationships)
1351 |> join(:inner, [user_rel], u in assoc(user_rel, :source))
1352 |> where([user_rel, u], user_rel.relationship_type in ^relationship_types)
1353 |> maybe_filter_on_ap_id(ap_ids)
1354 |> select([user_rel, u], u.ap_id)
1359 defp maybe_filter_on_ap_id(query, ap_ids) when is_list(ap_ids) do
1360 where(query, [user_rel, u], u.ap_id in ^ap_ids)
1363 defp maybe_filter_on_ap_id(query, _ap_ids), do: query
1365 def deactivate_async(user, status \\ true) do
1366 BackgroundWorker.enqueue("deactivate_user", %{"user_id" => user.id, "status" => status})
1369 def deactivate(user, status \\ true)
1371 def deactivate(users, status) when is_list(users) do
1372 Repo.transaction(fn ->
1373 for user <- users, do: deactivate(user, status)
1377 def deactivate(%User{} = user, status) do
1378 with {:ok, user} <- set_activation_status(user, status) do
1381 |> Enum.filter(& &1.local)
1382 |> Enum.each(fn follower ->
1383 follower |> update_following_count() |> set_cache()
1386 # Only update local user counts, remote will be update during the next pull.
1389 |> Enum.filter(& &1.local)
1390 |> Enum.each(&update_follower_count/1)
1396 def update_notification_settings(%User{} = user, settings) do
1398 |> cast(%{notification_settings: settings}, [])
1399 |> cast_embed(:notification_settings)
1400 |> validate_required([:notification_settings])
1401 |> update_and_set_cache()
1404 def delete(users) when is_list(users) do
1405 for user <- users, do: delete(user)
1408 def delete(%User{} = user) do
1409 BackgroundWorker.enqueue("delete_user", %{"user_id" => user.id})
1412 def perform(:force_password_reset, user), do: force_password_reset(user)
1414 @spec perform(atom(), User.t()) :: {:ok, User.t()}
1415 def perform(:delete, %User{} = user) do
1416 {:ok, _user} = ActivityPub.delete(user)
1418 # Remove all relationships
1421 |> Enum.each(fn follower ->
1422 ActivityPub.unfollow(follower, user)
1423 unfollow(follower, user)
1428 |> Enum.each(fn followed ->
1429 ActivityPub.unfollow(user, followed)
1430 unfollow(user, followed)
1433 delete_user_activities(user)
1434 invalidate_cache(user)
1438 def perform(:deactivate_async, user, status), do: deactivate(user, status)
1440 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
1441 def perform(:blocks_import, %User{} = blocker, blocked_identifiers)
1442 when is_list(blocked_identifiers) do
1444 blocked_identifiers,
1445 fn blocked_identifier ->
1446 with {:ok, %User{} = blocked} <- get_or_fetch(blocked_identifier),
1447 {:ok, _user_block} <- block(blocker, blocked),
1448 {:ok, _} <- ActivityPub.block(blocker, blocked) do
1452 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
1459 def perform(:follow_import, %User{} = follower, followed_identifiers)
1460 when is_list(followed_identifiers) do
1462 followed_identifiers,
1463 fn followed_identifier ->
1464 with {:ok, %User{} = followed} <- get_or_fetch(followed_identifier),
1465 {:ok, follower} <- maybe_direct_follow(follower, followed),
1466 {:ok, _} <- ActivityPub.follow(follower, followed) do
1470 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
1477 @spec external_users_query() :: Ecto.Query.t()
1478 def external_users_query do
1486 @spec external_users(keyword()) :: [User.t()]
1487 def external_users(opts \\ []) do
1489 external_users_query()
1490 |> select([u], struct(u, [:id, :ap_id]))
1494 do: where(query, [u], u.id > ^opts[:max_id]),
1499 do: limit(query, ^opts[:limit]),
1505 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
1506 BackgroundWorker.enqueue("blocks_import", %{
1507 "blocker_id" => blocker.id,
1508 "blocked_identifiers" => blocked_identifiers
1512 def follow_import(%User{} = follower, followed_identifiers)
1513 when is_list(followed_identifiers) do
1514 BackgroundWorker.enqueue("follow_import", %{
1515 "follower_id" => follower.id,
1516 "followed_identifiers" => followed_identifiers
1520 def delete_user_activities(%User{ap_id: ap_id}) do
1522 |> Activity.Queries.by_actor()
1523 |> RepoStreamer.chunk_stream(50)
1524 |> Stream.each(fn activities -> Enum.each(activities, &delete_activity/1) end)
1528 defp delete_activity(%{data: %{"type" => "Create"}} = activity) do
1530 |> Object.normalize()
1531 |> ActivityPub.delete()
1534 defp delete_activity(%{data: %{"type" => "Like"}} = activity) do
1535 object = Object.normalize(activity)
1538 |> get_cached_by_ap_id()
1539 |> ActivityPub.unlike(object)
1542 defp delete_activity(%{data: %{"type" => "Announce"}} = activity) do
1543 object = Object.normalize(activity)
1546 |> get_cached_by_ap_id()
1547 |> ActivityPub.unannounce(object)
1550 defp delete_activity(_activity), do: "Doing nothing"
1552 def html_filter_policy(%User{no_rich_text: true}) do
1553 Pleroma.HTML.Scrubber.TwitterText
1556 def html_filter_policy(_), do: Pleroma.Config.get([:markup, :scrub_policy])
1558 def fetch_by_ap_id(ap_id), do: ActivityPub.make_user_from_ap_id(ap_id)
1560 def get_or_fetch_by_ap_id(ap_id) do
1561 user = get_cached_by_ap_id(ap_id)
1563 if !is_nil(user) and !needs_update?(user) do
1566 fetch_by_ap_id(ap_id)
1571 Creates an internal service actor by URI if missing.
1572 Optionally takes nickname for addressing.
1574 @spec get_or_create_service_actor_by_ap_id(String.t(), String.t()) :: User.t() | nil
1575 def get_or_create_service_actor_by_ap_id(uri, nickname) do
1577 case get_cached_by_ap_id(uri) do
1579 with {:error, %{errors: errors}} <- create_service_actor(uri, nickname) do
1580 Logger.error("Cannot create service actor: #{uri}/.\n#{inspect(errors)}")
1584 %User{invisible: false} = user ->
1594 @spec set_invisible(User.t()) :: {:ok, User.t()}
1595 defp set_invisible(user) do
1597 |> change(%{invisible: true})
1598 |> update_and_set_cache()
1601 @spec create_service_actor(String.t(), String.t()) ::
1602 {:ok, User.t()} | {:error, Ecto.Changeset.t()}
1603 defp create_service_actor(uri, nickname) do
1609 follower_address: uri <> "/followers"
1612 |> unique_constraint(:nickname)
1617 def public_key(%{public_key: public_key_pem}) when is_binary(public_key_pem) do
1620 |> :public_key.pem_decode()
1622 |> :public_key.pem_entry_decode()
1627 def public_key(_), do: {:error, "key not found"}
1629 def get_public_key_for_ap_id(ap_id) do
1630 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id),
1631 {:ok, public_key} <- public_key(user) do
1638 def ap_enabled?(%User{local: true}), do: true
1639 def ap_enabled?(%User{ap_enabled: ap_enabled}), do: ap_enabled
1640 def ap_enabled?(_), do: false
1642 @doc "Gets or fetch a user by uri or nickname."
1643 @spec get_or_fetch(String.t()) :: {:ok, User.t()} | {:error, String.t()}
1644 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1645 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1647 # wait a period of time and return newest version of the User structs
1648 # this is because we have synchronous follow APIs and need to simulate them
1649 # with an async handshake
1650 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1651 with %User{} = a <- get_cached_by_id(a.id),
1652 %User{} = b <- get_cached_by_id(b.id) do
1659 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1660 with :ok <- :timer.sleep(timeout),
1661 %User{} = a <- get_cached_by_id(a.id),
1662 %User{} = b <- get_cached_by_id(b.id) do
1669 def parse_bio(bio) when is_binary(bio) and bio != "" do
1671 |> CommonUtils.format_input("text/plain", mentions_format: :full)
1675 def parse_bio(_), do: ""
1677 def parse_bio(bio, user) when is_binary(bio) and bio != "" do
1678 # TODO: get profile URLs other than user.ap_id
1679 profile_urls = [user.ap_id]
1682 |> CommonUtils.format_input("text/plain",
1683 mentions_format: :full,
1684 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1689 def parse_bio(_, _), do: ""
1691 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1692 Repo.transaction(fn ->
1693 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1697 def tag(nickname, tags) when is_binary(nickname),
1698 do: tag(get_by_nickname(nickname), tags)
1700 def tag(%User{} = user, tags),
1701 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1703 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1704 Repo.transaction(fn ->
1705 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1709 def untag(nickname, tags) when is_binary(nickname),
1710 do: untag(get_by_nickname(nickname), tags)
1712 def untag(%User{} = user, tags),
1713 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1715 defp update_tags(%User{} = user, new_tags) do
1716 {:ok, updated_user} =
1718 |> change(%{tags: new_tags})
1719 |> update_and_set_cache()
1724 defp normalize_tags(tags) do
1727 |> Enum.map(&String.downcase/1)
1730 defp local_nickname_regex do
1731 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1732 @extended_local_nickname_regex
1734 @strict_local_nickname_regex
1738 def local_nickname(nickname_or_mention) do
1741 |> String.split("@")
1745 def full_nickname(nickname_or_mention),
1746 do: String.trim_leading(nickname_or_mention, "@")
1748 def error_user(ap_id) do
1752 nickname: "erroruser@example.com",
1753 inserted_at: NaiveDateTime.utc_now()
1757 @spec all_superusers() :: [User.t()]
1758 def all_superusers do
1759 User.Query.build(%{super_users: true, local: true, deactivated: false})
1763 def muting_reblogs?(%User{} = user, %User{} = target) do
1764 UserRelationship.reblog_mute_exists?(user, target)
1767 def showing_reblogs?(%User{} = user, %User{} = target) do
1768 not muting_reblogs?(user, target)
1772 The function returns a query to get users with no activity for given interval of days.
1773 Inactive users are those who didn't read any notification, or had any activity where
1774 the user is the activity's actor, during `inactivity_threshold` days.
1775 Deactivated users will not appear in this list.
1779 iex> Pleroma.User.list_inactive_users()
1782 @spec list_inactive_users_query(integer()) :: Ecto.Query.t()
1783 def list_inactive_users_query(inactivity_threshold \\ 7) do
1784 negative_inactivity_threshold = -inactivity_threshold
1785 now = NaiveDateTime.truncate(NaiveDateTime.utc_now(), :second)
1786 # Subqueries are not supported in `where` clauses, join gets too complicated.
1787 has_read_notifications =
1788 from(n in Pleroma.Notification,
1789 where: n.seen == true,
1791 having: max(n.updated_at) > datetime_add(^now, ^negative_inactivity_threshold, "day"),
1794 |> Pleroma.Repo.all()
1796 from(u in Pleroma.User,
1797 left_join: a in Pleroma.Activity,
1798 on: u.ap_id == a.actor,
1799 where: not is_nil(u.nickname),
1800 where: u.deactivated != ^true,
1801 where: u.id not in ^has_read_notifications,
1804 max(a.inserted_at) < datetime_add(^now, ^negative_inactivity_threshold, "day") or
1805 is_nil(max(a.inserted_at))
1810 Enable or disable email notifications for user
1814 iex> Pleroma.User.switch_email_notifications(Pleroma.User{email_notifications: %{"digest" => false}}, "digest", true)
1815 Pleroma.User{email_notifications: %{"digest" => true}}
1817 iex> Pleroma.User.switch_email_notifications(Pleroma.User{email_notifications: %{"digest" => true}}, "digest", false)
1818 Pleroma.User{email_notifications: %{"digest" => false}}
1820 @spec switch_email_notifications(t(), String.t(), boolean()) ::
1821 {:ok, t()} | {:error, Ecto.Changeset.t()}
1822 def switch_email_notifications(user, type, status) do
1823 User.update_email_notifications(user, %{type => status})
1827 Set `last_digest_emailed_at` value for the user to current time
1829 @spec touch_last_digest_emailed_at(t()) :: t()
1830 def touch_last_digest_emailed_at(user) do
1831 now = NaiveDateTime.truncate(NaiveDateTime.utc_now(), :second)
1833 {:ok, updated_user} =
1835 |> change(%{last_digest_emailed_at: now})
1836 |> update_and_set_cache()
1841 @spec toggle_confirmation(User.t()) :: {:ok, User.t()} | {:error, Changeset.t()}
1842 def toggle_confirmation(%User{} = user) do
1844 |> confirmation_changeset(need_confirmation: !user.confirmation_pending)
1845 |> update_and_set_cache()
1848 @spec toggle_confirmation([User.t()]) :: [{:ok, User.t()} | {:error, Changeset.t()}]
1849 def toggle_confirmation(users) do
1850 Enum.map(users, &toggle_confirmation/1)
1853 def get_mascot(%{mascot: %{} = mascot}) when not is_nil(mascot) do
1857 def get_mascot(%{mascot: mascot}) when is_nil(mascot) do
1858 # use instance-default
1859 config = Pleroma.Config.get([:assets, :mascots])
1860 default_mascot = Pleroma.Config.get([:assets, :default_mascot])
1861 mascot = Keyword.get(config, default_mascot)
1864 "id" => "default-mascot",
1865 "url" => mascot[:url],
1866 "preview_url" => mascot[:url],
1868 "mime_type" => mascot[:mime_type]
1873 def ensure_keys_present(%{keys: keys} = user) when not is_nil(keys), do: {:ok, user}
1875 def ensure_keys_present(%User{} = user) do
1876 with {:ok, pem} <- Keys.generate_rsa_pem() do
1878 |> cast(%{keys: pem}, [:keys])
1879 |> validate_required([:keys])
1880 |> update_and_set_cache()
1884 def get_ap_ids_by_nicknames(nicknames) do
1886 where: u.nickname in ^nicknames,
1892 defdelegate search(query, opts \\ []), to: User.Search
1894 defp put_password_hash(
1895 %Ecto.Changeset{valid?: true, changes: %{password: password}} = changeset
1897 change(changeset, password_hash: Pbkdf2.hashpwsalt(password))
1900 defp put_password_hash(changeset), do: changeset
1902 def is_internal_user?(%User{nickname: nil}), do: true
1903 def is_internal_user?(%User{local: true, nickname: "internal." <> _}), do: true
1904 def is_internal_user?(_), do: false
1906 # A hack because user delete activities have a fake id for whatever reason
1907 # TODO: Get rid of this
1908 def get_delivered_users_by_object_id("pleroma:fake_object_id"), do: []
1910 def get_delivered_users_by_object_id(object_id) do
1912 inner_join: delivery in assoc(u, :deliveries),
1913 where: delivery.object_id == ^object_id
1918 def change_email(user, email) do
1920 |> cast(%{email: email}, [:email])
1921 |> validate_required([:email])
1922 |> unique_constraint(:email)
1923 |> validate_format(:email, @email_regex)
1924 |> update_and_set_cache()
1927 # Internal function; public one is `deactivate/2`
1928 defp set_activation_status(user, deactivated) do
1930 |> cast(%{deactivated: deactivated}, [:deactivated])
1931 |> update_and_set_cache()
1934 def update_banner(user, banner) do
1936 |> cast(%{banner: banner}, [:banner])
1937 |> update_and_set_cache()
1940 def update_background(user, background) do
1942 |> cast(%{background: background}, [:background])
1943 |> update_and_set_cache()
1946 def roles(%{is_moderator: is_moderator, is_admin: is_admin}) do
1949 moderator: is_moderator
1953 def validate_fields(changeset, remote? \\ false) do
1954 limit_name = if remote?, do: :max_remote_account_fields, else: :max_account_fields
1955 limit = Pleroma.Config.get([:instance, limit_name], 0)
1958 |> validate_length(:fields, max: limit)
1959 |> validate_change(:fields, fn :fields, fields ->
1960 if Enum.all?(fields, &valid_field?/1) do
1968 defp valid_field?(%{"name" => name, "value" => value}) do
1969 name_limit = Pleroma.Config.get([:instance, :account_field_name_length], 255)
1970 value_limit = Pleroma.Config.get([:instance, :account_field_value_length], 255)
1972 is_binary(name) && is_binary(value) && String.length(name) <= name_limit &&
1973 String.length(value) <= value_limit
1976 defp valid_field?(_), do: false
1978 defp truncate_field(%{"name" => name, "value" => value}) do
1980 String.split_at(name, Pleroma.Config.get([:instance, :account_field_name_length], 255))
1983 String.split_at(value, Pleroma.Config.get([:instance, :account_field_value_length], 255))
1985 %{"name" => name, "value" => value}
1988 def admin_api_update(user, params) do
1995 |> update_and_set_cache()
1998 @doc "Signs user out of all applications"
1999 def global_sign_out(user) do
2000 OAuth.Authorization.delete_user_authorizations(user)
2001 OAuth.Token.delete_user_tokens(user)
2004 def mascot_update(user, url) do
2006 |> cast(%{mascot: url}, [:mascot])
2007 |> validate_required([:mascot])
2008 |> update_and_set_cache()
2011 def mastodon_settings_update(user, settings) do
2013 |> cast(%{settings: settings}, [:settings])
2014 |> validate_required([:settings])
2015 |> update_and_set_cache()
2018 @spec confirmation_changeset(User.t(), keyword()) :: Changeset.t()
2019 def confirmation_changeset(user, need_confirmation: need_confirmation?) do
2021 if need_confirmation? do
2023 confirmation_pending: true,
2024 confirmation_token: :crypto.strong_rand_bytes(32) |> Base.url_encode64()
2028 confirmation_pending: false,
2029 confirmation_token: nil
2033 cast(user, params, [:confirmation_pending, :confirmation_token])
2036 def add_pinnned_activity(user, %Pleroma.Activity{id: id}) do
2037 if id not in user.pinned_activities do
2038 max_pinned_statuses = Pleroma.Config.get([:instance, :max_pinned_statuses], 0)
2039 params = %{pinned_activities: user.pinned_activities ++ [id]}
2042 |> cast(params, [:pinned_activities])
2043 |> validate_length(:pinned_activities,
2044 max: max_pinned_statuses,
2045 message: "You have already pinned the maximum number of statuses"
2050 |> update_and_set_cache()
2053 def remove_pinnned_activity(user, %Pleroma.Activity{id: id}) do
2054 params = %{pinned_activities: List.delete(user.pinned_activities, id)}
2057 |> cast(params, [:pinned_activities])
2058 |> update_and_set_cache()
2061 def update_email_notifications(user, settings) do
2062 email_notifications =
2063 user.email_notifications
2064 |> Map.merge(settings)
2065 |> Map.take(["digest"])
2067 params = %{email_notifications: email_notifications}
2068 fields = [:email_notifications]
2071 |> cast(params, fields)
2072 |> validate_required(fields)
2073 |> update_and_set_cache()
2076 defp set_domain_blocks(user, domain_blocks) do
2077 params = %{domain_blocks: domain_blocks}
2080 |> cast(params, [:domain_blocks])
2081 |> validate_required([:domain_blocks])
2082 |> update_and_set_cache()
2085 def block_domain(user, domain_blocked) do
2086 set_domain_blocks(user, Enum.uniq([domain_blocked | user.domain_blocks]))
2089 def unblock_domain(user, domain_blocked) do
2090 set_domain_blocks(user, List.delete(user.domain_blocks, domain_blocked))
2093 @spec add_to_block(User.t(), User.t()) ::
2094 {:ok, UserRelationship.t()} | {:error, Ecto.Changeset.t()}
2095 defp add_to_block(%User{} = user, %User{} = blocked) do
2096 UserRelationship.create_block(user, blocked)
2099 @spec add_to_block(User.t(), User.t()) ::
2100 {:ok, UserRelationship.t()} | {:ok, nil} | {:error, Ecto.Changeset.t()}
2101 defp remove_from_block(%User{} = user, %User{} = blocked) do
2102 UserRelationship.delete_block(user, blocked)
2105 defp add_to_mutes(%User{} = user, %User{} = muted_user, notifications?) do
2106 with {:ok, user_mute} <- UserRelationship.create_mute(user, muted_user),
2107 {:ok, user_notification_mute} <-
2108 (notifications? && UserRelationship.create_notification_mute(user, muted_user)) ||
2110 {:ok, Enum.filter([user_mute, user_notification_mute], & &1)}
2114 defp remove_from_mutes(user, %User{} = muted_user) do
2115 with {:ok, user_mute} <- UserRelationship.delete_mute(user, muted_user),
2116 {:ok, user_notification_mute} <-
2117 UserRelationship.delete_notification_mute(user, muted_user) do
2118 {:ok, [user_mute, user_notification_mute]}
2122 def set_invisible(user, invisible) do
2123 params = %{invisible: invisible}
2126 |> cast(params, [:invisible])
2127 |> validate_required([:invisible])
2128 |> update_and_set_cache()
2131 def sanitize_html(%User{} = user) do
2132 sanitize_html(user, nil)
2135 # User data that mastodon isn't filtering (treated as plaintext):
2138 def sanitize_html(%User{} = user, filter) do
2140 Enum.map(user.fields, fn %{"name" => name, "value" => value} ->
2143 "value" => HTML.filter_tags(value, Pleroma.HTML.Scrubber.LinksOnly)
2148 |> Map.put(:bio, HTML.filter_tags(user.bio, filter))
2149 |> Map.put(:fields, fields)