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.Web.MastodonAPI.SearchController do
6 use Pleroma.Web, :controller
10 alias Pleroma.Web.ControllerHelper
11 alias Pleroma.Web.Endpoint
12 alias Pleroma.Web.MastodonAPI.AccountView
13 alias Pleroma.Web.MastodonAPI.StatusView
14 alias Pleroma.Web.Plugs.OAuthScopesPlug
15 alias Pleroma.Web.Plugs.RateLimiter
21 plug(Pleroma.Web.ApiSpec.CastAndValidate)
23 # Note: Mastodon doesn't allow unauthenticated access (requires read:accounts / read:search)
24 plug(OAuthScopesPlug, %{scopes: ["read:search"], fallback: :proceed_unauthenticated})
26 # Note: on private instances auth is required (EnsurePublicOrAuthenticatedPlug is not skipped)
28 plug(RateLimiter, [name: :search] when action in [:search2, :account_search])
30 defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.SearchOperation
32 def account_search(%{assigns: %{user: user}} = conn, %{q: query} = params) do
33 accounts = User.search(query, search_options(params, user))
36 |> put_view(AccountView)
37 |> render("index.json",
44 def search2(conn, params), do: do_search(:v2, conn, params)
46 defp do_search(version, %{assigns: %{user: user}} = conn, %{q: query} = params) do
47 query = String.trim(query)
48 options = search_options(params, user)
49 timeout = Keyword.get(Repo.config(), :timeout, 15_000)
50 default_values = %{"statuses" => [], "accounts" => [], "hashtags" => []}
54 |> Enum.map(fn {resource, default_value} ->
55 if params[:type] in [nil, resource] do
56 {resource, fn -> resource_search(version, resource, query, options) end}
58 {resource, fn -> default_value end}
61 |> Task.async_stream(fn {resource, f} -> {resource, with_fallback(f)} end,
63 on_timeout: :kill_task
65 |> Enum.reduce(default_values, fn
66 {:ok, {resource, result}}, acc ->
67 Map.put(acc, resource, result)
76 defp search_options(params, user) do
78 resolve: params[:resolve],
79 following: params[:following],
80 limit: min(params[:limit], @search_limit),
81 offset: params[:offset],
83 author: get_author(params),
84 embed_relationships: ControllerHelper.embed_relationships?(params),
87 |> Enum.filter(&elem(&1, 1))
90 defp resource_search(_, "accounts", query, options) do
91 accounts = with_fallback(fn -> User.search(query, options) end)
93 AccountView.render("index.json",
95 for: options[:for_user],
96 embed_relationships: options[:embed_relationships]
100 defp resource_search(_, "statuses", query, options) do
101 statuses = with_fallback(fn -> Pleroma.Search.search(query, options) end)
103 StatusView.render("index.json",
104 activities: statuses,
105 for: options[:for_user],
110 defp resource_search(:v2, "hashtags", query, options) do
111 tags_path = Endpoint.url() <> "/tag/"
114 |> prepare_tags(options)
115 |> Enum.map(fn tag ->
116 %{name: tag, url: tags_path <> tag}
120 defp prepare_tags(query, options) do
123 |> preprocess_uri_query()
124 |> String.split(~r/[^#\w]+/u, trim: true)
125 |> Enum.uniq_by(&String.downcase/1)
127 explicit_tags = Enum.filter(tags, fn tag -> String.starts_with?(tag, "#") end)
130 if Enum.any?(explicit_tags) do
136 tags = Enum.map(tags, fn tag -> String.trim_leading(tag, "#") end)
139 if Enum.empty?(explicit_tags) && !options[:skip_joined_tag] do
145 Pleroma.Pagination.paginate(tags, options)
148 defp add_joined_tag(tags) do
150 |> Kernel.++([joined_tag(tags)])
151 |> Enum.uniq_by(&String.downcase/1)
154 # If `query` is a URI, returns last component of its path, otherwise returns `query`
155 defp preprocess_uri_query(query) do
156 if query =~ ~r/https?:\/\// do
158 |> String.trim_trailing("/")
168 defp joined_tag(tags) do
170 |> Enum.map(fn tag -> String.capitalize(tag) end)
174 defp with_fallback(f, fallback \\ []) do
179 Logger.error("#{__MODULE__} search error: #{inspect(error)}")
184 defp get_author(%{account_id: account_id}) when is_binary(account_id),
185 do: User.get_cached_by_id(account_id)
187 defp get_author(_params), do: nil