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 has_many(:notifications, Notification)
30 def avatar_url(user) do
32 %{"url" => [%{"href" => href} | _]} -> href
33 _ -> "#{Web.base_url()}/images/avi.png"
37 def banner_url(user) do
38 case user.info["banner"] do
39 %{"url" => [%{"href" => href} | _]} -> href
40 _ -> "#{Web.base_url()}/images/banner.png"
44 def ap_id(%User{nickname: nickname}) do
45 "#{Web.base_url()}/users/#{nickname}"
48 def ap_followers(%User{} = user) do
49 "#{ap_id(user)}/followers"
52 def follow_changeset(struct, params \\ %{}) do
54 |> cast(params, [:following])
55 |> validate_required([:following])
58 def info_changeset(struct, params \\ %{}) do
60 |> cast(params, [:info])
61 |> validate_required([:info])
64 def user_info(%User{} = user) do
65 oneself = if user.local, do: 1, else: 0
68 following_count: length(user.following) - oneself,
69 note_count: user.info["note_count"] || 0,
70 follower_count: user.info["follower_count"] || 0,
71 locked: user.info["locked"] || false,
72 default_scope: user.info["default_scope"] || "public"
76 @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])?)*$/
77 def remote_user_creation(params) do
80 |> cast(params, [:bio, :name, :ap_id, :nickname, :info, :avatar])
81 |> validate_required([:name, :ap_id])
82 |> unique_constraint(:nickname)
83 |> validate_format(:nickname, @email_regex)
84 |> validate_length(:bio, max: 5000)
85 |> validate_length(:name, max: 100)
86 |> put_change(:local, false)
89 case changes.changes[:info]["source_data"] do
90 %{"followers" => followers} ->
92 |> put_change(:follower_address, followers)
95 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
98 |> put_change(:follower_address, followers)
105 def update_changeset(struct, params \\ %{}) do
107 |> cast(params, [:bio, :name])
108 |> unique_constraint(:nickname)
109 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
110 |> validate_length(:bio, max: 5000)
111 |> validate_length(:name, min: 1, max: 100)
114 def upgrade_changeset(struct, params \\ %{}) do
116 |> cast(params, [:bio, :name, :info, :follower_address, :avatar])
117 |> unique_constraint(:nickname)
118 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
119 |> validate_length(:bio, max: 5000)
120 |> validate_length(:name, max: 100)
123 def password_update_changeset(struct, params) do
126 |> cast(params, [:password, :password_confirmation])
127 |> validate_required([:password, :password_confirmation])
128 |> validate_confirmation(:password)
130 if changeset.valid? do
131 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
134 |> put_change(:password_hash, hashed)
140 def reset_password(user, data) do
141 update_and_set_cache(password_update_changeset(user, data))
144 def register_changeset(struct, params \\ %{}) do
147 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
148 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
149 |> validate_confirmation(:password)
150 |> unique_constraint(:email)
151 |> unique_constraint(:nickname)
152 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
153 |> validate_format(:email, @email_regex)
154 |> validate_length(:bio, max: 1000)
155 |> validate_length(:name, min: 1, max: 100)
157 if changeset.valid? do
158 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
159 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
160 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
163 |> put_change(:password_hash, hashed)
164 |> put_change(:ap_id, ap_id)
165 |> put_change(:following, [followers])
166 |> put_change(:follower_address, followers)
172 def maybe_direct_follow(%User{} = follower, %User{info: info} = followed) do
173 user_config = Application.get_env(:pleroma, :user)
174 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
176 user_info = user_info(followed)
178 should_direct_follow =
180 # if the account is locked, don't pre-create the relationship
181 user_info[:locked] == true ->
184 # if the users are blocking each other, we shouldn't even be here, but check for it anyway
185 deny_follow_blocked and
186 (User.blocks?(follower, followed) or User.blocks?(followed, follower)) ->
189 # if OStatus, then there is no three-way handshake to follow
190 User.ap_enabled?(followed) != true ->
193 # if there are no other reasons not to, just pre-create the relationship
198 if should_direct_follow do
199 follow(follower, followed)
205 def maybe_follow(%User{} = follower, %User{info: info} = followed) do
206 if not following?(follower, followed) do
207 follow(follower, followed)
213 def follow(%User{} = follower, %User{info: info} = followed) do
214 user_config = Application.get_env(:pleroma, :user)
215 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
217 ap_followers = followed.follower_address
220 following?(follower, followed) or info["deactivated"] ->
221 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
223 deny_follow_blocked and blocks?(followed, follower) ->
224 {:error, "Could not follow user: #{followed.nickname} blocked you."}
227 if !followed.local && follower.local && !ap_enabled?(followed) do
228 Websub.subscribe(follower, followed)
232 [ap_followers | follower.following]
237 |> follow_changeset(%{following: following})
238 |> update_and_set_cache
240 {:ok, _} = update_follower_count(followed)
246 def unfollow(%User{} = follower, %User{} = followed) do
247 ap_followers = followed.follower_address
249 if following?(follower, followed) and follower.ap_id != followed.ap_id do
252 |> List.delete(ap_followers)
256 |> follow_changeset(%{following: following})
257 |> update_and_set_cache
259 {:ok, followed} = update_follower_count(followed)
261 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
263 {:error, "Not subscribed!"}
267 def following?(%User{} = follower, %User{} = followed) do
268 Enum.member?(follower.following, followed.follower_address)
271 def locked?(%User{} = user) do
272 user.info["locked"] || false
275 def get_by_ap_id(ap_id) do
276 Repo.get_by(User, ap_id: ap_id)
279 def update_and_set_cache(changeset) do
280 with {:ok, user} <- Repo.update(changeset) do
281 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
282 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
283 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
290 def invalidate_cache(user) do
291 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
292 Cachex.del(:user_cache, "nickname:#{user.nickname}")
295 def get_cached_by_ap_id(ap_id) do
296 key = "ap_id:#{ap_id}"
297 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
300 def get_cached_by_nickname(nickname) do
301 key = "nickname:#{nickname}"
302 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
305 def get_by_nickname(nickname) do
306 Repo.get_by(User, nickname: nickname)
309 def get_by_nickname_or_email(nickname_or_email) do
310 case user = Repo.get_by(User, nickname: nickname_or_email) do
312 nil -> Repo.get_by(User, email: nickname_or_email)
316 def get_cached_user_info(user) do
317 key = "user_info:#{user.id}"
318 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
321 def fetch_by_nickname(nickname) do
322 ap_try = ActivityPub.make_user_from_nickname(nickname)
325 {:ok, user} -> {:ok, user}
326 _ -> OStatus.make_user(nickname)
330 def get_or_fetch_by_nickname(nickname) do
331 with %User{} = user <- get_by_nickname(nickname) do
335 with [_nick, _domain] <- String.split(nickname, "@"),
336 {:ok, user} <- fetch_by_nickname(nickname) do
344 def get_followers_query(%User{id: id, follower_address: follower_address}) do
347 where: fragment("? <@ ?", ^[follower_address], u.following),
352 def get_followers(user) do
353 q = get_followers_query(user)
358 def get_friends_query(%User{id: id, following: following}) do
361 where: u.follower_address in ^following,
366 def get_friends(user) do
367 q = get_friends_query(user)
372 def get_follow_requests_query(%User{} = user) do
377 "? ->> 'type' = 'Follow'",
382 "? ->> 'state' = 'pending'",
389 ^%{"object" => user.ap_id}
394 def get_follow_requests(%User{} = user) do
395 q = get_follow_requests_query(user)
399 Enum.map(reqs, fn req -> req.actor end)
401 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
402 |> Enum.filter(fn u -> !following?(u, user) end)
407 def increase_note_count(%User{} = user) do
408 note_count = (user.info["note_count"] || 0) + 1
409 new_info = Map.put(user.info, "note_count", note_count)
411 cs = info_changeset(user, %{info: new_info})
413 update_and_set_cache(cs)
416 def decrease_note_count(%User{} = user) do
417 note_count = user.info["note_count"] || 0
418 note_count = if note_count <= 0, do: 0, else: note_count - 1
419 new_info = Map.put(user.info, "note_count", note_count)
421 cs = info_changeset(user, %{info: new_info})
423 update_and_set_cache(cs)
426 def update_note_count(%User{} = user) do
430 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
434 note_count = Repo.one(note_count_query)
436 new_info = Map.put(user.info, "note_count", note_count)
438 cs = info_changeset(user, %{info: new_info})
440 update_and_set_cache(cs)
443 def update_follower_count(%User{} = user) do
444 follower_count_query =
447 where: ^user.follower_address in u.following,
448 where: u.id != ^user.id,
452 follower_count = Repo.one(follower_count_query)
454 new_info = Map.put(user.info, "follower_count", follower_count)
456 cs = info_changeset(user, %{info: new_info})
458 update_and_set_cache(cs)
461 def get_notified_from_activity_query(to) do
464 where: u.ap_id in ^to,
465 where: u.local == true
469 def get_notified_from_activity(%Activity{recipients: to, data: %{"type" => "Announce"} = data}) do
470 object = Object.normalize(data["object"])
471 actor = User.get_cached_by_ap_id(data["actor"])
473 # ensure that the actor who published the announced object appears only once
475 if actor.nickname != nil do
476 to ++ [object.data["actor"]]
482 query = get_notified_from_activity_query(to)
487 def get_notified_from_activity(%Activity{recipients: to}) do
488 query = get_notified_from_activity_query(to)
493 def get_recipients_from_activity(%Activity{recipients: to}) do
497 where: u.ap_id in ^to,
498 or_where: fragment("? && ?", u.following, ^to)
501 query = from(u in query, where: u.local == true)
506 def search(query, resolve) do
507 # strip the beginning @ off if there is a query
508 query = String.trim_leading(query, "@")
511 User.get_or_fetch_by_nickname(query)
526 where: not is_nil(u.nickname)
531 s in subquery(inner),
532 order_by: s.search_distance,
539 def block(blocker, %User{ap_id: ap_id} = blocked) do
540 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
542 if following?(blocker, blocked) do
543 {:ok, blocker, _} = unfollow(blocker, blocked)
549 if following?(blocked, blocker) do
550 unfollow(blocked, blocker)
553 blocks = blocker.info["blocks"] || []
554 new_blocks = Enum.uniq([ap_id | blocks])
555 new_info = Map.put(blocker.info, "blocks", new_blocks)
557 cs = User.info_changeset(blocker, %{info: new_info})
558 update_and_set_cache(cs)
561 # helper to handle the block given only an actor's AP id
562 def block(blocker, %{ap_id: ap_id}) do
563 block(blocker, User.get_by_ap_id(ap_id))
566 def unblock(user, %{ap_id: ap_id}) do
567 blocks = user.info["blocks"] || []
568 new_blocks = List.delete(blocks, ap_id)
569 new_info = Map.put(user.info, "blocks", new_blocks)
571 cs = User.info_changeset(user, %{info: new_info})
572 update_and_set_cache(cs)
575 def blocks?(user, %{ap_id: ap_id}) do
576 blocks = user.info["blocks"] || []
577 domain_blocks = user.info["domain_blocks"] || []
578 %{host: host} = URI.parse(ap_id)
580 Enum.member?(blocks, ap_id) ||
581 Enum.any?(domain_blocks, fn domain ->
586 def block_domain(user, domain) do
587 domain_blocks = user.info["domain_blocks"] || []
588 new_blocks = Enum.uniq([domain | domain_blocks])
589 new_info = Map.put(user.info, "domain_blocks", new_blocks)
591 cs = User.info_changeset(user, %{info: new_info})
592 update_and_set_cache(cs)
595 def unblock_domain(user, domain) do
596 blocks = user.info["domain_blocks"] || []
597 new_blocks = List.delete(blocks, domain)
598 new_info = Map.put(user.info, "domain_blocks", new_blocks)
600 cs = User.info_changeset(user, %{info: new_info})
601 update_and_set_cache(cs)
604 def local_user_query() do
607 where: u.local == true,
608 where: not is_nil(u.nickname)
612 def deactivate(%User{} = user) do
613 new_info = Map.put(user.info, "deactivated", true)
614 cs = User.info_changeset(user, %{info: new_info})
615 update_and_set_cache(cs)
618 def delete(%User{} = user) do
619 {:ok, user} = User.deactivate(user)
621 # Remove all relationships
622 {:ok, followers} = User.get_followers(user)
625 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
627 {:ok, friends} = User.get_friends(user)
630 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
632 query = from(a in Activity, where: a.actor == ^user.ap_id)
635 |> Enum.each(fn activity ->
636 case activity.data["type"] do
638 ActivityPub.delete(Object.normalize(activity.data["object"]))
640 # TODO: Do something with likes, follows, repeats.
649 def get_or_fetch_by_ap_id(ap_id) do
650 if user = get_by_ap_id(ap_id) do
653 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
660 case OStatus.make_user(ap_id) do
662 _ -> {:error, "Could not fetch by AP id"}
668 def get_or_create_instance_user do
669 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
671 if user = get_by_ap_id(relay_uri) do
676 |> cast(%{}, [:ap_id, :nickname, :local])
677 |> put_change(:ap_id, relay_uri)
678 |> put_change(:nickname, nil)
679 |> put_change(:local, true)
680 |> put_change(:follower_address, relay_uri <> "/followers")
682 {:ok, user} = Repo.insert(changes)
688 def public_key_from_info(%{
689 "source_data" => %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
692 :public_key.pem_decode(public_key_pem)
694 |> :public_key.pem_entry_decode()
700 def public_key_from_info(%{"magic_key" => magic_key}) do
701 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
704 def get_public_key_for_ap_id(ap_id) do
705 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
706 {:ok, public_key} <- public_key_from_info(user.info) do
713 defp blank?(""), do: nil
714 defp blank?(n), do: n
716 def insert_or_update_user(data) do
719 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
721 cs = User.remote_user_creation(data)
722 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
725 def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
726 def ap_enabled?(_), do: false
728 def get_or_fetch(uri_or_nickname) do
729 if String.starts_with?(uri_or_nickname, "http") do
730 get_or_fetch_by_ap_id(uri_or_nickname)
732 get_or_fetch_by_nickname(uri_or_nickname)