Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New filter_id query #429

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/philomena/filters/filter.ex
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ defmodule Philomena.Filters.Filter do
|> validate_required([:name])
|> validate_my_downvotes(:spoilered_complex_str)
|> validate_my_downvotes(:hidden_complex_str)
|> validate_query(:spoilered_complex_str, &Query.compile(&1, user: user))
|> validate_query(:hidden_complex_str, &Query.compile(&1, user: user))
|> validate_query(:spoilered_complex_str, &Query.compile(&1, user: user, filter: true))
|> validate_query(:hidden_complex_str, &Query.compile(&1, user: user, filter: true))
|> unsafe_validate_unique([:user_id, :name], Repo)
end

Expand Down
96 changes: 76 additions & 20 deletions lib/philomena/images/query.ex
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
defmodule Philomena.Images.Query do
alias PhilomenaQuery.Parse.Parser
alias Philomena.Repo
alias Philomena.Filters.Filter
import Ecto.Query

defp gallery_id_transform(_ctx, value) do
case Integer.parse(value) do
Expand All @@ -12,6 +14,29 @@ defmodule Philomena.Images.Query do
end
end

defp filter_id_transform(%{filter: true}, _value),
do: {:error, "Filter queries inside filters are not allowed."}

defp filter_id_transform(%{user: user} = ctx, value) do
with {value, ""} <- Integer.parse(value),
{:ok, filter} <- Map.fetch(ctx.filters, value),
true <- Canada.Can.can?(user, :show, filter) do
ctx = Map.merge(ctx, %{filter: true})

{:ok,
%{
bool: %{
must_not: [
%{terms: %{tag_ids: filter.hidden_tag_ids}},
invalid_filter_guard(ctx, filter.hidden_complex_str)
]
}
}}
else
_ -> {:error, "Invalid filter `#{value}`."}
end
end

defp user_my_transform(%{user: %{id: id}}, "faves"),
do: {:ok, %{term: %{favourited_by_user_ids: id}}}

Expand Down Expand Up @@ -59,8 +84,8 @@ defmodule Philomena.Images.Query do
defp user_my_transform(_ctx, _value),
do: {:error, "Unknown `my' value."}

defp invalid_filter_guard(ctx, search_string) do
case parse(user_fields(), ctx, PhilomenaQuery.Parse.String.normalize(search_string)) do
defp invalid_filter_guard(%{user: user} = ctx, search_string) do
case parse(fields_for(user), ctx, PhilomenaQuery.Parse.String.normalize(search_string)) do
{:ok, query} -> query
_error -> %{match_all: %{}}
end
Expand Down Expand Up @@ -92,9 +117,12 @@ defmodule Philomena.Images.Query do
~W(faved_by orig_sha512_hash sha512_hash uploader source_url original_format mime_type file_name),
bool_fields: ~W(animated processed thumbnails_generated),
ngram_fields: ~W(description),
custom_fields: ~W(gallery_id),
custom_fields: ~W(gallery_id filter_id),
default_field: {"namespaced_tags.name", :term},
transforms: %{"gallery_id" => &gallery_id_transform/2},
transforms: %{
"gallery_id" => &gallery_id_transform/2,
"filter_id" => &filter_id_transform/2
},
aliases: %{
"faved_by" => "favourited_by_users",
"faved_by_id" => "favourited_by_user_ids"
Expand Down Expand Up @@ -138,28 +166,56 @@ defmodule Philomena.Images.Query do
)
end

defp parse_filter_ids(query_string),
do:
Regex.scan(~r/\bfilter_id:(\d+)/, query_string, capture: :all_but_first)
|> List.flatten()
|> Enum.map(&String.to_integer/1)
|> Enum.filter(&(&1 <= 2_147_483_647))

defp load_filters([], _context), do: {:ok, %{}}

defp load_filters(_ids, %{filter: true}),
do: {:error, "Filter queries inside filters are not allowed."}

defp load_filters(ids, _context) do
filters =
Filter
|> where([f], f.id in ^ids)
|> Repo.all()
|> Map.new(&{&1.id, &1})

{:ok, filters}
end

defp prepare_context(context, query_string) do
with {:ok, filters} <- query_string |> parse_filter_ids() |> load_filters(context) do
{:ok, Map.merge(context, %{filters: filters})}
end
Comment on lines +192 to +194
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if there's only one point where the pattern diverges, case is usually preferred over with

query_string
|> parse_filter_ids()
|> load_filters(context)
|> case do
  {:ok, filters} ->
     {:ok, Map.put(context, :filters, filters)}

  err ->
     err
end

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did it like this in case prepare_context ever needs to do more work than load filters but I can change it if you want

end

defp parse(fields, context, query_string) do
fields
|> Parser.new()
|> Parser.parse(query_string, context)
case prepare_context(context, query_string) do
{:ok, context} ->
fields
|> Parser.new()
|> Parser.parse(query_string, context)

{:error, error} ->
{:error, error}
end
end

defp fields_for(nil), do: anonymous_fields()
defp fields_for(%{role: role}) when role in ~W(user assistant), do: user_fields()
defp fields_for(%{role: role}) when role in ~W(moderator admin), do: moderator_fields()
defp fields_for(_), do: raise(ArgumentError, "Unknown user role.")

def compile(query_string, opts \\ []) do
user = Keyword.get(opts, :user)
watch = Keyword.get(opts, :watch, false)
filter = Keyword.get(opts, :filter, false)

case user do
nil ->
parse(anonymous_fields(), %{user: nil, watch: watch}, query_string)

%{role: role} when role in ~W(user assistant) ->
parse(user_fields(), %{user: user, watch: watch}, query_string)

%{role: role} when role in ~W(moderator admin) ->
parse(moderator_fields(), %{user: user, watch: watch}, query_string)

_ ->
raise ArgumentError, "Unknown user role."
end
parse(fields_for(user), %{user: user, watch: watch, filter: filter}, query_string)
end
end
3 changes: 3 additions & 0 deletions lib/philomena_query/ecto/query_validator.ex
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ defmodule PhilomenaQuery.Ecto.QueryValidator do
{:ok, _} <- callback.(value) do
changeset
else
{:error, msg} ->
add_error(changeset, attr, "is invalid: #{msg}")

_ ->
add_error(changeset, attr, "is invalid")
end
Expand Down
2 changes: 1 addition & 1 deletion lib/philomena_web/plugs/filter_forced_users_plug.ex
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ defmodule PhilomenaWeb.FilterForcedUsersPlug do
defp compile_filter(user, search_string) do
search_string
|> String.normalize()
|> Query.compile(user: user)
|> Query.compile(user: user, filter: true)
|> case do
{:ok, query} -> query
_error -> %{match_all: %{}}
Expand Down
2 changes: 1 addition & 1 deletion lib/philomena_web/plugs/image_filter_plug.ex
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ defmodule PhilomenaWeb.ImageFilterPlug do
defp invalid_filter_guard(user, search_string) do
search_string
|> String.normalize()
|> Query.compile(user: user)
|> Query.compile(user: user, filter: true)
|> case do
{:ok, query} -> query
_error -> %{match_all: %{}}
Expand Down