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.Web.MastodonAPI.SearchController do
6 use Pleroma.Web, :controller
9 alias Pleroma.Plugs.OAuthScopesPlug
10 alias Pleroma.Plugs.RateLimiter
14 alias Pleroma.Web.ControllerHelper
15 alias Pleroma.Web.MastodonAPI.AccountView
16 alias Pleroma.Web.MastodonAPI.StatusView
20 plug(Pleroma.Web.ApiSpec.CastAndValidate)
22 # Note: Mastodon doesn't allow unauthenticated access (requires read:accounts / read:search)
23 plug(OAuthScopesPlug, %{scopes: ["read:search"], fallback: :proceed_unauthenticated})
25 # Note: on private instances auth is required (EnsurePublicOrAuthenticatedPlug is not skipped)
27 plug(RateLimiter, [name: :search] when action in [:search, :search2, :account_search])
29 defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.SearchOperation
31 def account_search(%{assigns: %{user: user}} = conn, %{q: query} = params) do
32 accounts = User.search(query, search_options(params, user))
35 |> put_view(AccountView)
36 # https://git.pleroma.social/pleroma/pleroma-fe/-/issues/838#note_59223
37 |> render("index.json",
41 embed_relationships: ControllerHelper.with_relationships?(params)
45 def search2(conn, params), do: do_search(:v2, conn, params)
46 def search(conn, params), do: do_search(:v1, conn, params)
48 defp do_search(version, %{assigns: %{user: user}} = conn, %{q: query} = params) do
49 options = search_options(params, user)
50 timeout = Keyword.get(Repo.config(), :timeout, 15_000)
51 default_values = %{"statuses" => [], "accounts" => [], "hashtags" => []}
55 |> Enum.map(fn {resource, default_value} ->
56 if params[:type] in [nil, resource] do
57 {resource, fn -> resource_search(version, resource, query, options) end}
59 {resource, fn -> default_value end}
62 |> Task.async_stream(fn {resource, f} -> {resource, with_fallback(f)} end,
64 on_timeout: :kill_task
66 |> Enum.reduce(default_values, fn
67 {:ok, {resource, result}}, acc ->
68 Map.put(acc, resource, result)
77 defp search_options(params, user) do
79 resolve: params[:resolve],
80 following: params[:following],
81 limit: params[:limit],
82 offset: params[:offset],
84 author: get_author(params),
85 embed_relationships: ControllerHelper.with_relationships?(params),
88 |> Enum.filter(&elem(&1, 1))
91 defp resource_search(_, "accounts", query, options) do
92 accounts = with_fallback(fn -> User.search(query, options) end)
94 AccountView.render("index.json",
96 for: options[:for_user],
98 # https://git.pleroma.social/pleroma/pleroma-fe/-/issues/838#note_59223
99 embed_relationships: options[:embed_relationships]
103 defp resource_search(_, "statuses", query, options) do
104 statuses = with_fallback(fn -> Activity.search(options[:for_user], query, options) end)
106 StatusView.render("index.json",
107 activities: statuses,
108 for: options[:for_user],
113 defp resource_search(:v2, "hashtags", query, _options) do
114 tags_path = Web.base_url() <> "/tag/"
118 |> Enum.map(fn tag ->
119 tag = String.trim_leading(tag, "#")
120 %{name: tag, url: tags_path <> tag}
124 defp resource_search(:v1, "hashtags", query, _options) do
127 |> Enum.map(fn tag -> String.trim_leading(tag, "#") end)
130 defp prepare_tags(query) do
134 |> Enum.filter(fn tag -> String.starts_with?(tag, "#") end)
137 defp with_fallback(f, fallback \\ []) do
142 Logger.error("#{__MODULE__} search error: #{inspect(error)}")
147 defp get_author(%{account_id: account_id}) when is_binary(account_id),
148 do: User.get_cached_by_id(account_id)
150 defp get_author(_params), do: nil