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{local: false}), do: false
49 def auth_active?(%User{info: %User.Info{confirmation_pending: false}}), do: true
51 def auth_active?(%User{info: %User.Info{confirmation_pending: true}}),
52 do: !Pleroma.Config.get([:instance, :account_activation_required])
54 def auth_active?(_), do: false
56 def visible_for?(user, for_user \\ nil)
58 def visible_for?(%User{id: user_id}, %User{id: for_id}) when user_id == for_id, do: true
60 def visible_for?(%User{} = user, for_user) do
61 auth_active?(user) || superuser?(for_user)
64 def visible_for?(_, _), do: false
66 def superuser?(%User{info: %User.Info{} = info}), do: User.Info.superuser?(info)
67 def superuser?(_), do: false
69 def avatar_url(user) do
71 %{"url" => [%{"href" => href} | _]} -> href
72 _ -> "#{Web.base_url()}/images/avi.png"
76 def banner_url(user) do
77 case user.info.banner do
78 %{"url" => [%{"href" => href} | _]} -> href
79 _ -> "#{Web.base_url()}/images/banner.png"
83 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
84 def profile_url(%User{ap_id: ap_id}), do: ap_id
85 def profile_url(_), do: nil
87 def ap_id(%User{nickname: nickname}) do
88 "#{Web.base_url()}/users/#{nickname}"
91 def ap_followers(%User{} = user) do
92 "#{ap_id(user)}/followers"
95 def follow_changeset(struct, params \\ %{}) do
97 |> cast(params, [:following])
98 |> validate_required([:following])
101 def user_info(%User{} = user) do
102 oneself = if user.local, do: 1, else: 0
105 following_count: length(user.following) - oneself,
106 note_count: user.info.note_count,
107 follower_count: user.info.follower_count,
108 locked: user.info.locked,
109 confirmation_pending: user.info.confirmation_pending,
110 default_scope: user.info.default_scope
114 def remote_user_creation(params) do
117 |> Map.put(:info, params[:info] || %{})
119 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
123 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
124 |> validate_required([:name, :ap_id])
125 |> unique_constraint(:nickname)
126 |> validate_format(:nickname, @email_regex)
127 |> validate_length(:bio, max: 5000)
128 |> validate_length(:name, max: 100)
129 |> put_change(:local, false)
130 |> put_embed(:info, info_cng)
133 case info_cng.changes[:source_data] do
134 %{"followers" => followers} ->
136 |> put_change(:follower_address, followers)
139 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
142 |> put_change(:follower_address, followers)
149 def update_changeset(struct, params \\ %{}) do
151 |> cast(params, [:bio, :name, :avatar])
152 |> unique_constraint(:nickname)
153 |> validate_format(:nickname, local_nickname_regex())
154 |> validate_length(:bio, max: 5000)
155 |> validate_length(:name, min: 1, max: 100)
158 def upgrade_changeset(struct, params \\ %{}) do
161 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
165 |> User.Info.user_upgrade(params[:info])
168 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
169 |> unique_constraint(:nickname)
170 |> validate_format(:nickname, local_nickname_regex())
171 |> validate_length(:bio, max: 5000)
172 |> validate_length(:name, max: 100)
173 |> put_embed(:info, info_cng)
176 def password_update_changeset(struct, params) do
179 |> cast(params, [:password, :password_confirmation])
180 |> validate_required([:password, :password_confirmation])
181 |> validate_confirmation(:password)
183 OAuth.Token.delete_user_tokens(struct)
184 OAuth.Authorization.delete_user_authorizations(struct)
186 if changeset.valid? do
187 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
190 |> put_change(:password_hash, hashed)
196 def reset_password(user, data) do
197 update_and_set_cache(password_update_changeset(user, data))
200 def register_changeset(struct, params \\ %{}, opts \\ []) do
201 confirmation_status =
202 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
208 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
212 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
213 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
214 |> validate_confirmation(:password)
215 |> unique_constraint(:email)
216 |> unique_constraint(:nickname)
217 |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
218 |> validate_format(:nickname, local_nickname_regex())
219 |> validate_format(:email, @email_regex)
220 |> validate_length(:bio, max: 1000)
221 |> validate_length(:name, min: 1, max: 100)
222 |> put_change(:info, info_change)
224 if changeset.valid? do
225 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
226 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
227 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
230 |> put_change(:password_hash, hashed)
231 |> put_change(:ap_id, ap_id)
232 |> put_change(:following, [followers])
233 |> put_change(:follower_address, followers)
239 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
240 def register(%Ecto.Changeset{} = changeset) do
241 with {:ok, user} <- Repo.insert(changeset),
242 {:ok, _} = try_send_confirmation_email(user) do
247 def try_send_confirmation_email(%User{} = user) do
248 if user.info.confirmation_pending &&
249 Pleroma.Config.get([:instance, :account_activation_required]) do
251 |> Pleroma.UserEmail.account_confirmation_email()
252 |> Pleroma.Mailer.deliver()
258 def needs_update?(%User{local: true}), do: false
260 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
262 def needs_update?(%User{local: false} = user) do
263 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
266 def needs_update?(_), do: true
268 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
272 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
273 follow(follower, followed)
276 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
277 if not User.ap_enabled?(followed) do
278 follow(follower, followed)
284 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
285 if not following?(follower, followed) do
286 follow(follower, followed)
292 def follow(%User{} = follower, %User{info: info} = followed) do
293 user_config = Application.get_env(:pleroma, :user)
294 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
296 ap_followers = followed.follower_address
299 following?(follower, followed) or info.deactivated ->
300 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
302 deny_follow_blocked and blocks?(followed, follower) ->
303 {:error, "Could not follow user: #{followed.nickname} blocked you."}
306 if !followed.local && follower.local && !ap_enabled?(followed) do
307 Websub.subscribe(follower, followed)
311 [ap_followers | follower.following]
316 |> follow_changeset(%{following: following})
317 |> update_and_set_cache
319 {:ok, _} = update_follower_count(followed)
325 def unfollow(%User{} = follower, %User{} = followed) do
326 ap_followers = followed.follower_address
328 if following?(follower, followed) and follower.ap_id != followed.ap_id do
331 |> List.delete(ap_followers)
335 |> follow_changeset(%{following: following})
336 |> update_and_set_cache
338 {:ok, followed} = update_follower_count(followed)
340 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
342 {:error, "Not subscribed!"}
346 @spec following?(User.t(), User.t()) :: boolean
347 def following?(%User{} = follower, %User{} = followed) do
348 Enum.member?(follower.following, followed.follower_address)
351 def follow_import(%User{} = follower, followed_identifiers)
352 when is_list(followed_identifiers) do
354 followed_identifiers,
355 fn followed_identifier ->
356 with %User{} = followed <- get_or_fetch(followed_identifier),
357 {:ok, follower} <- maybe_direct_follow(follower, followed),
358 {:ok, _} <- ActivityPub.follow(follower, followed) do
362 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
369 def locked?(%User{} = user) do
370 user.info.locked || false
373 def get_by_ap_id(ap_id) do
374 Repo.get_by(User, ap_id: ap_id)
377 # 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
378 def get_by_guessed_nickname(ap_id) do
379 domain = URI.parse(ap_id).host
380 name = List.last(String.split(ap_id, "/"))
381 nickname = "#{name}@#{domain}"
383 get_by_nickname(nickname)
386 def update_and_set_cache(changeset) do
387 with {:ok, user} <- Repo.update(changeset) do
388 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
389 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
390 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
397 def invalidate_cache(user) do
398 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
399 Cachex.del(:user_cache, "nickname:#{user.nickname}")
400 Cachex.del(:user_cache, "user_info:#{user.id}")
403 def get_cached_by_ap_id(ap_id) do
404 key = "ap_id:#{ap_id}"
405 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
408 def get_cached_by_nickname(nickname) do
409 key = "nickname:#{nickname}"
410 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
413 def get_by_nickname(nickname) do
414 Repo.get_by(User, nickname: nickname) ||
415 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
416 [local_nickname, _] = String.split(nickname, "@")
417 Repo.get_by(User, nickname: local_nickname)
421 def get_by_nickname_or_email(nickname_or_email) do
422 case user = Repo.get_by(User, nickname: nickname_or_email) do
424 nil -> Repo.get_by(User, email: nickname_or_email)
428 def get_cached_user_info(user) do
429 key = "user_info:#{user.id}"
430 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
433 def fetch_by_nickname(nickname) do
434 ap_try = ActivityPub.make_user_from_nickname(nickname)
437 {:ok, user} -> {:ok, user}
438 _ -> OStatus.make_user(nickname)
442 def get_or_fetch_by_nickname(nickname) do
443 with %User{} = user <- get_by_nickname(nickname) do
447 with [_nick, _domain] <- String.split(nickname, "@"),
448 {:ok, user} <- fetch_by_nickname(nickname) do
456 def get_followers_query(%User{id: id, follower_address: follower_address}) do
459 where: fragment("? <@ ?", ^[follower_address], u.following),
464 def get_followers(user) do
465 q = get_followers_query(user)
470 def get_friends_query(%User{id: id, following: following}) do
473 where: u.follower_address in ^following,
478 def get_friends(user) do
479 q = get_friends_query(user)
484 def get_follow_requests_query(%User{} = user) do
489 "? ->> 'type' = 'Follow'",
494 "? ->> 'state' = 'pending'",
501 ^%{"object" => user.ap_id}
506 def get_follow_requests(%User{} = user) do
507 q = get_follow_requests_query(user)
511 Enum.map(reqs, fn req -> req.actor end)
513 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
514 |> Enum.filter(fn u -> !is_nil(u) end)
515 |> Enum.filter(fn u -> !following?(u, user) end)
520 def increase_note_count(%User{} = user) do
521 info_cng = User.Info.add_to_note_count(user.info, 1)
525 |> put_embed(:info, info_cng)
527 update_and_set_cache(cng)
530 def decrease_note_count(%User{} = user) do
531 info_cng = User.Info.add_to_note_count(user.info, -1)
535 |> put_embed(:info, info_cng)
537 update_and_set_cache(cng)
540 def update_note_count(%User{} = user) do
544 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
548 note_count = Repo.one(note_count_query)
550 info_cng = User.Info.set_note_count(user.info, note_count)
554 |> put_embed(:info, info_cng)
556 update_and_set_cache(cng)
559 def update_follower_count(%User{} = user) do
560 follower_count_query =
563 where: ^user.follower_address in u.following,
564 where: u.id != ^user.id,
568 follower_count = Repo.one(follower_count_query)
572 |> User.Info.set_follower_count(follower_count)
576 |> put_embed(:info, info_cng)
578 update_and_set_cache(cng)
581 def get_users_from_set_query(ap_ids, false) do
584 where: u.ap_id in ^ap_ids
588 def get_users_from_set_query(ap_ids, true) do
589 query = get_users_from_set_query(ap_ids, false)
593 where: u.local == true
597 def get_users_from_set(ap_ids, local_only \\ true) do
598 get_users_from_set_query(ap_ids, local_only)
602 def get_recipients_from_activity(%Activity{recipients: to}) do
606 where: u.ap_id in ^to,
607 or_where: fragment("? && ?", u.following, ^to)
610 query = from(u in query, where: u.local == true)
615 def search(query, resolve \\ false) do
616 # strip the beginning @ off if there is a query
617 query = String.trim_leading(query, "@")
620 User.get_or_fetch_by_nickname(query)
629 "? <-> (? || coalesce(?, ''))",
635 where: not is_nil(u.nickname)
640 s in subquery(inner),
641 order_by: s.search_distance,
648 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
651 fn blocked_identifier ->
652 with %User{} = blocked <- get_or_fetch(blocked_identifier),
653 {:ok, blocker} <- block(blocker, blocked),
654 {:ok, _} <- ActivityPub.block(blocker, blocked) do
658 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
665 def block(blocker, %User{ap_id: ap_id} = blocked) do
666 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
668 if following?(blocker, blocked) do
669 {:ok, blocker, _} = unfollow(blocker, blocked)
675 if following?(blocked, blocker) do
676 unfollow(blocked, blocker)
681 |> User.Info.add_to_block(ap_id)
685 |> put_embed(:info, info_cng)
687 update_and_set_cache(cng)
690 # helper to handle the block given only an actor's AP id
691 def block(blocker, %{ap_id: ap_id}) do
692 block(blocker, User.get_by_ap_id(ap_id))
695 def unblock(blocker, %{ap_id: ap_id}) do
698 |> User.Info.remove_from_block(ap_id)
702 |> put_embed(:info, info_cng)
704 update_and_set_cache(cng)
707 def blocks?(user, %{ap_id: ap_id}) do
708 blocks = user.info.blocks
709 domain_blocks = user.info.domain_blocks
710 %{host: host} = URI.parse(ap_id)
712 Enum.member?(blocks, ap_id) ||
713 Enum.any?(domain_blocks, fn domain ->
718 def blocked_users(user),
719 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
721 def block_domain(user, domain) do
724 |> User.Info.add_to_domain_block(domain)
728 |> put_embed(:info, info_cng)
730 update_and_set_cache(cng)
733 def unblock_domain(user, domain) do
736 |> User.Info.remove_from_domain_block(domain)
740 |> put_embed(:info, info_cng)
742 update_and_set_cache(cng)
745 def local_user_query() do
748 where: u.local == true,
749 where: not is_nil(u.nickname)
753 def moderator_user_query() do
756 where: u.local == true,
757 where: fragment("?->'is_moderator' @> 'true'", u.info)
761 def deactivate(%User{} = user, status \\ true) do
762 info_cng = User.Info.set_activation_status(user.info, status)
766 |> put_embed(:info, info_cng)
768 update_and_set_cache(cng)
771 def delete(%User{} = user) do
772 {:ok, user} = User.deactivate(user)
774 # Remove all relationships
775 {:ok, followers} = User.get_followers(user)
778 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
780 {:ok, friends} = User.get_friends(user)
783 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
785 query = from(a in Activity, where: a.actor == ^user.ap_id)
788 |> Enum.each(fn activity ->
789 case activity.data["type"] do
791 ActivityPub.delete(Object.normalize(activity.data["object"]))
793 # TODO: Do something with likes, follows, repeats.
802 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
803 Pleroma.HTML.Scrubber.TwitterText
806 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
808 def html_filter_policy(_), do: @default_scrubbers
810 def get_or_fetch_by_ap_id(ap_id) do
811 user = get_by_ap_id(ap_id)
813 if !is_nil(user) and !User.needs_update?(user) do
816 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
823 case OStatus.make_user(ap_id) do
825 _ -> {:error, "Could not fetch by AP id"}
831 def get_or_create_instance_user do
832 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
834 if user = get_by_ap_id(relay_uri) do
838 %User{info: %User.Info{}}
839 |> cast(%{}, [:ap_id, :nickname, :local])
840 |> put_change(:ap_id, relay_uri)
841 |> put_change(:nickname, nil)
842 |> put_change(:local, true)
843 |> put_change(:follower_address, relay_uri <> "/followers")
845 {:ok, user} = Repo.insert(changes)
851 def public_key_from_info(%{
852 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
856 |> :public_key.pem_decode()
858 |> :public_key.pem_entry_decode()
864 def public_key_from_info(%{magic_key: magic_key}) do
865 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
868 def get_public_key_for_ap_id(ap_id) do
869 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
870 {:ok, public_key} <- public_key_from_info(user.info) do
877 defp blank?(""), do: nil
878 defp blank?(n), do: n
880 def insert_or_update_user(data) do
883 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
885 cs = User.remote_user_creation(data)
887 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
890 def ap_enabled?(%User{local: true}), do: true
891 def ap_enabled?(%User{info: info}), do: info.ap_enabled
892 def ap_enabled?(_), do: false
894 @doc "Gets or fetch a user by uri or nickname."
895 @spec get_or_fetch(String.t()) :: User.t()
896 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
897 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
899 # wait a period of time and return newest version of the User structs
900 # this is because we have synchronous follow APIs and need to simulate them
901 # with an async handshake
902 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
903 with %User{} = a <- Repo.get(User, a.id),
904 %User{} = b <- Repo.get(User, b.id) do
912 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
913 with :ok <- :timer.sleep(timeout),
914 %User{} = a <- Repo.get(User, a.id),
915 %User{} = b <- Repo.get(User, b.id) do
923 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
924 def parse_bio(nil, _user), do: ""
925 def parse_bio(bio, _user) when bio == "", do: bio
927 def parse_bio(bio, user) do
928 mentions = Formatter.parse_mentions(bio)
929 tags = Formatter.parse_tags(bio)
932 (user.info.source_data["tag"] || [])
933 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
934 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
935 {String.trim(name, ":"), url}
939 |> CommonUtils.format_input(mentions, tags, "text/plain")
940 |> Formatter.emojify(emoji)
943 def tag(user_identifiers, tags) when is_list(user_identifiers) do
944 Repo.transaction(fn ->
945 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
949 def tag(nickname, tags) when is_binary(nickname),
950 do: tag(User.get_by_nickname(nickname), tags)
952 def tag(%User{} = user, tags),
953 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
955 def untag(user_identifiers, tags) when is_list(user_identifiers) do
956 Repo.transaction(fn ->
957 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
961 def untag(nickname, tags) when is_binary(nickname),
962 do: untag(User.get_by_nickname(nickname), tags)
964 def untag(%User{} = user, tags),
965 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
967 defp update_tags(%User{} = user, new_tags) do
968 {:ok, updated_user} =
970 |> change(%{tags: new_tags})
976 defp normalize_tags(tags) do
979 |> Enum.map(&String.downcase(&1))
982 defp local_nickname_regex() do
983 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
984 @extended_local_nickname_regex
986 @strict_local_nickname_regex