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
12 def search(query_string, opts \\ []) do
13 resolve = Keyword.get(opts, :resolve, false)
14 following = Keyword.get(opts, :following, false)
15 result_limit = Keyword.get(opts, :limit, @limit)
16 offset = Keyword.get(opts, :offset, 0)
18 for_user = Keyword.get(opts, :for_user)
20 query_string = format_query(query_string)
22 maybe_resolve(resolve, for_user, query_string)
26 |> search_query(for_user, following)
27 |> Pagination.fetch_paginated(%{"offset" => offset, "limit" => result_limit}, :offset)
32 defp format_query(query_string) do
33 # Strip the beginning @ off if there is a query
34 query_string = String.trim_leading(query_string, "@")
36 with [name, domain] <- String.split(query_string, "@") do
39 |> String.replace(~r/[!-\-|@|[-`|{-~|\/|:|\s]+/, "")
40 |> String.to_charlist()
44 name <> "@" <> encoded_domain
50 defp search_query(query_string, for_user, following) do
52 |> base_query(following)
53 |> filter_blocked_user(for_user)
54 |> filter_invisible_users()
55 |> filter_discoverable_users()
56 |> filter_internal_users()
57 |> filter_blocked_domains(for_user)
58 |> fts_search(query_string)
59 |> trigram_rank(query_string)
60 |> boost_search_rank(for_user)
62 |> order_by(desc: :search_rank)
63 |> maybe_restrict_local(for_user)
66 defp fts_search(query, query_string) do
67 query_string = to_tsquery(query_string)
73 # The fragment must _exactly_ match `users_fts_index`, otherwise the index won't work
76 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
77 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')
78 ) @@ to_tsquery('simple', ?)
87 defp to_tsquery(query_string) do
88 String.trim_trailing(query_string, "@" <> local_domain())
89 |> String.replace(~r/[!-\/|@|[-`|{-~|:-?]+/, " ")
92 |> Enum.map(&(&1 <> ":*"))
96 # Considers nickname match, localized nickname match, name match; preferences nickname match
97 defp trigram_rank(query, query_string) do
105 similarity(?, regexp_replace(?, '@.+', '')) +
106 similarity(?, trim(coalesce(?, '')))
119 defp base_query(%User{} = user, true), do: User.get_friends_query(user)
120 defp base_query(_user, _following), do: User
122 defp filter_invisible_users(query) do
123 from(q in query, where: q.invisible == false)
126 defp filter_discoverable_users(query) do
127 from(q in query, where: q.discoverable == true)
130 defp filter_internal_users(query) do
131 from(q in query, where: q.actor_type != "Application")
134 defp filter_blocked_user(query, %User{} = blocker) do
136 |> join(:left, [u], b in Pleroma.UserRelationship,
138 on: b.relationship_type == ^:block and b.source_id == ^blocker.id and u.id == b.target_id
140 |> where([blocks: b], is_nil(b.target_id))
143 defp filter_blocked_user(query, _), do: query
145 defp filter_blocked_domains(query, %User{domain_blocks: domain_blocks})
146 when length(domain_blocks) > 0 do
147 domains = Enum.join(domain_blocks, ",")
151 where: fragment("substring(ap_id from '.*://([^/]*)') NOT IN (?)", ^domains)
155 defp filter_blocked_domains(query, _), do: query
157 defp maybe_resolve(true, user, query) do
158 case {limit(), user} do
160 {:unauthenticated, %User{}} -> User.get_or_fetch(query)
161 {:unauthenticated, _} -> :noop
162 {false, _} -> User.get_or_fetch(query)
166 defp maybe_resolve(_, _, _), do: :noop
168 defp maybe_restrict_local(q, user) do
169 case {limit(), user} do
170 {:all, _} -> restrict_local(q)
171 {:unauthenticated, %User{}} -> q
172 {:unauthenticated, _} -> restrict_local(q)
177 defp limit, do: Pleroma.Config.get([:instance, :limit_to_local_content], :unauthenticated)
179 defp restrict_local(q), do: where(q, [u], u.local == true)
181 defp local_domain, do: Pleroma.Config.get([Pleroma.Web.Endpoint, :url, :host])
183 defp boost_search_rank(query, %User{} = for_user) do
184 friends_ids = User.get_friends_ids(for_user)
185 followers_ids = User.get_followers_ids(for_user)
187 from(u in subquery(query),
192 CASE WHEN (?) THEN (?) * 1.5
193 WHEN (?) THEN (?) * 1.3
194 WHEN (?) THEN (?) * 1.1
197 u.id in ^friends_ids and u.id in ^followers_ids,
199 u.id in ^friends_ids,
201 u.id in ^followers_ids,
209 defp boost_search_rank(query, _for_user), do: query