Merge pull request #55 from neon-mmd/put-the-themes-on-different-paths

Cargo.lock

@@ -1242,9 +1242,9 @@ dependencies = [
 
 [[package]]
 name = "io-lifetimes"
-version = "1.0.10"
+version = "1.0.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9c66c74d2ae7e79a5a8f7ac924adbe38ee42a859c6539ad869eb51f0b52dc220"
+checksum = "eae7b9aee968036d54dce06cebaefd919e4472e753296daccd6d344e3e2df0c2"
 dependencies = [
  "hermit-abi 0.3.1",
  "libc",
@@ -3319,7 +3319,7 @@ dependencies = [
 
 [[package]]
 name = "websurfx"
-version = "0.8.0"
+version = "0.9.0"
 dependencies = [
  "actix-files",
  "actix-web",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "websurfx"
-version = "0.8.0"
+version = "0.9.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

src/handler/mod.rs

@@ -0,0 +1 @@
+pub mod public_path_handler;

src/handler/public_path_handler.rs

@@ -0,0 +1,31 @@
+//! This module provides the functionality to handle theme folder present on different paths and
+//! provide one appropriate path on which it is present and can be used.
+
+use std::io::Error;
+use std::path::Path;
+
+// ------- Constants --------
+static PUBLIC_DIRECTORY_NAME: &str = "public";
+
+/// A function which returns an appropriate theme directory path checking if the theme
+/// directory exists on that path.
+///
+/// # Error
+///
+/// Returns a `Theme (public) folder not found!!` error if the theme folder is not present under following
+/// paths which are:
+/// 1. `/opt/websurfx` if it not present here then it fallbacks to the next one (2)
+/// 2. Under project folder ( or codebase in other words) if it is not present
+///    here then it returns an error as mentioned above.
+pub fn handle_different_public_path() -> Result<String, Error> {
+    if Path::new(format!("/opt/websurfx/{}/", PUBLIC_DIRECTORY_NAME).as_str()).exists() {
+        Ok(format!("/opt/websurfx/{}", PUBLIC_DIRECTORY_NAME))
+    } else if Path::new(format!("./{}/", PUBLIC_DIRECTORY_NAME).as_str()).exists() {
+        Ok(format!("./{}", PUBLIC_DIRECTORY_NAME))
+    } else {
+        Err(Error::new(
+            std::io::ErrorKind::NotFound,
+            "Themes (public) folder not found!!",
+        ))
+    }
+}

src/lib.rs

@@ -4,6 +4,7 @@
 pub mod cache;
 pub mod config_parser;
 pub mod engines;
+pub mod handler;
 pub mod search_results_handler;
 pub mod server;
 
@@ -15,6 +16,7 @@ use actix_files as fs;
 use actix_web::{dev::Server, middleware::Logger, web, App, HttpServer};
 use config_parser::parser::Config;
 use handlebars::Handlebars;
+use handler::public_path_handler::handle_different_public_path;
 
 /// Runs the web server on the provided TCP listener and returns a `Server` instance.
 ///
@@ -39,8 +41,10 @@ use handlebars::Handlebars;
 pub fn run(listener: TcpListener, config: Config) -> std::io::Result<Server> {
     let mut handlebars: Handlebars = Handlebars::new();
 
+    let public_folder_path: String = handle_different_public_path()?;
+
     handlebars
-        .register_templates_directory(".html", "./public/templates")
+        .register_templates_directory(".html", format!("{}/templates", public_folder_path))
         .unwrap();
 
     let handlebars_ref: web::Data<Handlebars> = web::Data::new(handlebars);
@@ -51,8 +55,14 @@ pub fn run(listener: TcpListener, config: Config) -> std::io::Result<Server> {
             .app_data(web::Data::new(config.clone()))
             .wrap(Logger::default()) // added logging middleware for logging.
             // Serve images and static files (css and js files).
-            .service(fs::Files::new("/static", "./public/static").show_files_listing())
-            .service(fs::Files::new("/images", "./public/images").show_files_listing())
+            .service(
+                fs::Files::new("/static", format!("{}/static", public_folder_path))
+                    .show_files_listing(),
+            )
+            .service(
+                fs::Files::new("/images", format!("{}/images", public_folder_path))
+                    .show_files_listing(),
+            )
             .service(routes::robots_data) // robots.txt
             .service(routes::index) // index page
             .service(routes::search) // search page

src/server/routes.rs

@@ -7,6 +7,7 @@ use std::fs::read_to_string;
 use crate::{
     cache::cacher::RedisCache,
     config_parser::parser::Config,
+    handler::public_path_handler::handle_different_public_path,
     search_results_handler::{aggregation_models::SearchResults, aggregator::aggregate},
 };
 use actix_web::{get, web, HttpRequest, HttpResponse};
@@ -146,7 +147,8 @@ pub async fn search(
 /// Handles the route of robots.txt page of the `websurfx` meta search engine website.
 #[get("/robots.txt")]
 pub async fn robots_data(_req: HttpRequest) -> Result<HttpResponse, Box<dyn std::error::Error>> {
-    let page_content: String = read_to_string("./public/robots.txt")?;
+    let page_content: String =
+        read_to_string(format!("{}/robots.txt", handle_different_public_path()?))?;
     Ok(HttpResponse::Ok()
         .content_type("text/plain; charset=ascii")
         .body(page_content))