1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 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.Utils.Guards, only: [not_empty_string: 1]
32 alias Pleroma.FollowingRelationship
44 deactivated: boolean(),
45 need_approval: boolean(),
46 unconfirmed: boolean(),
48 is_moderator: boolean(),
49 is_suggested: boolean(),
50 is_discoverable: boolean(),
51 super_users: boolean(),
56 recipients_from_activity: [String.t()],
57 nickname: [String.t()] | String.t(),
62 actor_types: [String.t()]
66 @ilike_criteria [:nickname, :name, :query]
67 @equal_criteria [:email]
68 @contains_criteria [:ap_id, :nickname]
70 @spec build(Query.t(), criteria()) :: Query.t()
71 def build(query \\ base_query(), criteria) do
72 prepare_query(query, criteria)
75 @spec paginate(Ecto.Query.t(), pos_integer(), pos_integer()) :: Ecto.Query.t()
76 def paginate(query, page, page_size) do
79 offset: ^((page - 1) * page_size)
87 defp prepare_query(query, criteria) do
89 |> Map.put_new(:internal, false)
90 |> Enum.reduce(query, &compose_query/2)
93 defp compose_query({key, value}, query)
94 when key in @ilike_criteria and not_empty_string(value) do
96 key = if key == :query, do: :nickname, else: key
97 where(query, [u], ilike(field(u, ^key), ^"%#{value}%"))
100 defp compose_query({:invisible, bool}, query) when is_boolean(bool) do
101 where(query, [u], u.invisible == ^bool)
104 defp compose_query({key, value}, query)
105 when key in @equal_criteria and not_empty_string(value) do
106 where(query, [u], ^[{key, value}])
109 defp compose_query({key, values}, query) when key in @contains_criteria and is_list(values) do
110 where(query, [u], field(u, ^key) in ^values)
113 defp compose_query({:tags, tags}, query) when is_list(tags) and length(tags) > 0 do
114 where(query, [u], fragment("? && ?", u.tags, ^tags))
117 defp compose_query({:is_admin, bool}, query) do
118 where(query, [u], u.is_admin == ^bool)
121 defp compose_query({:actor_types, actor_types}, query) when is_list(actor_types) do
122 where(query, [u], u.actor_type in ^actor_types)
125 defp compose_query({:is_moderator, bool}, query) do
126 where(query, [u], u.is_moderator == ^bool)
129 defp compose_query({:super_users, _}, query) do
133 u.is_admin or u.is_moderator
137 defp compose_query({:local, _}, query), do: location_query(query, true)
139 defp compose_query({:external, _}, query), do: location_query(query, false)
141 defp compose_query({:active, _}, query) do
142 where(query, [u], u.is_active == true)
143 |> where([u], u.is_approved == true)
144 |> where([u], u.is_confirmed == true)
147 defp compose_query({:legacy_active, _}, query) do
149 |> where([u], fragment("not (?->'deactivated' @> 'true')", u.info))
152 defp compose_query({:deactivated, false}, query) do
153 where(query, [u], u.is_active == true)
156 defp compose_query({:deactivated, true}, query) do
157 where(query, [u], u.is_active == false)
160 defp compose_query({:confirmation_pending, bool}, query) do
161 where(query, [u], u.is_confirmed != ^bool)
164 defp compose_query({:need_approval, _}, query) do
165 where(query, [u], u.is_approved == false)
168 defp compose_query({:unconfirmed, _}, query) do
169 where(query, [u], u.is_confirmed == false)
172 defp compose_query({:is_suggested, bool}, query) do
173 where(query, [u], u.is_suggested == ^bool)
176 defp compose_query({:is_discoverable, bool}, query) do
177 where(query, [u], u.is_discoverable == ^bool)
180 defp compose_query({:followers, %User{id: id}}, query) do
182 |> where([u], u.id != ^id)
183 |> join(:inner, [u], r in FollowingRelationship,
185 on: r.following_id == ^id and r.follower_id == u.id
187 |> where([relationships: r], r.state == ^:follow_accept)
190 defp compose_query({:friends, %User{id: id}}, query) do
192 |> where([u], u.id != ^id)
193 |> join(:inner, [u], r in FollowingRelationship,
195 on: r.following_id == u.id and r.follower_id == ^id
197 |> where([relationships: r], r.state == ^:follow_accept)
200 defp compose_query({:recipients_from_activity, to}, query) do
203 join: f in FollowingRelationship,
204 on: u.id == f.following_id,
205 where: f.state == ^:follow_accept,
206 where: u.follower_address in ^to,
207 select: f.follower_id
211 where: u.ap_id in ^to or u.id in subquery(following_query)
215 defp compose_query({:order_by, key}, query) do
216 order_by(query, [u], field(u, ^key))
219 defp compose_query({:select, keys}, query) do
220 select(query, [u], ^keys)
223 defp compose_query({:limit, limit}, query) do
227 defp compose_query({:internal, false}, query) do
229 |> where([u], not is_nil(u.nickname))
230 |> where([u], not like(u.nickname, "internal.%"))
233 defp compose_query(_unsupported_param, query), do: query
235 defp location_query(query, local) do
236 where(query, [u], u.local == ^local)