GDALOpenEx(): make it possible to exclude driver(s) by prefixing their name with dash in the allowed driver list

Author: rouault

autotest/gcore/basic_test.py

@@ -1191,3 +1191,22 @@ def test_basic_GetDataTypeByName():
 
     # For now, to avoid breaking backwards compatibility
     assert gdal.GetDataTypeName(gdal.GDT_UInt8) == "Byte"
+
+
+@gdaltest.enable_exceptions()
+def test_basic_exclude_driver_at_open_time():
+
+    if gdal.GetDriverByName("LIBERTIFF"):
+        ds = gdal.OpenEx(
+            "data/gtiff/non_square_pixels.tif",
+            gdal.OF_RASTER,
+            allowed_drivers=["-GTiff", "-idonotexist"],
+        )
+        assert ds.GetDriver().GetDescription() == "LIBERTIFF"
+
+    with pytest.raises(Exception, match="not recognized"):
+        gdal.OpenEx(
+            "data/gtiff/non_square_pixels.tif",
+            gdal.OF_RASTER | gdal.OF_VERBOSE_ERROR,
+            allowed_drivers=["-GTiff", "-LIBERTIFF"],
+        )

gcore/gdaldataset.cpp

@@ -4019,6 +4019,8 @@ static GDALDataset *GetSharedDS(const char *pszFilename,
  * @param papszAllowedDrivers NULL to consider all candidate drivers, or a NULL
  * terminated list of strings with the driver short names that must be
  * considered.
+ * Starting with GDAL 3.13, a string starting with the dash (-) character
+ * followed by the driver short name can be used to exclude a driver.
  *
  * @param papszOpenOptions NULL, or a NULL terminated list of strings with open
  * options passed to candidate drivers. An option exists for all drivers,
@@ -4150,6 +4152,8 @@ GDALDatasetH CPL_STDCALL GDALOpenEx(const char *pszFilename,
  * @param papszAllowedDrivers NULL to consider all candidate drivers, or a NULL
  * terminated list of strings with the driver short names that must be
  * considered.
+ * Starting with GDAL 3.13, a string starting with the dash (-) character
+ * followed by the driver short name can be used to exclude a driver.
  *
  * @param papszOpenOptions NULL, or a NULL terminated list of strings with open
  * options passed to candidate drivers. An option exists for all drivers,
@@ -4264,11 +4268,33 @@ GDALDataset::Open(GDALOpenInfo *poOpenInfo,
         GDALDriver *poDriver =
             iPass == 1 ? poDM->GetDriver(iDriver, /*bIncludeHidden=*/true)
                        : apoSecondPassDrivers[iDriver];
-        if (papszAllowedDrivers != nullptr &&
-            CSLFindString(papszAllowedDrivers,
-                          GDALGetDriverShortName(poDriver)) == -1)
-        {
-            continue;
+        const char *pszDriverName = GDALGetDriverShortName(poDriver);
+        if (pszDriverName && papszAllowedDrivers)
+        {
+            bool bDriverMatchedPositively = false;
+            bool bDriverMatchedNegatively = false;
+            bool bOnlyExcludedDrivers = true;
+            for (const char *pszAllowedDriver :
+                 cpl::Iterate(papszAllowedDrivers))
+            {
+                if (pszAllowedDriver[0] != '-')
+                    bOnlyExcludedDrivers = false;
+                if (EQUAL(pszAllowedDriver, pszDriverName))
+                {
+                    bDriverMatchedPositively = true;
+                }
+                else if (pszAllowedDriver[0] == '-' &&
+                         EQUAL(pszAllowedDriver + 1, pszDriverName))
+                {
+                    bDriverMatchedNegatively = true;
+                    break;
+                }
+            }
+            if ((!bDriverMatchedPositively && !bOnlyExcludedDrivers) ||
+                bDriverMatchedNegatively)
+            {
+                continue;
+            }
         }
 
         if (poDriver->GetMetadataItem(GDAL_DCAP_OPEN) == nullptr)

gcore/gdaldefaultoverviews.cpp

@@ -375,11 +375,14 @@ void GDALDefaultOverviews::OverviewScan()
                 osOvrFilename = pszProxyOvrFilename;
             }
 
+            // Exclude TILEDB because reading from /vsis3/ can be really slow
+            const char *const apszAllowedDrivers[] = {"-TILEDB", nullptr};
             CPLPushErrorHandler(CPLQuietErrorHandler);
             poODS = GDALDataset::Open(
                 osOvrFilename,
                 GDAL_OF_RASTER |
-                    (poDS->GetAccess() == GA_Update ? GDAL_OF_UPDATE : 0));
+                    (poDS->GetAccess() == GA_Update ? GDAL_OF_UPDATE : 0),
+                apszAllowedDrivers);
             CPLPopErrorHandler();
         }
     }

gcore/gdaldrivermanager.cpp

@@ -484,7 +484,7 @@ GDALDriverH CPL_STDCALL GDALGetDriver(int iDriver)
  *
  * @param poDriver the driver to register.
  *
- * @return the index of the new installed driver.
+ * @return the index of the new installed driver, or -1 in case of error
  */
 
 int GDALDriverManager::RegisterDriver(GDALDriver *poDriver)
@@ -496,12 +496,29 @@ int GDALDriverManager::RegisterDriver(GDALDriver *poDriver, bool bHidden)
 {
     CPLMutexHolderD(&hDMMutex);
 
+    const char *pszDriverName = poDriver->GetDescription();
+    if (pszDriverName[0] == 0)
+    {
+        CPLError(CE_Failure, CPLE_AppDefined,
+                 "Cannot register driver with empty name");
+        return -1;
+    }
+    if (pszDriverName[0] == '-')
+    {
+        // Because GDALDataset::Open() considers that strings in the allowed
+        // drivers list starting with dash mean to exclude a driver.
+        CPLError(
+            CE_Failure, CPLE_AppDefined,
+            "Cannot register driver whose name starts with a dash character");
+        return -1;
+    }
+
     /* -------------------------------------------------------------------- */
     /*      If it is already registered, just return the existing           */
     /*      index.                                                          */
     /* -------------------------------------------------------------------- */
     if (!m_bInDeferredDriverLoading &&
-        GetDriverByName_unlocked(poDriver->GetDescription()) != nullptr)
+        GetDriverByName_unlocked(pszDriverName) != nullptr)
     {
         for (int i = 0; i < nDrivers; ++i)
         {
@@ -536,39 +553,38 @@ int GDALDriverManager::RegisterDriver(GDALDriver *poDriver, bool bHidden)
         poDriver->GetMetadataItem(GDAL_DCAP_GNM) == nullptr)
     {
         CPLDebug("GDAL", "Assuming DCAP_RASTER for driver %s. Please fix it.",
-                 poDriver->GetDescription());
+                 pszDriverName);
         poDriver->SetMetadataItem(GDAL_DCAP_RASTER, "YES");
     }
 
     if (poDriver->GetMetadataItem(GDAL_DMD_OPENOPTIONLIST) != nullptr &&
         poDriver->pfnIdentify == nullptr &&
         poDriver->pfnIdentifyEx == nullptr &&
-        !STARTS_WITH_CI(poDriver->GetDescription(), "Interlis"))
+        !STARTS_WITH_CI(pszDriverName, "Interlis"))
     {
         CPLDebug("GDAL",
                  "Driver %s that defines GDAL_DMD_OPENOPTIONLIST must also "
                  "implement Identify(), so that it can be used",
-                 poDriver->GetDescription());
+                 pszDriverName);
     }
 
     if (poDriver->pfnVectorTranslateFrom != nullptr)
         poDriver->SetMetadataItem(GDAL_DCAP_VECTOR_TRANSLATE_FROM, "YES");
 
     if (m_bInDeferredDriverLoading &&
-        cpl::contains(oMapNameToDrivers,
-                      CPLString(poDriver->GetDescription()).toupper()))
+        cpl::contains(oMapNameToDrivers, CPLString(pszDriverName).toupper()))
     {
-        if (cpl::contains(m_oMapRealDrivers, poDriver->GetDescription()))
+        if (cpl::contains(m_oMapRealDrivers, pszDriverName))
         {
             CPLError(
                 CE_Failure, CPLE_AppDefined,
                 "RegisterDriver() in m_bInDeferredDriverLoading: %s already "
                 "registered!",
-                poDriver->GetDescription());
+                pszDriverName);
             delete poDriver;
             return -1;
         }
-        m_oMapRealDrivers[poDriver->GetDescription()] =
+        m_oMapRealDrivers[pszDriverName] =
             std::unique_ptr<GDALDriver>(poDriver);
         return -1;
     }
@@ -592,10 +608,9 @@ int GDALDriverManager::RegisterDriver(GDALDriver *poDriver, bool bHidden)
     papoDrivers[nDrivers] = poDriver;
     ++nDrivers;
 
-    oMapNameToDrivers[CPLString(poDriver->GetDescription()).toupper()] =
-        poDriver;
+    oMapNameToDrivers[CPLString(pszDriverName).toupper()] = poDriver;
 
-    if (EQUAL(poDriver->GetDescription(), "MEM") &&
+    if (EQUAL(pszDriverName, "MEM") &&
         oMapNameToDrivers.find("MEMORY") == oMapNameToDrivers.end())
     {
         // Instantiate a Memory driver, that is the same as the MEM one,