// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
namespace Microsoft.AspNetCore.Authentication;
 
/// <summary>
/// Contains the result of an Authenticate call
/// </summary>
public class HandleRequestResult : AuthenticateResult
{
    private static readonly HandleRequestResult _noResult = new() { None = true };
    private static readonly HandleRequestResult _skippedResult = new() { Skipped = true };
    private static readonly HandleRequestResult _handledResult = new() { Handled = true };
 
    /// <summary>
    /// Indicates that stage of authentication was directly handled by
    /// user intervention and no further processing should be attempted.
    /// </summary>
    public bool Handled { get; private set; }
 
    /// <summary>
    /// Indicates that the default authentication logic should be
    /// skipped and that the rest of the pipeline should be invoked.
    /// </summary>
    public bool Skipped { get; private set; }
 
    /// <summary>
    /// Indicates that authentication was successful.
    /// </summary>
    /// <param name="ticket">The ticket representing the authentication result.</param>
    /// <returns>The result.</returns>
    public static new HandleRequestResult Success(AuthenticationTicket ticket)
    {
        ArgumentNullException.ThrowIfNull(ticket);
        return new HandleRequestResult() { Ticket = ticket, Properties = ticket.Properties };
    }
 
    /// <summary>
    /// Indicates that there was a failure during authentication.
    /// </summary>
    /// <param name="failure">The failure exception.</param>
    /// <returns>The result.</returns>
    public static new HandleRequestResult Fail(Exception failure)
    {
        return new HandleRequestResult() { Failure = failure };
    }
 
    /// <summary>
    /// Indicates that there was a failure during authentication.
    /// </summary>
    /// <param name="failure">The failure exception.</param>
    /// <param name="properties">Additional state values for the authentication session.</param>
    /// <returns>The result.</returns>
    public static new HandleRequestResult Fail(Exception failure, AuthenticationProperties? properties)
    {
        return new HandleRequestResult() { Failure = failure, Properties = properties };
    }
 
    /// <summary>
    /// Indicates that there was a failure during authentication.
    /// </summary>
    /// <param name="failureMessage">The failure message.</param>
    /// <returns>The result.</returns>
    public static new HandleRequestResult Fail(string failureMessage)
        => Fail(new AuthenticationFailureException(failureMessage));
 
    /// <summary>
    /// Indicates that there was a failure during authentication.
    /// </summary>
    /// <param name="failureMessage">The failure message.</param>
    /// <param name="properties">Additional state values for the authentication session.</param>
    /// <returns>The result.</returns>
    public static new HandleRequestResult Fail(string failureMessage, AuthenticationProperties? properties)
        => Fail(new AuthenticationFailureException(failureMessage), properties);
 
    /// <summary>
    /// Discontinue all processing for this request and return to the client.
    /// The caller is responsible for generating the full response.
    /// </summary>
    /// <returns>The result.</returns>
    public static HandleRequestResult Handle() => _handledResult;
 
    /// <summary>
    /// Discontinue processing the request in the current handler.
    /// </summary>
    /// <returns>The result.</returns>
    public static HandleRequestResult SkipHandler() => _skippedResult;
 
    /// <summary>
    /// Indicates that there were no results produced during authentication.
    /// </summary>
    /// <returns>The result.</returns>
    public static new HandleRequestResult NoResult() => _noResult;
}