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 remote_or_auth_active?(%User{} = user), do: !user.local || auth_active?(user)
52 def visible_for?(%User{} = user, for_user \\ nil) do
53 User.remote_or_auth_active?(user) || (for_user && for_user.id == user.id) ||
54 User.superuser?(for_user)
57 def superuser?(nil), do: false
58 def superuser?(%User{} = user), do: user.info && User.Info.superuser?(user.info)
60 def avatar_url(user) do
62 %{"url" => [%{"href" => href} | _]} -> href
63 _ -> "#{Web.base_url()}/images/avi.png"
67 def banner_url(user) do
68 case user.info.banner do
69 %{"url" => [%{"href" => href} | _]} -> href
70 _ -> "#{Web.base_url()}/images/banner.png"
74 def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
75 def profile_url(%User{ap_id: ap_id}), do: ap_id
76 def profile_url(_), do: nil
78 def ap_id(%User{nickname: nickname}) do
79 "#{Web.base_url()}/users/#{nickname}"
82 def ap_followers(%User{} = user) do
83 "#{ap_id(user)}/followers"
86 def follow_changeset(struct, params \\ %{}) do
88 |> cast(params, [:following])
89 |> validate_required([:following])
92 def user_info(%User{} = user) do
93 oneself = if user.local, do: 1, else: 0
96 following_count: length(user.following) - oneself,
97 note_count: user.info.note_count,
98 follower_count: user.info.follower_count,
99 locked: user.info.locked,
100 confirmation_pending: user.info.confirmation_pending,
101 default_scope: user.info.default_scope
105 def remote_user_creation(params) do
108 |> Map.put(:info, params[:info] || %{})
110 info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])
114 |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
115 |> validate_required([:name, :ap_id])
116 |> unique_constraint(:nickname)
117 |> validate_format(:nickname, @email_regex)
118 |> validate_length(:bio, max: 5000)
119 |> validate_length(:name, max: 100)
120 |> put_change(:local, false)
121 |> put_embed(:info, info_cng)
124 case info_cng.changes[:source_data] do
125 %{"followers" => followers} ->
127 |> put_change(:follower_address, followers)
130 followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
133 |> put_change(:follower_address, followers)
140 def update_changeset(struct, params \\ %{}) do
142 |> cast(params, [:bio, :name, :avatar])
143 |> unique_constraint(:nickname)
144 |> validate_format(:nickname, local_nickname_regex())
145 |> validate_length(:bio, max: 5000)
146 |> validate_length(:name, min: 1, max: 100)
149 def upgrade_changeset(struct, params \\ %{}) do
152 |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())
156 |> User.Info.user_upgrade(params[:info])
159 |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
160 |> unique_constraint(:nickname)
161 |> validate_format(:nickname, local_nickname_regex())
162 |> validate_length(:bio, max: 5000)
163 |> validate_length(:name, max: 100)
164 |> put_embed(:info, info_cng)
167 def password_update_changeset(struct, params) do
170 |> cast(params, [:password, :password_confirmation])
171 |> validate_required([:password, :password_confirmation])
172 |> validate_confirmation(:password)
174 OAuth.Token.delete_user_tokens(struct)
175 OAuth.Authorization.delete_user_authorizations(struct)
177 if changeset.valid? do
178 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
181 |> put_change(:password_hash, hashed)
187 def reset_password(user, data) do
188 update_and_set_cache(password_update_changeset(user, data))
191 def register_changeset(struct, params \\ %{}, opts \\ []) do
192 confirmation_status =
193 if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
199 info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)
203 |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
204 |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
205 |> validate_confirmation(:password)
206 |> unique_constraint(:email)
207 |> unique_constraint(:nickname)
208 |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
209 |> validate_format(:nickname, local_nickname_regex())
210 |> validate_format(:email, @email_regex)
211 |> validate_length(:bio, max: 1000)
212 |> validate_length(:name, min: 1, max: 100)
213 |> put_change(:info, info_change)
215 if changeset.valid? do
216 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
217 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
218 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
221 |> put_change(:password_hash, hashed)
222 |> put_change(:ap_id, ap_id)
223 |> put_change(:following, [followers])
224 |> put_change(:follower_address, followers)
230 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
231 def register(%Ecto.Changeset{} = changeset) do
232 with {:ok, user} <- Repo.insert(changeset),
233 {:ok, _} = try_send_confirmation_email(user) do
238 def try_send_confirmation_email(%User{} = user) do
239 if user.info.confirmation_pending &&
240 Pleroma.Config.get([:instance, :account_activation_required]) do
242 |> Pleroma.UserEmail.account_confirmation_email()
243 |> Pleroma.Mailer.deliver()
249 def needs_update?(%User{local: true}), do: false
251 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
253 def needs_update?(%User{local: false} = user) do
254 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
257 def needs_update?(_), do: true
259 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
263 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
264 follow(follower, followed)
267 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
268 if not User.ap_enabled?(followed) do
269 follow(follower, followed)
275 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
276 if not following?(follower, followed) do
277 follow(follower, followed)
283 def follow(%User{} = follower, %User{info: info} = followed) do
284 user_config = Application.get_env(:pleroma, :user)
285 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
287 ap_followers = followed.follower_address
290 following?(follower, followed) or info.deactivated ->
291 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
293 deny_follow_blocked and blocks?(followed, follower) ->
294 {:error, "Could not follow user: #{followed.nickname} blocked you."}
297 if !followed.local && follower.local && !ap_enabled?(followed) do
298 Websub.subscribe(follower, followed)
302 [ap_followers | follower.following]
307 |> follow_changeset(%{following: following})
308 |> update_and_set_cache
310 {:ok, _} = update_follower_count(followed)
316 def unfollow(%User{} = follower, %User{} = followed) do
317 ap_followers = followed.follower_address
319 if following?(follower, followed) and follower.ap_id != followed.ap_id do
322 |> List.delete(ap_followers)
326 |> follow_changeset(%{following: following})
327 |> update_and_set_cache
329 {:ok, followed} = update_follower_count(followed)
331 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
333 {:error, "Not subscribed!"}
337 @spec following?(User.t(), User.t()) :: boolean
338 def following?(%User{} = follower, %User{} = followed) do
339 Enum.member?(follower.following, followed.follower_address)
342 def locked?(%User{} = user) do
343 user.info.locked || false
346 def get_by_ap_id(ap_id) do
347 Repo.get_by(User, ap_id: ap_id)
350 def update_and_set_cache(changeset) do
351 with {:ok, user} <- Repo.update(changeset) do
352 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
353 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
354 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
361 def invalidate_cache(user) do
362 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
363 Cachex.del(:user_cache, "nickname:#{user.nickname}")
364 Cachex.del(:user_cache, "user_info:#{user.id}")
367 def get_cached_by_ap_id(ap_id) do
368 key = "ap_id:#{ap_id}"
369 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
372 def get_cached_by_nickname(nickname) do
373 key = "nickname:#{nickname}"
374 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
377 def get_by_nickname(nickname) do
378 Repo.get_by(User, nickname: nickname)
381 def get_by_nickname_or_email(nickname_or_email) do
382 case user = Repo.get_by(User, nickname: nickname_or_email) do
384 nil -> Repo.get_by(User, email: nickname_or_email)
388 def get_cached_user_info(user) do
389 key = "user_info:#{user.id}"
390 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
393 def fetch_by_nickname(nickname) do
394 ap_try = ActivityPub.make_user_from_nickname(nickname)
397 {:ok, user} -> {:ok, user}
398 _ -> OStatus.make_user(nickname)
402 def get_or_fetch_by_nickname(nickname) do
403 with %User{} = user <- get_by_nickname(nickname) do
407 with [_nick, _domain] <- String.split(nickname, "@"),
408 {:ok, user} <- fetch_by_nickname(nickname) do
416 def get_followers_query(%User{id: id, follower_address: follower_address}) do
419 where: fragment("? <@ ?", ^[follower_address], u.following),
424 def get_followers(user) do
425 q = get_followers_query(user)
430 def get_friends_query(%User{id: id, following: following}) do
433 where: u.follower_address in ^following,
438 def get_friends(user) do
439 q = get_friends_query(user)
444 def get_follow_requests_query(%User{} = user) do
449 "? ->> 'type' = 'Follow'",
454 "? ->> 'state' = 'pending'",
461 ^%{"object" => user.ap_id}
466 def get_follow_requests(%User{} = user) do
467 q = get_follow_requests_query(user)
471 Enum.map(reqs, fn req -> req.actor end)
473 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
474 |> Enum.filter(fn u -> !following?(u, user) end)
479 def increase_note_count(%User{} = user) do
480 info_cng = User.Info.add_to_note_count(user.info, 1)
484 |> put_embed(:info, info_cng)
486 update_and_set_cache(cng)
489 def decrease_note_count(%User{} = user) do
490 info_cng = User.Info.add_to_note_count(user.info, -1)
494 |> put_embed(:info, info_cng)
496 update_and_set_cache(cng)
499 def update_note_count(%User{} = user) do
503 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
507 note_count = Repo.one(note_count_query)
509 info_cng = User.Info.set_note_count(user.info, note_count)
513 |> put_embed(:info, info_cng)
515 update_and_set_cache(cng)
518 def update_follower_count(%User{} = user) do
519 follower_count_query =
522 where: ^user.follower_address in u.following,
523 where: u.id != ^user.id,
527 follower_count = Repo.one(follower_count_query)
531 |> User.Info.set_follower_count(follower_count)
535 |> put_embed(:info, info_cng)
537 update_and_set_cache(cng)
540 def get_users_from_set_query(ap_ids, false) do
543 where: u.ap_id in ^ap_ids
547 def get_users_from_set_query(ap_ids, true) do
548 query = get_users_from_set_query(ap_ids, false)
552 where: u.local == true
556 def get_users_from_set(ap_ids, local_only \\ true) do
557 get_users_from_set_query(ap_ids, local_only)
561 def get_recipients_from_activity(%Activity{recipients: to}) do
565 where: u.ap_id in ^to,
566 or_where: fragment("? && ?", u.following, ^to)
569 query = from(u in query, where: u.local == true)
574 def search(query, resolve \\ false) do
575 # strip the beginning @ off if there is a query
576 query = String.trim_leading(query, "@")
579 User.get_or_fetch_by_nickname(query)
594 where: not is_nil(u.nickname)
599 s in subquery(inner),
600 order_by: s.search_distance,
607 def block(blocker, %User{ap_id: ap_id} = blocked) do
608 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
610 if following?(blocker, blocked) do
611 {:ok, blocker, _} = unfollow(blocker, blocked)
617 if following?(blocked, blocker) do
618 unfollow(blocked, blocker)
623 |> User.Info.add_to_block(ap_id)
627 |> put_embed(:info, info_cng)
629 update_and_set_cache(cng)
632 # helper to handle the block given only an actor's AP id
633 def block(blocker, %{ap_id: ap_id}) do
634 block(blocker, User.get_by_ap_id(ap_id))
637 def unblock(blocker, %{ap_id: ap_id}) do
640 |> User.Info.remove_from_block(ap_id)
644 |> put_embed(:info, info_cng)
646 update_and_set_cache(cng)
649 def blocks?(user, %{ap_id: ap_id}) do
650 blocks = user.info.blocks
651 domain_blocks = user.info.domain_blocks
652 %{host: host} = URI.parse(ap_id)
654 Enum.member?(blocks, ap_id) ||
655 Enum.any?(domain_blocks, fn domain ->
660 def block_domain(user, domain) do
663 |> User.Info.add_to_domain_block(domain)
667 |> put_embed(:info, info_cng)
669 update_and_set_cache(cng)
672 def unblock_domain(user, domain) do
675 |> User.Info.remove_from_domain_block(domain)
679 |> put_embed(:info, info_cng)
681 update_and_set_cache(cng)
684 def local_user_query() do
687 where: u.local == true,
688 where: not is_nil(u.nickname)
692 def moderator_user_query() do
695 where: u.local == true,
696 where: fragment("?->'is_moderator' @> 'true'", u.info)
700 def deactivate(%User{} = user, status \\ true) do
701 info_cng = User.Info.set_activation_status(user.info, status)
705 |> put_embed(:info, info_cng)
707 update_and_set_cache(cng)
710 def delete(%User{} = user) do
711 {:ok, user} = User.deactivate(user)
713 # Remove all relationships
714 {:ok, followers} = User.get_followers(user)
717 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
719 {:ok, friends} = User.get_friends(user)
722 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
724 query = from(a in Activity, where: a.actor == ^user.ap_id)
727 |> Enum.each(fn activity ->
728 case activity.data["type"] do
730 ActivityPub.delete(Object.normalize(activity.data["object"]))
732 # TODO: Do something with likes, follows, repeats.
741 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
742 Pleroma.HTML.Scrubber.TwitterText
745 def html_filter_policy(_), do: nil
747 def get_or_fetch_by_ap_id(ap_id) do
748 user = get_by_ap_id(ap_id)
750 if !is_nil(user) and !User.needs_update?(user) do
753 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
760 case OStatus.make_user(ap_id) do
762 _ -> {:error, "Could not fetch by AP id"}
768 def get_or_create_instance_user do
769 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
771 if user = get_by_ap_id(relay_uri) do
775 %User{info: %User.Info{}}
776 |> cast(%{}, [:ap_id, :nickname, :local])
777 |> put_change(:ap_id, relay_uri)
778 |> put_change(:nickname, nil)
779 |> put_change(:local, true)
780 |> put_change(:follower_address, relay_uri <> "/followers")
782 {:ok, user} = Repo.insert(changes)
788 def public_key_from_info(%{
789 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
793 |> :public_key.pem_decode()
795 |> :public_key.pem_entry_decode()
801 def public_key_from_info(%{magic_key: magic_key}) do
802 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
805 def get_public_key_for_ap_id(ap_id) do
806 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
807 {:ok, public_key} <- public_key_from_info(user.info) do
814 defp blank?(""), do: nil
815 defp blank?(n), do: n
817 def insert_or_update_user(data) do
820 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
822 cs = User.remote_user_creation(data)
824 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
827 def ap_enabled?(%User{local: true}), do: true
828 def ap_enabled?(%User{info: info}), do: info.ap_enabled
829 def ap_enabled?(_), do: false
831 @doc "Gets or fetch a user by uri or nickname."
832 @spec get_or_fetch(String.t()) :: User.t()
833 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
834 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
836 # wait a period of time and return newest version of the User structs
837 # this is because we have synchronous follow APIs and need to simulate them
838 # with an async handshake
839 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
840 with %User{} = a <- Repo.get(User, a.id),
841 %User{} = b <- Repo.get(User, b.id) do
849 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
850 with :ok <- :timer.sleep(timeout),
851 %User{} = a <- Repo.get(User, a.id),
852 %User{} = b <- Repo.get(User, b.id) do
860 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
861 def parse_bio(nil, _user), do: ""
862 def parse_bio(bio, _user) when bio == "", do: bio
864 def parse_bio(bio, user) do
865 mentions = Formatter.parse_mentions(bio)
866 tags = Formatter.parse_tags(bio)
869 (user.info.source_data["tag"] || [])
870 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
871 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
872 {String.trim(name, ":"), url}
876 |> CommonUtils.format_input(mentions, tags, "text/plain")
877 |> Formatter.emojify(emoji)
880 def tag(user_identifiers, tags) when is_list(user_identifiers) do
881 Repo.transaction(fn ->
882 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
886 def tag(nickname, tags) when is_binary(nickname),
887 do: tag(User.get_by_nickname(nickname), tags)
889 def tag(%User{} = user, tags),
890 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
892 def untag(user_identifiers, tags) when is_list(user_identifiers) do
893 Repo.transaction(fn ->
894 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
898 def untag(nickname, tags) when is_binary(nickname),
899 do: untag(User.get_by_nickname(nickname), tags)
901 def untag(%User{} = user, tags),
902 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
904 defp update_tags(%User{} = user, new_tags) do
905 {:ok, updated_user} =
907 |> change(%{tags: new_tags})
913 defp normalize_tags(tags) do
916 |> Enum.map(&String.downcase(&1))
919 defp local_nickname_regex() do
920 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
921 @extended_local_nickname_regex
923 @strict_local_nickname_regex