1 defmodule Pleroma.User do
4 import Ecto.{Changeset, Query}
5 alias Pleroma.{Repo, User, Object, Web, Activity, Notification}
7 alias Pleroma.Formatter
8 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
9 alias Pleroma.Web.{OStatus, Websub, OAuth}
10 alias Pleroma.Web.ActivityPub.{Utils, ActivityPub}
12 @type t :: %__MODULE__{}
14 @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])?)*$/
16 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
17 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
21 field(:email, :string)
23 field(:nickname, :string)
24 field(:password_hash, :string)
25 field(:password, :string, virtual: true)
26 field(:password_confirmation, :string, virtual: true)
27 field(:following, {:array, :string}, default: [])
28 field(:ap_id, :string)
30 field(:local, :boolean, default: true)
31 field(:follower_address, :string)
32 field(:search_distance, :float, virtual: true)
33 field(:tags, {:array, :string}, default: [])
34 field(:last_refreshed_at, :naive_datetime)
35 has_many(:notifications, Notification)
36 embeds_one(:info, Pleroma.User.Info)
41 def auth_active?(%User{} = user) do
42 (user.info && !user.info.confirmation_pending) ||
43 !Pleroma.Config.get([:instance, :account_activation_required])
46 def superuser?(%User{} = user), do: user.info && User.Info.superuser?(user.info)
48 def avatar_url(user) do
50 %{"url" => [%{"href" => href} | _]} -> href
51 _ -> "#{Web.base_url()}/images/avi.png"
55 def banner_url(user) do
56 case user.info.banner do
57 %{"url" => [%{"href" => href} | _]} -> href
58 _ -> "#{Web.base_url()}/images/banner.png"
62 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
63 def profile_url(%User{ap_id: ap_id}), do: ap_id
64 def profile_url(_), do: nil
66 def ap_id(%User{nickname: nickname}) do
67 "#{Web.base_url()}/users/#{nickname}"
70 def ap_followers(%User{} = user) do
71 "#{ap_id(user)}/followers"
74 def follow_changeset(struct, params \\ %{}) do
76 |> cast(params, [:following])
77 |> validate_required([:following])
80 def user_info(%User{} = user) do
81 oneself = if user.local, do: 1, else: 0
84 following_count: length(user.following) - oneself,
85 note_count: user.info.note_count,
86 follower_count: user.info.follower_count,
87 locked: user.info.locked,
88 confirmation_pending: user.info.confirmation_pending,
89 default_scope: user.info.default_scope
93 def remote_user_creation(params) do
96 |> Map.put(:info, params[:info] || %{})
98 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
102 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
103 |> validate_required([:name, :ap_id])
104 |> unique_constraint(:nickname)
105 |> validate_format(:nickname, @email_regex)
106 |> validate_length(:bio, max: 5000)
107 |> validate_length(:name, max: 100)
108 |> put_change(:local, false)
109 |> put_embed(:info, info_cng)
112 case info_cng.changes[:source_data] do
113 %{"followers" => followers} ->
115 |> put_change(:follower_address, followers)
118 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
121 |> put_change(:follower_address, followers)
128 def update_changeset(struct, params \\ %{}) do
130 |> cast(params, [:bio, :name, :avatar])
131 |> unique_constraint(:nickname)
132 |> validate_format(:nickname, local_nickname_regex())
133 |> validate_length(:bio, max: 5000)
134 |> validate_length(:name, min: 1, max: 100)
137 def upgrade_changeset(struct, params \\ %{}) do
140 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
144 |> User.Info.user_upgrade(params[:info])
147 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
148 |> unique_constraint(:nickname)
149 |> validate_format(:nickname, local_nickname_regex())
150 |> validate_length(:bio, max: 5000)
151 |> validate_length(:name, max: 100)
152 |> put_embed(:info, info_cng)
155 def password_update_changeset(struct, params) do
158 |> cast(params, [:password, :password_confirmation])
159 |> validate_required([:password, :password_confirmation])
160 |> validate_confirmation(:password)
162 OAuth.Token.delete_user_tokens(struct)
163 OAuth.Authorization.delete_user_authorizations(struct)
165 if changeset.valid? do
166 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
169 |> put_change(:password_hash, hashed)
175 def reset_password(user, data) do
176 update_and_set_cache(password_update_changeset(user, data))
179 def register_changeset(struct, params \\ %{}, opts \\ []) do
180 confirmation_status =
181 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
187 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
191 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
192 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
193 |> validate_confirmation(:password)
194 |> unique_constraint(:email)
195 |> unique_constraint(:nickname)
196 |> validate_format(:nickname, local_nickname_regex())
197 |> validate_format(:email, @email_regex)
198 |> validate_length(:bio, max: 1000)
199 |> validate_length(:name, min: 1, max: 100)
200 |> put_change(:info, info_change)
202 if changeset.valid? do
203 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
204 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
205 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
208 |> put_change(:password_hash, hashed)
209 |> put_change(:ap_id, ap_id)
210 |> put_change(:following, [followers])
211 |> put_change(:follower_address, followers)
217 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
218 def register(%Ecto.Changeset{} = changeset) do
219 with {:ok, user} <- Repo.insert(changeset),
220 {:ok, _} = try_send_confirmation_email(user) do
225 def try_send_confirmation_email(%User{} = user) do
226 if user.info.confirmation_pending &&
227 Pleroma.Config.get([:instance, :account_activation_required]) do
229 |> Pleroma.UserEmail.account_confirmation_email()
230 |> Pleroma.Mailer.deliver()
236 def needs_update?(%User{local: true}), do: false
238 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
240 def needs_update?(%User{local: false} = user) do
241 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
244 def needs_update?(_), do: true
246 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
250 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
251 follow(follower, followed)
254 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
255 if not User.ap_enabled?(followed) do
256 follow(follower, followed)
262 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
263 if not following?(follower, followed) do
264 follow(follower, followed)
270 def follow(%User{} = follower, %User{info: info} = followed) do
271 user_config = Application.get_env(:pleroma, :user)
272 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
274 ap_followers = followed.follower_address
277 following?(follower, followed) or info.deactivated ->
278 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
280 deny_follow_blocked and blocks?(followed, follower) ->
281 {:error, "Could not follow user: #{followed.nickname} blocked you."}
284 if !followed.local && follower.local && !ap_enabled?(followed) do
285 Websub.subscribe(follower, followed)
289 [ap_followers | follower.following]
294 |> follow_changeset(%{following: following})
295 |> update_and_set_cache
297 {:ok, _} = update_follower_count(followed)
303 def unfollow(%User{} = follower, %User{} = followed) do
304 ap_followers = followed.follower_address
306 if following?(follower, followed) and follower.ap_id != followed.ap_id do
309 |> List.delete(ap_followers)
313 |> follow_changeset(%{following: following})
314 |> update_and_set_cache
316 {:ok, followed} = update_follower_count(followed)
318 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
320 {:error, "Not subscribed!"}
324 @spec following?(User.t(), User.t()) :: boolean
325 def following?(%User{} = follower, %User{} = followed) do
326 Enum.member?(follower.following, followed.follower_address)
329 def locked?(%User{} = user) do
330 user.info.locked || false
333 def get_by_ap_id(ap_id) do
334 Repo.get_by(User, ap_id: ap_id)
337 def update_and_set_cache(changeset) do
338 with {:ok, user} <- Repo.update(changeset) do
339 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
340 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
341 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
348 def invalidate_cache(user) do
349 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
350 Cachex.del(:user_cache, "nickname:#{user.nickname}")
351 Cachex.del(:user_cache, "user_info:#{user.id}")
354 def get_cached_by_ap_id(ap_id) do
355 key = "ap_id:#{ap_id}"
356 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
359 def get_cached_by_nickname(nickname) do
360 key = "nickname:#{nickname}"
361 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
364 def get_by_nickname(nickname) do
365 Repo.get_by(User, nickname: nickname)
368 def get_by_nickname_or_email(nickname_or_email) do
369 case user = Repo.get_by(User, nickname: nickname_or_email) do
371 nil -> Repo.get_by(User, email: nickname_or_email)
375 def get_cached_user_info(user) do
376 key = "user_info:#{user.id}"
377 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
380 def fetch_by_nickname(nickname) do
381 ap_try = ActivityPub.make_user_from_nickname(nickname)
384 {:ok, user} -> {:ok, user}
385 _ -> OStatus.make_user(nickname)
389 def get_or_fetch_by_nickname(nickname) do
390 with %User{} = user <- get_by_nickname(nickname) do
394 with [_nick, _domain] <- String.split(nickname, "@"),
395 {:ok, user} <- fetch_by_nickname(nickname) do
403 def get_followers_query(%User{id: id, follower_address: follower_address}) do
406 where: fragment("? <@ ?", ^[follower_address], u.following),
411 def get_followers(user) do
412 q = get_followers_query(user)
417 def get_friends_query(%User{id: id, following: following}) do
420 where: u.follower_address in ^following,
425 def get_friends(user) do
426 q = get_friends_query(user)
431 def get_follow_requests_query(%User{} = user) do
436 "? ->> 'type' = 'Follow'",
441 "? ->> 'state' = 'pending'",
448 ^%{"object" => user.ap_id}
453 def get_follow_requests(%User{} = user) do
454 q = get_follow_requests_query(user)
458 Enum.map(reqs, fn req -> req.actor end)
460 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
461 |> Enum.filter(fn u -> !following?(u, user) end)
466 def increase_note_count(%User{} = user) do
467 info_cng = User.Info.add_to_note_count(user.info, 1)
471 |> put_embed(:info, info_cng)
473 update_and_set_cache(cng)
476 def decrease_note_count(%User{} = user) do
477 info_cng = User.Info.add_to_note_count(user.info, -1)
481 |> put_embed(:info, info_cng)
483 update_and_set_cache(cng)
486 def update_note_count(%User{} = user) do
490 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
494 note_count = Repo.one(note_count_query)
496 info_cng = User.Info.set_note_count(user.info, note_count)
500 |> put_embed(:info, info_cng)
502 update_and_set_cache(cng)
505 def update_follower_count(%User{} = user) do
506 follower_count_query =
509 where: ^user.follower_address in u.following,
510 where: u.id != ^user.id,
514 follower_count = Repo.one(follower_count_query)
518 |> User.Info.set_follower_count(follower_count)
522 |> put_embed(:info, info_cng)
524 update_and_set_cache(cng)
527 def get_users_from_set_query(ap_ids, false) do
530 where: u.ap_id in ^ap_ids
534 def get_users_from_set_query(ap_ids, true) do
535 query = get_users_from_set_query(ap_ids, false)
539 where: u.local == true
543 def get_users_from_set(ap_ids, local_only \\ true) do
544 get_users_from_set_query(ap_ids, local_only)
548 def get_recipients_from_activity(%Activity{recipients: to}) do
552 where: u.ap_id in ^to,
553 or_where: fragment("? && ?", u.following, ^to)
556 query = from(u in query, where: u.local == true)
561 def search(query, resolve \\ false) do
562 # strip the beginning @ off if there is a query
563 query = String.trim_leading(query, "@")
566 User.get_or_fetch_by_nickname(query)
581 where: not is_nil(u.nickname)
586 s in subquery(inner),
587 order_by: s.search_distance,
594 def block(blocker, %User{ap_id: ap_id} = blocked) do
595 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
597 if following?(blocker, blocked) do
598 {:ok, blocker, _} = unfollow(blocker, blocked)
604 if following?(blocked, blocker) do
605 unfollow(blocked, blocker)
610 |> User.Info.add_to_block(ap_id)
614 |> put_embed(:info, info_cng)
616 update_and_set_cache(cng)
619 # helper to handle the block given only an actor's AP id
620 def block(blocker, %{ap_id: ap_id}) do
621 block(blocker, User.get_by_ap_id(ap_id))
624 def unblock(blocker, %{ap_id: ap_id}) do
627 |> User.Info.remove_from_block(ap_id)
631 |> put_embed(:info, info_cng)
633 update_and_set_cache(cng)
636 def blocks?(user, %{ap_id: ap_id}) do
637 blocks = user.info.blocks
638 domain_blocks = user.info.domain_blocks
639 %{host: host} = URI.parse(ap_id)
641 Enum.member?(blocks, ap_id) ||
642 Enum.any?(domain_blocks, fn domain ->
647 def block_domain(user, domain) do
650 |> User.Info.add_to_domain_block(domain)
654 |> put_embed(:info, info_cng)
656 update_and_set_cache(cng)
659 def unblock_domain(user, domain) do
662 |> User.Info.remove_from_domain_block(domain)
666 |> put_embed(:info, info_cng)
668 update_and_set_cache(cng)
671 def local_user_query() do
674 where: u.local == true,
675 where: not is_nil(u.nickname)
679 def moderator_user_query() do
682 where: u.local == true,
683 where: fragment("?->'is_moderator' @> 'true'", u.info)
687 def deactivate(%User{} = user, status \\ true) do
688 info_cng = User.Info.set_activation_status(user.info, status)
692 |> put_embed(:info, info_cng)
694 update_and_set_cache(cng)
697 def delete(%User{} = user) do
698 {:ok, user} = User.deactivate(user)
700 # Remove all relationships
701 {:ok, followers} = User.get_followers(user)
704 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
706 {:ok, friends} = User.get_friends(user)
709 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
711 query = from(a in Activity, where: a.actor == ^user.ap_id)
714 |> Enum.each(fn activity ->
715 case activity.data["type"] do
717 ActivityPub.delete(Object.normalize(activity.data["object"]))
719 # TODO: Do something with likes, follows, repeats.
728 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
729 Pleroma.HTML.Scrubber.TwitterText
732 def html_filter_policy(_), do: nil
734 def get_or_fetch_by_ap_id(ap_id) do
735 user = get_by_ap_id(ap_id)
737 if !is_nil(user) and !User.needs_update?(user) do
740 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
747 case OStatus.make_user(ap_id) do
749 _ -> {:error, "Could not fetch by AP id"}
755 def get_or_create_instance_user do
756 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
758 if user = get_by_ap_id(relay_uri) do
762 %User{info: %User.Info{}}
763 |> cast(%{}, [:ap_id, :nickname, :local])
764 |> put_change(:ap_id, relay_uri)
765 |> put_change(:nickname, nil)
766 |> put_change(:local, true)
767 |> put_change(:follower_address, relay_uri <> "/followers")
769 {:ok, user} = Repo.insert(changes)
775 def public_key_from_info(%{
776 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
780 |> :public_key.pem_decode()
782 |> :public_key.pem_entry_decode()
788 def public_key_from_info(%{magic_key: magic_key}) do
789 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
792 def get_public_key_for_ap_id(ap_id) do
793 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
794 {:ok, public_key} <- public_key_from_info(user.info) do
801 defp blank?(""), do: nil
802 defp blank?(n), do: n
804 def insert_or_update_user(data) do
807 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
809 cs = User.remote_user_creation(data)
811 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
814 def ap_enabled?(%User{local: true}), do: true
815 def ap_enabled?(%User{info: info}), do: info.ap_enabled
816 def ap_enabled?(_), do: false
818 @doc "Gets or fetch a user by uri or nickname."
819 @spec get_or_fetch(String.t()) :: User.t()
820 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
821 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
823 # wait a period of time and return newest version of the User structs
824 # this is because we have synchronous follow APIs and need to simulate them
825 # with an async handshake
826 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
827 with %User{} = a <- Repo.get(User, a.id),
828 %User{} = b <- Repo.get(User, b.id) do
836 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
837 with :ok <- :timer.sleep(timeout),
838 %User{} = a <- Repo.get(User, a.id),
839 %User{} = b <- Repo.get(User, b.id) do
847 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
848 def parse_bio(nil, _user), do: ""
849 def parse_bio(bio, _user) when bio == "", do: bio
851 def parse_bio(bio, user) do
852 mentions = Formatter.parse_mentions(bio)
853 tags = Formatter.parse_tags(bio)
856 (user.info.source_data["tag"] || [])
857 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
858 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
859 {String.trim(name, ":"), url}
863 |> CommonUtils.format_input(mentions, tags, "text/plain")
864 |> Formatter.emojify(emoji)
867 def tag(user_identifiers, tags) when is_list(user_identifiers) do
868 Repo.transaction(fn ->
869 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
873 def tag(nickname, tags) when is_binary(nickname),
874 do: tag(User.get_by_nickname(nickname), tags)
876 def tag(%User{} = user, tags),
877 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
879 def untag(user_identifiers, tags) when is_list(user_identifiers) do
880 Repo.transaction(fn ->
881 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
885 def untag(nickname, tags) when is_binary(nickname),
886 do: untag(User.get_by_nickname(nickname), tags)
888 def untag(%User{} = user, tags),
889 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
891 defp update_tags(%User{} = user, new_tags) do
892 {:ok, updated_user} =
894 |> change(%{tags: new_tags})
900 defp normalize_tags(tags) do
903 |> Enum.map(&String.downcase(&1))
906 defp local_nickname_regex() do
907 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
908 @extended_local_nickname_regex
910 @strict_local_nickname_regex