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.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]
32 alias Pleroma.FollowingRelationship
44 deactivated: boolean(),
45 need_approval: boolean(),
47 is_moderator: boolean(),
48 super_users: boolean(),
53 recipients_from_activity: [String.t()],
54 nickname: [String.t()] | String.t(),
62 @ilike_criteria [:nickname, :name, :query]
63 @equal_criteria [:email]
64 @contains_criteria [:ap_id, :nickname]
66 @spec build(Query.t(), criteria()) :: Query.t()
67 def build(query \\ base_query(), criteria) do
68 prepare_query(query, criteria)
71 @spec paginate(Ecto.Query.t(), pos_integer(), pos_integer()) :: Ecto.Query.t()
72 def paginate(query, page, page_size) do
75 offset: ^((page - 1) * page_size)
83 defp prepare_query(query, criteria) do
85 |> Map.put_new(:internal, false)
86 |> Enum.reduce(query, &compose_query/2)
89 defp compose_query({key, value}, query)
90 when key in @ilike_criteria and not_empty_string(value) do
92 key = if key == :query, do: :nickname, else: key
93 where(query, [u], ilike(field(u, ^key), ^"%#{value}%"))
96 defp compose_query({:invisible, bool}, query) when is_boolean(bool) do
97 where(query, [u], u.invisible == ^bool)
100 defp compose_query({key, value}, query)
101 when key in @equal_criteria and not_empty_string(value) do
102 where(query, [u], ^[{key, value}])
105 defp compose_query({key, values}, query) when key in @contains_criteria and is_list(values) do
106 where(query, [u], field(u, ^key) in ^values)
109 defp compose_query({:tags, tags}, query) when is_list(tags) and length(tags) > 0 do
110 where(query, [u], fragment("? && ?", u.tags, ^tags))
113 defp compose_query({:is_admin, bool}, query) do
114 where(query, [u], u.is_admin == ^bool)
117 defp compose_query({:is_moderator, bool}, query) do
118 where(query, [u], u.is_moderator == ^bool)
121 defp compose_query({:super_users, _}, query) do
125 u.is_admin or u.is_moderator
129 defp compose_query({:local, _}, query), do: location_query(query, true)
131 defp compose_query({:external, _}, query), do: location_query(query, false)
133 defp compose_query({:active, _}, query) do
134 User.restrict_deactivated(query)
135 |> where([u], u.approval_pending == false)
138 defp compose_query({:legacy_active, _}, query) do
140 |> where([u], fragment("not (?->'deactivated' @> 'true')", u.info))
143 defp compose_query({:deactivated, false}, query) do
144 User.restrict_deactivated(query)
147 defp compose_query({:deactivated, true}, query) do
148 where(query, [u], u.deactivated == ^true)
151 defp compose_query({:confirmation_pending, bool}, query) do
152 where(query, [u], u.confirmation_pending == ^bool)
155 defp compose_query({:need_approval, _}, query) do
156 where(query, [u], u.approval_pending)
159 defp compose_query({:followers, %User{id: id}}, query) do
161 |> where([u], u.id != ^id)
162 |> join(:inner, [u], r in FollowingRelationship,
164 on: r.following_id == ^id and r.follower_id == u.id
166 |> where([relationships: r], r.state == ^:follow_accept)
169 defp compose_query({:friends, %User{id: id}}, query) do
171 |> where([u], u.id != ^id)
172 |> join(:inner, [u], r in FollowingRelationship,
174 on: r.following_id == u.id and r.follower_id == ^id
176 |> where([relationships: r], r.state == ^:follow_accept)
179 defp compose_query({:recipients_from_activity, to}, query) do
182 join: f in FollowingRelationship,
183 on: u.id == f.following_id,
184 where: f.state == ^:follow_accept,
185 where: u.follower_address in ^to,
186 select: f.follower_id
190 where: u.ap_id in ^to or u.id in subquery(following_query)
194 defp compose_query({:order_by, key}, query) do
195 order_by(query, [u], field(u, ^key))
198 defp compose_query({:select, keys}, query) do
199 select(query, [u], ^keys)
202 defp compose_query({:limit, limit}, query) do
206 defp compose_query({:internal, false}, query) do
208 |> where([u], not is_nil(u.nickname))
209 |> where([u], not like(u.nickname, "internal.%"))
212 defp compose_query(_unsupported_param, query), do: query
214 defp location_query(query, local) do
215 where(query, [u], u.local == ^local)