// 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 System.Security.Claims;
 
namespace Microsoft.AspNetCore.Authentication;
 
/// <summary>
/// Contains the result of an Authenticate call
/// </summary>
public class AuthenticateResult
{
    private static readonly AuthenticateResult _noResult = new() { None = true };
 
    /// <summary>
    /// Creates a new <see cref="AuthenticateResult"/> instance.
    /// </summary>
    protected AuthenticateResult() { }
 
    /// <summary>
    /// If a ticket was produced, authenticate was successful.
    /// </summary>
    [MemberNotNullWhen(true, nameof(Ticket), nameof(Principal), nameof(Properties))]
    public bool Succeeded => Ticket != null;
 
    /// <summary>
    /// The authentication ticket.
    /// </summary>
    public AuthenticationTicket? Ticket { get; protected set; }
 
    /// <summary>
    /// Gets the claims-principal with authenticated user identities.
    /// </summary>
    public ClaimsPrincipal? Principal => Ticket?.Principal;
 
    /// <summary>
    /// Additional state values for the authentication session.
    /// </summary>
    public AuthenticationProperties? Properties { get; protected set; }
 
    /// <summary>
    /// Holds failure information from the authentication.
    /// </summary>
    public Exception? Failure { get; protected set; }
 
    /// <summary>
    /// Indicates that there was no information returned for this authentication scheme.
    /// </summary>
    public bool None { get; protected set; }
 
    /// <summary>
    /// Create a new deep copy of the result
    /// </summary>
    /// <returns>A copy of the result</returns>
    public AuthenticateResult Clone()
    {
        if (None)
        {
            return NoResult();
        }
        if (Failure != null)
        {
            return Fail(Failure, Properties?.Clone());
        }
        if (Succeeded)
        {
            return Success(Ticket!.Clone());
        }
        // This shouldn't happen
        throw new NotImplementedException();
    }
 
    /// <summary>
    /// Indicates that authentication was successful.
    /// </summary>
    /// <param name="ticket">The ticket representing the authentication result.</param>
    /// <returns>The result.</returns>
    public static AuthenticateResult Success(AuthenticationTicket ticket)
    {
        ArgumentNullException.ThrowIfNull(ticket);
        return new AuthenticateResult() { Ticket = ticket, Properties = ticket.Properties };
    }
 
    /// <summary>
    /// Indicates that there was no information returned for this authentication scheme.
    /// </summary>
    /// <returns>The result.</returns>
    public static AuthenticateResult NoResult()
    {
        return _noResult;
    }
 
    /// <summary>
    /// Indicates that there was a failure during authentication.
    /// </summary>
    /// <param name="failure">The failure exception.</param>
    /// <returns>The result.</returns>
    public static AuthenticateResult Fail(Exception failure)
    {
        return new AuthenticateResult() { 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 AuthenticateResult Fail(Exception failure, AuthenticationProperties? properties)
    {
        return new AuthenticateResult() { 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 AuthenticateResult 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 AuthenticateResult Fail(string failureMessage, AuthenticationProperties? properties)
        => Fail(new AuthenticationFailureException(failureMessage), properties);
}