From 4179473d901f7e2e718cf6d3f8939e46db20e61e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20N=C3=A4geli?= <andr.naegeli@gmail.com>
Date: Tue, 17 Mar 2020 20:50:04 +0100
Subject: [PATCH] Add support for favicons (closes #61)

---
 API/GenHTTP.API/Protocol/ContentType.cs       |   2 +-
 .../Websites/WebsiteBuilder.cs                |  12 +-
 .../Websites/WebsiteRouter.cs                 |  19 ++
 .../Providers/WebsiteTests.cs                 | 305 +++++++++---------
 4 files changed, 189 insertions(+), 149 deletions(-)

diff --git a/API/GenHTTP.API/Protocol/ContentType.cs b/API/GenHTTP.API/Protocol/ContentType.cs
index 612c8cd2..00677cb6 100644
--- a/API/GenHTTP.API/Protocol/ContentType.cs
+++ b/API/GenHTTP.API/Protocol/ContentType.cs
@@ -218,7 +218,7 @@ public struct FlexibleContentType
             { ContentType.TextHtml, "text/html" },
             { ContentType.TextCss, "text/css" },
             { ContentType.ApplicationJavaScript, "application/javascript" },
-            { ContentType.ImageIcon, "image/vnd.microsoft.icon" },
+            { ContentType.ImageIcon, "image/x-icon" },
             { ContentType.ImageGif, "image/gif" },
             { ContentType.ImageJpg, "image/jpg" },
             { ContentType.ImagePng, "image/png" },
diff --git a/Modules/GenHTTP.Modules.Core/Websites/WebsiteBuilder.cs b/Modules/GenHTTP.Modules.Core/Websites/WebsiteBuilder.cs
index e12117d3..e94fd010 100644
--- a/Modules/GenHTTP.Modules.Core/Websites/WebsiteBuilder.cs
+++ b/Modules/GenHTTP.Modules.Core/Websites/WebsiteBuilder.cs
@@ -19,6 +19,8 @@ public class WebsiteBuilder : RouterBuilderBase<WebsiteBuilder>
 
         private IBuilder<IMenuProvider>? _Menu;
 
+        private IResourceProvider? _Favicon;
+
         private readonly List<Script> _Scripts = new List<Script>();
 
         private readonly List<Style> _Styles = new List<Style>();
@@ -50,6 +52,14 @@ public WebsiteBuilder Menu(IBuilder<IMenuProvider> menu)
             return this;
         }
 
+        public WebsiteBuilder Favicon(IBuilder<IResourceProvider> resourceProvider) => Favicon(resourceProvider.Build());
+
+        public WebsiteBuilder Favicon(IResourceProvider resourceProvider)
+        {
+            _Favicon = resourceProvider;
+            return this;
+        }
+
         public WebsiteBuilder AddStyle(string name, IBuilder<IResourceProvider> provider) => AddStyle(name, provider.Build());
 
         public WebsiteBuilder AddStyle(string name, IResourceProvider provider)
@@ -78,7 +88,7 @@ public override IRouter Build()
 
             var menu = _Menu ?? Core.Menu.From(content);
 
-            return new WebsiteRouter(content, scripts, styles, menu.Build(), theme, _ErrorHandler);
+            return new WebsiteRouter(content, scripts, styles, _Favicon, menu.Build(), theme, _ErrorHandler);
         }
 
         #endregion
diff --git a/Modules/GenHTTP.Modules.Core/Websites/WebsiteRouter.cs b/Modules/GenHTTP.Modules.Core/Websites/WebsiteRouter.cs
index d17ecc0b..e268d03e 100644
--- a/Modules/GenHTTP.Modules.Core/Websites/WebsiteRouter.cs
+++ b/Modules/GenHTTP.Modules.Core/Websites/WebsiteRouter.cs
@@ -22,6 +22,8 @@ public class WebsiteRouter : IRouter
 
         private StyleRouter Styles { get; }
 
+        private IContentProvider? Favicon { get; }
+
         public IMenuProvider Menu { get; }
 
         private IRouter? Resources { get; }
@@ -43,6 +45,7 @@ public IRouter Parent
         public WebsiteRouter(IRouter content,
                              ScriptRouter scripts,
                              StyleRouter styles,
+                             IResourceProvider? favicon,
                              IMenuProvider menu,
                              ITheme theme,
                              IContentProvider? errorHandler)
@@ -56,6 +59,13 @@ public WebsiteRouter(IRouter content,
             Styles = styles;
             Styles.Parent = this;
 
+            if (favicon != null)
+            {
+                Favicon = Download.From(favicon)
+                                  .Type(ContentType.ImageIcon)
+                                  .Build();
+            }
+
             Resources = theme.Resources;
 
             if (Resources != null)
@@ -104,6 +114,10 @@ public void HandleContext(IEditableRoutingContext current)
                 current.Scope(Resources, segment);
                 Resources.HandleContext(current);
             }
+            else if (segment == "favicon.ico" && Favicon != null)
+            {
+                current.RegisterContent(Favicon);
+            }
             else
             {
                 Content.HandleContext(current);
@@ -127,6 +141,11 @@ public IEnumerable<ContentElement> GetContent(IRequest request, string basePath)
                 yield return resource;
             }
 
+            if (Favicon != null)
+            {
+                yield return new ContentElement($"{basePath}favicon.ico", "Favicon", ContentType.ImageIcon, null);
+            }
+
             foreach (var content in Content.GetContent(request, basePath))
             {
                 yield return content;
diff --git a/Testing/GenHTTP.Testing.Acceptance/Providers/WebsiteTests.cs b/Testing/GenHTTP.Testing.Acceptance/Providers/WebsiteTests.cs
index 589999d1..42252452 100644
--- a/Testing/GenHTTP.Testing.Acceptance/Providers/WebsiteTests.cs
+++ b/Testing/GenHTTP.Testing.Acceptance/Providers/WebsiteTests.cs
@@ -1,149 +1,160 @@
-using System;
-using System.Collections.Generic;
-using System.Net;
-
-using Xunit;
-
-using GenHTTP.Api.Modules;
-using GenHTTP.Api.Modules.Templating;
-using GenHTTP.Api.Modules.Websites;
-using GenHTTP.Api.Protocol;
-using GenHTTP.Api.Routing;
-using GenHTTP.Modules.Core;
-using GenHTTP.Modules.Core.Websites;
-using GenHTTP.Testing.Acceptance.Domain;
+using System;
+using System.Collections.Generic;
+using System.Net;
+
+using Xunit;
+
+using GenHTTP.Api.Modules;
+using GenHTTP.Api.Modules.Templating;
+using GenHTTP.Api.Modules.Websites;
+using GenHTTP.Api.Protocol;
+using GenHTTP.Api.Routing;
+using GenHTTP.Modules.Core;
+using GenHTTP.Modules.Core.Websites;
+using GenHTTP.Testing.Acceptance.Domain;
 using GenHTTP.Modules.Themes.Lorahost;
 
-namespace GenHTTP.Testing.Acceptance.Providers
-{
-
-    public class WebsiteTests
-    {
-
-        #region Supporting data structures
-
-        public class Theme : ITheme
-        {
-            public List<Script> Scripts
-            {
-                get { return new List<Script> { new Script("custom.js", true, Data.FromString(" ").Build()) }; }
-            }
-
-            public List<Style> Styles
-            {
-                get { return new List<Style> { new Style("custom.css", Data.FromString(" ").Build()) }; }
-            }
-
-            public IRouter? Resources => Layout.Create().Add("some.txt", Content.From("Text")).Build();
-
-            public IContentProvider? GetErrorHandler(IRequest request, ResponseStatus responseType, Exception? cause)
-            {
-                return Content.From("Error!").Build();
-            }
-
-            public object? GetModel(IRequest request)
-            {
-                return new { key = "value" };
-            }
-
-            public IRenderer<WebsiteModel> GetRenderer()
-            {
-                throw new NotImplementedException();
-            }
-        }
-
-        #endregion
-
-        [Fact]
-        public void TestDevelopmentResourcesWithoutBundle()
-        {
-            using var runner = new TestRunner();
-
-            runner.Host.Router(GetWebsite())
-                       .Development(true)
-                       .Start();
-
-            using var style = runner.GetResponse("/styles/custom.css");
-            Assert.Equal(HttpStatusCode.OK, style.StatusCode);
-
-            using var script = runner.GetResponse("/scripts/custom.js");
-            Assert.Equal(HttpStatusCode.OK, script.StatusCode);
-
-            using var noStyle = runner.GetResponse("/styles/no.css");
-            Assert.Equal(HttpStatusCode.NotFound, noStyle.StatusCode);
-
-            using var noScript = runner.GetResponse("/scripts/no.js");
-            Assert.Equal(HttpStatusCode.NotFound, noScript.StatusCode);
-        }
-
-        [Fact]
-        public void TestBundleNotServed()
-        {
-            using var runner = TestRunner.Run(GetWebsite());
-
-            using var noStyle = runner.GetResponse("/styles/custom.css");
-            Assert.Equal(HttpStatusCode.NotFound, noStyle.StatusCode);
-
-            using var noScript = runner.GetResponse("/scripts/custom.js");
-            Assert.Equal(HttpStatusCode.NotFound, noScript.StatusCode);
-        }
-
-        [Fact]
-        public void TestCustomContent()
-        {
-            var website = GetWebsite().AddScript("my.js", Data.FromString("my"))
-                                      .AddStyle("my.css", Data.FromString("my"));
-
-            using var runner = TestRunner.Run(website);
-
-            using var style = runner.GetResponse("/styles/bundle.css");
-            Assert.Contains("my", style.GetContent());
-            
-            using var script = runner.GetResponse("/scripts/bundle.js");
-            Assert.Contains("my", script.GetContent());
-        }
-
-        [Fact]
-        public void TestStaticMenu()
-        {
-            var menu = Menu.Empty()
-                           .Add("one", "One")
-                           .Add("two", "Two", new List<(string, string)> { ("three", "Three") });
-
-            var website = GetWebsite().Theme(new LorahostBuilder())
-                                      .Menu(menu);
-
-            using var runner = TestRunner.Run(website);
-
-            using var response = runner.GetResponse();
-            var index = response.GetContent();
-
-            Assert.Contains("One", index);
-            Assert.Contains("Two", index);
-            Assert.Contains("Three", index);
-        }
-
-        [Fact]
-        public void TestResources()
-        {
-            using var runner = TestRunner.Run(GetWebsite());
-
-            using var file = runner.GetResponse("/resources/some.txt");
-            Assert.Equal(HttpStatusCode.OK, file.StatusCode);
-
-            using var noFile = runner.GetResponse("/resources/other.txt");
-            Assert.Equal(HttpStatusCode.NotFound, noFile.StatusCode);
-        }
-
-        private WebsiteBuilder GetWebsite()
-        {
-            var content = Layout.Create();
-
-            return Website.Create()
-                          .Theme(new Theme())
-                          .Content(content);
-        }
-
-    }
-
-}
+namespace GenHTTP.Testing.Acceptance.Providers
+{
+
+    public class WebsiteTests
+    {
+
+        #region Supporting data structures
+
+        public class Theme : ITheme
+        {
+            public List<Script> Scripts
+            {
+                get { return new List<Script> { new Script("custom.js", true, Data.FromString(" ").Build()) }; }
+            }
+
+            public List<Style> Styles
+            {
+                get { return new List<Style> { new Style("custom.css", Data.FromString(" ").Build()) }; }
+            }
+
+            public IRouter? Resources => Layout.Create().Add("some.txt", Content.From("Text")).Build();
+
+            public IContentProvider? GetErrorHandler(IRequest request, ResponseStatus responseType, Exception? cause)
+            {
+                return Content.From("Error!").Build();
+            }
+
+            public object? GetModel(IRequest request)
+            {
+                return new { key = "value" };
+            }
+
+            public IRenderer<WebsiteModel> GetRenderer()
+            {
+                throw new NotImplementedException();
+            }
+        }
+
+        #endregion
+
+        [Fact]
+        public void TestDevelopmentResourcesWithoutBundle()
+        {
+            using var runner = new TestRunner();
+
+            runner.Host.Router(GetWebsite())
+                       .Development(true)
+                       .Start();
+
+            using var style = runner.GetResponse("/styles/custom.css");
+            Assert.Equal(HttpStatusCode.OK, style.StatusCode);
+
+            using var script = runner.GetResponse("/scripts/custom.js");
+            Assert.Equal(HttpStatusCode.OK, script.StatusCode);
+
+            using var noStyle = runner.GetResponse("/styles/no.css");
+            Assert.Equal(HttpStatusCode.NotFound, noStyle.StatusCode);
+
+            using var noScript = runner.GetResponse("/scripts/no.js");
+            Assert.Equal(HttpStatusCode.NotFound, noScript.StatusCode);
+        }
+
+        [Fact]
+        public void TestBundleNotServed()
+        {
+            using var runner = TestRunner.Run(GetWebsite());
+
+            using var noStyle = runner.GetResponse("/styles/custom.css");
+            Assert.Equal(HttpStatusCode.NotFound, noStyle.StatusCode);
+
+            using var noScript = runner.GetResponse("/scripts/custom.js");
+            Assert.Equal(HttpStatusCode.NotFound, noScript.StatusCode);
+        }
+
+        [Fact]
+        public void TestCustomContent()
+        {
+            var website = GetWebsite().AddScript("my.js", Data.FromString("my"))
+                                      .AddStyle("my.css", Data.FromString("my"));
+
+            using var runner = TestRunner.Run(website);
+
+            using var style = runner.GetResponse("/styles/bundle.css");
+            Assert.Contains("my", style.GetContent());
+            
+            using var script = runner.GetResponse("/scripts/bundle.js");
+            Assert.Contains("my", script.GetContent());
+        }
+
+        [Fact]
+        public void TestStaticMenu()
+        {
+            var menu = Menu.Empty()
+                           .Add("one", "One")
+                           .Add("two", "Two", new List<(string, string)> { ("three", "Three") });
+
+            var website = GetWebsite().Theme(new LorahostBuilder())
+                                      .Menu(menu);
+
+            using var runner = TestRunner.Run(website);
+
+            using var response = runner.GetResponse();
+            var index = response.GetContent();
+
+            Assert.Contains("One", index);
+            Assert.Contains("Two", index);
+            Assert.Contains("Three", index);
+        }
+
+        [Fact]
+        public void TestResources()
+        {
+            using var runner = TestRunner.Run(GetWebsite());
+
+            using var file = runner.GetResponse("/resources/some.txt");
+            Assert.Equal(HttpStatusCode.OK, file.StatusCode);
+
+            using var noFile = runner.GetResponse("/resources/other.txt");
+            Assert.Equal(HttpStatusCode.NotFound, noFile.StatusCode);
+        }
+
+        [Fact]
+        public void TestFavicon()
+        {
+            using var runner = TestRunner.Run(GetWebsite());
+
+            using var file = runner.GetResponse("/favicon.ico");
+            Assert.Equal(HttpStatusCode.OK, file.StatusCode);
+            Assert.Equal("image/x-icon", file.ContentType);
+        }
+
+        private WebsiteBuilder GetWebsite()
+        {
+            var content = Layout.Create();
+
+            return Website.Create()
+                          .Theme(new Theme())
+                          .Content(content)
+                          .Favicon(Data.FromString("This is a favicon"));
+        }
+
+    }
+
+}