//! This module provides the functionality to handle different routes of the `websurfx` //! meta search engine website and provide approriate response to each route/page //! when requested. use std::fs::read_to_string; use crate::{config_parser::parser::Config, search_results_handler::aggregator::aggregate}; use actix_web::{get, web, HttpRequest, HttpResponse}; use handlebars::Handlebars; use serde::Deserialize; /// A named struct which deserializes all the user provided search parameters and stores them. /// /// # Fields /// /// * `q` - It stores the search parameter option `q` (or query in simple words) /// of the search url. /// * `page` - It stores the search parameter `page` (or pageno in simple words) /// of the search url. #[derive(Debug, Deserialize)] struct SearchParams { q: Option, page: Option, } /// Handles the route of index page or main page of the `websurfx` meta search engine website. #[get("/")] pub async fn index( hbs: web::Data>, config: web::Data, ) -> Result> { let page_content: String = hbs.render("index", &config.style).unwrap(); Ok(HttpResponse::Ok().body(page_content)) } /// Handles the route of any other accessed route/page which is not provided by the /// website essentially the 404 error page. pub async fn not_found( hbs: web::Data>, config: web::Data, ) -> Result> { let page_content: String = hbs.render("404", &config.style)?; Ok(HttpResponse::Ok() .content_type("text/html; charset=utf-8") .body(page_content)) } /// Handles the route of search page of the `websurfx` meta search engine website and it takes /// two search url parameters `q` and `page` where `page` parameter is optional. /// /// # Example /// /// ```bash /// curl "http://127.0.0.1:8080/search?q=sweden&page=1" /// ``` /// /// Or /// /// ```bash /// curl "http://127.0.0.1:8080/search?q=sweden" /// ``` #[get("/search")] pub async fn search( hbs: web::Data>, req: HttpRequest, config: web::Data, ) -> Result> { let params = web::Query::::from_query(req.query_string())?; match ¶ms.q { Some(query) => { if query.trim().is_empty() { Ok(HttpResponse::Found() .insert_header(("location", "/")) .finish()) } else { let mut results_json: crate::search_results_handler::aggregation_models::SearchResults = aggregate(query, params.page).await?; results_json.add_style(config.style.clone()); let page_content: String = hbs.render("search", &results_json)?; Ok(HttpResponse::Ok().body(page_content)) } } None => Ok(HttpResponse::Found() .insert_header(("location", "/")) .finish()), } } /// 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> { let page_content: String = read_to_string("./public/robots.txt")?; Ok(HttpResponse::Ok() .content_type("text/plain; charset=ascii") .body(page_content)) } /// Handles the route of about page of the `websurfx` meta search engine website. #[get("/about")] pub async fn about( hbs: web::Data>, config: web::Data, ) -> Result> { let page_content: String = hbs.render("about", &config.style)?; Ok(HttpResponse::Ok().body(page_content)) } /// Handles the route of settings page of the `websurfx` meta search engine website. #[get("/settings")] pub async fn settings( hbs: web::Data>, config: web::Data, ) -> Result> { let page_content: String = hbs.render("settings", &config.style)?; Ok(HttpResponse::Ok().body(page_content)) } // TODO: Write tests for tesing parameters for search function that if provided with something // other than u32 like alphabets and special characters than it should panic