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}
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 if changeset.valid? do
136 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
139 |> put_change(:password_hash, hashed)
145 def reset_password(user, data) do
146 update_and_set_cache(password_update_changeset(user, data))
149 def register_changeset(struct, params \\ %{}) do
152 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
153 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
154 |> validate_confirmation(:password)
155 |> unique_constraint(:email)
156 |> unique_constraint(:nickname)
157 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
158 |> validate_format(:email, @email_regex)
159 |> validate_length(:bio, max: 1000)
160 |> validate_length(:name, min: 1, max: 100)
162 if changeset.valid? do
163 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
164 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
165 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
168 |> put_change(:password_hash, hashed)
169 |> put_change(:ap_id, ap_id)
170 |> put_change(:following, [followers])
171 |> put_change(:follower_address, followers)
177 def needs_update?(%User{local: true}), do: false
179 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
181 def needs_update?(%User{local: false} = user) do
182 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
185 def needs_update?(_), do: true
187 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{"locked" => true}}) do
191 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
192 follow(follower, followed)
195 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
196 if !User.ap_enabled?(followed) do
197 follow(follower, followed)
203 def maybe_follow(%User{} = follower, %User{info: info} = followed) do
204 if not following?(follower, followed) do
205 follow(follower, followed)
211 def follow(%User{} = follower, %User{info: info} = followed) do
212 user_config = Application.get_env(:pleroma, :user)
213 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
215 ap_followers = followed.follower_address
218 following?(follower, followed) or info["deactivated"] ->
219 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
221 deny_follow_blocked and blocks?(followed, follower) ->
222 {:error, "Could not follow user: #{followed.nickname} blocked you."}
225 if !followed.local && follower.local && !ap_enabled?(followed) do
226 Websub.subscribe(follower, followed)
230 [ap_followers | follower.following]
235 |> follow_changeset(%{following: following})
236 |> update_and_set_cache
238 {:ok, _} = update_follower_count(followed)
244 def unfollow(%User{} = follower, %User{} = followed) do
245 ap_followers = followed.follower_address
247 if following?(follower, followed) and follower.ap_id != followed.ap_id do
250 |> List.delete(ap_followers)
254 |> follow_changeset(%{following: following})
255 |> update_and_set_cache
257 {:ok, followed} = update_follower_count(followed)
259 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
261 {:error, "Not subscribed!"}
265 def following?(%User{} = follower, %User{} = followed) do
266 Enum.member?(follower.following, followed.follower_address)
269 def locked?(%User{} = user) do
270 user.info["locked"] || false
273 def get_by_ap_id(ap_id) do
274 Repo.get_by(User, ap_id: ap_id)
277 def update_and_set_cache(changeset) do
278 with {:ok, user} <- Repo.update(changeset) do
279 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
280 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
281 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
288 def invalidate_cache(user) do
289 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
290 Cachex.del(:user_cache, "nickname:#{user.nickname}")
293 def get_cached_by_ap_id(ap_id) do
294 key = "ap_id:#{ap_id}"
295 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
298 def get_cached_by_nickname(nickname) do
299 key = "nickname:#{nickname}"
300 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
303 def get_by_nickname(nickname) do
304 Repo.get_by(User, nickname: nickname)
307 def get_by_nickname_or_email(nickname_or_email) do
308 case user = Repo.get_by(User, nickname: nickname_or_email) do
310 nil -> Repo.get_by(User, email: nickname_or_email)
314 def get_cached_user_info(user) do
315 key = "user_info:#{user.id}"
316 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
319 def fetch_by_nickname(nickname) do
320 ap_try = ActivityPub.make_user_from_nickname(nickname)
323 {:ok, user} -> {:ok, user}
324 _ -> OStatus.make_user(nickname)
328 def get_or_fetch_by_nickname(nickname) do
329 with %User{} = user <- get_by_nickname(nickname) do
333 with [_nick, _domain] <- String.split(nickname, "@"),
334 {:ok, user} <- fetch_by_nickname(nickname) do
342 def get_followers_query(%User{id: id, follower_address: follower_address}) do
345 where: fragment("? <@ ?", ^[follower_address], u.following),
350 def get_followers(user) do
351 q = get_followers_query(user)
356 def get_friends_query(%User{id: id, following: following}) do
359 where: u.follower_address in ^following,
364 def get_friends(user) do
365 q = get_friends_query(user)
370 def get_follow_requests_query(%User{} = user) do
375 "? ->> 'type' = 'Follow'",
380 "? ->> 'state' = 'pending'",
387 ^%{"object" => user.ap_id}
392 def get_follow_requests(%User{} = user) do
393 q = get_follow_requests_query(user)
397 Enum.map(reqs, fn req -> req.actor end)
399 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
400 |> Enum.filter(fn u -> !following?(u, user) end)
405 def increase_note_count(%User{} = user) do
406 note_count = (user.info["note_count"] || 0) + 1
407 new_info = Map.put(user.info, "note_count", note_count)
409 cs = info_changeset(user, %{info: new_info})
411 update_and_set_cache(cs)
414 def decrease_note_count(%User{} = user) do
415 note_count = user.info["note_count"] || 0
416 note_count = if note_count <= 0, do: 0, else: note_count - 1
417 new_info = Map.put(user.info, "note_count", note_count)
419 cs = info_changeset(user, %{info: new_info})
421 update_and_set_cache(cs)
424 def update_note_count(%User{} = user) do
428 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
432 note_count = Repo.one(note_count_query)
434 new_info = Map.put(user.info, "note_count", note_count)
436 cs = info_changeset(user, %{info: new_info})
438 update_and_set_cache(cs)
441 def update_follower_count(%User{} = user) do
442 follower_count_query =
445 where: ^user.follower_address in u.following,
446 where: u.id != ^user.id,
450 follower_count = Repo.one(follower_count_query)
452 new_info = Map.put(user.info, "follower_count", follower_count)
454 cs = info_changeset(user, %{info: new_info})
456 update_and_set_cache(cs)
459 def get_notified_from_activity_query(to) do
462 where: u.ap_id in ^to,
463 where: u.local == true
467 def get_notified_from_activity(%Activity{recipients: to, data: %{"type" => "Announce"} = data}) do
468 object = Object.normalize(data["object"])
469 actor = User.get_cached_by_ap_id(data["actor"])
471 # ensure that the actor who published the announced object appears only once
473 if actor.nickname != nil do
474 to ++ [object.data["actor"]]
480 query = get_notified_from_activity_query(to)
485 def get_notified_from_activity(%Activity{recipients: to}) do
486 query = get_notified_from_activity_query(to)
491 def get_recipients_from_activity(%Activity{recipients: to}) do
495 where: u.ap_id in ^to,
496 or_where: fragment("? && ?", u.following, ^to)
499 query = from(u in query, where: u.local == true)
504 def search(query, resolve) do
505 # strip the beginning @ off if there is a query
506 query = String.trim_leading(query, "@")
509 User.get_or_fetch_by_nickname(query)
524 where: not is_nil(u.nickname)
529 s in subquery(inner),
530 order_by: s.search_distance,
537 def block(blocker, %User{ap_id: ap_id} = blocked) do
538 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
540 if following?(blocker, blocked) do
541 {:ok, blocker, _} = unfollow(blocker, blocked)
547 if following?(blocked, blocker) do
548 unfollow(blocked, blocker)
551 blocks = blocker.info["blocks"] || []
552 new_blocks = Enum.uniq([ap_id | blocks])
553 new_info = Map.put(blocker.info, "blocks", new_blocks)
555 cs = User.info_changeset(blocker, %{info: new_info})
556 update_and_set_cache(cs)
559 # helper to handle the block given only an actor's AP id
560 def block(blocker, %{ap_id: ap_id}) do
561 block(blocker, User.get_by_ap_id(ap_id))
564 def unblock(user, %{ap_id: ap_id}) do
565 blocks = user.info["blocks"] || []
566 new_blocks = List.delete(blocks, ap_id)
567 new_info = Map.put(user.info, "blocks", new_blocks)
569 cs = User.info_changeset(user, %{info: new_info})
570 update_and_set_cache(cs)
573 def blocks?(user, %{ap_id: ap_id}) do
574 blocks = user.info["blocks"] || []
575 domain_blocks = user.info["domain_blocks"] || []
576 %{host: host} = URI.parse(ap_id)
578 Enum.member?(blocks, ap_id) ||
579 Enum.any?(domain_blocks, fn domain ->
584 def block_domain(user, domain) do
585 domain_blocks = user.info["domain_blocks"] || []
586 new_blocks = Enum.uniq([domain | domain_blocks])
587 new_info = Map.put(user.info, "domain_blocks", new_blocks)
589 cs = User.info_changeset(user, %{info: new_info})
590 update_and_set_cache(cs)
593 def unblock_domain(user, domain) do
594 blocks = user.info["domain_blocks"] || []
595 new_blocks = List.delete(blocks, domain)
596 new_info = Map.put(user.info, "domain_blocks", new_blocks)
598 cs = User.info_changeset(user, %{info: new_info})
599 update_and_set_cache(cs)
602 def local_user_query() do
605 where: u.local == true,
606 where: not is_nil(u.nickname)
610 def moderator_user_query() do
613 where: u.local == true,
614 where: fragment("?->'is_moderator' @> 'true'", u.info)
618 def deactivate(%User{} = user) do
619 new_info = Map.put(user.info, "deactivated", true)
620 cs = User.info_changeset(user, %{info: new_info})
621 update_and_set_cache(cs)
624 def delete(%User{} = user) do
625 {:ok, user} = User.deactivate(user)
627 # Remove all relationships
628 {:ok, followers} = User.get_followers(user)
631 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
633 {:ok, friends} = User.get_friends(user)
636 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
638 query = from(a in Activity, where: a.actor == ^user.ap_id)
641 |> Enum.each(fn activity ->
642 case activity.data["type"] do
644 ActivityPub.delete(Object.normalize(activity.data["object"]))
646 # TODO: Do something with likes, follows, repeats.
655 def html_filter_policy(%User{info: %{"no_rich_text" => true}}) do
656 Pleroma.HTML.Scrubber.TwitterText
659 def html_filter_policy(_), do: nil
661 def get_or_fetch_by_ap_id(ap_id) do
662 user = get_by_ap_id(ap_id)
664 if !is_nil(user) and !User.needs_update?(user) do
667 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
674 case OStatus.make_user(ap_id) do
676 _ -> {:error, "Could not fetch by AP id"}
682 def get_or_create_instance_user do
683 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
685 if user = get_by_ap_id(relay_uri) do
690 |> cast(%{}, [:ap_id, :nickname, :local])
691 |> put_change(:ap_id, relay_uri)
692 |> put_change(:nickname, nil)
693 |> put_change(:local, true)
694 |> put_change(:follower_address, relay_uri <> "/followers")
696 {:ok, user} = Repo.insert(changes)
702 def public_key_from_info(%{
703 "source_data" => %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
706 :public_key.pem_decode(public_key_pem)
708 |> :public_key.pem_entry_decode()
714 def public_key_from_info(%{"magic_key" => magic_key}) do
715 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
718 def get_public_key_for_ap_id(ap_id) do
719 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
720 {:ok, public_key} <- public_key_from_info(user.info) do
727 defp blank?(""), do: nil
728 defp blank?(n), do: n
730 def insert_or_update_user(data) do
733 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
735 cs = User.remote_user_creation(data)
736 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
739 def ap_enabled?(%User{local: true}), do: true
740 def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
741 def ap_enabled?(_), do: false
743 def get_or_fetch(uri_or_nickname) do
744 if String.starts_with?(uri_or_nickname, "http") do
745 get_or_fetch_by_ap_id(uri_or_nickname)
747 get_or_fetch_by_nickname(uri_or_nickname)
751 # wait a period of time and return newest version of the User structs
752 # this is because we have synchronous follow APIs and need to simulate them
753 # with an async handshake
754 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
755 with %User{} = a <- Repo.get(User, a.id),
756 %User{} = b <- Repo.get(User, b.id) do
764 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
765 with :ok <- :timer.sleep(timeout),
766 %User{} = a <- Repo.get(User, a.id),
767 %User{} = b <- Repo.get(User, b.id) do