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), do: user.info && !user.info.confirmation_pending
43 def avatar_url(user) do
45 %{"url" => [%{"href" => href} | _]} -> href
46 _ -> "#{Web.base_url()}/images/avi.png"
50 def banner_url(user) do
51 case user.info.banner do
52 %{"url" => [%{"href" => href} | _]} -> href
53 _ -> "#{Web.base_url()}/images/banner.png"
57 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
58 def profile_url(%User{ap_id: ap_id}), do: ap_id
59 def profile_url(_), do: nil
61 def ap_id(%User{nickname: nickname}) do
62 "#{Web.base_url()}/users/#{nickname}"
65 def ap_followers(%User{} = user) do
66 "#{ap_id(user)}/followers"
69 def follow_changeset(struct, params \\ %{}) do
71 |> cast(params, [:following])
72 |> validate_required([:following])
75 def user_info(%User{} = user) do
76 oneself = if user.local, do: 1, else: 0
80 following_count: length(user.following) - oneself,
81 note_count: user_info.note_count,
82 follower_count: user_info.follower_count,
83 locked: user_info.locked,
84 confirmation_pending: user_info.confirmation_pending,
85 default_scope: user_info.default_scope
89 def remote_user_creation(params) do
92 |> Map.put(:info, params[:info] || %{})
94 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
98 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
99 |> validate_required([:name, :ap_id])
100 |> unique_constraint(:nickname)
101 |> validate_format(:nickname, @email_regex)
102 |> validate_length(:bio, max: 5000)
103 |> validate_length(:name, max: 100)
104 |> put_change(:local, false)
105 |> put_embed(:info, info_cng)
108 case info_cng.changes[:source_data] do
109 %{"followers" => followers} ->
111 |> put_change(:follower_address, followers)
114 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
117 |> put_change(:follower_address, followers)
124 def update_changeset(struct, params \\ %{}) do
126 |> cast(params, [:bio, :name, :avatar])
127 |> unique_constraint(:nickname)
128 |> validate_format(:nickname, local_nickname_regex())
129 |> validate_length(:bio, max: 5000)
130 |> validate_length(:name, min: 1, max: 100)
133 def upgrade_changeset(struct, params \\ %{}) do
136 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
140 |> User.Info.user_upgrade(params[:info])
143 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
144 |> unique_constraint(:nickname)
145 |> validate_format(:nickname, local_nickname_regex())
146 |> validate_length(:bio, max: 5000)
147 |> validate_length(:name, max: 100)
148 |> put_embed(:info, info_cng)
151 def password_update_changeset(struct, params) do
154 |> cast(params, [:password, :password_confirmation])
155 |> validate_required([:password, :password_confirmation])
156 |> validate_confirmation(:password)
158 OAuth.Token.delete_user_tokens(struct)
159 OAuth.Authorization.delete_user_authorizations(struct)
161 if changeset.valid? do
162 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
165 |> put_change(:password_hash, hashed)
171 def reset_password(user, data) do
172 update_and_set_cache(password_update_changeset(user, data))
175 def register_changeset(struct, params \\ %{}, opts \\ []) do
176 confirmation_status =
177 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
185 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
186 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
187 |> validate_confirmation(:password)
188 |> unique_constraint(:email)
189 |> unique_constraint(:nickname)
190 |> validate_format(:nickname, local_nickname_regex())
191 |> validate_format(:email, @email_regex)
192 |> validate_length(:bio, max: 1000)
193 |> validate_length(:name, min: 1, max: 100)
194 |> put_change(:info, User.Info.confirmation_changeset(%User.Info{}, confirmation_status))
196 if changeset.valid? do
197 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
198 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
199 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
202 |> put_change(:password_hash, hashed)
203 |> put_change(:ap_id, ap_id)
204 |> put_change(:following, [followers])
205 |> put_change(:follower_address, followers)
211 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
212 def register(%Ecto.Changeset{} = changeset) do
213 with {:ok, user} <- Repo.insert(changeset) do
214 {:ok, _} = try_send_confirmation_email(user)
219 def try_send_confirmation_email(%User{} = user) do
220 if user.info.confirmation_pending do
222 |> Pleroma.UserEmail.account_confirmation_email()
223 |> Pleroma.Mailer.deliver()
229 def needs_update?(%User{local: true}), do: false
231 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
233 def needs_update?(%User{local: false} = user) do
234 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
237 def needs_update?(_), do: true
239 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
243 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
244 follow(follower, followed)
247 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
248 if not User.ap_enabled?(followed) do
249 follow(follower, followed)
255 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
256 if not following?(follower, followed) do
257 follow(follower, followed)
263 def follow(%User{} = follower, %User{info: info} = followed) do
264 user_config = Application.get_env(:pleroma, :user)
265 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
267 ap_followers = followed.follower_address
270 following?(follower, followed) or info.deactivated ->
271 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
273 deny_follow_blocked and blocks?(followed, follower) ->
274 {:error, "Could not follow user: #{followed.nickname} blocked you."}
277 if !followed.local && follower.local && !ap_enabled?(followed) do
278 Websub.subscribe(follower, followed)
282 [ap_followers | follower.following]
287 |> follow_changeset(%{following: following})
288 |> update_and_set_cache
290 {:ok, _} = update_follower_count(followed)
296 def unfollow(%User{} = follower, %User{} = followed) do
297 ap_followers = followed.follower_address
299 if following?(follower, followed) and follower.ap_id != followed.ap_id do
302 |> List.delete(ap_followers)
306 |> follow_changeset(%{following: following})
307 |> update_and_set_cache
309 {:ok, followed} = update_follower_count(followed)
311 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
313 {:error, "Not subscribed!"}
317 @spec following?(User.t(), User.t()) :: boolean
318 def following?(%User{} = follower, %User{} = followed) do
319 Enum.member?(follower.following, followed.follower_address)
322 def locked?(%User{} = user) do
323 user.info.locked || false
326 def get_by_ap_id(ap_id) do
327 Repo.get_by(User, ap_id: ap_id)
330 def update_and_set_cache(changeset) do
331 with {:ok, user} <- Repo.update(changeset) do
332 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
333 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
334 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
341 def invalidate_cache(user) do
342 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
343 Cachex.del(:user_cache, "nickname:#{user.nickname}")
344 Cachex.del(:user_cache, "user_info:#{user.id}")
347 def get_cached_by_ap_id(ap_id) do
348 key = "ap_id:#{ap_id}"
349 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
352 def get_cached_by_nickname(nickname) do
353 key = "nickname:#{nickname}"
354 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
357 def get_by_nickname(nickname) do
358 Repo.get_by(User, nickname: nickname)
361 def get_by_nickname_or_email(nickname_or_email) do
362 case user = Repo.get_by(User, nickname: nickname_or_email) do
364 nil -> Repo.get_by(User, email: nickname_or_email)
368 def get_cached_user_info(user) do
369 key = "user_info:#{user.id}"
370 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
373 def fetch_by_nickname(nickname) do
374 ap_try = ActivityPub.make_user_from_nickname(nickname)
377 {:ok, user} -> {:ok, user}
378 _ -> OStatus.make_user(nickname)
382 def get_or_fetch_by_nickname(nickname) do
383 with %User{} = user <- get_by_nickname(nickname) do
387 with [_nick, _domain] <- String.split(nickname, "@"),
388 {:ok, user} <- fetch_by_nickname(nickname) do
396 def get_by_confirmation_token(token) do
397 Repo.one(from(u in User, where: fragment("? ->> 'confirmation_token' = ?", u.info, ^token)))
400 def get_followers_query(%User{id: id, follower_address: follower_address}) do
403 where: fragment("? <@ ?", ^[follower_address], u.following),
408 def get_followers(user) do
409 q = get_followers_query(user)
414 def get_friends_query(%User{id: id, following: following}) do
417 where: u.follower_address in ^following,
422 def get_friends(user) do
423 q = get_friends_query(user)
428 def get_follow_requests_query(%User{} = user) do
433 "? ->> 'type' = 'Follow'",
438 "? ->> 'state' = 'pending'",
445 ^%{"object" => user.ap_id}
450 def get_follow_requests(%User{} = user) do
451 q = get_follow_requests_query(user)
455 Enum.map(reqs, fn req -> req.actor end)
457 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
458 |> Enum.filter(fn u -> !following?(u, user) end)
463 def increase_note_count(%User{} = user) do
464 info_cng = User.Info.add_to_note_count(user.info, 1)
468 |> put_embed(:info, info_cng)
470 update_and_set_cache(cng)
473 def decrease_note_count(%User{} = user) do
474 info_cng = User.Info.add_to_note_count(user.info, -1)
478 |> put_embed(:info, info_cng)
480 update_and_set_cache(cng)
483 def update_note_count(%User{} = user) do
487 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
491 note_count = Repo.one(note_count_query)
493 info_cng = User.Info.set_note_count(user.info, note_count)
497 |> put_embed(:info, info_cng)
499 update_and_set_cache(cng)
502 def update_follower_count(%User{} = user) do
503 follower_count_query =
506 where: ^user.follower_address in u.following,
507 where: u.id != ^user.id,
511 follower_count = Repo.one(follower_count_query)
515 |> User.Info.set_follower_count(follower_count)
519 |> put_embed(:info, info_cng)
521 update_and_set_cache(cng)
524 def get_users_from_set_query(ap_ids, false) do
527 where: u.ap_id in ^ap_ids
531 def get_users_from_set_query(ap_ids, true) do
532 query = get_users_from_set_query(ap_ids, false)
536 where: u.local == true
540 def get_users_from_set(ap_ids, local_only \\ true) do
541 get_users_from_set_query(ap_ids, local_only)
545 def get_recipients_from_activity(%Activity{recipients: to}) do
549 where: u.ap_id in ^to,
550 or_where: fragment("? && ?", u.following, ^to)
553 query = from(u in query, where: u.local == true)
558 def search(query, resolve \\ false) do
559 # strip the beginning @ off if there is a query
560 query = String.trim_leading(query, "@")
563 User.get_or_fetch_by_nickname(query)
578 where: not is_nil(u.nickname)
583 s in subquery(inner),
584 order_by: s.search_distance,
591 def block(blocker, %User{ap_id: ap_id} = blocked) do
592 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
594 if following?(blocker, blocked) do
595 {:ok, blocker, _} = unfollow(blocker, blocked)
601 if following?(blocked, blocker) do
602 unfollow(blocked, blocker)
607 |> User.Info.add_to_block(ap_id)
611 |> put_embed(:info, info_cng)
613 update_and_set_cache(cng)
616 # helper to handle the block given only an actor's AP id
617 def block(blocker, %{ap_id: ap_id}) do
618 block(blocker, User.get_by_ap_id(ap_id))
621 def unblock(blocker, %{ap_id: ap_id}) do
624 |> User.Info.remove_from_block(ap_id)
628 |> put_embed(:info, info_cng)
630 update_and_set_cache(cng)
633 def blocks?(user, %{ap_id: ap_id}) do
634 blocks = user.info.blocks
635 domain_blocks = user.info.domain_blocks
636 %{host: host} = URI.parse(ap_id)
638 Enum.member?(blocks, ap_id) ||
639 Enum.any?(domain_blocks, fn domain ->
644 def block_domain(user, domain) do
647 |> User.Info.add_to_domain_block(domain)
651 |> put_embed(:info, info_cng)
653 update_and_set_cache(cng)
656 def unblock_domain(user, domain) do
659 |> User.Info.remove_from_domain_block(domain)
663 |> put_embed(:info, info_cng)
665 update_and_set_cache(cng)
668 def local_user_query() do
671 where: u.local == true,
672 where: not is_nil(u.nickname)
676 def moderator_user_query() do
679 where: u.local == true,
680 where: fragment("?->'is_moderator' @> 'true'", u.info)
684 def deactivate(%User{} = user, status \\ true) do
685 info_cng = User.Info.set_activation_status(user.info, status)
689 |> put_embed(:info, info_cng)
691 update_and_set_cache(cng)
694 def delete(%User{} = user) do
695 {:ok, user} = User.deactivate(user)
697 # Remove all relationships
698 {:ok, followers} = User.get_followers(user)
701 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
703 {:ok, friends} = User.get_friends(user)
706 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
708 query = from(a in Activity, where: a.actor == ^user.ap_id)
711 |> Enum.each(fn activity ->
712 case activity.data["type"] do
714 ActivityPub.delete(Object.normalize(activity.data["object"]))
716 # TODO: Do something with likes, follows, repeats.
725 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
726 Pleroma.HTML.Scrubber.TwitterText
729 def html_filter_policy(_), do: nil
731 def get_or_fetch_by_ap_id(ap_id) do
732 user = get_by_ap_id(ap_id)
734 if !is_nil(user) and !User.needs_update?(user) do
737 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
744 case OStatus.make_user(ap_id) do
746 _ -> {:error, "Could not fetch by AP id"}
752 def get_or_create_instance_user do
753 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
755 if user = get_by_ap_id(relay_uri) do
759 %User{info: %User.Info{}}
760 |> cast(%{}, [:ap_id, :nickname, :local])
761 |> put_change(:ap_id, relay_uri)
762 |> put_change(:nickname, nil)
763 |> put_change(:local, true)
764 |> put_change(:follower_address, relay_uri <> "/followers")
766 {:ok, user} = Repo.insert(changes)
772 def public_key_from_info(%{
773 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
777 |> :public_key.pem_decode()
779 |> :public_key.pem_entry_decode()
785 def public_key_from_info(%{magic_key: magic_key}) do
786 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
789 def get_public_key_for_ap_id(ap_id) do
790 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
791 {:ok, public_key} <- public_key_from_info(user.info) do
798 defp blank?(""), do: nil
799 defp blank?(n), do: n
801 def insert_or_update_user(data) do
804 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
806 cs = User.remote_user_creation(data)
808 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
811 def ap_enabled?(%User{local: true}), do: true
812 def ap_enabled?(%User{info: info}), do: info.ap_enabled
813 def ap_enabled?(_), do: false
815 @doc "Gets or fetch a user by uri or nickname."
816 @spec get_or_fetch(String.t()) :: User.t()
817 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
818 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
820 # wait a period of time and return newest version of the User structs
821 # this is because we have synchronous follow APIs and need to simulate them
822 # with an async handshake
823 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
824 with %User{} = a <- Repo.get(User, a.id),
825 %User{} = b <- Repo.get(User, b.id) do
833 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
834 with :ok <- :timer.sleep(timeout),
835 %User{} = a <- Repo.get(User, a.id),
836 %User{} = b <- Repo.get(User, b.id) do
844 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
845 def parse_bio(nil, _user), do: ""
846 def parse_bio(bio, _user) when bio == "", do: bio
848 def parse_bio(bio, user) do
849 mentions = Formatter.parse_mentions(bio)
850 tags = Formatter.parse_tags(bio)
853 (user.info.source_data["tag"] || [])
854 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
855 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
856 {String.trim(name, ":"), url}
860 |> CommonUtils.format_input(mentions, tags, "text/plain")
861 |> Formatter.emojify(emoji)
864 def tag(user_identifiers, tags) when is_list(user_identifiers) do
865 Repo.transaction(fn ->
866 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
870 def tag(nickname, tags) when is_binary(nickname),
871 do: tag(User.get_by_nickname(nickname), tags)
873 def tag(%User{} = user, tags),
874 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
876 def untag(user_identifiers, tags) when is_list(user_identifiers) do
877 Repo.transaction(fn ->
878 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
882 def untag(nickname, tags) when is_binary(nickname),
883 do: untag(User.get_by_nickname(nickname), tags)
885 def untag(%User{} = user, tags),
886 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
888 defp update_tags(%User{} = user, new_tags) do
889 {:ok, updated_user} =
891 |> change(%{tags: new_tags})
897 defp normalize_tags(tags) do
900 |> Enum.map(&String.downcase(&1))
903 defp local_nickname_regex() do
904 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
905 @extended_local_nickname_regex
907 @strict_local_nickname_regex