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(%{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()],
54 @ilike_criteria [:nickname, :name, :query]
55 @equal_criteria [:email]
56 @role_criteria [:is_admin, :is_moderator]
57 @contains_criteria [:ap_id, :nickname]
59 @spec build(criteria()) :: Query.t()
60 def build(query \\ base_query(), criteria) do
61 prepare_query(query, criteria)
64 @spec paginate(Ecto.Query.t(), pos_integer(), pos_integer()) :: Ecto.Query.t()
65 def paginate(query, page, page_size) do
68 offset: ^((page - 1) * page_size)
76 defp prepare_query(query, criteria) do
77 Enum.reduce(criteria, query, &compose_query/2)
80 defp compose_query({key, value}, query)
81 when key in @ilike_criteria and not_empty_string(value) do
83 key = if key == :query, do: :nickname, else: key
84 where(query, [u], ilike(field(u, ^key), ^"%#{value}%"))
87 defp compose_query({key, value}, query)
88 when key in @equal_criteria and not_empty_string(value) do
89 where(query, [u], ^[{key, value}])
92 defp compose_query({key, values}, query) when key in @contains_criteria and is_list(values) do
93 where(query, [u], field(u, ^key) in ^values)
96 defp compose_query({:tags, tags}, query) when is_list(tags) and length(tags) > 0 do
97 Enum.reduce(tags, query, &prepare_tag_criteria/2)
100 defp compose_query({key, _}, query) when key in @role_criteria do
101 where(query, [u], fragment("(?->? @> 'true')", u.info, ^to_string(key)))
104 defp compose_query({:super_users, _}, query) do
108 fragment("?->'is_admin' @> 'true' OR ?->'is_moderator' @> 'true'", u.info, u.info)
112 defp compose_query({:local, _}, query), do: location_query(query, true)
114 defp compose_query({:external, _}, query), do: location_query(query, false)
116 defp compose_query({:active, _}, query) do
117 where(query, [u], fragment("not (?->'deactivated' @> 'true')", u.info))
118 |> where([u], not is_nil(u.nickname))
121 defp compose_query({:deactivated, false}, query) do
122 User.restrict_deactivated(query)
125 defp compose_query({:deactivated, true}, query) do
126 where(query, [u], fragment("?->'deactivated' @> 'true'", u.info))
127 |> where([u], not is_nil(u.nickname))
130 defp compose_query({:followers, %User{id: id, follower_address: follower_address}}, query) do
131 where(query, [u], fragment("? <@ ?", ^[follower_address], u.following))
132 |> where([u], u.id != ^id)
135 defp compose_query({:friends, %User{id: id, following: following}}, query) do
136 where(query, [u], u.follower_address in ^following)
137 |> where([u], u.id != ^id)
140 defp compose_query({:recipients_from_activity, to}, query) do
141 where(query, [u], u.ap_id in ^to or fragment("? && ?", u.following, ^to))
144 defp compose_query(_unsupported_param, query), do: query
146 defp prepare_tag_criteria(tag, query) do
147 or_where(query, [u], fragment("? = any(?)", ^tag, u.tags))
150 defp location_query(query, local) do
151 where(query, [u], u.local == ^local)
152 |> where([u], not is_nil(u.nickname))