1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.User.Search do
6 alias Pleroma.EctoType.ActivityPub.ObjectValidators.Uri, as: UriType
7 alias Pleroma.Pagination
14 def search(query_string, opts \\ []) do
15 resolve = Keyword.get(opts, :resolve, false)
16 following = Keyword.get(opts, :following, false)
17 result_limit = Keyword.get(opts, :limit, @limit)
18 offset = Keyword.get(opts, :offset, 0)
20 for_user = Keyword.get(opts, :for_user)
22 query_string = format_query(query_string)
24 # If this returns anything, it should bounce to the top
25 maybe_resolved = maybe_resolve(resolve, for_user, query_string)
29 |> maybe_add_resolved(maybe_resolved)
30 |> maybe_add_ap_id_match(query_string)
31 |> maybe_add_uri_match(query_string)
35 |> search_query(for_user, following, top_user_ids)
36 |> Pagination.fetch_paginated(%{"offset" => offset, "limit" => result_limit}, :offset)
41 defp maybe_add_resolved(list, {:ok, %User{} = user}) do
45 defp maybe_add_resolved(list, _), do: list
47 defp maybe_add_ap_id_match(list, query) do
48 if user = User.get_cached_by_ap_id(query) do
55 defp maybe_add_uri_match(list, query) do
56 with {:ok, query} <- UriType.cast(query),
57 q = from(u in User, where: u.uri == ^query, select: u.id),
58 users = Pleroma.Repo.all(q) do
65 defp format_query(query_string) do
66 # Strip the beginning @ off if there is a query
67 query_string = String.trim_leading(query_string, "@")
69 with [name, domain] <- String.split(query_string, "@") do
72 |> String.replace(~r/[!-\-|@|[-`|{-~|\/|:|\s]+/, "")
73 |> String.to_charlist()
77 name <> "@" <> encoded_domain
83 defp search_query(query_string, for_user, following, top_user_ids) do
85 |> base_query(following)
86 |> filter_blocked_user(for_user)
87 |> filter_invisible_users()
88 |> filter_internal_users()
89 |> filter_blocked_domains(for_user)
90 |> fts_search(query_string)
91 |> select_top_users(top_user_ids)
92 |> trigram_rank(query_string)
93 |> boost_search_rank(for_user, top_user_ids)
95 |> order_by(desc: :search_rank)
96 |> maybe_restrict_local(for_user)
97 |> filter_deactivated_users()
100 defp select_top_users(query, top_user_ids) do
102 or_where: u.id in ^top_user_ids
106 defp fts_search(query, query_string) do
107 query_string = to_tsquery(query_string)
113 # The fragment must _exactly_ match `users_fts_index`, otherwise the index won't work
116 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
117 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')
118 ) @@ to_tsquery('simple', ?)
127 defp to_tsquery(query_string) do
128 String.trim_trailing(query_string, "@" <> local_domain())
129 |> String.replace(~r/[!-\/|@|[-`|{-~|:-?]+/, " ")
132 |> Enum.map(&(&1 <> ":*"))
136 # Considers nickname match, localized nickname match, name match; preferences nickname match
137 defp trigram_rank(query, query_string) do
145 similarity(?, regexp_replace(?, '@.+', '')) +
146 similarity(?, trim(coalesce(?, '')))
159 defp base_query(%User{} = user, true), do: User.get_friends_query(user)
160 defp base_query(_user, _following), do: User
162 defp filter_invisible_users(query) do
163 from(q in query, where: q.invisible == false)
166 defp filter_internal_users(query) do
167 from(q in query, where: q.actor_type != "Application")
170 defp filter_deactivated_users(query) do
171 from(q in query, where: q.is_active == true)
174 defp filter_blocked_user(query, %User{} = blocker) do
176 |> join(:left, [u], b in Pleroma.UserRelationship,
178 on: b.relationship_type == ^:block and b.source_id == ^blocker.id and u.id == b.target_id
180 |> where([blocks: b], is_nil(b.target_id))
183 defp filter_blocked_user(query, _), do: query
185 defp filter_blocked_domains(query, %User{domain_blocks: domain_blocks})
186 when length(domain_blocks) > 0 do
187 domains = Enum.join(domain_blocks, ",")
191 where: fragment("substring(ap_id from '.*://([^/]*)') NOT IN (?)", ^domains)
195 defp filter_blocked_domains(query, _), do: query
197 defp maybe_resolve(true, user, query) do
198 case {limit(), user} do
200 {:unauthenticated, %User{}} -> User.get_or_fetch(query)
201 {:unauthenticated, _} -> :noop
202 {false, _} -> User.get_or_fetch(query)
206 defp maybe_resolve(_, _, _), do: :noop
208 defp maybe_restrict_local(q, user) do
209 case {limit(), user} do
210 {:all, _} -> restrict_local(q)
211 {:unauthenticated, %User{}} -> q
212 {:unauthenticated, _} -> restrict_local(q)
217 defp limit, do: Pleroma.Config.get([:instance, :limit_to_local_content], :unauthenticated)
219 defp restrict_local(q), do: where(q, [u], u.local == true)
221 defp local_domain, do: Pleroma.Config.get([Pleroma.Web.Endpoint, :url, :host])
223 defp boost_search_rank(query, %User{} = for_user, top_user_ids) do
224 friends_ids = User.get_friends_ids(for_user)
225 followers_ids = User.get_followers_ids(for_user)
227 from(u in subquery(query),
232 CASE WHEN (?) THEN (?) * 1.5
233 WHEN (?) THEN (?) * 1.3
234 WHEN (?) THEN (?) * 1.1
238 u.id in ^friends_ids and u.id in ^followers_ids,
240 u.id in ^friends_ids,
242 u.id in ^followers_ids,
244 u.id in ^top_user_ids,
251 defp boost_search_rank(query, _for_user, top_user_ids) do
252 from(u in subquery(query),
257 CASE WHEN (?) THEN 9001
260 u.id in ^top_user_ids,