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
79 following_count: length(user.following) - oneself,
80 note_count: user.info.note_count,
81 follower_count: user.info.follower_count,
82 locked: user.info.locked,
83 default_scope: user.info.default_scope
87 def remote_user_creation(params) do
90 |> Map.put(:info, params[:info] || %{})
92 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
96 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
97 |> validate_required([:name, :ap_id])
98 |> unique_constraint(:nickname)
99 |> validate_format(:nickname, @email_regex)
100 |> validate_length(:bio, max: 5000)
101 |> validate_length(:name, max: 100)
102 |> put_change(:local, false)
103 |> put_embed(:info, info_cng)
106 case info_cng.changes[:source_data] do
107 %{"followers" => followers} ->
109 |> put_change(:follower_address, followers)
112 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
115 |> put_change(:follower_address, followers)
122 def update_changeset(struct, params \\ %{}) do
124 |> cast(params, [:bio, :name, :avatar])
125 |> unique_constraint(:nickname)
126 |> validate_format(:nickname, local_nickname_regex())
127 |> validate_length(:bio, max: 5000)
128 |> validate_length(:name, min: 1, max: 100)
131 def upgrade_changeset(struct, params \\ %{}) do
134 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
138 |> User.Info.user_upgrade(params[:info])
141 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
142 |> unique_constraint(:nickname)
143 |> validate_format(:nickname, local_nickname_regex())
144 |> validate_length(:bio, max: 5000)
145 |> validate_length(:name, max: 100)
146 |> put_embed(:info, info_cng)
149 def password_update_changeset(struct, params) do
152 |> cast(params, [:password, :password_confirmation])
153 |> validate_required([:password, :password_confirmation])
154 |> validate_confirmation(:password)
156 OAuth.Token.delete_user_tokens(struct)
157 OAuth.Authorization.delete_user_authorizations(struct)
159 if changeset.valid? do
160 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
163 |> put_change(:password_hash, hashed)
169 def reset_password(user, data) do
170 update_and_set_cache(password_update_changeset(user, data))
173 def register_changeset(struct, params \\ %{}) do
176 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
177 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
178 |> validate_confirmation(:password)
179 |> unique_constraint(:email)
180 |> unique_constraint(:nickname)
181 |> validate_format(:nickname, local_nickname_regex())
182 |> validate_format(:email, @email_regex)
183 |> validate_length(:bio, max: 1000)
184 |> validate_length(:name, min: 1, max: 100)
185 |> put_change(:info, %Pleroma.User.Info{})
187 if changeset.valid? do
188 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
189 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
190 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
193 |> put_change(:password_hash, hashed)
194 |> put_change(:ap_id, ap_id)
195 |> put_change(:following, [followers])
196 |> put_change(:follower_address, followers)
202 def needs_update?(%User{local: true}), do: false
204 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
206 def needs_update?(%User{local: false} = user) do
207 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
210 def needs_update?(_), do: true
212 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
216 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
217 follow(follower, followed)
220 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
221 if not User.ap_enabled?(followed) do
222 follow(follower, followed)
228 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
229 if not following?(follower, followed) do
230 follow(follower, followed)
236 def follow(%User{} = follower, %User{info: info} = followed) do
237 user_config = Application.get_env(:pleroma, :user)
238 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
240 ap_followers = followed.follower_address
243 following?(follower, followed) or info.deactivated ->
244 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
246 deny_follow_blocked and blocks?(followed, follower) ->
247 {:error, "Could not follow user: #{followed.nickname} blocked you."}
250 if !followed.local && follower.local && !ap_enabled?(followed) do
251 Websub.subscribe(follower, followed)
255 [ap_followers | follower.following]
260 |> follow_changeset(%{following: following})
261 |> update_and_set_cache
263 {:ok, _} = update_follower_count(followed)
269 def unfollow(%User{} = follower, %User{} = followed) do
270 ap_followers = followed.follower_address
272 if following?(follower, followed) and follower.ap_id != followed.ap_id do
275 |> List.delete(ap_followers)
279 |> follow_changeset(%{following: following})
280 |> update_and_set_cache
282 {:ok, followed} = update_follower_count(followed)
284 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
286 {:error, "Not subscribed!"}
290 @spec following?(User.t(), User.t()) :: boolean
291 def following?(%User{} = follower, %User{} = followed) do
292 Enum.member?(follower.following, followed.follower_address)
295 def locked?(%User{} = user) do
296 user.info.locked || false
299 def get_by_ap_id(ap_id) do
300 Repo.get_by(User, ap_id: ap_id)
303 def update_and_set_cache(changeset) do
304 with {:ok, user} <- Repo.update(changeset) do
305 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
306 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
307 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
314 def invalidate_cache(user) do
315 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
316 Cachex.del(:user_cache, "nickname:#{user.nickname}")
317 Cachex.del(:user_cache, "user_info:#{user.id}")
320 def get_cached_by_ap_id(ap_id) do
321 key = "ap_id:#{ap_id}"
322 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
325 def get_cached_by_nickname(nickname) do
326 key = "nickname:#{nickname}"
327 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
330 def get_by_nickname(nickname) do
331 Repo.get_by(User, nickname: nickname)
334 def get_by_nickname_or_email(nickname_or_email) do
335 case user = Repo.get_by(User, nickname: nickname_or_email) do
337 nil -> Repo.get_by(User, email: nickname_or_email)
341 def get_cached_user_info(user) do
342 key = "user_info:#{user.id}"
343 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
346 def fetch_by_nickname(nickname) do
347 ap_try = ActivityPub.make_user_from_nickname(nickname)
350 {:ok, user} -> {:ok, user}
351 _ -> OStatus.make_user(nickname)
355 def get_or_fetch_by_nickname(nickname) do
356 with %User{} = user <- get_by_nickname(nickname) do
360 with [_nick, _domain] <- String.split(nickname, "@"),
361 {:ok, user} <- fetch_by_nickname(nickname) do
369 def get_by_confirmation_token(token) do
370 Repo.one(from(u in User, where: fragment("? ->> 'confirmation_token' = ?", u.info, ^token)))
373 def get_followers_query(%User{id: id, follower_address: follower_address}) do
376 where: fragment("? <@ ?", ^[follower_address], u.following),
381 def get_followers(user) do
382 q = get_followers_query(user)
387 def get_friends_query(%User{id: id, following: following}) do
390 where: u.follower_address in ^following,
395 def get_friends(user) do
396 q = get_friends_query(user)
401 def get_follow_requests_query(%User{} = user) do
406 "? ->> 'type' = 'Follow'",
411 "? ->> 'state' = 'pending'",
418 ^%{"object" => user.ap_id}
423 def get_follow_requests(%User{} = user) do
424 q = get_follow_requests_query(user)
428 Enum.map(reqs, fn req -> req.actor end)
430 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
431 |> Enum.filter(fn u -> !following?(u, user) end)
436 def increase_note_count(%User{} = user) do
437 info_cng = User.Info.add_to_note_count(user.info, 1)
441 |> put_embed(:info, info_cng)
443 update_and_set_cache(cng)
446 def decrease_note_count(%User{} = user) do
447 info_cng = User.Info.add_to_note_count(user.info, -1)
451 |> put_embed(:info, info_cng)
453 update_and_set_cache(cng)
456 def update_note_count(%User{} = user) do
460 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
464 note_count = Repo.one(note_count_query)
466 info_cng = User.Info.set_note_count(user.info, note_count)
470 |> put_embed(:info, info_cng)
472 update_and_set_cache(cng)
475 def update_follower_count(%User{} = user) do
476 follower_count_query =
479 where: ^user.follower_address in u.following,
480 where: u.id != ^user.id,
484 follower_count = Repo.one(follower_count_query)
488 |> User.Info.set_follower_count(follower_count)
492 |> put_embed(:info, info_cng)
494 update_and_set_cache(cng)
497 def get_users_from_set_query(ap_ids, false) do
500 where: u.ap_id in ^ap_ids
504 def get_users_from_set_query(ap_ids, true) do
505 query = get_users_from_set_query(ap_ids, false)
509 where: u.local == true
513 def get_users_from_set(ap_ids, local_only \\ true) do
514 get_users_from_set_query(ap_ids, local_only)
518 def get_recipients_from_activity(%Activity{recipients: to}) do
522 where: u.ap_id in ^to,
523 or_where: fragment("? && ?", u.following, ^to)
526 query = from(u in query, where: u.local == true)
531 def search(query, resolve \\ false) do
532 # strip the beginning @ off if there is a query
533 query = String.trim_leading(query, "@")
536 User.get_or_fetch_by_nickname(query)
551 where: not is_nil(u.nickname)
556 s in subquery(inner),
557 order_by: s.search_distance,
564 def block(blocker, %User{ap_id: ap_id} = blocked) do
565 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
567 if following?(blocker, blocked) do
568 {:ok, blocker, _} = unfollow(blocker, blocked)
574 if following?(blocked, blocker) do
575 unfollow(blocked, blocker)
580 |> User.Info.add_to_block(ap_id)
584 |> put_embed(:info, info_cng)
586 update_and_set_cache(cng)
589 # helper to handle the block given only an actor's AP id
590 def block(blocker, %{ap_id: ap_id}) do
591 block(blocker, User.get_by_ap_id(ap_id))
594 def unblock(blocker, %{ap_id: ap_id}) do
597 |> User.Info.remove_from_block(ap_id)
601 |> put_embed(:info, info_cng)
603 update_and_set_cache(cng)
606 def blocks?(user, %{ap_id: ap_id}) do
607 blocks = user.info.blocks
608 domain_blocks = user.info.domain_blocks
609 %{host: host} = URI.parse(ap_id)
611 Enum.member?(blocks, ap_id) ||
612 Enum.any?(domain_blocks, fn domain ->
617 def block_domain(user, domain) do
620 |> User.Info.add_to_domain_block(domain)
624 |> put_embed(:info, info_cng)
626 update_and_set_cache(cng)
629 def unblock_domain(user, domain) do
632 |> User.Info.remove_from_domain_block(domain)
636 |> put_embed(:info, info_cng)
638 update_and_set_cache(cng)
641 def local_user_query() do
644 where: u.local == true,
645 where: not is_nil(u.nickname)
649 def moderator_user_query() do
652 where: u.local == true,
653 where: fragment("?->'is_moderator' @> 'true'", u.info)
657 def deactivate(%User{} = user, status \\ true) do
658 info_cng = User.Info.set_activation_status(user.info, status)
662 |> put_embed(:info, info_cng)
664 update_and_set_cache(cng)
667 def delete(%User{} = user) do
668 {:ok, user} = User.deactivate(user)
670 # Remove all relationships
671 {:ok, followers} = User.get_followers(user)
674 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
676 {:ok, friends} = User.get_friends(user)
679 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
681 query = from(a in Activity, where: a.actor == ^user.ap_id)
684 |> Enum.each(fn activity ->
685 case activity.data["type"] do
687 ActivityPub.delete(Object.normalize(activity.data["object"]))
689 # TODO: Do something with likes, follows, repeats.
698 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
699 Pleroma.HTML.Scrubber.TwitterText
702 def html_filter_policy(_), do: nil
704 def get_or_fetch_by_ap_id(ap_id) do
705 user = get_by_ap_id(ap_id)
707 if !is_nil(user) and !User.needs_update?(user) do
710 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
717 case OStatus.make_user(ap_id) do
719 _ -> {:error, "Could not fetch by AP id"}
725 def get_or_create_instance_user do
726 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
728 if user = get_by_ap_id(relay_uri) do
732 %User{info: %User.Info{}}
733 |> cast(%{}, [:ap_id, :nickname, :local])
734 |> put_change(:ap_id, relay_uri)
735 |> put_change(:nickname, nil)
736 |> put_change(:local, true)
737 |> put_change(:follower_address, relay_uri <> "/followers")
739 {:ok, user} = Repo.insert(changes)
745 def public_key_from_info(%{
746 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
750 |> :public_key.pem_decode()
752 |> :public_key.pem_entry_decode()
758 def public_key_from_info(%{magic_key: magic_key}) do
759 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
762 def get_public_key_for_ap_id(ap_id) do
763 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
764 {:ok, public_key} <- public_key_from_info(user.info) do
771 defp blank?(""), do: nil
772 defp blank?(n), do: n
774 def insert_or_update_user(data) do
777 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
779 cs = User.remote_user_creation(data)
781 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
784 def ap_enabled?(%User{local: true}), do: true
785 def ap_enabled?(%User{info: info}), do: info.ap_enabled
786 def ap_enabled?(_), do: false
788 @doc "Gets or fetch a user by uri or nickname."
789 @spec get_or_fetch(String.t()) :: User.t()
790 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
791 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
793 # wait a period of time and return newest version of the User structs
794 # this is because we have synchronous follow APIs and need to simulate them
795 # with an async handshake
796 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
797 with %User{} = a <- Repo.get(User, a.id),
798 %User{} = b <- Repo.get(User, b.id) do
806 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
807 with :ok <- :timer.sleep(timeout),
808 %User{} = a <- Repo.get(User, a.id),
809 %User{} = b <- Repo.get(User, b.id) do
817 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
818 def parse_bio(nil, _user), do: ""
819 def parse_bio(bio, _user) when bio == "", do: bio
821 def parse_bio(bio, user) do
822 mentions = Formatter.parse_mentions(bio)
823 tags = Formatter.parse_tags(bio)
826 (user.info.source_data["tag"] || [])
827 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
828 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
829 {String.trim(name, ":"), url}
833 |> CommonUtils.format_input(mentions, tags, "text/plain")
834 |> Formatter.emojify(emoji)
837 def tag(user_identifiers, tags) when is_list(user_identifiers) do
838 Repo.transaction(fn ->
839 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
843 def tag(nickname, tags) when is_binary(nickname),
844 do: tag(User.get_by_nickname(nickname), tags)
846 def tag(%User{} = user, tags),
847 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
849 def untag(user_identifiers, tags) when is_list(user_identifiers) do
850 Repo.transaction(fn ->
851 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
855 def untag(nickname, tags) when is_binary(nickname),
856 do: untag(User.get_by_nickname(nickname), tags)
858 def untag(%User{} = user, tags),
859 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
861 defp update_tags(%User{} = user, new_tags) do
862 {:ok, updated_user} =
864 |> change(%{tags: new_tags})
870 defp normalize_tags(tags) do
873 |> Enum.map(&String.downcase(&1))
876 defp local_nickname_regex() do
877 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
878 @extended_local_nickname_regex
880 @strict_local_nickname_regex