1 defmodule Pleroma.User do
4 import Ecto.{Changeset, Query}
5 alias Pleroma.{Repo, User, Object, Web, Activity, Notification}
7 alias Pleroma.Web.{OStatus, Websub, OAuth}
8 alias Pleroma.Web.ActivityPub.{Utils, ActivityPub}
12 field(:email, :string)
14 field(:nickname, :string)
15 field(:password_hash, :string)
16 field(:password, :string, virtual: true)
17 field(:password_confirmation, :string, virtual: true)
18 field(:following, {:array, :string}, default: [])
19 field(:ap_id, :string)
21 field(:local, :boolean, default: true)
22 field(:follower_address, :string)
23 field(:search_distance, :float, virtual: true)
24 field(:last_refreshed_at, :naive_datetime)
25 has_many(:notifications, Notification)
26 embeds_one(:info, Pleroma.User.Info)
31 def avatar_url(user) do
33 %{"url" => [%{"href" => href} | _]} -> href
34 _ -> "#{Web.base_url()}/images/avi.png"
38 def banner_url(user) do
39 case user.info.banner do
40 %{"url" => [%{"href" => href} | _]} -> href
41 _ -> "#{Web.base_url()}/images/banner.png"
45 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
46 def profile_url(%User{ap_id: ap_id}), do: ap_id
47 def profile_url(_), do: nil
49 def ap_id(%User{nickname: nickname}) do
50 "#{Web.base_url()}/users/#{nickname}"
53 def ap_followers(%User{} = user) do
54 "#{ap_id(user)}/followers"
57 def follow_changeset(struct, params \\ %{}) do
59 |> cast(params, [:following])
60 |> validate_required([:following])
63 def info_changeset(struct, params \\ %{}) do
64 raise "NOT VALID ANYMORE"
67 def user_info(%User{} = user) do
68 oneself = if user.local, do: 1, else: 0
71 following_count: length(user.following) - oneself,
72 note_count: user.info.note_count,
73 follower_count: user.info.follower_count,
74 locked: user.info.locked,
75 default_scope: user.info.default_scope
79 @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])?)*$/
80 def remote_user_creation(params) do
83 |> Map.put(:info, params[:info] || %{})
85 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
89 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
90 |> validate_required([:name, :ap_id])
91 |> unique_constraint(:nickname)
92 |> validate_format(:nickname, @email_regex)
93 |> validate_length(:bio, max: 5000)
94 |> validate_length(:name, max: 100)
95 |> put_change(:local, false)
96 |> put_embed(:info, info_cng)
99 case info_cng.changes[:source_data] do
100 %{"followers" => followers} ->
102 |> put_change(:follower_address, followers)
105 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
108 |> put_change(:follower_address, followers)
115 def update_changeset(struct, params \\ %{}) do
117 |> cast(params, [:bio, :name, :avatar])
118 |> unique_constraint(:nickname)
119 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
120 |> validate_length(:bio, max: 5000)
121 |> validate_length(:name, min: 1, max: 100)
124 def upgrade_changeset(struct, params \\ %{}) do
127 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
131 |> User.Info.user_upgrade(params[:info])
134 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
135 |> unique_constraint(:nickname)
136 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
137 |> validate_length(:bio, max: 5000)
138 |> validate_length(:name, max: 100)
139 |> put_embed(:info, info_cng)
142 def password_update_changeset(struct, params) do
145 |> cast(params, [:password, :password_confirmation])
146 |> validate_required([:password, :password_confirmation])
147 |> validate_confirmation(:password)
149 OAuth.Token.delete_user_tokens(struct)
150 OAuth.Authorization.delete_user_authorizations(struct)
152 if changeset.valid? do
153 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
156 |> put_change(:password_hash, hashed)
162 def reset_password(user, data) do
163 update_and_set_cache(password_update_changeset(user, data))
166 def register_changeset(struct, params \\ %{}) do
169 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
170 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
171 |> validate_confirmation(:password)
172 |> unique_constraint(:email)
173 |> unique_constraint(:nickname)
174 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
175 |> validate_format(:email, @email_regex)
176 |> validate_length(:bio, max: 1000)
177 |> validate_length(:name, min: 1, max: 100)
179 if changeset.valid? do
180 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
181 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
182 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
185 |> put_change(:password_hash, hashed)
186 |> put_change(:ap_id, ap_id)
187 |> put_change(:following, [followers])
188 |> put_change(:follower_address, followers)
194 def needs_update?(%User{local: true}), do: false
196 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
198 def needs_update?(%User{local: false} = user) do
199 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
202 def needs_update?(_), do: true
204 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
208 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
209 follow(follower, followed)
212 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
213 if !User.ap_enabled?(followed) do
214 follow(follower, followed)
220 def maybe_follow(%User{} = follower, %User{info: info} = followed) do
221 if not following?(follower, followed) do
222 follow(follower, followed)
228 def follow(%User{} = follower, %User{info: info} = followed) do
229 user_config = Application.get_env(:pleroma, :user)
230 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
232 ap_followers = followed.follower_address
235 following?(follower, followed) or info.deactivated ->
236 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
238 deny_follow_blocked and blocks?(followed, follower) ->
239 {:error, "Could not follow user: #{followed.nickname} blocked you."}
242 if !followed.local && follower.local && !ap_enabled?(followed) do
243 Websub.subscribe(follower, followed)
247 [ap_followers | follower.following]
252 |> follow_changeset(%{following: following})
253 |> update_and_set_cache
255 {:ok, _} = update_follower_count(followed)
261 def unfollow(%User{} = follower, %User{} = followed) do
262 ap_followers = followed.follower_address
264 if following?(follower, followed) and follower.ap_id != followed.ap_id do
267 |> List.delete(ap_followers)
271 |> follow_changeset(%{following: following})
272 |> update_and_set_cache
274 {:ok, followed} = update_follower_count(followed)
276 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
278 {:error, "Not subscribed!"}
282 def following?(%User{} = follower, %User{} = followed) do
283 Enum.member?(follower.following, followed.follower_address)
286 def locked?(%User{} = user) do
287 user.info.locked || false
290 def get_by_ap_id(ap_id) do
291 Repo.get_by(User, ap_id: ap_id)
294 def update_and_set_cache(changeset) do
295 with {:ok, user} <- Repo.update(changeset) do
296 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
297 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
298 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
305 def invalidate_cache(user) do
306 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
307 Cachex.del(:user_cache, "nickname:#{user.nickname}")
308 Cachex.del(:user_cache, "user_info:#{user.id}")
311 def get_cached_by_ap_id(ap_id) do
312 key = "ap_id:#{ap_id}"
313 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
316 def get_cached_by_nickname(nickname) do
317 key = "nickname:#{nickname}"
318 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
321 def get_by_nickname(nickname) do
322 Repo.get_by(User, nickname: nickname)
325 def get_by_nickname_or_email(nickname_or_email) do
326 case user = Repo.get_by(User, nickname: nickname_or_email) do
328 nil -> Repo.get_by(User, email: nickname_or_email)
332 def get_cached_user_info(user) do
333 key = "user_info:#{user.id}"
334 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
337 def fetch_by_nickname(nickname) do
338 ap_try = ActivityPub.make_user_from_nickname(nickname)
341 {:ok, user} -> {:ok, user}
342 _ -> OStatus.make_user(nickname)
346 def get_or_fetch_by_nickname(nickname) do
347 with %User{} = user <- get_by_nickname(nickname) do
351 with [_nick, _domain] <- String.split(nickname, "@"),
352 {:ok, user} <- fetch_by_nickname(nickname) do
360 def get_followers_query(%User{id: id, follower_address: follower_address}) do
363 where: fragment("? <@ ?", ^[follower_address], u.following),
368 def get_followers(user) do
369 q = get_followers_query(user)
374 def get_friends_query(%User{id: id, following: following}) do
377 where: u.follower_address in ^following,
382 def get_friends(user) do
383 q = get_friends_query(user)
388 def get_follow_requests_query(%User{} = user) do
393 "? ->> 'type' = 'Follow'",
398 "? ->> 'state' = 'pending'",
405 ^%{"object" => user.ap_id}
410 def get_follow_requests(%User{} = user) do
411 q = get_follow_requests_query(user)
415 Enum.map(reqs, fn req -> req.actor end)
417 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
418 |> Enum.filter(fn u -> !following?(u, user) end)
423 def increase_note_count(%User{} = user) do
424 info_cng = User.Info.add_to_note_count(user.info, 1)
428 |> put_embed(:info, info_cng)
430 update_and_set_cache(cng)
433 def decrease_note_count(%User{} = user) do
434 info_cng = User.Info.add_to_note_count(user.info, -1)
438 |> put_embed(:info, info_cng)
440 update_and_set_cache(cng)
443 def update_note_count(%User{} = user) do
447 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
451 note_count = Repo.one(note_count_query)
453 info_cng = User.Info.set_note_count(user.info, note_count)
457 |> put_embed(:info, info_cng)
459 update_and_set_cache(cng)
462 def update_follower_count(%User{} = user) do
463 follower_count_query =
466 where: ^user.follower_address in u.following,
467 where: u.id != ^user.id,
471 follower_count = Repo.one(follower_count_query)
475 |> User.Info.set_follower_count(follower_count)
479 |> put_embed(:info, info_cng)
481 update_and_set_cache(cng)
484 def get_users_from_set_query(ap_ids, false) do
487 where: u.ap_id in ^ap_ids
491 def get_users_from_set_query(ap_ids, true) do
492 query = get_users_from_set_query(ap_ids, false)
496 where: u.local == true
500 def get_users_from_set(ap_ids, local_only \\ true) do
501 get_users_from_set_query(ap_ids, local_only)
505 def get_recipients_from_activity(%Activity{recipients: to}) do
509 where: u.ap_id in ^to,
510 or_where: fragment("? && ?", u.following, ^to)
513 query = from(u in query, where: u.local == true)
518 def search(query, resolve \\ false) do
519 # strip the beginning @ off if there is a query
520 query = String.trim_leading(query, "@")
523 User.get_or_fetch_by_nickname(query)
538 where: not is_nil(u.nickname)
543 s in subquery(inner),
544 order_by: s.search_distance,
551 def block(blocker, %User{ap_id: ap_id} = blocked) do
552 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
554 if following?(blocker, blocked) do
555 {:ok, blocker, _} = unfollow(blocker, blocked)
561 if following?(blocked, blocker) do
562 unfollow(blocked, blocker)
567 |> User.Info.add_to_block(ap_id)
571 |> put_embed(:info, info_cng)
573 update_and_set_cache(cng)
576 # helper to handle the block given only an actor's AP id
577 def block(blocker, %{ap_id: ap_id}) do
578 block(blocker, User.get_by_ap_id(ap_id))
581 def unblock(blocker, %{ap_id: ap_id}) do
584 |> User.Info.remove_from_block(ap_id)
588 |> put_embed(:info, info_cng)
590 update_and_set_cache(cng)
593 def blocks?(user, %{ap_id: ap_id}) do
594 blocks = user.info.blocks
595 domain_blocks = user.info.domain_blocks
596 %{host: host} = URI.parse(ap_id)
598 Enum.member?(blocks, ap_id) ||
599 Enum.any?(domain_blocks, fn domain ->
604 def block_domain(user, domain) do
607 |> User.Info.add_to_domain_block(domain)
611 |> put_embed(:info, info_cng)
613 update_and_set_cache(cng)
616 def unblock_domain(user, domain) do
619 |> User.Info.remove_from_domain_block(domain)
623 |> put_embed(:info, info_cng)
625 update_and_set_cache(cng)
628 def local_user_query() do
631 where: u.local == true,
632 where: not is_nil(u.nickname)
636 def moderator_user_query() do
639 where: u.local == true,
640 where: fragment("?->'is_moderator' @> 'true'", u.info)
644 def deactivate(%User{} = user, status \\ true) do
645 info_cng = User.Info.set_activation_status(user.info, status)
649 |> put_embed(:info, info_cng)
651 update_and_set_cache(cng)
654 def delete(%User{} = user) do
655 {:ok, user} = User.deactivate(user)
657 # Remove all relationships
658 {:ok, followers} = User.get_followers(user)
661 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
663 {:ok, friends} = User.get_friends(user)
666 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
668 query = from(a in Activity, where: a.actor == ^user.ap_id)
671 |> Enum.each(fn activity ->
672 case activity.data["type"] do
674 ActivityPub.delete(Object.normalize(activity.data["object"]))
676 # TODO: Do something with likes, follows, repeats.
685 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
686 Pleroma.HTML.Scrubber.TwitterText
689 def html_filter_policy(_), do: nil
691 def get_or_fetch_by_ap_id(ap_id) do
692 user = get_by_ap_id(ap_id)
694 if !is_nil(user) and !User.needs_update?(user) do
697 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
704 case OStatus.make_user(ap_id) do
706 _ -> {:error, "Could not fetch by AP id"}
712 def get_or_create_instance_user do
713 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
715 if user = get_by_ap_id(relay_uri) do
719 %User{info: %User.Info{}}
720 |> cast(%{}, [:ap_id, :nickname, :local])
721 |> put_change(:ap_id, relay_uri)
722 |> put_change(:nickname, nil)
723 |> put_change(:local, true)
724 |> put_change(:follower_address, relay_uri <> "/followers")
726 {:ok, user} = Repo.insert(changes)
732 def public_key_from_info(%{
733 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
736 :public_key.pem_decode(public_key_pem)
738 |> :public_key.pem_entry_decode()
744 def public_key_from_info(%{magic_key: magic_key}) do
745 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
748 def get_public_key_for_ap_id(ap_id) do
749 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
750 {:ok, public_key} <- public_key_from_info(user.info) do
757 defp blank?(""), do: nil
758 defp blank?(n), do: n
760 def insert_or_update_user(data) do
763 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
765 cs = User.remote_user_creation(data)
767 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
770 def ap_enabled?(%User{local: true}), do: true
771 def ap_enabled?(%User{info: info}), do: info.ap_enabled
772 def ap_enabled?(_), do: false
774 def get_or_fetch(uri_or_nickname) do
775 if String.starts_with?(uri_or_nickname, "http") do
776 get_or_fetch_by_ap_id(uri_or_nickname)
778 get_or_fetch_by_nickname(uri_or_nickname)
782 # wait a period of time and return newest version of the User structs
783 # this is because we have synchronous follow APIs and need to simulate them
784 # with an async handshake
785 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
786 with %User{} = a <- Repo.get(User, a.id),
787 %User{} = b <- Repo.get(User, b.id) do
795 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
796 with :ok <- :timer.sleep(timeout),
797 %User{} = a <- Repo.get(User, a.id),
798 %User{} = b <- Repo.get(User, b.id) do