1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2018 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.User do
8 import Ecto.{Changeset, Query}
9 alias Pleroma.{Repo, User, Object, Web, Activity, Notification}
11 alias Pleroma.Formatter
12 alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
13 alias Pleroma.Web.{OStatus, Websub, OAuth}
14 alias Pleroma.Web.ActivityPub.{Utils, ActivityPub}
18 @type t :: %__MODULE__{}
20 @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])?)*$/
22 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
23 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
27 field(:email, :string)
29 field(:nickname, :string)
30 field(:password_hash, :string)
31 field(:password, :string, virtual: true)
32 field(:password_confirmation, :string, virtual: true)
33 field(:following, {:array, :string}, default: [])
34 field(:ap_id, :string)
36 field(:local, :boolean, default: true)
37 field(:follower_address, :string)
38 field(:search_distance, :float, virtual: true)
39 field(:tags, {:array, :string}, default: [])
40 field(:last_refreshed_at, :naive_datetime)
41 has_many(:notifications, Notification)
42 embeds_one(:info, Pleroma.User.Info)
47 def auth_active?(%User{} = user) do
48 (user.info && !user.info.confirmation_pending) ||
49 !Pleroma.Config.get([:instance, :account_activation_required])
52 def superuser?(%User{} = user), do: user.info && User.Info.superuser?(user.info)
54 def avatar_url(user) do
56 %{"url" => [%{"href" => href} | _]} -> href
57 _ -> "#{Web.base_url()}/images/avi.png"
61 def banner_url(user) do
62 case user.info.banner do
63 %{"url" => [%{"href" => href} | _]} -> href
64 _ -> "#{Web.base_url()}/images/banner.png"
68 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
69 def profile_url(%User{ap_id: ap_id}), do: ap_id
70 def profile_url(_), do: nil
72 def ap_id(%User{nickname: nickname}) do
73 "#{Web.base_url()}/users/#{nickname}"
76 def ap_followers(%User{} = user) do
77 "#{ap_id(user)}/followers"
80 def follow_changeset(struct, params \\ %{}) do
82 |> cast(params, [:following])
83 |> validate_required([:following])
86 def user_info(%User{} = user) do
87 oneself = if user.local, do: 1, else: 0
90 following_count: length(user.following) - oneself,
91 note_count: user.info.note_count,
92 follower_count: user.info.follower_count,
93 locked: user.info.locked,
94 confirmation_pending: user.info.confirmation_pending,
95 default_scope: user.info.default_scope
99 def remote_user_creation(params) do
102 |> Map.put(:info, params[:info] || %{})
104 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
108 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
109 |> validate_required([:name, :ap_id])
110 |> unique_constraint(:nickname)
111 |> validate_format(:nickname, @email_regex)
112 |> validate_length(:bio, max: 5000)
113 |> validate_length(:name, max: 100)
114 |> put_change(:local, false)
115 |> put_embed(:info, info_cng)
118 case info_cng.changes[:source_data] do
119 %{"followers" => followers} ->
121 |> put_change(:follower_address, followers)
124 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
127 |> put_change(:follower_address, followers)
134 def update_changeset(struct, params \\ %{}) do
136 |> cast(params, [:bio, :name, :avatar])
137 |> unique_constraint(:nickname)
138 |> validate_format(:nickname, local_nickname_regex())
139 |> validate_length(:bio, max: 5000)
140 |> validate_length(:name, min: 1, max: 100)
143 def upgrade_changeset(struct, params \\ %{}) do
146 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
150 |> User.Info.user_upgrade(params[:info])
153 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
154 |> unique_constraint(:nickname)
155 |> validate_format(:nickname, local_nickname_regex())
156 |> validate_length(:bio, max: 5000)
157 |> validate_length(:name, max: 100)
158 |> put_embed(:info, info_cng)
161 def password_update_changeset(struct, params) do
164 |> cast(params, [:password, :password_confirmation])
165 |> validate_required([:password, :password_confirmation])
166 |> validate_confirmation(:password)
168 OAuth.Token.delete_user_tokens(struct)
169 OAuth.Authorization.delete_user_authorizations(struct)
171 if changeset.valid? do
172 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
175 |> put_change(:password_hash, hashed)
181 def reset_password(user, data) do
182 update_and_set_cache(password_update_changeset(user, data))
185 def register_changeset(struct, params \\ %{}, opts \\ []) do
186 confirmation_status =
187 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
193 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
197 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
198 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
199 |> validate_confirmation(:password)
200 |> unique_constraint(:email)
201 |> unique_constraint(:nickname)
202 |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
203 |> validate_format(:nickname, local_nickname_regex())
204 |> validate_format(:email, @email_regex)
205 |> validate_length(:bio, max: 1000)
206 |> validate_length(:name, min: 1, max: 100)
207 |> put_change(:info, info_change)
209 if changeset.valid? do
210 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
211 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
212 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
215 |> put_change(:password_hash, hashed)
216 |> put_change(:ap_id, ap_id)
217 |> put_change(:following, [followers])
218 |> put_change(:follower_address, followers)
224 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
225 def register(%Ecto.Changeset{} = changeset) do
226 with {:ok, user} <- Repo.insert(changeset),
227 {:ok, _} = try_send_confirmation_email(user) do
232 def try_send_confirmation_email(%User{} = user) do
233 if user.info.confirmation_pending &&
234 Pleroma.Config.get([:instance, :account_activation_required]) do
236 |> Pleroma.UserEmail.account_confirmation_email()
237 |> Pleroma.Mailer.deliver()
243 def needs_update?(%User{local: true}), do: false
245 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
247 def needs_update?(%User{local: false} = user) do
248 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
251 def needs_update?(_), do: true
253 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
257 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
258 follow(follower, followed)
261 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
262 if not User.ap_enabled?(followed) do
263 follow(follower, followed)
269 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
270 if not following?(follower, followed) do
271 follow(follower, followed)
277 def follow(%User{} = follower, %User{info: info} = followed) do
278 user_config = Application.get_env(:pleroma, :user)
279 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
281 ap_followers = followed.follower_address
284 following?(follower, followed) or info.deactivated ->
285 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
287 deny_follow_blocked and blocks?(followed, follower) ->
288 {:error, "Could not follow user: #{followed.nickname} blocked you."}
291 if !followed.local && follower.local && !ap_enabled?(followed) do
292 Websub.subscribe(follower, followed)
296 [ap_followers | follower.following]
301 |> follow_changeset(%{following: following})
302 |> update_and_set_cache
304 {:ok, _} = update_follower_count(followed)
310 def unfollow(%User{} = follower, %User{} = followed) do
311 ap_followers = followed.follower_address
313 if following?(follower, followed) and follower.ap_id != followed.ap_id do
316 |> List.delete(ap_followers)
320 |> follow_changeset(%{following: following})
321 |> update_and_set_cache
323 {:ok, followed} = update_follower_count(followed)
325 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
327 {:error, "Not subscribed!"}
331 @spec following?(User.t(), User.t()) :: boolean
332 def following?(%User{} = follower, %User{} = followed) do
333 Enum.member?(follower.following, followed.follower_address)
336 def follow_import(%User{} = follower, followed_identifiers)
337 when is_list(followed_identifiers) do
339 followed_identifiers,
340 fn followed_identifier ->
341 with %User{} = followed <- get_or_fetch(followed_identifier),
342 {:ok, follower} <- maybe_direct_follow(follower, followed),
343 {:ok, _} <- ActivityPub.follow(follower, followed) do
347 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
354 def locked?(%User{} = user) do
355 user.info.locked || false
358 def get_by_ap_id(ap_id) do
359 Repo.get_by(User, ap_id: ap_id)
362 def update_and_set_cache(changeset) do
363 with {:ok, user} <- Repo.update(changeset) do
364 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
365 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
366 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
373 def invalidate_cache(user) do
374 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
375 Cachex.del(:user_cache, "nickname:#{user.nickname}")
376 Cachex.del(:user_cache, "user_info:#{user.id}")
379 def get_cached_by_ap_id(ap_id) do
380 key = "ap_id:#{ap_id}"
381 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
384 def get_cached_by_nickname(nickname) do
385 key = "nickname:#{nickname}"
386 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
389 def get_by_nickname(nickname) do
390 Repo.get_by(User, nickname: nickname) ||
391 if String.ends_with?(nickname, "@" <> Pleroma.Web.Endpoint.host()) do
392 [local_nickname, _] = String.split(nickname, "@")
393 Repo.get_by(User, nickname: local_nickname)
397 def get_by_nickname_or_email(nickname_or_email) do
398 case user = Repo.get_by(User, nickname: nickname_or_email) do
400 nil -> Repo.get_by(User, email: nickname_or_email)
404 def get_cached_user_info(user) do
405 key = "user_info:#{user.id}"
406 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
409 def fetch_by_nickname(nickname) do
410 ap_try = ActivityPub.make_user_from_nickname(nickname)
413 {:ok, user} -> {:ok, user}
414 _ -> OStatus.make_user(nickname)
418 def get_or_fetch_by_nickname(nickname) do
419 with %User{} = user <- get_by_nickname(nickname) do
423 with [_nick, _domain] <- String.split(nickname, "@"),
424 {:ok, user} <- fetch_by_nickname(nickname) do
432 def get_followers_query(%User{id: id, follower_address: follower_address}) do
435 where: fragment("? <@ ?", ^[follower_address], u.following),
440 def get_followers(user) do
441 q = get_followers_query(user)
446 def get_friends_query(%User{id: id, following: following}) do
449 where: u.follower_address in ^following,
454 def get_friends(user) do
455 q = get_friends_query(user)
460 def get_follow_requests_query(%User{} = user) do
465 "? ->> 'type' = 'Follow'",
470 "? ->> 'state' = 'pending'",
477 ^%{"object" => user.ap_id}
482 def get_follow_requests(%User{} = user) do
483 q = get_follow_requests_query(user)
487 Enum.map(reqs, fn req -> req.actor end)
489 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
490 |> Enum.filter(fn u -> !following?(u, user) end)
495 def increase_note_count(%User{} = user) do
496 info_cng = User.Info.add_to_note_count(user.info, 1)
500 |> put_embed(:info, info_cng)
502 update_and_set_cache(cng)
505 def decrease_note_count(%User{} = user) do
506 info_cng = User.Info.add_to_note_count(user.info, -1)
510 |> put_embed(:info, info_cng)
512 update_and_set_cache(cng)
515 def update_note_count(%User{} = user) do
519 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
523 note_count = Repo.one(note_count_query)
525 info_cng = User.Info.set_note_count(user.info, note_count)
529 |> put_embed(:info, info_cng)
531 update_and_set_cache(cng)
534 def update_follower_count(%User{} = user) do
535 follower_count_query =
538 where: ^user.follower_address in u.following,
539 where: u.id != ^user.id,
543 follower_count = Repo.one(follower_count_query)
547 |> User.Info.set_follower_count(follower_count)
551 |> put_embed(:info, info_cng)
553 update_and_set_cache(cng)
556 def get_users_from_set_query(ap_ids, false) do
559 where: u.ap_id in ^ap_ids
563 def get_users_from_set_query(ap_ids, true) do
564 query = get_users_from_set_query(ap_ids, false)
568 where: u.local == true
572 def get_users_from_set(ap_ids, local_only \\ true) do
573 get_users_from_set_query(ap_ids, local_only)
577 def get_recipients_from_activity(%Activity{recipients: to}) do
581 where: u.ap_id in ^to,
582 or_where: fragment("? && ?", u.following, ^to)
585 query = from(u in query, where: u.local == true)
590 def search(query, resolve \\ false) do
591 # strip the beginning @ off if there is a query
592 query = String.trim_leading(query, "@")
595 User.get_or_fetch_by_nickname(query)
610 where: not is_nil(u.nickname)
615 s in subquery(inner),
616 order_by: s.search_distance,
623 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
626 fn blocked_identifier ->
627 with %User{} = blocked <- get_or_fetch(blocked_identifier),
628 {:ok, blocker} <- block(blocker, blocked),
629 {:ok, _} <- ActivityPub.block(blocker, blocked) do
633 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
640 def block(blocker, %User{ap_id: ap_id} = blocked) do
641 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
643 if following?(blocker, blocked) do
644 {:ok, blocker, _} = unfollow(blocker, blocked)
650 if following?(blocked, blocker) do
651 unfollow(blocked, blocker)
656 |> User.Info.add_to_block(ap_id)
660 |> put_embed(:info, info_cng)
662 update_and_set_cache(cng)
665 # helper to handle the block given only an actor's AP id
666 def block(blocker, %{ap_id: ap_id}) do
667 block(blocker, User.get_by_ap_id(ap_id))
670 def unblock(blocker, %{ap_id: ap_id}) do
673 |> User.Info.remove_from_block(ap_id)
677 |> put_embed(:info, info_cng)
679 update_and_set_cache(cng)
682 def blocks?(user, %{ap_id: ap_id}) do
683 blocks = user.info.blocks
684 domain_blocks = user.info.domain_blocks
685 %{host: host} = URI.parse(ap_id)
687 Enum.member?(blocks, ap_id) ||
688 Enum.any?(domain_blocks, fn domain ->
693 def blocked_users(user),
694 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
696 def block_domain(user, domain) do
699 |> User.Info.add_to_domain_block(domain)
703 |> put_embed(:info, info_cng)
705 update_and_set_cache(cng)
708 def unblock_domain(user, domain) do
711 |> User.Info.remove_from_domain_block(domain)
715 |> put_embed(:info, info_cng)
717 update_and_set_cache(cng)
720 def local_user_query() do
723 where: u.local == true,
724 where: not is_nil(u.nickname)
728 def moderator_user_query() do
731 where: u.local == true,
732 where: fragment("?->'is_moderator' @> 'true'", u.info)
736 def deactivate(%User{} = user, status \\ true) do
737 info_cng = User.Info.set_activation_status(user.info, status)
741 |> put_embed(:info, info_cng)
743 update_and_set_cache(cng)
746 def delete(%User{} = user) do
747 {:ok, user} = User.deactivate(user)
749 # Remove all relationships
750 {:ok, followers} = User.get_followers(user)
753 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
755 {:ok, friends} = User.get_friends(user)
758 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
760 query = from(a in Activity, where: a.actor == ^user.ap_id)
763 |> Enum.each(fn activity ->
764 case activity.data["type"] do
766 ActivityPub.delete(Object.normalize(activity.data["object"]))
768 # TODO: Do something with likes, follows, repeats.
777 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
778 Pleroma.HTML.Scrubber.TwitterText
781 def html_filter_policy(_), do: nil
783 def get_or_fetch_by_ap_id(ap_id) do
784 user = get_by_ap_id(ap_id)
786 if !is_nil(user) and !User.needs_update?(user) do
789 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
796 case OStatus.make_user(ap_id) do
798 _ -> {:error, "Could not fetch by AP id"}
804 def get_or_create_instance_user do
805 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
807 if user = get_by_ap_id(relay_uri) do
811 %User{info: %User.Info{}}
812 |> cast(%{}, [:ap_id, :nickname, :local])
813 |> put_change(:ap_id, relay_uri)
814 |> put_change(:nickname, nil)
815 |> put_change(:local, true)
816 |> put_change(:follower_address, relay_uri <> "/followers")
818 {:ok, user} = Repo.insert(changes)
824 def public_key_from_info(%{
825 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
829 |> :public_key.pem_decode()
831 |> :public_key.pem_entry_decode()
837 def public_key_from_info(%{magic_key: magic_key}) do
838 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
841 def get_public_key_for_ap_id(ap_id) do
842 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
843 {:ok, public_key} <- public_key_from_info(user.info) do
850 defp blank?(""), do: nil
851 defp blank?(n), do: n
853 def insert_or_update_user(data) do
856 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
858 cs = User.remote_user_creation(data)
860 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
863 def ap_enabled?(%User{local: true}), do: true
864 def ap_enabled?(%User{info: info}), do: info.ap_enabled
865 def ap_enabled?(_), do: false
867 @doc "Gets or fetch a user by uri or nickname."
868 @spec get_or_fetch(String.t()) :: User.t()
869 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
870 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
872 # wait a period of time and return newest version of the User structs
873 # this is because we have synchronous follow APIs and need to simulate them
874 # with an async handshake
875 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
876 with %User{} = a <- Repo.get(User, a.id),
877 %User{} = b <- Repo.get(User, b.id) do
885 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
886 with :ok <- :timer.sleep(timeout),
887 %User{} = a <- Repo.get(User, a.id),
888 %User{} = b <- Repo.get(User, b.id) do
896 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
897 def parse_bio(nil, _user), do: ""
898 def parse_bio(bio, _user) when bio == "", do: bio
900 def parse_bio(bio, user) do
901 mentions = Formatter.parse_mentions(bio)
902 tags = Formatter.parse_tags(bio)
905 (user.info.source_data["tag"] || [])
906 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
907 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
908 {String.trim(name, ":"), url}
912 |> CommonUtils.format_input(mentions, tags, "text/plain")
913 |> Formatter.emojify(emoji)
916 def tag(user_identifiers, tags) when is_list(user_identifiers) do
917 Repo.transaction(fn ->
918 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
922 def tag(nickname, tags) when is_binary(nickname),
923 do: tag(User.get_by_nickname(nickname), tags)
925 def tag(%User{} = user, tags),
926 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
928 def untag(user_identifiers, tags) when is_list(user_identifiers) do
929 Repo.transaction(fn ->
930 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
934 def untag(nickname, tags) when is_binary(nickname),
935 do: untag(User.get_by_nickname(nickname), tags)
937 def untag(%User{} = user, tags),
938 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
940 defp update_tags(%User{} = user, new_tags) do
941 {:ok, updated_user} =
943 |> change(%{tags: new_tags})
949 defp normalize_tags(tags) do
952 |> Enum.map(&String.downcase(&1))
955 defp local_nickname_regex() do
956 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
957 @extended_local_nickname_regex
959 @strict_local_nickname_regex