1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.User.Search do
6 alias Pleroma.Pagination
8 alias Pleroma.EctoType.ActivityPub.ObjectValidators.Uri, as: UriType
13 def search(query_string, opts \\ []) do
14 resolve = Keyword.get(opts, :resolve, false)
15 following = Keyword.get(opts, :following, false)
16 result_limit = Keyword.get(opts, :limit, @limit)
17 offset = Keyword.get(opts, :offset, 0)
19 for_user = Keyword.get(opts, :for_user)
21 query_string = format_query(query_string)
23 # If this returns anything, it should bounce to the top
24 maybe_resolved = maybe_resolve(resolve, for_user, query_string)
28 |> maybe_add_resolved(maybe_resolved)
29 |> maybe_add_ap_id_match(query_string)
30 |> maybe_add_uri_match(query_string)
34 |> search_query(for_user, following, top_user_ids)
35 |> Pagination.fetch_paginated(%{"offset" => offset, "limit" => result_limit}, :offset)
40 defp maybe_add_resolved(list, {:ok, %User{} = user}) do
44 defp maybe_add_resolved(list, _), do: list
46 defp maybe_add_ap_id_match(list, query) do
47 if user = User.get_cached_by_ap_id(query) do
54 defp maybe_add_uri_match(list, query) do
55 with {:ok, query} <- UriType.cast(query),
56 %User{} = user <- Pleroma.Repo.get_by(User, uri: query) do
63 defp format_query(query_string) do
64 # Strip the beginning @ off if there is a query
65 query_string = String.trim_leading(query_string, "@")
67 with [name, domain] <- String.split(query_string, "@") do
70 |> String.replace(~r/[!-\-|@|[-`|{-~|\/|:|\s]+/, "")
71 |> String.to_charlist()
75 name <> "@" <> encoded_domain
81 defp search_query(query_string, for_user, following, top_user_ids) do
83 |> base_query(following)
84 |> filter_blocked_user(for_user)
85 |> filter_invisible_users()
86 |> filter_discoverable_users()
87 |> filter_internal_users()
88 |> filter_blocked_domains(for_user)
89 |> fts_search(query_string)
90 |> select_top_users(top_user_ids)
91 |> trigram_rank(query_string)
92 |> boost_search_rank(for_user, top_user_ids)
94 |> order_by(desc: :search_rank)
95 |> maybe_restrict_local(for_user)
98 defp select_top_users(query, top_user_ids) do
100 or_where: u.id in ^top_user_ids
104 defp fts_search(query, query_string) do
105 query_string = to_tsquery(query_string)
111 # The fragment must _exactly_ match `users_fts_index`, otherwise the index won't work
114 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
115 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')
116 ) @@ to_tsquery('simple', ?)
125 defp to_tsquery(query_string) do
126 String.trim_trailing(query_string, "@" <> local_domain())
127 |> String.replace(~r/[!-\/|@|[-`|{-~|:-?]+/, " ")
130 |> Enum.map(&(&1 <> ":*"))
134 # Considers nickname match, localized nickname match, name match; preferences nickname match
135 defp trigram_rank(query, query_string) do
143 similarity(?, regexp_replace(?, '@.+', '')) +
144 similarity(?, trim(coalesce(?, '')))
157 defp base_query(%User{} = user, true), do: User.get_friends_query(user)
158 defp base_query(_user, _following), do: User
160 defp filter_invisible_users(query) do
161 from(q in query, where: q.invisible == false)
164 defp filter_discoverable_users(query) do
165 from(q in query, where: q.discoverable == true)
168 defp filter_internal_users(query) do
169 from(q in query, where: q.actor_type != "Application")
172 defp filter_blocked_user(query, %User{} = blocker) do
174 |> join(:left, [u], b in Pleroma.UserRelationship,
176 on: b.relationship_type == ^:block and b.source_id == ^blocker.id and u.id == b.target_id
178 |> where([blocks: b], is_nil(b.target_id))
181 defp filter_blocked_user(query, _), do: query
183 defp filter_blocked_domains(query, %User{domain_blocks: domain_blocks})
184 when length(domain_blocks) > 0 do
185 domains = Enum.join(domain_blocks, ",")
189 where: fragment("substring(ap_id from '.*://([^/]*)') NOT IN (?)", ^domains)
193 defp filter_blocked_domains(query, _), do: query
195 defp maybe_resolve(true, user, query) do
196 case {limit(), user} do
198 {:unauthenticated, %User{}} -> User.get_or_fetch(query)
199 {:unauthenticated, _} -> :noop
200 {false, _} -> User.get_or_fetch(query)
204 defp maybe_resolve(_, _, _), do: :noop
206 defp maybe_restrict_local(q, user) do
207 case {limit(), user} do
208 {:all, _} -> restrict_local(q)
209 {:unauthenticated, %User{}} -> q
210 {:unauthenticated, _} -> restrict_local(q)
215 defp limit, do: Pleroma.Config.get([:instance, :limit_to_local_content], :unauthenticated)
217 defp restrict_local(q), do: where(q, [u], u.local == true)
219 defp local_domain, do: Pleroma.Config.get([Pleroma.Web.Endpoint, :url, :host])
221 defp boost_search_rank(query, %User{} = for_user, top_user_ids) do
222 friends_ids = User.get_friends_ids(for_user)
223 followers_ids = User.get_followers_ids(for_user)
225 from(u in subquery(query),
230 CASE WHEN (?) THEN (?) * 1.5
231 WHEN (?) THEN (?) * 1.3
232 WHEN (?) THEN (?) * 1.1
236 u.id in ^friends_ids and u.id in ^followers_ids,
238 u.id in ^friends_ids,
240 u.id in ^followers_ids,
242 u.id in ^top_user_ids,
249 defp boost_search_rank(query, _for_user, top_user_ids) do
250 from(u in subquery(query),
255 CASE WHEN (?) THEN 9001
258 u.id in ^top_user_ids,