GDAL Configuration System (#8)

NAMESPACE

@@ -1,17 +1,27 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(as.character,gdal_opts)
+S3method(as.list,gdal_config)
 S3method(as.list,gdal_opts)
 S3method(as_config_option,default)
 S3method(as_config_option,gdal_config_opts)
 S3method(as_config_option,gdal_vsi_opts)
 S3method(as_gdal_args,character)
 S3method(as_gdal_args,default)
+S3method(as_gdal_args,gdal_config)
 S3method(as_gdal_args,gdal_opts)
 S3method(as_gdal_args,list)
+S3method(as_gdal_config,character)
+S3method(as_gdal_config,default)
+S3method(as_gdal_config,gdal_config)
+S3method(as_gdal_config,gdal_config_file)
+S3method(as_gdal_config,gdal_opts)
+S3method(as_gdal_config,list)
 S3method(as_gdal_config_opts,character)
 S3method(as_gdal_config_opts,default)
+S3method(as_gdal_config_opts,gdal_config)
 S3method(as_gdal_config_opts,gdal_config_opts)
+S3method(as_gdal_config_opts,gdal_config_sitrep)
 S3method(as_gdal_config_opts,list)
 S3method(as_gdal_config_opts,tbl_df)
 S3method(as_gdal_creation_opts,character)
@@ -33,14 +43,22 @@ S3method(as_gdalg,default)
 S3method(as_gdalg,gdalg)
 S3method(as_gdalg,json)
 S3method(as_gdalg,list)
+S3method(as_tibble,gdal_config_sitrep)
+S3method(c,gdal_config)
 S3method(c,gdal_opts)
+S3method(format,gdal_config)
+S3method(format,gdal_config_file)
+S3method(format,gdal_config_sitrep)
 S3method(format,gdal_opts)
 S3method(format,gdalg)
 S3method(format,gpq_file_info)
 S3method(format,gpq_geo_metadata)
 S3method(format,gpq_inspect)
 S3method(format,gpq_row_groups)
 S3method(format,gpq_schema_info)
+S3method(print,gdal_config)
+S3method(print,gdal_config_file)
+S3method(print,gdal_config_sitrep)
 S3method(print,gdal_opts)
 S3method(print,gdalg)
 S3method(print,gpq_file_info)
@@ -50,6 +68,7 @@ S3method(print,gpq_row_groups)
 S3method(print,gpq_schema_info)
 export(as_config_option)
 export(as_gdal_args)
+export(as_gdal_config)
 export(as_gdal_config_opts)
 export(as_gdal_creation_opts)
 export(as_gdal_open_opts)
@@ -67,7 +86,16 @@ export(fgb_creation_opts)
 export(fgb_open_opts)
 export(fgb_validate_spatial_index_ram)
 export(gdal_config)
+export(gdal_config_active)
+export(gdal_config_file)
+export(gdal_config_file_read)
+export(gdal_config_file_write)
+export(gdal_config_get)
 export(gdal_config_opts)
+export(gdal_config_reset)
+export(gdal_config_set)
+export(gdal_config_sitrep)
+export(gdal_config_unset)
 export(gdal_creation_opts)
 export(gdal_driver_names)
 export(gdal_drivers)
@@ -107,6 +135,7 @@ export(gpq_row_groups)
 export(gpq_schema)
 export(gpq_schema_info)
 export(is_vsi_path)
+export(local_gdal_config)
 export(local_hash)
 export(local_last_modified)
 export(ping)
@@ -144,6 +173,7 @@ export(vsi_sync)
 export(vsi_type)
 export(vsi_zip)
 export(vsi_zip_curl)
+export(with_gdal_config)
 export(xml_parse_gdal_driver_config_opts)
 export(xml_parse_gdal_options)
 importFrom(bit64,is.integer64)
@@ -166,15 +196,25 @@ importFrom(crayon,green)
 importFrom(crayon,italic)
 importFrom(crayon,yellow)
 importFrom(dplyr,bind_rows)
+importFrom(dplyr,case_when)
 importFrom(dplyr,filter)
 importFrom(dplyr,filter_out)
 importFrom(dplyr,first)
 importFrom(dplyr,group_by)
+importFrom(dplyr,group_map)
+importFrom(dplyr,if_else)
 importFrom(dplyr,mutate)
 importFrom(dplyr,replace_values)
+importFrom(dplyr,select)
 importFrom(dplyr,summarise)
+importFrom(dplyr,ungroup)
+importFrom(gdalraster,get_config_option)
 importFrom(gdalraster,get_num_cpus)
 importFrom(gdalraster,get_usable_physical_ram)
+importFrom(gdalraster,set_config_option)
+importFrom(gdalraster,vsi_get_fs_options)
+importFrom(gdalraster,vsi_get_fs_prefixes)
+importFrom(gdalraster,vsi_set_path_option)
 importFrom(gdalraster,vsi_stat_size)
 importFrom(httr2,req_method)
 importFrom(httr2,req_perform)
@@ -193,18 +233,27 @@ importFrom(openssl,sha1)
 importFrom(openssl,sha256)
 importFrom(openssl,sha512)
 importFrom(ps,errno)
+importFrom(purrr,compact)
 importFrom(purrr,discard)
+importFrom(purrr,imap)
+importFrom(purrr,imap_chr)
+importFrom(purrr,iwalk)
+importFrom(purrr,keep)
+importFrom(purrr,map)
 importFrom(purrr,map2)
 importFrom(purrr,map_chr)
 importFrom(purrr,map_dfr)
 importFrom(purrr,pluck)
+importFrom(purrr,reduce)
+importFrom(purrr,walk)
 importFrom(rlang,.data)
 importFrom(rlang,.env)
 importFrom(rlang,`!!!`)
 importFrom(rlang,`!!`)
 importFrom(rlang,`%||%`)
 importFrom(rlang,`:=`)
 importFrom(rlang,abort)
+importFrom(rlang,arg_match)
 importFrom(rlang,arg_match0)
 importFrom(rlang,as_bytes)
 importFrom(rlang,call_inspect)
@@ -223,17 +272,21 @@ importFrom(rlang,current_fn)
 importFrom(rlang,empty_env)
 importFrom(rlang,env_cache)
 importFrom(rlang,env_get)
+importFrom(rlang,env_has)
 importFrom(rlang,env_poke)
 importFrom(rlang,error_cnd)
+importFrom(rlang,exec)
 importFrom(rlang,inform)
 importFrom(rlang,inherits_all)
 importFrom(rlang,inherits_any)
 importFrom(rlang,is_empty)
 importFrom(rlang,is_named)
 importFrom(rlang,is_named2)
+importFrom(rlang,is_string)
 importFrom(rlang,list2)
 importFrom(rlang,local_use_cli)
 importFrom(rlang,message_cnd)
+importFrom(rlang,names2)
 importFrom(rlang,new_environment)
 importFrom(rlang,on_load)
 importFrom(rlang,run_on_load)
@@ -248,20 +301,25 @@ importFrom(rvest,html_nodes)
 importFrom(rvest,html_text)
 importFrom(stats,setNames)
 importFrom(stringr,fixed)
+importFrom(stringr,str_detect)
 importFrom(stringr,str_extract)
 importFrom(stringr,str_match)
 importFrom(stringr,str_remove)
 importFrom(stringr,str_remove_all)
 importFrom(stringr,str_split)
+importFrom(stringr,str_starts)
 importFrom(stringr,str_trim)
 importFrom(tibble,add_column)
 importFrom(tibble,as_tibble)
 importFrom(tibble,tibble)
+importFrom(tidyr,fill)
+importFrom(tidyr,separate_wider_delim)
 importFrom(utils,capture.output)
 importFrom(utils,globalVariables)
 importFrom(utils,modifyList)
 importFrom(utils,packageVersion)
 importFrom(utils,unzip)
+importFrom(withr,defer)
 importFrom(withr,local_locale)
 importFrom(xml2,read_html)
 importFrom(xml2,read_xml)

R/aaa.R

@@ -25,6 +25,110 @@ GDAL_VECTOR_DRIVERS <- c(
   "OGR_VRT"
 )
 
+
+# VSI Prefixes ----------------------------------------------------------------------------------------------------
+
+#' @keywords internal
+#' @noRd
+GDAL_VSI_PREFIXES <- c(
+  "/vsistdin/",
+  "/vsistdout/",
+  "/vsimem/",
+  "/vsicurl/",
+  "/vsizip/",
+  "/vsitar/",
+  "/vsigzip/",
+  "/vsicache/",
+  "/vsis3/",
+  "/vsigs/",
+  "/vsiaz/",
+  "/vsiadls/",
+  "/vsicrypt/"
+)
+
+# core config options ---------------------------------------------------------------------------------------------
+
+# curated names of *core* (non-driver, non-VSI) GDAL configuration options, drawn from
+# https://gdal.org/en/stable/user/configoptions.html (GDAL 3.13). this is the only known-option
+# source that cannot be derived from the running GDAL build: VSI/network/credential options are
+# enumerated at runtime via vsi_get_fs_options(), and per-driver config options come from the
+# curated driver metadata table. used only for advisory typo checking and the gdal_config()
+# snapshot probe - never blocking. keep small; when in doubt, leave a name out (a key that GDAL
+# already resolves to a value is never flagged).
+#' @keywords internal
+#' @noRd
+GDAL_CORE_CONFIG_OPTS <- c(
+  # performance / general
+  "GDAL_NUM_THREADS",
+  "GDAL_CACHEMAX",
+  "GDAL_FORCE_CACHING",
+  "GDAL_BAND_BLOCK_CACHE",
+  "GDAL_MAX_DATASET_POOL_SIZE",
+  "GDAL_MAX_DATASET_POOL_RAM_USAGE",
+  "GDAL_SWATH_SIZE",
+  "GDAL_DISABLE_READDIR_ON_OPEN",
+  "GDAL_READDIR_LIMIT_ON_OPEN",
+  "GDAL_DATA",
+  "GDAL_DRIVER_PATH",
+  "GDAL_SKIP",
+  "OGR_SKIP",
+  "GDAL_CONFIG_FILE",
+  "GDAL_RASTERIO_RESAMPLING",
+  "GDAL_XML_VALIDATION",
+  "GDAL_FILENAME_IS_UTF8",
+  "GDAL_PAM_ENABLED",
+  "GDAL_PAM_PROXY_DIR",
+  # cpl / logging
+  "CPL_DEBUG",
+  "CPL_LOG",
+  "CPL_LOG_ERRORS",
+  "CPL_TIMESTAMP",
+  "CPL_MAX_ERROR_REPORTS",
+  "CPL_ACCUM_ERROR_MSG",
+  "CPL_CURL_VERBOSE",
+  "CPL_CURL_GZIP",
+  "CPL_TMPDIR",
+  # vsi general
+  "VSI_CACHE",
+  "VSI_CACHE_SIZE",
+  # http core (not reliably part of the runtime vsi option metadata on all builds)
+  "GDAL_HTTP_TIMEOUT",
+  "GDAL_HTTP_CONNECTTIMEOUT",
+  "GDAL_HTTP_MAX_RETRY",
+  "GDAL_HTTP_RETRY_DELAY",
+  "GDAL_HTTP_RETRY_CODES",
+  "GDAL_HTTP_VERSION",
+  "GDAL_HTTP_USERAGENT",
+  "GDAL_HTTP_PROXY",
+  "GDAL_HTTPS_PROXY",
+  "GDAL_HTTP_PROXYUSERPWD",
+  "GDAL_HTTP_NETRC",
+  "GDAL_HTTP_SSL_VERIFYPEER",
+  "GDAL_HTTP_UNSAFESSL",
+  "GDAL_HTTP_TCP_KEEPALIVE",
+  # cloud extras not consistently enumerated by vsi_get_fs_options()
+  "AWS_REGION",
+  # proj / srs
+  "PROJ_LIB",
+  "PROJ_DATA",
+  "PROJ_NETWORK",
+  "PROJ_NETWORK_ENDPOINT",
+  "OSR_DEFAULT_AXIS_MAPPING_STRATEGY",
+  "OSR_WKT_FORMAT",
+  "CHECK_WITH_INVERT_PROJ",
+  "CENTER_LONG",
+  # ogr general
+  "OGR_INTERLEAVED_READING",
+  "OGR_ARC_STEPSIZE",
+  "OGR_ARC_MAX_GAP",
+  "OGR_WKT_PRECISION",
+  "OGR_ORGANIZE_POLYGONS",
+  "OGR_ENABLE_PARTIAL_REPROJECTION",
+  "OGR_SQL_LIKE_AS_ILIKE",
+  "OGR_FORCE_ASCII",
+  "OGR_CURRENT_DATE"
+)
+
 # magic bytes -----------------------------------------------------------------------------------------------------
 
 #' @keywords internal