DSN window implementation

Author: alinaliBQ

cpp/src/arrow/flight/sql/odbc/flight_sql/system_dsn.h

@@ -21,6 +21,7 @@
 #include "arrow/flight/sql/odbc/flight_sql/include/flight_sql/config/configuration.h"
 
 using driver::flight_sql::config::Configuration;
+using driver::odbcabstraction::Connection;
 
 #if defined _WIN32 || defined _WIN64
 /**
@@ -31,6 +32,19 @@ using driver::flight_sql::config::Configuration;
  * @return True on success and false on fail.
  */
 bool DisplayConnectionWindow(void* windowParent, Configuration& config);
+
+/**
+ * For SQLDriverConnect.
+ * Display connection window for user to configure connection parameters.
+ *
+ * @param windowParent Parent window handle.
+ * @param config Output configuration, presumed to be empty, it will be using values from
+ * properties.
+ * @param config Output properties.
+ * @return True on success and false on fail.
+ */
+void DisplayConnectionWindow(void* windowParent, Configuration& config,
+                             Connection::ConnPropertyMap& properties);
 #endif
 
 /**

cpp/src/arrow/flight/sql/odbc/flight_sql/win_system_dsn.cc

@@ -41,6 +41,7 @@ using driver::flight_sql::config::ConnectionStringParser;
 using driver::flight_sql::config::DsnConfigurationWindow;
 using driver::flight_sql::config::Result;
 using driver::flight_sql::config::Window;
+using driver::odbcabstraction::DriverException;
 
 BOOL CALLBACK ConfigDriver(HWND hwndParent, WORD fRequest, LPCSTR lpszDriver,
                            LPCSTR lpszArgs, LPSTR lpszMsg, WORD cbMsgMax,
@@ -63,7 +64,7 @@ bool DisplayConnectionWindow(void* windowParent, Configuration& config) {
     window.Update();
 
     return ProcessMessages(window) == Result::OK;
-  } catch (const driver::odbcabstraction::DriverException& err) {
+  } catch (const DriverException& err) {
     std::stringstream buf;
     buf << "SQL State: " << err.GetSqlState() << ", Message: " << err.GetMessageText()
         << ", Code: " << err.GetNativeError();
@@ -76,6 +77,19 @@ bool DisplayConnectionWindow(void* windowParent, Configuration& config) {
   return false;
 }
 
+void DisplayConnectionWindow(void* windowParent, Configuration& config,
+                             Connection::ConnPropertyMap& properties) {
+  for (const auto& [key, value] : properties) {
+    config.Set(key, value);
+  }
+
+  if (DisplayConnectionWindow(windowParent, config)) {
+    properties = config.GetProperties();
+  } else {
+    throw DriverException("Connection canceled by user", "HY008");
+  }
+}
+
 BOOL INSTAPI ConfigDSN(HWND hwndParent, WORD req, LPCSTR driver, LPCSTR attributes) {
   Configuration config;
   ConnectionStringParser parser(config);

cpp/src/arrow/flight/sql/odbc/odbc_api.cc

@@ -354,6 +354,7 @@ SQLRETURN SQLDriverConnectW(SQLHDBC conn, SQLHWND windowHandle,
   // spec https://github.com/apache/arrow/issues/46560
 
   using driver::odbcabstraction::Connection;
+  using driver::odbcabstraction::DriverException;
   using ODBC::ODBCConnection;
 
   return ODBCConnection::ExecuteWithDiagnostics(conn, SQL_ERROR, [=]() {
@@ -369,16 +370,37 @@ SQLRETURN SQLDriverConnectW(SQLHDBC conn, SQLHWND windowHandle,
     // TODO: Implement SQL_DRIVER_COMPLETE_REQUIRED in SQLDriverConnectW according to the
     // spec https://github.com/apache/arrow/issues/46448
 #if defined _WIN32 || defined _WIN64
-    if (driverCompletion == SQL_DRIVER_PROMPT ||
-        ((driverCompletion == SQL_DRIVER_COMPLETE ||
-          driverCompletion == SQL_DRIVER_COMPLETE_REQUIRED) &&
-         !missing_properties.empty())) {
-      // TODO: implement driverCompletion behavior to display connection window.
+    // Attempt connection once, if connection failed due to missing properties,
+    // load the DSN window according to driverCompletion
+
+    driver::flight_sql::config::Configuration config;
+    if (driverCompletion == SQL_DRIVER_PROMPT) {
+      DisplayConnectionWindow(windowHandle, config, properties);
+      connection->connect(dsn, properties, missing_properties);
+    } else if (driverCompletion == SQL_DRIVER_COMPLETE ||
+               driverCompletion == SQL_DRIVER_COMPLETE_REQUIRED) {
+      try {
+        connection->connect(dsn, properties, missing_properties);
+      } catch (DriverException& ex) {
+        // If first connection fails due to missing attributes, load
+        // the DSN window and try to connect again
+        if (!missing_properties.empty()) {
+          missing_properties.clear();
+
+          DisplayConnectionWindow(windowHandle, config, properties);
+          connection->connect(dsn, properties, missing_properties);
+        } else {
+          throw ex;
+        }
+      }
+    } else {
+      // Default case: attempt connection without showing DSN window
+      connection->connect(dsn, properties, missing_properties);
     }
-#endif
-
+#else
+    // Attempt connection without loading DSN window on macOS/Linux
     connection->connect(dsn, properties, missing_properties);
-
+#endif
     // Copy connection string to outConnectionString after connection attempt
     return ODBC::GetStringAttribute(true, connection_string, true, outConnectionString,
                                     outConnectionStringBufferLen, outConnectionStringLen,