favicons

src/main.rs

@@ -113,8 +113,8 @@ async fn main() -> std::io::Result<()> {
             .configure(v1::services)
             .configure(widget::services)
             .configure(docs::services)
-            .configure(static_assets::services)
             .configure(pages::services)
+            .configure(static_assets::services)
             .app_data(get_json_err())
     })
     .bind(SETTINGS.server.get_ip())

src/static_assets/filemap.rs

@@ -0,0 +1,52 @@
+/*
+* Copyright (C) 2021  Aravinth Manivannan <realaravinth@batsense.net>
+*
+* This program is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Affero General Public License as
+* published by the Free Software Foundation, either version 3 of the
+* License, or (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU Affero General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+use cache_buster::Files;
+
+pub struct FileMap {
+    pub files: Files,
+}
+
+impl FileMap {
+    pub fn new() -> Self {
+        let map = include_str!("../cache_buster_data.json");
+        let files = Files::new(&map);
+        Self { files }
+    }
+    pub fn get<'a>(&'a self, path: &'a str) -> Option<&'a str> {
+        // let file_path = self.files.get(path);
+        let file_path = self.files.get_full_path(path);
+
+        if file_path.is_some() {
+            let file_path = &file_path.unwrap()[1..];
+            return Some(file_path);
+        } else {
+            return None;
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+
+    #[test]
+    fn filemap_works() {
+        let files = super::FileMap::new();
+        let css = files.get("./static-assets/bundle/bundle.css").unwrap();
+        println!("{}", css);
+        assert!(css.contains("/static/bundle/bundle"));
+    }
+}

src/static_assets/mod.rs

@@ -0,0 +1,26 @@
+/*
+* Copyright (C) 2021  Aravinth Manivannan <realaravinth@batsense.net>
+*
+* This program is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Affero General Public License as
+* published by the Free Software Foundation, either version 3 of the
+* License, or (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU Affero General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+pub mod filemap;
+pub mod static_files;
+
+pub use filemap::FileMap;
+
+pub fn services(cfg: &mut actix_web::web::ServiceConfig) {
+    cfg.service(static_files::static_files);
+    cfg.service(static_files::favicons);
+}

src/static_assets/static_files.rs

@@ -18,7 +18,7 @@ use std::borrow::Cow;
 
 use actix_web::body::Body;
 use actix_web::{get, http::header, web, HttpResponse, Responder};
-use cache_buster::Files;
+use log::debug;
 use mime_guess::from_path;
 use rust_embed::RustEmbed;
 
@@ -28,7 +28,7 @@ use crate::CACHE_AGE;
 #[folder = "static/"]
 struct Asset;
 
-pub fn handle_embedded_file(path: &str) -> HttpResponse {
+fn handle_assets(path: &str) -> HttpResponse {
     match Asset::get(path) {
         Some(content) => {
             let body: Body = match content {
@@ -48,37 +48,41 @@ pub fn handle_embedded_file(path: &str) -> HttpResponse {
 }
 
 #[get("/static/{_:.*}")]
-async fn dist(path: web::Path<String>) -> impl Responder {
+pub async fn static_files(path: web::Path<String>) -> impl Responder {
-    handle_embedded_file(&path.0)
+    handle_assets(&path.0)
 }
 
-pub fn services(cfg: &mut web::ServiceConfig) {
-    cfg.service(dist);
-}
 
-pub struct FileMap {
-    files: Files,
-}
 
-impl FileMap {
+#[derive(RustEmbed)]
-    pub fn new() -> Self {
+#[folder = "static-assets/favicons/"]
-        let map = include_str!("cache_buster_data.json");
+struct Favicons;
-        let files = Files::new(&map);
-        Self { files }
-    }
-    pub fn get<'a>(&'a self, path: &'a str) -> Option<&'a str> {
-        // let file_path = self.files.get(path);
-        let file_path = self.files.get_full_path(path);
 
-        if file_path.is_some() {
+fn handle_favicons(path: &str) -> HttpResponse {
-            let file_path = &file_path.unwrap()[1..];
+    match Favicons::get(path) {
-            return Some(file_path);
+        Some(content) => {
-        } else {
+            let body: Body = match content {
-            return None;
+                Cow::Borrowed(bytes) => bytes.into(),
+                Cow::Owned(bytes) => bytes.into(),
+            };
+
+            HttpResponse::Ok()
+                .set(header::CacheControl(vec![header::CacheDirective::MaxAge(
+                    CACHE_AGE,
+                )]))
+                .content_type(from_path(path).first_or_octet_stream().as_ref())
+                .body(body)
         }
+        None => HttpResponse::NotFound().body("404 Not Found"),
     }
 }
 
+#[get("/{file}")]
+pub async fn favicons(path: web::Path<String>) -> impl Responder {
+    debug!("searching favicons");
+    handle_favicons(&path.0)
+}
+
 #[cfg(test)]
 mod tests {
     use actix_web::http::StatusCode;
@@ -86,10 +90,11 @@ mod tests {
 
     use super::*;
     use crate::*;
+    use crate::tests::*;
 
     #[actix_rt::test]
     async fn static_assets_work() {
-        let mut app = test::init_service(App::new().configure(services)).await;
+        let mut app = get_app!().await;
 
         let resp = test::call_service(
             &mut app,
@@ -99,11 +104,21 @@ mod tests {
         assert_eq!(resp.status(), StatusCode::OK);
     }
 
-    #[test]
+    #[actix_rt::test]
-    fn filemap_works() {
+    async fn favicons_work() {
-        let files = super::FileMap::new();
+
-        let css = files.get("./static-assets/bundle/bundle.css").unwrap();
+        assert!(Favicons::get("favicon.ico").is_some());
-        println!("{}", css);
+
-        assert!(css.contains("/static/bundle/bundle"));
+        //let mut app = test::init_service(App::new().configure(services)).await;
+        let mut app = get_app!().await;
+
+        let resp = test::call_service(
+            &mut app,
+            test::TestRequest::get().uri("/favicon.ico").to_request(),
+        )
+        .await;
+        assert_eq!(resp.status(), StatusCode::OK);
+
     }
+
 }

src/tests/mod.rs

@@ -48,6 +48,21 @@ macro_rules! post_request {
 
 #[macro_export]
 macro_rules! get_app {
+    () => {
+    test::init_service(
+            App::new()
+                .wrap(get_identity_service())
+                .wrap(actix_middleware::NormalizePath::new(
+                    actix_middleware::normalize::TrailingSlash::Trim,
+                ))
+                .configure(crate::api::v1::services)
+                .configure(crate::widget::services)
+                .configure(crate::docs::services)
+                .configure(crate::pages::services)
+                .configure(crate::static_assets::services)
+        )
+
+    };
     ($data:expr) => {
         test::init_service(
             App::new()
@@ -55,9 +70,11 @@ macro_rules! get_app {
                 .wrap(actix_middleware::NormalizePath::new(
                     actix_middleware::normalize::TrailingSlash::Trim,
                 ))
-                .configure(crate::api::v1::pow::services)
                 .configure(crate::api::v1::services)
+                .configure(crate::widget::services)
+                .configure(crate::docs::services)
                 .configure(crate::pages::services)
+                .configure(crate::static_assets::services)
                 .data($data.clone()),
         )
     };

static-assets/favicons/browserconfig.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig><msapplication><tile><square70x70logo src="/ms-icon-70x70.png"/><square150x150logo src="/ms-icon-150x150.png"/><square310x310logo src="/ms-icon-310x310.png"/><TileColor>#ffffff</TileColor></tile></msapplication></browserconfig>

static-assets/favicons/manifest.json

@@ -0,0 +1,41 @@
+{
+ "name": "App",
+ "icons": [
+  {
+   "src": "\/android-icon-36x36.png",
+   "sizes": "36x36",
+   "type": "image\/png",
+   "density": "0.75"
+  },
+  {
+   "src": "\/android-icon-48x48.png",
+   "sizes": "48x48",
+   "type": "image\/png",
+   "density": "1.0"
+  },
+  {
+   "src": "\/android-icon-72x72.png",
+   "sizes": "72x72",
+   "type": "image\/png",
+   "density": "1.5"
+  },
+  {
+   "src": "\/android-icon-96x96.png",
+   "sizes": "96x96",
+   "type": "image\/png",
+   "density": "2.0"
+  },
+  {
+   "src": "\/android-icon-144x144.png",
+   "sizes": "144x144",
+   "type": "image\/png",
+   "density": "3.0"
+  },
+  {
+   "src": "\/android-icon-192x192.png",
+   "sizes": "192x192",
+   "type": "image\/png",
+   "density": "4.0"
+  }
+ ]
+}

templates/auth/login/index.html

@@ -1,4 +1,4 @@
-<. include!("../../components/headers.html"); .>
+<. include!("../../components/headers/index.html"); .>
 <div class="tmp-layout">
 <main class="auth-main">
   <div class="auth-inner-container">

templates/auth/register/index.html

@@ -1,4 +1,4 @@
-<. include!("../../components/headers.html"); .>
+<. include!("../../components/headers/index.html"); .>
 <div class="tmp-layout">
 <main class="auth-main">
   <div class="auth-inner-container">

templates/components/headers/favicon.html

@@ -0,0 +1,17 @@
+<link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
+<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
+<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
+<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
+<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
+<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
+<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
+<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
+<link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
+<link rel="icon" type="image/png" sizes="192x192"  href="/android-icon-192x192.png">
+<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
+<link rel="icon" type="image/png" sizes="96x96" href="/favicon-96x96.png">
+<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
+<link rel="manifest" href="/manifest.json">
+<meta name="msapplication-TileColor" content="#ffffff">
+<meta name="msapplication-TileImage" content="/ms-icon-144x144.png">
+<meta name="theme-color" content="#ffffff">

templates/components/headers/raw-headers.html

@@ -44,5 +44,6 @@
     <meta property="og:site_name" 
 		content="mCaptcha is an AGPL'd, privacy focued, proof-of-work based CAPTCHA System"
 	 />
-  </head>
 
+	<. include!("./favicon.html"); .>
+  </head>

templates/errors/index.html

@@ -1,4 +1,4 @@
-<. include!("../components/headers.html"); .>
+<. include!("../components/headers/index.html"); .>
 <div class="inner-container">
   <div class="error-box">
     <h1 class="error-title"><.= title .></h1>

templates/panel/index.html

@@ -1,4 +1,4 @@
-<. include!("../components/headers.html"); .>
+<. include!("../components/headers/index.html"); .>
 <. include!("./navbar/index.html"); .>
 <div class="tmp-layout">
 <. include!("./header/index.html"); .>

templates/panel/sitekey/add/index.html

@@ -1,4 +1,4 @@
-<. include!("../../../components/headers.html"); .> 
+<. include!("../../../components/headers/index.html"); .> 
 <. include!("../../navbar/index.html"); .>
 <div class="tmp-layout">
 <. include!("../../header/index.html"); .>

templates/panel/sitekey/list/index.html

@@ -1,4 +1,4 @@
-<. include!("../../../components/headers.html"); .> 
+<. include!("../../../components/headers/index.html"); .> 
 <. include!("../../navbar/index.html"); .>
 <div class="tmp-layout">
 <. include!("../../header/index.html"); .>

templates/panel/sitekey/view/index.html

@@ -1,4 +1,4 @@
-<. include!("../../../components/headers.html"); .> 
+<. include!("../../../components/headers/index.html"); .> 
 <. include!("../../navbar/index.html"); .>
 <div class="tmp-layout">
 <. include!("../../header/index.html"); .>

templates/widget/index.html

@@ -1,4 +1,4 @@
-<. include!("../components/raw-headers.html"); .>
+<. include!("../components/headers/raw-headers.html"); .>
   <body>
     <form class="contaienr">
       <label class="checkbox-label" for="verification">