1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2018 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 @role_criteria [:is_admin, :is_moderator]
60 @contains_criteria [:ap_id, :nickname]
62 @spec build(criteria()) :: Query.t()
63 def build(query \\ base_query(), criteria) do
64 prepare_query(query, criteria)
67 @spec paginate(Ecto.Query.t(), pos_integer(), pos_integer()) :: Ecto.Query.t()
68 def paginate(query, page, page_size) do
71 offset: ^((page - 1) * page_size)
79 defp prepare_query(query, criteria) do
80 Enum.reduce(criteria, query, &compose_query/2)
83 defp compose_query({key, value}, query)
84 when key in @ilike_criteria and not_empty_string(value) do
86 key = if key == :query, do: :nickname, else: key
87 where(query, [u], ilike(field(u, ^key), ^"%#{value}%"))
90 defp compose_query({key, value}, query)
91 when key in @equal_criteria and not_empty_string(value) do
92 where(query, [u], ^[{key, value}])
95 defp compose_query({key, values}, query) when key in @contains_criteria and is_list(values) do
96 where(query, [u], field(u, ^key) in ^values)
99 defp compose_query({:tags, tags}, query) when is_list(tags) and length(tags) > 0 do
100 Enum.reduce(tags, query, &prepare_tag_criteria/2)
103 defp compose_query({key, _}, query) when key in @role_criteria do
104 where(query, [u], fragment("(?->? @> 'true')", u.info, ^to_string(key)))
107 defp compose_query({:super_users, _}, query) do
111 fragment("?->'is_admin' @> 'true' OR ?->'is_moderator' @> 'true'", u.info, u.info)
115 defp compose_query({:local, _}, query), do: location_query(query, true)
117 defp compose_query({:external, _}, query), do: location_query(query, false)
119 defp compose_query({:active, _}, query) do
120 where(query, [u], fragment("not (?->'deactivated' @> 'true')", u.info))
121 |> where([u], not is_nil(u.nickname))
124 defp compose_query({:deactivated, false}, query) do
125 User.restrict_deactivated(query)
128 defp compose_query({:deactivated, true}, query) do
129 where(query, [u], fragment("?->'deactivated' @> 'true'", u.info))
130 |> where([u], not is_nil(u.nickname))
133 defp compose_query({:followers, %User{id: id, follower_address: follower_address}}, query) do
134 where(query, [u], fragment("? <@ ?", ^[follower_address], u.following))
135 |> where([u], u.id != ^id)
138 defp compose_query({:friends, %User{id: id, following: following}}, query) do
139 where(query, [u], u.follower_address in ^following)
140 |> where([u], u.id != ^id)
143 defp compose_query({:recipients_from_activity, to}, query) do
144 where(query, [u], u.ap_id in ^to or fragment("? && ?", u.following, ^to))
147 defp compose_query({:order_by, key}, query) do
148 order_by(query, [u], field(u, ^key))
151 defp compose_query({:select, keys}, query) do
152 select(query, [u], ^keys)
155 defp compose_query({:limit, limit}, query) do
159 defp compose_query(_unsupported_param, query), do: query
161 defp prepare_tag_criteria(tag, query) do
162 or_where(query, [u], fragment("? = any(?)", ^tag, u.tags))
165 defp location_query(query, local) do
166 where(query, [u], u.local == ^local)
167 |> where([u], not is_nil(u.nickname))