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}) do
1184 User.Query.build(%{recipients_from_activity: to, local: true, deactivated: false})
1188 @spec mute(User.t(), User.t(), boolean()) ::
1189 {:ok, list(UserRelationship.t())} | {:error, String.t()}
1190 def mute(%User{} = muter, %User{} = mutee, notifications? \\ true) do
1191 add_to_mutes(muter, mutee, notifications?)
1194 def unmute(%User{} = muter, %User{} = mutee) do
1195 remove_from_mutes(muter, mutee)
1198 def subscribe(%User{} = subscriber, %User{} = target) do
1199 deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
1201 if blocks?(target, subscriber) and deny_follow_blocked do
1202 {:error, "Could not subscribe: #{target.nickname} is blocking you"}
1204 # Note: the relationship is inverse: subscriber acts as relationship target
1205 UserRelationship.create_inverse_subscription(target, subscriber)
1209 def subscribe(%User{} = subscriber, %{ap_id: ap_id}) do
1210 with %User{} = subscribee <- get_cached_by_ap_id(ap_id) do
1211 subscribe(subscriber, subscribee)
1215 def unsubscribe(%User{} = unsubscriber, %User{} = target) do
1216 # Note: the relationship is inverse: subscriber acts as relationship target
1217 UserRelationship.delete_inverse_subscription(target, unsubscriber)
1220 def unsubscribe(%User{} = unsubscriber, %{ap_id: ap_id}) do
1221 with %User{} = user <- get_cached_by_ap_id(ap_id) do
1222 unsubscribe(unsubscriber, user)
1226 def block(%User{} = blocker, %User{} = blocked) do
1227 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
1229 if following?(blocker, blocked) do
1230 {:ok, blocker, _} = unfollow(blocker, blocked)
1236 # clear any requested follows as well
1238 case CommonAPI.reject_follow_request(blocked, blocker) do
1239 {:ok, %User{} = updated_blocked} -> updated_blocked
1243 unsubscribe(blocked, blocker)
1245 if following?(blocked, blocker), do: unfollow(blocked, blocker)
1247 {:ok, blocker} = update_follower_count(blocker)
1248 {:ok, blocker, _} = Participation.mark_all_as_read(blocker, blocked)
1249 add_to_block(blocker, blocked)
1252 # helper to handle the block given only an actor's AP id
1253 def block(%User{} = blocker, %{ap_id: ap_id}) do
1254 block(blocker, get_cached_by_ap_id(ap_id))
1257 def unblock(%User{} = blocker, %User{} = blocked) do
1258 remove_from_block(blocker, blocked)
1261 # helper to handle the block given only an actor's AP id
1262 def unblock(%User{} = blocker, %{ap_id: ap_id}) do
1263 unblock(blocker, get_cached_by_ap_id(ap_id))
1266 def mutes?(nil, _), do: false
1267 def mutes?(%User{} = user, %User{} = target), do: mutes_user?(user, target)
1269 def mutes_user?(%User{} = user, %User{} = target) do
1270 UserRelationship.mute_exists?(user, target)
1273 @spec muted_notifications?(User.t() | nil, User.t() | map()) :: boolean()
1274 def muted_notifications?(nil, _), do: false
1276 def muted_notifications?(%User{} = user, %User{} = target),
1277 do: UserRelationship.notification_mute_exists?(user, target)
1279 def blocks?(nil, _), do: false
1281 def blocks?(%User{} = user, %User{} = target) do
1282 blocks_user?(user, target) ||
1283 (blocks_domain?(user, target) and not User.following?(user, target))
1286 def blocks_user?(%User{} = user, %User{} = target) do
1287 UserRelationship.block_exists?(user, target)
1290 def blocks_user?(_, _), do: false
1292 def blocks_domain?(%User{} = user, %User{} = target) do
1293 domain_blocks = Pleroma.Web.ActivityPub.MRF.subdomains_regex(user.domain_blocks)
1294 %{host: host} = URI.parse(target.ap_id)
1295 Pleroma.Web.ActivityPub.MRF.subdomain_match?(domain_blocks, host)
1298 def blocks_domain?(_, _), do: false
1300 def subscribed_to?(%User{} = user, %User{} = target) do
1301 # Note: the relationship is inverse: subscriber acts as relationship target
1302 UserRelationship.inverse_subscription_exists?(target, user)
1305 def subscribed_to?(%User{} = user, %{ap_id: ap_id}) do
1306 with %User{} = target <- get_cached_by_ap_id(ap_id) do
1307 subscribed_to?(user, target)
1312 Returns map of outgoing (blocked, muted etc.) relationships' user AP IDs by relation type.
1313 E.g. `outgoing_relationships_ap_ids(user, [:block])` -> `%{block: ["https://some.site/users/userapid"]}`
1315 @spec outgoing_relationships_ap_ids(User.t(), list(atom())) :: %{atom() => list(String.t())}
1316 def outgoing_relationships_ap_ids(_user, []), do: %{}
1318 def outgoing_relationships_ap_ids(nil, _relationship_types), do: %{}
1320 def outgoing_relationships_ap_ids(%User{} = user, relationship_types)
1321 when is_list(relationship_types) do
1324 |> assoc(:outgoing_relationships)
1325 |> join(:inner, [user_rel], u in assoc(user_rel, :target))
1326 |> where([user_rel, u], user_rel.relationship_type in ^relationship_types)
1327 |> select([user_rel, u], [user_rel.relationship_type, fragment("array_agg(?)", u.ap_id)])
1328 |> group_by([user_rel, u], user_rel.relationship_type)
1330 |> Enum.into(%{}, fn [k, v] -> {k, v} end)
1335 fn rel_type -> {rel_type, db_result[rel_type] || []} end
1339 def incoming_relationships_ungrouped_ap_ids(user, relationship_types, ap_ids \\ nil)
1341 def incoming_relationships_ungrouped_ap_ids(_user, [], _ap_ids), do: []
1343 def incoming_relationships_ungrouped_ap_ids(nil, _relationship_types, _ap_ids), do: []
1345 def incoming_relationships_ungrouped_ap_ids(%User{} = user, relationship_types, ap_ids)
1346 when is_list(relationship_types) do
1348 |> assoc(:incoming_relationships)
1349 |> join(:inner, [user_rel], u in assoc(user_rel, :source))
1350 |> where([user_rel, u], user_rel.relationship_type in ^relationship_types)
1351 |> maybe_filter_on_ap_id(ap_ids)
1352 |> select([user_rel, u], u.ap_id)
1357 defp maybe_filter_on_ap_id(query, ap_ids) when is_list(ap_ids) do
1358 where(query, [user_rel, u], u.ap_id in ^ap_ids)
1361 defp maybe_filter_on_ap_id(query, _ap_ids), do: query
1363 def deactivate_async(user, status \\ true) do
1364 BackgroundWorker.enqueue("deactivate_user", %{"user_id" => user.id, "status" => status})
1367 def deactivate(user, status \\ true)
1369 def deactivate(users, status) when is_list(users) do
1370 Repo.transaction(fn ->
1371 for user <- users, do: deactivate(user, status)
1375 def deactivate(%User{} = user, status) do
1376 with {:ok, user} <- set_activation_status(user, status) do
1379 |> Enum.filter(& &1.local)
1380 |> Enum.each(fn follower ->
1381 follower |> update_following_count() |> set_cache()
1384 # Only update local user counts, remote will be update during the next pull.
1387 |> Enum.filter(& &1.local)
1388 |> Enum.each(&update_follower_count/1)
1394 def update_notification_settings(%User{} = user, settings) do
1396 |> cast(%{notification_settings: settings}, [])
1397 |> cast_embed(:notification_settings)
1398 |> validate_required([:notification_settings])
1399 |> update_and_set_cache()
1402 def delete(users) when is_list(users) do
1403 for user <- users, do: delete(user)
1406 def delete(%User{} = user) do
1407 BackgroundWorker.enqueue("delete_user", %{"user_id" => user.id})
1410 def perform(:force_password_reset, user), do: force_password_reset(user)
1412 @spec perform(atom(), User.t()) :: {:ok, User.t()}
1413 def perform(:delete, %User{} = user) do
1414 {:ok, _user} = ActivityPub.delete(user)
1416 # Remove all relationships
1419 |> Enum.each(fn follower ->
1420 ActivityPub.unfollow(follower, user)
1421 unfollow(follower, user)
1426 |> Enum.each(fn followed ->
1427 ActivityPub.unfollow(user, followed)
1428 unfollow(user, followed)
1431 delete_user_activities(user)
1432 invalidate_cache(user)
1436 def perform(:deactivate_async, user, status), do: deactivate(user, status)
1438 @spec perform(atom(), User.t(), list()) :: list() | {:error, any()}
1439 def perform(:blocks_import, %User{} = blocker, blocked_identifiers)
1440 when is_list(blocked_identifiers) do
1442 blocked_identifiers,
1443 fn blocked_identifier ->
1444 with {:ok, %User{} = blocked} <- get_or_fetch(blocked_identifier),
1445 {:ok, _user_block} <- block(blocker, blocked),
1446 {:ok, _} <- ActivityPub.block(blocker, blocked) do
1450 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
1457 def perform(:follow_import, %User{} = follower, followed_identifiers)
1458 when is_list(followed_identifiers) do
1460 followed_identifiers,
1461 fn followed_identifier ->
1462 with {:ok, %User{} = followed} <- get_or_fetch(followed_identifier),
1463 {:ok, follower} <- maybe_direct_follow(follower, followed),
1464 {:ok, _} <- ActivityPub.follow(follower, followed) do
1468 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
1475 @spec external_users_query() :: Ecto.Query.t()
1476 def external_users_query do
1484 @spec external_users(keyword()) :: [User.t()]
1485 def external_users(opts \\ []) do
1487 external_users_query()
1488 |> select([u], struct(u, [:id, :ap_id]))
1492 do: where(query, [u], u.id > ^opts[:max_id]),
1497 do: limit(query, ^opts[:limit]),
1503 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
1504 BackgroundWorker.enqueue("blocks_import", %{
1505 "blocker_id" => blocker.id,
1506 "blocked_identifiers" => blocked_identifiers
1510 def follow_import(%User{} = follower, followed_identifiers)
1511 when is_list(followed_identifiers) do
1512 BackgroundWorker.enqueue("follow_import", %{
1513 "follower_id" => follower.id,
1514 "followed_identifiers" => followed_identifiers
1518 def delete_user_activities(%User{ap_id: ap_id}) do
1520 |> Activity.Queries.by_actor()
1521 |> RepoStreamer.chunk_stream(50)
1522 |> Stream.each(fn activities -> Enum.each(activities, &delete_activity/1) end)
1526 defp delete_activity(%{data: %{"type" => "Create"}} = activity) do
1528 |> Object.normalize()
1529 |> ActivityPub.delete()
1532 defp delete_activity(%{data: %{"type" => "Like"}} = activity) do
1533 object = Object.normalize(activity)
1536 |> get_cached_by_ap_id()
1537 |> ActivityPub.unlike(object)
1540 defp delete_activity(%{data: %{"type" => "Announce"}} = activity) do
1541 object = Object.normalize(activity)
1544 |> get_cached_by_ap_id()
1545 |> ActivityPub.unannounce(object)
1548 defp delete_activity(_activity), do: "Doing nothing"
1550 def html_filter_policy(%User{no_rich_text: true}) do
1551 Pleroma.HTML.Scrubber.TwitterText
1554 def html_filter_policy(_), do: Pleroma.Config.get([:markup, :scrub_policy])
1556 def fetch_by_ap_id(ap_id), do: ActivityPub.make_user_from_ap_id(ap_id)
1558 def get_or_fetch_by_ap_id(ap_id) do
1559 user = get_cached_by_ap_id(ap_id)
1561 if !is_nil(user) and !needs_update?(user) do
1564 fetch_by_ap_id(ap_id)
1569 Creates an internal service actor by URI if missing.
1570 Optionally takes nickname for addressing.
1572 @spec get_or_create_service_actor_by_ap_id(String.t(), String.t()) :: User.t() | nil
1573 def get_or_create_service_actor_by_ap_id(uri, nickname) do
1575 case get_cached_by_ap_id(uri) do
1577 with {:error, %{errors: errors}} <- create_service_actor(uri, nickname) do
1578 Logger.error("Cannot create service actor: #{uri}/.\n#{inspect(errors)}")
1582 %User{invisible: false} = user ->
1592 @spec set_invisible(User.t()) :: {:ok, User.t()}
1593 defp set_invisible(user) do
1595 |> change(%{invisible: true})
1596 |> update_and_set_cache()
1599 @spec create_service_actor(String.t(), String.t()) ::
1600 {:ok, User.t()} | {:error, Ecto.Changeset.t()}
1601 defp create_service_actor(uri, nickname) do
1607 follower_address: uri <> "/followers"
1610 |> unique_constraint(:nickname)
1615 def public_key(%{public_key: public_key_pem}) when is_binary(public_key_pem) do
1618 |> :public_key.pem_decode()
1620 |> :public_key.pem_entry_decode()
1625 def public_key(_), do: {:error, "key not found"}
1627 def get_public_key_for_ap_id(ap_id) do
1628 with {:ok, %User{} = user} <- get_or_fetch_by_ap_id(ap_id),
1629 {:ok, public_key} <- public_key(user) do
1636 def ap_enabled?(%User{local: true}), do: true
1637 def ap_enabled?(%User{ap_enabled: ap_enabled}), do: ap_enabled
1638 def ap_enabled?(_), do: false
1640 @doc "Gets or fetch a user by uri or nickname."
1641 @spec get_or_fetch(String.t()) :: {:ok, User.t()} | {:error, String.t()}
1642 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
1643 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
1645 # wait a period of time and return newest version of the User structs
1646 # this is because we have synchronous follow APIs and need to simulate them
1647 # with an async handshake
1648 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
1649 with %User{} = a <- get_cached_by_id(a.id),
1650 %User{} = b <- get_cached_by_id(b.id) do
1657 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
1658 with :ok <- :timer.sleep(timeout),
1659 %User{} = a <- get_cached_by_id(a.id),
1660 %User{} = b <- get_cached_by_id(b.id) do
1667 def parse_bio(bio) when is_binary(bio) and bio != "" do
1669 |> CommonUtils.format_input("text/plain", mentions_format: :full)
1673 def parse_bio(_), do: ""
1675 def parse_bio(bio, user) when is_binary(bio) and bio != "" do
1676 # TODO: get profile URLs other than user.ap_id
1677 profile_urls = [user.ap_id]
1680 |> CommonUtils.format_input("text/plain",
1681 mentions_format: :full,
1682 rel: &RelMe.maybe_put_rel_me(&1, profile_urls)
1687 def parse_bio(_, _), do: ""
1689 def tag(user_identifiers, tags) when is_list(user_identifiers) do
1690 Repo.transaction(fn ->
1691 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
1695 def tag(nickname, tags) when is_binary(nickname),
1696 do: tag(get_by_nickname(nickname), tags)
1698 def tag(%User{} = user, tags),
1699 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
1701 def untag(user_identifiers, tags) when is_list(user_identifiers) do
1702 Repo.transaction(fn ->
1703 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
1707 def untag(nickname, tags) when is_binary(nickname),
1708 do: untag(get_by_nickname(nickname), tags)
1710 def untag(%User{} = user, tags),
1711 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
1713 defp update_tags(%User{} = user, new_tags) do
1714 {:ok, updated_user} =
1716 |> change(%{tags: new_tags})
1717 |> update_and_set_cache()
1722 defp normalize_tags(tags) do
1725 |> Enum.map(&String.downcase/1)
1728 defp local_nickname_regex do
1729 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
1730 @extended_local_nickname_regex
1732 @strict_local_nickname_regex
1736 def local_nickname(nickname_or_mention) do
1739 |> String.split("@")
1743 def full_nickname(nickname_or_mention),
1744 do: String.trim_leading(nickname_or_mention, "@")
1746 def error_user(ap_id) do
1750 nickname: "erroruser@example.com",
1751 inserted_at: NaiveDateTime.utc_now()
1755 @spec all_superusers() :: [User.t()]
1756 def all_superusers do
1757 User.Query.build(%{super_users: true, local: true, deactivated: false})
1761 def muting_reblogs?(%User{} = user, %User{} = target) do
1762 UserRelationship.reblog_mute_exists?(user, target)
1765 def showing_reblogs?(%User{} = user, %User{} = target) do
1766 not muting_reblogs?(user, target)
1770 The function returns a query to get users with no activity for given interval of days.
1771 Inactive users are those who didn't read any notification, or had any activity where
1772 the user is the activity's actor, during `inactivity_threshold` days.
1773 Deactivated users will not appear in this list.
1777 iex> Pleroma.User.list_inactive_users()
1780 @spec list_inactive_users_query(integer()) :: Ecto.Query.t()
1781 def list_inactive_users_query(inactivity_threshold \\ 7) do
1782 negative_inactivity_threshold = -inactivity_threshold
1783 now = NaiveDateTime.truncate(NaiveDateTime.utc_now(), :second)
1784 # Subqueries are not supported in `where` clauses, join gets too complicated.
1785 has_read_notifications =
1786 from(n in Pleroma.Notification,
1787 where: n.seen == true,
1789 having: max(n.updated_at) > datetime_add(^now, ^negative_inactivity_threshold, "day"),
1792 |> Pleroma.Repo.all()
1794 from(u in Pleroma.User,
1795 left_join: a in Pleroma.Activity,
1796 on: u.ap_id == a.actor,
1797 where: not is_nil(u.nickname),
1798 where: u.deactivated != ^true,
1799 where: u.id not in ^has_read_notifications,
1802 max(a.inserted_at) < datetime_add(^now, ^negative_inactivity_threshold, "day") or
1803 is_nil(max(a.inserted_at))
1808 Enable or disable email notifications for user
1812 iex> Pleroma.User.switch_email_notifications(Pleroma.User{email_notifications: %{"digest" => false}}, "digest", true)
1813 Pleroma.User{email_notifications: %{"digest" => true}}
1815 iex> Pleroma.User.switch_email_notifications(Pleroma.User{email_notifications: %{"digest" => true}}, "digest", false)
1816 Pleroma.User{email_notifications: %{"digest" => false}}
1818 @spec switch_email_notifications(t(), String.t(), boolean()) ::
1819 {:ok, t()} | {:error, Ecto.Changeset.t()}
1820 def switch_email_notifications(user, type, status) do
1821 User.update_email_notifications(user, %{type => status})
1825 Set `last_digest_emailed_at` value for the user to current time
1827 @spec touch_last_digest_emailed_at(t()) :: t()
1828 def touch_last_digest_emailed_at(user) do
1829 now = NaiveDateTime.truncate(NaiveDateTime.utc_now(), :second)
1831 {:ok, updated_user} =
1833 |> change(%{last_digest_emailed_at: now})
1834 |> update_and_set_cache()
1839 @spec toggle_confirmation(User.t()) :: {:ok, User.t()} | {:error, Changeset.t()}
1840 def toggle_confirmation(%User{} = user) do
1842 |> confirmation_changeset(need_confirmation: !user.confirmation_pending)
1843 |> update_and_set_cache()
1846 @spec toggle_confirmation([User.t()]) :: [{:ok, User.t()} | {:error, Changeset.t()}]
1847 def toggle_confirmation(users) do
1848 Enum.map(users, &toggle_confirmation/1)
1851 def get_mascot(%{mascot: %{} = mascot}) when not is_nil(mascot) do
1855 def get_mascot(%{mascot: mascot}) when is_nil(mascot) do
1856 # use instance-default
1857 config = Pleroma.Config.get([:assets, :mascots])
1858 default_mascot = Pleroma.Config.get([:assets, :default_mascot])
1859 mascot = Keyword.get(config, default_mascot)
1862 "id" => "default-mascot",
1863 "url" => mascot[:url],
1864 "preview_url" => mascot[:url],
1866 "mime_type" => mascot[:mime_type]
1871 def ensure_keys_present(%{keys: keys} = user) when not is_nil(keys), do: {:ok, user}
1873 def ensure_keys_present(%User{} = user) do
1874 with {:ok, pem} <- Keys.generate_rsa_pem() do
1876 |> cast(%{keys: pem}, [:keys])
1877 |> validate_required([:keys])
1878 |> update_and_set_cache()
1882 def get_ap_ids_by_nicknames(nicknames) do
1884 where: u.nickname in ^nicknames,
1890 defdelegate search(query, opts \\ []), to: User.Search
1892 defp put_password_hash(
1893 %Ecto.Changeset{valid?: true, changes: %{password: password}} = changeset
1895 change(changeset, password_hash: Pbkdf2.hashpwsalt(password))
1898 defp put_password_hash(changeset), do: changeset
1900 def is_internal_user?(%User{nickname: nil}), do: true
1901 def is_internal_user?(%User{local: true, nickname: "internal." <> _}), do: true
1902 def is_internal_user?(_), do: false
1904 # A hack because user delete activities have a fake id for whatever reason
1905 # TODO: Get rid of this
1906 def get_delivered_users_by_object_id("pleroma:fake_object_id"), do: []
1908 def get_delivered_users_by_object_id(object_id) do
1910 inner_join: delivery in assoc(u, :deliveries),
1911 where: delivery.object_id == ^object_id
1916 def change_email(user, email) do
1918 |> cast(%{email: email}, [:email])
1919 |> validate_required([:email])
1920 |> unique_constraint(:email)
1921 |> validate_format(:email, @email_regex)
1922 |> update_and_set_cache()
1925 # Internal function; public one is `deactivate/2`
1926 defp set_activation_status(user, deactivated) do
1928 |> cast(%{deactivated: deactivated}, [:deactivated])
1929 |> update_and_set_cache()
1932 def update_banner(user, banner) do
1934 |> cast(%{banner: banner}, [:banner])
1935 |> update_and_set_cache()
1938 def update_background(user, background) do
1940 |> cast(%{background: background}, [:background])
1941 |> update_and_set_cache()
1944 def roles(%{is_moderator: is_moderator, is_admin: is_admin}) do
1947 moderator: is_moderator
1951 def validate_fields(changeset, remote? \\ false) do
1952 limit_name = if remote?, do: :max_remote_account_fields, else: :max_account_fields
1953 limit = Pleroma.Config.get([:instance, limit_name], 0)
1956 |> validate_length(:fields, max: limit)
1957 |> validate_change(:fields, fn :fields, fields ->
1958 if Enum.all?(fields, &valid_field?/1) do
1966 defp valid_field?(%{"name" => name, "value" => value}) do
1967 name_limit = Pleroma.Config.get([:instance, :account_field_name_length], 255)
1968 value_limit = Pleroma.Config.get([:instance, :account_field_value_length], 255)
1970 is_binary(name) && is_binary(value) && String.length(name) <= name_limit &&
1971 String.length(value) <= value_limit
1974 defp valid_field?(_), do: false
1976 defp truncate_field(%{"name" => name, "value" => value}) do
1978 String.split_at(name, Pleroma.Config.get([:instance, :account_field_name_length], 255))
1981 String.split_at(value, Pleroma.Config.get([:instance, :account_field_value_length], 255))
1983 %{"name" => name, "value" => value}
1986 def admin_api_update(user, params) do
1993 |> update_and_set_cache()
1996 @doc "Signs user out of all applications"
1997 def global_sign_out(user) do
1998 OAuth.Authorization.delete_user_authorizations(user)
1999 OAuth.Token.delete_user_tokens(user)
2002 def mascot_update(user, url) do
2004 |> cast(%{mascot: url}, [:mascot])
2005 |> validate_required([:mascot])
2006 |> update_and_set_cache()
2009 def mastodon_settings_update(user, settings) do
2011 |> cast(%{settings: settings}, [:settings])
2012 |> validate_required([:settings])
2013 |> update_and_set_cache()
2016 @spec confirmation_changeset(User.t(), keyword()) :: Changeset.t()
2017 def confirmation_changeset(user, need_confirmation: need_confirmation?) do
2019 if need_confirmation? do
2021 confirmation_pending: true,
2022 confirmation_token: :crypto.strong_rand_bytes(32) |> Base.url_encode64()
2026 confirmation_pending: false,
2027 confirmation_token: nil
2031 cast(user, params, [:confirmation_pending, :confirmation_token])
2034 def add_pinnned_activity(user, %Pleroma.Activity{id: id}) do
2035 if id not in user.pinned_activities do
2036 max_pinned_statuses = Pleroma.Config.get([:instance, :max_pinned_statuses], 0)
2037 params = %{pinned_activities: user.pinned_activities ++ [id]}
2040 |> cast(params, [:pinned_activities])
2041 |> validate_length(:pinned_activities,
2042 max: max_pinned_statuses,
2043 message: "You have already pinned the maximum number of statuses"
2048 |> update_and_set_cache()
2051 def remove_pinnned_activity(user, %Pleroma.Activity{id: id}) do
2052 params = %{pinned_activities: List.delete(user.pinned_activities, id)}
2055 |> cast(params, [:pinned_activities])
2056 |> update_and_set_cache()
2059 def update_email_notifications(user, settings) do
2060 email_notifications =
2061 user.email_notifications
2062 |> Map.merge(settings)
2063 |> Map.take(["digest"])
2065 params = %{email_notifications: email_notifications}
2066 fields = [:email_notifications]
2069 |> cast(params, fields)
2070 |> validate_required(fields)
2071 |> update_and_set_cache()
2074 defp set_domain_blocks(user, domain_blocks) do
2075 params = %{domain_blocks: domain_blocks}
2078 |> cast(params, [:domain_blocks])
2079 |> validate_required([:domain_blocks])
2080 |> update_and_set_cache()
2083 def block_domain(user, domain_blocked) do
2084 set_domain_blocks(user, Enum.uniq([domain_blocked | user.domain_blocks]))
2087 def unblock_domain(user, domain_blocked) do
2088 set_domain_blocks(user, List.delete(user.domain_blocks, domain_blocked))
2091 @spec add_to_block(User.t(), User.t()) ::
2092 {:ok, UserRelationship.t()} | {:error, Ecto.Changeset.t()}
2093 defp add_to_block(%User{} = user, %User{} = blocked) do
2094 UserRelationship.create_block(user, blocked)
2097 @spec add_to_block(User.t(), User.t()) ::
2098 {:ok, UserRelationship.t()} | {:ok, nil} | {:error, Ecto.Changeset.t()}
2099 defp remove_from_block(%User{} = user, %User{} = blocked) do
2100 UserRelationship.delete_block(user, blocked)
2103 defp add_to_mutes(%User{} = user, %User{} = muted_user, notifications?) do
2104 with {:ok, user_mute} <- UserRelationship.create_mute(user, muted_user),
2105 {:ok, user_notification_mute} <-
2106 (notifications? && UserRelationship.create_notification_mute(user, muted_user)) ||
2108 {:ok, Enum.filter([user_mute, user_notification_mute], & &1)}
2112 defp remove_from_mutes(user, %User{} = muted_user) do
2113 with {:ok, user_mute} <- UserRelationship.delete_mute(user, muted_user),
2114 {:ok, user_notification_mute} <-
2115 UserRelationship.delete_notification_mute(user, muted_user) do
2116 {:ok, [user_mute, user_notification_mute]}
2120 def set_invisible(user, invisible) do
2121 params = %{invisible: invisible}
2124 |> cast(params, [:invisible])
2125 |> validate_required([:invisible])
2126 |> update_and_set_cache()
2129 def sanitize_html(%User{} = user) do
2130 sanitize_html(user, nil)
2133 # User data that mastodon isn't filtering (treated as plaintext):
2136 def sanitize_html(%User{} = user, filter) do
2138 Enum.map(user.fields, fn %{"name" => name, "value" => value} ->
2141 "value" => HTML.filter_tags(value, Pleroma.HTML.Scrubber.LinksOnly)
2146 |> Map.put(:bio, HTML.filter_tags(user.bio, filter))
2147 |> Map.put(:fields, fields)