Webiant Logo Webiant Logo
☌

  1. No results found.

    Try your search with a different keyword or use * as a wildcard.

GenericUrlRouteProvider.cs

using Nop.Data;
using Nop.Web.Framework.Mvc.Routing;

namespace Nop.Web.Infrastructure;

/// 
/// Represents provider that provided generic routes
/// 
public partial class GenericUrlRouteProvider : BaseRouteProvider, IRouteProvider
{
    #region Methods

    /// 
    /// Register routes
    /// 
    /// Route builder
    public void RegisterRoutes(IEndpointRouteBuilder endpointRouteBuilder)
    {
        var lang = GetLanguageRoutePattern();

        //default routes
        //these routes are not generic, they are just default to map requests that don't match other patterns, 
        //but we define them here since this route provider is with the lowest priority, to allow to add additional routes before them
        if (!string.IsNullOrEmpty(lang))
        {
            endpointRouteBuilder.MapControllerRoute(name: "DefaultWithLanguageCode",
                pattern: $"{lang}/{{controller=Home}}/{{action=Index}}/{{id?}}");
        }

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

        if (!DataSettingsManager.IsDatabaseInstalled())
            return;

        //generic routes (actually routing is processed later in SlugRouteTransformer)
        var genericCatalogPattern = $"{lang}/{{{NopRoutingDefaults.RouteValue.CatalogSeName}}}/{{{NopRoutingDefaults.RouteValue.SeName}}}";
        endpointRouteBuilder.MapDynamicControllerRoute(genericCatalogPattern);

        var genericPattern = $"{lang}/{{{NopRoutingDefaults.RouteValue.SeName}}}";
        endpointRouteBuilder.MapDynamicControllerRoute(genericPattern);

        //routes for not found slugs
        if (!string.IsNullOrEmpty(lang))
        {
            endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.GenericUrlWithLanguageCode,
                pattern: genericPattern,
                defaults: new { controller = "Common", action = "GenericUrl" });

            endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.GenericCatalogUrlWithLanguageCode,
                pattern: genericCatalogPattern,
                defaults: new { controller = "Common", action = "GenericUrl" });
        }

        endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.GenericUrl,
            pattern: $"{{{NopRoutingDefaults.RouteValue.SeName}}}",
            defaults: new { controller = "Common", action = "GenericUrl" });

        endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.GenericCatalogUrl,
            pattern: $"{{{NopRoutingDefaults.RouteValue.CatalogSeName}}}/{{{NopRoutingDefaults.RouteValue.SeName}}}",
            defaults: new { controller = "Common", action = "GenericUrl" });

        //routes for entities that support catalog path and slug (e.g. '/category-seo-name/product-seo-name')
        endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.ProductCatalog,
            pattern: genericCatalogPattern,
            defaults: new { controller = "Product", action = "ProductDetails" });

        //routes for entities that support single slug (e.g. '/product-seo-name')
        endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.Product,
            pattern: genericPattern,
            defaults: new { controller = "Product", action = "ProductDetails" });

        endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.Category,
            pattern: genericPattern,
            defaults: new { controller = "Catalog", action = "Category" });

        endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.Manufacturer,
            pattern: genericPattern,
            defaults: new { controller = "Catalog", action = "Manufacturer" });

        endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.Vendor,
            pattern: genericPattern,
            defaults: new { controller = "Catalog", action = "Vendor" });

        endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.NewsItem,
            pattern: genericPattern,
            defaults: new { controller = "News", action = "NewsItem" });

        endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.BlogPost,
            pattern: genericPattern,
            defaults: new { controller = "Blog", action = "BlogPost" });

        endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.Topic,
            pattern: genericPattern,
            defaults: new { controller = "Topic", action = "TopicDetails" });

        endpointRouteBuilder.MapControllerRoute(name: NopRoutingDefaults.RouteName.Generic.ProductTag,
            pattern: genericPattern,
            defaults: new { controller = "Catalog", action = "ProductsByTag" });
    }

    #endregion

    #region Properties

    /// 
    /// Gets a priority of route provider
    /// 
    /// 
    /// it should be the last route. we do not set it to -int.MaxValue so it could be overridden (if required)
    /// 
    public int Priority => -1000000;

    #endregion
}