1 defmodule Pleroma.User do
4 import Ecto.{Changeset, Query}
5 alias Pleroma.{Repo, User, Object, Web, Activity, Notification}
7 alias Pleroma.Formatter
8 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
9 alias Pleroma.Web.{OStatus, Websub, OAuth}
10 alias Pleroma.Web.ActivityPub.{Utils, ActivityPub}
14 field(:email, :string)
16 field(:nickname, :string)
17 field(:password_hash, :string)
18 field(:password, :string, virtual: true)
19 field(:password_confirmation, :string, virtual: true)
20 field(:following, {:array, :string}, default: [])
21 field(:ap_id, :string)
23 field(:local, :boolean, default: true)
24 field(:follower_address, :string)
25 field(:search_distance, :float, virtual: true)
26 field(:tags, {:array, :string}, default: [])
27 field(:last_refreshed_at, :naive_datetime)
28 has_many(:notifications, Notification)
29 embeds_one(:info, Pleroma.User.Info)
34 def avatar_url(user) do
36 %{"url" => [%{"href" => href} | _]} -> href
37 _ -> "#{Web.base_url()}/images/avi.png"
41 def banner_url(user) do
42 case user.info.banner do
43 %{"url" => [%{"href" => href} | _]} -> href
44 _ -> "#{Web.base_url()}/images/banner.png"
48 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
49 def profile_url(%User{ap_id: ap_id}), do: ap_id
50 def profile_url(_), do: nil
52 def ap_id(%User{nickname: nickname}) do
53 "#{Web.base_url()}/users/#{nickname}"
56 def ap_followers(%User{} = user) do
57 "#{ap_id(user)}/followers"
60 def follow_changeset(struct, params \\ %{}) do
62 |> cast(params, [:following])
63 |> validate_required([:following])
66 def info_changeset(struct, params \\ %{}) do
67 raise "NOT VALID ANYMORE"
70 def user_info(%User{} = user) do
71 oneself = if user.local, do: 1, else: 0
74 following_count: length(user.following) - oneself,
75 note_count: user.info.note_count,
76 follower_count: user.info.follower_count,
77 locked: user.info.locked,
78 default_scope: user.info.default_scope
82 @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])?)*$/
83 def remote_user_creation(params) do
86 |> Map.put(:info, params[:info] || %{})
88 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
92 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
93 |> validate_required([:name, :ap_id])
94 |> unique_constraint(:nickname)
95 |> validate_format(:nickname, @email_regex)
96 |> validate_length(:bio, max: 5000)
97 |> validate_length(:name, max: 100)
98 |> put_change(:local, false)
99 |> put_embed(:info, info_cng)
102 case info_cng.changes[:source_data] do
103 %{"followers" => followers} ->
105 |> put_change(:follower_address, followers)
108 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
111 |> put_change(:follower_address, followers)
118 def update_changeset(struct, params \\ %{}) do
120 |> cast(params, [:bio, :name, :avatar])
121 |> unique_constraint(:nickname)
122 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
123 |> validate_length(:bio, max: 5000)
124 |> validate_length(:name, min: 1, max: 100)
127 def upgrade_changeset(struct, params \\ %{}) do
130 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
134 |> User.Info.user_upgrade(params[:info])
137 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
138 |> unique_constraint(:nickname)
139 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
140 |> validate_length(:bio, max: 5000)
141 |> validate_length(:name, max: 100)
142 |> put_embed(:info, info_cng)
145 def password_update_changeset(struct, params) do
148 |> cast(params, [:password, :password_confirmation])
149 |> validate_required([:password, :password_confirmation])
150 |> validate_confirmation(:password)
152 OAuth.Token.delete_user_tokens(struct)
153 OAuth.Authorization.delete_user_authorizations(struct)
155 if changeset.valid? do
156 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
159 |> put_change(:password_hash, hashed)
165 def reset_password(user, data) do
166 update_and_set_cache(password_update_changeset(user, data))
169 def register_changeset(struct, params \\ %{}) do
172 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
173 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
174 |> validate_confirmation(:password)
175 |> unique_constraint(:email)
176 |> unique_constraint(:nickname)
177 |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
178 |> validate_format(:email, @email_regex)
179 |> validate_length(:bio, max: 1000)
180 |> validate_length(:name, min: 1, max: 100)
181 |> put_change(:info, %Pleroma.User.Info{})
183 if changeset.valid? do
184 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
185 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
186 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
189 |> put_change(:password_hash, hashed)
190 |> put_change(:ap_id, ap_id)
191 |> put_change(:following, [followers])
192 |> put_change(:follower_address, followers)
198 def needs_update?(%User{local: true}), do: false
200 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
202 def needs_update?(%User{local: false} = user) do
203 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
206 def needs_update?(_), do: true
208 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
212 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
213 follow(follower, followed)
216 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
217 if !User.ap_enabled?(followed) do
218 follow(follower, followed)
224 def maybe_follow(%User{} = follower, %User{info: info} = followed) do
225 if not following?(follower, followed) do
226 follow(follower, followed)
232 def follow(%User{} = follower, %User{info: info} = followed) do
233 user_config = Application.get_env(:pleroma, :user)
234 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
236 ap_followers = followed.follower_address
239 following?(follower, followed) or info.deactivated ->
240 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
242 deny_follow_blocked and blocks?(followed, follower) ->
243 {:error, "Could not follow user: #{followed.nickname} blocked you."}
246 if !followed.local && follower.local && !ap_enabled?(followed) do
247 Websub.subscribe(follower, followed)
251 [ap_followers | follower.following]
256 |> follow_changeset(%{following: following})
257 |> update_and_set_cache
259 {:ok, _} = update_follower_count(followed)
265 def unfollow(%User{} = follower, %User{} = followed) do
266 ap_followers = followed.follower_address
268 if following?(follower, followed) and follower.ap_id != followed.ap_id do
271 |> List.delete(ap_followers)
275 |> follow_changeset(%{following: following})
276 |> update_and_set_cache
278 {:ok, followed} = update_follower_count(followed)
280 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
282 {:error, "Not subscribed!"}
286 def following?(%User{} = follower, %User{} = followed) do
287 Enum.member?(follower.following, followed.follower_address)
290 def locked?(%User{} = user) do
291 user.info.locked || false
294 def get_by_ap_id(ap_id) do
295 Repo.get_by(User, ap_id: ap_id)
298 def update_and_set_cache(changeset) do
299 with {:ok, user} <- Repo.update(changeset) do
300 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
301 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
302 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
309 def invalidate_cache(user) do
310 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
311 Cachex.del(:user_cache, "nickname:#{user.nickname}")
312 Cachex.del(:user_cache, "user_info:#{user.id}")
315 def get_cached_by_ap_id(ap_id) do
316 key = "ap_id:#{ap_id}"
317 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
320 def get_cached_by_nickname(nickname) do
321 key = "nickname:#{nickname}"
322 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
325 def get_by_nickname(nickname) do
326 Repo.get_by(User, nickname: nickname)
329 def get_by_nickname_or_email(nickname_or_email) do
330 case user = Repo.get_by(User, nickname: nickname_or_email) do
332 nil -> Repo.get_by(User, email: nickname_or_email)
336 def get_cached_user_info(user) do
337 key = "user_info:#{user.id}"
338 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
341 def fetch_by_nickname(nickname) do
342 ap_try = ActivityPub.make_user_from_nickname(nickname)
345 {:ok, user} -> {:ok, user}
346 _ -> OStatus.make_user(nickname)
350 def get_or_fetch_by_nickname(nickname) do
351 with %User{} = user <- get_by_nickname(nickname) do
355 with [_nick, _domain] <- String.split(nickname, "@"),
356 {:ok, user} <- fetch_by_nickname(nickname) do
364 def get_followers_query(%User{id: id, follower_address: follower_address}) do
367 where: fragment("? <@ ?", ^[follower_address], u.following),
372 def get_followers(user) do
373 q = get_followers_query(user)
378 def get_friends_query(%User{id: id, following: following}) do
381 where: u.follower_address in ^following,
386 def get_friends(user) do
387 q = get_friends_query(user)
392 def get_follow_requests_query(%User{} = user) do
397 "? ->> 'type' = 'Follow'",
402 "? ->> 'state' = 'pending'",
409 ^%{"object" => user.ap_id}
414 def get_follow_requests(%User{} = user) do
415 q = get_follow_requests_query(user)
419 Enum.map(reqs, fn req -> req.actor end)
421 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
422 |> Enum.filter(fn u -> !following?(u, user) end)
427 def increase_note_count(%User{} = user) do
428 info_cng = User.Info.add_to_note_count(user.info, 1)
432 |> put_embed(:info, info_cng)
434 update_and_set_cache(cng)
437 def decrease_note_count(%User{} = user) do
438 info_cng = User.Info.add_to_note_count(user.info, -1)
442 |> put_embed(:info, info_cng)
444 update_and_set_cache(cng)
447 def update_note_count(%User{} = user) do
451 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
455 note_count = Repo.one(note_count_query)
457 info_cng = User.Info.set_note_count(user.info, note_count)
461 |> put_embed(:info, info_cng)
463 update_and_set_cache(cng)
466 def update_follower_count(%User{} = user) do
467 follower_count_query =
470 where: ^user.follower_address in u.following,
471 where: u.id != ^user.id,
475 follower_count = Repo.one(follower_count_query)
479 |> User.Info.set_follower_count(follower_count)
483 |> put_embed(:info, info_cng)
485 update_and_set_cache(cng)
488 def get_users_from_set_query(ap_ids, false) do
491 where: u.ap_id in ^ap_ids
495 def get_users_from_set_query(ap_ids, true) do
496 query = get_users_from_set_query(ap_ids, false)
500 where: u.local == true
504 def get_users_from_set(ap_ids, local_only \\ true) do
505 get_users_from_set_query(ap_ids, local_only)
509 def get_recipients_from_activity(%Activity{recipients: to}) do
513 where: u.ap_id in ^to,
514 or_where: fragment("? && ?", u.following, ^to)
517 query = from(u in query, where: u.local == true)
522 def search(query, resolve \\ false) do
523 # strip the beginning @ off if there is a query
524 query = String.trim_leading(query, "@")
527 User.get_or_fetch_by_nickname(query)
542 where: not is_nil(u.nickname)
547 s in subquery(inner),
548 order_by: s.search_distance,
555 def block(blocker, %User{ap_id: ap_id} = blocked) do
556 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
558 if following?(blocker, blocked) do
559 {:ok, blocker, _} = unfollow(blocker, blocked)
565 if following?(blocked, blocker) do
566 unfollow(blocked, blocker)
571 |> User.Info.add_to_block(ap_id)
575 |> put_embed(:info, info_cng)
577 update_and_set_cache(cng)
580 # helper to handle the block given only an actor's AP id
581 def block(blocker, %{ap_id: ap_id}) do
582 block(blocker, User.get_by_ap_id(ap_id))
585 def unblock(blocker, %{ap_id: ap_id}) do
588 |> User.Info.remove_from_block(ap_id)
592 |> put_embed(:info, info_cng)
594 update_and_set_cache(cng)
597 def blocks?(user, %{ap_id: ap_id}) do
598 blocks = user.info.blocks
599 domain_blocks = user.info.domain_blocks
600 %{host: host} = URI.parse(ap_id)
602 Enum.member?(blocks, ap_id) ||
603 Enum.any?(domain_blocks, fn domain ->
608 def block_domain(user, domain) do
611 |> User.Info.add_to_domain_block(domain)
615 |> put_embed(:info, info_cng)
617 update_and_set_cache(cng)
620 def unblock_domain(user, domain) do
623 |> User.Info.remove_from_domain_block(domain)
627 |> put_embed(:info, info_cng)
629 update_and_set_cache(cng)
632 def local_user_query() do
635 where: u.local == true,
636 where: not is_nil(u.nickname)
640 def moderator_user_query() do
643 where: u.local == true,
644 where: fragment("?->'is_moderator' @> 'true'", u.info)
648 def deactivate(%User{} = user, status \\ true) do
649 info_cng = User.Info.set_activation_status(user.info, status)
653 |> put_embed(:info, info_cng)
655 update_and_set_cache(cng)
658 def delete(%User{} = user) do
659 {:ok, user} = User.deactivate(user)
661 # Remove all relationships
662 {:ok, followers} = User.get_followers(user)
665 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
667 {:ok, friends} = User.get_friends(user)
670 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
672 query = from(a in Activity, where: a.actor == ^user.ap_id)
675 |> Enum.each(fn activity ->
676 case activity.data["type"] do
678 ActivityPub.delete(Object.normalize(activity.data["object"]))
680 # TODO: Do something with likes, follows, repeats.
689 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
690 Pleroma.HTML.Scrubber.TwitterText
693 def html_filter_policy(_), do: nil
695 def get_or_fetch_by_ap_id(ap_id) do
696 user = get_by_ap_id(ap_id)
698 if !is_nil(user) and !User.needs_update?(user) do
701 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
708 case OStatus.make_user(ap_id) do
710 _ -> {:error, "Could not fetch by AP id"}
716 def get_or_create_instance_user do
717 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
719 if user = get_by_ap_id(relay_uri) do
723 %User{info: %User.Info{}}
724 |> cast(%{}, [:ap_id, :nickname, :local])
725 |> put_change(:ap_id, relay_uri)
726 |> put_change(:nickname, nil)
727 |> put_change(:local, true)
728 |> put_change(:follower_address, relay_uri <> "/followers")
730 {:ok, user} = Repo.insert(changes)
736 def public_key_from_info(%{
737 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
740 :public_key.pem_decode(public_key_pem)
742 |> :public_key.pem_entry_decode()
748 def public_key_from_info(%{magic_key: magic_key}) do
749 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
752 def get_public_key_for_ap_id(ap_id) do
753 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
754 {:ok, public_key} <- public_key_from_info(user.info) do
761 defp blank?(""), do: nil
762 defp blank?(n), do: n
764 def insert_or_update_user(data) do
767 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
769 cs = User.remote_user_creation(data)
771 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
774 def ap_enabled?(%User{local: true}), do: true
775 def ap_enabled?(%User{info: info}), do: info.ap_enabled
776 def ap_enabled?(_), do: false
778 def get_or_fetch(uri_or_nickname) do
779 if String.starts_with?(uri_or_nickname, "http") do
780 get_or_fetch_by_ap_id(uri_or_nickname)
782 get_or_fetch_by_nickname(uri_or_nickname)
786 # wait a period of time and return newest version of the User structs
787 # this is because we have synchronous follow APIs and need to simulate them
788 # with an async handshake
789 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
790 with %User{} = a <- Repo.get(User, a.id),
791 %User{} = b <- Repo.get(User, b.id) do
799 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
800 with :ok <- :timer.sleep(timeout),
801 %User{} = a <- Repo.get(User, a.id),
802 %User{} = b <- Repo.get(User, b.id) do
810 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}}) do
811 mentions = Formatter.parse_mentions(bio)
812 tags = Formatter.parse_tags(bio)
815 (user.info.source_data["tag"] || [])
816 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
817 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
818 {String.trim(name, ":"), url}
821 CommonUtils.format_input(bio, mentions, tags, "text/plain") |> Formatter.emojify(emoji)
824 def tag(user_identifiers, tags), do: tag_or_untag(user_identifiers, tags, :tag)
826 def untag(user_identifiers, tags), do: tag_or_untag(user_identifiers, tags, :untag)
828 defp tag_or_untag(user_identifier, tags, action) when not is_list(user_identifier),
829 do: tag_or_untag([user_identifier], tags, action)
831 defp tag_or_untag([hd | _] = nicknames, tags, action) when is_binary(hd) do
832 users = Repo.all(from(u in User, where: u.nickname in ^nicknames))
834 if length(users) == length(nicknames) do
835 tag_or_untag(users, tags, action)
841 defp tag_or_untag([hd | _] = users, tags, action) when is_map(hd) do
845 |> Enum.map(&String.downcase(&1))
847 Repo.transaction(fn ->
849 new_tags = mutate_tags(user, tags, action)
851 {:ok, updated_user} =
853 |> change(%{tags: new_tags})
861 defp mutate_tags(user, tags, :tag), do: Enum.uniq(user.tags ++ tags)
863 defp mutate_tags(user, tags, :untag), do: user.tags -- tags