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_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
201 |> validate_format(:nickname, local_nickname_regex())
202 |> validate_format(:email, @email_regex)
203 |> validate_length(:bio, max: 1000)
204 |> validate_length(:name, min: 1, max: 100)
205 |> put_change(:info, info_change)
207 if changeset.valid? do
208 hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
209 ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
210 followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
213 |> put_change(:password_hash, hashed)
214 |> put_change(:ap_id, ap_id)
215 |> put_change(:following, [followers])
216 |> put_change(:follower_address, followers)
222 @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
223 def register(%Ecto.Changeset{} = changeset) do
224 with {:ok, user} <- Repo.insert(changeset),
225 {:ok, _} = try_send_confirmation_email(user) do
230 def try_send_confirmation_email(%User{} = user) do
231 if user.info.confirmation_pending &&
232 Pleroma.Config.get([:instance, :account_activation_required]) do
234 |> Pleroma.UserEmail.account_confirmation_email()
235 |> Pleroma.Mailer.deliver()
241 def needs_update?(%User{local: true}), do: false
243 def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true
245 def needs_update?(%User{local: false} = user) do
246 NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86400
249 def needs_update?(_), do: true
251 def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
255 def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
256 follow(follower, followed)
259 def maybe_direct_follow(%User{} = follower, %User{} = followed) do
260 if not User.ap_enabled?(followed) do
261 follow(follower, followed)
267 def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
268 if not following?(follower, followed) do
269 follow(follower, followed)
275 def follow(%User{} = follower, %User{info: info} = followed) do
276 user_config = Application.get_env(:pleroma, :user)
277 deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
279 ap_followers = followed.follower_address
282 following?(follower, followed) or info.deactivated ->
283 {:error, "Could not follow user: #{followed.nickname} is already on your list."}
285 deny_follow_blocked and blocks?(followed, follower) ->
286 {:error, "Could not follow user: #{followed.nickname} blocked you."}
289 if !followed.local && follower.local && !ap_enabled?(followed) do
290 Websub.subscribe(follower, followed)
294 [ap_followers | follower.following]
299 |> follow_changeset(%{following: following})
300 |> update_and_set_cache
302 {:ok, _} = update_follower_count(followed)
308 def unfollow(%User{} = follower, %User{} = followed) do
309 ap_followers = followed.follower_address
311 if following?(follower, followed) and follower.ap_id != followed.ap_id do
314 |> List.delete(ap_followers)
318 |> follow_changeset(%{following: following})
319 |> update_and_set_cache
321 {:ok, followed} = update_follower_count(followed)
323 {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
325 {:error, "Not subscribed!"}
329 @spec following?(User.t(), User.t()) :: boolean
330 def following?(%User{} = follower, %User{} = followed) do
331 Enum.member?(follower.following, followed.follower_address)
334 def locked?(%User{} = user) do
335 user.info.locked || false
338 def get_by_ap_id(ap_id) do
339 Repo.get_by(User, ap_id: ap_id)
342 def update_and_set_cache(changeset) do
343 with {:ok, user} <- Repo.update(changeset) do
344 Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
345 Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
346 Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
353 def invalidate_cache(user) do
354 Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
355 Cachex.del(:user_cache, "nickname:#{user.nickname}")
356 Cachex.del(:user_cache, "user_info:#{user.id}")
359 def get_cached_by_ap_id(ap_id) do
360 key = "ap_id:#{ap_id}"
361 Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
364 def get_cached_by_nickname(nickname) do
365 key = "nickname:#{nickname}"
366 Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
369 def get_by_nickname(nickname) do
370 Repo.get_by(User, nickname: nickname)
373 def get_by_nickname_or_email(nickname_or_email) do
374 case user = Repo.get_by(User, nickname: nickname_or_email) do
376 nil -> Repo.get_by(User, email: nickname_or_email)
380 def get_cached_user_info(user) do
381 key = "user_info:#{user.id}"
382 Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
385 def fetch_by_nickname(nickname) do
386 ap_try = ActivityPub.make_user_from_nickname(nickname)
389 {:ok, user} -> {:ok, user}
390 _ -> OStatus.make_user(nickname)
394 def get_or_fetch_by_nickname(nickname) do
395 with %User{} = user <- get_by_nickname(nickname) do
399 with [_nick, _domain] <- String.split(nickname, "@"),
400 {:ok, user} <- fetch_by_nickname(nickname) do
408 def get_followers_query(%User{id: id, follower_address: follower_address}) do
411 where: fragment("? <@ ?", ^[follower_address], u.following),
416 def get_followers(user) do
417 q = get_followers_query(user)
422 def get_friends_query(%User{id: id, following: following}) do
425 where: u.follower_address in ^following,
430 def get_friends(user) do
431 q = get_friends_query(user)
436 def get_follow_requests_query(%User{} = user) do
441 "? ->> 'type' = 'Follow'",
446 "? ->> 'state' = 'pending'",
453 ^%{"object" => user.ap_id}
458 def get_follow_requests(%User{} = user) do
459 q = get_follow_requests_query(user)
463 Enum.map(reqs, fn req -> req.actor end)
465 |> Enum.map(fn ap_id -> get_by_ap_id(ap_id) end)
466 |> Enum.filter(fn u -> !following?(u, user) end)
471 def increase_note_count(%User{} = user) do
472 info_cng = User.Info.add_to_note_count(user.info, 1)
476 |> put_embed(:info, info_cng)
478 update_and_set_cache(cng)
481 def decrease_note_count(%User{} = user) do
482 info_cng = User.Info.add_to_note_count(user.info, -1)
486 |> put_embed(:info, info_cng)
488 update_and_set_cache(cng)
491 def update_note_count(%User{} = user) do
495 where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
499 note_count = Repo.one(note_count_query)
501 info_cng = User.Info.set_note_count(user.info, note_count)
505 |> put_embed(:info, info_cng)
507 update_and_set_cache(cng)
510 def update_follower_count(%User{} = user) do
511 follower_count_query =
514 where: ^user.follower_address in u.following,
515 where: u.id != ^user.id,
519 follower_count = Repo.one(follower_count_query)
523 |> User.Info.set_follower_count(follower_count)
527 |> put_embed(:info, info_cng)
529 update_and_set_cache(cng)
532 def get_users_from_set_query(ap_ids, false) do
535 where: u.ap_id in ^ap_ids
539 def get_users_from_set_query(ap_ids, true) do
540 query = get_users_from_set_query(ap_ids, false)
544 where: u.local == true
548 def get_users_from_set(ap_ids, local_only \\ true) do
549 get_users_from_set_query(ap_ids, local_only)
553 def get_recipients_from_activity(%Activity{recipients: to}) do
557 where: u.ap_id in ^to,
558 or_where: fragment("? && ?", u.following, ^to)
561 query = from(u in query, where: u.local == true)
566 def search(query, resolve \\ false) do
567 # strip the beginning @ off if there is a query
568 query = String.trim_leading(query, "@")
571 User.get_or_fetch_by_nickname(query)
586 where: not is_nil(u.nickname)
591 s in subquery(inner),
592 order_by: s.search_distance,
599 def block(blocker, %User{ap_id: ap_id} = blocked) do
600 # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
602 if following?(blocker, blocked) do
603 {:ok, blocker, _} = unfollow(blocker, blocked)
609 if following?(blocked, blocker) do
610 unfollow(blocked, blocker)
615 |> User.Info.add_to_block(ap_id)
619 |> put_embed(:info, info_cng)
621 update_and_set_cache(cng)
624 # helper to handle the block given only an actor's AP id
625 def block(blocker, %{ap_id: ap_id}) do
626 block(blocker, User.get_by_ap_id(ap_id))
629 def unblock(blocker, %{ap_id: ap_id}) do
632 |> User.Info.remove_from_block(ap_id)
636 |> put_embed(:info, info_cng)
638 update_and_set_cache(cng)
641 def blocks?(user, %{ap_id: ap_id}) do
642 blocks = user.info.blocks
643 domain_blocks = user.info.domain_blocks
644 %{host: host} = URI.parse(ap_id)
646 Enum.member?(blocks, ap_id) ||
647 Enum.any?(domain_blocks, fn domain ->
652 def blocked_users(user),
653 do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))
655 def block_domain(user, domain) do
658 |> User.Info.add_to_domain_block(domain)
662 |> put_embed(:info, info_cng)
664 update_and_set_cache(cng)
667 def unblock_domain(user, domain) do
670 |> User.Info.remove_from_domain_block(domain)
674 |> put_embed(:info, info_cng)
676 update_and_set_cache(cng)
679 def local_user_query() do
682 where: u.local == true,
683 where: not is_nil(u.nickname)
687 def moderator_user_query() do
690 where: u.local == true,
691 where: fragment("?->'is_moderator' @> 'true'", u.info)
695 def deactivate(%User{} = user, status \\ true) do
696 info_cng = User.Info.set_activation_status(user.info, status)
700 |> put_embed(:info, info_cng)
702 update_and_set_cache(cng)
705 def delete(%User{} = user) do
706 {:ok, user} = User.deactivate(user)
708 # Remove all relationships
709 {:ok, followers} = User.get_followers(user)
712 |> Enum.each(fn follower -> User.unfollow(follower, user) end)
714 {:ok, friends} = User.get_friends(user)
717 |> Enum.each(fn followed -> User.unfollow(user, followed) end)
719 query = from(a in Activity, where: a.actor == ^user.ap_id)
722 |> Enum.each(fn activity ->
723 case activity.data["type"] do
725 ActivityPub.delete(Object.normalize(activity.data["object"]))
727 # TODO: Do something with likes, follows, repeats.
736 def html_filter_policy(%User{info: %{no_rich_text: true}}) do
737 Pleroma.HTML.Scrubber.TwitterText
740 def html_filter_policy(_), do: nil
742 def get_or_fetch_by_ap_id(ap_id) do
743 user = get_by_ap_id(ap_id)
745 if !is_nil(user) and !User.needs_update?(user) do
748 ap_try = ActivityPub.make_user_from_ap_id(ap_id)
755 case OStatus.make_user(ap_id) do
757 _ -> {:error, "Could not fetch by AP id"}
763 def get_or_create_instance_user do
764 relay_uri = "#{Pleroma.Web.Endpoint.url()}/relay"
766 if user = get_by_ap_id(relay_uri) do
770 %User{info: %User.Info{}}
771 |> cast(%{}, [:ap_id, :nickname, :local])
772 |> put_change(:ap_id, relay_uri)
773 |> put_change(:nickname, nil)
774 |> put_change(:local, true)
775 |> put_change(:follower_address, relay_uri <> "/followers")
777 {:ok, user} = Repo.insert(changes)
783 def public_key_from_info(%{
784 source_data: %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
788 |> :public_key.pem_decode()
790 |> :public_key.pem_entry_decode()
796 def public_key_from_info(%{magic_key: magic_key}) do
797 {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
800 def get_public_key_for_ap_id(ap_id) do
801 with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
802 {:ok, public_key} <- public_key_from_info(user.info) do
809 defp blank?(""), do: nil
810 defp blank?(n), do: n
812 def insert_or_update_user(data) do
815 |> Map.put(:name, blank?(data[:name]) || data[:nickname])
817 cs = User.remote_user_creation(data)
819 Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
822 def ap_enabled?(%User{local: true}), do: true
823 def ap_enabled?(%User{info: info}), do: info.ap_enabled
824 def ap_enabled?(_), do: false
826 @doc "Gets or fetch a user by uri or nickname."
827 @spec get_or_fetch(String.t()) :: User.t()
828 def get_or_fetch("http" <> _host = uri), do: get_or_fetch_by_ap_id(uri)
829 def get_or_fetch(nickname), do: get_or_fetch_by_nickname(nickname)
831 # wait a period of time and return newest version of the User structs
832 # this is because we have synchronous follow APIs and need to simulate them
833 # with an async handshake
834 def wait_and_refresh(_, %User{local: true} = a, %User{local: true} = b) do
835 with %User{} = a <- Repo.get(User, a.id),
836 %User{} = b <- Repo.get(User, b.id) do
844 def wait_and_refresh(timeout, %User{} = a, %User{} = b) do
845 with :ok <- :timer.sleep(timeout),
846 %User{} = a <- Repo.get(User, a.id),
847 %User{} = b <- Repo.get(User, b.id) do
855 def parse_bio(bio, user \\ %User{info: %{source_data: %{}}})
856 def parse_bio(nil, _user), do: ""
857 def parse_bio(bio, _user) when bio == "", do: bio
859 def parse_bio(bio, user) do
860 mentions = Formatter.parse_mentions(bio)
861 tags = Formatter.parse_tags(bio)
864 (user.info.source_data["tag"] || [])
865 |> Enum.filter(fn %{"type" => t} -> t == "Emoji" end)
866 |> Enum.map(fn %{"icon" => %{"url" => url}, "name" => name} ->
867 {String.trim(name, ":"), url}
871 |> CommonUtils.format_input(mentions, tags, "text/plain")
872 |> Formatter.emojify(emoji)
875 def tag(user_identifiers, tags) when is_list(user_identifiers) do
876 Repo.transaction(fn ->
877 for user_identifier <- user_identifiers, do: tag(user_identifier, tags)
881 def tag(nickname, tags) when is_binary(nickname),
882 do: tag(User.get_by_nickname(nickname), tags)
884 def tag(%User{} = user, tags),
885 do: update_tags(user, Enum.uniq((user.tags || []) ++ normalize_tags(tags)))
887 def untag(user_identifiers, tags) when is_list(user_identifiers) do
888 Repo.transaction(fn ->
889 for user_identifier <- user_identifiers, do: untag(user_identifier, tags)
893 def untag(nickname, tags) when is_binary(nickname),
894 do: untag(User.get_by_nickname(nickname), tags)
896 def untag(%User{} = user, tags),
897 do: update_tags(user, (user.tags || []) -- normalize_tags(tags))
899 defp update_tags(%User{} = user, new_tags) do
900 {:ok, updated_user} =
902 |> change(%{tags: new_tags})
908 defp normalize_tags(tags) do
911 |> Enum.map(&String.downcase(&1))
914 defp local_nickname_regex() do
915 if Pleroma.Config.get([:instance, :extended_nickname_format]) do
916 @extended_local_nickname_regex
918 @strict_local_nickname_regex