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
6 alias Pleroma.Pagination
11 @similarity_threshold 0.25
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 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 |> Pagination.fetch_paginated(%{"offset" => offset, "limit" => result_limit}, :offset)
43 defp format_query(query_string) do
44 # Strip the beginning @ off if there is a query
45 query_string = String.trim_leading(query_string, "@")
47 with [name, domain] <- String.split(query_string, "@"),
48 formatted_domain <- String.replace(domain, ~r/[!-\-|@|[-`|{-~|\/|:|\s]+/, "") do
49 name <> "@" <> to_string(:idna.encode(formatted_domain))
55 defp search_query(query_string, for_user, following) do
57 |> base_query(following)
58 |> filter_blocked_user(for_user)
59 |> filter_blocked_domains(for_user)
60 |> search_subqueries(query_string)
63 |> boost_search_rank_query(for_user)
65 |> order_by(desc: :search_rank)
66 |> maybe_restrict_local(for_user)
69 defp base_query(_user, false), do: User
70 defp base_query(user, true), do: User.get_followers_query(user)
72 defp filter_blocked_user(query, %User{info: %{blocks: blocks}})
73 when length(blocks) > 0 do
74 from(q in query, where: not (q.ap_id in ^blocks))
77 defp filter_blocked_user(query, _), do: query
79 defp filter_blocked_domains(query, %User{info: %{domain_blocks: domain_blocks}})
80 when length(domain_blocks) > 0 do
81 domains = Enum.join(domain_blocks, ",")
85 where: fragment("substring(ap_id from '.*://([^/]*)') NOT IN (?)", ^domains)
89 defp filter_blocked_domains(query, _), do: query
91 defp union_subqueries({fts_subquery, trigram_subquery}) do
92 from(s in trigram_subquery, union_all: ^fts_subquery)
95 defp search_subqueries(base_query, query_string) do
97 fts_search_subquery(base_query, query_string),
98 trigram_search_subquery(base_query, query_string)
102 defp distinct_query(q) do
103 from(s in subquery(q), order_by: s.search_type, distinct: s.id)
106 defp maybe_resolve(true, user, query) do
107 case {limit(), user} do
109 {:unauthenticated, %User{}} -> User.get_or_fetch(query)
110 {:unauthenticated, _} -> :noop
111 {false, _} -> User.get_or_fetch(query)
115 defp maybe_resolve(_, _, _), do: :noop
117 defp maybe_restrict_local(q, user) do
118 case {limit(), user} do
119 {:all, _} -> restrict_local(q)
120 {:unauthenticated, %User{}} -> q
121 {:unauthenticated, _} -> restrict_local(q)
126 defp limit, do: Pleroma.Config.get([:instance, :limit_to_local_content], :unauthenticated)
128 defp restrict_local(q), do: where(q, [u], u.local == true)
130 defp boost_search_rank_query(query, nil), do: query
132 defp boost_search_rank_query(query, for_user) do
133 friends_ids = User.get_friends_ids(for_user)
134 followers_ids = User.get_followers_ids(for_user)
136 from(u in subquery(query),
141 CASE WHEN (?) THEN 0.5 + (?) * 1.3
142 WHEN (?) THEN 0.5 + (?) * 1.2
143 WHEN (?) THEN (?) * 1.1
146 u.id in ^friends_ids and u.id in ^followers_ids,
148 u.id in ^friends_ids,
150 u.id in ^followers_ids,
158 @spec fts_search_subquery(User.t() | Ecto.Query.t(), String.t()) :: Ecto.Query.t()
159 defp fts_search_subquery(query, term) do
161 String.trim_trailing(term, "@" <> local_domain())
162 |> String.replace(~r/[!-\/|@|[-`|{-~|:-?]+/, " ")
165 |> Enum.map(&(&1 <> ":*"))
176 setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
177 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
178 to_tsquery('simple', ?),
190 (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
191 setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
198 |> User.restrict_deactivated()
201 @spec trigram_search_subquery(User.t() | Ecto.Query.t(), String.t()) :: Ecto.Query.t()
202 defp trigram_search_subquery(query, term) do
203 term = String.trim_trailing(term, "@" <> local_domain())
208 # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
209 search_type: fragment("?", 1),
212 "similarity(?, trim(? || ' ' || coalesce(?, '')))",
218 where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
220 |> User.restrict_deactivated()
223 defp local_domain, do: Pleroma.Config.get([Pleroma.Web.Endpoint, :url, :host])