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
65 |> cast(params, [:info])
66 |> validate_required([:info])
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 |> cast(params, [:bio, :name, :ap_id, :nickname, :info, :avatar])
86 |> validate_required([:name, :ap_id])
87 |> unique_constraint(:nickname)
88 |> validate_format(:nickname, @email_regex)
89 |> validate_length(:bio, max: 5000)
90 |> validate_length(:name, max: 100)
91 |> put_change(:local, false)
94 case changes.changes[:info]["source_data"] do
95 %{"followers" => followers} ->
97 |> put_change(:follower_address, followers)
100 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
103 |> put_change(:follower_address, followers)
110 def update_changeset(struct, params \\ %{}) do
112 |> cast(params, [:bio, :name])
113 |> unique_constraint(:nickname)
114 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
115 |> validate_length(:bio, max: 5000)
116 |> validate_length(:name, min: 1, max: 100)
119 def upgrade_changeset(struct, params \\ %{}) do
122 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
125 |> cast(params, [:bio, :name, :info, :follower_address, :avatar, :last_refreshed_at])
126 |> unique_constraint(:nickname)
127 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
128 |> validate_length(:bio, max: 5000)
129 |> validate_length(:name, max: 100)
132 def password_update_changeset(struct, params) do
135 |> cast(params, [:password, :password_confirmation])
136 |> validate_required([:password, :password_confirmation])
137 |> validate_confirmation(:password)
139 OAuth.Token.delete_user_tokens(struct)
140 OAuth.Authorization.delete_user_authorizations(struct)
142 if changeset.valid? do
143 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
146 |> put_change(:password_hash, hashed)
152 def reset_password(user, data) do
153 update_and_set_cache(password_update_changeset(user, data))
156 def register_changeset(struct, params \\ %{}) do
159 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
160 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
161 |> validate_confirmation(:password)
162 |> unique_constraint(:email)
163 |> unique_constraint(:nickname)
164 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
165 |> validate_format(:email, @email_regex)
166 |> validate_length(:bio, max: 1000)
167 |> validate_length(:name, min: 1, max: 100)
169 if changeset.valid? do
170 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
171 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
172 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
175 |> put_change(:password_hash, hashed)
176 |> put_change(:ap_id, ap_id)
177 |> put_change(:following, [followers])
178 |> put_change(:follower_address, followers)
184 def needs_update?(%User{local: true}), do: false
186 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
188 def needs_update?(%User{local: false} = user) do
189 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
192 def needs_update?(_), do: true
194 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{"locked" => true}}) do
198 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
199 follow(follower, followed)
202 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
203 if !User.ap_enabled?(followed) do
204 follow(follower, followed)
210 def maybe_follow(%User{} = follower, %User{info: info} = followed) do
211 if not following?(follower, followed) do
212 follow(follower, followed)
218 def follow(%User{} = follower, %User{info: info} = followed) do
219 user_config = Application.get_env(:pleroma, :user)
220 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
222 ap_followers = followed.follower_address
225 following?(follower, followed) or info.deactivated ->
226 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
228 deny_follow_blocked and blocks?(followed, follower) ->
229 {:error, "Could not follow user: #{followed.nickname} blocked you."}
232 if !followed.local && follower.local && !ap_enabled?(followed) do
233 Websub.subscribe(follower, followed)
237 [ap_followers | follower.following]
242 |> follow_changeset(%{following: following})
243 |> update_and_set_cache
245 {:ok, _} = update_follower_count(followed)
251 def unfollow(%User{} = follower, %User{} = followed) do
252 ap_followers = followed.follower_address
254 if following?(follower, followed) and follower.ap_id != followed.ap_id do
257 |> List.delete(ap_followers)
261 |> follow_changeset(%{following: following})
262 |> update_and_set_cache
264 {:ok, followed} = update_follower_count(followed)
266 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
268 {:error, "Not subscribed!"}
272 def following?(%User{} = follower, %User{} = followed) do
273 Enum.member?(follower.following, followed.follower_address)
276 def locked?(%User{} = user) do
277 user.info["locked"] || false
280 def get_by_ap_id(ap_id) do
281 Repo.get_by(User, ap_id: ap_id)
284 def update_and_set_cache(changeset) do
285 with {:ok, user} <- Repo.update(changeset) do
286 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
287 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
288 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
295 def invalidate_cache(user) do
296 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
297 Cachex.del(:user_cache, "nickname:#{user.nickname}")
298 Cachex.del(:user_cache, "user_info:#{user.id}")
301 def get_cached_by_ap_id(ap_id) do
302 key = "ap_id:#{ap_id}"
303 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
306 def get_cached_by_nickname(nickname) do
307 key = "nickname:#{nickname}"
308 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
311 def get_by_nickname(nickname) do
312 Repo.get_by(User, nickname: nickname)
315 def get_by_nickname_or_email(nickname_or_email) do
316 case user = Repo.get_by(User, nickname: nickname_or_email) do
318 nil -> Repo.get_by(User, email: nickname_or_email)
322 def get_cached_user_info(user) do
323 key = "user_info:#{user.id}"
324 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
327 def fetch_by_nickname(nickname) do
328 ap_try = ActivityPub.make_user_from_nickname(nickname)
331 {:ok, user} -> {:ok, user}
332 _ -> OStatus.make_user(nickname)
336 def get_or_fetch_by_nickname(nickname) do
337 with %User{} = user <- get_by_nickname(nickname) do
341 with [_nick, _domain] <- String.split(nickname, "@"),
342 {:ok, user} <- fetch_by_nickname(nickname) do
350 def get_followers_query(%User{id: id, follower_address: follower_address}) do
353 where: fragment("? <@ ?", ^[follower_address], u.following),
358 def get_followers(user) do
359 q = get_followers_query(user)
364 def get_friends_query(%User{id: id, following: following}) do
367 where: u.follower_address in ^following,
372 def get_friends(user) do
373 q = get_friends_query(user)
378 def get_follow_requests_query(%User{} = user) do
383 "? ->> 'type' = 'Follow'",
388 "? ->> 'state' = 'pending'",
395 ^%{"object" => user.ap_id}
400 def get_follow_requests(%User{} = user) do
401 q = get_follow_requests_query(user)
405 Enum.map(reqs, fn req -> req.actor end)
407 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
408 |> Enum.filter(fn u -> !following?(u, user) end)
413 def increase_note_count(%User{} = user) do
414 info_cng = User.Info.add_to_note_count(user.info, 1)
418 |> put_embed(:info, info_cng)
420 update_and_set_cache(cng)
423 def decrease_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 update_note_count(%User{} = user) do
437 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
441 note_count = Repo.one(note_count_query)
443 info_cng = User.Info.set_note_count(user.info, note_count)
447 |> put_embed(:info, info_cng)
449 update_and_set_cache(cng)
452 def update_follower_count(%User{} = user) do
453 follower_count_query =
456 where: ^user.follower_address in u.following,
457 where: u.id != ^user.id,
461 follower_count = Repo.one(follower_count_query)
465 |> User.Info.set_follower_count(follower_count)
469 |> put_embed(:info, info_cng)
471 update_and_set_cache(cng)
474 def get_users_from_set_query(ap_ids, false) do
477 where: u.ap_id in ^ap_ids
481 def get_users_from_set_query(ap_ids, true) do
482 query = get_users_from_set_query(ap_ids, false)
486 where: u.local == true
490 def get_users_from_set(ap_ids, local_only \\ true) do
491 get_users_from_set_query(ap_ids, local_only)
495 def get_recipients_from_activity(%Activity{recipients: to}) do
499 where: u.ap_id in ^to,
500 or_where: fragment("? && ?", u.following, ^to)
503 query = from(u in query, where: u.local == true)
508 def search(query, resolve \\ false) do
509 # strip the beginning @ off if there is a query
510 query = String.trim_leading(query, "@")
513 User.get_or_fetch_by_nickname(query)
528 where: not is_nil(u.nickname)
533 s in subquery(inner),
534 order_by: s.search_distance,
541 def block(blocker, %User{ap_id: ap_id} = blocked) do
542 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
544 if following?(blocker, blocked) do
545 {:ok, blocker, _} = unfollow(blocker, blocked)
551 if following?(blocked, blocker) do
552 unfollow(blocked, blocker)
557 |> User.Info.add_to_block(ap_id)
561 |> put_embed(:info, info_cng)
563 update_and_set_cache(cng)
566 # helper to handle the block given only an actor's AP id
567 def block(blocker, %{ap_id: ap_id}) do
568 block(blocker, User.get_by_ap_id(ap_id))
571 def unblock(blocker, %{ap_id: ap_id}) do
574 |> User.Info.remove_from_block(ap_id)
578 |> put_embed(:info, info_cng)
580 update_and_set_cache(cng)
583 def blocks?(user, %{ap_id: ap_id}) do
584 blocks = user.info.blocks
585 domain_blocks = user.info.domain_blocks
586 %{host: host} = URI.parse(ap_id)
588 Enum.member?(blocks, ap_id) ||
589 Enum.any?(domain_blocks, fn domain ->
594 def block_domain(user, domain) do
595 domain_blocks = user.info.domain_blocks
596 new_blocks = Enum.uniq([domain | domain_blocks])
597 new_info = Map.put(user.info, "domain_blocks", new_blocks)
599 cs = User.info_changeset(user, %{info: new_info})
600 update_and_set_cache(cs)
603 def unblock_domain(user, domain) do
604 blocks = user.info["domain_blocks"] || []
605 new_blocks = List.delete(blocks, domain)
606 new_info = Map.put(user.info, "domain_blocks", new_blocks)
608 cs = User.info_changeset(user, %{info: new_info})
609 update_and_set_cache(cs)
612 def local_user_query() do
615 where: u.local == true,
616 where: not is_nil(u.nickname)
620 def moderator_user_query() do
623 where: u.local == true,
624 where: fragment("?->'is_moderator' @> 'true'", u.info)
628 def deactivate(%User{} = user, status \\ true) do
629 info_cng = User.Info.set_activation_status(user.info, status)
633 |> put_embed(:info, info_cng)
635 update_and_set_cache(cng)
638 def delete(%User{} = user) do
639 {:ok, user} = User.deactivate(user)
641 # Remove all relationships
642 {:ok, followers} = User.get_followers(user)
645 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
647 {:ok, friends} = User.get_friends(user)
650 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
652 query = from(a in Activity, where: a.actor == ^user.ap_id)
655 |> Enum.each(fn activity ->
656 case activity.data["type"] do
658 ActivityPub.delete(Object.normalize(activity.data["object"]))
660 # TODO: Do something with likes, follows, repeats.
669 def html_filter_policy(%User{info: %{"no_rich_text" => true}}) do
670 Pleroma.HTML.Scrubber.TwitterText
673 def html_filter_policy(_), do: nil
675 def get_or_fetch_by_ap_id(ap_id) do
676 user = get_by_ap_id(ap_id)
678 if !is_nil(user) and !User.needs_update?(user) do
681 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
688 case OStatus.make_user(ap_id) do
690 _ -> {:error, "Could not fetch by AP id"}
696 def get_or_create_instance_user do
697 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
699 if user = get_by_ap_id(relay_uri) do
704 |> cast(%{}, [:ap_id, :nickname, :local])
705 |> put_change(:ap_id, relay_uri)
706 |> put_change(:nickname, nil)
707 |> put_change(:local, true)
708 |> put_change(:follower_address, relay_uri <> "/followers")
710 {:ok, user} = Repo.insert(changes)
716 def public_key_from_info(%{
717 "source_data" => %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
720 :public_key.pem_decode(public_key_pem)
722 |> :public_key.pem_entry_decode()
728 def public_key_from_info(%{"magic_key" => magic_key}) do
729 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
732 def get_public_key_for_ap_id(ap_id) do
733 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
734 {:ok, public_key} <- public_key_from_info(user.info) do
741 defp blank?(""), do: nil
742 defp blank?(n), do: n
744 def insert_or_update_user(data) do
747 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
749 cs = User.remote_user_creation(data)
750 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
753 def ap_enabled?(%User{local: true}), do: true
754 def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
755 def ap_enabled?(_), do: false
757 def get_or_fetch(uri_or_nickname) do
758 if String.starts_with?(uri_or_nickname, "http") do
759 get_or_fetch_by_ap_id(uri_or_nickname)
761 get_or_fetch_by_nickname(uri_or_nickname)
765 # wait a period of time and return newest version of the User structs
766 # this is because we have synchronous follow APIs and need to simulate them
767 # with an async handshake
768 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
769 with %User{} = a <- Repo.get(User, a.id),
770 %User{} = b <- Repo.get(User, b.id) do
778 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
779 with :ok <- :timer.sleep(timeout),
780 %User{} = a <- Repo.get(User, a.id),
781 %User{} = b <- Repo.get(User, b.id) do