using System;

using System.ComponentModel;

using System.Data;

using System.Data.Common;

using System.Diagnostics;

using System.Diagnostics.CodeAnalysis;

using System.IO;

using System.Runtime.CompilerServices;

using System.Runtime.ExceptionServices;

using System.Threading;

using System.Threading.Tasks;

using Npgsql.Internal;

using Npgsql.Internal.Postgres;

using Npgsql.PostgresTypes;

using Npgsql.TypeMapping;

using Npgsql.Util;

using NpgsqlTypes;

namespace Npgsql;

public class NpgsqlParameter : DbParameter, IDbDataParameter, ICloneable

#region Fields and Properties

private protected byte _precision;

private protected byte _scale;

private protected int _size;

internal NpgsqlDbType? _npgsqlDbType;

internal string? _dataTypeName;

internal DbType? _dbType;

private protected string _name = string.Empty;

object? _value;

private protected bool _useSubStream;

private protected Stream? _subStream;

private protected string _sourceColumn;

internal string TrimmedName { get; private protected set; } = PositionalName;

internal const string PositionalName = "";

IDbTypeResolver? _dbTypeResolver;

private protected PgTypeInfo? TypeInfo { get; private set; }

private protected PgConcreteTypeInfo? ConcreteTypeInfo { get; private set; }

internal PgTypeId PgTypeId => ConcreteTypeInfo?.PgTypeId ?? default;

internal DataFormat Format => _isBound ? _binding.DataFormat : DataFormat.Binary;

object? _providerWriteState;

private protected PgValueBinding _binding;

private protected bool _isBound;

#endregion

#region Constructors

/// <summary>

/// Initializes a new instance of the <see cref="NpgsqlParameter"/> class.

/// </summary>

public NpgsqlParameter()

}

/// <summary>

/// Initializes a new instance of the <see cref="NpgsqlParameter"/> class with the parameter name and a value.

/// </summary>

/// <param name="parameterName">The name of the parameter to map.</param>

/// <param name="value">The value of the <see cref="NpgsqlParameter"/>.</param>

/// <remarks>

/// <p>

/// When you specify an <see cref="object"/> in the value parameter, the <see cref="System.Data.DbType"/> is

/// inferred from the CLR type.

/// </p>

/// <p>

/// When using this constructor, you must be aware of a possible misuse of the constructor which takes a <see cref="DbType"/>

/// parameter. This happens when calling this constructor passing an int 0 and the compiler thinks you are passing a value of

/// <see cref="DbType"/>. Use <see cref="Convert.ToInt32(object)"/> for example to have compiler calling the correct constructor.

/// </p>

/// </remarks>

public NpgsqlParameter(string? parameterName, object? value)

}

/// <summary>

/// Initializes a new instance of the <see cref="NpgsqlParameter"/> class with the parameter name and the data type.

/// </summary>

/// <param name="parameterName">The name of the parameter to map.</param>

/// <param name="parameterType">One of the <see cref="NpgsqlTypes.NpgsqlDbType"/> values.</param>

public NpgsqlParameter(string? parameterName, NpgsqlDbType parameterType)

: this(parameterName, parameterType, 0, string.Empty)

{

}

/// <summary>

/// Initializes a new instance of the <see cref="NpgsqlParameter"/>.

/// </summary>

/// <param name="parameterName">The name of the parameter to map.</param>

/// <param name="parameterType">One of the <see cref="System.Data.DbType"/> values.</param>

public NpgsqlParameter(string? parameterName, DbType parameterType)

: this(parameterName, parameterType, 0, string.Empty)

{

}

/// <summary>

/// Initializes a new instance of the <see cref="NpgsqlParameter"/>.

/// </summary>

/// <param name="parameterName">The name of the parameter to map.</param>

/// <param name="parameterType">One of the <see cref="NpgsqlTypes.NpgsqlDbType"/> values.</param>

/// <param name="size">The length of the parameter.</param>

public NpgsqlParameter(string? parameterName, NpgsqlDbType parameterType, int size)

: this(parameterName, parameterType, size, string.Empty)

{

}

/// <summary>

/// Initializes a new instance of the <see cref="NpgsqlParameter"/>.

/// </summary>

/// <param name="parameterName">The name of the parameter to map.</param>

/// <param name="parameterType">One of the <see cref="System.Data.DbType"/> values.</param>

/// <param name="size">The length of the parameter.</param>

public NpgsqlParameter(string? parameterName, DbType parameterType, int size)

: this(parameterName, parameterType, size, string.Empty)

{

}

/// <summary>

/// Initializes a new instance of the <see cref="NpgsqlParameter"/>

/// </summary>

/// <param name="parameterName">The name of the parameter to map.</param>

/// <param name="parameterType">One of the <see cref="NpgsqlTypes.NpgsqlDbType"/> values.</param>

/// <param name="size">The length of the parameter.</param>

/// <param name="sourceColumn">The name of the source column.</param>

public NpgsqlParameter(string? parameterName, NpgsqlDbType parameterType, int size, string? sourceColumn)

}

/// <summary>

/// Initializes a new instance of the <see cref="NpgsqlParameter"/>.

/// </summary>

/// <param name="parameterName">The name of the parameter to map.</param>

/// <param name="parameterType">One of the <see cref="System.Data.DbType"/> values.</param>

/// <param name="size">The length of the parameter.</param>

/// <param name="sourceColumn">The name of the source column.</param>

public NpgsqlParameter(string? parameterName, DbType parameterType, int size, string? sourceColumn)

}

/// <summary>

/// Initializes a new instance of the <see cref="NpgsqlParameter"/>.

/// </summary>

/// <param name="parameterName">The name of the parameter to map.</param>

/// <param name="parameterType">One of the <see cref="NpgsqlTypes.NpgsqlDbType"/> values.</param>

/// <param name="size">The length of the parameter.</param>

/// <param name="sourceColumn">The name of the source column.</param>

/// <param name="direction">One of the <see cref="System.Data.ParameterDirection"/> values.</param>

/// <param name="isNullable">

/// <see langword="true"/> if the value of the field can be <see langword="null"/>, otherwise <see langword="false"/>.

/// </param>

/// <param name="precision">

/// The total number of digits to the left and right of the decimal point to which <see cref="Value"/> is resolved.

/// </param>

/// <param name="scale">The total number of decimal places to which <see cref="Value"/> is resolved.</param>

/// <param name="sourceVersion">One of the <see cref="System.Data.DataRowVersion"/> values.</param>

/// <param name="value">An <see cref="object"/> that is the value of the <see cref="NpgsqlParameter"/>.</param>

public NpgsqlParameter(string parameterName, NpgsqlDbType parameterType, int size, string? sourceColumn,

}

/// <summary>

/// Initializes a new instance of the <see cref="NpgsqlParameter"/>.

/// </summary>

/// <param name="parameterName">The name of the parameter to map.</param>

/// <param name="parameterType">One of the <see cref="System.Data.DbType"/> values.</param>

/// <param name="size">The length of the parameter.</param>

/// <param name="sourceColumn">The name of the source column.</param>

/// <param name="direction">One of the <see cref="System.Data.ParameterDirection"/> values.</param>

/// <param name="isNullable">

/// <see langword="true"/> if the value of the field can be <see langword="null"/>, otherwise <see langword="false"/>.

/// </param>

/// <param name="precision">

/// The total number of digits to the left and right of the decimal point to which <see cref="Value"/> is resolved.

/// </param>

/// <param name="scale">The total number of decimal places to which <see cref="Value"/> is resolved.</param>

/// <param name="sourceVersion">One of the <see cref="System.Data.DataRowVersion"/> values.</param>

/// <param name="value">An <see cref="object"/> that is the value of the <see cref="NpgsqlParameter"/>.</param>

public NpgsqlParameter(string parameterName, DbType parameterType, int size, string? sourceColumn,

}

#endregion

#region Name

/// <summary>

/// Gets or sets The name of the <see cref="NpgsqlParameter"/>.

/// </summary>

/// <value>The name of the <see cref="NpgsqlParameter"/>.

/// The default is an empty string.</value>

[AllowNull, DefaultValue("")]

public sealed override string ParameterName

}

internal void ChangeParameterName(string? value)

}

internal bool IsPositional => ParameterName.Length == 0;

#endregion Name

#region Value

/// <inheritdoc />

[TypeConverter(typeof(StringConverter)), Category("Data")]

public override object? Value

}

/// <summary>

/// Gets or sets the value of the parameter.

/// </summary>

/// <value>

/// An <see cref="object" /> that is the value of the parameter.

/// The default value is <see langword="null" />.

/// </value>

[Category("Data")]

[TypeConverter(typeof(StringConverter))]

public object? NpgsqlValue

}

#endregion Value

#region Type

/// <summary>

/// Gets or sets the <see cref="System.Data.DbType"/> of the parameter.

/// </summary>

/// <value>One of the <see cref="System.Data.DbType"/> values. The default is <see cref="object"/>.</value>

[DefaultValue(DbType.Object)]

[Category("Data"), RefreshProperties(RefreshProperties.All)]

public sealed override DbType DbType

}

/// <summary>

/// Gets or sets the <see cref="NpgsqlTypes.NpgsqlDbType"/> of the parameter.

/// </summary>

/// <value>One of the <see cref="NpgsqlTypes.NpgsqlDbType"/> values. The default is <see cref="NpgsqlTypes.NpgsqlDbType"/>.</value>

[DefaultValue(NpgsqlDbType.Unknown)]

[Category("Data"), RefreshProperties(RefreshProperties.All)]

[DbProviderSpecificTypeProperty(true)]

public NpgsqlDbType NpgsqlDbType

}

/// <summary>

/// Used to specify which PostgreSQL type will be sent to the database for this parameter.

/// </summary>

public string? DataTypeName

}

// Value without DBNull to pass onto FindDataTypeName.

object? ValueAsObject

}

#endregion Type

#region Other Properties

/// <inheritdoc />

public sealed override bool IsNullable { get; set; }

/// <inheritdoc />

[DefaultValue(ParameterDirection.Input)]

[Category("Data")]

public sealed override ParameterDirection Direction { get; set; }

/// <summary>

/// Gets or sets the maximum number of digits used to represent the <see cref="Value"/> property.

/// </summary>

/// <value>

/// The maximum number of digits used to represent the <see cref="Value"/> property.

/// The default value is 0, which indicates that the data provider sets the precision for <see cref="Value"/>.</value>

[DefaultValue((byte)0)]

[Category("Data")]

public new byte Precision

}

/// <summary>

/// Gets or sets the number of decimal places to which <see cref="Value"/> is resolved.

/// </summary>

/// <value>The number of decimal places to which <see cref="Value"/> is resolved. The default is 0.</value>

[DefaultValue((byte)0)]

[Category("Data")]

public new byte Scale

}

/// <inheritdoc />

[DefaultValue(0)]

[Category("Data")]

public sealed override int Size

}

/// <inheritdoc />

[AllowNull, DefaultValue("")]

[Category("Data")]

public sealed override string SourceColumn

}

/// <inheritdoc />

[Category("Data"), DefaultValue(DataRowVersion.Current)]

public sealed override DataRowVersion SourceVersion { get; set; }

/// <inheritdoc />

public sealed override bool SourceColumnNullMapping { get; set; }

/// <summary>

/// The collection to which this parameter belongs, if any.

/// </summary>

public NpgsqlParameterCollection? Collection { get; set; }

/// <summary>

/// The PostgreSQL data type, such as int4 or text, as discovered from pg_type.

/// This property is automatically set if parameters have been derived via

/// <see cref="NpgsqlCommandBuilder.DeriveParameters"/> and can be used to

/// acquire additional information about the parameters' data type.

/// </summary>

public PostgresType? PostgresType { get; internal set; }

#endregion Other Properties

#region Internals

/// The DBNull handling mode parameters apply at their own ADO.NET boundary.

/// Compositional converters inherit this from BindContext / ProviderValueContext.

internal const NestedObjectDbNullHandling ParameterDbNullHandling = NestedObjectDbNullHandling.Extended;

private protected virtual Type StaticValueType => typeof(object);

Type? GetValueType(Type staticValueType) => staticValueType != typeof(object) ? staticValueType : Value?.GetType();

bool TryResolveDbType(DataTypeName dataTypeName, out DbType dbType)

}

bool TryResolveDbTypeDataTypeName(DbType dbType, Type? type, [NotNullWhen(true)]out string? normalizedDataTypeName)

}

internal void SetOutputValue(NpgsqlDataReader reader, int ordinal)

}

internal bool ShouldResetObjectTypeInfo(object? value)

}

internal void GetResolutionInfo(out PgTypeInfo? typeInfo, out PgConcreteTypeInfo? concreteTypeInfo)

}

internal void SetResolutionInfo(PgTypeInfo typeInfo, PgConcreteTypeInfo concreteTypeInfo)

}

/// Attempt to resolve a type info based on available (postgres) type information on the parameter.

/// When <paramref name="willBind"/> is false (e.g. SchemaOnly), any provider-produced write state is

/// disposed immediately because no Bind call will follow to take ownership of it.

internal void ResolveTypeInfo(PgSerializerOptions options, IDbTypeResolver? dbTypeResolver, bool willBind = true)

}

/// Bind the current value to the type info, truncate (if applicable), take its size, and do any final validation before writing.

internal void Bind(out DataFormat format, out Size size, DataFormat? requiredFormat = null)

}

internal async ValueTask Write(bool async, PgWriter writer, CancellationToken cancellationToken)

{

if (!_isBound || ConcreteTypeInfo is not { } concrete)

{

ThrowHelper.ThrowInvalidOperationException("Missing type info or binding info.");

return;

}

try

{

if (writer.ShouldFlush(sizeof(int)))

await writer.Flush(async, cancellationToken).ConfigureAwait(false);

var size = _binding.Size?.Value ?? -1;

writer.WriteInt32(size);

writer.CommitAndResetTotal(sizeof(int));

if (!_binding.IsDbNullBinding)

{

if (_useSubStream)

{

Debug.Assert(_subStream is not null);

if (async)

await _subStream.CopyToAsync(writer.GetStream(), cancellationToken).ConfigureAwait(false);

else

_subStream.CopyTo(writer.GetStream());

writer.CommitAndResetTotal(size);

}

else

{

await writer.StartWrite(async, _binding, cancellationToken).ConfigureAwait(false);

if (StaticValueType == typeof(object))

{

var value = Value;

Debug.Assert(value is not null);

// The binding carries the format-correct converter resolved at Bind time.

if (async)

await _binding.Converter.WriteAsObjectAsync(writer, value, cancellationToken).ConfigureAwait(false);

else