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(:info, :map, default: %{})
23 field(:follower_address, :string)
24 field(:search_distance, :float, virtual: true)
25 field(:last_refreshed_at, :naive_datetime)
26 has_many(:notifications, Notification)
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 ap_id(%User{nickname: nickname}) do
46 "#{Web.base_url()}/users/#{nickname}"
49 def ap_followers(%User{} = user) do
50 "#{ap_id(user)}/followers"
53 def follow_changeset(struct, params \\ %{}) do
55 |> cast(params, [:following])
56 |> validate_required([:following])
59 def info_changeset(struct, params \\ %{}) do
61 |> cast(params, [:info])
62 |> validate_required([:info])
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"] || 0,
71 follower_count: user.info["follower_count"] || 0,
72 locked: user.info["locked"] || false,
73 default_scope: user.info["default_scope"] || "public"
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 |> cast(params, [:bio, :name, :ap_id, :nickname, :info, :avatar])
82 |> validate_required([:name, :ap_id])
83 |> unique_constraint(:nickname)
84 |> validate_format(:nickname, @email_regex)
85 |> validate_length(:bio, max: 5000)
86 |> validate_length(:name, max: 100)
87 |> put_change(:local, false)
90 case changes.changes[:info]["source_data"] do
91 %{"followers" => followers} ->
93 |> put_change(:follower_address, followers)
96 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
99 |> put_change(:follower_address, followers)
106 def update_changeset(struct, params \\ %{}) do
108 |> cast(params, [:bio, :name])
109 |> unique_constraint(:nickname)
110 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
111 |> validate_length(:bio, max: 5000)
112 |> validate_length(:name, min: 1, max: 100)
115 def upgrade_changeset(struct, params \\ %{}) do
118 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
121 |> cast(params, [:bio, :name, :info, :follower_address, :avatar, :last_refreshed_at])
122 |> unique_constraint(:nickname)
123 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
124 |> validate_length(:bio, max: 5000)
125 |> validate_length(:name, max: 100)
128 def password_update_changeset(struct, params) do
131 |> cast(params, [:password, :password_confirmation])
132 |> validate_required([:password, :password_confirmation])
133 |> validate_confirmation(:password)
135 OAuth.Token.delete_user_tokens(struct)
136 OAuth.Authorization.delete_user_authorizations(struct)
138 if changeset.valid? do
139 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
142 |> put_change(:password_hash, hashed)
148 def reset_password(user, data) do
149 update_and_set_cache(password_update_changeset(user, data))
152 def register_changeset(struct, params \\ %{}) do
155 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
156 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
157 |> validate_confirmation(:password)
158 |> unique_constraint(:email)
159 |> unique_constraint(:nickname)
160 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
161 |> validate_format(:email, @email_regex)
162 |> validate_length(:bio, max: 1000)
163 |> validate_length(:name, min: 1, max: 100)
165 if changeset.valid? do
166 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
167 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
168 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
171 |> put_change(:password_hash, hashed)
172 |> put_change(:ap_id, ap_id)
173 |> put_change(:following, [followers])
174 |> put_change(:follower_address, followers)
180 def needs_update?(%User{local: true}), do: false
182 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
184 def needs_update?(%User{local: false} = user) do
185 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
188 def needs_update?(_), do: true
190 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{"locked" => true}}) do
194 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
195 follow(follower, followed)
198 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
199 if !User.ap_enabled?(followed) do
200 follow(follower, followed)
206 def maybe_follow(%User{} = follower, %User{info: info} = followed) do
207 if not following?(follower, followed) do
208 follow(follower, followed)
214 def follow(%User{} = follower, %User{info: info} = followed) do
215 user_config = Application.get_env(:pleroma, :user)
216 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
218 ap_followers = followed.follower_address
221 following?(follower, followed) or info["deactivated"] ->
222 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
224 deny_follow_blocked and blocks?(followed, follower) ->
225 {:error, "Could not follow user: #{followed.nickname} blocked you."}
228 if !followed.local && follower.local && !ap_enabled?(followed) do
229 Websub.subscribe(follower, followed)
233 [ap_followers | follower.following]
238 |> follow_changeset(%{following: following})
239 |> update_and_set_cache
241 {:ok, _} = update_follower_count(followed)
247 def unfollow(%User{} = follower, %User{} = followed) do
248 ap_followers = followed.follower_address
250 if following?(follower, followed) and follower.ap_id != followed.ap_id do
253 |> List.delete(ap_followers)
257 |> follow_changeset(%{following: following})
258 |> update_and_set_cache
260 {:ok, followed} = update_follower_count(followed)
262 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
264 {:error, "Not subscribed!"}
268 def following?(%User{} = follower, %User{} = followed) do
269 Enum.member?(follower.following, followed.follower_address)
272 def locked?(%User{} = user) do
273 user.info["locked"] || false
276 def get_by_ap_id(ap_id) do
277 Repo.get_by(User, ap_id: ap_id)
280 def update_and_set_cache(changeset) do
281 with {:ok, user} <- Repo.update(changeset) do
282 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
283 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
284 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
291 def invalidate_cache(user) do
292 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
293 Cachex.del(:user_cache, "nickname:#{user.nickname}")
296 def get_cached_by_ap_id(ap_id) do
297 key = "ap_id:#{ap_id}"
298 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
301 def get_cached_by_nickname(nickname) do
302 key = "nickname:#{nickname}"
303 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
306 def get_by_nickname(nickname) do
307 Repo.get_by(User, nickname: nickname)
310 def get_by_nickname_or_email(nickname_or_email) do
311 case user = Repo.get_by(User, nickname: nickname_or_email) do
313 nil -> Repo.get_by(User, email: nickname_or_email)
317 def get_cached_user_info(user) do
318 key = "user_info:#{user.id}"
319 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
322 def fetch_by_nickname(nickname) do
323 ap_try = ActivityPub.make_user_from_nickname(nickname)
326 {:ok, user} -> {:ok, user}
327 _ -> OStatus.make_user(nickname)
331 def get_or_fetch_by_nickname(nickname) do
332 with %User{} = user <- get_by_nickname(nickname) do
336 with [_nick, _domain] <- String.split(nickname, "@"),
337 {:ok, user} <- fetch_by_nickname(nickname) do
345 def get_followers_query(%User{id: id, follower_address: follower_address}) do
348 where: fragment("? <@ ?", ^[follower_address], u.following),
353 def get_followers(user) do
354 q = get_followers_query(user)
359 def get_friends_query(%User{id: id, following: following}) do
362 where: u.follower_address in ^following,
367 def get_friends(user) do
368 q = get_friends_query(user)
373 def get_follow_requests_query(%User{} = user) do
378 "? ->> 'type' = 'Follow'",
383 "? ->> 'state' = 'pending'",
390 ^%{"object" => user.ap_id}
395 def get_follow_requests(%User{} = user) do
396 q = get_follow_requests_query(user)
400 Enum.map(reqs, fn req -> req.actor end)
402 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
403 |> Enum.filter(fn u -> !following?(u, user) end)
408 def increase_note_count(%User{} = user) do
409 note_count = (user.info["note_count"] || 0) + 1
410 new_info = Map.put(user.info, "note_count", note_count)
412 cs = info_changeset(user, %{info: new_info})
414 update_and_set_cache(cs)
417 def decrease_note_count(%User{} = user) do
418 note_count = user.info["note_count"] || 0
419 note_count = if note_count <= 0, do: 0, else: note_count - 1
420 new_info = Map.put(user.info, "note_count", note_count)
422 cs = info_changeset(user, %{info: new_info})
424 update_and_set_cache(cs)
427 def update_note_count(%User{} = user) do
431 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
435 note_count = Repo.one(note_count_query)
437 new_info = Map.put(user.info, "note_count", note_count)
439 cs = info_changeset(user, %{info: new_info})
441 update_and_set_cache(cs)
444 def update_follower_count(%User{} = user) do
445 follower_count_query =
448 where: ^user.follower_address in u.following,
449 where: u.id != ^user.id,
453 follower_count = Repo.one(follower_count_query)
455 new_info = Map.put(user.info, "follower_count", follower_count)
457 cs = info_changeset(user, %{info: new_info})
459 update_and_set_cache(cs)
462 def get_notified_from_activity_query(to) do
465 where: u.ap_id in ^to,
466 where: u.local == true
470 def get_notified_from_activity(%Activity{recipients: to, data: %{"type" => "Announce"} = data}) do
471 object = Object.normalize(data["object"])
472 actor = User.get_cached_by_ap_id(data["actor"])
474 # ensure that the actor who published the announced object appears only once
476 if actor.nickname != nil do
477 to ++ [object.data["actor"]]
483 query = get_notified_from_activity_query(to)
488 def get_notified_from_activity(%Activity{recipients: to}) do
489 query = get_notified_from_activity_query(to)
494 def get_recipients_from_activity(%Activity{recipients: to}) do
498 where: u.ap_id in ^to,
499 or_where: fragment("? && ?", u.following, ^to)
502 query = from(u in query, where: u.local == true)
507 def search(query, resolve) do
508 # strip the beginning @ off if there is a query
509 query = String.trim_leading(query, "@")
512 User.get_or_fetch_by_nickname(query)
527 where: not is_nil(u.nickname)
532 s in subquery(inner),
533 order_by: s.search_distance,
540 def block(blocker, %User{ap_id: ap_id} = blocked) do
541 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
543 if following?(blocker, blocked) do
544 {:ok, blocker, _} = unfollow(blocker, blocked)
550 if following?(blocked, blocker) do
551 unfollow(blocked, blocker)
554 blocks = blocker.info["blocks"] || []
555 new_blocks = Enum.uniq([ap_id | blocks])
556 new_info = Map.put(blocker.info, "blocks", new_blocks)
558 cs = User.info_changeset(blocker, %{info: new_info})
559 update_and_set_cache(cs)
562 # helper to handle the block given only an actor's AP id
563 def block(blocker, %{ap_id: ap_id}) do
564 block(blocker, User.get_by_ap_id(ap_id))
567 def unblock(user, %{ap_id: ap_id}) do
568 blocks = user.info["blocks"] || []
569 new_blocks = List.delete(blocks, ap_id)
570 new_info = Map.put(user.info, "blocks", new_blocks)
572 cs = User.info_changeset(user, %{info: new_info})
573 update_and_set_cache(cs)
576 def blocks?(user, %{ap_id: ap_id}) do
577 blocks = user.info["blocks"] || []
578 domain_blocks = user.info["domain_blocks"] || []
579 %{host: host} = URI.parse(ap_id)
581 Enum.member?(blocks, ap_id) ||
582 Enum.any?(domain_blocks, fn domain ->
587 def block_domain(user, domain) do
588 domain_blocks = user.info["domain_blocks"] || []
589 new_blocks = Enum.uniq([domain | domain_blocks])
590 new_info = Map.put(user.info, "domain_blocks", new_blocks)
592 cs = User.info_changeset(user, %{info: new_info})
593 update_and_set_cache(cs)
596 def unblock_domain(user, domain) do
597 blocks = user.info["domain_blocks"] || []
598 new_blocks = List.delete(blocks, domain)
599 new_info = Map.put(user.info, "domain_blocks", new_blocks)
601 cs = User.info_changeset(user, %{info: new_info})
602 update_and_set_cache(cs)
605 def local_user_query() do
608 where: u.local == true,
609 where: not is_nil(u.nickname)
613 def moderator_user_query() do
616 where: u.local == true,
617 where: fragment("?->'is_moderator' @> 'true'", u.info)
621 def deactivate(%User{} = user) do
622 new_info = Map.put(user.info, "deactivated", true)
623 cs = User.info_changeset(user, %{info: new_info})
624 update_and_set_cache(cs)
627 def delete(%User{} = user) do
628 {:ok, user} = User.deactivate(user)
630 # Remove all relationships
631 {:ok, followers} = User.get_followers(user)
634 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
636 {:ok, friends} = User.get_friends(user)
639 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
641 query = from(a in Activity, where: a.actor == ^user.ap_id)
644 |> Enum.each(fn activity ->
645 case activity.data["type"] do
647 ActivityPub.delete(Object.normalize(activity.data["object"]))
649 # TODO: Do something with likes, follows, repeats.
658 def html_filter_policy(%User{info: %{"no_rich_text" => true}}) do
659 Pleroma.HTML.Scrubber.TwitterText
662 def html_filter_policy(_), do: nil
664 def get_or_fetch_by_ap_id(ap_id) do
665 user = get_by_ap_id(ap_id)
667 if !is_nil(user) and !User.needs_update?(user) do
670 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
677 case OStatus.make_user(ap_id) do
679 _ -> {:error, "Could not fetch by AP id"}
685 def get_or_create_instance_user do
686 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
688 if user = get_by_ap_id(relay_uri) do
693 |> cast(%{}, [:ap_id, :nickname, :local])
694 |> put_change(:ap_id, relay_uri)
695 |> put_change(:nickname, nil)
696 |> put_change(:local, true)
697 |> put_change(:follower_address, relay_uri <> "/followers")
699 {:ok, user} = Repo.insert(changes)
705 def public_key_from_info(%{
706 "source_data" => %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
709 :public_key.pem_decode(public_key_pem)
711 |> :public_key.pem_entry_decode()
717 def public_key_from_info(%{"magic_key" => magic_key}) do
718 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
721 def get_public_key_for_ap_id(ap_id) do
722 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
723 {:ok, public_key} <- public_key_from_info(user.info) do
730 defp blank?(""), do: nil
731 defp blank?(n), do: n
733 def insert_or_update_user(data) do
736 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
738 cs = User.remote_user_creation(data)
739 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
742 def ap_enabled?(%User{local: true}), do: true
743 def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
744 def ap_enabled?(_), do: false
746 def get_or_fetch(uri_or_nickname) do
747 if String.starts_with?(uri_or_nickname, "http") do
748 get_or_fetch_by_ap_id(uri_or_nickname)
750 get_or_fetch_by_nickname(uri_or_nickname)
754 # wait a period of time and return newest version of the User structs
755 # this is because we have synchronous follow APIs and need to simulate them
756 # with an async handshake
757 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
758 with %User{} = a <- Repo.get(User, a.id),
759 %User{} = b <- Repo.get(User, b.id) do
767 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
768 with :ok <- :timer.sleep(timeout),
769 %User{} = a <- Repo.get(User, a.id),
770 %User{} = b <- Repo.get(User, b.id) do