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 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"] || 0,
75 follower_count: user.info["follower_count"] || 0,
76 locked: user.info["locked"] || false,
77 default_scope: user.info["default_scope"] || "public"
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 note_count = (user.info["note_count"] || 0) + 1
415 new_info = Map.put(user.info, "note_count", note_count)
417 cs = info_changeset(user, %{info: new_info})
419 update_and_set_cache(cs)
422 def decrease_note_count(%User{} = user) do
423 note_count = user.info["note_count"] || 0
424 note_count = if note_count <= 0, do: 0, else: note_count - 1
425 new_info = Map.put(user.info, "note_count", note_count)
427 cs = info_changeset(user, %{info: new_info})
429 update_and_set_cache(cs)
432 def update_note_count(%User{} = user) do
436 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
440 note_count = Repo.one(note_count_query)
442 new_info = Map.put(user.info, "note_count", note_count)
444 cs = info_changeset(user, %{info: new_info})
446 update_and_set_cache(cs)
449 def update_follower_count(%User{} = user) do
450 follower_count_query =
453 where: ^user.follower_address in u.following,
454 where: u.id != ^user.id,
458 follower_count = Repo.one(follower_count_query)
460 new_info = Map.put(user.info, "follower_count", follower_count)
462 cs = info_changeset(user, %{info: new_info})
464 update_and_set_cache(cs)
467 def get_notified_from_activity_query(to) do
470 where: u.ap_id in ^to,
471 where: u.local == true
475 def get_notified_from_activity(%Activity{recipients: to, data: %{"type" => "Announce"} = data}) do
476 object = Object.normalize(data["object"])
477 actor = User.get_cached_by_ap_id(data["actor"])
479 # ensure that the actor who published the announced object appears only once
481 if actor.nickname != nil do
482 to ++ [object.data["actor"]]
488 query = get_notified_from_activity_query(to)
493 def get_notified_from_activity(%Activity{recipients: to}) do
494 query = get_notified_from_activity_query(to)
499 def get_recipients_from_activity(%Activity{recipients: to}) do
503 where: u.ap_id in ^to,
504 or_where: fragment("? && ?", u.following, ^to)
507 query = from(u in query, where: u.local == true)
512 def search(query, resolve) do
513 # strip the beginning @ off if there is a query
514 query = String.trim_leading(query, "@")
517 User.get_or_fetch_by_nickname(query)
532 where: not is_nil(u.nickname)
537 s in subquery(inner),
538 order_by: s.search_distance,
545 def block(blocker, %User{ap_id: ap_id} = blocked) do
546 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
548 if following?(blocker, blocked) do
549 {:ok, blocker, _} = unfollow(blocker, blocked)
555 if following?(blocked, blocker) do
556 unfollow(blocked, blocker)
559 blocks = blocker.info["blocks"] || []
560 new_blocks = Enum.uniq([ap_id | blocks])
561 new_info = Map.put(blocker.info, "blocks", new_blocks)
563 cs = User.info_changeset(blocker, %{info: new_info})
564 update_and_set_cache(cs)
567 # helper to handle the block given only an actor's AP id
568 def block(blocker, %{ap_id: ap_id}) do
569 block(blocker, User.get_by_ap_id(ap_id))
572 def unblock(user, %{ap_id: ap_id}) do
573 blocks = user.info["blocks"] || []
574 new_blocks = List.delete(blocks, ap_id)
575 new_info = Map.put(user.info, "blocks", new_blocks)
577 cs = User.info_changeset(user, %{info: new_info})
578 update_and_set_cache(cs)
581 def blocks?(user, %{ap_id: ap_id}) do
582 blocks = user.info["blocks"] || []
583 domain_blocks = user.info["domain_blocks"] || []
584 %{host: host} = URI.parse(ap_id)
586 Enum.member?(blocks, ap_id) ||
587 Enum.any?(domain_blocks, fn domain ->
592 def block_domain(user, domain) do
593 domain_blocks = user.info["domain_blocks"] || []
594 new_blocks = Enum.uniq([domain | domain_blocks])
595 new_info = Map.put(user.info, "domain_blocks", new_blocks)
597 cs = User.info_changeset(user, %{info: new_info})
598 update_and_set_cache(cs)
601 def unblock_domain(user, domain) do
602 blocks = user.info["domain_blocks"] || []
603 new_blocks = List.delete(blocks, domain)
604 new_info = Map.put(user.info, "domain_blocks", new_blocks)
606 cs = User.info_changeset(user, %{info: new_info})
607 update_and_set_cache(cs)
610 def local_user_query() do
613 where: u.local == true,
614 where: not is_nil(u.nickname)
618 def moderator_user_query() do
621 where: u.local == true,
622 where: fragment("?->'is_moderator' @> 'true'", u.info)
626 def deactivate(%User{} = user, status \\ true) do
627 new_info = Map.put(user.info, "deactivated", status)
628 cs = User.info_changeset(user, %{info: new_info})
629 update_and_set_cache(cs)
632 def delete(%User{} = user) do
633 {:ok, user} = User.deactivate(user)
635 # Remove all relationships
636 {:ok, followers} = User.get_followers(user)
639 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
641 {:ok, friends} = User.get_friends(user)
644 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
646 query = from(a in Activity, where: a.actor == ^user.ap_id)
649 |> Enum.each(fn activity ->
650 case activity.data["type"] do
652 ActivityPub.delete(Object.normalize(activity.data["object"]))
654 # TODO: Do something with likes, follows, repeats.
663 def html_filter_policy(%User{info: %{"no_rich_text" => true}}) do
664 Pleroma.HTML.Scrubber.TwitterText
667 def html_filter_policy(_), do: nil
669 def get_or_fetch_by_ap_id(ap_id) do
670 user = get_by_ap_id(ap_id)
672 if !is_nil(user) and !User.needs_update?(user) do
675 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
682 case OStatus.make_user(ap_id) do
684 _ -> {:error, "Could not fetch by AP id"}
690 def get_or_create_instance_user do
691 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
693 if user = get_by_ap_id(relay_uri) do
698 |> cast(%{}, [:ap_id, :nickname, :local])
699 |> put_change(:ap_id, relay_uri)
700 |> put_change(:nickname, nil)
701 |> put_change(:local, true)
702 |> put_change(:follower_address, relay_uri <> "/followers")
704 {:ok, user} = Repo.insert(changes)
710 def public_key_from_info(%{
711 "source_data" => %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
714 :public_key.pem_decode(public_key_pem)
716 |> :public_key.pem_entry_decode()
722 def public_key_from_info(%{"magic_key" => magic_key}) do
723 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
726 def get_public_key_for_ap_id(ap_id) do
727 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
728 {:ok, public_key} <- public_key_from_info(user.info) do
735 defp blank?(""), do: nil
736 defp blank?(n), do: n
738 def insert_or_update_user(data) do
741 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
743 cs = User.remote_user_creation(data)
744 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
747 def ap_enabled?(%User{local: true}), do: true
748 def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
749 def ap_enabled?(_), do: false
751 def get_or_fetch(uri_or_nickname) do
752 if String.starts_with?(uri_or_nickname, "http") do
753 get_or_fetch_by_ap_id(uri_or_nickname)
755 get_or_fetch_by_nickname(uri_or_nickname)
759 # wait a period of time and return newest version of the User structs
760 # this is because we have synchronous follow APIs and need to simulate them
761 # with an async handshake
762 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
763 with %User{} = a <- Repo.get(User, a.id),
764 %User{} = b <- Repo.get(User, b.id) do
772 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
773 with :ok <- :timer.sleep(timeout),
774 %User{} = a <- Repo.get(User, a.id),
775 %User{} = b <- Repo.get(User, b.id) do