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 user_info(%User{} = user) do
66 oneself = if user.local, do: 1, else: 0
69 following_count: length(user.following) - oneself,
70 note_count: user.info.note_count,
71 follower_count: user.info.follower_count,
72 locked: user.info.locked,
73 default_scope: user.info.default_scope
77 @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])?)*$/
78 def remote_user_creation(params) do
81 |> Map.put(:info, params[:info] || %{})
83 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
87 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
88 |> validate_required([:name, :ap_id])
89 |> unique_constraint(:nickname)
90 |> validate_format(:nickname, @email_regex)
91 |> validate_length(:bio, max: 5000)
92 |> validate_length(:name, max: 100)
93 |> put_change(:local, false)
94 |> put_embed(:info, info_cng)
97 case info_cng.changes[:source_data] do
98 %{"followers" => followers} ->
100 |> put_change(:follower_address, followers)
103 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
106 |> put_change(:follower_address, followers)
113 def update_changeset(struct, params \\ %{}) do
115 |> cast(params, [:bio, :name, :avatar])
116 |> unique_constraint(:nickname)
117 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
118 |> validate_length(:bio, max: 5000)
119 |> validate_length(:name, min: 1, max: 100)
122 def upgrade_changeset(struct, params \\ %{}) do
125 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
129 |> User.Info.user_upgrade(params[:info])
132 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
133 |> unique_constraint(:nickname)
134 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
135 |> validate_length(:bio, max: 5000)
136 |> validate_length(:name, max: 100)
137 |> put_embed(:info, info_cng)
140 def password_update_changeset(struct, params) do
143 |> cast(params, [:password, :password_confirmation])
144 |> validate_required([:password, :password_confirmation])
145 |> validate_confirmation(:password)
147 OAuth.Token.delete_user_tokens(struct)
148 OAuth.Authorization.delete_user_authorizations(struct)
150 if changeset.valid? do
151 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
154 |> put_change(:password_hash, hashed)
160 def reset_password(user, data) do
161 update_and_set_cache(password_update_changeset(user, data))
164 def register_changeset(struct, params \\ %{}) do
167 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
168 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
169 |> validate_confirmation(:password)
170 |> unique_constraint(:email)
171 |> unique_constraint(:nickname)
172 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
173 |> validate_format(:email, @email_regex)
174 |> validate_length(:bio, max: 1000)
175 |> validate_length(:name, min: 1, max: 100)
176 |> put_change(:info, %Pleroma.User.Info{})
178 if changeset.valid? do
179 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
180 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
181 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
184 |> put_change(:password_hash, hashed)
185 |> put_change(:ap_id, ap_id)
186 |> put_change(:following, [followers])
187 |> put_change(:follower_address, followers)
193 def needs_update?(%User{local: true}), do: false
195 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
197 def needs_update?(%User{local: false} = user) do
198 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
201 def needs_update?(_), do: true
203 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
207 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
208 follow(follower, followed)
211 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
212 if !User.ap_enabled?(followed) do
213 follow(follower, followed)
219 def maybe_follow(%User{} = follower, %User{info: info} = followed) do
220 if not following?(follower, followed) do
221 follow(follower, followed)
227 def follow(%User{} = follower, %User{info: info} = followed) do
228 user_config = Application.get_env(:pleroma, :user)
229 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
231 ap_followers = followed.follower_address
234 following?(follower, followed) or info.deactivated ->
235 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
237 deny_follow_blocked and blocks?(followed, follower) ->
238 {:error, "Could not follow user: #{followed.nickname} blocked you."}
241 if !followed.local && follower.local && !ap_enabled?(followed) do
242 Websub.subscribe(follower, followed)
246 [ap_followers | follower.following]
251 |> follow_changeset(%{following: following})
252 |> update_and_set_cache
254 {:ok, _} = update_follower_count(followed)
260 def unfollow(%User{} = follower, %User{} = followed) do
261 ap_followers = followed.follower_address
263 if following?(follower, followed) and follower.ap_id != followed.ap_id do
266 |> List.delete(ap_followers)
270 |> follow_changeset(%{following: following})
271 |> update_and_set_cache
273 {:ok, followed} = update_follower_count(followed)
275 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
277 {:error, "Not subscribed!"}
281 def following?(%User{} = follower, %User{} = followed) do
282 Enum.member?(follower.following, followed.follower_address)
285 def locked?(%User{} = user) do
286 user.info.locked || false
289 def get_by_ap_id(ap_id) do
290 Repo.get_by(User, ap_id: ap_id)
293 def update_and_set_cache(changeset) do
294 with {:ok, user} <- Repo.update(changeset) do
295 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
296 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
297 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
304 def invalidate_cache(user) do
305 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
306 Cachex.del(:user_cache, "nickname:#{user.nickname}")
307 Cachex.del(:user_cache, "user_info:#{user.id}")
310 def get_cached_by_ap_id(ap_id) do
311 key = "ap_id:#{ap_id}"
312 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
315 def get_cached_by_nickname(nickname) do
316 key = "nickname:#{nickname}"
317 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
320 def get_by_nickname(nickname) do
321 Repo.get_by(User, nickname: nickname)
324 def get_by_nickname_or_email(nickname_or_email) do
325 case user = Repo.get_by(User, nickname: nickname_or_email) do
327 nil -> Repo.get_by(User, email: nickname_or_email)
331 def get_cached_user_info(user) do
332 key = "user_info:#{user.id}"
333 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
336 def fetch_by_nickname(nickname) do
337 ap_try = ActivityPub.make_user_from_nickname(nickname)
340 {:ok, user} -> {:ok, user}
341 _ -> OStatus.make_user(nickname)
345 def get_or_fetch_by_nickname(nickname) do
346 with %User{} = user <- get_by_nickname(nickname) do
350 with [_nick, _domain] <- String.split(nickname, "@"),
351 {:ok, user} <- fetch_by_nickname(nickname) do
359 def get_followers_query(%User{id: id, follower_address: follower_address}) do
362 where: fragment("? <@ ?", ^[follower_address], u.following),
367 def get_followers(user) do
368 q = get_followers_query(user)
373 def get_friends_query(%User{id: id, following: following}) do
376 where: u.follower_address in ^following,
381 def get_friends(user) do
382 q = get_friends_query(user)
387 def get_follow_requests_query(%User{} = user) do
392 "? ->> 'type' = 'Follow'",
397 "? ->> 'state' = 'pending'",
404 ^%{"object" => user.ap_id}
409 def get_follow_requests(%User{} = user) do
410 q = get_follow_requests_query(user)
414 Enum.map(reqs, fn req -> req.actor end)
416 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
417 |> Enum.filter(fn u -> !following?(u, user) end)
422 def increase_note_count(%User{} = user) do
423 info_cng = User.Info.add_to_note_count(user.info, 1)
427 |> put_embed(:info, info_cng)
429 update_and_set_cache(cng)
432 def decrease_note_count(%User{} = user) do
433 info_cng = User.Info.add_to_note_count(user.info, -1)
437 |> put_embed(:info, info_cng)
439 update_and_set_cache(cng)
442 def update_note_count(%User{} = user) do
446 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
450 note_count = Repo.one(note_count_query)
452 info_cng = User.Info.set_note_count(user.info, note_count)
456 |> put_embed(:info, info_cng)
458 update_and_set_cache(cng)
461 def update_follower_count(%User{} = user) do
462 follower_count_query =
465 where: ^user.follower_address in u.following,
466 where: u.id != ^user.id,
470 follower_count = Repo.one(follower_count_query)
474 |> User.Info.set_follower_count(follower_count)
478 |> put_embed(:info, info_cng)
480 update_and_set_cache(cng)
483 def get_users_from_set_query(ap_ids, false) do
486 where: u.ap_id in ^ap_ids
490 def get_users_from_set_query(ap_ids, true) do
491 query = get_users_from_set_query(ap_ids, false)
495 where: u.local == true
499 def get_users_from_set(ap_ids, local_only \\ true) do
500 get_users_from_set_query(ap_ids, local_only)
504 def get_recipients_from_activity(%Activity{recipients: to}) do
508 where: u.ap_id in ^to,
509 or_where: fragment("? && ?", u.following, ^to)
512 query = from(u in query, where: u.local == true)
517 def search(query, resolve \\ false) do
518 # strip the beginning @ off if there is a query
519 query = String.trim_leading(query, "@")
522 User.get_or_fetch_by_nickname(query)
537 where: not is_nil(u.nickname)
542 s in subquery(inner),
543 order_by: s.search_distance,
550 def block(blocker, %User{ap_id: ap_id} = blocked) do
551 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
553 if following?(blocker, blocked) do
554 {:ok, blocker, _} = unfollow(blocker, blocked)
560 if following?(blocked, blocker) do
561 unfollow(blocked, blocker)
566 |> User.Info.add_to_block(ap_id)
570 |> put_embed(:info, info_cng)
572 update_and_set_cache(cng)
575 # helper to handle the block given only an actor's AP id
576 def block(blocker, %{ap_id: ap_id}) do
577 block(blocker, User.get_by_ap_id(ap_id))
580 def unblock(blocker, %{ap_id: ap_id}) do
583 |> User.Info.remove_from_block(ap_id)
587 |> put_embed(:info, info_cng)
589 update_and_set_cache(cng)
592 def blocks?(user, %{ap_id: ap_id}) do
593 blocks = user.info.blocks
594 domain_blocks = user.info.domain_blocks
595 %{host: host} = URI.parse(ap_id)
597 Enum.member?(blocks, ap_id) ||
598 Enum.any?(domain_blocks, fn domain ->
603 def block_domain(user, domain) do
606 |> User.Info.add_to_domain_block(domain)
610 |> put_embed(:info, info_cng)
612 update_and_set_cache(cng)
615 def unblock_domain(user, domain) do
618 |> User.Info.remove_from_domain_block(domain)
622 |> put_embed(:info, info_cng)
624 update_and_set_cache(cng)
627 def local_user_query() do
630 where: u.local == true,
631 where: not is_nil(u.nickname)
635 def moderator_user_query() do
638 where: u.local == true,
639 where: fragment("?->'is_moderator' @> 'true'", u.info)
643 def deactivate(%User{} = user, status \\ true) do
644 info_cng = User.Info.set_activation_status(user.info, status)
648 |> put_embed(:info, info_cng)
650 update_and_set_cache(cng)
653 def delete(%User{} = user) do
654 {:ok, user} = User.deactivate(user)
656 # Remove all relationships
657 {:ok, followers} = User.get_followers(user)
660 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
662 {:ok, friends} = User.get_friends(user)
665 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
667 query = from(a in Activity, where: a.actor == ^user.ap_id)
670 |> Enum.each(fn activity ->
671 case activity.data["type"] do
673 ActivityPub.delete(Object.normalize(activity.data["object"]))
675 # TODO: Do something with likes, follows, repeats.
684 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
685 Pleroma.HTML.Scrubber.TwitterText
688 def html_filter_policy(_), do: nil
690 def get_or_fetch_by_ap_id(ap_id) do
691 user = get_by_ap_id(ap_id)
693 if !is_nil(user) and !User.needs_update?(user) do
696 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
703 case OStatus.make_user(ap_id) do
705 _ -> {:error, "Could not fetch by AP id"}
711 def get_or_create_instance_user do
712 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
714 if user = get_by_ap_id(relay_uri) do
718 %User{info: %User.Info{}}
719 |> cast(%{}, [:ap_id, :nickname, :local])
720 |> put_change(:ap_id, relay_uri)
721 |> put_change(:nickname, nil)
722 |> put_change(:local, true)
723 |> put_change(:follower_address, relay_uri <> "/followers")
725 {:ok, user} = Repo.insert(changes)
731 def public_key_from_info(%{
732 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
735 :public_key.pem_decode(public_key_pem)
737 |> :public_key.pem_entry_decode()
743 def public_key_from_info(%{magic_key: magic_key}) do
744 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
747 def get_public_key_for_ap_id(ap_id) do
748 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
749 {:ok, public_key} <- public_key_from_info(user.info) do
756 defp blank?(""), do: nil
757 defp blank?(n), do: n
759 def insert_or_update_user(data) do
762 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
764 cs = User.remote_user_creation(data)
766 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
769 def ap_enabled?(%User{local: true}), do: true
770 def ap_enabled?(%User{info: info}), do: info.ap_enabled
771 def ap_enabled?(_), do: false
773 def get_or_fetch(uri_or_nickname) do
774 if String.starts_with?(uri_or_nickname, "http") do
775 get_or_fetch_by_ap_id(uri_or_nickname)
777 get_or_fetch_by_nickname(uri_or_nickname)
781 # wait a period of time and return newest version of the User structs
782 # this is because we have synchronous follow APIs and need to simulate them
783 # with an async handshake
784 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
785 with %User{} = a <- Repo.get(User, a.id),
786 %User{} = b <- Repo.get(User, b.id) do
794 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
795 with :ok <- :timer.sleep(timeout),
796 %User{} = a <- Repo.get(User, a.id),
797 %User{} = b <- Repo.get(User, b.id) do
805 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}}) do
806 mentions = Formatter.parse_mentions(bio)
807 tags = Formatter.parse_tags(bio)
810 (user.info.source_data["tag"] || [])
811 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
812 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
813 {String.trim(name, ":"), url}
816 CommonUtils.format_input(bio, mentions, tags, "text/plain") |> Formatter.emojify(emoji)