✨ Smart list filter builder

README.md

@@ -42,11 +42,11 @@ Stump is a free and open source comics, manga and digital book server with OPDS
 - [License 📝](#license-)
 </details>
 
-> **🚧 Disclaimer 🚧**: Stump is under active development and is an ongoing **WIP**. Anyone is welcome to try it out, but **DO NOT** expect a fully featured or bug-free experience. If you'd like to contribute and help expedite Stump's first release, please review the [developer guide](#developer-guide-).
+> **🚧 Disclaimer 🚧**: Stump is under active development and is an ongoing **WIP**. Anyone is welcome to try it out, but **DO NOT** expect a fully featured or bug-free experience. If you'd like to contribute and help expedite feature development, please review the [developer guide](#developer-guide-).
 
 ## Roadmap 🗺
 
-The following items are the major targets for Stump's first release:
+The following items are the major targets for Stump's first stable release:
 
 - 📃 Full OPDS + OPDS Page Streaming support
 - 📕 EPUB, PDF, and CBZ/CBR support
@@ -59,7 +59,7 @@ The following items are the major targets for Stump's first release:
 - 🌏 Language support _(look [here](https://github.com/stumpapp/stump/issues/106))_
 - 🌈 And more!
 
-Things you can expect to see after the first release:
+Things you can expect to see afterwards:
 
 - 🖥️ Cross-platform desktop app _(Windows, Mac, Linux)_
 - 📖 [Tachiyomi](https://github.com/stumpapp/tachiyomi-extensions) support

apps/expo/package.json

@@ -28,7 +28,7 @@
 		"nativewind": "^2.0.11",
 		"react": "18.2.0",
 		"react-dom": "18.2.0",
-		"react-hook-form": "^7.50.1",
+		"react-hook-form": "^7.53.0",
 		"react-native": "0.73.4",
 		"react-native-fs": "^2.20.0",
 		"react-native-gesture-handler": "~2.14.0",

apps/server/src/routers/api/v1/smart_list.rs

@@ -113,6 +113,8 @@
 	#[serde(default)]
 	all: Option<bool>,
 	#[serde(default)]
+	mine: Option<bool>,
+	#[serde(default)]
 	search: Option<String>,
 }
 
@@ -141,11 +143,21 @@
 		));
 	}
 
+	let mine = params.mine.unwrap_or(false);
+	if query_all && mine {
+		return Err(APIError::BadRequest(
+			"Cannot query all and mine at the same time".to_string(),
+		));
+	}
+
 	let where_params = chain_optional_iter(
 		[],
 		[
-			(!query_all)
+			// If not querying all, and not querying mine, then we need to filter by access
+			(!query_all && !mine)
 				.then(|| smart_list_access_for_user(&user, AccessRole::Reader.value())),
+			// If querying mine, then we need to filter by the user
+			mine.then(|| smart_list::creator_id::equals(user.id.clone())),
 			params.search.map(|search| {
 				or![
 					smart_list::name::contains(search.clone()),
@@ -174,6 +186,8 @@
 	pub joiner: Option<FilterJoin>,
 	#[serde(default)]
 	pub default_grouping: Option<SmartListItemGrouping>,
+	#[serde(default)]
+	pub visibility: Option<EntityVisibility>,
 }
 
 #[utoipa::path(
@@ -217,6 +231,9 @@
 					input.default_grouping.map(|grouping| {
 						smart_list::default_grouping::set(grouping.to_string())
 					}),
+					input.visibility.map(|visibility| {
+						smart_list::visibility::set(visibility.to_string())
+					}),
 				],
 			),
 		)
@@ -323,6 +340,9 @@
 					input.default_grouping.map(|grouping| {
 						smart_list::default_grouping::set(grouping.to_string())
 					}),
+					input.visibility.map(|visibility| {
+						smart_list::visibility::set(visibility.to_string())
+					}),
 				],
 			),
 		)

core/src/db/filter/smart_filter.rs

@@ -1,6 +1,10 @@
 use std::{fmt::Display, str::FromStr};
 
-use prisma_client_rust::{and, not, or};
+use prisma_client_rust::{
+	and,
+	chrono::{DateTime, FixedOffset},
+	not, or,
+};
 use serde::{Deserialize, Serialize};
 use specta::Type;
 use utoipa::ToSchema;
@@ -15,16 +19,13 @@
 // 1. Performance implications. This is mostly because the assumption for each `into_prisma` call is a single param,
 //    which means for relation filters we will have an `is` call each time. I don't yet know how this actually affects
 //    performance in real-world scenarios, but it's something to keep in mind.
-// 2. Repetition of logic. There is a lot of repetition in the `into_prisma` definitions, and I think there is a way to (maybe)
-//    consolidate them into a single macro. I'm not sure if this is possible, but it's worth looking into. This will get exponentially
-//    worse as things like sorting and sorting on relations are added... :weary:
 
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, ToSchema, Type)]
 #[serde(untagged)]
 /// A filter for a single value, e.g. `name = "test"`
 pub enum Filter<T> {
 	/// A simple equals filter, e.g. `name = "test"`
-	Equals(T),
+	Equals { equals: T },
 	/// A simple not filter, e.g. `name != "test"`
 	Not { not: T },
 	/// A filter for a string that contains a substring, e.g. `name contains "test"`. This should
@@ -71,7 +72,7 @@
 		WhereParam: From<prisma_client_rust::Operator<WhereParam>>,
 	{
 		match self {
-			Filter::Equals(value) => equals_fn(value),
+			Filter::Equals { equals } => equals_fn(equals),
 			Filter::Not { not } => not![equals_fn(not)],
 			Filter::Contains { contains } => contains_fn(contains),
 			Filter::Excludes { excludes } => not![contains_fn(excludes)],
@@ -93,7 +94,7 @@
 		WhereParam: From<prisma_client_rust::Operator<WhereParam>>,
 	{
 		match self {
-			Filter::Equals(value) => equals_fn(Some(value)),
+			Filter::Equals { equals } => equals_fn(Some(equals)),
 			Filter::Not { not } => not![equals_fn(Some(not))],
 			Filter::Contains { contains } => contains_fn(contains),
 			Filter::Excludes { excludes } => not![contains_fn(excludes)],
@@ -102,22 +103,20 @@
 			_ => unreachable!("Numeric filters should be handled elsewhere"),
 		}
 	}
-}
 
-impl Filter<i32> {
 	pub fn into_numeric_params<WhereParam>(
 		self,
-		equals_fn: fn(i32) -> WhereParam,
-		gt_fn: fn(i32) -> WhereParam,
-		gte_fn: fn(i32) -> WhereParam,
-		lt_fn: fn(i32) -> WhereParam,
-		lte_fn: fn(i32) -> WhereParam,
+		equals_fn: fn(T) -> WhereParam,
+		gt_fn: fn(T) -> WhereParam,
+		gte_fn: fn(T) -> WhereParam,
+		lt_fn: fn(T) -> WhereParam,
+		lte_fn: fn(T) -> WhereParam,
 	) -> WhereParam
 	where
 		WhereParam: From<prisma_client_rust::Operator<WhereParam>>,
 	{
 		match self {
-			Filter::Equals(value) => equals_fn(value),
+			Filter::Equals { equals } => equals_fn(equals),
 			Filter::Not { not } => not![equals_fn(not)],
 			Filter::NumericFilter(numeric_filter) => match numeric_filter {
 				NumericFilter::Gt { gt } => gt_fn(gt),
@@ -138,17 +137,17 @@
 
 	pub fn into_optional_numeric_params<WhereParam>(
 		self,
-		equals_fn: fn(Option<i32>) -> WhereParam,
-		gt_fn: fn(i32) -> WhereParam,
-		gte_fn: fn(i32) -> WhereParam,
-		lt_fn: fn(i32) -> WhereParam,
-		lte_fn: fn(i32) -> WhereParam,
+		equals_fn: fn(Option<T>) -> WhereParam,
+		gt_fn: fn(T) -> WhereParam,
+		gte_fn: fn(T) -> WhereParam,
+		lt_fn: fn(T) -> WhereParam,
+		lte_fn: fn(T) -> WhereParam,
 	) -> WhereParam
 	where
 		WhereParam: From<prisma_client_rust::Operator<WhereParam>>,
 	{
 		match self {
-			Filter::Equals(value) => equals_fn(Some(value)),
+			Filter::Equals { equals } => equals_fn(Some(equals)),
 			Filter::Not { not } => not![equals_fn(Some(not))],
 			Filter::NumericFilter(numeric_filter) => match numeric_filter {
 				NumericFilter::Gt { gt } => gt_fn(gt),
@@ -217,11 +216,6 @@
 	}
 }
 
-// pub struct SmartFilterOrder {
-// 	pub direction: Direction,
-// 	pub order_by:
-// }
-
 #[derive(Debug, Clone, Serialize, Deserialize, Type, ToSchema)]
 #[aliases(SmartFilterSchema = SmartFilter<MediaSmartFilter>)]
 pub struct SmartFilter<T> {
@@ -230,9 +224,6 @@
 	pub joiner: FilterJoin,
 }
 
-// TODO: figure out if perhaps macros can come in with the save here. Continuing down this path
-// will be INCREDIBLY verbose..
-
 #[generate_smart_filter]
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Type, ToSchema)]
 #[serde(untagged)]
@@ -335,7 +326,6 @@
 	Inkers { inkers: String },
 	#[is_optional]
 	Editors { editors: String },
-	// FIXME: Current implementationm makes it awkward to support numeric filters
 	#[is_optional]
 	AgeRating { age_rating: i32 },
 	#[is_optional]
@@ -352,8 +342,13 @@
 #[prisma_table("media")]
 pub enum MediaSmartFilter {
 	Name { name: String },
+	Size { size: i64 },
 	Extension { extension: String },
+	CreatedAt { created_at: DateTime<FixedOffset> },
+	UpdatedAt { updated_at: DateTime<FixedOffset> },
+	Status { status: String },
 	Path { path: String },
+	Pages { pages: i32 },
 	Metadata { metadata: MediaMetadataSmartFilter },
 	Series { series: SeriesSmartFilter },
 }
@@ -437,6 +432,83 @@
 		);
 	}
 
+	#[test]
+	fn it_serializes_number_correctly() {
+		let filter: FilterGroup<MediaSmartFilter> = FilterGroup::And {
+			and: vec![MediaSmartFilter::Size {
+				size: Filter::NumericFilter(NumericFilter::Gte { gte: 3000 }),
+			}],
+		};
+
+		let json = serde_json::to_string(&filter).unwrap();
+
+		assert_eq!(json, r#"{"and":[{"size":{"gte":3000}}]}"#);
+	}
+
+	#[test]
+	fn it_deserializes_number_correctly() {
+		let json = r#"{"or":[{"size":{"gte":3000}}]}"#;
+
+		let filter: FilterGroup<MediaSmartFilter> = serde_json::from_str(json).unwrap();
+
+		assert_eq!(
+			filter,
+			FilterGroup::Or {
+				or: vec![MediaSmartFilter::Size {
+					size: Filter::NumericFilter(NumericFilter::Gte { gte: 3000 }),
+				}],
+			}
+		);
+	}
+
+	#[test]
+	fn it_serializes_range_correctly() {
+		let filter: FilterGroup<MediaSmartFilter> = FilterGroup::And {
+			and: vec![MediaSmartFilter::Metadata {
+				metadata: MediaMetadataSmartFilter::AgeRating {
+					age_rating: Filter::NumericFilter(NumericFilter::Range(
+						NumericRange {
+							from: 10,
+							to: 20,
+							inclusive: true,
+						},
+					)),
+				},
+			}],
+		};
+
+		let json = serde_json::to_string(&filter).unwrap();
+
+		assert_eq!(
+			json,
+			r#"{"and":[{"metadata":{"age_rating":{"from":10,"to":20,"inclusive":true}}}]}"#
+		);
+	}
+
+	#[test]
+	fn it_deserializes_range_correctly() {
+		let json = r#"{"and":[{"metadata":{"age_rating":{"from":10,"to":20,"inclusive":true}}}]}"#;
+
+		let filter: FilterGroup<MediaSmartFilter> = serde_json::from_str(json).unwrap();
+
+		assert_eq!(
+			filter,
+			FilterGroup::And {
+				and: vec![MediaSmartFilter::Metadata {
+					metadata: MediaMetadataSmartFilter::AgeRating {
+						age_rating: Filter::NumericFilter(NumericFilter::Range(
+							NumericRange {
+								from: 10,
+								to: 20,
+								inclusive: true,
+							},
+						)),
+					},
+				}],
+			}
+		);
+	}
+
 	fn default_book(name: &str) -> media::Data {
 		media::Data {
 			id: "test-id".to_string(),

docs/pages/faq.md

@@ -33,10 +33,6 @@ The hardware requirements vary and should serve **only as a guide**. Generally s
 
 **This section will be revisited once the first beta release is out.**
 
-## When will Stump be released?
-
-Stump is currently under development. The primary developer is working on it in their free time, mostly on the weekends. There aren't many active contributors, so it's hard to say when it will be release ready. Ideally the first release candidate will be ready by the end of 2024. Please consider contributing to the project if you're interested in expediting the development. You can find more information on ways to contribute in the [contributing](/contributing) guide.
-
 ## Can I try it out?
 
 I am working on setting up a public demo instance. If it is available, you will find it at [demo.stumpapp.dev](https://demo.stumpapp.dev). The login credentials are:

docs/pages/guides/opds.md

@@ -20,17 +20,16 @@ The general structure of the URL to connect to your Stump server is:
 
 The following clients have been tested with Stump:
 
-| OS      |                                      Application                                       | Page Streaming |               Issues/Notes                                                       |
-| ------- | :------------------------------------------------------------------------------------: | -------------: | -------------------------:                                                       |
-| iOS     |                             [Panels](https://panels.app/)                              |             ✅ |                         ✨                                                      |
+| OS      |                                      Application                                       | Page Streaming |                                                                     Issues/Notes |
+| ------- | :------------------------------------------------------------------------------------: | -------------: | -------------------------------------------------------------------------------: |
+| iOS     |                             [Panels](https://panels.app/)                              |             ✅ |                                                                               ✨ |
 | iOS     |     [Chunky Reader](https://apps.apple.com/us/app/chunky-comic-reader/id663567628)     |             ✅ |                                                                                  |
-| Android | [Moon+ Reader](https://play.google.com/store/apps/details?id=com.flyersoft.moonreader) |             ❌ | Users report OK experience                                                       |
-| Android |                         [KyBook 3](http://kybook-reader.com/)                          |             ❌ | No testing at this time                                                          |
-| Android | [Librera](https://play.google.com/store/apps/details?id=com.foobnix.pdf.reader)        |             ❌ | Supports covers, categories, and downloads, but shows file names not book titles |
-| Android | [Cantook by Aldiko](https://play.google.com/store/apps/details?id=com.aldiko.android)  |             ❌ | No auth support, does not work. Use 2.0                                          |
-| Linux   |                     [Foliate](https://johnfactotum.github.io/foliate/)                 |             ❌ | Loads cover previews, file names and categories                                  |
-| Windows |                     [Thorium 3](https://thorium.edrlab.org/en/)                        |             ❌ | Loads cover previews, file names and categories                                  |
-
+| Android | [Moon+ Reader](https://play.google.com/store/apps/details?id=com.flyersoft.moonreader) |             ❌ |                                                       Users report OK experience |
+| Android |                         [KyBook 3](http://kybook-reader.com/)                          |             ❌ |                                                          No testing at this time |
+| Android |    [Librera](https://play.google.com/store/apps/details?id=com.foobnix.pdf.reader)     |             ❌ | Supports covers, categories, and downloads, but shows file names not book titles |
+| Android | [Cantook by Aldiko](https://play.google.com/store/apps/details?id=com.aldiko.android)  |             ❌ |                                          No auth support, does not work. Use 2.0 |
+| Linux   |                   [Foliate](https://johnfactotum.github.io/foliate/)                   |             ❌ |                                  Loads cover previews, file names and categories |
+| Windows |                      [Thorium 3](https://thorium.edrlab.org/en/)                       |             ❌ |                                  Loads cover previews, file names and categories |
 
 If you have any experiences, good or bad, using any of these clients or another client not listed here, please consider updating this page with your findings.
 
@@ -44,10 +43,10 @@ The general structure of the URL to connect to your Stump server is:
 
 The following clients have been tested with Stump:
 
-| OS       |                                    Application                                        | Page Streaming |                                                                                                                         Issues/Notes |
-| ---      | :-----------------------------------------------------------------------------------: | -------------: | -----------------------------------------------------------------------------------------------------------------------------------: |
-| iOS      | [Cantook by Aldiko](https://apps.apple.com/us/app/cantook-by-aldiko/id1476410111)     |             ❓ | Supports catalog traversal and media downloads. Issues with rendering media covers, however this appears to be an issue on their end |
-| Android  | [Cantook by Aldiko](https://play.google.com/store/apps/details?id=com.aldiko.android) |             ❓ | Supports catalog traversal and media downloads. Issues with rendering media covers, however this appears to be an issue on their end |
-| Android  | [Librera](https://play.google.com/store/apps/details?id=com.foobnix.pdf.reader)       |             ❓ | Does not work. Likely lacking OPDS 2.0 support                                                                                       |
-| Linux    |                     [Foliate](https://johnfactotum.github.io/foliate/)                |            ❌ | Loads cover previews, book names, publisher and categories                                                                           |
-| Windows  |                     [Thorium 3](https://thorium.edrlab.org/en/)                       |            ❌ | Loads covers and their previews, book names, publisher and categories                                                                |
+| OS      |                                      Application                                      | Page Streaming |                                                                                                                         Issues/Notes |
+| ------- | :-----------------------------------------------------------------------------------: | -------------: | -----------------------------------------------------------------------------------------------------------------------------------: |
+| iOS     |   [Cantook by Aldiko](https://apps.apple.com/us/app/cantook-by-aldiko/id1476410111)   |             ❓ | Supports catalog traversal and media downloads. Issues with rendering media covers, however this appears to be an issue on their end |
+| Android | [Cantook by Aldiko](https://play.google.com/store/apps/details?id=com.aldiko.android) |             ❓ | Supports catalog traversal and media downloads. Issues with rendering media covers, however this appears to be an issue on their end |
+| Android |    [Librera](https://play.google.com/store/apps/details?id=com.foobnix.pdf.reader)    |             ❓ |                                                                                       Does not work. Likely lacking OPDS 2.0 support |
+| Linux   |                  [Foliate](https://johnfactotum.github.io/foliate/)                   |             ❌ |                                                                           Loads cover previews, book names, publisher and categories |
+| Windows |                      [Thorium 3](https://thorium.edrlab.org/en/)                      |             ❌ |                                                                Loads covers and their previews, book names, publisher and categories |