Add DriverManager::get_drivers_for_filename for the ability to auto detect compatible Drivers for writing data

CHANGES.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Added `DriverManager::get_drivers_for_filename` for the ability to auto detect compatible `Driver`s for writing data.
+
 - Added `Feature::unset_field`
   - <https://github.com/georust/gdal/pull/503>
 

src/driver.rs

@@ -410,6 +410,90 @@ impl DriverManager {
         Ok(Driver { c_driver })
     }
 
+    /// Get the Driver based on the file extension from filename
+    ///
+    /// Searches for the available extensions in the registered
+    /// drivers and returns the matches. The determined driver is
+    /// checked for writing capabilities as
+    /// [`Dataset::open`](Dataset::open) can already open datasets
+    /// with just path.
+    ///
+    /// See also: [`get_driver_by_name`](Self::get_driver_by_name)
+    ///
+    /// # Example
+    ///
+    /// ```rust, no_run
+    /// use gdal::DriverManager;
+    /// # fn main() -> gdal::errors::Result<()> {
+    /// let compatible_drivers =
+    ///     DriverManager::get_drivers_for_filename("test.gpkg", true)
+    ///         .iter()
+    ///         .map(|d| d.short_name())
+    ///         .collect::<Vec<String>>();
+    /// println!("{:?}", compatible_drivers);
+    /// # Ok(())
+    /// # }
+    /// ```
+    /// ```text
+    /// ["GPKG"]
+    /// ```
+    pub fn get_drivers_for_filename(filename: &str, is_vector: bool) -> Vec<Driver> {
+        let ext = {
+            let filename = filename.to_ascii_lowercase();
+            let e = match filename.rsplit_once('.') {
+                Some(("", _)) => "", // hidden file no ext
+                Some((f, "zip")) => {
+                    // zip files could be zipped shp or gpkg
+                    if f.ends_with(".shp") {
+                        "shp.zip"
+                    } else if f.ends_with(".gpkg") {
+                        "gpkg.zip"
+                    } else {
+                        "zip"
+                    }
+                }
+                Some((_, e)) => e, // normal file with ext
+                None => "",
+            };
+            e.to_string()
+        };
+
+        let mut drivers: Vec<Driver> = Vec::new();
+        for i in 0..DriverManager::count() {
+            let d = DriverManager::get_driver(i).expect("Index for this loop should be valid");
+            let can_create = d.metadata_item("DCAP_CREATE", "").is_some()
+                || d.metadata_item("DCAP_CREATECOPY", "").is_some();
+            let check_vector = is_vector && d.metadata_item("DCAP_VECTOR", "").is_some();
+            let check_raster = !is_vector && d.metadata_item("DCAP_RASTER", "").is_some();
+            let check_vector_translate =
+                is_vector && d.metadata_item("DCAP_VECTOR_TRANSLATE_FROM", "").is_some();
+            if !((can_create && (check_vector || check_raster)) || (check_vector_translate)) {
+                continue;
+            }
+
+            if let Some(e) = &d.metadata_item("DMD_EXTENSION", "") {
+                if *e == ext {
+                    drivers.push(d);
+                    continue;
+                }
+            }
+            if let Some(e) = d.metadata_item("DMD_EXTENSIONS", "") {
+                if e.split(' ').collect::<Vec<&str>>().contains(&ext.as_str()) {
+                    drivers.push(d);
+                    continue;
+                }
+            }
+
+            if let Some(pre) = d.metadata_item("DMD_CONNECTION_PREFIX", "") {
+                if filename.starts_with(&pre) {
+                    drivers.push(d);
+                }
+            }
+        }
+
+        drivers
+    }
+
     /// Register a driver for use.
     ///
     /// Wraps [`GDALRegisterDriver()`](https://gdal.org/api/raster_c_api.html#_CPPv418GDALRegisterDriver11GDALDriverH)
@@ -455,6 +539,8 @@ impl DriverManager {
 
 #[cfg(test)]
 mod tests {
+    use std::collections::HashSet;
+
     use super::*;
 
     #[test]
@@ -466,4 +552,46 @@ mod tests {
         assert!(DriverManager::count() > 0);
         assert!(DriverManager::get_driver(0).is_ok());
     }
+
+    #[test]
+    fn test_driver_extension() {
+        // convert the driver into short_name for testing purposes
+        let drivers = |filename, is_vector| {
+            DriverManager::get_drivers_for_filename(filename, is_vector)
+                .iter()
+                .map(|d| d.short_name())
+                .collect::<HashSet<String>>()
+        };
+        let gdal_version: i64 = crate::version::version_info("VERSION_NUM").parse().unwrap();
+        if DriverManager::get_driver_by_name("ESRI Shapefile").is_ok() {
+            assert!(drivers("test.shp", true).contains("ESRI Shapefile"));
+            // `shp.zip` only supported from gdal version 3.1
+            // https://gdal.org/drivers/vector/shapefile.html#compressed-files
+            if gdal_version >= 3010000 {
+                assert!(drivers("test.shp.zip", true).contains("ESRI Shapefile"));
+            }
+        }
+        if DriverManager::get_driver_by_name("GPKG").is_ok() {
+            assert!(drivers("test.gpkg", true).contains("GPKG"));
+            // `gpkg.zip` only supported from gdal version 3.7
+            // https://gdal.org/drivers/vector/gpkg.html#compressed-files
+            if gdal_version >= 3070000 {
+                assert!(drivers("test.gpkg.zip", true).contains("GPKG"));
+            }
+        }
+        if DriverManager::get_driver_by_name("GTiff").is_ok() {
+            assert!(drivers("test.tiff", false).contains("GTiff"));
+        }
+        if DriverManager::get_driver_by_name("netCDF").is_ok() {
+            assert!(drivers("test.nc", false).contains("netCDF"));
+        }
+        if DriverManager::get_driver_by_name("Elasticsearch").is_ok() {
+            // Elasticsearch short name was ElasticSearch in older versions
+            if gdal_version >= 3010000 {
+                assert!(drivers("ES:test", true).contains("Elasticsearch"));
+            } else {
+                assert!(drivers("ES:test", true).contains("ElasticSearch"));
+            }
+        }
+    }
 }