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.Query do
7 User query builder module. Builds query from new query or another user query.
10 query = Pleroma.User.Query.build(%{nickname: "nickname"})
11 another_query = Pleroma.User.Query.build(query, %{email: "email@example.com"})
12 Pleroma.Repo.all(query)
13 Pleroma.Repo.all(another_query)
17 - add field to @ilike_criteria list
18 - pass non empty string
19 - e.g. Pleroma.User.Query.build(%{nickname: "nickname"})
21 - add field to @equal_criteria list
22 - pass non empty string
23 - e.g. Pleroma.User.Query.build(%{email: "email@example.com"})
25 - add field to @containns_criteria list
27 - e.g. Pleroma.User.Query.build(%{ap_id: ["http://ap_id1", "http://ap_id2"]})
30 import Pleroma.Web.AdminAPI.Search, only: [not_empty_string: 1]
42 deactivated: boolean(),
44 is_moderator: boolean(),
45 super_users: boolean(),
48 recipients_from_activity: [String.t()],
49 nickname: [String.t()],
57 @ilike_criteria [:nickname, :name, :query]
58 @equal_criteria [:email]
59 @contains_criteria [:ap_id, :nickname]
61 @spec build(criteria()) :: Query.t()
62 def build(query \\ base_query(), criteria) do
63 prepare_query(query, criteria)
66 @spec paginate(Ecto.Query.t(), pos_integer(), pos_integer()) :: Ecto.Query.t()
67 def paginate(query, page, page_size) do
70 offset: ^((page - 1) * page_size)
78 defp prepare_query(query, criteria) do
79 Enum.reduce(criteria, query, &compose_query/2)
82 defp compose_query({key, value}, query)
83 when key in @ilike_criteria and not_empty_string(value) do
85 key = if key == :query, do: :nickname, else: key
86 where(query, [u], ilike(field(u, ^key), ^"%#{value}%"))
89 defp compose_query({key, value}, query)
90 when key in @equal_criteria and not_empty_string(value) do
91 where(query, [u], ^[{key, value}])
94 defp compose_query({key, values}, query) when key in @contains_criteria and is_list(values) do
95 where(query, [u], field(u, ^key) in ^values)
98 defp compose_query({:tags, tags}, query) when is_list(tags) and length(tags) > 0 do
99 Enum.reduce(tags, query, &prepare_tag_criteria/2)
102 defp compose_query({:is_admin, _}, query) do
103 where(query, [u], u.is_admin)
106 defp compose_query({:is_moderator, _}, query) do
107 where(query, [u], u.is_moderator)
110 defp compose_query({:super_users, _}, query) do
114 u.is_admin or u.is_moderator
118 defp compose_query({:local, _}, query), do: location_query(query, true)
120 defp compose_query({:external, _}, query), do: location_query(query, false)
122 defp compose_query({:active, _}, query) do
123 User.restrict_deactivated(query)
124 |> where([u], not is_nil(u.nickname))
127 defp compose_query({:legacy_active, _}, query) do
129 |> where([u], fragment("not (?->'deactivated' @> 'true')", u.info))
130 |> where([u], not is_nil(u.nickname))
133 defp compose_query({:deactivated, false}, query) do
134 User.restrict_deactivated(query)
137 defp compose_query({:deactivated, true}, query) do
138 where(query, [u], u.deactivated == ^true)
139 |> where([u], not is_nil(u.nickname))
142 defp compose_query({:followers, %User{id: id, follower_address: follower_address}}, query) do
143 where(query, [u], fragment("? <@ ?", ^[follower_address], u.following))
144 |> where([u], u.id != ^id)
147 defp compose_query({:friends, %User{id: id, following: following}}, query) do
148 where(query, [u], u.follower_address in ^following)
149 |> where([u], u.id != ^id)
152 defp compose_query({:recipients_from_activity, to}, query) do
153 where(query, [u], u.ap_id in ^to or fragment("? && ?", u.following, ^to))
156 defp compose_query({:order_by, key}, query) do
157 order_by(query, [u], field(u, ^key))
160 defp compose_query({:select, keys}, query) do
161 select(query, [u], ^keys)
164 defp compose_query({:limit, limit}, query) do
168 defp compose_query(_unsupported_param, query), do: query
170 defp prepare_tag_criteria(tag, query) do
171 or_where(query, [u], fragment("? = any(?)", ^tag, u.tags))
174 defp location_query(query, local) do
175 where(query, [u], u.local == ^local)
176 |> where([u], not is_nil(u.nickname))