1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 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 remote_or_auth_active?(%User{local: false}), do: true
53 def remote_or_auth_active?(%User{local: true} = user), do: auth_active?(user)
55 def visible_for?(%User{} = user, for_user \\ nil) do
56 User.remote_or_auth_active?(user) || (for_user && for_user.id == user.id) ||
57 User.superuser?(for_user)
60 def superuser?(nil), do: false
61 def superuser?(%User{} = user), do: user.info && User.Info.superuser?(user.info)
63 def avatar_url(user) do
65 %{"url" => [%{"href" => href} | _]} -> href
66 _ -> "#{Web.base_url()}/images/avi.png"
70 def banner_url(user) do
71 case user.info.banner do
72 %{"url" => [%{"href" => href} | _]} -> href
73 _ -> "#{Web.base_url()}/images/banner.png"
77 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
78 def profile_url(%User{ap_id: ap_id}), do: ap_id
79 def profile_url(_), do: nil
81 def ap_id(%User{nickname: nickname}) do
82 "#{Web.base_url()}/users/#{nickname}"
85 def ap_followers(%User{} = user) do
86 "#{ap_id(user)}/followers"
89 def follow_changeset(struct, params \\ %{}) do
91 |> cast(params, [:following])
92 |> validate_required([:following])
95 def user_info(%User{} = user) do
96 oneself = if user.local, do: 1, else: 0
99 following_count: length(user.following) - oneself,
100 note_count: user.info.note_count,
101 follower_count: user.info.follower_count,
102 locked: user.info.locked,
103 confirmation_pending: user.info.confirmation_pending,
104 default_scope: user.info.default_scope
108 def remote_user_creation(params) do
111 |> Map.put(:info, params[:info] || %{})
113 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
117 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
118 |> validate_required([:name, :ap_id])
119 |> unique_constraint(:nickname)
120 |> validate_format(:nickname, @email_regex)
121 |> validate_length(:bio, max: 5000)
122 |> validate_length(:name, max: 100)
123 |> put_change(:local, false)
124 |> put_embed(:info, info_cng)
127 case info_cng.changes[:source_data] do
128 %{"followers" => followers} ->
130 |> put_change(:follower_address, followers)
133 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
136 |> put_change(:follower_address, followers)
143 def update_changeset(struct, params \\ %{}) do
145 |> cast(params, [:bio, :name, :avatar])
146 |> unique_constraint(:nickname)
147 |> validate_format(:nickname, local_nickname_regex())
148 |> validate_length(:bio, max: 5000)
149 |> validate_length(:name, min: 1, max: 100)
152 def upgrade_changeset(struct, params \\ %{}) do
155 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
159 |> User.Info.user_upgrade(params[:info])
162 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
163 |> unique_constraint(:nickname)
164 |> validate_format(:nickname, local_nickname_regex())
165 |> validate_length(:bio, max: 5000)
166 |> validate_length(:name, max: 100)
167 |> put_embed(:info, info_cng)
170 def password_update_changeset(struct, params) do
173 |> cast(params, [:password, :password_confirmation])
174 |> validate_required([:password, :password_confirmation])
175 |> validate_confirmation(:password)
177 OAuth.Token.delete_user_tokens(struct)
178 OAuth.Authorization.delete_user_authorizations(struct)
180 if changeset.valid? do
181 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
184 |> put_change(:password_hash, hashed)
190 def reset_password(user, data) do
191 update_and_set_cache(password_update_changeset(user, data))
194 def register_changeset(struct, params \\ %{}, opts \\ []) do
195 confirmation_status =
196 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
202 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
206 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
207 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
208 |> validate_confirmation(:password)
209 |> unique_constraint(:email)
210 |> unique_constraint(:nickname)
211 |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
212 |> validate_format(:nickname, local_nickname_regex())
213 |> validate_format(:email, @email_regex)
214 |> validate_length(:bio, max: 1000)
215 |> validate_length(:name, min: 1, max: 100)
216 |> put_change(:info, info_change)
218 if changeset.valid? do
219 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
220 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
221 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
224 |> put_change(:password_hash, hashed)
225 |> put_change(:ap_id, ap_id)
226 |> put_change(:following, [followers])
227 |> put_change(:follower_address, followers)
233 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
234 def register(%Ecto.Changeset{} = changeset) do
235 with {:ok, user} <- Repo.insert(changeset),
236 {:ok, _} = try_send_confirmation_email(user) do
241 def try_send_confirmation_email(%User{} = user) do
242 if user.info.confirmation_pending &&
243 Pleroma.Config.get([:instance, :account_activation_required]) do
245 |> Pleroma.UserEmail.account_confirmation_email()
246 |> Pleroma.Mailer.deliver()
252 def needs_update?(%User{local: true}), do: false
254 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
256 def needs_update?(%User{local: false} = user) do
257 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
260 def needs_update?(_), do: true
262 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
266 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
267 follow(follower, followed)
270 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
271 if not User.ap_enabled?(followed) do
272 follow(follower, followed)
278 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
279 if not following?(follower, followed) do
280 follow(follower, followed)
286 def follow(%User{} = follower, %User{info: info} = followed) do
287 user_config = Application.get_env(:pleroma, :user)
288 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
290 ap_followers = followed.follower_address
293 following?(follower, followed) or info.deactivated ->
294 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
296 deny_follow_blocked and blocks?(followed, follower) ->
297 {:error, "Could not follow user: #{followed.nickname} blocked you."}
300 if !followed.local && follower.local && !ap_enabled?(followed) do
301 Websub.subscribe(follower, followed)
305 [ap_followers | follower.following]
310 |> follow_changeset(%{following: following})
311 |> update_and_set_cache
313 {:ok, _} = update_follower_count(followed)
319 def unfollow(%User{} = follower, %User{} = followed) do
320 ap_followers = followed.follower_address
322 if following?(follower, followed) and follower.ap_id != followed.ap_id do
325 |> List.delete(ap_followers)
329 |> follow_changeset(%{following: following})
330 |> update_and_set_cache
332 {:ok, followed} = update_follower_count(followed)
334 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
336 {:error, "Not subscribed!"}
340 @spec following?(User.t(), User.t()) :: boolean
341 def following?(%User{} = follower, %User{} = followed) do
342 Enum.member?(follower.following, followed.follower_address)
345 def follow_import(%User{} = follower, followed_identifiers)
346 when is_list(followed_identifiers) do
348 followed_identifiers,
349 fn followed_identifier ->
350 with %User{} = followed <- get_or_fetch(followed_identifier),
351 {:ok, follower} <- maybe_direct_follow(follower, followed),
352 {:ok, _} <- ActivityPub.follow(follower, followed) do
356 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
363 def locked?(%User{} = user) do
364 user.info.locked || false
367 def get_by_ap_id(ap_id) do
368 Repo.get_by(User, ap_id: ap_id)
371 # This is mostly an SPC migration fix. This guesses the user nickname (by taking the last part of the ap_id and the domain) and tries to get that user
372 def get_by_guessed_nickname(ap_id) do
373 domain = URI.parse(ap_id).host
374 name = List.last(String.split(ap_id, "/"))
375 nickname = "#{name}@#{domain}"
377 get_by_nickname(nickname)
380 def update_and_set_cache(changeset) do
381 with {:ok, user} <- Repo.update(changeset) do
382 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
383 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
384 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
391 def invalidate_cache(user) do
392 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
393 Cachex.del(:user_cache, "nickname:#{user.nickname}")
394 Cachex.del(:user_cache, "user_info:#{user.id}")
397 def get_cached_by_ap_id(ap_id) do
398 key = "ap_id:#{ap_id}"
399 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
402 def get_cached_by_nickname(nickname) do
403 key = "nickname:#{nickname}"
404 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
407 def get_by_nickname(nickname) do
408 Repo.get_by(User, nickname: nickname) ||
409 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
410 [local_nickname, _] = String.split(nickname, "@")
411 Repo.get_by(User, nickname: local_nickname)
415 def get_by_nickname_or_email(nickname_or_email) do
416 case user = Repo.get_by(User, nickname: nickname_or_email) do
418 nil -> Repo.get_by(User, email: nickname_or_email)
422 def get_cached_user_info(user) do
423 key = "user_info:#{user.id}"
424 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
427 def fetch_by_nickname(nickname) do
428 ap_try = ActivityPub.make_user_from_nickname(nickname)
431 {:ok, user} -> {:ok, user}
432 _ -> OStatus.make_user(nickname)
436 def get_or_fetch_by_nickname(nickname) do
437 with %User{} = user <- get_by_nickname(nickname) do
441 with [_nick, _domain] <- String.split(nickname, "@"),
442 {:ok, user} <- fetch_by_nickname(nickname) do
450 def get_followers_query(%User{id: id, follower_address: follower_address}) do
453 where: fragment("? <@ ?", ^[follower_address], u.following),
458 def get_followers(user) do
459 q = get_followers_query(user)
464 def get_friends_query(%User{id: id, following: following}) do
467 where: u.follower_address in ^following,
472 def get_friends(user) do
473 q = get_friends_query(user)
478 def get_follow_requests_query(%User{} = user) do
483 "? ->> 'type' = 'Follow'",
488 "? ->> 'state' = 'pending'",
495 ^%{"object" => user.ap_id}
500 def get_follow_requests(%User{} = user) do
501 q = get_follow_requests_query(user)
505 Enum.map(reqs, fn req -> req.actor end)
507 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
508 |> Enum.filter(fn u -> !is_nil(u) end)
509 |> Enum.filter(fn u -> !following?(u, user) end)
514 def increase_note_count(%User{} = user) do
515 info_cng = User.Info.add_to_note_count(user.info, 1)
519 |> put_embed(:info, info_cng)
521 update_and_set_cache(cng)
524 def decrease_note_count(%User{} = user) do
525 info_cng = User.Info.add_to_note_count(user.info, -1)
529 |> put_embed(:info, info_cng)
531 update_and_set_cache(cng)
534 def update_note_count(%User{} = user) do
538 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
542 note_count = Repo.one(note_count_query)
544 info_cng = User.Info.set_note_count(user.info, note_count)
548 |> put_embed(:info, info_cng)
550 update_and_set_cache(cng)
553 def update_follower_count(%User{} = user) do
554 follower_count_query =
557 where: ^user.follower_address in u.following,
558 where: u.id != ^user.id,
562 follower_count = Repo.one(follower_count_query)
566 |> User.Info.set_follower_count(follower_count)
570 |> put_embed(:info, info_cng)
572 update_and_set_cache(cng)
575 def get_users_from_set_query(ap_ids, false) do
578 where: u.ap_id in ^ap_ids
582 def get_users_from_set_query(ap_ids, true) do
583 query = get_users_from_set_query(ap_ids, false)
587 where: u.local == true
591 def get_users_from_set(ap_ids, local_only \\ true) do
592 get_users_from_set_query(ap_ids, local_only)
596 def get_recipients_from_activity(%Activity{recipients: to}) do
600 where: u.ap_id in ^to,
601 or_where: fragment("? && ?", u.following, ^to)
604 query = from(u in query, where: u.local == true)
609 def search(query, resolve \\ false) do
610 # strip the beginning @ off if there is a query
611 query = String.trim_leading(query, "@")
614 User.get_or_fetch_by_nickname(query)
623 "? <-> (? || coalesce(?, ''))",
629 where: not is_nil(u.nickname)
634 s in subquery(inner),
635 order_by: s.search_distance,
642 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
645 fn blocked_identifier ->
646 with %User{} = blocked <- get_or_fetch(blocked_identifier),
647 {:ok, blocker} <- block(blocker, blocked),
648 {:ok, _} <- ActivityPub.block(blocker, blocked) do
652 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
659 def block(blocker, %User{ap_id: ap_id} = blocked) do
660 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
662 if following?(blocker, blocked) do
663 {:ok, blocker, _} = unfollow(blocker, blocked)
669 if following?(blocked, blocker) do
670 unfollow(blocked, blocker)
675 |> User.Info.add_to_block(ap_id)
679 |> put_embed(:info, info_cng)
681 update_and_set_cache(cng)
684 # helper to handle the block given only an actor's AP id
685 def block(blocker, %{ap_id: ap_id}) do
686 block(blocker, User.get_by_ap_id(ap_id))
689 def unblock(blocker, %{ap_id: ap_id}) do
692 |> User.Info.remove_from_block(ap_id)
696 |> put_embed(:info, info_cng)
698 update_and_set_cache(cng)
701 def blocks?(user, %{ap_id: ap_id}) do
702 blocks = user.info.blocks
703 domain_blocks = user.info.domain_blocks
704 %{host: host} = URI.parse(ap_id)
706 Enum.member?(blocks, ap_id) ||
707 Enum.any?(domain_blocks, fn domain ->
712 def blocked_users(user),
713 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
715 def block_domain(user, domain) do
718 |> User.Info.add_to_domain_block(domain)
722 |> put_embed(:info, info_cng)
724 update_and_set_cache(cng)
727 def unblock_domain(user, domain) do
730 |> User.Info.remove_from_domain_block(domain)
734 |> put_embed(:info, info_cng)
736 update_and_set_cache(cng)
739 def local_user_query() do
742 where: u.local == true,
743 where: not is_nil(u.nickname)
747 def moderator_user_query() do
750 where: u.local == true,
751 where: fragment("?->'is_moderator' @> 'true'", u.info)
755 def deactivate(%User{} = user, status \\ true) do
756 info_cng = User.Info.set_activation_status(user.info, status)
760 |> put_embed(:info, info_cng)
762 update_and_set_cache(cng)
765 def delete(%User{} = user) do
766 {:ok, user} = User.deactivate(user)
768 # Remove all relationships
769 {:ok, followers} = User.get_followers(user)
772 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
774 {:ok, friends} = User.get_friends(user)
777 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
779 query = from(a in Activity, where: a.actor == ^user.ap_id)
782 |> Enum.each(fn activity ->
783 case activity.data["type"] do
785 ActivityPub.delete(Object.normalize(activity.data["object"]))
787 # TODO: Do something with likes, follows, repeats.
796 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
797 Pleroma.HTML.Scrubber.TwitterText
800 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
802 def html_filter_policy(_), do: @default_scrubbers
804 def get_or_fetch_by_ap_id(ap_id) do
805 user = get_by_ap_id(ap_id)
807 if !is_nil(user) and !User.needs_update?(user) do
810 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
817 case OStatus.make_user(ap_id) do
819 _ -> {:error, "Could not fetch by AP id"}
825 def get_or_create_instance_user do
826 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
828 if user = get_by_ap_id(relay_uri) do
832 %User{info: %User.Info{}}
833 |> cast(%{}, [:ap_id, :nickname, :local])
834 |> put_change(:ap_id, relay_uri)
835 |> put_change(:nickname, nil)
836 |> put_change(:local, true)
837 |> put_change(:follower_address, relay_uri <> "/followers")
839 {:ok, user} = Repo.insert(changes)
845 def public_key_from_info(%{
846 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
850 |> :public_key.pem_decode()
852 |> :public_key.pem_entry_decode()
858 def public_key_from_info(%{magic_key: magic_key}) do
859 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
862 def get_public_key_for_ap_id(ap_id) do
863 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
864 {:ok, public_key} <- public_key_from_info(user.info) do
871 defp blank?(""), do: nil
872 defp blank?(n), do: n
874 def insert_or_update_user(data) do
877 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
879 cs = User.remote_user_creation(data)
881 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
884 def ap_enabled?(%User{local: true}), do: true
885 def ap_enabled?(%User{info: info}), do: info.ap_enabled
886 def ap_enabled?(_), do: false
888 @doc "Gets or fetch a user by uri or nickname."
889 @spec get_or_fetch(String.t()) :: User.t()
890 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
891 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
893 # wait a period of time and return newest version of the User structs
894 # this is because we have synchronous follow APIs and need to simulate them
895 # with an async handshake
896 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
897 with %User{} = a <- Repo.get(User, a.id),
898 %User{} = b <- Repo.get(User, b.id) do
906 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
907 with :ok <- :timer.sleep(timeout),
908 %User{} = a <- Repo.get(User, a.id),
909 %User{} = b <- Repo.get(User, b.id) do
917 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
918 def parse_bio(nil, _user), do: ""
919 def parse_bio(bio, _user) when bio == "", do: bio
921 def parse_bio(bio, user) do
922 mentions = Formatter.parse_mentions(bio)
923 tags = Formatter.parse_tags(bio)
926 (user.info.source_data["tag"] || [])
927 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
928 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
929 {String.trim(name, ":"), url}
933 |> CommonUtils.format_input(mentions, tags, "text/plain")
934 |> Formatter.emojify(emoji)
937 def tag(user_identifiers, tags) when is_list(user_identifiers) do
938 Repo.transaction(fn ->
939 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
943 def tag(nickname, tags) when is_binary(nickname),
944 do: tag(User.get_by_nickname(nickname), tags)
946 def tag(%User{} = user, tags),
947 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
949 def untag(user_identifiers, tags) when is_list(user_identifiers) do
950 Repo.transaction(fn ->
951 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
955 def untag(nickname, tags) when is_binary(nickname),
956 do: untag(User.get_by_nickname(nickname), tags)
958 def untag(%User{} = user, tags),
959 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
961 defp update_tags(%User{} = user, new_tags) do
962 {:ok, updated_user} =
964 |> change(%{tags: new_tags})
970 defp normalize_tags(tags) do
973 |> Enum.map(&String.downcase(&1))
976 defp local_nickname_regex() do
977 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
978 @extended_local_nickname_regex
980 @strict_local_nickname_regex