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(),
46 is_moderator: boolean(),
47 super_users: boolean(),
50 recipients_from_activity: [String.t()],
51 nickname: [String.t()] | String.t(),
59 @ilike_criteria [:nickname, :name, :query]
60 @equal_criteria [:email]
61 @contains_criteria [:ap_id, :nickname]
63 @spec build(criteria()) :: Query.t()
64 def build(query \\ base_query(), criteria) do
65 prepare_query(query, criteria)
68 @spec paginate(Ecto.Query.t(), pos_integer(), pos_integer()) :: Ecto.Query.t()
69 def paginate(query, page, page_size) do
72 offset: ^((page - 1) * page_size)
80 defp prepare_query(query, criteria) do
81 Enum.reduce(criteria, query, &compose_query/2)
84 defp compose_query({key, value}, query)
85 when key in @ilike_criteria and not_empty_string(value) do
87 key = if key == :query, do: :nickname, else: key
88 where(query, [u], ilike(field(u, ^key), ^"%#{value}%"))
91 defp compose_query({key, value}, query)
92 when key in @equal_criteria and not_empty_string(value) do
93 where(query, [u], ^[{key, value}])
96 defp compose_query({key, values}, query) when key in @contains_criteria and is_list(values) do
97 where(query, [u], field(u, ^key) in ^values)
100 defp compose_query({:tags, tags}, query) when is_list(tags) and length(tags) > 0 do
101 Enum.reduce(tags, query, &prepare_tag_criteria/2)
104 defp compose_query({:is_admin, _}, query) do
105 where(query, [u], u.is_admin)
108 defp compose_query({:is_moderator, _}, query) do
109 where(query, [u], u.is_moderator)
112 defp compose_query({:super_users, _}, query) do
116 u.is_admin or u.is_moderator
120 defp compose_query({:local, _}, query), do: location_query(query, true)
122 defp compose_query({:external, _}, query), do: location_query(query, false)
124 defp compose_query({:active, _}, query) do
125 User.restrict_deactivated(query)
126 |> where([u], not is_nil(u.nickname))
129 defp compose_query({:legacy_active, _}, query) do
131 |> where([u], fragment("not (?->'deactivated' @> 'true')", u.info))
132 |> where([u], not is_nil(u.nickname))
135 defp compose_query({:deactivated, false}, query) do
136 User.restrict_deactivated(query)
139 defp compose_query({:deactivated, true}, query) do
140 where(query, [u], u.deactivated == ^true)
141 |> where([u], not is_nil(u.nickname))
144 defp compose_query({:followers, %User{id: id}}, query) do
146 |> where([u], u.id != ^id)
147 |> join(:inner, [u], r in FollowingRelationship,
149 on: r.following_id == ^id and r.follower_id == u.id
151 |> where([relationships: r], r.state == "accept")
154 defp compose_query({:friends, %User{id: id}}, query) do
156 |> where([u], u.id != ^id)
157 |> join(:inner, [u], r in FollowingRelationship,
159 on: r.following_id == u.id and r.follower_id == ^id
161 |> where([relationships: r], r.state == "accept")
164 defp compose_query({:recipients_from_activity, to}, query) do
166 |> join(:left, [u], r in FollowingRelationship,
168 on: r.follower_id == u.id
170 |> join(:left, [relationships: r], f in User,
172 on: f.id == r.following_id
175 [u, following: f, relationships: r],
176 u.ap_id in ^to or (f.follower_address in ^to and r.state == "accept")
181 defp compose_query({:order_by, key}, query) do
182 order_by(query, [u], field(u, ^key))
185 defp compose_query({:select, keys}, query) do
186 select(query, [u], ^keys)
189 defp compose_query({:limit, limit}, query) do
193 defp compose_query(_unsupported_param, query), do: query
195 defp prepare_tag_criteria(tag, query) do
196 or_where(query, [u], fragment("? = any(?)", ^tag, u.tags))
199 defp location_query(query, local) do
200 where(query, [u], u.local == ^local)
201 |> where([u], not is_nil(u.nickname))