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__{}
16 field(:email, :string)
18 field(:nickname, :string)
19 field(:password_hash, :string)
20 field(:password, :string, virtual: true)
21 field(:password_confirmation, :string, virtual: true)
22 field(:following, {:array, :string}, default: [])
23 field(:ap_id, :string)
25 field(:local, :boolean, default: true)
26 field(:follower_address, :string)
27 field(:search_distance, :float, virtual: true)
28 field(:tags, {:array, :string}, default: [])
29 field(:last_refreshed_at, :naive_datetime)
30 has_many(:notifications, Notification)
31 embeds_one(:info, Pleroma.User.Info)
36 def avatar_url(user) do
38 %{"url" => [%{"href" => href} | _]} -> href
39 _ -> "#{Web.base_url()}/images/avi.png"
43 def banner_url(user) do
44 case user.info.banner do
45 %{"url" => [%{"href" => href} | _]} -> href
46 _ -> "#{Web.base_url()}/images/banner.png"
50 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
51 def profile_url(%User{ap_id: ap_id}), do: ap_id
52 def profile_url(_), do: nil
54 def ap_id(%User{nickname: nickname}) do
55 "#{Web.base_url()}/users/#{nickname}"
58 def ap_followers(%User{} = user) do
59 "#{ap_id(user)}/followers"
62 def follow_changeset(struct, params \\ %{}) do
64 |> cast(params, [:following])
65 |> validate_required([:following])
68 def user_info(%User{} = user) do
69 oneself = if user.local, do: 1, else: 0
72 following_count: length(user.following) - oneself,
73 note_count: user.info.note_count,
74 follower_count: user.info.follower_count,
75 locked: user.info.locked,
76 default_scope: user.info.default_scope
80 @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])?)*$/
81 def remote_user_creation(params) do
84 |> Map.put(:info, params[:info] || %{})
86 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
90 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
91 |> validate_required([:name, :ap_id])
92 |> unique_constraint(:nickname)
93 |> validate_format(:nickname, @email_regex)
94 |> validate_length(:bio, max: 5000)
95 |> validate_length(:name, max: 100)
96 |> put_change(:local, false)
97 |> put_embed(:info, info_cng)
100 case info_cng.changes[:source_data] do
101 %{"followers" => followers} ->
103 |> put_change(:follower_address, followers)
106 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
109 |> put_change(:follower_address, followers)
116 def update_changeset(struct, params \\ %{}) do
118 |> cast(params, [:bio, :name, :avatar])
119 |> unique_constraint(:nickname)
120 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
121 |> validate_length(:bio, max: 5000)
122 |> validate_length(:name, min: 1, max: 100)
125 def upgrade_changeset(struct, params \\ %{}) do
128 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
132 |> User.Info.user_upgrade(params[:info])
135 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
136 |> unique_constraint(:nickname)
137 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
138 |> validate_length(:bio, max: 5000)
139 |> validate_length(:name, max: 100)
140 |> put_embed(:info, info_cng)
143 def password_update_changeset(struct, params) do
146 |> cast(params, [:password, :password_confirmation])
147 |> validate_required([:password, :password_confirmation])
148 |> validate_confirmation(:password)
150 OAuth.Token.delete_user_tokens(struct)
151 OAuth.Authorization.delete_user_authorizations(struct)
153 if changeset.valid? do
154 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
157 |> put_change(:password_hash, hashed)
163 def reset_password(user, data) do
164 update_and_set_cache(password_update_changeset(user, data))
167 def register_changeset(struct, params \\ %{}) do
170 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
171 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
172 |> validate_confirmation(:password)
173 |> unique_constraint(:email)
174 |> unique_constraint(:nickname)
175 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
176 |> validate_format(:email, @email_regex)
177 |> validate_length(:bio, max: 1000)
178 |> validate_length(:name, min: 1, max: 100)
179 |> put_change(:info, %Pleroma.User.Info{})
181 if changeset.valid? do
182 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
183 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
184 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
187 |> put_change(:password_hash, hashed)
188 |> put_change(:ap_id, ap_id)
189 |> put_change(:following, [followers])
190 |> put_change(:follower_address, followers)
196 def needs_update?(%User{local: true}), do: false
198 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
200 def needs_update?(%User{local: false} = user) do
201 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
204 def needs_update?(_), do: true
206 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
210 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
211 follow(follower, followed)
214 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
215 if not User.ap_enabled?(followed) do
216 follow(follower, followed)
222 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
223 if not following?(follower, followed) do
224 follow(follower, followed)
230 def follow(%User{} = follower, %User{info: info} = followed) do
231 user_config = Application.get_env(:pleroma, :user)
232 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
234 ap_followers = followed.follower_address
237 following?(follower, followed) or info.deactivated ->
238 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
240 deny_follow_blocked and blocks?(followed, follower) ->
241 {:error, "Could not follow user: #{followed.nickname} blocked you."}
244 if !followed.local && follower.local && !ap_enabled?(followed) do
245 Websub.subscribe(follower, followed)
249 [ap_followers | follower.following]
254 |> follow_changeset(%{following: following})
255 |> update_and_set_cache
257 {:ok, _} = update_follower_count(followed)
263 def unfollow(%User{} = follower, %User{} = followed) do
264 ap_followers = followed.follower_address
266 if following?(follower, followed) and follower.ap_id != followed.ap_id do
269 |> List.delete(ap_followers)
273 |> follow_changeset(%{following: following})
274 |> update_and_set_cache
276 {:ok, followed} = update_follower_count(followed)
278 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
280 {:error, "Not subscribed!"}
284 @spec following?(User.t(), User.t()) :: boolean
285 def following?(%User{} = follower, %User{} = followed) do
286 Enum.member?(follower.following, followed.follower_address)
289 def locked?(%User{} = user) do
290 user.info.locked || false
293 def get_by_ap_id(ap_id) do
294 Repo.get_by(User, ap_id: ap_id)
297 def update_and_set_cache(changeset) do
298 with {:ok, user} <- Repo.update(changeset) do
299 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
300 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
301 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
308 def invalidate_cache(user) do
309 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
310 Cachex.del(:user_cache, "nickname:#{user.nickname}")
311 Cachex.del(:user_cache, "user_info:#{user.id}")
314 def get_cached_by_ap_id(ap_id) do
315 key = "ap_id:#{ap_id}"
316 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
319 def get_cached_by_nickname(nickname) do
320 key = "nickname:#{nickname}"
321 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
324 def get_by_nickname(nickname) do
325 Repo.get_by(User, nickname: nickname)
328 def get_by_nickname_or_email(nickname_or_email) do
329 case user = Repo.get_by(User, nickname: nickname_or_email) do
331 nil -> Repo.get_by(User, email: nickname_or_email)
335 def get_cached_user_info(user) do
336 key = "user_info:#{user.id}"
337 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
340 def fetch_by_nickname(nickname) do
341 ap_try = ActivityPub.make_user_from_nickname(nickname)
344 {:ok, user} -> {:ok, user}
345 _ -> OStatus.make_user(nickname)
349 def get_or_fetch_by_nickname(nickname) do
350 with %User{} = user <- get_by_nickname(nickname) do
354 with [_nick, _domain] <- String.split(nickname, "@"),
355 {:ok, user} <- fetch_by_nickname(nickname) do
363 def get_followers_query(%User{id: id, follower_address: follower_address}) do
366 where: fragment("? <@ ?", ^[follower_address], u.following),
371 def get_followers(user) do
372 q = get_followers_query(user)
377 def get_friends_query(%User{id: id, following: following}) do
380 where: u.follower_address in ^following,
385 def get_friends(user) do
386 q = get_friends_query(user)
391 def get_follow_requests_query(%User{} = user) do
396 "? ->> 'type' = 'Follow'",
401 "? ->> 'state' = 'pending'",
408 ^%{"object" => user.ap_id}
413 def get_follow_requests(%User{} = user) do
414 q = get_follow_requests_query(user)
418 Enum.map(reqs, fn req -> req.actor end)
420 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
421 |> Enum.filter(fn u -> !following?(u, user) end)
426 def increase_note_count(%User{} = user) do
427 info_cng = User.Info.add_to_note_count(user.info, 1)
431 |> put_embed(:info, info_cng)
433 update_and_set_cache(cng)
436 def decrease_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 update_note_count(%User{} = user) do
450 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
454 note_count = Repo.one(note_count_query)
456 info_cng = User.Info.set_note_count(user.info, note_count)
460 |> put_embed(:info, info_cng)
462 update_and_set_cache(cng)
465 def update_follower_count(%User{} = user) do
466 follower_count_query =
469 where: ^user.follower_address in u.following,
470 where: u.id != ^user.id,
474 follower_count = Repo.one(follower_count_query)
478 |> User.Info.set_follower_count(follower_count)
482 |> put_embed(:info, info_cng)
484 update_and_set_cache(cng)
487 def get_users_from_set_query(ap_ids, false) do
490 where: u.ap_id in ^ap_ids
494 def get_users_from_set_query(ap_ids, true) do
495 query = get_users_from_set_query(ap_ids, false)
499 where: u.local == true
503 def get_users_from_set(ap_ids, local_only \\ true) do
504 get_users_from_set_query(ap_ids, local_only)
508 def get_recipients_from_activity(%Activity{recipients: to}) do
512 where: u.ap_id in ^to,
513 or_where: fragment("? && ?", u.following, ^to)
516 query = from(u in query, where: u.local == true)
521 def search(query, resolve \\ false) do
522 # strip the beginning @ off if there is a query
523 query = String.trim_leading(query, "@")
526 User.get_or_fetch_by_nickname(query)
541 where: not is_nil(u.nickname)
546 s in subquery(inner),
547 order_by: s.search_distance,
554 def block(blocker, %User{ap_id: ap_id} = blocked) do
555 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
557 if following?(blocker, blocked) do
558 {:ok, blocker, _} = unfollow(blocker, blocked)
564 if following?(blocked, blocker) do
565 unfollow(blocked, blocker)
570 |> User.Info.add_to_block(ap_id)
574 |> put_embed(:info, info_cng)
576 update_and_set_cache(cng)
579 # helper to handle the block given only an actor's AP id
580 def block(blocker, %{ap_id: ap_id}) do
581 block(blocker, User.get_by_ap_id(ap_id))
584 def unblock(blocker, %{ap_id: ap_id}) do
587 |> User.Info.remove_from_block(ap_id)
591 |> put_embed(:info, info_cng)
593 update_and_set_cache(cng)
596 def blocks?(user, %{ap_id: ap_id}) do
597 blocks = user.info.blocks
598 domain_blocks = user.info.domain_blocks
599 %{host: host} = URI.parse(ap_id)
601 Enum.member?(blocks, ap_id) ||
602 Enum.any?(domain_blocks, fn domain ->
607 def block_domain(user, domain) do
610 |> User.Info.add_to_domain_block(domain)
614 |> put_embed(:info, info_cng)
616 update_and_set_cache(cng)
619 def unblock_domain(user, domain) do
622 |> User.Info.remove_from_domain_block(domain)
626 |> put_embed(:info, info_cng)
628 update_and_set_cache(cng)
631 def local_user_query() do
634 where: u.local == true,
635 where: not is_nil(u.nickname)
639 def moderator_user_query() do
642 where: u.local == true,
643 where: fragment("?->'is_moderator' @> 'true'", u.info)
647 def deactivate(%User{} = user, status \\ true) do
648 info_cng = User.Info.set_activation_status(user.info, status)
652 |> put_embed(:info, info_cng)
654 update_and_set_cache(cng)
657 def delete(%User{} = user) do
658 {:ok, user} = User.deactivate(user)
660 # Remove all relationships
661 {:ok, followers} = User.get_followers(user)
664 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
666 {:ok, friends} = User.get_friends(user)
669 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
671 query = from(a in Activity, where: a.actor == ^user.ap_id)
674 |> Enum.each(fn activity ->
675 case activity.data["type"] do
677 ActivityPub.delete(Object.normalize(activity.data["object"]))
679 # TODO: Do something with likes, follows, repeats.
688 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
689 Pleroma.HTML.Scrubber.TwitterText
692 def html_filter_policy(_), do: nil
694 def get_or_fetch_by_ap_id(ap_id) do
695 user = get_by_ap_id(ap_id)
697 if !is_nil(user) and !User.needs_update?(user) do
700 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
707 case OStatus.make_user(ap_id) do
709 _ -> {:error, "Could not fetch by AP id"}
715 def get_or_create_instance_user do
716 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
718 if user = get_by_ap_id(relay_uri) do
722 %User{info: %User.Info{}}
723 |> cast(%{}, [:ap_id, :nickname, :local])
724 |> put_change(:ap_id, relay_uri)
725 |> put_change(:nickname, nil)
726 |> put_change(:local, true)
727 |> put_change(:follower_address, relay_uri <> "/followers")
729 {:ok, user} = Repo.insert(changes)
735 def public_key_from_info(%{
736 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
740 |> :public_key.pem_decode()
742 |> :public_key.pem_entry_decode()
748 def public_key_from_info(%{magic_key: magic_key}) do
749 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
752 def get_public_key_for_ap_id(ap_id) do
753 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
754 {:ok, public_key} <- public_key_from_info(user.info) do
761 defp blank?(""), do: nil
762 defp blank?(n), do: n
764 def insert_or_update_user(data) do
767 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
769 cs = User.remote_user_creation(data)
771 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
774 def ap_enabled?(%User{local: true}), do: true
775 def ap_enabled?(%User{info: info}), do: info.ap_enabled
776 def ap_enabled?(_), do: false
778 @doc "Gets or fetch a user by uri or nickname."
779 @spec get_or_fetch(String.t()) :: User.t()
780 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
781 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
783 # wait a period of time and return newest version of the User structs
784 # this is because we have synchronous follow APIs and need to simulate them
785 # with an async handshake
786 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
787 with %User{} = a <- Repo.get(User, a.id),
788 %User{} = b <- Repo.get(User, b.id) do
796 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
797 with :ok <- :timer.sleep(timeout),
798 %User{} = a <- Repo.get(User, a.id),
799 %User{} = b <- Repo.get(User, b.id) do
807 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
808 def parse_bio(nil, _user), do: ""
809 def parse_bio(bio, _user) when bio == "", do: bio
811 def parse_bio(bio, user) do
812 mentions = Formatter.parse_mentions(bio)
813 tags = Formatter.parse_tags(bio)
816 (user.info.source_data["tag"] || [])
817 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
818 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
819 {String.trim(name, ":"), url}
823 |> CommonUtils.format_input(mentions, tags, "text/plain")
824 |> Formatter.emojify(emoji)
827 def tag(user_identifiers, tags) when is_list(user_identifiers) do
828 Repo.transaction(fn ->
829 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
833 def tag(nickname, tags) when is_binary(nickname),
834 do: tag(User.get_by_nickname(nickname), tags)
836 def tag(%User{} = user, tags),
837 do: update_tags(user, Enum.uniq(user.tags ++ normalize_tags(tags)))
839 def untag(user_identifiers, tags) when is_list(user_identifiers) do
840 Repo.transaction(fn ->
841 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
845 def untag(nickname, tags) when is_binary(nickname),
846 do: untag(User.get_by_nickname(nickname), tags)
848 def untag(%User{} = user, tags), do: update_tags(user, user.tags -- normalize_tags(tags))
850 defp update_tags(%User{} = user, new_tags) do
851 {:ok, updated_user} =
853 |> change(%{tags: new_tags})
859 defp normalize_tags(tags) do
862 |> Enum.map(&String.downcase(&1))