ControllerLinkGeneratorExtensions.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Diagnostics.CodeAnalysis;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Http.Features;
using Microsoft.AspNetCore.Mvc.Routing;

namespace Microsoft.AspNetCore.Routing;

/// <summary>
/// Extension methods for using <see cref="LinkGenerator"/> to generate links to MVC controllers.
/// </summary>
public static class ControllerLinkGeneratorExtensions
{
    /// <summary>
    /// Generates a URI with an absolute path based on the provided values.
    /// </summary>
    /// <param name="generator">The <see cref="LinkGenerator"/>.</param>
    /// <param name="httpContext">The <see cref="HttpContext"/> associated with the current request.</param>
    /// <param name="action">
    /// The action name. Used to resolve endpoints. Optional. If <c>null</c> is provided, the current action route value
    /// will be used.
    /// </param>
    /// <param name="controller">
    /// The controller name. Used to resolve endpoints. Optional. If <c>null</c> is provided, the current controller route value
    /// will be used.
    /// </param>
    /// <param name="values">The route values. Optional. Used to resolve endpoints and expand parameters in the route template.</param>
    /// <param name="pathBase">
    /// An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of <see cref="HttpRequest.PathBase"/> will be used.
    /// </param>
    /// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
    /// <param name="options">
    /// An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching
    /// names from <c>RouteOptions</c>.
    /// </param>
    /// <returns>A URI with an absolute path, or <c>null</c> if a URI cannot be created.</returns>
    [SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
    public static string? GetPathByAction(
        this LinkGenerator generator,
        HttpContext httpContext,
        string? action = default,
        string? controller = default,
        object? values = default,
        PathString? pathBase = default,
        FragmentString fragment = default,
        LinkOptions? options = default)
    {
        ArgumentNullException.ThrowIfNull(generator);
        ArgumentNullException.ThrowIfNull(httpContext);

        var address = CreateAddress(httpContext, action, controller, values);
        return generator.GetPathByAddress<RouteValuesAddress>(
            httpContext,
            address,
            address.ExplicitValues,
            address.AmbientValues,
            pathBase,
            fragment,
            options);
    }

    /// <summary>
    /// Generates a URI with an absolute path based on the provided values.
    /// </summary>
    /// <param name="generator">The <see cref="LinkGenerator"/>.</param>
    /// <param name="action">The action name. Used to resolve endpoints.</param>
    /// <param name="controller">The controller name. Used to resolve endpoints.</param>
    /// <param name="values">The route values. Optional. Used to resolve endpoints and expand parameters in the route template.</param>
    /// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI.</param>
    /// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
    /// <param name="options">
    /// An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching
    /// names from <c>RouteOptions</c>.
    /// </param>
    /// <returns>A URI with an absolute path, or <c>null</c> if a URI cannot be created.</returns>
    [SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
    public static string? GetPathByAction(
        this LinkGenerator generator,
        string action,
        string controller,
        object? values = default,
        PathString pathBase = default,
        FragmentString fragment = default,
        LinkOptions? options = default)
    {
        ArgumentNullException.ThrowIfNull(generator);
        ArgumentNullException.ThrowIfNull(action);
        ArgumentNullException.ThrowIfNull(controller);

        var address = CreateAddress(httpContext: null, action, controller, values);
        return generator.GetPathByAddress<RouteValuesAddress>(address, address.ExplicitValues, pathBase, fragment, options);
    }

    /// <summary>
    /// Generates an absolute URI based on the provided values.
    /// </summary>
    /// <param name="generator">The <see cref="LinkGenerator"/>.</param>
    /// <param name="httpContext">The <see cref="HttpContext"/> associated with the current request.</param>
    /// <param name="action">
    /// The action name. Used to resolve endpoints. Optional. If <c>null</c> is provided, the current action route value
    /// will be used.
    /// </param>
    /// <param name="controller">
    /// The controller name. Used to resolve endpoints. Optional. If <c>null</c> is provided, the current controller route value
    /// will be used.
    /// </param>
    /// <param name="values">The route values. Optional. Used to resolve endpoints and expand parameters in the route template.</param>
    /// <param name="scheme">
    /// The URI scheme, applied to the resulting URI. Optional. If not provided, the value of <see cref="HttpRequest.Scheme"/> will be used.
    /// </param>
    /// <param name="host">
    /// The URI host/authority, applied to the resulting URI. Optional. If not provided, the value <see cref="HttpRequest.Host"/> will be used.
    /// </param>
    /// <param name="pathBase">
    /// An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of <see cref="HttpRequest.PathBase"/> will be used.
    /// </param>
    /// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
    /// <param name="options">
    /// An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching
    /// names from <c>RouteOptions</c>.
    /// </param>
    /// <returns>A absolute URI, or <c>null</c> if a URI cannot be created.</returns>
    /// <remarks>
    /// <para>
    /// The value of <paramref name="host" /> should be a trusted value. Relying on the value of the current request
    /// can allow untrusted input to influence the resulting URI unless the <c>Host</c> header has been validated.
    /// See the deployment documentation for instructions on how to properly validate the <c>Host</c> header in
    /// your deployment environment.
    /// </para>
    /// </remarks>
    [SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
    public static string? GetUriByAction(
        this LinkGenerator generator,
        HttpContext httpContext,
        string? action = default,
        string? controller = default,
        object? values = default,
        string? scheme = default,
        HostString? host = default,
        PathString? pathBase = default,
        FragmentString fragment = default,
        LinkOptions? options = default)
    {
        ArgumentNullException.ThrowIfNull(generator);
        ArgumentNullException.ThrowIfNull(httpContext);

        var address = CreateAddress(httpContext, action, controller, values);
        return generator.GetUriByAddress<RouteValuesAddress>(
            httpContext,
            address,
            address.ExplicitValues,
            address.AmbientValues,
            scheme,
            host,
            pathBase,
            fragment,
            options);
    }

    /// <summary>
    /// Generates an absolute URI based on the provided values.
    /// </summary>
    /// <param name="generator">The <see cref="LinkGenerator"/>.</param>
    /// <param name="action">The action name. Used to resolve endpoints.</param>
    /// <param name="controller">The controller name. Used to resolve endpoints.</param>
    /// <param name="values">The route values. May be null. Used to resolve endpoints and expand parameters in the route template.</param>
    /// <param name="scheme">The URI scheme, applied to the resulting URI.</param>
    /// <param name="host">The URI host/authority, applied to the resulting URI.</param>
    /// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI.</param>
    /// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
    /// <param name="options">
    /// An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching
    /// names from <c>RouteOptions</c>.
    /// </param>
    /// <returns>A absolute URI, or <c>null</c> if a URI cannot be created.</returns>
    /// <remarks>
    /// <para>
    /// The value of <paramref name="host" /> should be a trusted value. Relying on the value of the current request
    /// can allow untrusted input to influence the resulting URI unless the <c>Host</c> header has been validated.
    /// See the deployment documentation for instructions on how to properly validate the <c>Host</c> header in
    /// your deployment environment.
    /// </para>
    /// </remarks>
    [SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
    public static string? GetUriByAction(
        this LinkGenerator generator,
        string action,
        string controller,
        object? values,
        string scheme,
        HostString host,
        PathString pathBase = default,
        FragmentString fragment = default,
        LinkOptions? options = default)
    {
        ArgumentNullException.ThrowIfNull(generator);
        ArgumentNullException.ThrowIfNull(action);
        ArgumentNullException.ThrowIfNull(controller);

        var address = CreateAddress(httpContext: null, action, controller, values);
        return generator.GetUriByAddress<RouteValuesAddress>(address, address.ExplicitValues, scheme, host, pathBase, fragment, options);
    }

    private static RouteValuesAddress CreateAddress(HttpContext? httpContext, string? action, string? controller, object? values)
    {
        var explicitValues = new RouteValueDictionary(values);
        var ambientValues = GetAmbientValues(httpContext);

        UrlHelperBase.NormalizeRouteValuesForAction(action, controller, explicitValues, ambientValues);

        return new RouteValuesAddress()
        {
            AmbientValues = ambientValues,
            ExplicitValues = explicitValues
        };
    }

    private static RouteValueDictionary? GetAmbientValues(HttpContext? httpContext)
    {
        return httpContext?.Features?.Get<IRouteValuesFeature>()?.RouteValues;
    }
}