Filtering Overhaul (#2207)

* Implemented the first version of dynamic filtering which is all Extension based.

* Implemented basic generic property filter for expanded metadata filtering.

* Fixed up the code to allow for nested properties and fixed up the Contains to work only for IList's

* Started refactoring for the new approach

* More progress, need to rethink a few filters like read progress to be % based and people needs to be more explicit.

* Refactored most of the existing filtering operations into dedicate extensions for the appropriate comparisons. People still need to be reworked to be more dynamic.

* Fixed a bug with continue point where it fails on chapters or volumes tagged with a range

* Wired up a basic api path to start building groups. No and/or support yet.

* Started on the UI

* Made a bit of progress on the UI as I'm putting the pieces together about how to design it.

* Refactored names to make it more consistent. New thinking is we will have one row that will take a filter statement and manipulate it. It will emit said statement and a builder will turn into the higher level statement.

* Started working on updating code to use new inject() method.

* Fixed the code to switch the comparisons.

* Added dynamic input structure in and moved add/remove to the builder.

* Fixed an enum bug

* Hooked in basic dropdown support that is dynamic to the field. Only language is missing as that needs a DTO change (but don't want to break API)

* Fixed a bug where dropdown options wouldn't re-populate when switching fields that are both dropdowns

* Started adding metadata builder

* Fixed when typing on filter row the focus resetting

* Refactored to add an additional component which handles the compounding of filter rows.

* Started hooking up v2 dto in the UI to send to the backend.

* Started working on building group UI for and/or support.

* Lots of backend code fixes to ensure OR and AND statements combine correctly.

* More trying to figure out how to write the UI code

* Started debugging to remember what I was last doing.

* Lots of progress towards building out the UI recursively

* I got the dto to build and propagate up the chain

* Started hooking up to the actual api to fetch the data.

* Basic wire up to the backend is working.

* HasName is now complete

* Refactored SortOptions code into an extension and streamlined LimitTo to the correct place.

* Fixed a bug where Library Filters from the Group weren't actually being taken into account.

* Refactored a lot of code so builder will now export the full dto.

* Cleaned up the data flow from metadata filter to library detail

* Got the dropdown to load preset values on first load, but now it triggers twice.

* Changed so when you add a new filter, it does it at top and fixed remove

* Fixed the remove button being on the wrong row

* Cleaned up the arrays to make it easier to manage

* Cleaned up some of the backend to ensure it doesn't throw an incorrect exception

* I'm starting to tread water, taking a break

* Fixed a merge issue

* Cleaned up Docker checks.

* Default IpAddresses to empty string.

* Refactored IsDocker to be completely static

* Figured out the issue with the dropdown not working.

* Almost got it, but the event isn't being called.

* I think i might try something else. This doesn't seem to be working.

* On the new implementation, implemented remove group.

* Use enums to reduce copy/paste

* the new system is working pretty well, ill go with it and move on. Can alwasy refactor.

* Code is totally broken, but working the cache resume code with some hiccups.

* I need to take a break

* Stashing my broken code. I have an idea on how to serialize to the URL, but I need to rearchitect a lot.

* Reverted last commit

* remove domain

* Fixed up some hardcoded caching. I'm giving up on this implementation and going to a simpler version

* Refactored the backend to just allow flat filtering.

* Started refactoring the components to make it flat filtering only.

* Finished refactoring so that the base preset case will render.

* Implemented basic query functionality on desktop. Clear needs some work and url code.

* Some cleanup

* Working on filtering url encode/decode

* Interacting with filters now saves to url and can be reloaded from the url. Named filters is not hooked up.

* Fixed a double load on the library detail page.

* Moved the library filtering code out of the FilterBuilder as it needs to be handled differently.

* Fixed up how we handle library statements in the filter.

* Fixed up how links that perform a filter work.

* Refactored a bunch of linking to a search page.

* LimitTo works, my css however does not.

* Switched some code to use localized strings.

* Cleaned up some css

* Hooked up Languages and put some additional code in so that Languages will return invalid Language codes back.

* Removed a duplicate language signature.

* Hooked up ability to preload collection tag.

* Want To Read is converted

* Converted lots of code to new filtering system. Need to do Bookmarks.

* Fixed a potential bug with default filter creation.

* Hooked up the ability to disable certain filter fields from appearing.

* Added mobile drawer code and a hook for Robbie to take a look for some css.

* Converted the APIs for dashboard along with other safety fixes to ensure bad data doesn't break any of the filtering apis

* Added the backend code to handle summary query

* Converted Want to Read api properly now.

* Fixed the HasReadingProgress query

* Hooked back the Reading Progress for legacy APIs

* Fixed some bad localization strings

* Wrote the filtering code for all-bookmarks.

* OPDS is now using the new filter

* Fixed OPDS reading lists and covers not sending their images.

* Fixed up the OPDS feed and fixed a bug where libraries also weren't sending their images over OPDS

* All but dropdown options have been validated and tested.

* Fixed up some default cases for setting up the filter.

* Sorted filter fields and re-keyed to be better suited based on user's needs.

Fixed a bug where OPDS Series (from library view) wasn't showing the summary.

Moved the (Format) from the title to the description to make the UX much better for OPDS.

MOved

* don't send empty summaries in the new summary formatting

* Fixed up some default cases for setting up the filter.

* Fixed the reset button

* Fixed infinite scroller not having correct scope key

* Added localization to the new components and removed old debug code

* Styling fixes

* Fixed deep linking across the app. Made it so you can click Characters from Reading list and open a filtered search.

* A bit of styling for mobile

* Don't show language if it's not properly set

---------

Co-authored-by: Robbie Davis <robbie@therobbiedavis.com>

API/DTOs/Filtering/v2/FilterCombination.cs

@@ -0,0 +1,7 @@
+namespace API.DTOs.Filtering.v2;
+
+public enum FilterCombination
+{
+    Or = 0,
+    And = 1
+}

API/DTOs/Filtering/v2/FilterComparision.cs

@@ -0,0 +1,51 @@
+using System.ComponentModel;
+
+namespace API.DTOs.Filtering.v2;
+
+public enum FilterComparison
+{
+    [Description("Equal")]
+    Equal = 0,
+    GreaterThan = 1,
+    GreaterThanEqual = 2,
+    LessThan = 3,
+    LessThanEqual = 4,
+    /// <summary>
+    ///
+    /// </summary>
+    /// <remarks>Only works with IList</remarks>
+    Contains = 5,
+    /// <summary>
+    /// Performs a LIKE %value%
+    /// </summary>
+    Matches = 6,
+    NotContains = 7,
+    /// <summary>
+    /// Not Equal to
+    /// </summary>
+    NotEqual = 9,
+    /// <summary>
+    /// String starts with
+    /// </summary>
+    BeginsWith = 10,
+    /// <summary>
+    /// String ends with
+    /// </summary>
+    EndsWith = 11,
+    /// <summary>
+    /// Is Date before X
+    /// </summary>
+    IsBefore = 12,
+    /// <summary>
+    /// Is Date after X
+    /// </summary>
+    IsAfter = 13,
+    /// <summary>
+    /// Is Date between now and X seconds ago
+    /// </summary>
+    IsInLast = 14,
+    /// <summary>
+    /// Is Date not between now and X seconds ago
+    /// </summary>
+    IsNotInLast = 15,
+}

API/DTOs/Filtering/v2/FilterField.cs

@@ -0,0 +1,32 @@
+namespace API.DTOs.Filtering.v2;
+
+/// <summary>
+/// Represents the field which will dictate the value type and the Extension used for filtering
+/// </summary>
+public enum FilterField
+{
+    Summary = 0,
+    SeriesName = 1,
+    PublicationStatus = 2,
+    Languages = 3,
+    AgeRating = 4,
+    UserRating = 5,
+    Tags = 6,
+    CollectionTags = 7,
+    Translators = 8,
+    Characters = 9,
+    Publisher = 10,
+    Editor = 11,
+    CoverArtist = 12,
+    Letterer = 13,
+    Colorist = 14,
+    Inker = 15,
+    Penciller = 16,
+    Writers = 17,
+    Genres = 18,
+    Libraries = 19,
+    ReadProgress = 20,
+    Formats = 21,
+    ReleaseYear = 22,
+    ReadTime = 23
+}

API/DTOs/Filtering/v2/FilterStatementDto.cs

@@ -0,0 +1,8 @@
+namespace API.DTOs.Filtering.v2;
+
+public class FilterStatementDto
+{
+    public FilterComparison Comparison { get; set; }
+    public FilterField Field { get; set; }
+    public string Value { get; set; }
+}

API/DTOs/Filtering/v2/FilterV2Dto.cs

@@ -0,0 +1,30 @@
+using System.Collections.Generic;
+
+
+namespace API.DTOs.Filtering.v2;
+
+
+
+/// <summary>
+/// Metadata filtering for v2 API only
+/// </summary>
+public class FilterV2Dto
+{
+    /// <summary>
+    /// The name of the filter
+    /// </summary>
+    public string? Name { get; set; }
+    public ICollection<FilterStatementDto> Statements { get; set; } = new List<FilterStatementDto>();
+    public FilterCombination Combination { get; set; } = FilterCombination.And;
+    public SortOptions SortOptions { get; set; }
+
+    /// <summary>
+    /// Limit the number of rows returned. Defaults to not applying a limit (aka 0)
+    /// </summary>
+    public int LimitTo { get; set; } = 0;
+}
+
+
+
+
+