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
81 following_count: length(user.following) - oneself,
82 note_count: user.info.note_count,
83 follower_count: user.info.follower_count,
84 locked: user.info.locked,
85 confirmation_pending: user.info.confirmation_pending,
86 default_scope: user.info.default_scope
90 def remote_user_creation(params) do
93 |> Map.put(:info, params[:info] || %{})
95 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
99 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
100 |> validate_required([:name, :ap_id])
101 |> unique_constraint(:nickname)
102 |> validate_format(:nickname, @email_regex)
103 |> validate_length(:bio, max: 5000)
104 |> validate_length(:name, max: 100)
105 |> put_change(:local, false)
106 |> put_embed(:info, info_cng)
109 case info_cng.changes[:source_data] do
110 %{"followers" => followers} ->
112 |> put_change(:follower_address, followers)
115 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
118 |> put_change(:follower_address, followers)
125 def update_changeset(struct, params \\ %{}) do
127 |> cast(params, [:bio, :name, :avatar])
128 |> unique_constraint(:nickname)
129 |> validate_format(:nickname, local_nickname_regex())
130 |> validate_length(:bio, max: 5000)
131 |> validate_length(:name, min: 1, max: 100)
134 def upgrade_changeset(struct, params \\ %{}) do
137 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
141 |> User.Info.user_upgrade(params[:info])
144 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
145 |> unique_constraint(:nickname)
146 |> validate_format(:nickname, local_nickname_regex())
147 |> validate_length(:bio, max: 5000)
148 |> validate_length(:name, max: 100)
149 |> put_embed(:info, info_cng)
152 def password_update_changeset(struct, params) do
155 |> cast(params, [:password, :password_confirmation])
156 |> validate_required([:password, :password_confirmation])
157 |> validate_confirmation(:password)
159 OAuth.Token.delete_user_tokens(struct)
160 OAuth.Authorization.delete_user_authorizations(struct)
162 if changeset.valid? do
163 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
166 |> put_change(:password_hash, hashed)
172 def reset_password(user, data) do
173 update_and_set_cache(password_update_changeset(user, data))
176 def register_changeset(struct, params \\ %{}, opts \\ []) do
177 confirmation_status =
178 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
184 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
188 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
189 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
190 |> validate_confirmation(:password)
191 |> unique_constraint(:email)
192 |> unique_constraint(:nickname)
193 |> validate_format(:nickname, local_nickname_regex())
194 |> validate_format(:email, @email_regex)
195 |> validate_length(:bio, max: 1000)
196 |> validate_length(:name, min: 1, max: 100)
197 |> put_change(:info, info_change)
199 if changeset.valid? do
200 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
201 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
202 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
205 |> put_change(:password_hash, hashed)
206 |> put_change(:ap_id, ap_id)
207 |> put_change(:following, [followers])
208 |> put_change(:follower_address, followers)
214 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
215 def register(%Ecto.Changeset{} = changeset) do
216 with {:ok, user} <- Repo.insert(changeset),
217 {:ok, _} = try_send_confirmation_email(user) do
222 def try_send_confirmation_email(%User{} = user) do
223 if user.info.confirmation_pending do
225 |> Pleroma.UserEmail.account_confirmation_email()
226 |> Pleroma.Mailer.deliver()
232 def needs_update?(%User{local: true}), do: false
234 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
236 def needs_update?(%User{local: false} = user) do
237 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
240 def needs_update?(_), do: true
242 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
246 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
247 follow(follower, followed)
250 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
251 if not User.ap_enabled?(followed) do
252 follow(follower, followed)
258 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
259 if not following?(follower, followed) do
260 follow(follower, followed)
266 def follow(%User{} = follower, %User{info: info} = followed) do
267 user_config = Application.get_env(:pleroma, :user)
268 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
270 ap_followers = followed.follower_address
273 following?(follower, followed) or info.deactivated ->
274 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
276 deny_follow_blocked and blocks?(followed, follower) ->
277 {:error, "Could not follow user: #{followed.nickname} blocked you."}
280 if !followed.local && follower.local && !ap_enabled?(followed) do
281 Websub.subscribe(follower, followed)
285 [ap_followers | follower.following]
290 |> follow_changeset(%{following: following})
291 |> update_and_set_cache
293 {:ok, _} = update_follower_count(followed)
299 def unfollow(%User{} = follower, %User{} = followed) do
300 ap_followers = followed.follower_address
302 if following?(follower, followed) and follower.ap_id != followed.ap_id do
305 |> List.delete(ap_followers)
309 |> follow_changeset(%{following: following})
310 |> update_and_set_cache
312 {:ok, followed} = update_follower_count(followed)
314 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
316 {:error, "Not subscribed!"}
320 @spec following?(User.t(), User.t()) :: boolean
321 def following?(%User{} = follower, %User{} = followed) do
322 Enum.member?(follower.following, followed.follower_address)
325 def locked?(%User{} = user) do
326 user.info.locked || false
329 def get_by_ap_id(ap_id) do
330 Repo.get_by(User, ap_id: ap_id)
333 def update_and_set_cache(changeset) do
334 with {:ok, user} <- Repo.update(changeset) do
335 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
336 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
337 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
344 def invalidate_cache(user) do
345 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
346 Cachex.del(:user_cache, "nickname:#{user.nickname}")
347 Cachex.del(:user_cache, "user_info:#{user.id}")
350 def get_cached_by_ap_id(ap_id) do
351 key = "ap_id:#{ap_id}"
352 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
355 def get_cached_by_nickname(nickname) do
356 key = "nickname:#{nickname}"
357 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
360 def get_by_nickname(nickname) do
361 Repo.get_by(User, nickname: nickname)
364 def get_by_nickname_or_email(nickname_or_email) do
365 case user = Repo.get_by(User, nickname: nickname_or_email) do
367 nil -> Repo.get_by(User, email: nickname_or_email)
371 def get_cached_user_info(user) do
372 key = "user_info:#{user.id}"
373 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
376 def fetch_by_nickname(nickname) do
377 ap_try = ActivityPub.make_user_from_nickname(nickname)
380 {:ok, user} -> {:ok, user}
381 _ -> OStatus.make_user(nickname)
385 def get_or_fetch_by_nickname(nickname) do
386 with %User{} = user <- get_by_nickname(nickname) do
390 with [_nick, _domain] <- String.split(nickname, "@"),
391 {:ok, user} <- fetch_by_nickname(nickname) do
399 def get_followers_query(%User{id: id, follower_address: follower_address}) do
402 where: fragment("? <@ ?", ^[follower_address], u.following),
407 def get_followers(user) do
408 q = get_followers_query(user)
413 def get_friends_query(%User{id: id, following: following}) do
416 where: u.follower_address in ^following,
421 def get_friends(user) do
422 q = get_friends_query(user)
427 def get_follow_requests_query(%User{} = user) do
432 "? ->> 'type' = 'Follow'",
437 "? ->> 'state' = 'pending'",
444 ^%{"object" => user.ap_id}
449 def get_follow_requests(%User{} = user) do
450 q = get_follow_requests_query(user)
454 Enum.map(reqs, fn req -> req.actor end)
456 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
457 |> Enum.filter(fn u -> !following?(u, user) end)
462 def increase_note_count(%User{} = user) do
463 info_cng = User.Info.add_to_note_count(user.info, 1)
467 |> put_embed(:info, info_cng)
469 update_and_set_cache(cng)
472 def decrease_note_count(%User{} = user) do
473 info_cng = User.Info.add_to_note_count(user.info, -1)
477 |> put_embed(:info, info_cng)
479 update_and_set_cache(cng)
482 def update_note_count(%User{} = user) do
486 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
490 note_count = Repo.one(note_count_query)
492 info_cng = User.Info.set_note_count(user.info, note_count)
496 |> put_embed(:info, info_cng)
498 update_and_set_cache(cng)
501 def update_follower_count(%User{} = user) do
502 follower_count_query =
505 where: ^user.follower_address in u.following,
506 where: u.id != ^user.id,
510 follower_count = Repo.one(follower_count_query)
514 |> User.Info.set_follower_count(follower_count)
518 |> put_embed(:info, info_cng)
520 update_and_set_cache(cng)
523 def get_users_from_set_query(ap_ids, false) do
526 where: u.ap_id in ^ap_ids
530 def get_users_from_set_query(ap_ids, true) do
531 query = get_users_from_set_query(ap_ids, false)
535 where: u.local == true
539 def get_users_from_set(ap_ids, local_only \\ true) do
540 get_users_from_set_query(ap_ids, local_only)
544 def get_recipients_from_activity(%Activity{recipients: to}) do
548 where: u.ap_id in ^to,
549 or_where: fragment("? && ?", u.following, ^to)
552 query = from(u in query, where: u.local == true)
557 def search(query, resolve \\ false) do
558 # strip the beginning @ off if there is a query
559 query = String.trim_leading(query, "@")
562 User.get_or_fetch_by_nickname(query)
577 where: not is_nil(u.nickname)
582 s in subquery(inner),
583 order_by: s.search_distance,
590 def block(blocker, %User{ap_id: ap_id} = blocked) do
591 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
593 if following?(blocker, blocked) do
594 {:ok, blocker, _} = unfollow(blocker, blocked)
600 if following?(blocked, blocker) do
601 unfollow(blocked, blocker)
606 |> User.Info.add_to_block(ap_id)
610 |> put_embed(:info, info_cng)
612 update_and_set_cache(cng)
615 # helper to handle the block given only an actor's AP id
616 def block(blocker, %{ap_id: ap_id}) do
617 block(blocker, User.get_by_ap_id(ap_id))
620 def unblock(blocker, %{ap_id: ap_id}) do
623 |> User.Info.remove_from_block(ap_id)
627 |> put_embed(:info, info_cng)
629 update_and_set_cache(cng)
632 def blocks?(user, %{ap_id: ap_id}) do
633 blocks = user.info.blocks
634 domain_blocks = user.info.domain_blocks
635 %{host: host} = URI.parse(ap_id)
637 Enum.member?(blocks, ap_id) ||
638 Enum.any?(domain_blocks, fn domain ->
643 def block_domain(user, domain) do
646 |> User.Info.add_to_domain_block(domain)
650 |> put_embed(:info, info_cng)
652 update_and_set_cache(cng)
655 def unblock_domain(user, domain) do
658 |> User.Info.remove_from_domain_block(domain)
662 |> put_embed(:info, info_cng)
664 update_and_set_cache(cng)
667 def local_user_query() do
670 where: u.local == true,
671 where: not is_nil(u.nickname)
675 def moderator_user_query() do
678 where: u.local == true,
679 where: fragment("?->'is_moderator' @> 'true'", u.info)
683 def deactivate(%User{} = user, status \\ true) do
684 info_cng = User.Info.set_activation_status(user.info, status)
688 |> put_embed(:info, info_cng)
690 update_and_set_cache(cng)
693 def delete(%User{} = user) do
694 {:ok, user} = User.deactivate(user)
696 # Remove all relationships
697 {:ok, followers} = User.get_followers(user)
700 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
702 {:ok, friends} = User.get_friends(user)
705 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
707 query = from(a in Activity, where: a.actor == ^user.ap_id)
710 |> Enum.each(fn activity ->
711 case activity.data["type"] do
713 ActivityPub.delete(Object.normalize(activity.data["object"]))
715 # TODO: Do something with likes, follows, repeats.
724 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
725 Pleroma.HTML.Scrubber.TwitterText
728 def html_filter_policy(_), do: nil
730 def get_or_fetch_by_ap_id(ap_id) do
731 user = get_by_ap_id(ap_id)
733 if !is_nil(user) and !User.needs_update?(user) do
736 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
743 case OStatus.make_user(ap_id) do
745 _ -> {:error, "Could not fetch by AP id"}
751 def get_or_create_instance_user do
752 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
754 if user = get_by_ap_id(relay_uri) do
758 %User{info: %User.Info{}}
759 |> cast(%{}, [:ap_id, :nickname, :local])
760 |> put_change(:ap_id, relay_uri)
761 |> put_change(:nickname, nil)
762 |> put_change(:local, true)
763 |> put_change(:follower_address, relay_uri <> "/followers")
765 {:ok, user} = Repo.insert(changes)
771 def public_key_from_info(%{
772 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
776 |> :public_key.pem_decode()
778 |> :public_key.pem_entry_decode()
784 def public_key_from_info(%{magic_key: magic_key}) do
785 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
788 def get_public_key_for_ap_id(ap_id) do
789 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
790 {:ok, public_key} <- public_key_from_info(user.info) do
797 defp blank?(""), do: nil
798 defp blank?(n), do: n
800 def insert_or_update_user(data) do
803 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
805 cs = User.remote_user_creation(data)
807 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
810 def ap_enabled?(%User{local: true}), do: true
811 def ap_enabled?(%User{info: info}), do: info.ap_enabled
812 def ap_enabled?(_), do: false
814 @doc "Gets or fetch a user by uri or nickname."
815 @spec get_or_fetch(String.t()) :: User.t()
816 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
817 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
819 # wait a period of time and return newest version of the User structs
820 # this is because we have synchronous follow APIs and need to simulate them
821 # with an async handshake
822 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
823 with %User{} = a <- Repo.get(User, a.id),
824 %User{} = b <- Repo.get(User, b.id) do
832 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
833 with :ok <- :timer.sleep(timeout),
834 %User{} = a <- Repo.get(User, a.id),
835 %User{} = b <- Repo.get(User, b.id) do
843 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
844 def parse_bio(nil, _user), do: ""
845 def parse_bio(bio, _user) when bio == "", do: bio
847 def parse_bio(bio, user) do
848 mentions = Formatter.parse_mentions(bio)
849 tags = Formatter.parse_tags(bio)
852 (user.info.source_data["tag"] || [])
853 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
854 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
855 {String.trim(name, ":"), url}
859 |> CommonUtils.format_input(mentions, tags, "text/plain")
860 |> Formatter.emojify(emoji)
863 def tag(user_identifiers, tags) when is_list(user_identifiers) do
864 Repo.transaction(fn ->
865 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
869 def tag(nickname, tags) when is_binary(nickname),
870 do: tag(User.get_by_nickname(nickname), tags)
872 def tag(%User{} = user, tags),
873 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
875 def untag(user_identifiers, tags) when is_list(user_identifiers) do
876 Repo.transaction(fn ->
877 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
881 def untag(nickname, tags) when is_binary(nickname),
882 do: untag(User.get_by_nickname(nickname), tags)
884 def untag(%User{} = user, tags),
885 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
887 defp update_tags(%User{} = user, new_tags) do
888 {:ok, updated_user} =
890 |> change(%{tags: new_tags})
896 defp normalize_tags(tags) do
899 |> Enum.map(&String.downcase(&1))
902 defp local_nickname_regex() do
903 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
904 @extended_local_nickname_regex
906 @strict_local_nickname_regex