chore: move "ferron-common" to Ferron itself

DorianNiemiecSVRJS · DorianNiemiecSVRJS · commit cb48884df182 · 2025-03-23T18:22:42.000+01:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,6 @@
 [workspace]
 members = [
     "ferron",
-    "ferron-common",
     "ferron-passwd",
 ]
 resolver = "2"
@@ -10,7 +9,6 @@ resolver = "2"
 hyper = { version = "1.6.0", features = ["http1", "http2", "server"] }
 tokio = { version = "1.43.0", features = ["full"] }
 tokio-test = "0.4.4"
-ferron-common = { path = "./ferron-common" }
 http-body-util = "0.1"
 yaml-rust2 = "0.10.0"
 async-trait = "0.1.86"
diff --git a/ferron-common/Cargo.toml b/ferron-common/Cargo.toml
diff --git a/ferron/Cargo.toml b/ferron/Cargo.toml
@@ -21,7 +21,6 @@ anyhow = "1.0.95"
 futures-util = "0.3.31"
 chrono = "0.4.39"
 async-trait = { workspace = true }
-ferron-common = { workspace = true }
 rustls-native-certs = "0.8.1"
 ocsp-stapler = { version = "0.4.4", default-features = false }
 clap = { version = "4.5.28", features = ["derive"] }
@@ -39,7 +38,7 @@ itertools = { version = "0.14.0", optional = true }
 rand = "0.9.0"
 memmem = { version = "0.1.1", optional = true }
 httparse = { version = "1.10.0", optional = true }
-pin-project-lite = { version = "0.2.16", optional = true }
+pin-project-lite = "0.2.16"
 hashlink = "0.10.0"
 tokio-rustls-acme = "0.6.0"
 glob = "0.3.2"
@@ -57,7 +56,7 @@ cache = ["itertools"]
 cgi = ["httparse", "memmem"]
 example = []
 fauth = []
-fcgi = ["httparse", "memmem", "pin-project-lite"]
+fcgi = ["httparse", "memmem"]
 fproxy = []
 rproxy = []
 scgi = ["httparse", "memmem"]
diff --git a/ferron/src/common/log.rs b/ferron/src/common/log.rs
diff --git a/ferron/src/common/mod.rs b/ferron/src/common/mod.rs
@@ -1,3 +1,5 @@
+#![allow(dead_code)]
+
 use std::{error::Error, future::Future, net::SocketAddr, pin::Pin};
 
 use async_channel::Sender;
@@ -8,7 +10,9 @@ use hyper_tungstenite::HyperWebsocket;
 use tokio::runtime::Handle;
 use yaml_rust2::Yaml;
 
+#[path = "log.rs"]
 mod log;
+#[path = "with_runtime.rs"]
 mod with_runtime;
 
 /// Contains information about a network socket, including remote and local addresses,
@@ -44,7 +48,7 @@ impl SocketData {
 }
 
 /// Represents a log message. This is a type alias for `crate::log::LogMessage`.
-pub type LogMessage = crate::log::LogMessage;
+pub type LogMessage = log::LogMessage;
 
 /// Represents the server configuration object. This is a type alias for `Yaml` from the `yaml_rust2` crate.
 pub type ServerConfig = Yaml;
@@ -60,7 +64,7 @@ pub type HyperUpgraded = Upgraded;
 
 /// A wrapper that ensures a function is executed within a specific runtime context.
 /// This is a type alias for `crate::with_runtime::WithRuntime<F>`.
-pub type WithRuntime<F> = crate::with_runtime::WithRuntime<F>;
+pub type WithRuntime<F> = with_runtime::WithRuntime<F>;
 
 /// Contains data related to an HTTP request, including the original Hyper request
 /// and optional authentication user information.
@@ -175,7 +179,7 @@ impl ErrorLogger {
   /// # Examples
   ///
   /// ```
-  /// # use ferron_common::ErrorLogger;
+  /// # use crate::ferron_common::ErrorLogger;
   /// # #[tokio::main]
   /// # async fn main() {
   /// let (tx, mut rx) = async_channel::bounded(100);
diff --git a/ferron/src/common/with_runtime.rs b/ferron/src/common/with_runtime.rs
diff --git a/ferron/src/main.rs b/ferron/src/main.rs
@@ -12,6 +12,10 @@ mod ferron_res {
   pub mod server_software;
 }
 
+// Import common modules from "common" directory
+#[path = "common/mod.rs"]
+mod ferron_common;
+
 // Import utility modules from "util" directory
 #[path = "util"]
 mod ferron_util {
diff --git a/ferron/src/modules/blocklist.rs b/ferron/src/modules/blocklist.rs
@@ -1,12 +1,12 @@
 use std::error::Error;
 use std::sync::Arc;
 
-use async_trait::async_trait;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperUpgraded, WithRuntime};
+use crate::ferron_common::{HyperUpgraded, WithRuntime};
+use async_trait::async_trait;
 use hyper::StatusCode;
 use hyper_tungstenite::HyperWebsocket;
 use tokio::runtime::Handle;
diff --git a/ferron/src/modules/default_handler_checks.rs b/ferron/src/modules/default_handler_checks.rs
@@ -1,11 +1,11 @@
 use std::error::Error;
 
-use async_trait::async_trait;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperUpgraded, WithRuntime};
+use crate::ferron_common::{HyperUpgraded, WithRuntime};
+use async_trait::async_trait;
 use http_body_util::{BodyExt, Empty};
 use hyper::header::HeaderValue;
 use hyper::{header, HeaderMap, Method, Response, StatusCode};
diff --git a/ferron/src/modules/non_standard_codes.rs b/ferron/src/modules/non_standard_codes.rs
@@ -11,14 +11,14 @@ use crate::ferron_util::non_standard_code_structs::{
 };
 use crate::ferron_util::ttl_cache::TtlCache;
 
-use async_trait::async_trait;
-use base64::{engine::general_purpose, Engine};
-use fancy_regex::RegexBuilder;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperUpgraded, WithRuntime};
+use crate::ferron_common::{HyperUpgraded, WithRuntime};
+use async_trait::async_trait;
+use base64::{engine::general_purpose, Engine};
+use fancy_regex::RegexBuilder;
 use http_body_util::{BodyExt, Empty};
 use hyper::header::HeaderValue;
 use hyper::{header, HeaderMap, Response, StatusCode};
diff --git a/ferron/src/modules/redirect_trailing_slashes.rs b/ferron/src/modules/redirect_trailing_slashes.rs
@@ -3,12 +3,12 @@ use std::path::Path;
 use std::sync::Arc;
 use std::time::Duration;
 
-use async_trait::async_trait;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperUpgraded, WithRuntime};
+use crate::ferron_common::{HyperUpgraded, WithRuntime};
+use async_trait::async_trait;
 use http_body_util::{BodyExt, Empty};
 use hyper::{header, Response, StatusCode};
 use hyper_tungstenite::HyperWebsocket;
diff --git a/ferron/src/modules/redirects.rs b/ferron/src/modules/redirects.rs
@@ -1,11 +1,11 @@
 use std::error::Error;
 
-use async_trait::async_trait;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperUpgraded, WithRuntime};
+use crate::ferron_common::{HyperUpgraded, WithRuntime};
+use async_trait::async_trait;
 use http_body_util::{BodyExt, Empty};
 use hyper::{header, Response, StatusCode, Uri};
 use hyper_tungstenite::HyperWebsocket;
diff --git a/ferron/src/modules/static_file_serving.rs b/ferron/src/modules/static_file_serving.rs
@@ -6,17 +6,17 @@ use std::str::FromStr;
 use std::sync::Arc;
 use std::time::Duration;
 
+use crate::ferron_common::{
+  ErrorLogger, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
+  ServerModuleHandlers, SocketData,
+};
+use crate::ferron_common::{HyperUpgraded, WithRuntime};
 use async_compression::tokio::bufread::{BrotliEncoder, DeflateEncoder, GzipEncoder, ZstdEncoder};
 use async_compression::zstd::CParameter;
 use async_compression::Level;
 use async_trait::async_trait;
 use chrono::offset::Local;
 use chrono::DateTime;
-use ferron_common::{
-  ErrorLogger, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
-  ServerModuleHandlers, SocketData,
-};
-use ferron_common::{HyperUpgraded, WithRuntime};
 use futures_util::TryStreamExt;
 use hashlink::LruCache;
 use http_body_util::{BodyExt, Empty, Full, StreamBody};
diff --git a/ferron/src/modules/url_rewrite.rs b/ferron/src/modules/url_rewrite.rs
@@ -9,13 +9,13 @@ use crate::ferron_util::url_rewrite_structs::{
   UrlRewriteMapEntry, UrlRewriteMapLocationWrap, UrlRewriteMapWrap,
 };
 
-use async_trait::async_trait;
-use fancy_regex::RegexBuilder;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperUpgraded, WithRuntime};
+use crate::ferron_common::{HyperUpgraded, WithRuntime};
+use async_trait::async_trait;
+use fancy_regex::RegexBuilder;
 use hyper::{header, Request, StatusCode};
 use hyper_tungstenite::HyperWebsocket;
 use tokio::fs;
diff --git a/ferron/src/modules/x_forwarded_for.rs b/ferron/src/modules/x_forwarded_for.rs
@@ -1,12 +1,12 @@
 use std::error::Error;
 use std::net::{IpAddr, SocketAddr};
 
-use async_trait::async_trait;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperUpgraded, WithRuntime};
+use crate::ferron_common::{HyperUpgraded, WithRuntime};
+use async_trait::async_trait;
 use hyper::StatusCode;
 use hyper_tungstenite::HyperWebsocket;
 use tokio::runtime::Handle;
diff --git a/ferron/src/optional_modules/cache.rs b/ferron/src/optional_modules/cache.rs
@@ -4,13 +4,13 @@ use std::hash::RandomState;
 use std::sync::Arc;
 use std::time::{Duration, Instant};
 
-use async_trait::async_trait;
-use cache_control::{Cachability, CacheControl};
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperUpgraded, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperResponse, WithRuntime};
+use crate::ferron_common::{HyperResponse, WithRuntime};
+use async_trait::async_trait;
+use cache_control::{Cachability, CacheControl};
 use futures_util::{StreamExt, TryStreamExt};
 use hashlink::LinkedHashMap;
 use http_body_util::{BodyExt, Full, StreamBody};
diff --git a/ferron/src/optional_modules/cgi.rs b/ferron/src/optional_modules/cgi.rs
@@ -6,12 +6,12 @@ use std::process::Stdio;
 use std::sync::Arc;
 use std::time::Duration;
 
-use async_trait::async_trait;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperRequest, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperUpgraded, WithRuntime};
+use crate::ferron_common::{HyperUpgraded, WithRuntime};
+use async_trait::async_trait;
 use futures_util::TryStreamExt;
 use hashlink::LinkedHashMap;
 use http_body_util::{BodyExt, StreamBody};
diff --git a/ferron/src/optional_modules/example.rs b/ferron/src/optional_modules/example.rs
@@ -1,11 +1,11 @@
 use std::error::Error;
 
-use async_trait::async_trait;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperUpgraded, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperResponse, WithRuntime};
+use crate::ferron_common::{HyperResponse, WithRuntime};
+use async_trait::async_trait;
 use http_body_util::{BodyExt, Full};
 use hyper::Response;
 use hyper_tungstenite::HyperWebsocket;
diff --git a/ferron/src/optional_modules/fauth.rs b/ferron/src/optional_modules/fauth.rs
@@ -5,12 +5,12 @@ use std::error::Error;
 use std::str::FromStr;
 use std::sync::Arc;
 
-use async_trait::async_trait;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperUpgraded, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperResponse, WithRuntime};
+use crate::ferron_common::{HyperResponse, WithRuntime};
+use async_trait::async_trait;
 use http_body_util::combinators::BoxBody;
 use http_body_util::{BodyExt, Empty};
 use hyper::body::Bytes;
diff --git a/ferron/src/optional_modules/fcgi.rs b/ferron/src/optional_modules/fcgi.rs
@@ -6,12 +6,12 @@ use std::path::{Path, PathBuf};
 use std::sync::Arc;
 use std::time::Duration;
 
-use async_trait::async_trait;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperRequest, HyperResponse, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperUpgraded, WithRuntime};
+use crate::ferron_common::{HyperUpgraded, WithRuntime};
+use async_trait::async_trait;
 use futures_util::future::Either;
 use futures_util::TryStreamExt;
 use hashlink::LinkedHashMap;
diff --git a/ferron/src/optional_modules/fproxy.rs b/ferron/src/optional_modules/fproxy.rs
@@ -1,12 +1,12 @@
 use std::error::Error;
 use std::str::FromStr;
 
-use async_trait::async_trait;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperUpgraded, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperResponse, WithRuntime};
+use crate::ferron_common::{HyperResponse, WithRuntime};
+use async_trait::async_trait;
 use http_body_util::combinators::BoxBody;
 use http_body_util::BodyExt;
 use hyper::body::Bytes;
diff --git a/ferron/src/optional_modules/rproxy.rs b/ferron/src/optional_modules/rproxy.rs
@@ -4,12 +4,12 @@ use std::str::FromStr;
 use std::sync::Arc;
 use std::time::Duration;
 
-use async_trait::async_trait;
-use ferron_common::{
+use crate::ferron_common::{
   ErrorLogger, HyperUpgraded, RequestData, ResponseData, ServerConfig, ServerModule,
   ServerModuleHandlers, SocketData,
 };
-use ferron_common::{HyperResponse, WithRuntime};
+use crate::ferron_common::{HyperResponse, WithRuntime};
+use async_trait::async_trait;
 use futures_util::{SinkExt, StreamExt};
 use http::uri::{PathAndQuery, Scheme};
 use http_body_util::combinators::BoxBody;
diff --git a/ferron/src/optional_modules/scgi.rs b/ferron/src/optional_modules/scgi.rs
diff --git a/ferron/src/request_handler.rs b/ferron/src/request_handler.rs
diff --git a/ferron/src/server.rs b/ferron/src/server.rs
diff --git a/ferron/src/util/validate_config.rs b/ferron/src/util/validate_config.rs
