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{} = user), do: !user.local || auth_active?(user)
54 def visible_for?(%User{} = user, for_user \\ nil) do
55 User.remote_or_auth_active?(user) || (for_user && for_user.id == user.id) ||
56 User.superuser?(for_user)
59 def superuser?(nil), do: false
60 def superuser?(%User{} = user), do: user.info && User.Info.superuser?(user.info)
62 def avatar_url(user) do
64 %{"url" => [%{"href" => href} | _]} -> href
65 _ -> "#{Web.base_url()}/images/avi.png"
69 def banner_url(user) do
70 case user.info.banner do
71 %{"url" => [%{"href" => href} | _]} -> href
72 _ -> "#{Web.base_url()}/images/banner.png"
76 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
77 def profile_url(%User{ap_id: ap_id}), do: ap_id
78 def profile_url(_), do: nil
80 def ap_id(%User{nickname: nickname}) do
81 "#{Web.base_url()}/users/#{nickname}"
84 def ap_followers(%User{} = user) do
85 "#{ap_id(user)}/followers"
88 def follow_changeset(struct, params \\ %{}) do
90 |> cast(params, [:following])
91 |> validate_required([:following])
94 def user_info(%User{} = user) do
95 oneself = if user.local, do: 1, else: 0
98 following_count: length(user.following) - oneself,
99 note_count: user.info.note_count,
100 follower_count: user.info.follower_count,
101 locked: user.info.locked,
102 confirmation_pending: user.info.confirmation_pending,
103 default_scope: user.info.default_scope
107 def remote_user_creation(params) do
110 |> Map.put(:info, params[:info] || %{})
112 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
116 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
117 |> validate_required([:name, :ap_id])
118 |> unique_constraint(:nickname)
119 |> validate_format(:nickname, @email_regex)
120 |> validate_length(:bio, max: 5000)
121 |> validate_length(:name, max: 100)
122 |> put_change(:local, false)
123 |> put_embed(:info, info_cng)
126 case info_cng.changes[:source_data] do
127 %{"followers" => followers} ->
129 |> put_change(:follower_address, followers)
132 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
135 |> put_change(:follower_address, followers)
142 def update_changeset(struct, params \\ %{}) do
144 |> cast(params, [:bio, :name, :avatar])
145 |> unique_constraint(:nickname)
146 |> validate_format(:nickname, local_nickname_regex())
147 |> validate_length(:bio, max: 5000)
148 |> validate_length(:name, min: 1, max: 100)
151 def upgrade_changeset(struct, params \\ %{}) do
154 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
158 |> User.Info.user_upgrade(params[:info])
161 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
162 |> unique_constraint(:nickname)
163 |> validate_format(:nickname, local_nickname_regex())
164 |> validate_length(:bio, max: 5000)
165 |> validate_length(:name, max: 100)
166 |> put_embed(:info, info_cng)
169 def password_update_changeset(struct, params) do
172 |> cast(params, [:password, :password_confirmation])
173 |> validate_required([:password, :password_confirmation])
174 |> validate_confirmation(:password)
176 OAuth.Token.delete_user_tokens(struct)
177 OAuth.Authorization.delete_user_authorizations(struct)
179 if changeset.valid? do
180 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
183 |> put_change(:password_hash, hashed)
189 def reset_password(user, data) do
190 update_and_set_cache(password_update_changeset(user, data))
193 def register_changeset(struct, params \\ %{}, opts \\ []) do
194 confirmation_status =
195 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
201 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
205 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
206 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
207 |> validate_confirmation(:password)
208 |> unique_constraint(:email)
209 |> unique_constraint(:nickname)
210 |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
211 |> validate_format(:nickname, local_nickname_regex())
212 |> validate_format(:email, @email_regex)
213 |> validate_length(:bio, max: 1000)
214 |> validate_length(:name, min: 1, max: 100)
215 |> put_change(:info, info_change)
217 if changeset.valid? do
218 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
219 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
220 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
223 |> put_change(:password_hash, hashed)
224 |> put_change(:ap_id, ap_id)
225 |> put_change(:following, [followers])
226 |> put_change(:follower_address, followers)
232 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
233 def register(%Ecto.Changeset{} = changeset) do
234 with {:ok, user} <- Repo.insert(changeset),
235 {:ok, _} = try_send_confirmation_email(user) do
240 def try_send_confirmation_email(%User{} = user) do
241 if user.info.confirmation_pending &&
242 Pleroma.Config.get([:instance, :account_activation_required]) do
244 |> Pleroma.UserEmail.account_confirmation_email()
245 |> Pleroma.Mailer.deliver()
251 def needs_update?(%User{local: true}), do: false
253 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
255 def needs_update?(%User{local: false} = user) do
256 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
259 def needs_update?(_), do: true
261 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
265 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
266 follow(follower, followed)
269 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
270 if not User.ap_enabled?(followed) do
271 follow(follower, followed)
277 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
278 if not following?(follower, followed) do
279 follow(follower, followed)
285 def follow(%User{} = follower, %User{info: info} = followed) do
286 user_config = Application.get_env(:pleroma, :user)
287 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
289 ap_followers = followed.follower_address
292 following?(follower, followed) or info.deactivated ->
293 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
295 deny_follow_blocked and blocks?(followed, follower) ->
296 {:error, "Could not follow user: #{followed.nickname} blocked you."}
299 if !followed.local && follower.local && !ap_enabled?(followed) do
300 Websub.subscribe(follower, followed)
304 [ap_followers | follower.following]
309 |> follow_changeset(%{following: following})
310 |> update_and_set_cache
312 {:ok, _} = update_follower_count(followed)
318 def unfollow(%User{} = follower, %User{} = followed) do
319 ap_followers = followed.follower_address
321 if following?(follower, followed) and follower.ap_id != followed.ap_id do
324 |> List.delete(ap_followers)
328 |> follow_changeset(%{following: following})
329 |> update_and_set_cache
331 {:ok, followed} = update_follower_count(followed)
333 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
335 {:error, "Not subscribed!"}
339 @spec following?(User.t(), User.t()) :: boolean
340 def following?(%User{} = follower, %User{} = followed) do
341 Enum.member?(follower.following, followed.follower_address)
344 def follow_import(%User{} = follower, followed_identifiers)
345 when is_list(followed_identifiers) do
347 followed_identifiers,
348 fn followed_identifier ->
349 with %User{} = followed <- get_or_fetch(followed_identifier),
350 {:ok, follower} <- maybe_direct_follow(follower, followed),
351 {:ok, _} <- ActivityPub.follow(follower, followed) do
355 Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
362 def locked?(%User{} = user) do
363 user.info.locked || false
366 def get_by_ap_id(ap_id) do
367 Repo.get_by(User, ap_id: ap_id)
370 def update_and_set_cache(changeset) do
371 with {:ok, user} <- Repo.update(changeset) do
372 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
373 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
374 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
381 def invalidate_cache(user) do
382 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
383 Cachex.del(:user_cache, "nickname:#{user.nickname}")
384 Cachex.del(:user_cache, "user_info:#{user.id}")
387 def get_cached_by_ap_id(ap_id) do
388 key = "ap_id:#{ap_id}"
389 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
392 def get_cached_by_nickname(nickname) do
393 key = "nickname:#{nickname}"
394 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
397 def get_by_nickname(nickname) do
398 Repo.get_by(User, nickname: nickname) ||
399 if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
400 [local_nickname, _] = String.split(nickname, "@")
401 Repo.get_by(User, nickname: local_nickname)
405 def get_by_nickname_or_email(nickname_or_email) do
406 case user = Repo.get_by(User, nickname: nickname_or_email) do
408 nil -> Repo.get_by(User, email: nickname_or_email)
412 def get_cached_user_info(user) do
413 key = "user_info:#{user.id}"
414 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
417 def fetch_by_nickname(nickname) do
418 ap_try = ActivityPub.make_user_from_nickname(nickname)
421 {:ok, user} -> {:ok, user}
422 _ -> OStatus.make_user(nickname)
426 def get_or_fetch_by_nickname(nickname) do
427 with %User{} = user <- get_by_nickname(nickname) do
431 with [_nick, _domain] <- String.split(nickname, "@"),
432 {:ok, user} <- fetch_by_nickname(nickname) do
440 def get_followers_query(%User{id: id, follower_address: follower_address}) do
443 where: fragment("? <@ ?", ^[follower_address], u.following),
448 def get_followers(user) do
449 q = get_followers_query(user)
454 def get_friends_query(%User{id: id, following: following}) do
457 where: u.follower_address in ^following,
462 def get_friends(user) do
463 q = get_friends_query(user)
468 def get_follow_requests_query(%User{} = user) do
473 "? ->> 'type' = 'Follow'",
478 "? ->> 'state' = 'pending'",
485 ^%{"object" => user.ap_id}
490 def get_follow_requests(%User{} = user) do
491 q = get_follow_requests_query(user)
495 Enum.map(reqs, fn req -> req.actor end)
497 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
498 |> Enum.filter(fn u -> !is_nil(u) end)
499 |> Enum.filter(fn u -> !following?(u, user) end)
504 def increase_note_count(%User{} = user) do
505 info_cng = User.Info.add_to_note_count(user.info, 1)
509 |> put_embed(:info, info_cng)
511 update_and_set_cache(cng)
514 def decrease_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 update_note_count(%User{} = user) do
528 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
532 note_count = Repo.one(note_count_query)
534 info_cng = User.Info.set_note_count(user.info, note_count)
538 |> put_embed(:info, info_cng)
540 update_and_set_cache(cng)
543 def update_follower_count(%User{} = user) do
544 follower_count_query =
547 where: ^user.follower_address in u.following,
548 where: u.id != ^user.id,
552 follower_count = Repo.one(follower_count_query)
556 |> User.Info.set_follower_count(follower_count)
560 |> put_embed(:info, info_cng)
562 update_and_set_cache(cng)
565 def get_users_from_set_query(ap_ids, false) do
568 where: u.ap_id in ^ap_ids
572 def get_users_from_set_query(ap_ids, true) do
573 query = get_users_from_set_query(ap_ids, false)
577 where: u.local == true
581 def get_users_from_set(ap_ids, local_only \\ true) do
582 get_users_from_set_query(ap_ids, local_only)
586 def get_recipients_from_activity(%Activity{recipients: to}) do
590 where: u.ap_id in ^to,
591 or_where: fragment("? && ?", u.following, ^to)
594 query = from(u in query, where: u.local == true)
599 def search(query, resolve \\ false) do
600 # strip the beginning @ off if there is a query
601 query = String.trim_leading(query, "@")
604 User.get_or_fetch_by_nickname(query)
619 where: not is_nil(u.nickname)
624 s in subquery(inner),
625 order_by: s.search_distance,
632 def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
635 fn blocked_identifier ->
636 with %User{} = blocked <- get_or_fetch(blocked_identifier),
637 {:ok, blocker} <- block(blocker, blocked),
638 {:ok, _} <- ActivityPub.block(blocker, blocked) do
642 Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
649 def block(blocker, %User{ap_id: ap_id} = blocked) do
650 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
652 if following?(blocker, blocked) do
653 {:ok, blocker, _} = unfollow(blocker, blocked)
659 if following?(blocked, blocker) do
660 unfollow(blocked, blocker)
665 |> User.Info.add_to_block(ap_id)
669 |> put_embed(:info, info_cng)
671 update_and_set_cache(cng)
674 # helper to handle the block given only an actor's AP id
675 def block(blocker, %{ap_id: ap_id}) do
676 block(blocker, User.get_by_ap_id(ap_id))
679 def unblock(blocker, %{ap_id: ap_id}) do
682 |> User.Info.remove_from_block(ap_id)
686 |> put_embed(:info, info_cng)
688 update_and_set_cache(cng)
691 def blocks?(user, %{ap_id: ap_id}) do
692 blocks = user.info.blocks
693 domain_blocks = user.info.domain_blocks
694 %{host: host} = URI.parse(ap_id)
696 Enum.member?(blocks, ap_id) ||
697 Enum.any?(domain_blocks, fn domain ->
702 def blocked_users(user),
703 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
705 def block_domain(user, domain) do
708 |> User.Info.add_to_domain_block(domain)
712 |> put_embed(:info, info_cng)
714 update_and_set_cache(cng)
717 def unblock_domain(user, domain) do
720 |> User.Info.remove_from_domain_block(domain)
724 |> put_embed(:info, info_cng)
726 update_and_set_cache(cng)
729 def local_user_query() do
732 where: u.local == true,
733 where: not is_nil(u.nickname)
737 def moderator_user_query() do
740 where: u.local == true,
741 where: fragment("?->'is_moderator' @> 'true'", u.info)
745 def deactivate(%User{} = user, status \\ true) do
746 info_cng = User.Info.set_activation_status(user.info, status)
750 |> put_embed(:info, info_cng)
752 update_and_set_cache(cng)
755 def delete(%User{} = user) do
756 {:ok, user} = User.deactivate(user)
758 # Remove all relationships
759 {:ok, followers} = User.get_followers(user)
762 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
764 {:ok, friends} = User.get_friends(user)
767 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
769 query = from(a in Activity, where: a.actor == ^user.ap_id)
772 |> Enum.each(fn activity ->
773 case activity.data["type"] do
775 ActivityPub.delete(Object.normalize(activity.data["object"]))
777 # TODO: Do something with likes, follows, repeats.
786 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
787 Pleroma.HTML.Scrubber.TwitterText
790 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
792 def html_filter_policy(_), do: @default_scrubbers
794 def get_or_fetch_by_ap_id(ap_id) do
795 user = get_by_ap_id(ap_id)
797 if !is_nil(user) and !User.needs_update?(user) do
800 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
807 case OStatus.make_user(ap_id) do
809 _ -> {:error, "Could not fetch by AP id"}
815 def get_or_create_instance_user do
816 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
818 if user = get_by_ap_id(relay_uri) do
822 %User{info: %User.Info{}}
823 |> cast(%{}, [:ap_id, :nickname, :local])
824 |> put_change(:ap_id, relay_uri)
825 |> put_change(:nickname, nil)
826 |> put_change(:local, true)
827 |> put_change(:follower_address, relay_uri <> "/followers")
829 {:ok, user} = Repo.insert(changes)
835 def public_key_from_info(%{
836 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
840 |> :public_key.pem_decode()
842 |> :public_key.pem_entry_decode()
848 def public_key_from_info(%{magic_key: magic_key}) do
849 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
852 def get_public_key_for_ap_id(ap_id) do
853 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
854 {:ok, public_key} <- public_key_from_info(user.info) do
861 defp blank?(""), do: nil
862 defp blank?(n), do: n
864 def insert_or_update_user(data) do
867 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
869 cs = User.remote_user_creation(data)
871 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
874 def ap_enabled?(%User{local: true}), do: true
875 def ap_enabled?(%User{info: info}), do: info.ap_enabled
876 def ap_enabled?(_), do: false
878 @doc "Gets or fetch a user by uri or nickname."
879 @spec get_or_fetch(String.t()) :: User.t()
880 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
881 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
883 # wait a period of time and return newest version of the User structs
884 # this is because we have synchronous follow APIs and need to simulate them
885 # with an async handshake
886 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
887 with %User{} = a <- Repo.get(User, a.id),
888 %User{} = b <- Repo.get(User, b.id) do
896 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
897 with :ok <- :timer.sleep(timeout),
898 %User{} = a <- Repo.get(User, a.id),
899 %User{} = b <- Repo.get(User, b.id) do
907 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
908 def parse_bio(nil, _user), do: ""
909 def parse_bio(bio, _user) when bio == "", do: bio
911 def parse_bio(bio, user) do
912 mentions = Formatter.parse_mentions(bio)
913 tags = Formatter.parse_tags(bio)
916 (user.info.source_data["tag"] || [])
917 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
918 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
919 {String.trim(name, ":"), url}
923 |> CommonUtils.format_input(mentions, tags, "text/plain")
924 |> Formatter.emojify(emoji)
927 def tag(user_identifiers, tags) when is_list(user_identifiers) do
928 Repo.transaction(fn ->
929 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
933 def tag(nickname, tags) when is_binary(nickname),
934 do: tag(User.get_by_nickname(nickname), tags)
936 def tag(%User{} = user, tags),
937 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
939 def untag(user_identifiers, tags) when is_list(user_identifiers) do
940 Repo.transaction(fn ->
941 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
945 def untag(nickname, tags) when is_binary(nickname),
946 do: untag(User.get_by_nickname(nickname), tags)
948 def untag(%User{} = user, tags),
949 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
951 defp update_tags(%User{} = user, new_tags) do
952 {:ok, updated_user} =
954 |> change(%{tags: new_tags})
960 defp normalize_tags(tags) do
963 |> Enum.map(&String.downcase(&1))
966 defp local_nickname_regex() do
967 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
968 @extended_local_nickname_regex
970 @strict_local_nickname_regex