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
84 |> Map.put(:info, params[:info] || %{})
86 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
90 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
91 |> validate_required([:name, :ap_id])
92 |> unique_constraint(:nickname)
93 |> validate_format(:nickname, @email_regex)
94 |> validate_length(:bio, max: 5000)
95 |> validate_length(:name, max: 100)
96 |> put_change(:local, false)
97 |> put_embed(:info, info_cng)
100 case info_cng.changes[:source_data] do
101 %{"followers" => followers} ->
103 |> put_change(:follower_address, followers)
106 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
109 |> put_change(:follower_address, followers)
116 def update_changeset(struct, params \\ %{}) do
118 |> cast(params, [:bio, :name])
119 |> unique_constraint(:nickname)
120 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
121 |> validate_length(:bio, max: 5000)
122 |> validate_length(:name, min: 1, max: 100)
125 def upgrade_changeset(struct, params \\ %{}) do
128 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
131 |> cast(params, [:bio, :name, :info, :follower_address, :avatar, :last_refreshed_at])
132 |> unique_constraint(:nickname)
133 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
134 |> validate_length(:bio, max: 5000)
135 |> validate_length(:name, max: 100)
138 def password_update_changeset(struct, params) do
141 |> cast(params, [:password, :password_confirmation])
142 |> validate_required([:password, :password_confirmation])
143 |> validate_confirmation(:password)
145 OAuth.Token.delete_user_tokens(struct)
146 OAuth.Authorization.delete_user_authorizations(struct)
148 if changeset.valid? do
149 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
152 |> put_change(:password_hash, hashed)
158 def reset_password(user, data) do
159 update_and_set_cache(password_update_changeset(user, data))
162 def register_changeset(struct, params \\ %{}) do
165 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
166 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
167 |> validate_confirmation(:password)
168 |> unique_constraint(:email)
169 |> unique_constraint(:nickname)
170 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
171 |> validate_format(:email, @email_regex)
172 |> validate_length(:bio, max: 1000)
173 |> validate_length(:name, min: 1, max: 100)
175 if changeset.valid? do
176 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
177 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
178 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
181 |> put_change(:password_hash, hashed)
182 |> put_change(:ap_id, ap_id)
183 |> put_change(:following, [followers])
184 |> put_change(:follower_address, followers)
190 def needs_update?(%User{local: true}), do: false
192 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
194 def needs_update?(%User{local: false} = user) do
195 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
198 def needs_update?(_), do: true
200 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
204 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
205 follow(follower, followed)
208 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
209 if !User.ap_enabled?(followed) do
210 follow(follower, followed)
216 def maybe_follow(%User{} = follower, %User{info: info} = followed) do
217 if not following?(follower, followed) do
218 follow(follower, followed)
224 def follow(%User{} = follower, %User{info: info} = followed) do
225 user_config = Application.get_env(:pleroma, :user)
226 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
228 ap_followers = followed.follower_address
231 following?(follower, followed) or info.deactivated ->
232 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
234 deny_follow_blocked and blocks?(followed, follower) ->
235 {:error, "Could not follow user: #{followed.nickname} blocked you."}
238 if !followed.local && follower.local && !ap_enabled?(followed) do
239 Websub.subscribe(follower, followed)
243 [ap_followers | follower.following]
248 |> follow_changeset(%{following: following})
249 |> update_and_set_cache
251 {:ok, _} = update_follower_count(followed)
257 def unfollow(%User{} = follower, %User{} = followed) do
258 ap_followers = followed.follower_address
260 if following?(follower, followed) and follower.ap_id != followed.ap_id do
263 |> List.delete(ap_followers)
267 |> follow_changeset(%{following: following})
268 |> update_and_set_cache
270 {:ok, followed} = update_follower_count(followed)
272 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
274 {:error, "Not subscribed!"}
278 def following?(%User{} = follower, %User{} = followed) do
279 Enum.member?(follower.following, followed.follower_address)
282 def locked?(%User{} = user) do
283 user.info["locked"] || false
286 def get_by_ap_id(ap_id) do
287 Repo.get_by(User, ap_id: ap_id)
290 def update_and_set_cache(changeset) do
291 with {:ok, user} <- Repo.update(changeset) do
292 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
293 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
294 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
301 def invalidate_cache(user) do
302 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
303 Cachex.del(:user_cache, "nickname:#{user.nickname}")
304 Cachex.del(:user_cache, "user_info:#{user.id}")
307 def get_cached_by_ap_id(ap_id) do
308 key = "ap_id:#{ap_id}"
309 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
312 def get_cached_by_nickname(nickname) do
313 key = "nickname:#{nickname}"
314 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
317 def get_by_nickname(nickname) do
318 Repo.get_by(User, nickname: nickname)
321 def get_by_nickname_or_email(nickname_or_email) do
322 case user = Repo.get_by(User, nickname: nickname_or_email) do
324 nil -> Repo.get_by(User, email: nickname_or_email)
328 def get_cached_user_info(user) do
329 key = "user_info:#{user.id}"
330 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
333 def fetch_by_nickname(nickname) do
334 ap_try = ActivityPub.make_user_from_nickname(nickname)
337 {:ok, user} -> {:ok, user}
338 _ -> OStatus.make_user(nickname)
342 def get_or_fetch_by_nickname(nickname) do
343 with %User{} = user <- get_by_nickname(nickname) do
347 with [_nick, _domain] <- String.split(nickname, "@"),
348 {:ok, user} <- fetch_by_nickname(nickname) do
356 def get_followers_query(%User{id: id, follower_address: follower_address}) do
359 where: fragment("? <@ ?", ^[follower_address], u.following),
364 def get_followers(user) do
365 q = get_followers_query(user)
370 def get_friends_query(%User{id: id, following: following}) do
373 where: u.follower_address in ^following,
378 def get_friends(user) do
379 q = get_friends_query(user)
384 def get_follow_requests_query(%User{} = user) do
389 "? ->> 'type' = 'Follow'",
394 "? ->> 'state' = 'pending'",
401 ^%{"object" => user.ap_id}
406 def get_follow_requests(%User{} = user) do
407 q = get_follow_requests_query(user)
411 Enum.map(reqs, fn req -> req.actor end)
413 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
414 |> Enum.filter(fn u -> !following?(u, user) end)
419 def increase_note_count(%User{} = user) do
420 info_cng = User.Info.add_to_note_count(user.info, 1)
424 |> put_embed(:info, info_cng)
426 update_and_set_cache(cng)
429 def decrease_note_count(%User{} = user) do
430 info_cng = User.Info.add_to_note_count(user.info, -1)
434 |> put_embed(:info, info_cng)
436 update_and_set_cache(cng)
439 def update_note_count(%User{} = user) do
443 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
447 note_count = Repo.one(note_count_query)
449 info_cng = User.Info.set_note_count(user.info, note_count)
453 |> put_embed(:info, info_cng)
455 update_and_set_cache(cng)
458 def update_follower_count(%User{} = user) do
459 follower_count_query =
462 where: ^user.follower_address in u.following,
463 where: u.id != ^user.id,
467 follower_count = Repo.one(follower_count_query)
471 |> User.Info.set_follower_count(follower_count)
475 |> put_embed(:info, info_cng)
477 update_and_set_cache(cng)
480 def get_users_from_set_query(ap_ids, false) do
483 where: u.ap_id in ^ap_ids
487 def get_users_from_set_query(ap_ids, true) do
488 query = get_users_from_set_query(ap_ids, false)
492 where: u.local == true
496 def get_users_from_set(ap_ids, local_only \\ true) do
497 get_users_from_set_query(ap_ids, local_only)
501 def get_recipients_from_activity(%Activity{recipients: to}) do
505 where: u.ap_id in ^to,
506 or_where: fragment("? && ?", u.following, ^to)
509 query = from(u in query, where: u.local == true)
514 def search(query, resolve \\ false) do
515 # strip the beginning @ off if there is a query
516 query = String.trim_leading(query, "@")
519 User.get_or_fetch_by_nickname(query)
534 where: not is_nil(u.nickname)
539 s in subquery(inner),
540 order_by: s.search_distance,
547 def block(blocker, %User{ap_id: ap_id} = blocked) do
548 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
550 if following?(blocker, blocked) do
551 {:ok, blocker, _} = unfollow(blocker, blocked)
557 if following?(blocked, blocker) do
558 unfollow(blocked, blocker)
563 |> User.Info.add_to_block(ap_id)
567 |> put_embed(:info, info_cng)
569 update_and_set_cache(cng)
572 # helper to handle the block given only an actor's AP id
573 def block(blocker, %{ap_id: ap_id}) do
574 block(blocker, User.get_by_ap_id(ap_id))
577 def unblock(blocker, %{ap_id: ap_id}) do
580 |> User.Info.remove_from_block(ap_id)
584 |> put_embed(:info, info_cng)
586 update_and_set_cache(cng)
589 def blocks?(user, %{ap_id: ap_id}) do
590 blocks = user.info.blocks
591 domain_blocks = user.info.domain_blocks
592 %{host: host} = URI.parse(ap_id)
594 Enum.member?(blocks, ap_id) ||
595 Enum.any?(domain_blocks, fn domain ->
600 def block_domain(user, domain) do
602 |> User.Info.add_to_domain_block(domain)
605 |> put_embed(:info, info_cng)
607 update_and_set_cache(cng)
610 def unblock_domain(user, domain) do
612 |> User.Info.remove_from_domain_block(domain)
615 |> put_embed(:info, info_cng)
617 update_and_set_cache(cng)
620 def local_user_query() do
623 where: u.local == true,
624 where: not is_nil(u.nickname)
628 def moderator_user_query() do
631 where: u.local == true,
632 where: fragment("?->'is_moderator' @> 'true'", u.info)
636 def deactivate(%User{} = user, status \\ true) do
637 info_cng = User.Info.set_activation_status(user.info, status)
641 |> put_embed(:info, info_cng)
643 update_and_set_cache(cng)
646 def delete(%User{} = user) do
647 {:ok, user} = User.deactivate(user)
649 # Remove all relationships
650 {:ok, followers} = User.get_followers(user)
653 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
655 {:ok, friends} = User.get_friends(user)
658 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
660 query = from(a in Activity, where: a.actor == ^user.ap_id)
663 |> Enum.each(fn activity ->
664 case activity.data["type"] do
666 ActivityPub.delete(Object.normalize(activity.data["object"]))
668 # TODO: Do something with likes, follows, repeats.
677 def html_filter_policy(%User{info: %{"no_rich_text" => true}}) do
678 Pleroma.HTML.Scrubber.TwitterText
681 def html_filter_policy(_), do: nil
683 def get_or_fetch_by_ap_id(ap_id) do
684 user = get_by_ap_id(ap_id)
686 if !is_nil(user) and !User.needs_update?(user) do
689 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
696 case OStatus.make_user(ap_id) do
698 _ -> {:error, "Could not fetch by AP id"}
704 def get_or_create_instance_user do
705 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
707 if user = get_by_ap_id(relay_uri) do
712 |> cast(%{}, [:ap_id, :nickname, :local])
713 |> put_change(:ap_id, relay_uri)
714 |> put_change(:nickname, nil)
715 |> put_change(:local, true)
716 |> put_change(:follower_address, relay_uri <> "/followers")
718 {:ok, user} = Repo.insert(changes)
724 def public_key_from_info(%{
725 "source_data" => %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
728 :public_key.pem_decode(public_key_pem)
730 |> :public_key.pem_entry_decode()
736 def public_key_from_info(%{"magic_key" => magic_key}) do
737 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
740 def get_public_key_for_ap_id(ap_id) do
741 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
742 {:ok, public_key} <- public_key_from_info(user.info) do
749 defp blank?(""), do: nil
750 defp blank?(n), do: n
752 def insert_or_update_user(data) do
755 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
756 |> Map.put(:info, data[:info] || %{})
758 cs = User.remote_user_creation(data)
759 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
762 def ap_enabled?(%User{local: true}), do: true
763 def ap_enabled?(%User{info: info}), do: info.ap_enabled
764 def ap_enabled?(_), do: false
766 def get_or_fetch(uri_or_nickname) do
767 if String.starts_with?(uri_or_nickname, "http") do
768 get_or_fetch_by_ap_id(uri_or_nickname)
770 get_or_fetch_by_nickname(uri_or_nickname)
774 # wait a period of time and return newest version of the User structs
775 # this is because we have synchronous follow APIs and need to simulate them
776 # with an async handshake
777 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
778 with %User{} = a <- Repo.get(User, a.id),
779 %User{} = b <- Repo.get(User, b.id) do
787 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
788 with :ok <- :timer.sleep(timeout),
789 %User{} = a <- Repo.get(User, a.id),
790 %User{} = b <- Repo.get(User, b.id) do