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}
14 field(:email, :string)
16 field(:nickname, :string)
17 field(:password_hash, :string)
18 field(:password, :string, virtual: true)
19 field(:password_confirmation, :string, virtual: true)
20 field(:following, {:array, :string}, default: [])
21 field(:ap_id, :string)
23 field(:local, :boolean, default: true)
24 field(:follower_address, :string)
25 field(:search_distance, :float, virtual: true)
26 field(:last_refreshed_at, :naive_datetime)
27 has_many(:notifications, Notification)
28 embeds_one(:info, Pleroma.User.Info)
33 def avatar_url(user) do
35 %{"url" => [%{"href" => href} | _]} -> href
36 _ -> "#{Web.base_url()}/images/avi.png"
40 def banner_url(user) do
41 case user.info.banner do
42 %{"url" => [%{"href" => href} | _]} -> href
43 _ -> "#{Web.base_url()}/images/banner.png"
47 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
48 def profile_url(%User{ap_id: ap_id}), do: ap_id
49 def profile_url(_), do: nil
51 def ap_id(%User{nickname: nickname}) do
52 "#{Web.base_url()}/users/#{nickname}"
55 def ap_followers(%User{} = user) do
56 "#{ap_id(user)}/followers"
59 def follow_changeset(struct, params \\ %{}) do
61 |> cast(params, [:following])
62 |> validate_required([:following])
65 def info_changeset(struct, params \\ %{}) do
66 raise "NOT VALID ANYMORE"
69 def user_info(%User{} = user) do
70 oneself = if user.local, do: 1, else: 0
73 following_count: length(user.following) - oneself,
74 note_count: user.info.note_count,
75 follower_count: user.info.follower_count,
76 locked: user.info.locked,
77 default_scope: user.info.default_scope
81 @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])?)*$/
82 def remote_user_creation(params) do
85 |> Map.put(:info, params[:info] || %{})
87 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
91 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
92 |> validate_required([:name, :ap_id])
93 |> unique_constraint(:nickname)
94 |> validate_format(:nickname, @email_regex)
95 |> validate_length(:bio, max: 5000)
96 |> validate_length(:name, max: 100)
97 |> put_change(:local, false)
98 |> put_embed(:info, info_cng)
101 case info_cng.changes[:source_data] do
102 %{"followers" => followers} ->
104 |> put_change(:follower_address, followers)
107 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
110 |> put_change(:follower_address, followers)
117 def update_changeset(struct, params \\ %{}) do
119 |> cast(params, [:bio, :name, :avatar])
120 |> unique_constraint(:nickname)
121 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
122 |> validate_length(:bio, max: 5000)
123 |> validate_length(:name, min: 1, max: 100)
126 def upgrade_changeset(struct, params \\ %{}) do
129 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
133 |> User.Info.user_upgrade(params[:info])
136 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
137 |> unique_constraint(:nickname)
138 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
139 |> validate_length(:bio, max: 5000)
140 |> validate_length(:name, max: 100)
141 |> put_embed(:info, info_cng)
144 def password_update_changeset(struct, params) do
147 |> cast(params, [:password, :password_confirmation])
148 |> validate_required([:password, :password_confirmation])
149 |> validate_confirmation(:password)
151 OAuth.Token.delete_user_tokens(struct)
152 OAuth.Authorization.delete_user_authorizations(struct)
154 if changeset.valid? do
155 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
158 |> put_change(:password_hash, hashed)
164 def reset_password(user, data) do
165 update_and_set_cache(password_update_changeset(user, data))
168 def register_changeset(struct, params \\ %{}) do
171 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
172 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
173 |> validate_confirmation(:password)
174 |> unique_constraint(:email)
175 |> unique_constraint(:nickname)
176 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
177 |> validate_format(:email, @email_regex)
178 |> validate_length(:bio, max: 1000)
179 |> validate_length(:name, min: 1, max: 100)
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 !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 def following?(%User{} = follower, %User{} = followed) do
285 Enum.member?(follower.following, followed.follower_address)
288 def locked?(%User{} = user) do
289 user.info.locked || false
292 def get_by_ap_id(ap_id) do
293 Repo.get_by(User, ap_id: ap_id)
296 def update_and_set_cache(changeset) do
297 with {:ok, user} <- Repo.update(changeset) do
298 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
299 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
300 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
307 def invalidate_cache(user) do
308 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
309 Cachex.del(:user_cache, "nickname:#{user.nickname}")
310 Cachex.del(:user_cache, "user_info:#{user.id}")
313 def get_cached_by_ap_id(ap_id) do
314 key = "ap_id:#{ap_id}"
315 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
318 def get_cached_by_nickname(nickname) do
319 key = "nickname:#{nickname}"
320 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
323 def get_by_nickname(nickname) do
324 Repo.get_by(User, nickname: nickname)
327 def get_by_nickname_or_email(nickname_or_email) do
328 case user = Repo.get_by(User, nickname: nickname_or_email) do
330 nil -> Repo.get_by(User, email: nickname_or_email)
334 def get_cached_user_info(user) do
335 key = "user_info:#{user.id}"
336 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
339 def fetch_by_nickname(nickname) do
340 ap_try = ActivityPub.make_user_from_nickname(nickname)
343 {:ok, user} -> {:ok, user}
344 _ -> OStatus.make_user(nickname)
348 def get_or_fetch_by_nickname(nickname) do
349 with %User{} = user <- get_by_nickname(nickname) do
353 with [_nick, _domain] <- String.split(nickname, "@"),
354 {:ok, user} <- fetch_by_nickname(nickname) do
362 def get_followers_query(%User{id: id, follower_address: follower_address}) do
365 where: fragment("? <@ ?", ^[follower_address], u.following),
370 def get_followers(user) do
371 q = get_followers_query(user)
376 def get_friends_query(%User{id: id, following: following}) do
379 where: u.follower_address in ^following,
384 def get_friends(user) do
385 q = get_friends_query(user)
390 def get_follow_requests_query(%User{} = user) do
395 "? ->> 'type' = 'Follow'",
400 "? ->> 'state' = 'pending'",
407 ^%{"object" => user.ap_id}
412 def get_follow_requests(%User{} = user) do
413 q = get_follow_requests_query(user)
417 Enum.map(reqs, fn req -> req.actor end)
419 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
420 |> Enum.filter(fn u -> !following?(u, user) end)
425 def increase_note_count(%User{} = user) do
426 info_cng = User.Info.add_to_note_count(user.info, 1)
430 |> put_embed(:info, info_cng)
432 update_and_set_cache(cng)
435 def decrease_note_count(%User{} = user) do
436 info_cng = User.Info.add_to_note_count(user.info, -1)
440 |> put_embed(:info, info_cng)
442 update_and_set_cache(cng)
445 def update_note_count(%User{} = user) do
449 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
453 note_count = Repo.one(note_count_query)
455 info_cng = User.Info.set_note_count(user.info, note_count)
459 |> put_embed(:info, info_cng)
461 update_and_set_cache(cng)
464 def update_follower_count(%User{} = user) do
465 follower_count_query =
468 where: ^user.follower_address in u.following,
469 where: u.id != ^user.id,
473 follower_count = Repo.one(follower_count_query)
477 |> User.Info.set_follower_count(follower_count)
481 |> put_embed(:info, info_cng)
483 update_and_set_cache(cng)
486 def get_users_from_set_query(ap_ids, false) do
489 where: u.ap_id in ^ap_ids
493 def get_users_from_set_query(ap_ids, true) do
494 query = get_users_from_set_query(ap_ids, false)
498 where: u.local == true
502 def get_users_from_set(ap_ids, local_only \\ true) do
503 get_users_from_set_query(ap_ids, local_only)
507 def get_recipients_from_activity(%Activity{recipients: to}) do
511 where: u.ap_id in ^to,
512 or_where: fragment("? && ?", u.following, ^to)
515 query = from(u in query, where: u.local == true)
520 def search(query, resolve \\ false) do
521 # strip the beginning @ off if there is a query
522 query = String.trim_leading(query, "@")
525 User.get_or_fetch_by_nickname(query)
540 where: not is_nil(u.nickname)
545 s in subquery(inner),
546 order_by: s.search_distance,
553 def block(blocker, %User{ap_id: ap_id} = blocked) do
554 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
556 if following?(blocker, blocked) do
557 {:ok, blocker, _} = unfollow(blocker, blocked)
563 if following?(blocked, blocker) do
564 unfollow(blocked, blocker)
569 |> User.Info.add_to_block(ap_id)
573 |> put_embed(:info, info_cng)
575 update_and_set_cache(cng)
578 # helper to handle the block given only an actor's AP id
579 def block(blocker, %{ap_id: ap_id}) do
580 block(blocker, User.get_by_ap_id(ap_id))
583 def unblock(blocker, %{ap_id: ap_id}) do
586 |> User.Info.remove_from_block(ap_id)
590 |> put_embed(:info, info_cng)
592 update_and_set_cache(cng)
595 def blocks?(user, %{ap_id: ap_id}) do
596 blocks = user.info.blocks
597 domain_blocks = user.info.domain_blocks
598 %{host: host} = URI.parse(ap_id)
600 Enum.member?(blocks, ap_id) ||
601 Enum.any?(domain_blocks, fn domain ->
606 def block_domain(user, domain) do
609 |> User.Info.add_to_domain_block(domain)
613 |> put_embed(:info, info_cng)
615 update_and_set_cache(cng)
618 def unblock_domain(user, domain) do
621 |> User.Info.remove_from_domain_block(domain)
625 |> put_embed(:info, info_cng)
627 update_and_set_cache(cng)
630 def local_user_query() do
633 where: u.local == true,
634 where: not is_nil(u.nickname)
638 def moderator_user_query() do
641 where: u.local == true,
642 where: fragment("?->'is_moderator' @> 'true'", u.info)
646 def deactivate(%User{} = user, status \\ true) do
647 info_cng = User.Info.set_activation_status(user.info, status)
651 |> put_embed(:info, info_cng)
653 update_and_set_cache(cng)
656 def delete(%User{} = user) do
657 {:ok, user} = User.deactivate(user)
659 # Remove all relationships
660 {:ok, followers} = User.get_followers(user)
663 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
665 {:ok, friends} = User.get_friends(user)
668 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
670 query = from(a in Activity, where: a.actor == ^user.ap_id)
673 |> Enum.each(fn activity ->
674 case activity.data["type"] do
676 ActivityPub.delete(Object.normalize(activity.data["object"]))
678 # TODO: Do something with likes, follows, repeats.
687 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
688 Pleroma.HTML.Scrubber.TwitterText
691 def html_filter_policy(_), do: nil
693 def get_or_fetch_by_ap_id(ap_id) do
694 user = get_by_ap_id(ap_id)
696 if !is_nil(user) and !User.needs_update?(user) do
699 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
706 case OStatus.make_user(ap_id) do
708 _ -> {:error, "Could not fetch by AP id"}
714 def get_or_create_instance_user do
715 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
717 if user = get_by_ap_id(relay_uri) do
721 %User{info: %User.Info{}}
722 |> cast(%{}, [:ap_id, :nickname, :local])
723 |> put_change(:ap_id, relay_uri)
724 |> put_change(:nickname, nil)
725 |> put_change(:local, true)
726 |> put_change(:follower_address, relay_uri <> "/followers")
728 {:ok, user} = Repo.insert(changes)
734 def public_key_from_info(%{
735 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
738 :public_key.pem_decode(public_key_pem)
740 |> :public_key.pem_entry_decode()
746 def public_key_from_info(%{magic_key: magic_key}) do
747 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
750 def get_public_key_for_ap_id(ap_id) do
751 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
752 {:ok, public_key} <- public_key_from_info(user.info) do
759 defp blank?(""), do: nil
760 defp blank?(n), do: n
762 def insert_or_update_user(data) do
765 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
767 cs = User.remote_user_creation(data)
769 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
772 def ap_enabled?(%User{local: true}), do: true
773 def ap_enabled?(%User{info: info}), do: info.ap_enabled
774 def ap_enabled?(_), do: false
776 def get_or_fetch(uri_or_nickname) do
777 if String.starts_with?(uri_or_nickname, "http") do
778 get_or_fetch_by_ap_id(uri_or_nickname)
780 get_or_fetch_by_nickname(uri_or_nickname)
784 # wait a period of time and return newest version of the User structs
785 # this is because we have synchronous follow APIs and need to simulate them
786 # with an async handshake
787 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
788 with %User{} = a <- Repo.get(User, a.id),
789 %User{} = b <- Repo.get(User, b.id) do
797 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
798 with :ok <- :timer.sleep(timeout),
799 %User{} = a <- Repo.get(User, a.id),
800 %User{} = b <- Repo.get(User, b.id) do
808 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}}) do
809 mentions = Formatter.parse_mentions(bio)
810 tags = Formatter.parse_tags(bio)
813 (user.info.source_data["tag"] || [])
814 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
815 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
816 {String.trim(name, ":"), url}
819 CommonUtils.format_input(bio, mentions, tags, "text/plain") |> Formatter.emojify(emoji)