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{info: info} = followed) do
188 user_config = Application.get_env(:pleroma, :user)
189 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
191 user_info = user_info(followed)
193 should_direct_follow =
195 # if the account is locked, don't pre-create the relationship
196 user_info[:locked] == true ->
199 # if the users are blocking each other, we shouldn't even be here, but check for it anyway
200 deny_follow_blocked and
201 (User.blocks?(follower, followed) or User.blocks?(followed, follower)) ->
204 # if OStatus, then there is no three-way handshake to follow
205 User.ap_enabled?(followed) != true ->
208 # if there are no other reasons not to, just pre-create the relationship
213 if should_direct_follow do
214 follow(follower, followed)
220 def maybe_follow(%User{} = follower, %User{info: info} = followed) do
221 if not following?(follower, followed) do
222 follow(follower, followed)
228 def follow(%User{} = follower, %User{info: info} = followed) do
229 user_config = Application.get_env(:pleroma, :user)
230 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
232 ap_followers = followed.follower_address
235 following?(follower, followed) or info["deactivated"] ->
236 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
238 deny_follow_blocked and blocks?(followed, follower) ->
239 {:error, "Could not follow user: #{followed.nickname} blocked you."}
242 if !followed.local && follower.local && !ap_enabled?(followed) do
243 Websub.subscribe(follower, followed)
247 [ap_followers | follower.following]
252 |> follow_changeset(%{following: following})
253 |> update_and_set_cache
255 {:ok, _} = update_follower_count(followed)
261 def unfollow(%User{} = follower, %User{} = followed) do
262 ap_followers = followed.follower_address
264 if following?(follower, followed) and follower.ap_id != followed.ap_id do
267 |> List.delete(ap_followers)
271 |> follow_changeset(%{following: following})
272 |> update_and_set_cache
274 {:ok, followed} = update_follower_count(followed)
276 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
278 {:error, "Not subscribed!"}
282 def following?(%User{} = follower, %User{} = followed) do
283 Enum.member?(follower.following, followed.follower_address)
286 def locked?(%User{} = user) do
287 user.info["locked"] || false
290 def get_by_ap_id(ap_id) do
291 Repo.get_by(User, ap_id: ap_id)
294 def update_and_set_cache(changeset) do
295 with {:ok, user} <- Repo.update(changeset) do
296 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
297 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
298 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
305 def invalidate_cache(user) do
306 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
307 Cachex.del(:user_cache, "nickname:#{user.nickname}")
310 def get_cached_by_ap_id(ap_id) do
311 key = "ap_id:#{ap_id}"
312 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
315 def get_cached_by_nickname(nickname) do
316 key = "nickname:#{nickname}"
317 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
320 def get_by_nickname(nickname) do
321 Repo.get_by(User, nickname: nickname)
324 def get_by_nickname_or_email(nickname_or_email) do
325 case user = Repo.get_by(User, nickname: nickname_or_email) do
327 nil -> Repo.get_by(User, email: nickname_or_email)
331 def get_cached_user_info(user) do
332 key = "user_info:#{user.id}"
333 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
336 def fetch_by_nickname(nickname) do
337 ap_try = ActivityPub.make_user_from_nickname(nickname)
340 {:ok, user} -> {:ok, user}
341 _ -> OStatus.make_user(nickname)
345 def get_or_fetch_by_nickname(nickname) do
346 with %User{} = user <- get_by_nickname(nickname) do
350 with [_nick, _domain] <- String.split(nickname, "@"),
351 {:ok, user} <- fetch_by_nickname(nickname) do
359 def get_followers_query(%User{id: id, follower_address: follower_address}) do
362 where: fragment("? <@ ?", ^[follower_address], u.following),
367 def get_followers(user) do
368 q = get_followers_query(user)
373 def get_friends_query(%User{id: id, following: following}) do
376 where: u.follower_address in ^following,
381 def get_friends(user) do
382 q = get_friends_query(user)
387 def get_follow_requests_query(%User{} = user) do
392 "? ->> 'type' = 'Follow'",
397 "? ->> 'state' = 'pending'",
404 ^%{"object" => user.ap_id}
409 def get_follow_requests(%User{} = user) do
410 q = get_follow_requests_query(user)
414 Enum.map(reqs, fn req -> req.actor end)
416 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
417 |> Enum.filter(fn u -> !following?(u, user) end)
422 def increase_note_count(%User{} = user) do
423 note_count = (user.info["note_count"] || 0) + 1
424 new_info = Map.put(user.info, "note_count", note_count)
426 cs = info_changeset(user, %{info: new_info})
428 update_and_set_cache(cs)
431 def decrease_note_count(%User{} = user) do
432 note_count = user.info["note_count"] || 0
433 note_count = if note_count <= 0, do: 0, else: note_count - 1
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_note_count(%User{} = user) do
445 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
449 note_count = Repo.one(note_count_query)
451 new_info = Map.put(user.info, "note_count", note_count)
453 cs = info_changeset(user, %{info: new_info})
455 update_and_set_cache(cs)
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)
469 new_info = Map.put(user.info, "follower_count", follower_count)
471 cs = info_changeset(user, %{info: new_info})
473 update_and_set_cache(cs)
476 def get_notified_from_activity_query(to) do
479 where: u.ap_id in ^to,
480 where: u.local == true
484 def get_notified_from_activity(%Activity{recipients: to, data: %{"type" => "Announce"} = data}) do
485 object = Object.normalize(data["object"])
486 actor = User.get_cached_by_ap_id(data["actor"])
488 # ensure that the actor who published the announced object appears only once
490 if actor.nickname != nil do
491 to ++ [object.data["actor"]]
497 query = get_notified_from_activity_query(to)
502 def get_notified_from_activity(%Activity{recipients: to}) do
503 query = get_notified_from_activity_query(to)
508 def get_recipients_from_activity(%Activity{recipients: to}) do
512 where: u.ap_id in ^to,
513 or_where: fragment("? && ?", u.following, ^to)
516 query = from(u in query, where: u.local == true)
521 def search(query, resolve) do
522 # strip the beginning @ off if there is a query
523 query = String.trim_leading(query, "@")
526 User.get_or_fetch_by_nickname(query)
541 where: not is_nil(u.nickname)
546 s in subquery(inner),
547 order_by: s.search_distance,
554 def block(blocker, %User{ap_id: ap_id} = blocked) do
555 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
557 if following?(blocker, blocked) do
558 {:ok, blocker, _} = unfollow(blocker, blocked)
564 if following?(blocked, blocker) do
565 unfollow(blocked, blocker)
568 blocks = blocker.info["blocks"] || []
569 new_blocks = Enum.uniq([ap_id | blocks])
570 new_info = Map.put(blocker.info, "blocks", new_blocks)
572 cs = User.info_changeset(blocker, %{info: new_info})
573 update_and_set_cache(cs)
576 # helper to handle the block given only an actor's AP id
577 def block(blocker, %{ap_id: ap_id}) do
578 block(blocker, User.get_by_ap_id(ap_id))
581 def unblock(user, %{ap_id: ap_id}) do
582 blocks = user.info["blocks"] || []
583 new_blocks = List.delete(blocks, ap_id)
584 new_info = Map.put(user.info, "blocks", new_blocks)
586 cs = User.info_changeset(user, %{info: new_info})
587 update_and_set_cache(cs)
590 def blocks?(user, %{ap_id: ap_id}) do
591 blocks = user.info["blocks"] || []
592 domain_blocks = user.info["domain_blocks"] || []
593 %{host: host} = URI.parse(ap_id)
595 Enum.member?(blocks, ap_id) ||
596 Enum.any?(domain_blocks, fn domain ->
601 def block_domain(user, domain) do
602 domain_blocks = user.info["domain_blocks"] || []
603 new_blocks = Enum.uniq([domain | domain_blocks])
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 unblock_domain(user, domain) do
611 blocks = user.info["domain_blocks"] || []
612 new_blocks = List.delete(blocks, domain)
613 new_info = Map.put(user.info, "domain_blocks", new_blocks)
615 cs = User.info_changeset(user, %{info: new_info})
616 update_and_set_cache(cs)
619 def local_user_query() do
622 where: u.local == true,
623 where: not is_nil(u.nickname)
627 def moderator_user_query() do
630 where: u.local == true,
631 where: fragment("?->'is_moderator' @> 'true'", u.info)
635 def deactivate(%User{} = user) do
636 new_info = Map.put(user.info, "deactivated", true)
637 cs = User.info_changeset(user, %{info: new_info})
638 update_and_set_cache(cs)
641 def delete(%User{} = user) do
642 {:ok, user} = User.deactivate(user)
644 # Remove all relationships
645 {:ok, followers} = User.get_followers(user)
648 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
650 {:ok, friends} = User.get_friends(user)
653 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
655 query = from(a in Activity, where: a.actor == ^user.ap_id)
658 |> Enum.each(fn activity ->
659 case activity.data["type"] do
661 ActivityPub.delete(Object.normalize(activity.data["object"]))
663 # TODO: Do something with likes, follows, repeats.
672 def html_filter_policy(%User{info: %{"no_rich_text" => true}}) do
673 Pleroma.HTML.Scrubber.TwitterText
676 def html_filter_policy(_), do: nil
678 def get_or_fetch_by_ap_id(ap_id) do
679 user = get_by_ap_id(ap_id)
681 if !is_nil(user) and !User.needs_update?(user) do
684 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
691 case OStatus.make_user(ap_id) do
693 _ -> {:error, "Could not fetch by AP id"}
699 def get_or_create_instance_user do
700 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
702 if user = get_by_ap_id(relay_uri) do
707 |> cast(%{}, [:ap_id, :nickname, :local])
708 |> put_change(:ap_id, relay_uri)
709 |> put_change(:nickname, nil)
710 |> put_change(:local, true)
711 |> put_change(:follower_address, relay_uri <> "/followers")
713 {:ok, user} = Repo.insert(changes)
719 def public_key_from_info(%{
720 "source_data" => %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
723 :public_key.pem_decode(public_key_pem)
725 |> :public_key.pem_entry_decode()
731 def public_key_from_info(%{"magic_key" => magic_key}) do
732 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
735 def get_public_key_for_ap_id(ap_id) do
736 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
737 {:ok, public_key} <- public_key_from_info(user.info) do
744 defp blank?(""), do: nil
745 defp blank?(n), do: n
747 def insert_or_update_user(data) do
750 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
752 cs = User.remote_user_creation(data)
753 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
756 def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
757 def ap_enabled?(_), do: false
759 def get_or_fetch(uri_or_nickname) do
760 if String.starts_with?(uri_or_nickname, "http") do
761 get_or_fetch_by_ap_id(uri_or_nickname)
763 get_or_fetch_by_nickname(uri_or_nickname)