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: user.info && !user.info.confirmation_pending
43 def superuser?(%User{} = user), do: user.info && User.Info.superuser?(user.info)
45 def avatar_url(user) do
47 %{"url" => [%{"href" => href} | _]} -> href
48 _ -> "#{Web.base_url()}/images/avi.png"
52 def banner_url(user) do
53 case user.info.banner do
54 %{"url" => [%{"href" => href} | _]} -> href
55 _ -> "#{Web.base_url()}/images/banner.png"
59 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
60 def profile_url(%User{ap_id: ap_id}), do: ap_id
61 def profile_url(_), do: nil
63 def ap_id(%User{nickname: nickname}) do
64 "#{Web.base_url()}/users/#{nickname}"
67 def ap_followers(%User{} = user) do
68 "#{ap_id(user)}/followers"
71 def follow_changeset(struct, params \\ %{}) do
73 |> cast(params, [:following])
74 |> validate_required([:following])
77 def user_info(%User{} = user) do
78 oneself = if user.local, do: 1, else: 0
82 following_count: length(user.following) - oneself,
83 note_count: user_info.note_count,
84 follower_count: user_info.follower_count,
85 locked: user_info.locked,
86 confirmation_pending: user_info.confirmation_pending,
87 default_scope: user_info.default_scope
91 def remote_user_creation(params) do
94 |> Map.put(:info, params[:info] || %{})
96 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
100 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
101 |> validate_required([:name, :ap_id])
102 |> unique_constraint(:nickname)
103 |> validate_format(:nickname, @email_regex)
104 |> validate_length(:bio, max: 5000)
105 |> validate_length(:name, max: 100)
106 |> put_change(:local, false)
107 |> put_embed(:info, info_cng)
110 case info_cng.changes[:source_data] do
111 %{"followers" => followers} ->
113 |> put_change(:follower_address, followers)
116 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
119 |> put_change(:follower_address, followers)
126 def update_changeset(struct, params \\ %{}) do
128 |> cast(params, [:bio, :name, :avatar])
129 |> unique_constraint(:nickname)
130 |> validate_format(:nickname, local_nickname_regex())
131 |> validate_length(:bio, max: 5000)
132 |> validate_length(:name, min: 1, max: 100)
135 def upgrade_changeset(struct, params \\ %{}) do
138 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
142 |> User.Info.user_upgrade(params[:info])
145 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
146 |> unique_constraint(:nickname)
147 |> validate_format(:nickname, local_nickname_regex())
148 |> validate_length(:bio, max: 5000)
149 |> validate_length(:name, max: 100)
150 |> put_embed(:info, info_cng)
153 def password_update_changeset(struct, params) do
156 |> cast(params, [:password, :password_confirmation])
157 |> validate_required([:password, :password_confirmation])
158 |> validate_confirmation(:password)
160 OAuth.Token.delete_user_tokens(struct)
161 OAuth.Authorization.delete_user_authorizations(struct)
163 if changeset.valid? do
164 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
167 |> put_change(:password_hash, hashed)
173 def reset_password(user, data) do
174 update_and_set_cache(password_update_changeset(user, data))
177 def register_changeset(struct, params \\ %{}, opts \\ []) do
178 confirmation_status =
179 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
187 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
188 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
189 |> validate_confirmation(:password)
190 |> unique_constraint(:email)
191 |> unique_constraint(:nickname)
192 |> validate_format(:nickname, local_nickname_regex())
193 |> validate_format(:email, @email_regex)
194 |> validate_length(:bio, max: 1000)
195 |> validate_length(:name, min: 1, max: 100)
196 |> put_change(:info, User.Info.confirmation_changeset(%User.Info{}, confirmation_status))
198 if changeset.valid? do
199 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
200 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
201 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
204 |> put_change(:password_hash, hashed)
205 |> put_change(:ap_id, ap_id)
206 |> put_change(:following, [followers])
207 |> put_change(:follower_address, followers)
213 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
214 def register(%Ecto.Changeset{} = changeset) do
215 with {:ok, user} <- Repo.insert(changeset),
216 {:ok, _} = try_send_confirmation_email(user) do
221 def try_send_confirmation_email(%User{} = user) do
222 if user.info.confirmation_pending do
224 |> Pleroma.UserEmail.account_confirmation_email()
225 |> Pleroma.Mailer.deliver()
231 def needs_update?(%User{local: true}), do: false
233 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
235 def needs_update?(%User{local: false} = user) do
236 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
239 def needs_update?(_), do: true
241 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
245 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
246 follow(follower, followed)
249 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
250 if not User.ap_enabled?(followed) do
251 follow(follower, followed)
257 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
258 if not following?(follower, followed) do
259 follow(follower, followed)
265 def follow(%User{} = follower, %User{info: info} = followed) do
266 user_config = Application.get_env(:pleroma, :user)
267 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
269 ap_followers = followed.follower_address
272 following?(follower, followed) or info.deactivated ->
273 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
275 deny_follow_blocked and blocks?(followed, follower) ->
276 {:error, "Could not follow user: #{followed.nickname} blocked you."}
279 if !followed.local && follower.local && !ap_enabled?(followed) do
280 Websub.subscribe(follower, followed)
284 [ap_followers | follower.following]
289 |> follow_changeset(%{following: following})
290 |> update_and_set_cache
292 {:ok, _} = update_follower_count(followed)
298 def unfollow(%User{} = follower, %User{} = followed) do
299 ap_followers = followed.follower_address
301 if following?(follower, followed) and follower.ap_id != followed.ap_id do
304 |> List.delete(ap_followers)
308 |> follow_changeset(%{following: following})
309 |> update_and_set_cache
311 {:ok, followed} = update_follower_count(followed)
313 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
315 {:error, "Not subscribed!"}
319 @spec following?(User.t(), User.t()) :: boolean
320 def following?(%User{} = follower, %User{} = followed) do
321 Enum.member?(follower.following, followed.follower_address)
324 def locked?(%User{} = user) do
325 user.info.locked || false
328 def get_by_ap_id(ap_id) do
329 Repo.get_by(User, ap_id: ap_id)
332 def update_and_set_cache(changeset) do
333 with {:ok, user} <- Repo.update(changeset) do
334 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
335 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
336 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
343 def invalidate_cache(user) do
344 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
345 Cachex.del(:user_cache, "nickname:#{user.nickname}")
346 Cachex.del(:user_cache, "user_info:#{user.id}")
349 def get_cached_by_ap_id(ap_id) do
350 key = "ap_id:#{ap_id}"
351 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
354 def get_cached_by_nickname(nickname) do
355 key = "nickname:#{nickname}"
356 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
359 def get_by_nickname(nickname) do
360 Repo.get_by(User, nickname: nickname)
363 def get_by_nickname_or_email(nickname_or_email) do
364 case user = Repo.get_by(User, nickname: nickname_or_email) do
366 nil -> Repo.get_by(User, email: nickname_or_email)
370 def get_cached_user_info(user) do
371 key = "user_info:#{user.id}"
372 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
375 def fetch_by_nickname(nickname) do
376 ap_try = ActivityPub.make_user_from_nickname(nickname)
379 {:ok, user} -> {:ok, user}
380 _ -> OStatus.make_user(nickname)
384 def get_or_fetch_by_nickname(nickname) do
385 with %User{} = user <- get_by_nickname(nickname) do
389 with [_nick, _domain] <- String.split(nickname, "@"),
390 {:ok, user} <- fetch_by_nickname(nickname) do
398 def get_by_confirmation_token(token) do
399 Repo.one(from(u in User, where: fragment("? ->> 'confirmation_token' = ?", u.info, ^token)))
402 def get_followers_query(%User{id: id, follower_address: follower_address}) do
405 where: fragment("? <@ ?", ^[follower_address], u.following),
410 def get_followers(user) do
411 q = get_followers_query(user)
416 def get_friends_query(%User{id: id, following: following}) do
419 where: u.follower_address in ^following,
424 def get_friends(user) do
425 q = get_friends_query(user)
430 def get_follow_requests_query(%User{} = user) do
435 "? ->> 'type' = 'Follow'",
440 "? ->> 'state' = 'pending'",
447 ^%{"object" => user.ap_id}
452 def get_follow_requests(%User{} = user) do
453 q = get_follow_requests_query(user)
457 Enum.map(reqs, fn req -> req.actor end)
459 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
460 |> Enum.filter(fn u -> !following?(u, user) end)
465 def increase_note_count(%User{} = user) do
466 info_cng = User.Info.add_to_note_count(user.info, 1)
470 |> put_embed(:info, info_cng)
472 update_and_set_cache(cng)
475 def decrease_note_count(%User{} = user) do
476 info_cng = User.Info.add_to_note_count(user.info, -1)
480 |> put_embed(:info, info_cng)
482 update_and_set_cache(cng)
485 def update_note_count(%User{} = user) do
489 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
493 note_count = Repo.one(note_count_query)
495 info_cng = User.Info.set_note_count(user.info, note_count)
499 |> put_embed(:info, info_cng)
501 update_and_set_cache(cng)
504 def update_follower_count(%User{} = user) do
505 follower_count_query =
508 where: ^user.follower_address in u.following,
509 where: u.id != ^user.id,
513 follower_count = Repo.one(follower_count_query)
517 |> User.Info.set_follower_count(follower_count)
521 |> put_embed(:info, info_cng)
523 update_and_set_cache(cng)
526 def get_users_from_set_query(ap_ids, false) do
529 where: u.ap_id in ^ap_ids
533 def get_users_from_set_query(ap_ids, true) do
534 query = get_users_from_set_query(ap_ids, false)
538 where: u.local == true
542 def get_users_from_set(ap_ids, local_only \\ true) do
543 get_users_from_set_query(ap_ids, local_only)
547 def get_recipients_from_activity(%Activity{recipients: to}) do
551 where: u.ap_id in ^to,
552 or_where: fragment("? && ?", u.following, ^to)
555 query = from(u in query, where: u.local == true)
560 def search(query, resolve \\ false) do
561 # strip the beginning @ off if there is a query
562 query = String.trim_leading(query, "@")
565 User.get_or_fetch_by_nickname(query)
580 where: not is_nil(u.nickname)
585 s in subquery(inner),
586 order_by: s.search_distance,
593 def block(blocker, %User{ap_id: ap_id} = blocked) do
594 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
596 if following?(blocker, blocked) do
597 {:ok, blocker, _} = unfollow(blocker, blocked)
603 if following?(blocked, blocker) do
604 unfollow(blocked, blocker)
609 |> User.Info.add_to_block(ap_id)
613 |> put_embed(:info, info_cng)
615 update_and_set_cache(cng)
618 # helper to handle the block given only an actor's AP id
619 def block(blocker, %{ap_id: ap_id}) do
620 block(blocker, User.get_by_ap_id(ap_id))
623 def unblock(blocker, %{ap_id: ap_id}) do
626 |> User.Info.remove_from_block(ap_id)
630 |> put_embed(:info, info_cng)
632 update_and_set_cache(cng)
635 def blocks?(user, %{ap_id: ap_id}) do
636 blocks = user.info.blocks
637 domain_blocks = user.info.domain_blocks
638 %{host: host} = URI.parse(ap_id)
640 Enum.member?(blocks, ap_id) ||
641 Enum.any?(domain_blocks, fn domain ->
646 def block_domain(user, domain) do
649 |> User.Info.add_to_domain_block(domain)
653 |> put_embed(:info, info_cng)
655 update_and_set_cache(cng)
658 def unblock_domain(user, domain) do
661 |> User.Info.remove_from_domain_block(domain)
665 |> put_embed(:info, info_cng)
667 update_and_set_cache(cng)
670 def local_user_query() do
673 where: u.local == true,
674 where: not is_nil(u.nickname)
678 def moderator_user_query() do
681 where: u.local == true,
682 where: fragment("?->'is_moderator' @> 'true'", u.info)
686 def deactivate(%User{} = user, status \\ true) do
687 info_cng = User.Info.set_activation_status(user.info, status)
691 |> put_embed(:info, info_cng)
693 update_and_set_cache(cng)
696 def delete(%User{} = user) do
697 {:ok, user} = User.deactivate(user)
699 # Remove all relationships
700 {:ok, followers} = User.get_followers(user)
703 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
705 {:ok, friends} = User.get_friends(user)
708 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
710 query = from(a in Activity, where: a.actor == ^user.ap_id)
713 |> Enum.each(fn activity ->
714 case activity.data["type"] do
716 ActivityPub.delete(Object.normalize(activity.data["object"]))
718 # TODO: Do something with likes, follows, repeats.
727 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
728 Pleroma.HTML.Scrubber.TwitterText
731 def html_filter_policy(_), do: nil
733 def get_or_fetch_by_ap_id(ap_id) do
734 user = get_by_ap_id(ap_id)
736 if !is_nil(user) and !User.needs_update?(user) do
739 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
746 case OStatus.make_user(ap_id) do
748 _ -> {:error, "Could not fetch by AP id"}
754 def get_or_create_instance_user do
755 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
757 if user = get_by_ap_id(relay_uri) do
761 %User{info: %User.Info{}}
762 |> cast(%{}, [:ap_id, :nickname, :local])
763 |> put_change(:ap_id, relay_uri)
764 |> put_change(:nickname, nil)
765 |> put_change(:local, true)
766 |> put_change(:follower_address, relay_uri <> "/followers")
768 {:ok, user} = Repo.insert(changes)
774 def public_key_from_info(%{
775 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
779 |> :public_key.pem_decode()
781 |> :public_key.pem_entry_decode()
787 def public_key_from_info(%{magic_key: magic_key}) do
788 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
791 def get_public_key_for_ap_id(ap_id) do
792 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
793 {:ok, public_key} <- public_key_from_info(user.info) do
800 defp blank?(""), do: nil
801 defp blank?(n), do: n
803 def insert_or_update_user(data) do
806 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
808 cs = User.remote_user_creation(data)
810 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
813 def ap_enabled?(%User{local: true}), do: true
814 def ap_enabled?(%User{info: info}), do: info.ap_enabled
815 def ap_enabled?(_), do: false
817 @doc "Gets or fetch a user by uri or nickname."
818 @spec get_or_fetch(String.t()) :: User.t()
819 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
820 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
822 # wait a period of time and return newest version of the User structs
823 # this is because we have synchronous follow APIs and need to simulate them
824 # with an async handshake
825 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
826 with %User{} = a <- Repo.get(User, a.id),
827 %User{} = b <- Repo.get(User, b.id) do
835 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
836 with :ok <- :timer.sleep(timeout),
837 %User{} = a <- Repo.get(User, a.id),
838 %User{} = b <- Repo.get(User, b.id) do
846 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
847 def parse_bio(nil, _user), do: ""
848 def parse_bio(bio, _user) when bio == "", do: bio
850 def parse_bio(bio, user) do
851 mentions = Formatter.parse_mentions(bio)
852 tags = Formatter.parse_tags(bio)
855 (user.info.source_data["tag"] || [])
856 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
857 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
858 {String.trim(name, ":"), url}
862 |> CommonUtils.format_input(mentions, tags, "text/plain")
863 |> Formatter.emojify(emoji)
866 def tag(user_identifiers, tags) when is_list(user_identifiers) do
867 Repo.transaction(fn ->
868 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
872 def tag(nickname, tags) when is_binary(nickname),
873 do: tag(User.get_by_nickname(nickname), tags)
875 def tag(%User{} = user, tags),
876 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
878 def untag(user_identifiers, tags) when is_list(user_identifiers) do
879 Repo.transaction(fn ->
880 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
884 def untag(nickname, tags) when is_binary(nickname),
885 do: untag(User.get_by_nickname(nickname), tags)
887 def untag(%User{} = user, tags),
888 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
890 defp update_tags(%User{} = user, new_tags) do
891 {:ok, updated_user} =
893 |> change(%{tags: new_tags})
899 defp normalize_tags(tags) do
902 |> Enum.map(&String.downcase(&1))
905 defp local_nickname_regex() do
906 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
907 @extended_local_nickname_regex
909 @strict_local_nickname_regex