1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.User.Search do
10 @similarity_threshold 0.25
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 # Strip the beginning @ off if there is a query
22 query_string = String.trim_leading(query_string, "@")
24 maybe_resolve(resolve, for_user, query_string)
27 Repo.transaction(fn ->
28 Ecto.Adapters.SQL.query(
30 "select set_limit(#{@similarity_threshold})",
35 |> search_query(for_user, following)
36 |> paginate(result_limit, offset)
43 defp search_query(query_string, for_user, following) do
45 |> base_query(following)
46 |> filter_blocked_user(for_user)
47 |> filter_blocked_domains(for_user)
48 |> search_subqueries(query_string)
51 |> boost_search_rank_query(for_user)
53 |> order_by(desc: :search_rank)
54 |> maybe_restrict_local(for_user)
57 defp base_query(_user, false), do: User
58 defp base_query(user, true), do: User.get_followers_query(user)
60 defp filter_blocked_user(query, %User{info: %{blocks: blocks}})
61 when length(blocks) > 0 do
62 from(q in query, where: not (q.ap_id in ^blocks))
65 defp filter_blocked_user(query, _), do: query
67 defp filter_blocked_domains(query, %User{info: %{domain_blocks: domain_blocks}})
68 when length(domain_blocks) > 0 do
69 domains = Enum.join(domain_blocks, ",")
73 where: fragment("substring(ap_id from '.*://([^/]*)') NOT IN (?)", ^domains)
77 defp filter_blocked_domains(query, _), do: query
79 defp paginate(query, limit, offset) do
80 from(q in query, limit: ^limit, offset: ^offset)
83 defp union_subqueries({fts_subquery, trigram_subquery}) do
84 from(s in trigram_subquery, union_all: ^fts_subquery)
87 defp search_subqueries(base_query, query_string) do
89 fts_search_subquery(base_query, query_string),
90 trigram_search_subquery(base_query, query_string)
94 defp distinct_query(q) do
95 from(s in subquery(q), order_by: s.search_type, distinct: s.id)
98 defp maybe_resolve(true, user, query) do
99 case {limit(), user} do
101 {:unauthenticated, %User{}} -> User.get_or_fetch(query)
102 {:unauthenticated, _} -> :noop
103 {false, _} -> User.get_or_fetch(query)
107 defp maybe_resolve(_, _, _), do: :noop
109 defp maybe_restrict_local(q, user) do
110 case {limit(), user} do
111 {:all, _} -> restrict_local(q)
112 {:unauthenticated, %User{}} -> q
113 {:unauthenticated, _} -> restrict_local(q)
118 defp limit, do: Pleroma.Config.get([:instance, :limit_to_local_content], :unauthenticated)
120 defp restrict_local(q), do: where(q, [u], u.local == true)
122 defp boost_search_rank_query(query, nil), do: query
124 defp boost_search_rank_query(query, for_user) do
125 friends_ids = User.get_friends_ids(for_user)
126 followers_ids = User.get_followers_ids(for_user)
128 from(u in subquery(query),
133 CASE WHEN (?) THEN 0.5 + (?) * 1.3
134 WHEN (?) THEN 0.5 + (?) * 1.2
135 WHEN (?) THEN (?) * 1.1
138 u.id in ^friends_ids and u.id in ^followers_ids,
140 u.id in ^friends_ids,
142 u.id in ^followers_ids,
150 @spec fts_search_subquery(User.t() | Ecto.Query.t(), String.t()) :: Ecto.Query.t()
151 defp fts_search_subquery(query, term) do
153 String.trim_trailing(term, "@" <> local_domain())
154 |> String.replace(~r/\W+/, " ")
157 |> Enum.map(&(&1 <> ":*"))
168 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
169 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
170 to_tsquery('simple', ?),
182 (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
183 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
190 |> User.restrict_deactivated()
193 @spec trigram_search_subquery(User.t() | Ecto.Query.t(), String.t()) :: Ecto.Query.t()
194 defp trigram_search_subquery(query, term) do
195 term = String.trim_trailing(term, "@" <> local_domain())
200 # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
201 search_type: fragment("?", 1),
204 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
210 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
212 |> User.restrict_deactivated()
215 defp local_domain, do: Pleroma.Config.get([Pleroma.Web.Endpoint, :url, :host])