The first component in the Asp.NET Core pipeline is Middleware. Middleware can either handle a request completely, or process the incoming request and pass it on to the next component in the pipeline.
As Piranha CMS is built around standard ASP.NET components most of its middleware is used for routing and passes the request on to eventually be handled by the web application.
The middleware components are added when configuring the application in Startup.cs. The following code sets up middleware for all available content.
public void Configure(IApplicationBuilder app, IHostingEnvironment env, IApi api)
{
...
// Configure Piranha
app.UsePiranha(options => {
...
});
...
}
This call is equivalent to setting up the entire web application and adding the following middleware components (in the specified order). Please note that the integrated middleware handles a lot of different content types.
// Configure Piranha
app.UsePiranha();
If you want to control exactly how the application is setup and in what order you can use the advanced setup. Calling this method only adds middleware so you're 100% responsible for setting up the rest of your application. When calling this method the following middleware are added in the specified order.
If you want to just add specific components you can read about them in detail below.
Note: If you are needing to simply remove a specific middleware functionality, take a look at the startup options available.
Below is a description of the different middleware components, how you register them manually, and what they do. Please note that if you plan on registering middleware manually you should not call app.UsePiranha() as this will register all middleware.
app.UseIntegratedPiranha();
This middleware component handles all of the content types in one pass and is designed to be as efficient as possible in the most common runtime scenario. This middleware replaces, and should not be used together with the following components:
app.UsePiranhaApplication();
Adds the middleware that resolves the current site requested by the incoming request. This middleware is mandatory and needed by all other middleware that handles incoming requests.
app.UsePiranhaAliases();
This adds the middleware that rewrites incoming requests depending on the current aliases configured in the manager.
app.UsePiranhaPages();
This adds the middleware that tries to resolve an incoming request to the slugs available for the current site. It listens to URL's of the following syntax:
GET /<pageSlug>
The middleware will rewrite requests to the specified Page Type Route or to /page if no route is specified, with the arguments id and startpage. To handle this request your controller action should look like this:
[Route("page")]
public IActionResult Page(Guid id, bool startpage)
{
...
}
app.UsePiranhaPosts();
This adds the middleware that tries to resolve an incoming request to the slugs available for the current site. It listens to URL's of the following syntax:
GET /<blogPageSlug>/<postSlug>
The middleware will rewrite requests to the specified Post Type Route or to /post if no route is specified, with the argument id. To handle this request your controller action should look like this:
[Route("post")]
public IActionResult Post(Guid id)
{
...
}
app.UsePiranhaArchives();
This adds the middleware that resolves incoming requests for archive pages and rewrites the request to the specified Page Type Route or to /archive if no route is specified. It listens to URL's of the following syntax:
GET /<blogPageSlug>/<year?>/<month?>(/page/<pageNum>)?
GET /<blogPageSlug>/category/<categorySlug>/<year?>/<month?>(/page/<pageNum>)?
GET /<blogPageSlug>/tag/<tagSlug>/<year?>/<month?>(/page/<pageNum>)?
All parameters are optional except blogPageSlug, but the optional paging must be placed last. Everything after the page number is ignored. This means that the following URL's would be valid:
/myblog/myblog/category/fishing/myblog/tag/salmon/myblog/page/2/myblog/category/fishing/page/2/myblog/tag/salmon/page/2/myblog/2018/myblog/category/fishing/2018/myblog/tag/salmon/2018/myblog/2018/page/2/myblog/category/fishing/2018/page/2/myblog/tag/salmon/2018/page/2/myblog/2018/1/myblog/category/fishing/2018/1/myblog/tag/salmon/2018/1/myblog/2018/1/page/2/myblog/category/fishing/2018/1/page/2/myblog/tag/salmon/2018/1/page/2The middleware will rewrite requests to the specified route with the following arguments:
[Route("archive")]
public IActionResult Archive(Guid id, int? year = null, int? month = null,
int? page = null, Guid? category = null, Guid? tag = null)
{
...
}
app.UsePiranhaStartPage();
Adds the middleware that resolves requests to the site root. It listens to URL's of the following syntax:
GET /
The start page middleware executes api.Pages.GetStartpage() which will load the page with ParentId == null && SortOrder == 0 (i.e. the first root-level page in the site). The "start" page will then be handled the same as any other page.
app.UsePiranhaSitemap();
Adds the middleware that responds to incoming requests for /sitemap.xml and returns a sitemap document.
GET /sitemap.xml