CSharp extension: ZIP archive support for InstallExternalLibrary/UninstallExternalLibrary

language-extensions/dotnet-core-CSharp/include/nativecsharpextension.h

@@ -142,6 +142,33 @@ SQLEXTENSION_INTERFACE SQLRETURN CleanupSession(SQLGUID sessionId, SQLUSMALLINT
 //
 SQLEXTENSION_INTERFACE SQLRETURN Cleanup();
 
+//  Installs an external library to the specified directory.
+//  The library file is expected to be a zip. If it contains an inner zip,
+//  that zip is extracted to the install directory. Otherwise, all files
+//  are copied directly.
+//
+SQLEXTENSION_INTERFACE SQLRETURN InstallExternalLibrary(
+    SQLGUID    setupSessionId,
+    SQLCHAR    *libraryName,
+    SQLINTEGER libraryNameLength,
+    SQLCHAR    *libraryFile,
+    SQLINTEGER libraryFileLength,
+    SQLCHAR    *libraryInstallDirectory,
+    SQLINTEGER libraryInstallDirectoryLength,
+    SQLCHAR    **libraryError,
+    SQLINTEGER *libraryErrorLength);
+
+//  Uninstalls an external library from the specified directory.
+//
+SQLEXTENSION_INTERFACE SQLRETURN UninstallExternalLibrary(
+    SQLGUID    setupSessionId,
+    SQLCHAR    *libraryName,
+    SQLINTEGER libraryNameLength,
+    SQLCHAR    *libraryInstallDirectory,
+    SQLINTEGER libraryInstallDirectoryLength,
+    SQLCHAR    **libraryError,
+    SQLINTEGER *libraryErrorLength);
+
 //  Dotnet environment pointer
 //
 static DotnetEnvironment* g_dotnet_runtime = nullptr;

language-extensions/dotnet-core-CSharp/src/managed/utils/DllUtils.cs

@@ -91,15 +91,12 @@ public static List<string> CreateDllList(
             }
             else
             {
-                if (!string.IsNullOrEmpty(privatePath))
-                {
-                    dllList.AddRange(Directory.GetFiles(privatePath, userLibName));
-                }
-
-                if (!string.IsNullOrEmpty(publicPath))
-                {
-                    dllList.AddRange(Directory.GetFiles(publicPath, userLibName));
-                }
+                // Callers may pass either a bare library name ("regex") or an explicit
+                // filename ("Foo.dll"). Try the exact name first so filenames with
+                // extensions resolve correctly; fall back to the "{name}.*" wildcard
+                // for bare names.
+                AddMatches(privatePath, userLibName, dllList);
+                AddMatches(publicPath, userLibName, dllList);
             }
 
             if (dllList.Count == 0)
@@ -110,6 +107,36 @@ public static List<string> CreateDllList(
             return dllList;
         }
 
+        /// <summary>
+        /// Adds DLL matches for <paramref name="userLibName"/> under
+        /// <paramref name="searchPath"/>. Tries the exact name first (so callers
+        /// that pass "Foo.dll" resolve correctly) and falls back to the
+        /// "{name}.*" wildcard for bare names (so callers that pass "Foo"
+        /// still match "Foo.dll", "Foo.runtimeconfig.json", etc.).
+        /// </summary>
+        private static void AddMatches(string searchPath, string userLibName, List<string> dllList)
+        {
+            if (string.IsNullOrEmpty(searchPath) || !Directory.Exists(searchPath))
+            {
+                return;
+            }
+
+            string exactPath = Path.Combine(searchPath, userLibName);
+            if (File.Exists(exactPath))
+            {
+                dllList.Add(exactPath);
+                return;
+            }
+
+            // The "{name}.*" wildcard matches non-DLL siblings too
+            // ("{name}.runtimeconfig.json", "{name}.deps.json", etc.). Only
+            // .dll files are valid Assembly.LoadFrom targets, so filter the
+            // wildcard match to avoid spamming the error log when the loader
+            // tries to load a JSON file as an assembly.
+            dllList.AddRange(Directory.GetFiles(searchPath, userLibName + ".*")
+                .Where(f => f.EndsWith(".dll", StringComparison.OrdinalIgnoreCase)));
+        }
+
         /// <summary>
         /// This method finds the corresponding loaded dll for user dll's dependencies.
         /// It searches for the corresponding loaded dll that matches args.Name.

language-extensions/dotnet-core-CSharp/src/native/nativecsharpextension.cpp

@@ -340,4 +340,139 @@ SQLRETURN Cleanup()
     LOG("nativecsharpextension::Cleanup");
     delete g_dotnet_runtime;
     return SQL_SUCCESS;
+}
+
+//--------------------------------------------------------------------------------------------------
+// Name: SetLibraryError
+//
+// Description:
+//  Helper to populate the library error output parameters.
+//
+static void SetLibraryError(
+    const std::string &errorString,
+    SQLCHAR    **libraryError,
+    SQLINTEGER *libraryErrorLength)
+{
+    // Guard against null out-parameters. The managed SetLibraryError
+    // (CSharpExtension.cs) does the same null-check; without it, a caller
+    // passing null libraryError / libraryErrorLength would dereference null
+    // and crash the host process.
+    if (libraryError == nullptr || libraryErrorLength == nullptr)
+    {
+        return;
+    }
+
+    if (!errorString.empty())
+    {
+        // Length excludes null terminator -- ExtHost adds +1 when copying
+        // (see Utf8ToNullTerminatedUtf16Le / strcpy_s in the host).
+        *libraryErrorLength = static_cast<SQLINTEGER>(errorString.length());
+        std::string *pError = new std::string(errorString);
+        *libraryError = const_cast<SQLCHAR*>(
+            reinterpret_cast<const SQLCHAR *>(pError->c_str()));
+    }
+    else
+    {
+        // Explicitly clear the out-parameters so callers that don't
+        // pre-initialize them see a well-defined "no error" state.
+        *libraryError = nullptr;
+        *libraryErrorLength = 0;
+    }
+}
+
+//--------------------------------------------------------------------------------------------------
+// Name: InstallExternalLibrary
+//
+// Description:
+//  Installs an external library to the specified directory.
+//  The library file is expected to be a zip containing the library files.
+//  If it contains an inner zip, that zip is extracted to the install directory.
+//  Otherwise, all files are copied directly.
+//
+// Returns:
+//  SQL_SUCCESS on success, else SQL_ERROR
+//
+SQLRETURN InstallExternalLibrary(
+    SQLGUID    setupSessionId,
+    SQLCHAR    *libraryName,
+    SQLINTEGER libraryNameLength,
+    SQLCHAR    *libraryFile,
+    SQLINTEGER libraryFileLength,
+    SQLCHAR    *libraryInstallDirectory,
+    SQLINTEGER libraryInstallDirectoryLength,
+    SQLCHAR    **libraryError,
+    SQLINTEGER *libraryErrorLength)
+{
+    LOG("nativecsharpextension::InstallExternalLibrary");
+
+    SQLRETURN result = SQL_ERROR;
+
+    if (g_dotnet_runtime == nullptr)
+    {
+        SetLibraryError(
+            "Extension not initialized. Call Init before InstallExternalLibrary.",
+            libraryError,
+            libraryErrorLength);
+    }
+    else
+    {
+        result = g_dotnet_runtime->call_managed_method<decltype(&InstallExternalLibrary)>(
+            nameof(InstallExternalLibrary),
+            setupSessionId,
+            libraryName,
+            libraryNameLength,
+            libraryFile,
+            libraryFileLength,
+            libraryInstallDirectory,
+            libraryInstallDirectoryLength,
+            libraryError,
+            libraryErrorLength);
+    }
+
+    return result;
+}
+
+//--------------------------------------------------------------------------------------------------
+// Name: UninstallExternalLibrary
+//
+// Description:
+//  Uninstalls an external library from the specified directory.
+//
+// Returns:
+//  SQL_SUCCESS on success, else SQL_ERROR
+//
+SQLRETURN UninstallExternalLibrary(
+    SQLGUID    setupSessionId,
+    SQLCHAR    *libraryName,
+    SQLINTEGER libraryNameLength,
+    SQLCHAR    *libraryInstallDirectory,
+    SQLINTEGER libraryInstallDirectoryLength,
+    SQLCHAR    **libraryError,
+    SQLINTEGER *libraryErrorLength)
+{
+    LOG("nativecsharpextension::UninstallExternalLibrary");
+
+    SQLRETURN result = SQL_ERROR;
+
+    if (g_dotnet_runtime == nullptr)
+    {
+        SetLibraryError(
+            "Extension not initialized. Call Init before UninstallExternalLibrary.",
+            libraryError,
+            libraryErrorLength);
+    }
+    else
+    {
+        result = g_dotnet_runtime->call_managed_method<decltype(&UninstallExternalLibrary)>(
+            nameof(UninstallExternalLibrary),
+            setupSessionId,
+            libraryName,
+            libraryNameLength,
+            libraryInstallDirectory,
+            libraryInstallDirectoryLength,
+            libraryError,
+            libraryErrorLength);
+    }
+
+    return result;
 }

language-extensions/dotnet-core-CSharp/test/include/CSharpExtensionApiTests.h

@@ -99,6 +99,26 @@ typedef SQLRETURN FN_cleanupSession(
 
 typedef SQLRETURN FN_cleanup();
 
+typedef SQLRETURN FN_installExternalLibrary(
+    SQLGUID,     // setupSessionId
+    SQLCHAR *,   // libraryName
+    SQLINTEGER,  // libraryNameLength
+    SQLCHAR *,   // libraryFile
+    SQLINTEGER,  // libraryFileLength
+    SQLCHAR *,   // libraryInstallDirectory
+    SQLINTEGER,  // libraryInstallDirectoryLength
+    SQLCHAR **,  // libraryError
+    SQLINTEGER *);// libraryErrorLength
+
+typedef SQLRETURN FN_uninstallExternalLibrary(
+    SQLGUID,     // setupSessionId
+    SQLCHAR *,   // libraryName
+    SQLINTEGER,  // libraryNameLength
+    SQLCHAR *,   // libraryInstallDirectory
+    SQLINTEGER,  // libraryInstallDirectoryLength
+    SQLCHAR **,  // libraryError
+    SQLINTEGER *);// libraryErrorLength
+
 namespace ExtensionApiTest
 {
     // Forward declaration
@@ -341,7 +361,7 @@ namespace ExtensionApiTest
         // User library name and class full name
         // The name of the library is same as the dll file name.
         //
-        const std::string m_UserLibName = "Microsoft.SqlServer.CSharpExtensionTest.dll";;
+        const std::string m_UserLibName = "Microsoft.SqlServer.CSharpExtensionTest.dll";
         const std::string m_UserClassFullName = "Microsoft.SqlServer.CSharpExtensionTest.CSharpTestExecutor";
         const std::string m_Separator = ";";
 
@@ -451,6 +471,14 @@ namespace ExtensionApiTest
         // Pointer to the Cleanup function
         //
         static FN_cleanup *sm_cleanupFuncPtr;
+
+        // Pointer to the InstallExternalLibrary function
+        //
+        static FN_installExternalLibrary *sm_installExternalLibraryFuncPtr;
+
+        // Pointer to the UninstallExternalLibrary function
+        //
+        static FN_uninstallExternalLibrary *sm_uninstallExternalLibraryFuncPtr;
     };
 
     // ColumnInfo template class to store information

language-extensions/dotnet-core-CSharp/test/src/native/CSharpExecuteTests.cpp

@@ -103,9 +103,9 @@ namespace ExtensionApiTest
     //
     TEST_F(CSharpExtensionApiTests, ExecuteInvalidLibraryNameScriptTest)
     {
-        // Unmatched library name with the dll file name.
+        // Use a library name that doesn't match any DLL file in the library path.
         //
-        string userLibName = "Microsoft.SqlServer.CSharpExtensionTest";
+        string userLibName = "NonExistentLibrary";
         string scriptString = userLibName + m_Separator + m_UserClassFullName;
         InitializeSession(
             0,   // inputSchemaColumnsNumber

language-extensions/dotnet-core-CSharp/test/src/native/CSharpExtensionApiTests.cpp

@@ -31,6 +31,8 @@ namespace ExtensionApiTest
     FN_getOutputParam *CSharpExtensionApiTests::sm_getOutputParamFuncPtr = nullptr;
     FN_cleanupSession *CSharpExtensionApiTests::sm_cleanupSessionFuncPtr = nullptr;
     FN_cleanup *CSharpExtensionApiTests::sm_cleanupFuncPtr = nullptr;
+    FN_installExternalLibrary *CSharpExtensionApiTests::sm_installExternalLibraryFuncPtr = nullptr;
+    FN_uninstallExternalLibrary *CSharpExtensionApiTests::sm_uninstallExternalLibraryFuncPtr = nullptr;
 
     //----------------------------------------------------------------------------------------------
     // Name: CSharpExtensionApiTest::SetUpTestCase
@@ -250,6 +252,14 @@ namespace ExtensionApiTest
 
         sm_cleanupFuncPtr = reinterpret_cast<FN_cleanup*>(GetProcAddress(sm_libHandle, "Cleanup"));
         EXPECT_TRUE(sm_cleanupFuncPtr != nullptr);
+
+        sm_installExternalLibraryFuncPtr = reinterpret_cast<FN_installExternalLibrary*>(
+            GetProcAddress(sm_libHandle, "InstallExternalLibrary"));
+        EXPECT_TRUE(sm_installExternalLibraryFuncPtr != nullptr);
+
+        sm_uninstallExternalLibraryFuncPtr = reinterpret_cast<FN_uninstallExternalLibrary*>(
+            GetProcAddress(sm_libHandle, "UninstallExternalLibrary"));
+        EXPECT_TRUE(sm_uninstallExternalLibraryFuncPtr != nullptr);
     }
 
     //----------------------------------------------------------------------------------------------