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}
16 @type t :: %__MODULE__{}
18 @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])?)*$/
20 @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
21 @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
25 field(:email, :string)
27 field(:nickname, :string)
28 field(:password_hash, :string)
29 field(:password, :string, virtual: true)
30 field(:password_confirmation, :string, virtual: true)
31 field(:following, {:array, :string}, default: [])
32 field(:ap_id, :string)
34 field(:local, :boolean, default: true)
35 field(:follower_address, :string)
36 field(:search_distance, :float, virtual: true)
37 field(:tags, {:array, :string}, default: [])
38 field(:last_refreshed_at, :naive_datetime)
39 has_many(:notifications, Notification)
40 embeds_one(:info, Pleroma.User.Info)
45 def auth_active?(%User{} = user) do
46 (user.info && !user.info.confirmation_pending) ||
47 !Pleroma.Config.get([:instance, :account_activation_required])
50 def superuser?(%User{} = user), do: user.info && User.Info.superuser?(user.info)
52 def avatar_url(user) do
54 %{"url" => [%{"href" => href} | _]} -> href
55 _ -> "#{Web.base_url()}/images/avi.png"
59 def banner_url(user) do
60 case user.info.banner do
61 %{"url" => [%{"href" => href} | _]} -> href
62 _ -> "#{Web.base_url()}/images/banner.png"
66 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
67 def profile_url(%User{ap_id: ap_id}), do: ap_id
68 def profile_url(_), do: nil
70 def ap_id(%User{nickname: nickname}) do
71 "#{Web.base_url()}/users/#{nickname}"
74 def ap_followers(%User{} = user) do
75 "#{ap_id(user)}/followers"
78 def follow_changeset(struct, params \\ %{}) do
80 |> cast(params, [:following])
81 |> validate_required([:following])
84 def user_info(%User{} = user) do
85 oneself = if user.local, do: 1, else: 0
88 following_count: length(user.following) - oneself,
89 note_count: user.info.note_count,
90 follower_count: user.info.follower_count,
91 locked: user.info.locked,
92 confirmation_pending: user.info.confirmation_pending,
93 default_scope: user.info.default_scope
97 def remote_user_creation(params) do
100 |> Map.put(:info, params[:info] || %{})
102 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
106 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
107 |> validate_required([:name, :ap_id])
108 |> unique_constraint(:nickname)
109 |> validate_format(:nickname, @email_regex)
110 |> validate_length(:bio, max: 5000)
111 |> validate_length(:name, max: 100)
112 |> put_change(:local, false)
113 |> put_embed(:info, info_cng)
116 case info_cng.changes[:source_data] do
117 %{"followers" => followers} ->
119 |> put_change(:follower_address, followers)
122 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
125 |> put_change(:follower_address, followers)
132 def update_changeset(struct, params \\ %{}) do
134 |> cast(params, [:bio, :name, :avatar])
135 |> unique_constraint(:nickname)
136 |> validate_format(:nickname, local_nickname_regex())
137 |> validate_length(:bio, max: 5000)
138 |> validate_length(:name, min: 1, max: 100)
141 def upgrade_changeset(struct, params \\ %{}) do
144 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
148 |> User.Info.user_upgrade(params[:info])
151 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
152 |> unique_constraint(:nickname)
153 |> validate_format(:nickname, local_nickname_regex())
154 |> validate_length(:bio, max: 5000)
155 |> validate_length(:name, max: 100)
156 |> put_embed(:info, info_cng)
159 def password_update_changeset(struct, params) do
162 |> cast(params, [:password, :password_confirmation])
163 |> validate_required([:password, :password_confirmation])
164 |> validate_confirmation(:password)
166 OAuth.Token.delete_user_tokens(struct)
167 OAuth.Authorization.delete_user_authorizations(struct)
169 if changeset.valid? do
170 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
173 |> put_change(:password_hash, hashed)
179 def reset_password(user, data) do
180 update_and_set_cache(password_update_changeset(user, data))
183 def register_changeset(struct, params \\ %{}, opts \\ []) do
184 confirmation_status =
185 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
191 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
195 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
196 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
197 |> validate_confirmation(:password)
198 |> unique_constraint(:email)
199 |> unique_constraint(:nickname)
200 |> validate_format(:nickname, local_nickname_regex())
201 |> validate_format(:email, @email_regex)
202 |> validate_length(:bio, max: 1000)
203 |> validate_length(:name, min: 1, max: 100)
204 |> put_change(:info, info_change)
206 if changeset.valid? do
207 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
208 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
209 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
212 |> put_change(:password_hash, hashed)
213 |> put_change(:ap_id, ap_id)
214 |> put_change(:following, [followers])
215 |> put_change(:follower_address, followers)
221 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
222 def register(%Ecto.Changeset{} = changeset) do
223 with {:ok, user} <- Repo.insert(changeset),
224 {:ok, _} = try_send_confirmation_email(user) do
229 def try_send_confirmation_email(%User{} = user) do
230 if user.info.confirmation_pending &&
231 Pleroma.Config.get([:instance, :account_activation_required]) do
233 |> Pleroma.UserEmail.account_confirmation_email()
234 |> Pleroma.Mailer.deliver()
240 def needs_update?(%User{local: true}), do: false
242 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
244 def needs_update?(%User{local: false} = user) do
245 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
248 def needs_update?(_), do: true
250 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
254 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
255 follow(follower, followed)
258 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
259 if not User.ap_enabled?(followed) do
260 follow(follower, followed)
266 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
267 if not following?(follower, followed) do
268 follow(follower, followed)
274 def follow(%User{} = follower, %User{info: info} = followed) do
275 user_config = Application.get_env(:pleroma, :user)
276 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
278 ap_followers = followed.follower_address
281 following?(follower, followed) or info.deactivated ->
282 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
284 deny_follow_blocked and blocks?(followed, follower) ->
285 {:error, "Could not follow user: #{followed.nickname} blocked you."}
288 if !followed.local && follower.local && !ap_enabled?(followed) do
289 Websub.subscribe(follower, followed)
293 [ap_followers | follower.following]
298 |> follow_changeset(%{following: following})
299 |> update_and_set_cache
301 {:ok, _} = update_follower_count(followed)
307 def unfollow(%User{} = follower, %User{} = followed) do
308 ap_followers = followed.follower_address
310 if following?(follower, followed) and follower.ap_id != followed.ap_id do
313 |> List.delete(ap_followers)
317 |> follow_changeset(%{following: following})
318 |> update_and_set_cache
320 {:ok, followed} = update_follower_count(followed)
322 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
324 {:error, "Not subscribed!"}
328 @spec following?(User.t(), User.t()) :: boolean
329 def following?(%User{} = follower, %User{} = followed) do
330 Enum.member?(follower.following, followed.follower_address)
333 def locked?(%User{} = user) do
334 user.info.locked || false
337 def get_by_ap_id(ap_id) do
338 Repo.get_by(User, ap_id: ap_id)
341 def update_and_set_cache(changeset) do
342 with {:ok, user} <- Repo.update(changeset) do
343 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
344 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
345 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
352 def invalidate_cache(user) do
353 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
354 Cachex.del(:user_cache, "nickname:#{user.nickname}")
355 Cachex.del(:user_cache, "user_info:#{user.id}")
358 def get_cached_by_ap_id(ap_id) do
359 key = "ap_id:#{ap_id}"
360 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
363 def get_cached_by_nickname(nickname) do
364 key = "nickname:#{nickname}"
365 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
368 def get_by_nickname(nickname) do
369 Repo.get_by(User, nickname: nickname)
372 def get_by_nickname_or_email(nickname_or_email) do
373 case user = Repo.get_by(User, nickname: nickname_or_email) do
375 nil -> Repo.get_by(User, email: nickname_or_email)
379 def get_cached_user_info(user) do
380 key = "user_info:#{user.id}"
381 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
384 def fetch_by_nickname(nickname) do
385 ap_try = ActivityPub.make_user_from_nickname(nickname)
388 {:ok, user} -> {:ok, user}
389 _ -> OStatus.make_user(nickname)
393 def get_or_fetch_by_nickname(nickname) do
394 with %User{} = user <- get_by_nickname(nickname) do
398 with [_nick, _domain] <- String.split(nickname, "@"),
399 {:ok, user} <- fetch_by_nickname(nickname) do
407 def get_followers_query(%User{id: id, follower_address: follower_address}) do
410 where: fragment("? <@ ?", ^[follower_address], u.following),
415 def get_followers(user) do
416 q = get_followers_query(user)
421 def get_friends_query(%User{id: id, following: following}) do
424 where: u.follower_address in ^following,
429 def get_friends(user) do
430 q = get_friends_query(user)
435 def get_follow_requests_query(%User{} = user) do
440 "? ->> 'type' = 'Follow'",
445 "? ->> 'state' = 'pending'",
452 ^%{"object" => user.ap_id}
457 def get_follow_requests(%User{} = user) do
458 q = get_follow_requests_query(user)
462 Enum.map(reqs, fn req -> req.actor end)
464 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
465 |> Enum.filter(fn u -> !following?(u, user) end)
470 def increase_note_count(%User{} = user) do
471 info_cng = User.Info.add_to_note_count(user.info, 1)
475 |> put_embed(:info, info_cng)
477 update_and_set_cache(cng)
480 def decrease_note_count(%User{} = user) do
481 info_cng = User.Info.add_to_note_count(user.info, -1)
485 |> put_embed(:info, info_cng)
487 update_and_set_cache(cng)
490 def update_note_count(%User{} = user) do
494 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
498 note_count = Repo.one(note_count_query)
500 info_cng = User.Info.set_note_count(user.info, note_count)
504 |> put_embed(:info, info_cng)
506 update_and_set_cache(cng)
509 def update_follower_count(%User{} = user) do
510 follower_count_query =
513 where: ^user.follower_address in u.following,
514 where: u.id != ^user.id,
518 follower_count = Repo.one(follower_count_query)
522 |> User.Info.set_follower_count(follower_count)
526 |> put_embed(:info, info_cng)
528 update_and_set_cache(cng)
531 def get_users_from_set_query(ap_ids, false) do
534 where: u.ap_id in ^ap_ids
538 def get_users_from_set_query(ap_ids, true) do
539 query = get_users_from_set_query(ap_ids, false)
543 where: u.local == true
547 def get_users_from_set(ap_ids, local_only \\ true) do
548 get_users_from_set_query(ap_ids, local_only)
552 def get_recipients_from_activity(%Activity{recipients: to}) do
556 where: u.ap_id in ^to,
557 or_where: fragment("? && ?", u.following, ^to)
560 query = from(u in query, where: u.local == true)
565 def search(query, resolve \\ false) do
566 # strip the beginning @ off if there is a query
567 query = String.trim_leading(query, "@")
570 User.get_or_fetch_by_nickname(query)
585 where: not is_nil(u.nickname)
590 s in subquery(inner),
591 order_by: s.search_distance,
598 def block(blocker, %User{ap_id: ap_id} = blocked) do
599 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
601 if following?(blocker, blocked) do
602 {:ok, blocker, _} = unfollow(blocker, blocked)
608 if following?(blocked, blocker) do
609 unfollow(blocked, blocker)
614 |> User.Info.add_to_block(ap_id)
618 |> put_embed(:info, info_cng)
620 update_and_set_cache(cng)
623 # helper to handle the block given only an actor's AP id
624 def block(blocker, %{ap_id: ap_id}) do
625 block(blocker, User.get_by_ap_id(ap_id))
628 def unblock(blocker, %{ap_id: ap_id}) do
631 |> User.Info.remove_from_block(ap_id)
635 |> put_embed(:info, info_cng)
637 update_and_set_cache(cng)
640 def blocks?(user, %{ap_id: ap_id}) do
641 blocks = user.info.blocks
642 domain_blocks = user.info.domain_blocks
643 %{host: host} = URI.parse(ap_id)
645 Enum.member?(blocks, ap_id) ||
646 Enum.any?(domain_blocks, fn domain ->
651 def block_domain(user, domain) do
654 |> User.Info.add_to_domain_block(domain)
658 |> put_embed(:info, info_cng)
660 update_and_set_cache(cng)
663 def unblock_domain(user, domain) do
666 |> User.Info.remove_from_domain_block(domain)
670 |> put_embed(:info, info_cng)
672 update_and_set_cache(cng)
675 def local_user_query() do
678 where: u.local == true,
679 where: not is_nil(u.nickname)
683 def moderator_user_query() do
686 where: u.local == true,
687 where: fragment("?->'is_moderator' @> 'true'", u.info)
691 def deactivate(%User{} = user, status \\ true) do
692 info_cng = User.Info.set_activation_status(user.info, status)
696 |> put_embed(:info, info_cng)
698 update_and_set_cache(cng)
701 def delete(%User{} = user) do
702 {:ok, user} = User.deactivate(user)
704 # Remove all relationships
705 {:ok, followers} = User.get_followers(user)
708 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
710 {:ok, friends} = User.get_friends(user)
713 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
715 query = from(a in Activity, where: a.actor == ^user.ap_id)
718 |> Enum.each(fn activity ->
719 case activity.data["type"] do
721 ActivityPub.delete(Object.normalize(activity.data["object"]))
723 # TODO: Do something with likes, follows, repeats.
732 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
733 Pleroma.HTML.Scrubber.TwitterText
736 @default_scrubbers Pleroma.Config.get([:markup, :scrub_policy])
738 def html_filter_policy(_), do: @default_scrubbers
740 def get_or_fetch_by_ap_id(ap_id) do
741 user = get_by_ap_id(ap_id)
743 if !is_nil(user) and !User.needs_update?(user) do
746 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
753 case OStatus.make_user(ap_id) do
755 _ -> {:error, "Could not fetch by AP id"}
761 def get_or_create_instance_user do
762 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
764 if user = get_by_ap_id(relay_uri) do
768 %User{info: %User.Info{}}
769 |> cast(%{}, [:ap_id, :nickname, :local])
770 |> put_change(:ap_id, relay_uri)
771 |> put_change(:nickname, nil)
772 |> put_change(:local, true)
773 |> put_change(:follower_address, relay_uri <> "/followers")
775 {:ok, user} = Repo.insert(changes)
781 def public_key_from_info(%{
782 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
786 |> :public_key.pem_decode()
788 |> :public_key.pem_entry_decode()
794 def public_key_from_info(%{magic_key: magic_key}) do
795 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
798 def get_public_key_for_ap_id(ap_id) do
799 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
800 {:ok, public_key} <- public_key_from_info(user.info) do
807 defp blank?(""), do: nil
808 defp blank?(n), do: n
810 def insert_or_update_user(data) do
813 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
815 cs = User.remote_user_creation(data)
817 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
820 def ap_enabled?(%User{local: true}), do: true
821 def ap_enabled?(%User{info: info}), do: info.ap_enabled
822 def ap_enabled?(_), do: false
824 @doc "Gets or fetch a user by uri or nickname."
825 @spec get_or_fetch(String.t()) :: User.t()
826 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
827 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
829 # wait a period of time and return newest version of the User structs
830 # this is because we have synchronous follow APIs and need to simulate them
831 # with an async handshake
832 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
833 with %User{} = a <- Repo.get(User, a.id),
834 %User{} = b <- Repo.get(User, b.id) do
842 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
843 with :ok <- :timer.sleep(timeout),
844 %User{} = a <- Repo.get(User, a.id),
845 %User{} = b <- Repo.get(User, b.id) do
853 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
854 def parse_bio(nil, _user), do: ""
855 def parse_bio(bio, _user) when bio == "", do: bio
857 def parse_bio(bio, user) do
858 mentions = Formatter.parse_mentions(bio)
859 tags = Formatter.parse_tags(bio)
862 (user.info.source_data["tag"] || [])
863 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
864 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
865 {String.trim(name, ":"), url}
869 |> CommonUtils.format_input(mentions, tags, "text/plain")
870 |> Formatter.emojify(emoji)
873 def tag(user_identifiers, tags) when is_list(user_identifiers) do
874 Repo.transaction(fn ->
875 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
879 def tag(nickname, tags) when is_binary(nickname),
880 do: tag(User.get_by_nickname(nickname), tags)
882 def tag(%User{} = user, tags),
883 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
885 def untag(user_identifiers, tags) when is_list(user_identifiers) do
886 Repo.transaction(fn ->
887 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
891 def untag(nickname, tags) when is_binary(nickname),
892 do: untag(User.get_by_nickname(nickname), tags)
894 def untag(%User{} = user, tags),
895 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
897 defp update_tags(%User{} = user, new_tags) do
898 {:ok, updated_user} =
900 |> change(%{tags: new_tags})
906 defp normalize_tags(tags) do
909 |> Enum.map(&String.downcase(&1))
912 defp local_nickname_regex() do
913 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
914 @extended_local_nickname_regex
916 @strict_local_nickname_regex