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)
180 |> put_change(:info, %Pleroma.User.Info{})
182 if changeset.valid? do
183 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
184 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
185 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
188 |> put_change(:password_hash, hashed)
189 |> put_change(:ap_id, ap_id)
190 |> put_change(:following, [followers])
191 |> put_change(:follower_address, followers)
197 def needs_update?(%User{local: true}), do: false
199 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
201 def needs_update?(%User{local: false} = user) do
202 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
205 def needs_update?(_), do: true
207 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
211 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
212 follow(follower, followed)
215 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
216 if !User.ap_enabled?(followed) do
217 follow(follower, followed)
223 def maybe_follow(%User{} = follower, %User{info: info} = followed) do
224 if not following?(follower, followed) do
225 follow(follower, followed)
231 def follow(%User{} = follower, %User{info: info} = followed) do
232 user_config = Application.get_env(:pleroma, :user)
233 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
235 ap_followers = followed.follower_address
238 following?(follower, followed) or info.deactivated ->
239 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
241 deny_follow_blocked and blocks?(followed, follower) ->
242 {:error, "Could not follow user: #{followed.nickname} blocked you."}
245 if !followed.local && follower.local && !ap_enabled?(followed) do
246 Websub.subscribe(follower, followed)
250 [ap_followers | follower.following]
255 |> follow_changeset(%{following: following})
256 |> update_and_set_cache
258 {:ok, _} = update_follower_count(followed)
264 def unfollow(%User{} = follower, %User{} = followed) do
265 ap_followers = followed.follower_address
267 if following?(follower, followed) and follower.ap_id != followed.ap_id do
270 |> List.delete(ap_followers)
274 |> follow_changeset(%{following: following})
275 |> update_and_set_cache
277 {:ok, followed} = update_follower_count(followed)
279 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
281 {:error, "Not subscribed!"}
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}}
739 :public_key.pem_decode(public_key_pem)
741 |> :public_key.pem_entry_decode()
747 def public_key_from_info(%{magic_key: magic_key}) do
748 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
751 def get_public_key_for_ap_id(ap_id) do
752 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
753 {:ok, public_key} <- public_key_from_info(user.info) do
760 defp blank?(""), do: nil
761 defp blank?(n), do: n
763 def insert_or_update_user(data) do
766 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
768 cs = User.remote_user_creation(data)
770 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
773 def ap_enabled?(%User{local: true}), do: true
774 def ap_enabled?(%User{info: info}), do: info.ap_enabled
775 def ap_enabled?(_), do: false
777 def get_or_fetch(uri_or_nickname) do
778 if String.starts_with?(uri_or_nickname, "http") do
779 get_or_fetch_by_ap_id(uri_or_nickname)
781 get_or_fetch_by_nickname(uri_or_nickname)
785 # wait a period of time and return newest version of the User structs
786 # this is because we have synchronous follow APIs and need to simulate them
787 # with an async handshake
788 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
789 with %User{} = a <- Repo.get(User, a.id),
790 %User{} = b <- Repo.get(User, b.id) do
798 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
799 with :ok <- :timer.sleep(timeout),
800 %User{} = a <- Repo.get(User, a.id),
801 %User{} = b <- Repo.get(User, b.id) do
809 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}}) do
810 mentions = Formatter.parse_mentions(bio)
811 tags = Formatter.parse_tags(bio)
814 (user.info.source_data["tag"] || [])
815 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
816 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
817 {String.trim(name, ":"), url}
820 CommonUtils.format_input(bio, mentions, tags, "text/plain") |> Formatter.emojify(emoji)