using System;

using System.Collections.Generic;

using System.ComponentModel;

using System.Data;

using System.Data.Common;

using System.Diagnostics;

using System.Diagnostics.CodeAnalysis;

using System.IO;

using System.Net.Security;

using System.Net.Sockets;

using System.Runtime.CompilerServices;

using System.Security.Cryptography.X509Certificates;

using System.Threading;

using System.Threading.Tasks;

using System.Transactions;

using Npgsql.Logging;

using Npgsql.NameTranslation;

using Npgsql.TypeMapping;

using Npgsql.Util;

using NpgsqlTypes;

using IsolationLevel = System.Data.IsolationLevel;

using static Npgsql.Util.Statics;

namespace Npgsql

/// <summary>

/// This class represents a connection to a PostgreSQL server.

/// </summary>

// ReSharper disable once RedundantNameQualifier

[System.ComponentModel.DesignerCategory("")]

public sealed class NpgsqlConnection : DbConnection, ICloneable, IComponent

{

#region Fields

// Set this when disposed is called.

bool _disposed;

/// <summary>

/// The connection string, without the password after open (unless Persist Security Info=true)

/// </summary>

string _userFacingConnectionString = string.Empty;

/// <summary>

/// The original connection string provided by the user, including the password.

/// </summary>

string _connectionString = string.Empty;

internal string OriginalConnectionString => _connectionString;

ConnectionState _fullState;

/// <summary>

/// The physical connection to the database. This is <see langword="null"/> when the connection is closed,

/// and also when it is open in multiplexing mode and unbound (e.g. not in a transaction).

/// </summary>

internal NpgsqlConnector? Connector { get; set; }

/// <summary>

/// The parsed connection string. Set only after the connection is opened.

/// </summary>

public NpgsqlConnectionStringBuilder Settings { get; private set; } = DefaultSettings;

static readonly NpgsqlConnectionStringBuilder DefaultSettings = new();

ConnectorSource? _pool;

internal ConnectorSource Pool

}

/// <summary>

/// A cached command handed out by <see cref="CreateCommand" />, which is returned when disposed. Useful for reducing allocations.

/// </summary>

internal NpgsqlCommand? CachedCommand { get; set; }

/// <summary>

/// Flag used to make sure we never double-close a connection, returning it twice to the pool.

/// </summary>

int _closing;

internal Transaction? EnlistedTransaction { get; set; }

/// <summary>

/// The global type mapper, which contains defaults used by all new connections.

/// Modify mappings on this mapper to affect your entire application.

/// </summary>

public static INpgsqlTypeMapper GlobalTypeMapper => TypeMapping.GlobalTypeMapper.Instance;

/// <summary>

/// The connection-specific type mapper - all modifications affect this connection only,

/// and are lost when it is closed.

/// </summary>

public INpgsqlTypeMapper TypeMapper

}

/// <summary>

/// The default TCP/IP port for PostgreSQL.

/// </summary>

public const int DefaultPort = 5432;

/// <summary>

/// Maximum value for connection timeout.

/// </summary>

internal const int TimeoutLimit = 1024;

/// <summary>

/// Tracks when this connection was bound to a physical connector (e.g. at open-time, when a transaction

/// was started...).

/// </summary>

internal ConnectorBindingScope ConnectorBindingScope { get; set; }

static readonly NpgsqlLogger Log = NpgsqlLogManager.CreateLogger(nameof(NpgsqlConnection));

static readonly StateChangeEventArgs ClosedToOpenEventArgs = new(ConnectionState.Closed, ConnectionState.Open);

static readonly StateChangeEventArgs OpenToClosedEventArgs = new(ConnectionState.Open, ConnectionState.Closed);

#endregion Fields

#region Constructors / Init / Open

/// <summary>

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

/// </summary>

public NpgsqlConnection()

=> GC.SuppressFinalize(this);

/// <summary>

/// Initializes a new instance of <see cref="NpgsqlConnection"/> with the given connection string.

/// </summary>

/// <param name="connectionString">The connection used to open the PostgreSQL database.</param>

public NpgsqlConnection(string? connectionString) : this()

=> ConnectionString = connectionString;

/// <summary>

/// Opens a database connection with the property settings specified by the <see cref="ConnectionString"/>.

/// </summary>

public override void Open() => Open(false, CancellationToken.None).GetAwaiter().GetResult();

/// <summary>

/// This is the asynchronous version of <see cref="Open()"/>.

/// </summary>

/// <remarks>

/// Do not invoke other methods and properties of the <see cref="NpgsqlConnection"/> object until the returned Task is complete.

/// </remarks>

/// <param name="cancellationToken">

/// An optional token to cancel the asynchronous operation. The default value is <see cref="CancellationToken.None"/>.

/// </param>

/// <returns>A task representing the asynchronous operation.</returns>

public override Task OpenAsync(CancellationToken cancellationToken)

}

void GetPoolAndSettings()

}

internal Task Open(bool async, CancellationToken cancellationToken)

}

#endregion Open / Init

#region Connection string management

/// <summary>

/// Gets or sets the string used to connect to a PostgreSQL database. See the manual for details.

/// </summary>

/// <value>The connection string that includes the server name,

/// the database name, and other parameters needed to establish

/// the initial connection. The default value is an empty string.

/// </value>

[AllowNull]

public override string ConnectionString

}

/// <summary>

/// Gets or sets the delegate used to generate a password for new database connections.

/// </summary>

/// <remarks>

/// <p>

/// This delegate is executed when a new database connection is opened that requires a password.

/// </p>

/// <p>

/// The <see cref="NpgsqlConnectionStringBuilder.Password"/> and <see cref="NpgsqlConnectionStringBuilder.Passfile"/> connection

/// string properties have precedence over this delegate: it will not be executed if a password is specified, or if the specified or

/// default Passfile contains a valid entry.

/// </p>

/// <p>

/// Due to connection pooling this delegate is only executed when a new physical connection is opened, not when reusing a connection

/// that was previously opened from the pool.

/// </p>

/// </remarks>

public ProvidePasswordCallback? ProvidePasswordCallback { get; set; }

#endregion Connection string management

#region Configuration settings

/// <summary>

/// Backend server host name.

/// </summary>

[Browsable(true)]

public string? Host => Connector?.Host;

/// <summary>

/// Backend server port.

/// </summary>

[Browsable(true)]

public int Port => Connector?.Port ?? 0;

/// <summary>

/// Gets the time (in seconds) to wait while trying to establish a connection

/// before terminating the attempt and generating an error.

/// </summary>

/// <value>The time (in seconds) to wait for a connection to open. The default value is 15 seconds.</value>

public override int ConnectionTimeout => Settings.Timeout;

/// <summary>

/// Gets the time (in seconds) to wait while trying to execute a command

/// before terminating the attempt and generating an error.

/// </summary>

/// <value>The time (in seconds) to wait for a command to complete. The default value is 20 seconds.</value>

public int CommandTimeout => Settings.CommandTimeout;

///<summary>

/// Gets the name of the current database or the database to be used after a connection is opened.

/// </summary>

/// <value>The name of the current database or the name of the database to be

/// used after a connection is opened. The default value is the empty string.</value>

public override string Database => Settings.Database ?? Settings.Username ?? "";

/// <summary>

/// Gets the string identifying the database server (host and port)

/// </summary>

/// <value>

/// The name of the database server (host and port). If the connection uses a Unix-domain socket,

/// the path to that socket is returned. The default value is the empty string.

/// </value>

public override string DataSource => Connector?.Settings.DataSourceCached ?? string.Empty;

/// <summary>

/// Whether to use Windows integrated security to log in.

/// </summary>

public bool IntegratedSecurity => Settings.IntegratedSecurity;

/// <summary>

/// User name.

/// </summary>

public string? UserName => Settings.Username;

internal string? Password => Settings.Password;

// The following two lines are here for backwards compatibility with the EF6 provider

// ReSharper disable UnusedMember.Global

internal string? EntityTemplateDatabase => Settings.EntityTemplateDatabase;

internal string? EntityAdminDatabase => Settings.EntityAdminDatabase;

// ReSharper restore UnusedMember.Global

#endregion Configuration settings

#region State management

/// <summary>

/// Gets the current state of the connection.

/// </summary>

/// <value>A bitwise combination of the <see cref="System.Data.ConnectionState"/> values. The default is <b>Closed</b>.</value>

[Browsable(false)]

public ConnectionState FullState

}

/// <summary>

/// Gets whether the current state of the connection is Open or Closed

/// </summary>

/// <value>ConnectionState.Open, ConnectionState.Closed or ConnectionState.Connecting</value>

[Browsable(false)]

public override ConnectionState State

}

#endregion State management

#region Commands

/// <summary>

/// Creates and returns a <see cref="System.Data.Common.DbCommand"/>

/// object associated with the <see cref="System.Data.Common.DbConnection"/>.

/// </summary>

/// <returns>A <see cref="System.Data.Common.DbCommand"/> object.</returns>

protected override DbCommand CreateDbCommand() => CreateCommand();

/// <summary>

/// Creates and returns a <see cref="NpgsqlCommand"/> object associated with the <see cref="NpgsqlConnection"/>.

/// </summary>

/// <returns>A <see cref="NpgsqlCommand"/> object.</returns>

public new NpgsqlCommand CreateCommand()

}

#endregion Commands

#region Transactions

/// <summary>

/// Begins a database transaction with the specified isolation level.

/// </summary>

/// <param name="isolationLevel">The isolation level under which the transaction should run.</param>

/// <returns>A <see cref="System.Data.Common.DbTransaction"/> object representing the new transaction.</returns>

/// <remarks>Nested transactions are not supported.</remarks>

protected override DbTransaction BeginDbTransaction(IsolationLevel isolationLevel) => BeginTransaction(isolationLevel);

/// <summary>

/// Begins a database transaction.

/// </summary>

/// <returns>A <see cref="NpgsqlTransaction"/> object representing the new transaction.</returns>

/// <remarks>

/// Nested transactions are not supported.

/// Transactions created by this method will have the <see cref="IsolationLevel.ReadCommitted"/> isolation level.

/// </remarks>

public new NpgsqlTransaction BeginTransaction()

=> BeginTransaction(IsolationLevel.Unspecified);

/// <summary>

/// Begins a database transaction with the specified isolation level.

/// </summary>

/// <param name="level">The isolation level under which the transaction should run.</param>

/// <returns>A <see cref="NpgsqlTransaction"/> object representing the new transaction.</returns>

/// <remarks>Nested transactions are not supported.</remarks>

public new NpgsqlTransaction BeginTransaction(IsolationLevel level)

=> BeginTransaction(level, async: false, CancellationToken.None).GetAwaiter().GetResult();

async ValueTask<NpgsqlTransaction> BeginTransaction(IsolationLevel level, bool async, CancellationToken cancellationToken)

}

#if !NETSTANDARD2_0

/// <summary>

/// Asynchronously begins a database transaction.

/// </summary>

/// <param name="cancellationToken">

/// An optional token to cancel the asynchronous operation. The default value is <see cref="CancellationToken.None"/>.

/// </param>

/// <returns>A task whose Result property is an object representing the new transaction.</returns>

/// <remarks>

/// Nested transactions are not supported.

/// Transactions created by this method will have the <see cref="IsolationLevel.ReadCommitted"/> isolation level.

/// </remarks>

public new ValueTask<NpgsqlTransaction> BeginTransactionAsync(CancellationToken cancellationToken = default)

=> BeginTransactionAsync(IsolationLevel.Unspecified, cancellationToken);

/// <summary>

/// Asynchronously begins a database transaction.

/// </summary>

/// <param name="level">The isolation level under which the transaction should run.</param>

/// <param name="cancellationToken">

/// An optional token to cancel the asynchronous operation. The default value is <see cref="CancellationToken.None"/>.

/// </param>

/// <returns>A task whose <see cref="ValueTask{T}.Result"/> property is an object representing the new transaction.</returns>

/// <remarks>

/// Nested transactions are not supported.

/// </remarks>

public new ValueTask<NpgsqlTransaction> BeginTransactionAsync(IsolationLevel level, CancellationToken cancellationToken = default)

}

#endif

/// <summary>

/// Enlist transaction.

/// </summary>

public override void EnlistTransaction(Transaction? transaction)

}

#endregion

#region Close

/// <summary>

/// Releases the connection. If the connection is pooled, it will be returned to the pool and made available for re-use.

/// If it is non-pooled, the physical connection will be closed.

/// </summary>

public override void Close() => Close(async: false);

/// <summary>

/// Releases the connection. If the connection is pooled, it will be returned to the pool and made available for re-use.

/// If it is non-pooled, the physical connection will be closed.

/// </summary>

#if NETSTANDARD2_0

public Task CloseAsync()

#else

public override Task CloseAsync()

}

internal Task Close(bool async, CancellationToken cancellationToken = default)

}

async Task CloseAsync(bool async, CancellationToken cancellationToken)

}

/// <summary>

/// Releases all resources used by the <see cref="NpgsqlConnection"/>.

/// </summary>

/// <param name="disposing"><see langword="true"/> when called from <see cref="Dispose"/>;

/// <see langword="false"/> when being called from the finalizer.</param>

protected override void Dispose(bool disposing)

}

/// <summary>

/// Releases all resources used by the <see cref="NpgsqlConnection"/>.

/// </summary>

#if NETSTANDARD2_0

public async ValueTask DisposeAsync()

#else

public override async ValueTask DisposeAsync()

}

#endregion

#region Notifications and Notices

/// <summary>

/// Fires when PostgreSQL notices are received from PostgreSQL.

/// </summary>

/// <remarks>

/// PostgreSQL notices are non-critical messages generated by PostgreSQL, either as a result of a user query

/// (e.g. as a warning or informational notice), or due to outside activity (e.g. if the database administrator

/// initiates a "fast" database shutdown).

///

/// Note that notices are very different from notifications (see the <see cref="Notification"/> event).

/// </remarks>

public event NoticeEventHandler? Notice;

/// <summary>

/// Fires when PostgreSQL notifications are received from PostgreSQL.

/// </summary>

/// <remarks>

/// PostgreSQL notifications are sent when your connection has registered for notifications on a specific channel via the

/// LISTEN command. NOTIFY can be used to generate such notifications, allowing for an inter-connection communication channel.

///

/// Note that notifications are very different from notices (see the <see cref="Notice"/> event).

/// </remarks>

public event NotificationEventHandler? Notification;

internal void OnNotice(PostgresNotice e)

}

internal void OnNotification(NpgsqlNotificationEventArgs e)

}

#endregion Notifications and Notices

#region SSL

/// <summary>

/// Returns whether SSL is being used for the connection.

/// </summary>

internal bool IsSecure => CheckOpenAndRunInTemporaryScope(c => c.IsSecure);

/// <summary>

/// Returns whether SCRAM-SHA256 is being user for the connection

/// </summary>

internal bool IsScram => CheckOpenAndRunInTemporaryScope(c => c.IsScram);

/// <summary>

/// Returns whether SCRAM-SHA256-PLUS is being user for the connection

/// </summary>

internal bool IsScramPlus => CheckOpenAndRunInTemporaryScope(c => c.IsScramPlus);

/// <summary>

/// Selects the local Secure Sockets Layer (SSL) certificate used for authentication.

/// </summary>

/// <remarks>

/// See <see href="https://msdn.microsoft.com/en-us/library/system.net.security.localcertificateselectioncallback(v=vs.110).aspx"/>

/// </remarks>

public ProvideClientCertificatesCallback? ProvideClientCertificatesCallback { get; set; }

/// <summary>

/// Verifies the remote Secure Sockets Layer (SSL) certificate used for authentication.

/// Ignored if <see cref="NpgsqlConnectionStringBuilder.TrustServerCertificate"/> is set.

/// </summary>

/// <remarks>

/// See <see href="https://msdn.microsoft.com/en-us/library/system.net.security.remotecertificatevalidationcallback(v=vs.110).aspx"/>

/// </remarks>

public RemoteCertificateValidationCallback? UserCertificateValidationCallback { get; set; }

#endregion SSL

#region Backend version, capabilities, settings

// TODO: We should probably move DatabaseInfo from each connector to the pool (but remember unpooled)

/// <summary>

/// Version of the PostgreSQL backend.

/// This can only be called when there is an active connection.

/// </summary>

[Browsable(false)]

public Version PostgreSqlVersion => CheckOpenAndRunInTemporaryScope(c => c.DatabaseInfo.Version);

/// <summary>

/// PostgreSQL server version.

/// </summary>

public override string ServerVersion => PostgreSqlVersion.ToString();

/// <summary>

/// Process id of backend server.

/// This can only be called when there is an active connection.

/// </summary>

[Browsable(false)]

// ReSharper disable once InconsistentNaming

public int ProcessID