// // Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. // using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.Data; using System.Data.Common; using System.Data.SqlClient; using System.Linq; using System.Threading; using System.Threading.Tasks; using Microsoft.SqlTools.ServiceLayer.Connection.Contracts; using Microsoft.SqlTools.ServiceLayer.Connection.ReliableConnection; using Microsoft.SqlTools.ServiceLayer.Hosting.Protocol; using Microsoft.SqlTools.ServiceLayer.SqlContext; using Microsoft.SqlTools.ServiceLayer.Utility; using Microsoft.SqlTools.ServiceLayer.Workspace; namespace Microsoft.SqlTools.ServiceLayer.Connection { /// /// Main class for the Connection Management services /// public class ConnectionService { /// /// Singleton service instance /// private static Lazy instance = new Lazy(() => new ConnectionService()); /// /// Gets the singleton service instance /// public static ConnectionService Instance { get { return instance.Value; } } /// /// The SQL connection factory object /// private ISqlConnectionFactory connectionFactory; private Dictionary ownerToConnectionMap = new Dictionary(); private ConcurrentDictionary ownerToCancellationTokenSourceMap = new ConcurrentDictionary(); private Object cancellationTokenSourceLock = new Object(); /// /// Map from script URIs to ConnectionInfo objects /// This is internal for testing access only /// internal Dictionary OwnerToConnectionMap { get { return this.ownerToConnectionMap; } } /// /// Service host object for sending/receiving requests/events. /// Internal for testing purposes. /// internal IProtocolEndpoint ServiceHost { get; set; } /// /// Default constructor is private since it's a singleton class /// private ConnectionService() { } /// /// Callback for onconnection handler /// /// public delegate Task OnConnectionHandler(ConnectionInfo info); /// // Callback for ondisconnect handler /// public delegate Task OnDisconnectHandler(ConnectionSummary summary, string ownerUri); /// /// List of onconnection handlers /// private readonly List onConnectionActivities = new List(); /// /// List of ondisconnect handlers /// private readonly List onDisconnectActivities = new List(); /// /// Gets the SQL connection factory instance /// public ISqlConnectionFactory ConnectionFactory { get { if (this.connectionFactory == null) { this.connectionFactory = new SqlConnectionFactory(); } return this.connectionFactory; } } /// /// Test constructor that injects dependency interfaces /// /// public ConnectionService(ISqlConnectionFactory testFactory) { this.connectionFactory = testFactory; } // Attempts to link a URI to an actively used connection for this URI public bool TryFindConnection(string ownerUri, out ConnectionInfo connectionInfo) { return this.ownerToConnectionMap.TryGetValue(ownerUri, out connectionInfo); } /// /// Open a connection with the specified connection details /// /// public async Task Connect(ConnectParams connectionParams) { // Validate parameters string paramValidationErrorMessage; if (connectionParams == null) { return new ConnectionCompleteParams { Messages = SR.ConnectionServiceConnectErrorNullParams }; } if (!connectionParams.IsValid(out paramValidationErrorMessage)) { return new ConnectionCompleteParams { OwnerUri = connectionParams.OwnerUri, Messages = paramValidationErrorMessage }; } // Resolve if it is an existing connection // Disconnect active connection if the URI is already connected ConnectionInfo connectionInfo; if (ownerToConnectionMap.TryGetValue(connectionParams.OwnerUri, out connectionInfo) ) { var disconnectParams = new DisconnectParams() { OwnerUri = connectionParams.OwnerUri }; Disconnect(disconnectParams); } connectionInfo = new ConnectionInfo(ConnectionFactory, connectionParams.OwnerUri, connectionParams.Connection); // try to connect var response = new ConnectionCompleteParams(); response.OwnerUri = connectionParams.OwnerUri; CancellationTokenSource source = null; try { // build the connection string from the input parameters string connectionString = ConnectionService.BuildConnectionString(connectionInfo.ConnectionDetails); // create a sql connection instance connectionInfo.SqlConnection = connectionInfo.Factory.CreateSqlConnection(connectionString); // turning on MARS to avoid break in LanguageService with multiple editors // we'll remove this once ConnectionService is refactored to not own the LanguageService connection connectionInfo.ConnectionDetails.MultipleActiveResultSets = true; // Add a cancellation token source so that the connection OpenAsync() can be cancelled using (source = new CancellationTokenSource()) { // Locking here to perform two operations as one atomic operation lock (cancellationTokenSourceLock) { // If the URI is currently connecting from a different request, cancel it before we try to connect CancellationTokenSource currentSource; if (ownerToCancellationTokenSourceMap.TryGetValue(connectionParams.OwnerUri, out currentSource)) { currentSource.Cancel(); } ownerToCancellationTokenSourceMap[connectionParams.OwnerUri] = source; } // Create a task to handle cancellation requests var cancellationTask = Task.Run(() => { source.Token.WaitHandle.WaitOne(); try { source.Token.ThrowIfCancellationRequested(); } catch (ObjectDisposedException) { // Ignore } }); var openTask = Task.Run(async () => { await connectionInfo.SqlConnection.OpenAsync(source.Token); }); // Open the connection await Task.WhenAny(openTask, cancellationTask).Unwrap(); source.Cancel(); } } catch (SqlException ex) { response.ErrorNumber = ex.Number; response.ErrorMessage = ex.Message; response.Messages = ex.ToString(); return response; } catch (OperationCanceledException) { // OpenAsync was cancelled response.Messages = SR.ConnectionServiceConnectionCanceled; return response; } catch (Exception ex) { response.ErrorMessage = ex.Message; response.Messages = ex.ToString(); return response; } finally { // Remove our cancellation token from the map since we're no longer connecting // Using a lock here to perform two operations as one atomic operation lock (cancellationTokenSourceLock) { // Only remove the token from the map if it is the same one created by this request CancellationTokenSource sourceValue; if (ownerToCancellationTokenSourceMap.TryGetValue(connectionParams.OwnerUri, out sourceValue) && sourceValue == source) { ownerToCancellationTokenSourceMap.TryRemove(connectionParams.OwnerUri, out sourceValue); } } } ownerToConnectionMap[connectionParams.OwnerUri] = connectionInfo; // Update with the actual database name in connectionInfo and result // Doing this here as we know the connection is open - expect to do this only on connecting connectionInfo.ConnectionDetails.DatabaseName = connectionInfo.SqlConnection.Database; response.ConnectionSummary = new ConnectionSummary() { ServerName = connectionInfo.ConnectionDetails.ServerName, DatabaseName = connectionInfo.ConnectionDetails.DatabaseName, UserName = connectionInfo.ConnectionDetails.UserName, }; // invoke callback notifications invokeOnConnectionActivities(connectionInfo); // try to get information about the connected SQL Server instance try { var reliableConnection = connectionInfo.SqlConnection as ReliableSqlConnection; DbConnection connection = reliableConnection != null ? reliableConnection.GetUnderlyingConnection() : connectionInfo.SqlConnection; ReliableConnectionHelper.ServerInfo serverInfo = ReliableConnectionHelper.GetServerVersion(connection); response.ServerInfo = new Contracts.ServerInfo() { ServerMajorVersion = serverInfo.ServerMajorVersion, ServerMinorVersion = serverInfo.ServerMinorVersion, ServerReleaseVersion = serverInfo.ServerReleaseVersion, EngineEditionId = serverInfo.EngineEditionId, ServerVersion = serverInfo.ServerVersion, ServerLevel = serverInfo.ServerLevel, ServerEdition = serverInfo.ServerEdition, IsCloud = serverInfo.IsCloud, AzureVersion = serverInfo.AzureVersion, OsVersion = serverInfo.OsVersion }; } catch(Exception ex) { response.Messages = ex.ToString(); } // return the connection result response.ConnectionId = connectionInfo.ConnectionId.ToString(); return response; } /// /// Cancel a connection that is in the process of opening. /// public bool CancelConnect(CancelConnectParams cancelParams) { // Validate parameters if (cancelParams == null || string.IsNullOrEmpty(cancelParams.OwnerUri)) { return false; } // Cancel any current connection attempts for this URI CancellationTokenSource source; if (ownerToCancellationTokenSourceMap.TryGetValue(cancelParams.OwnerUri, out source)) { try { source.Cancel(); return true; } catch { return false; } } else { return false; } } /// /// Close a connection with the specified connection details. /// public bool Disconnect(DisconnectParams disconnectParams) { // Validate parameters if (disconnectParams == null || string.IsNullOrEmpty(disconnectParams.OwnerUri)) { return false; } // Cancel if we are in the middle of connecting if (CancelConnect(new CancelConnectParams() { OwnerUri = disconnectParams.OwnerUri })) { return false; } // Lookup the connection owned by the URI ConnectionInfo info; if (!ownerToConnectionMap.TryGetValue(disconnectParams.OwnerUri, out info)) { return false; } // Close the connection info.SqlConnection.Close(); // Remove URI mapping ownerToConnectionMap.Remove(disconnectParams.OwnerUri); // Invoke callback notifications foreach (var activity in this.onDisconnectActivities) { activity(info.ConnectionDetails, disconnectParams.OwnerUri); } // Success return true; } /// /// List all databases on the server specified /// public ListDatabasesResponse ListDatabases(ListDatabasesParams listDatabasesParams) { // Verify parameters var owner = listDatabasesParams.OwnerUri; if (string.IsNullOrEmpty(owner)) { throw new ArgumentException(SR.ConnectionServiceListDbErrorNullOwnerUri); } // Use the existing connection as a base for the search ConnectionInfo info; if (!TryFindConnection(owner, out info)) { throw new Exception(SR.ConnectionServiceListDbErrorNotConnected(owner)); } ConnectionDetails connectionDetails = info.ConnectionDetails.Clone(); // Connect to master and query sys.databases connectionDetails.DatabaseName = "master"; var connection = this.ConnectionFactory.CreateSqlConnection(BuildConnectionString(connectionDetails)); connection.Open(); List results = new List(); var systemDatabases = new string[] {"master", "model", "msdb", "tempdb"}; using (DbCommand command = connection.CreateCommand()) { command.CommandText = "SELECT name FROM sys.databases ORDER BY name ASC"; command.CommandTimeout = 15; command.CommandType = CommandType.Text; using (var reader = command.ExecuteReader()) { while (reader.Read()) { results.Add(reader[0].ToString()); } } } // Put system databases at the top of the list results = results.Where(s => systemDatabases.Any(s.Equals)).Concat( results.Where(s => systemDatabases.All(x => !s.Equals(x)))).ToList(); connection.Close(); ListDatabasesResponse response = new ListDatabasesResponse(); response.DatabaseNames = results.ToArray(); return response; } public void InitializeService(IProtocolEndpoint serviceHost) { this.ServiceHost = serviceHost; // Register request and event handlers with the Service Host serviceHost.SetRequestHandler(ConnectionRequest.Type, HandleConnectRequest); serviceHost.SetRequestHandler(CancelConnectRequest.Type, HandleCancelConnectRequest); serviceHost.SetRequestHandler(DisconnectRequest.Type, HandleDisconnectRequest); serviceHost.SetRequestHandler(ListDatabasesRequest.Type, HandleListDatabasesRequest); // Register the configuration update handler WorkspaceService.Instance.RegisterConfigChangeCallback(HandleDidChangeConfigurationNotification); } /// /// Add a new method to be called when the onconnection request is submitted /// /// public void RegisterOnConnectionTask(OnConnectionHandler activity) { onConnectionActivities.Add(activity); } /// /// Add a new method to be called when the ondisconnect request is submitted /// public void RegisterOnDisconnectTask(OnDisconnectHandler activity) { onDisconnectActivities.Add(activity); } /// /// Handle new connection requests /// /// /// /// protected async Task HandleConnectRequest( ConnectParams connectParams, RequestContext requestContext) { Logger.Write(LogLevel.Verbose, "HandleConnectRequest"); try { RunConnectRequestHandlerTask(connectParams, requestContext); await requestContext.SendResult(true); } catch { await requestContext.SendResult(false); } } private void RunConnectRequestHandlerTask(ConnectParams connectParams, RequestContext requestContext) { // create a task to connect asynchronously so that other requests are not blocked in the meantime Task.Run(async () => { try { // open connection based on request details ConnectionCompleteParams result = await ConnectionService.Instance.Connect(connectParams); await ServiceHost.SendEvent(ConnectionCompleteNotification.Type, result); } catch (Exception ex) { ConnectionCompleteParams result = new ConnectionCompleteParams() { Messages = ex.ToString() }; await ServiceHost.SendEvent(ConnectionCompleteNotification.Type, result); } }); } /// /// Handle cancel connect requests /// protected async Task HandleCancelConnectRequest( CancelConnectParams cancelParams, RequestContext requestContext) { Logger.Write(LogLevel.Verbose, "HandleCancelConnectRequest"); try { bool result = ConnectionService.Instance.CancelConnect(cancelParams); await requestContext.SendResult(result); } catch(Exception ex) { await requestContext.SendError(ex.ToString()); } } /// /// Handle disconnect requests /// protected async Task HandleDisconnectRequest( DisconnectParams disconnectParams, RequestContext requestContext) { Logger.Write(LogLevel.Verbose, "HandleDisconnectRequest"); try { bool result = ConnectionService.Instance.Disconnect(disconnectParams); await requestContext.SendResult(result); } catch(Exception ex) { await requestContext.SendError(ex.ToString()); } } /// /// Handle requests to list databases on the current server /// protected async Task HandleListDatabasesRequest( ListDatabasesParams listDatabasesParams, RequestContext requestContext) { Logger.Write(LogLevel.Verbose, "ListDatabasesRequest"); try { ListDatabasesResponse result = ConnectionService.Instance.ListDatabases(listDatabasesParams); await requestContext.SendResult(result); } catch(Exception ex) { await requestContext.SendError(ex.ToString()); } } public Task HandleDidChangeConfigurationNotification( SqlToolsSettings newSettings, SqlToolsSettings oldSettings, EventContext eventContext) { return Task.FromResult(true); } /// /// Build a connection string from a connection details instance /// /// public static string BuildConnectionString(ConnectionDetails connectionDetails) { SqlConnectionStringBuilder connectionBuilder = new SqlConnectionStringBuilder(); connectionBuilder["Data Source"] = connectionDetails.ServerName; connectionBuilder["User Id"] = connectionDetails.UserName; connectionBuilder["Password"] = connectionDetails.Password; // Check for any optional parameters if (!string.IsNullOrEmpty(connectionDetails.DatabaseName)) { connectionBuilder["Initial Catalog"] = connectionDetails.DatabaseName; } if (!string.IsNullOrEmpty(connectionDetails.AuthenticationType)) { switch(connectionDetails.AuthenticationType) { case "Integrated": connectionBuilder.IntegratedSecurity = true; break; case "SqlLogin": break; default: throw new ArgumentException(SR.ConnectionServiceConnStringInvalidAuthType(connectionDetails.AuthenticationType)); } } if (connectionDetails.Encrypt.HasValue) { connectionBuilder.Encrypt = connectionDetails.Encrypt.Value; } if (connectionDetails.TrustServerCertificate.HasValue) { connectionBuilder.TrustServerCertificate = connectionDetails.TrustServerCertificate.Value; } if (connectionDetails.PersistSecurityInfo.HasValue) { connectionBuilder.PersistSecurityInfo = connectionDetails.PersistSecurityInfo.Value; } if (connectionDetails.ConnectTimeout.HasValue) { connectionBuilder.ConnectTimeout = connectionDetails.ConnectTimeout.Value; } if (connectionDetails.ConnectRetryCount.HasValue) { connectionBuilder.ConnectRetryCount = connectionDetails.ConnectRetryCount.Value; } if (connectionDetails.ConnectRetryInterval.HasValue) { connectionBuilder.ConnectRetryInterval = connectionDetails.ConnectRetryInterval.Value; } if (!string.IsNullOrEmpty(connectionDetails.ApplicationName)) { connectionBuilder.ApplicationName = connectionDetails.ApplicationName; } if (!string.IsNullOrEmpty(connectionDetails.WorkstationId)) { connectionBuilder.WorkstationID = connectionDetails.WorkstationId; } if (!string.IsNullOrEmpty(connectionDetails.ApplicationIntent)) { ApplicationIntent intent; switch (connectionDetails.ApplicationIntent) { case "ReadOnly": intent = ApplicationIntent.ReadOnly; break; case "ReadWrite": intent = ApplicationIntent.ReadWrite; break; default: throw new ArgumentException(SR.ConnectionServiceConnStringInvalidIntent(connectionDetails.ApplicationIntent)); } connectionBuilder.ApplicationIntent = intent; } if (!string.IsNullOrEmpty(connectionDetails.CurrentLanguage)) { connectionBuilder.CurrentLanguage = connectionDetails.CurrentLanguage; } if (connectionDetails.Pooling.HasValue) { connectionBuilder.Pooling = connectionDetails.Pooling.Value; } if (connectionDetails.MaxPoolSize.HasValue) { connectionBuilder.MaxPoolSize = connectionDetails.MaxPoolSize.Value; } if (connectionDetails.MinPoolSize.HasValue) { connectionBuilder.MinPoolSize = connectionDetails.MinPoolSize.Value; } if (connectionDetails.LoadBalanceTimeout.HasValue) { connectionBuilder.LoadBalanceTimeout = connectionDetails.LoadBalanceTimeout.Value; } if (connectionDetails.Replication.HasValue) { connectionBuilder.Replication = connectionDetails.Replication.Value; } if (!string.IsNullOrEmpty(connectionDetails.AttachDbFilename)) { connectionBuilder.AttachDBFilename = connectionDetails.AttachDbFilename; } if (!string.IsNullOrEmpty(connectionDetails.FailoverPartner)) { connectionBuilder.FailoverPartner = connectionDetails.FailoverPartner; } if (connectionDetails.MultiSubnetFailover.HasValue) { connectionBuilder.MultiSubnetFailover = connectionDetails.MultiSubnetFailover.Value; } if (connectionDetails.MultipleActiveResultSets.HasValue) { connectionBuilder.MultipleActiveResultSets = connectionDetails.MultipleActiveResultSets.Value; } if (connectionDetails.PacketSize.HasValue) { connectionBuilder.PacketSize = connectionDetails.PacketSize.Value; } if (!string.IsNullOrEmpty(connectionDetails.TypeSystemVersion)) { connectionBuilder.TypeSystemVersion = connectionDetails.TypeSystemVersion; } return connectionBuilder.ToString(); } /// /// Change the database context of a connection. /// /// URI of the owner of the connection /// Name of the database to change the connection to public void ChangeConnectionDatabaseContext(string ownerUri, string newDatabaseName) { ConnectionInfo info; if (TryFindConnection(ownerUri, out info)) { try { if (info.SqlConnection.State == ConnectionState.Open) { info.SqlConnection.ChangeDatabase(newDatabaseName); } info.ConnectionDetails.DatabaseName = newDatabaseName; // Fire a connection changed event ConnectionChangedParams parameters = new ConnectionChangedParams(); ConnectionSummary summary = (ConnectionSummary)(info.ConnectionDetails); parameters.Connection = summary.Clone(); parameters.OwnerUri = ownerUri; ServiceHost.SendEvent(ConnectionChangedNotification.Type, parameters); } catch (Exception e) { Logger.Write( LogLevel.Error, string.Format( "Exception caught while trying to change database context to [{0}] for OwnerUri [{1}]. Exception:{2}", newDatabaseName, ownerUri, e.ToString()) ); } } } private void invokeOnConnectionActivities(ConnectionInfo connectionInfo) { foreach (var activity in this.onConnectionActivities) { // not awaiting here to allow handlers to run in the background activity(connectionInfo); } } } }