Skip to content

Commit

Permalink
✨ Added sitemap middleware
Browse files Browse the repository at this point in the history
  • Loading branch information
Marthijn van den Heuvel committed Jun 30, 2024
1 parent d4e4e53 commit 282e16e
Show file tree
Hide file tree
Showing 101 changed files with 75,683 additions and 158 deletions.
21 changes: 14 additions & 7 deletions Sidio.Sitemap.AspNetCore.sln
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.8.34408.163
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sidio.Sitemap.AspNetCore", "src\Sidio.Sitemap.AspNetCore\Sidio.Sitemap.AspNetCore.csproj", "{DC78B0F0-C432-40E0-B457-28DECCF93989}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sidio.Sitemap.AspNetCore", "src\Sidio.Sitemap.AspNetCore\Sidio.Sitemap.AspNetCore.csproj", "{DC78B0F0-C432-40E0-B457-28DECCF93989}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionItems", "SolutionItems", "{A84962F5-CBDA-4DFA-8330-688B1E74BF45}"
ProjectSection(SolutionItems) = preProject
Expand All @@ -22,13 +22,15 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Workflows", "Workflows", "{
.github\workflows\release.yml = .github\workflows\release.yml
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sidio.Sitemap.AspNetCore.Tests", "src\Sidio.Sitemap.AspNetCore.Tests\Sidio.Sitemap.AspNetCore.Tests.csproj", "{FF6107F5-2129-4482-976D-4A59B7CF9012}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sidio.Sitemap.AspNetCore.Tests", "src\Sidio.Sitemap.AspNetCore.Tests\Sidio.Sitemap.AspNetCore.Tests.csproj", "{FF6107F5-2129-4482-976D-4A59B7CF9012}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Examples", "Examples", "{304BDC1E-73E2-4CD5-9CAE-14642D299E4D}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication", "src\Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication\Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.csproj", "{CB190E46-DDD0-44A0-A384-9C99239A30FF}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication", "src\Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication\Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.csproj", "{CB190E46-DDD0-44A0-A384-9C99239A30FF}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Tests", "src\Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Tests\Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Tests.csproj", "{AF1B6B53-8880-478B-8F38-C45439C9E431}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Tests", "src\Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Tests\Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Tests.csproj", "{AF1B6B53-8880-478B-8F38-C45439C9E431}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware", "src\Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware\Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware.csproj", "{02D87779-3782-4484-885B-0A8574BF17DB}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand All @@ -52,17 +54,22 @@ Global
{AF1B6B53-8880-478B-8F38-C45439C9E431}.Debug|Any CPU.Build.0 = Debug|Any CPU
{AF1B6B53-8880-478B-8F38-C45439C9E431}.Release|Any CPU.ActiveCfg = Release|Any CPU
{AF1B6B53-8880-478B-8F38-C45439C9E431}.Release|Any CPU.Build.0 = Release|Any CPU
{02D87779-3782-4484-885B-0A8574BF17DB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{02D87779-3782-4484-885B-0A8574BF17DB}.Debug|Any CPU.Build.0 = Debug|Any CPU
{02D87779-3782-4484-885B-0A8574BF17DB}.Release|Any CPU.ActiveCfg = Release|Any CPU
{02D87779-3782-4484-885B-0A8574BF17DB}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {BAAFA8AB-8CE7-4B73-8583-EB5CD2DD789E}
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{DC78B0F0-C432-40E0-B457-28DECCF93989} = {8BB6D612-E472-451D-8EE3-390A292B238F}
{FF6107F5-2129-4482-976D-4A59B7CF9012} = {150077D2-C1D4-422C-9343-1A0FAA5C663E}
{CB190E46-DDD0-44A0-A384-9C99239A30FF} = {304BDC1E-73E2-4CD5-9CAE-14642D299E4D}
{AF1B6B53-8880-478B-8F38-C45439C9E431} = {150077D2-C1D4-422C-9343-1A0FAA5C663E}
{02D87779-3782-4484-885B-0A8574BF17DB} = {304BDC1E-73E2-4CD5-9CAE-14642D299E4D}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {BAAFA8AB-8CE7-4B73-8583-EB5CD2DD789E}
EndGlobalSection
EndGlobal
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
using Microsoft.AspNetCore.Mvc;
using Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware.Models;
using System.Diagnostics;

namespace Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware.Controllers;

public class HomeController : Controller
{
private readonly ILogger<HomeController> _logger;

public HomeController(ILogger<HomeController> logger)
{
_logger = logger;
}

[SitemapInclude]
public IActionResult Index()
{
return View();
}

[Route("custom-url")]
[SitemapInclude]
public IActionResult IndexWithCustomUrl()
{
return View(nameof(Index));
}

[SitemapInclude]
public IActionResult Privacy()
{
return View();
}

[ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
public IActionResult Error()
{
return View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier });
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
namespace Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware.Models
{
public class ErrorViewModel
{
public string? RequestId { get; set; }

public bool ShowRequestId => !string.IsNullOrEmpty(RequestId);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
using Sidio.Sitemap.AspNetCore;
using Sidio.Sitemap.AspNetCore.Middleware;
using Sidio.Sitemap.Core.Services;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services
.AddHttpContextAccessor()
.AddDefaultSitemapServices<HttpContextBaseUrlProvider>()
.AddSitemapMiddleware(
options =>
{
options.EndpointInclusionMethod = EndpointInclusionMethod.OptIn;
})
.AddControllersWithViews();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
app.UseExceptionHandler("/Home/Error");
// The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.UseSitemap();

app.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}/{id?}");

app.Run();
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"$schema": "http://json.schemastore.org/launchsettings.json",
"iisSettings": {
"windowsAuthentication": false,
"anonymousAuthentication": true,
"iisExpress": {
"applicationUrl": "http://localhost:21812",
"sslPort": 44387
}
},
"profiles": {
"http": {
"commandName": "Project",
"dotnetRunMessages": true,
"launchBrowser": true,
"applicationUrl": "http://localhost:5202",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
},
"https": {
"commandName": "Project",
"dotnetRunMessages": true,
"launchBrowser": true,
"applicationUrl": "https://localhost:7178;http://localhost:5202",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
},
"IIS Express": {
"commandName": "IISExpress",
"launchBrowser": true,
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<Project Sdk="Microsoft.NET.Sdk.Web">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<IsPackable>false</IsPackable>
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="..\Sidio.Sitemap.AspNetCore\Sidio.Sitemap.AspNetCore.csproj" />
</ItemGroup>

</Project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
@{
ViewData["Title"] = "Home Page";
}

<div class="text-center">
<h1 class="display-4">Welcome</h1>
<p><a href="/sitemap.xml">Visit sitemap</a></p>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
@{
ViewData["Title"] = "Privacy Policy";
}
<h1>@ViewData["Title"]</h1>

<p>Use this page to detail your site's privacy policy.</p>
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
@model ErrorViewModel
@{
ViewData["Title"] = "Error";
}

<h1 class="text-danger">Error.</h1>
<h2 class="text-danger">An error occurred while processing your request.</h2>

@if (Model.ShowRequestId)
{
<p>
<strong>Request ID:</strong> <code>@Model.RequestId</code>
</p>
}

<h3>Development Mode</h3>
<p>
Swapping to <strong>Development</strong> environment will display more detailed information about the error that occurred.
</p>
<p>
<strong>The Development environment shouldn't be enabled for deployed applications.</strong>
It can result in displaying sensitive information from exceptions to end users.
For local debugging, enable the <strong>Development</strong> environment by setting the <strong>ASPNETCORE_ENVIRONMENT</strong> environment variable to <strong>Development</strong>
and restarting the app.
</p>
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>@ViewData["Title"] - Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware</title>
<link rel="stylesheet" href="~/lib/bootstrap/dist/css/bootstrap.min.css" />
<link rel="stylesheet" href="~/css/site.css" asp-append-version="true" />
<link rel="stylesheet" href="~/Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware.styles.css" asp-append-version="true" />
</head>
<body>
<header>
<nav class="navbar navbar-expand-sm navbar-toggleable-sm navbar-light bg-white border-bottom box-shadow mb-3">
<div class="container-fluid">
<a class="navbar-brand" asp-area="" asp-controller="Home" asp-action="Index">Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware</a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target=".navbar-collapse" aria-controls="navbarSupportedContent"
aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="navbar-collapse collapse d-sm-inline-flex justify-content-between">
<ul class="navbar-nav flex-grow-1">
<li class="nav-item">
<a class="nav-link text-dark" asp-area="" asp-controller="Home" asp-action="Index">Home</a>
</li>
<li class="nav-item">
<a class="nav-link text-dark" asp-area="" asp-controller="Home" asp-action="Privacy">Privacy</a>
</li>
</ul>
</div>
</div>
</nav>
</header>
<div class="container">
<main role="main" class="pb-3">
@RenderBody()
</main>
</div>

<footer class="border-top footer text-muted">
<div class="container">
&copy; 2024 - Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware - <a asp-area="" asp-controller="Home" asp-action="Privacy">Privacy</a>
</div>
</footer>
<script src="~/lib/jquery/dist/jquery.min.js"></script>
<script src="~/lib/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
<script src="~/js/site.js" asp-append-version="true"></script>
@await RenderSectionAsync("Scripts", required: false)
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/* Please see documentation at https://learn.microsoft.com/aspnet/core/client-side/bundling-and-minification
for details on configuring this project to bundle and minify static web assets. */

a.navbar-brand {
white-space: normal;
text-align: center;
word-break: break-all;
}

a {
color: #0077cc;
}

.btn-primary {
color: #fff;
background-color: #1b6ec2;
border-color: #1861ac;
}

.nav-pills .nav-link.active, .nav-pills .show > .nav-link {
color: #fff;
background-color: #1b6ec2;
border-color: #1861ac;
}

.border-top {
border-top: 1px solid #e5e5e5;
}
.border-bottom {
border-bottom: 1px solid #e5e5e5;
}

.box-shadow {
box-shadow: 0 .25rem .75rem rgba(0, 0, 0, .05);
}

button.accept-policy {
font-size: 1rem;
line-height: inherit;
}

.footer {
position: absolute;
bottom: 0;
width: 100%;
white-space: nowrap;
line-height: 60px;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<script src="~/lib/jquery-validation/dist/jquery.validate.min.js"></script>
<script src="~/lib/jquery-validation-unobtrusive/jquery.validate.unobtrusive.min.js"></script>
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@using Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware
@using Sidio.Sitemap.AspNetCore.Examples.MvcWebApplication.Middleware.Models
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@{
Layout = "_Layout";
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"AllowedHosts": "*"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
html {
font-size: 14px;
}

@media (min-width: 768px) {
html {
font-size: 16px;
}
}

.btn:focus, .btn:active:focus, .btn-link.nav-link:focus, .form-control:focus, .form-check-input:focus {
box-shadow: 0 0 0 0.1rem white, 0 0 0 0.25rem #258cfb;
}

html {
position: relative;
min-height: 100%;
}

body {
margin-bottom: 60px;
}
Binary file not shown.
Loading

0 comments on commit 282e16e

Please sign in to comment.