Line data Source code
1 : /******************************************************************************
2 : *
3 : * Project: GDAL Core
4 : * Purpose: Implementation of GDALDriver class (and C wrappers)
5 : * Author: Frank Warmerdam, warmerdam@pobox.com
6 : *
7 : ******************************************************************************
8 : * Copyright (c) 1998, 2000, Frank Warmerdam
9 : * Copyright (c) 2007-2014, Even Rouault <even dot rouault at spatialys.com>
10 : *
11 : * SPDX-License-Identifier: MIT
12 : ****************************************************************************/
13 :
14 : #include "cpl_port.h"
15 : #include "gdal.h"
16 : #include "gdal_priv.h"
17 : #include "gdal_rat.h"
18 : #include "gdalalgorithm.h"
19 : #include "gdal_known_connection_prefixes.h"
20 :
21 : #include <algorithm>
22 : #include <cerrno>
23 : #include <cstdlib>
24 : #include <cstring>
25 : #include <set>
26 : #include <sys/stat.h>
27 :
28 : #include "cpl_conv.h"
29 : #include "cpl_error.h"
30 : #include "cpl_minixml.h"
31 : #include "cpl_multiproc.h"
32 : #include "cpl_progress.h"
33 : #include "cpl_string.h"
34 : #include "cpl_vsi.h"
35 : #include "ograpispy.h"
36 : #include "ogr_core.h"
37 : #include "ogrsf_frmts.h"
38 :
39 : /************************************************************************/
40 : /* GDALDriver() */
41 : /************************************************************************/
42 :
43 : GDALDriver::GDALDriver() = default;
44 :
45 : /************************************************************************/
46 : /* ~GDALDriver() */
47 : /************************************************************************/
48 :
49 449236 : GDALDriver::~GDALDriver()
50 :
51 : {
52 253920 : if (pfnUnloadDriver != nullptr)
53 6897 : pfnUnloadDriver(this);
54 449236 : }
55 :
56 : /************************************************************************/
57 : /* GDALCreateDriver() */
58 : /************************************************************************/
59 :
60 : /**
61 : * \brief Create a GDALDriver.
62 : *
63 : * Creates a driver in the GDAL heap.
64 : */
65 :
66 225 : GDALDriverH CPL_STDCALL GDALCreateDriver()
67 : {
68 225 : return new GDALDriver();
69 : }
70 :
71 : /************************************************************************/
72 : /* GDALDestroyDriver() */
73 : /************************************************************************/
74 :
75 : /**
76 : * \brief Destroy a GDALDriver.
77 : *
78 : * This is roughly equivalent to deleting the driver, but is guaranteed
79 : * to take place in the GDAL heap. It is important this that function
80 : * not be called on a driver that is registered with the GDALDriverManager.
81 : *
82 : * @param hDriver the driver to destroy.
83 : */
84 :
85 0 : void CPL_STDCALL GDALDestroyDriver(GDALDriverH hDriver)
86 :
87 : {
88 0 : if (hDriver != nullptr)
89 0 : delete GDALDriver::FromHandle(hDriver);
90 0 : }
91 :
92 : /************************************************************************/
93 : /* Open() */
94 : /************************************************************************/
95 :
96 : //! @cond Doxygen_Suppress
97 :
98 491506 : GDALDataset *GDALDriver::Open(GDALOpenInfo *poOpenInfo, bool bSetOpenOptions)
99 : {
100 :
101 491506 : GDALDataset *poDS = nullptr;
102 491506 : pfnOpen = GetOpenCallback();
103 491506 : if (pfnOpen != nullptr)
104 : {
105 491503 : poDS = pfnOpen(poOpenInfo);
106 : }
107 3 : else if (pfnOpenWithDriverArg != nullptr)
108 : {
109 3 : poDS = pfnOpenWithDriverArg(this, poOpenInfo);
110 : }
111 :
112 491506 : if (poDS)
113 : {
114 : // Only set GDAL_OF_THREAD_SAFE if the driver itself has set it in
115 : // poDS->nOpenFlags
116 61362 : int nOpenFlags = poOpenInfo->nOpenFlags &
117 : ~(GDAL_OF_FROM_GDALOPEN | GDAL_OF_THREAD_SAFE);
118 61362 : if (poDS->nOpenFlags & GDAL_OF_THREAD_SAFE)
119 919 : nOpenFlags |= GDAL_OF_THREAD_SAFE;
120 61362 : poDS->nOpenFlags = nOpenFlags;
121 :
122 61362 : if (strlen(poDS->GetDescription()) == 0)
123 13806 : poDS->SetDescription(poOpenInfo->pszFilename);
124 :
125 61362 : if (poDS->poDriver == nullptr)
126 57445 : poDS->poDriver = this;
127 :
128 61362 : if (poDS->papszOpenOptions == nullptr && bSetOpenOptions)
129 : {
130 29 : poDS->papszOpenOptions = CSLDuplicate(poOpenInfo->papszOpenOptions);
131 : }
132 :
133 61362 : if (!(poOpenInfo->nOpenFlags & GDAL_OF_INTERNAL))
134 : {
135 48942 : if (CPLGetPID() != GDALGetResponsiblePIDForCurrentThread())
136 6 : CPLDebug(
137 : "GDAL",
138 : "GDALOpen(%s, this=%p) succeeds as "
139 : "%s (pid=%d, responsiblePID=%d).",
140 6 : poOpenInfo->pszFilename, poDS, GetDescription(),
141 6 : static_cast<int>(CPLGetPID()),
142 6 : static_cast<int>(GDALGetResponsiblePIDForCurrentThread()));
143 : else
144 48936 : CPLDebug("GDAL", "GDALOpen(%s, this=%p) succeeds as %s.",
145 48936 : poOpenInfo->pszFilename, poDS, GetDescription());
146 :
147 48942 : poDS->AddToDatasetOpenList();
148 : }
149 : }
150 :
151 491506 : return poDS;
152 : }
153 :
154 : //! @endcond
155 :
156 : /************************************************************************/
157 : /* Create() */
158 : /************************************************************************/
159 :
160 : /**
161 : * \brief Create a new dataset with this driver.
162 : *
163 : * What argument values are legal for particular drivers is driver specific,
164 : * and there is no way to query in advance to establish legal values.
165 : *
166 : * That function will try to validate the creation option list passed to the
167 : * driver with the GDALValidateCreationOptions() method. This check can be
168 : * disabled by defining the configuration option
169 : * GDAL_VALIDATE_CREATION_OPTIONS=NO.
170 : *
171 : * After you have finished working with the returned dataset, it is
172 : * <b>required</b> to close it with GDALClose(). This does not only close the
173 : * file handle, but also ensures that all the data and metadata has been written
174 : * to the dataset (GDALFlushCache() is not sufficient for that purpose).
175 : *
176 : * The arguments nXSize, nYSize and nBands can be passed to 0 when
177 : * creating a vector-only dataset for a compatible driver.
178 : *
179 : * Equivalent of the C function GDALCreate().
180 : *
181 : * @param pszFilename the name of the dataset to create. UTF-8 encoded.
182 : * @param nXSize width of created raster in pixels.
183 : * @param nYSize height of created raster in pixels.
184 : * @param nBands number of bands.
185 : * @param eType type of raster.
186 : * @param papszOptions list of driver specific control parameters.
187 : * The APPEND_SUBDATASET=YES option can be
188 : * specified to avoid prior destruction of existing dataset.
189 : *
190 : * @return NULL on failure, or a new GDALDataset.
191 : */
192 :
193 24575 : GDALDataset *GDALDriver::Create(const char *pszFilename, int nXSize, int nYSize,
194 : int nBands, GDALDataType eType,
195 : CSLConstList papszOptions)
196 :
197 : {
198 : /* -------------------------------------------------------------------- */
199 : /* Does this format support creation. */
200 : /* -------------------------------------------------------------------- */
201 24575 : pfnCreate = GetCreateCallback();
202 24575 : if (CPL_UNLIKELY(pfnCreate == nullptr && pfnCreateEx == nullptr &&
203 : pfnCreateVectorOnly == nullptr))
204 : {
205 1 : CPLError(CE_Failure, CPLE_NotSupported,
206 : "GDALDriver::Create() ... no create method implemented"
207 : " for this format.");
208 :
209 1 : return nullptr;
210 : }
211 : /* -------------------------------------------------------------------- */
212 : /* Do some rudimentary argument checking. */
213 : /* -------------------------------------------------------------------- */
214 24574 : if (CPL_UNLIKELY(nBands < 0))
215 : {
216 1 : CPLError(CE_Failure, CPLE_AppDefined,
217 : "Attempt to create dataset with %d bands is illegal,"
218 : "Must be >= 0.",
219 : nBands);
220 1 : return nullptr;
221 : }
222 :
223 24573 : if (CPL_UNLIKELY(GetMetadataItem(GDAL_DCAP_RASTER) != nullptr &&
224 : GetMetadataItem(GDAL_DCAP_VECTOR) == nullptr &&
225 24573 : (nXSize < 1 || nYSize < 1)))
226 : {
227 2 : CPLError(CE_Failure, CPLE_AppDefined,
228 : "Attempt to create %dx%d dataset is illegal,"
229 : "sizes must be larger than zero.",
230 : nXSize, nYSize);
231 2 : return nullptr;
232 : }
233 :
234 24571 : if (CPL_UNLIKELY(nBands != 0 &&
235 : (eType == GDT_Unknown || eType == GDT_TypeCount)))
236 : {
237 1 : CPLError(CE_Failure, CPLE_IllegalArg,
238 : "Illegal GDT_Unknown/GDT_TypeCount argument");
239 1 : return nullptr;
240 : }
241 :
242 : /* -------------------------------------------------------------------- */
243 : /* Make sure we cleanup if there is an existing dataset of this */
244 : /* name. But even if that seems to fail we will continue since */
245 : /* it might just be a corrupt file or something. */
246 : /* -------------------------------------------------------------------- */
247 24570 : if (!CPLFetchBool(papszOptions, "APPEND_SUBDATASET", false))
248 : {
249 : // Someone issuing Create("foo.tif") on a
250 : // memory driver doesn't expect files with those names to be deleted
251 : // on a file system...
252 : // This is somewhat messy. Ideally there should be a way for the
253 : // driver to overload the default behavior
254 24551 : if (!EQUAL(GetDescription(), "MEM") &&
255 37894 : !EQUAL(GetDescription(), "Memory") &&
256 : // ogr2ogr -f PostgreSQL might reach the Delete method of the
257 : // PostgisRaster driver which is undesirable
258 13343 : !EQUAL(GetDescription(), "PostgreSQL"))
259 : {
260 13341 : QuietDelete(pszFilename);
261 : }
262 : }
263 :
264 : /* -------------------------------------------------------------------- */
265 : /* Validate creation options. */
266 : /* -------------------------------------------------------------------- */
267 24570 : if (CPLTestBool(
268 : CPLGetConfigOption("GDAL_VALIDATE_CREATION_OPTIONS", "YES")))
269 24570 : GDALValidateCreationOptions(this, papszOptions);
270 :
271 : /* -------------------------------------------------------------------- */
272 : /* Proceed with creation. */
273 : /* -------------------------------------------------------------------- */
274 49140 : CPLDebug("GDAL", "GDALDriver::Create(%s,%s,%d,%d,%d,%s,%p)",
275 24570 : GetDescription(), pszFilename, nXSize, nYSize, nBands,
276 : GDALGetDataTypeName(eType), papszOptions);
277 :
278 24570 : GDALDataset *poDS = nullptr;
279 24570 : if (pfnCreateEx != nullptr)
280 : {
281 0 : poDS = pfnCreateEx(this, pszFilename, nXSize, nYSize, nBands, eType,
282 : const_cast<char **>(papszOptions));
283 : }
284 24570 : else if (pfnCreate != nullptr)
285 : {
286 24570 : poDS = pfnCreate(pszFilename, nXSize, nYSize, nBands, eType,
287 : const_cast<char **>(papszOptions));
288 : }
289 0 : else if (nBands < 1)
290 : {
291 0 : poDS = pfnCreateVectorOnly(this, pszFilename,
292 : const_cast<char **>(papszOptions));
293 : }
294 :
295 24570 : if (poDS != nullptr)
296 : {
297 46544 : if (poDS->GetDescription() == nullptr ||
298 23272 : strlen(poDS->GetDescription()) == 0)
299 20605 : poDS->SetDescription(pszFilename);
300 :
301 23272 : if (poDS->poDriver == nullptr)
302 22603 : poDS->poDriver = this;
303 :
304 23272 : poDS->AddToDatasetOpenList();
305 : }
306 :
307 24570 : return poDS;
308 : }
309 :
310 : /************************************************************************/
311 : /* GDALCreate() */
312 : /************************************************************************/
313 :
314 : /**
315 : * \brief Create a new dataset with this driver.
316 : *
317 : * @see GDALDriver::Create()
318 : */
319 :
320 20315 : GDALDatasetH CPL_DLL CPL_STDCALL GDALCreate(GDALDriverH hDriver,
321 : const char *pszFilename, int nXSize,
322 : int nYSize, int nBands,
323 : GDALDataType eBandType,
324 : CSLConstList papszOptions)
325 :
326 : {
327 20315 : VALIDATE_POINTER1(hDriver, "GDALCreate", nullptr);
328 :
329 20315 : GDALDatasetH hDS = GDALDriver::FromHandle(hDriver)->Create(
330 : pszFilename, nXSize, nYSize, nBands, eBandType, papszOptions);
331 :
332 : #ifdef OGRAPISPY_ENABLED
333 20315 : if (nBands < 1)
334 : {
335 3772 : OGRAPISpyCreateDataSource(hDriver, pszFilename,
336 : const_cast<char **>(papszOptions), hDS);
337 : }
338 : #endif
339 :
340 20315 : return hDS;
341 : }
342 :
343 : /************************************************************************/
344 : /* CreateMultiDimensional() */
345 : /************************************************************************/
346 :
347 : /**
348 : * \brief Create a new multidimensional dataset with this driver.
349 : *
350 : * Only drivers that advertise the GDAL_DCAP_MULTIDIM_RASTER capability and
351 : * implement the pfnCreateMultiDimensional method might return a non nullptr
352 : * GDALDataset.
353 : *
354 : * This is the same as the C function GDALCreateMultiDimensional().
355 : *
356 : * @param pszFilename the name of the dataset to create. UTF-8 encoded.
357 : * @param papszRootGroupOptions driver specific options regarding the creation
358 : * of the root group. Might be nullptr.
359 : * @param papszOptions driver specific options regarding the creation
360 : * of the dataset. Might be nullptr.
361 : * @return a new dataset, or nullptr in case of failure.
362 : *
363 : * @since GDAL 3.1
364 : */
365 :
366 : GDALDataset *
367 526 : GDALDriver::CreateMultiDimensional(const char *pszFilename,
368 : CSLConstList papszRootGroupOptions,
369 : CSLConstList papszOptions)
370 :
371 : {
372 : /* -------------------------------------------------------------------- */
373 : /* Does this format support creation. */
374 : /* -------------------------------------------------------------------- */
375 526 : pfnCreateMultiDimensional = GetCreateMultiDimensionalCallback();
376 526 : if (pfnCreateMultiDimensional == nullptr)
377 : {
378 0 : CPLError(CE_Failure, CPLE_NotSupported,
379 : "GDALDriver::CreateMultiDimensional() ... "
380 : "no CreateMultiDimensional method implemented "
381 : "for this format.");
382 :
383 0 : return nullptr;
384 : }
385 :
386 : /* -------------------------------------------------------------------- */
387 : /* Validate creation options. */
388 : /* -------------------------------------------------------------------- */
389 526 : if (CPLTestBool(
390 : CPLGetConfigOption("GDAL_VALIDATE_CREATION_OPTIONS", "YES")))
391 : {
392 : const char *pszOptionList =
393 526 : GetMetadataItem(GDAL_DMD_MULTIDIM_DATASET_CREATIONOPTIONLIST);
394 1052 : CPLString osDriver;
395 526 : osDriver.Printf("driver %s", GetDescription());
396 526 : GDALValidateOptions(pszOptionList, papszOptions, "creation option",
397 : osDriver);
398 : }
399 :
400 526 : auto poDstDS = pfnCreateMultiDimensional(pszFilename, papszRootGroupOptions,
401 : papszOptions);
402 :
403 526 : if (poDstDS != nullptr)
404 : {
405 1048 : if (poDstDS->GetDescription() == nullptr ||
406 524 : strlen(poDstDS->GetDescription()) == 0)
407 145 : poDstDS->SetDescription(pszFilename);
408 :
409 524 : if (poDstDS->poDriver == nullptr)
410 522 : poDstDS->poDriver = this;
411 : }
412 :
413 526 : return poDstDS;
414 : }
415 :
416 : /************************************************************************/
417 : /* GDALCreateMultiDimensional() */
418 : /************************************************************************/
419 :
420 : /** \brief Create a new multidimensional dataset with this driver.
421 : *
422 : * This is the same as the C++ method GDALDriver::CreateMultiDimensional().
423 : */
424 476 : GDALDatasetH GDALCreateMultiDimensional(GDALDriverH hDriver,
425 : const char *pszName,
426 : CSLConstList papszRootGroupOptions,
427 : CSLConstList papszOptions)
428 : {
429 476 : VALIDATE_POINTER1(hDriver, __func__, nullptr);
430 476 : VALIDATE_POINTER1(pszName, __func__, nullptr);
431 476 : return GDALDataset::ToHandle(
432 : GDALDriver::FromHandle(hDriver)->CreateMultiDimensional(
433 476 : pszName, papszRootGroupOptions, papszOptions));
434 : }
435 :
436 : /************************************************************************/
437 : /* DefaultCreateCopyMultiDimensional() */
438 : /************************************************************************/
439 :
440 : //! @cond Doxygen_Suppress
441 :
442 27 : CPLErr GDALDriver::DefaultCreateCopyMultiDimensional(
443 : GDALDataset *poSrcDS, GDALDataset *poDstDS, bool bStrict,
444 : CSLConstList papszOptions, GDALProgressFunc pfnProgress,
445 : void *pProgressData)
446 : {
447 27 : if (pfnProgress == nullptr)
448 3 : pfnProgress = GDALDummyProgress;
449 :
450 54 : auto poSrcRG = poSrcDS->GetRootGroup();
451 27 : if (!poSrcRG)
452 0 : return CE_Failure;
453 54 : auto poDstRG = poDstDS->GetRootGroup();
454 27 : if (!poDstRG)
455 0 : return CE_Failure;
456 27 : GUInt64 nCurCost = 0;
457 54 : return poDstRG->CopyFrom(poDstRG, poSrcDS, poSrcRG, bStrict, nCurCost,
458 : poSrcRG->GetTotalCopyCost(), pfnProgress,
459 27 : pProgressData, papszOptions)
460 27 : ? CE_None
461 27 : : CE_Failure;
462 : }
463 :
464 : //! @endcond
465 :
466 : /************************************************************************/
467 : /* DefaultCopyMasks() */
468 : /************************************************************************/
469 :
470 : //! @cond Doxygen_Suppress
471 6178 : CPLErr GDALDriver::DefaultCopyMasks(GDALDataset *poSrcDS, GDALDataset *poDstDS,
472 : int bStrict)
473 :
474 : {
475 6178 : return DefaultCopyMasks(poSrcDS, poDstDS, bStrict, nullptr, nullptr,
476 6178 : nullptr);
477 : }
478 :
479 8219 : CPLErr GDALDriver::DefaultCopyMasks(GDALDataset *poSrcDS, GDALDataset *poDstDS,
480 : int bStrict, CSLConstList /*papszOptions*/,
481 : GDALProgressFunc pfnProgress,
482 : void *pProgressData)
483 :
484 : {
485 8219 : if (pfnProgress == nullptr)
486 6178 : pfnProgress = GDALDummyProgress;
487 :
488 8219 : int nBands = poSrcDS->GetRasterCount();
489 8219 : if (nBands == 0)
490 0 : return CE_None;
491 :
492 : /* -------------------------------------------------------------------- */
493 : /* Try to copy mask if it seems appropriate. */
494 : /* -------------------------------------------------------------------- */
495 8219 : const char *papszOptions[2] = {"COMPRESSED=YES", nullptr};
496 8219 : CPLErr eErr = CE_None;
497 :
498 8219 : int nTotalBandsWithMask = 0;
499 28483 : for (int iBand = 0; iBand < nBands; ++iBand)
500 : {
501 20264 : GDALRasterBand *poSrcBand = poSrcDS->GetRasterBand(iBand + 1);
502 :
503 20264 : int nMaskFlags = poSrcBand->GetMaskFlags();
504 20264 : if (!(nMaskFlags &
505 : (GMF_ALL_VALID | GMF_PER_DATASET | GMF_ALPHA | GMF_NODATA)))
506 : {
507 8 : nTotalBandsWithMask++;
508 : }
509 : }
510 :
511 8219 : int iBandWithMask = 0;
512 28483 : for (int iBand = 0; eErr == CE_None && iBand < nBands; ++iBand)
513 : {
514 20264 : GDALRasterBand *poSrcBand = poSrcDS->GetRasterBand(iBand + 1);
515 :
516 20264 : int nMaskFlags = poSrcBand->GetMaskFlags();
517 20264 : if (eErr == CE_None && !(nMaskFlags & (GMF_ALL_VALID | GMF_PER_DATASET |
518 : GMF_ALPHA | GMF_NODATA)))
519 : {
520 8 : GDALRasterBand *poDstBand = poDstDS->GetRasterBand(iBand + 1);
521 8 : if (poDstBand != nullptr)
522 : {
523 8 : eErr = poDstBand->CreateMaskBand(nMaskFlags);
524 8 : if (eErr == CE_None)
525 : {
526 24 : void *pScaledData = GDALCreateScaledProgress(
527 8 : double(iBandWithMask) /
528 8 : std::max(1, nTotalBandsWithMask),
529 8 : double(iBandWithMask + 1) /
530 8 : std::max(1, nTotalBandsWithMask),
531 : pfnProgress, pProgressData);
532 16 : eErr = GDALRasterBandCopyWholeRaster(
533 8 : poSrcBand->GetMaskBand(), poDstBand->GetMaskBand(),
534 : papszOptions, GDALScaledProgress, pScaledData);
535 8 : GDALDestroyScaledProgress(pScaledData);
536 : }
537 0 : else if (!bStrict)
538 : {
539 0 : eErr = CE_None;
540 : }
541 : }
542 : }
543 : }
544 :
545 : /* -------------------------------------------------------------------- */
546 : /* Try to copy a per-dataset mask if we have one. */
547 : /* -------------------------------------------------------------------- */
548 8219 : const int nMaskFlags = poSrcDS->GetRasterBand(1)->GetMaskFlags();
549 8219 : if (eErr == CE_None &&
550 8219 : !(nMaskFlags & (GMF_ALL_VALID | GMF_ALPHA | GMF_NODATA)) &&
551 13 : (nMaskFlags & GMF_PER_DATASET))
552 : {
553 8 : eErr = poDstDS->CreateMaskBand(nMaskFlags);
554 8 : if (eErr == CE_None)
555 : {
556 8 : eErr = GDALRasterBandCopyWholeRaster(
557 8 : poSrcDS->GetRasterBand(1)->GetMaskBand(),
558 8 : poDstDS->GetRasterBand(1)->GetMaskBand(), papszOptions,
559 : pfnProgress, pProgressData);
560 : }
561 0 : else if (!bStrict)
562 : {
563 0 : eErr = CE_None;
564 : }
565 : }
566 :
567 8219 : return eErr;
568 : }
569 :
570 : /************************************************************************/
571 : /* DefaultCreateCopy() */
572 : /************************************************************************/
573 :
574 1434 : GDALDataset *GDALDriver::DefaultCreateCopy(const char *pszFilename,
575 : GDALDataset *poSrcDS, int bStrict,
576 : CSLConstList papszOptions,
577 : GDALProgressFunc pfnProgress,
578 : void *pProgressData)
579 :
580 : {
581 1434 : if (pfnProgress == nullptr)
582 0 : pfnProgress = GDALDummyProgress;
583 :
584 1434 : CPLErrorReset();
585 :
586 : /* -------------------------------------------------------------------- */
587 : /* Use multidimensional raster API if available. */
588 : /* -------------------------------------------------------------------- */
589 2868 : auto poSrcGroup = poSrcDS->GetRootGroup();
590 1434 : if (poSrcGroup != nullptr && GetMetadataItem(GDAL_DCAP_MULTIDIM_RASTER))
591 : {
592 48 : CPLStringList aosDatasetCO;
593 31 : for (const char *pszOption : cpl::Iterate(papszOptions))
594 : {
595 7 : if (!STARTS_WITH_CI(pszOption, "ARRAY:"))
596 0 : aosDatasetCO.AddString(pszOption);
597 : }
598 : auto poDstDS = std::unique_ptr<GDALDataset>(
599 48 : CreateMultiDimensional(pszFilename, nullptr, aosDatasetCO.List()));
600 24 : if (!poDstDS)
601 0 : return nullptr;
602 48 : auto poDstGroup = poDstDS->GetRootGroup();
603 24 : if (!poDstGroup)
604 0 : return nullptr;
605 24 : if (DefaultCreateCopyMultiDimensional(
606 24 : poSrcDS, poDstDS.get(), CPL_TO_BOOL(bStrict), papszOptions,
607 24 : pfnProgress, pProgressData) != CE_None)
608 0 : return nullptr;
609 24 : return poDstDS.release();
610 : }
611 :
612 : /* -------------------------------------------------------------------- */
613 : /* Validate that we can create the output as requested. */
614 : /* -------------------------------------------------------------------- */
615 1410 : const int nXSize = poSrcDS->GetRasterXSize();
616 1410 : const int nYSize = poSrcDS->GetRasterYSize();
617 1410 : const int nBands = poSrcDS->GetRasterCount();
618 :
619 1410 : CPLDebug("GDAL", "Using default GDALDriver::CreateCopy implementation.");
620 :
621 1410 : const int nLayerCount = poSrcDS->GetLayerCount();
622 1434 : if (nBands == 0 && nLayerCount == 0 &&
623 24 : GetMetadataItem(GDAL_DCAP_VECTOR) == nullptr)
624 : {
625 17 : CPLError(CE_Failure, CPLE_NotSupported,
626 : "GDALDriver::DefaultCreateCopy does not support zero band");
627 17 : return nullptr;
628 : }
629 1393 : if (poSrcDS->GetDriver() != nullptr &&
630 1363 : poSrcDS->GetDriver()->GetMetadataItem(GDAL_DCAP_RASTER) != nullptr &&
631 1356 : poSrcDS->GetDriver()->GetMetadataItem(GDAL_DCAP_VECTOR) == nullptr &&
632 2759 : GetMetadataItem(GDAL_DCAP_RASTER) == nullptr &&
633 3 : GetMetadataItem(GDAL_DCAP_VECTOR) != nullptr)
634 : {
635 3 : CPLError(CE_Failure, CPLE_NotSupported,
636 : "Source driver is raster-only whereas output driver is "
637 : "vector-only");
638 3 : return nullptr;
639 : }
640 1390 : else if (poSrcDS->GetDriver() != nullptr &&
641 1360 : poSrcDS->GetDriver()->GetMetadataItem(GDAL_DCAP_RASTER) ==
642 7 : nullptr &&
643 7 : poSrcDS->GetDriver()->GetMetadataItem(GDAL_DCAP_VECTOR) !=
644 7 : nullptr &&
645 2750 : GetMetadataItem(GDAL_DCAP_RASTER) != nullptr &&
646 0 : GetMetadataItem(GDAL_DCAP_VECTOR) == nullptr)
647 : {
648 0 : CPLError(CE_Failure, CPLE_NotSupported,
649 : "Source driver is vector-only whereas output driver is "
650 : "raster-only");
651 0 : return nullptr;
652 : }
653 :
654 1390 : if (!pfnProgress(0.0, nullptr, pProgressData))
655 : {
656 2 : CPLError(CE_Failure, CPLE_UserInterrupt, "User terminated");
657 2 : return nullptr;
658 : }
659 :
660 : /* -------------------------------------------------------------------- */
661 : /* Propagate some specific structural metadata as options if it */
662 : /* appears to be supported by the target driver and the caller */
663 : /* didn't provide values. */
664 : /* -------------------------------------------------------------------- */
665 1388 : char **papszCreateOptions = CSLDuplicate(papszOptions);
666 1388 : const char *const apszOptItems[] = {"NBITS", "IMAGE_STRUCTURE", "PIXELTYPE",
667 : "IMAGE_STRUCTURE", nullptr};
668 :
669 4132 : for (int iOptItem = 0; nBands > 0 && apszOptItems[iOptItem] != nullptr;
670 2744 : iOptItem += 2)
671 : {
672 : // does the source have this metadata item on the first band?
673 2744 : auto poBand = poSrcDS->GetRasterBand(1);
674 2744 : poBand->EnablePixelTypeSignedByteWarning(false);
675 5488 : const char *pszValue = poBand->GetMetadataItem(
676 2744 : apszOptItems[iOptItem], apszOptItems[iOptItem + 1]);
677 2744 : poBand->EnablePixelTypeSignedByteWarning(true);
678 :
679 2744 : if (pszValue == nullptr)
680 2742 : continue;
681 :
682 : // Do not override provided value.
683 2 : if (CSLFetchNameValue(papszCreateOptions, pszValue) != nullptr)
684 0 : continue;
685 :
686 : // Does this appear to be a supported creation option on this driver?
687 : const char *pszOptionList =
688 2 : GetMetadataItem(GDAL_DMD_CREATIONOPTIONLIST);
689 :
690 2 : if (pszOptionList == nullptr ||
691 2 : strstr(pszOptionList, apszOptItems[iOptItem]) == nullptr)
692 0 : continue;
693 :
694 2 : papszCreateOptions = CSLSetNameValue(papszCreateOptions,
695 2 : apszOptItems[iOptItem], pszValue);
696 : }
697 :
698 : /* -------------------------------------------------------------------- */
699 : /* Create destination dataset. */
700 : /* -------------------------------------------------------------------- */
701 1388 : GDALDataType eType = GDT_Unknown;
702 :
703 1388 : if (nBands > 0)
704 1372 : eType = poSrcDS->GetRasterBand(1)->GetRasterDataType();
705 : GDALDataset *poDstDS =
706 1388 : Create(pszFilename, nXSize, nYSize, nBands, eType, papszCreateOptions);
707 :
708 1388 : CSLDestroy(papszCreateOptions);
709 :
710 1388 : if (poDstDS == nullptr)
711 326 : return nullptr;
712 :
713 1062 : int nDstBands = poDstDS->GetRasterCount();
714 1062 : CPLErr eErr = CE_None;
715 1062 : if (nDstBands != nBands)
716 : {
717 0 : if (GetMetadataItem(GDAL_DCAP_RASTER) != nullptr)
718 : {
719 : // Should not happen for a well-behaved driver.
720 0 : CPLError(
721 : CE_Failure, CPLE_AppDefined,
722 : "Output driver created only %d bands whereas %d were expected",
723 : nDstBands, nBands);
724 0 : eErr = CE_Failure;
725 : }
726 0 : nDstBands = 0;
727 : }
728 :
729 : /* -------------------------------------------------------------------- */
730 : /* Try setting the projection and geotransform if it seems */
731 : /* suitable. */
732 : /* -------------------------------------------------------------------- */
733 1062 : if (nDstBands == 0 && !bStrict)
734 4 : CPLTurnFailureIntoWarning(true);
735 :
736 1062 : GDALGeoTransform gt;
737 1996 : if (eErr == CE_None && poSrcDS->GetGeoTransform(gt) == CE_None &&
738 1996 : gt != GDALGeoTransform())
739 : {
740 929 : eErr = poDstDS->SetGeoTransform(gt);
741 929 : if (!bStrict)
742 579 : eErr = CE_None;
743 : }
744 :
745 1062 : if (eErr == CE_None)
746 : {
747 1053 : const auto poSrcSRS = poSrcDS->GetSpatialRefRasterOnly();
748 1053 : if (poSrcSRS && !poSrcSRS->IsEmpty())
749 : {
750 867 : eErr = poDstDS->SetSpatialRef(poSrcSRS);
751 867 : if (!bStrict)
752 549 : eErr = CE_None;
753 : }
754 : }
755 :
756 : /* -------------------------------------------------------------------- */
757 : /* Copy GCPs. */
758 : /* -------------------------------------------------------------------- */
759 1062 : if (poSrcDS->GetGCPCount() > 0 && eErr == CE_None)
760 : {
761 2 : eErr = poDstDS->SetGCPs(poSrcDS->GetGCPCount(), poSrcDS->GetGCPs(),
762 : poSrcDS->GetGCPProjection());
763 2 : if (!bStrict)
764 1 : eErr = CE_None;
765 : }
766 :
767 1062 : if (nDstBands == 0 && !bStrict)
768 4 : CPLTurnFailureIntoWarning(false);
769 :
770 : /* -------------------------------------------------------------------- */
771 : /* Copy metadata. */
772 : /* -------------------------------------------------------------------- */
773 1062 : DefaultCopyMetadata(poSrcDS, poDstDS, papszOptions, nullptr);
774 :
775 : /* -------------------------------------------------------------------- */
776 : /* Loop copying bands. */
777 : /* -------------------------------------------------------------------- */
778 2693 : for (int iBand = 0; eErr == CE_None && iBand < nDstBands; ++iBand)
779 : {
780 1631 : GDALRasterBand *const poSrcBand = poSrcDS->GetRasterBand(iBand + 1);
781 1631 : GDALRasterBand *const poDstBand = poDstDS->GetRasterBand(iBand + 1);
782 :
783 : /* --------------------------------------------------------------------
784 : */
785 : /* Do we need to copy a colortable. */
786 : /* --------------------------------------------------------------------
787 : */
788 1631 : GDALColorTable *const poCT = poSrcBand->GetColorTable();
789 1631 : if (poCT != nullptr)
790 29 : poDstBand->SetColorTable(poCT);
791 :
792 : /* --------------------------------------------------------------------
793 : */
794 : /* Do we need to copy other metadata? Most of this is */
795 : /* non-critical, so lets not bother folks if it fails are we */
796 : /* are not in strict mode. */
797 : /* --------------------------------------------------------------------
798 : */
799 1631 : if (!bStrict)
800 1014 : CPLTurnFailureIntoWarning(true);
801 :
802 1631 : if (strlen(poSrcBand->GetDescription()) > 0)
803 52 : poDstBand->SetDescription(poSrcBand->GetDescription());
804 :
805 1631 : if (CSLCount(poSrcBand->GetMetadata()) > 0)
806 114 : poDstBand->SetMetadata(poSrcBand->GetMetadata());
807 :
808 1631 : int bSuccess = FALSE;
809 1631 : double dfValue = poSrcBand->GetOffset(&bSuccess);
810 1631 : if (bSuccess && dfValue != 0.0)
811 5 : poDstBand->SetOffset(dfValue);
812 :
813 1631 : dfValue = poSrcBand->GetScale(&bSuccess);
814 1631 : if (bSuccess && dfValue != 1.0)
815 4 : poDstBand->SetScale(dfValue);
816 :
817 1631 : GDALCopyNoDataValue(poDstBand, poSrcBand);
818 :
819 2669 : if (poSrcBand->GetColorInterpretation() != GCI_Undefined &&
820 1038 : poSrcBand->GetColorInterpretation() !=
821 1038 : poDstBand->GetColorInterpretation())
822 821 : poDstBand->SetColorInterpretation(
823 821 : poSrcBand->GetColorInterpretation());
824 :
825 1631 : char **papszCatNames = poSrcBand->GetCategoryNames();
826 1631 : if (nullptr != papszCatNames)
827 1 : poDstBand->SetCategoryNames(papszCatNames);
828 :
829 : // Only copy RAT if it is of reasonable size to fit in memory
830 1631 : GDALRasterAttributeTable *poRAT = poSrcBand->GetDefaultRAT();
831 1633 : if (poRAT != nullptr && static_cast<GIntBig>(poRAT->GetColumnCount()) *
832 2 : poRAT->GetRowCount() <
833 : 1024 * 1024)
834 : {
835 2 : poDstBand->SetDefaultRAT(poRAT);
836 : }
837 :
838 1631 : if (!bStrict)
839 : {
840 1014 : CPLTurnFailureIntoWarning(false);
841 : }
842 : else
843 : {
844 617 : eErr = CPLGetLastErrorType();
845 : }
846 : }
847 :
848 : /* -------------------------------------------------------------------- */
849 : /* Copy image data. */
850 : /* -------------------------------------------------------------------- */
851 1062 : if (eErr == CE_None && nDstBands > 0)
852 : {
853 1018 : const char *const apszCopyRasterOptionsSkipHoles[] = {"SKIP_HOLES=YES",
854 : nullptr};
855 1018 : const bool bSkipHoles = CPLTestBool(
856 : CSLFetchNameValueDef(papszOptions, "SKIP_HOLES", "FALSE"));
857 1018 : eErr = GDALDatasetCopyWholeRaster(
858 : poSrcDS, poDstDS,
859 : bSkipHoles ? apszCopyRasterOptionsSkipHoles : nullptr, pfnProgress,
860 : pProgressData);
861 : }
862 :
863 : /* -------------------------------------------------------------------- */
864 : /* Should we copy some masks over? */
865 : /* -------------------------------------------------------------------- */
866 1062 : if (eErr == CE_None && nDstBands > 0)
867 1001 : eErr = DefaultCopyMasks(poSrcDS, poDstDS, eErr);
868 :
869 : /* -------------------------------------------------------------------- */
870 : /* Copy vector layers */
871 : /* -------------------------------------------------------------------- */
872 1062 : if (eErr == CE_None)
873 : {
874 1014 : if (nLayerCount > 0 && poDstDS->TestCapability(ODsCCreateLayer))
875 : {
876 20 : for (int iLayer = 0; iLayer < nLayerCount; ++iLayer)
877 : {
878 10 : OGRLayer *poLayer = poSrcDS->GetLayer(iLayer);
879 :
880 10 : if (poLayer == nullptr)
881 0 : continue;
882 :
883 10 : poDstDS->CopyLayer(poLayer, poLayer->GetName(), nullptr);
884 : }
885 : }
886 : }
887 :
888 : /* -------------------------------------------------------------------- */
889 : /* Try to cleanup the output dataset if the translation failed. */
890 : /* -------------------------------------------------------------------- */
891 1062 : if (eErr != CE_None)
892 : {
893 48 : delete poDstDS;
894 48 : if (!CPLFetchBool(papszOptions, "APPEND_SUBDATASET", false))
895 : {
896 : // Only delete if creating a new file
897 48 : Delete(pszFilename);
898 : }
899 48 : return nullptr;
900 : }
901 : else
902 : {
903 1014 : CPLErrorReset();
904 : }
905 :
906 1014 : return poDstDS;
907 : }
908 :
909 : /************************************************************************/
910 : /* DefaultCopyMetadata() */
911 : /************************************************************************/
912 :
913 5424 : void GDALDriver::DefaultCopyMetadata(GDALDataset *poSrcDS, GDALDataset *poDstDS,
914 : CSLConstList papszOptions,
915 : CSLConstList papszExcludedDomains)
916 : {
917 : const char *pszCopySrcMDD =
918 5424 : CSLFetchNameValueDef(papszOptions, "COPY_SRC_MDD", "AUTO");
919 5424 : char **papszSrcMDD = CSLFetchNameValueMultiple(papszOptions, "SRC_MDD");
920 5424 : if (EQUAL(pszCopySrcMDD, "AUTO") || CPLTestBool(pszCopySrcMDD) ||
921 : papszSrcMDD)
922 : {
923 4 : if ((!papszSrcMDD || CSLFindString(papszSrcMDD, "") >= 0 ||
924 2 : CSLFindString(papszSrcMDD, "_DEFAULT_") >= 0) &&
925 10690 : CSLFindString(papszExcludedDomains, "") < 0 &&
926 5264 : CSLFindString(papszExcludedDomains, "_DEFAULT_") < 0)
927 : {
928 5264 : if (poSrcDS->GetMetadata() != nullptr)
929 831 : poDstDS->SetMetadata(poSrcDS->GetMetadata());
930 : }
931 :
932 : /* -------------------------------------------------------------------- */
933 : /* Copy transportable special domain metadata. */
934 : /* It would be nice to copy geolocation, but it is pretty fragile. */
935 : /* -------------------------------------------------------------------- */
936 5422 : constexpr const char *apszDefaultDomains[] = {
937 : "RPC", "xml:XMP", "json:ISIS3", "json:VICAR"};
938 27110 : for (const char *pszDomain : apszDefaultDomains)
939 : {
940 43360 : if ((!papszSrcMDD || CSLFindString(papszSrcMDD, pszDomain) >= 0) &&
941 21672 : CSLFindString(papszExcludedDomains, pszDomain) < 0)
942 : {
943 21672 : CSLConstList papszMD = poSrcDS->GetMetadata(pszDomain);
944 21672 : if (papszMD)
945 5 : poDstDS->SetMetadata(papszMD, pszDomain);
946 : }
947 : }
948 :
949 5422 : if ((!EQUAL(pszCopySrcMDD, "AUTO") && CPLTestBool(pszCopySrcMDD)) ||
950 : papszSrcMDD)
951 : {
952 24 : for (const char *pszDomain :
953 30 : CPLStringList(poSrcDS->GetMetadataDomainList()))
954 : {
955 36 : if (pszDomain[0] != 0 &&
956 12 : (!papszSrcMDD ||
957 12 : CSLFindString(papszSrcMDD, pszDomain) >= 0))
958 : {
959 10 : bool bCanCopy = true;
960 10 : if (CSLFindString(papszExcludedDomains, pszDomain) >= 0)
961 : {
962 0 : bCanCopy = false;
963 : }
964 : else
965 : {
966 50 : for (const char *pszOtherDomain : apszDefaultDomains)
967 : {
968 40 : if (EQUAL(pszDomain, pszOtherDomain))
969 : {
970 0 : bCanCopy = false;
971 0 : break;
972 : }
973 : }
974 10 : if (!papszSrcMDD)
975 : {
976 6 : constexpr const char *const apszReservedDomains[] =
977 : {"IMAGE_STRUCTURE", "DERIVED_SUBDATASETS"};
978 6 : for (const char *pszOtherDomain :
979 12 : apszReservedDomains)
980 : {
981 10 : if (EQUAL(pszDomain, pszOtherDomain))
982 : {
983 4 : bCanCopy = false;
984 4 : break;
985 : }
986 : }
987 : }
988 : }
989 10 : if (bCanCopy)
990 : {
991 6 : poDstDS->SetMetadata(poSrcDS->GetMetadata(pszDomain),
992 6 : pszDomain);
993 : }
994 : }
995 : }
996 : }
997 : }
998 5424 : CSLDestroy(papszSrcMDD);
999 5424 : }
1000 :
1001 : /************************************************************************/
1002 : /* QuietDeleteForCreateCopy() */
1003 : /************************************************************************/
1004 :
1005 11964 : CPLErr GDALDriver::QuietDeleteForCreateCopy(const char *pszFilename,
1006 : GDALDataset *poSrcDS)
1007 : {
1008 : // Someone issuing CreateCopy("foo.tif") on a
1009 : // memory driver doesn't expect files with those names to be deleted
1010 : // on a file system...
1011 : // This is somewhat messy. Ideally there should be a way for the
1012 : // driver to overload the default behavior
1013 23332 : if (!EQUAL(GetDescription(), "MEM") && !EQUAL(GetDescription(), "Memory") &&
1014 : // Also exclude database formats for which there's no file list
1015 : // and whose opening might be slow (GeoRaster in particular)
1016 34700 : !EQUAL(GetDescription(), "GeoRaster") &&
1017 11368 : !EQUAL(GetDescription(), "PostGISRaster"))
1018 : {
1019 : /* --------------------------------------------------------------------
1020 : */
1021 : /* Establish list of files of output dataset if it already
1022 : * exists. */
1023 : /* --------------------------------------------------------------------
1024 : */
1025 22700 : std::set<std::string> oSetExistingDestFiles;
1026 : {
1027 22700 : CPLErrorStateBackuper oErrorStateBackuper(CPLQuietErrorHandler);
1028 11350 : const char *const apszAllowedDrivers[] = {GetDescription(),
1029 11350 : nullptr};
1030 : auto poExistingOutputDS =
1031 : std::unique_ptr<GDALDataset>(GDALDataset::Open(
1032 22700 : pszFilename, GDAL_OF_RASTER, apszAllowedDrivers));
1033 11350 : if (poExistingOutputDS)
1034 : {
1035 692 : for (const char *pszFileInList :
1036 658 : CPLStringList(poExistingOutputDS->GetFileList()))
1037 : {
1038 : oSetExistingDestFiles.insert(
1039 346 : CPLString(pszFileInList).replaceAll('\\', '/'));
1040 : }
1041 : }
1042 : }
1043 :
1044 : /* --------------------------------------------------------------------
1045 : */
1046 : /* Check if the source dataset shares some files with the dest
1047 : * one.*/
1048 : /* --------------------------------------------------------------------
1049 : */
1050 22700 : std::set<std::string> oSetExistingDestFilesFoundInSource;
1051 11350 : if (!oSetExistingDestFiles.empty())
1052 : {
1053 624 : CPLErrorStateBackuper oErrorStateBackuper(CPLQuietErrorHandler);
1054 : // We need to reopen in a temporary dataset for the particular
1055 : // case of overwritten a .tif.ovr file from a .tif
1056 : // If we probe the file list of the .tif, it will then open the
1057 : // .tif.ovr !
1058 312 : const char *const apszAllowedDrivers[] = {
1059 312 : poSrcDS->GetDriver() ? poSrcDS->GetDriver()->GetDescription()
1060 : : nullptr,
1061 312 : nullptr};
1062 : auto poSrcDSTmp = std::unique_ptr<GDALDataset>(GDALDataset::Open(
1063 312 : poSrcDS->GetDescription(), GDAL_OF_RASTER, apszAllowedDrivers,
1064 624 : poSrcDS->papszOpenOptions));
1065 312 : if (poSrcDSTmp)
1066 : {
1067 211 : for (const char *pszFileInList :
1068 410 : CPLStringList(poSrcDSTmp->GetFileList()))
1069 : {
1070 422 : CPLString osFilename(pszFileInList);
1071 211 : osFilename.replaceAll('\\', '/');
1072 211 : if (cpl::contains(oSetExistingDestFiles, osFilename))
1073 : {
1074 : oSetExistingDestFilesFoundInSource.insert(
1075 16 : std::move(osFilename));
1076 : }
1077 : }
1078 : }
1079 : }
1080 :
1081 : // If the source file(s) and the dest one share some files in
1082 : // common, only remove the files that are *not* in common
1083 11350 : if (!oSetExistingDestFilesFoundInSource.empty())
1084 : {
1085 36 : for (const std::string &osFilename : oSetExistingDestFiles)
1086 : {
1087 21 : if (!cpl::contains(oSetExistingDestFilesFoundInSource,
1088 : osFilename))
1089 : {
1090 5 : VSIUnlink(osFilename.c_str());
1091 : }
1092 : }
1093 : }
1094 :
1095 11350 : QuietDelete(pszFilename);
1096 : }
1097 :
1098 11964 : return CE_None;
1099 : }
1100 :
1101 : //! @endcond
1102 :
1103 : /************************************************************************/
1104 : /* CreateCopy() */
1105 : /************************************************************************/
1106 :
1107 : /**
1108 : * \brief Create a copy of a dataset.
1109 : *
1110 : * This method will attempt to create a copy of a raster dataset with the
1111 : * indicated filename, and in this drivers format. Band number, size,
1112 : * type, projection, geotransform and so forth are all to be copied from
1113 : * the provided template dataset.
1114 : *
1115 : * Note that many sequential write once formats (such as JPEG and PNG) don't
1116 : * implement the Create() method but do implement this CreateCopy() method.
1117 : * If the driver doesn't implement CreateCopy(), but does implement Create()
1118 : * then the default CreateCopy() mechanism built on calling Create() will
1119 : * be used.
1120 : * So to test if CreateCopy() is available, you can test if GDAL_DCAP_CREATECOPY
1121 : * or GDAL_DCAP_CREATE is set in the GDAL metadata.
1122 : *
1123 : * It is intended that CreateCopy() will often be used with a source dataset
1124 : * which is a virtual dataset allowing configuration of band types, and other
1125 : * information without actually duplicating raster data (see the VRT driver).
1126 : * This is what is done by the gdal_translate utility for example.
1127 : *
1128 : * That function will try to validate the creation option list passed to the
1129 : * driver with the GDALValidateCreationOptions() method. This check can be
1130 : * disabled by defining the configuration option
1131 : * GDAL_VALIDATE_CREATION_OPTIONS=NO.
1132 : *
1133 : * This function copy all metadata from the default domain ("")
1134 : *
1135 : * Even is bStrict is TRUE, only the <b>value</b> of the data is equivalent,
1136 : * but the data layout (INTERLEAVE as PIXEL/LINE/BAND) of the dst dataset is
1137 : * controlled by the papszOptions creation options, and may differ from the
1138 : * poSrcDS src dataset.
1139 : * Starting from GDAL 3.5, if no INTERLEAVE and COMPRESS creation option has
1140 : * been specified in papszOptions, and if the driver supports equivalent
1141 : * interleaving as the src dataset, the CreateCopy() will internally add the
1142 : * proper creation option to get the same data interleaving.
1143 : *
1144 : * After you have finished working with the returned dataset, it is
1145 : * <b>required</b> to close it with GDALClose(). This does not only close the
1146 : * file handle, but also ensures that all the data and metadata has been written
1147 : * to the dataset (GDALFlushCache() is not sufficient for that purpose).
1148 : *
1149 : * For multidimensional datasets, papszOptions can contain array creation
1150 : * options, if they are prefixed with "ARRAY:". \see GDALGroup::CopyFrom()
1151 : * documentation for further details regarding such options.
1152 : *
1153 : * @param pszFilename the name for the new dataset. UTF-8 encoded.
1154 : * @param poSrcDS the dataset being duplicated.
1155 : * @param bStrict TRUE if the copy must be strictly equivalent, or more
1156 : * normally FALSE indicating that the copy may adapt as needed for the
1157 : * output format.
1158 : * @param papszOptions additional format dependent options controlling
1159 : * creation of the output file.
1160 : * The APPEND_SUBDATASET=YES option can be specified to avoid prior destruction
1161 : * of existing dataset.
1162 : * Starting with GDAL 3.8.0, the following options are recognized by the
1163 : * GTiff, COG, VRT, PNG au JPEG drivers:
1164 : * <ul>
1165 : * <li>COPY_SRC_MDD=AUTO/YES/NO: whether metadata domains of the source dataset
1166 : * should be copied to the destination dataset. In the default AUTO mode, only
1167 : * "safe" domains will be copied, which include the default metadata domain
1168 : * (some drivers may include other domains such as IMD, RPC, GEOLOCATION). When
1169 : * setting YES, all domains will be copied (but a few reserved ones like
1170 : * IMAGE_STRUCTURE or DERIVED_SUBDATASETS). When setting NO, no source metadata
1171 : * will be copied.
1172 : * </li>
1173 : *<li>SRC_MDD=domain_name: which source metadata domain should be copied.
1174 : * This option restricts the list of source metadata domains to be copied
1175 : * (it implies COPY_SRC_MDD=YES if it is not set). This option may be specified
1176 : * as many times as they are source domains. The default metadata domain is the
1177 : * empty string "" ("_DEFAULT_") may also be used when empty string is not practical)
1178 : * </li>
1179 : * </ul>
1180 : * @param pfnProgress a function to be used to report progress of the copy.
1181 : * @param pProgressData application data passed into progress function.
1182 : *
1183 : * @return a pointer to the newly created dataset (may be read-only access).
1184 : */
1185 :
1186 11430 : GDALDataset *GDALDriver::CreateCopy(const char *pszFilename,
1187 : GDALDataset *poSrcDS, int bStrict,
1188 : CSLConstList papszOptions,
1189 : GDALProgressFunc pfnProgress,
1190 : void *pProgressData)
1191 :
1192 : {
1193 11430 : if (pfnProgress == nullptr)
1194 8670 : pfnProgress = GDALDummyProgress;
1195 :
1196 11430 : const int nBandCount = poSrcDS->GetRasterCount();
1197 :
1198 : /* -------------------------------------------------------------------- */
1199 : /* If no INTERLEAVE creation option is given, we will try to add */
1200 : /* one that matches the current srcDS interleaving */
1201 : /* -------------------------------------------------------------------- */
1202 11430 : char **papszOptionsToDelete = nullptr;
1203 : const char *srcInterleave =
1204 11430 : poSrcDS->GetMetadataItem("INTERLEAVE", "IMAGE_STRUCTURE");
1205 6846 : if (nBandCount > 1 && srcInterleave != nullptr &&
1206 24728 : CSLFetchNameValue(papszOptions, "INTERLEAVE") == nullptr &&
1207 6452 : EQUAL(CSLFetchNameValueDef(papszOptions, "COMPRESS", "NONE"), "NONE"))
1208 : {
1209 :
1210 : // look for INTERLEAVE values of the driver
1211 6298 : char **interleavesCSL = nullptr;
1212 : const char *pszOptionList =
1213 6298 : this->GetMetadataItem(GDAL_DMD_CREATIONOPTIONLIST);
1214 : CPLXMLNode *xmlNode =
1215 6298 : !pszOptionList ? nullptr : CPLParseXMLString(pszOptionList);
1216 6298 : for (CPLXMLNode *child = !xmlNode ? nullptr : xmlNode->psChild;
1217 128571 : child != nullptr; child = child->psNext)
1218 : {
1219 122273 : if ((child->eType == CXT_Element) &&
1220 122273 : EQUAL(child->pszValue, "Option"))
1221 : {
1222 : const char *nameAttribute =
1223 122273 : CPLGetXMLValue(child, "name", nullptr);
1224 122273 : const bool isInterleaveAttribute =
1225 122273 : nameAttribute && EQUAL(nameAttribute, "INTERLEAVE");
1226 122273 : if (isInterleaveAttribute)
1227 : {
1228 1158 : for (CPLXMLNode *optionChild = child->psChild;
1229 7016 : optionChild != nullptr;
1230 5858 : optionChild = optionChild->psNext)
1231 : {
1232 5858 : if ((optionChild->eType == CXT_Element) &&
1233 2369 : EQUAL(optionChild->pszValue, "Value"))
1234 : {
1235 2369 : CPLXMLNode *optionChildValue = optionChild->psChild;
1236 2369 : if (optionChildValue &&
1237 2369 : (optionChildValue->eType == CXT_Text))
1238 : {
1239 2369 : interleavesCSL = CSLAddString(
1240 2369 : interleavesCSL, optionChildValue->pszValue);
1241 : }
1242 : }
1243 : }
1244 : }
1245 : }
1246 : }
1247 6298 : CPLDestroyXMLNode(xmlNode);
1248 :
1249 : const char *dstInterleaveBand =
1250 11462 : (CSLFindString(interleavesCSL, "BAND") >= 0) ? "BAND"
1251 5164 : : (CSLFindString(interleavesCSL, "BSQ") >= 0) ? "BSQ"
1252 6298 : : nullptr;
1253 : const char *dstInterleaveLine =
1254 12596 : (CSLFindString(interleavesCSL, "LINE") >= 0) ? "LINE"
1255 6298 : : (CSLFindString(interleavesCSL, "BIL") >= 0) ? "BIL"
1256 6298 : : nullptr;
1257 : const char *dstInterleavePixel =
1258 11462 : (CSLFindString(interleavesCSL, "PIXEL") >= 0) ? "PIXEL"
1259 5164 : : (CSLFindString(interleavesCSL, "BIP") >= 0) ? "BIP"
1260 6298 : : nullptr;
1261 6298 : const char *dstInterleave =
1262 6589 : EQUAL(srcInterleave, "BAND") ? dstInterleaveBand
1263 580 : : EQUAL(srcInterleave, "LINE") ? dstInterleaveLine
1264 289 : : EQUAL(srcInterleave, "PIXEL") ? dstInterleavePixel
1265 : : nullptr;
1266 6298 : CSLDestroy(interleavesCSL);
1267 :
1268 6298 : if (dstInterleave != nullptr)
1269 : {
1270 1158 : papszOptionsToDelete = CSLDuplicate(papszOptions);
1271 1158 : papszOptionsToDelete = CSLSetNameValue(papszOptionsToDelete,
1272 : "INTERLEAVE", dstInterleave);
1273 1158 : papszOptionsToDelete = CSLSetNameValue(
1274 : papszOptionsToDelete, "@INTERLEAVE_ADDED_AUTOMATICALLY", "YES");
1275 1158 : papszOptions = papszOptionsToDelete;
1276 : }
1277 : }
1278 :
1279 : /* -------------------------------------------------------------------- */
1280 : /* Make sure we cleanup if there is an existing dataset of this */
1281 : /* name. But even if that seems to fail we will continue since */
1282 : /* it might just be a corrupt file or something. */
1283 : /* -------------------------------------------------------------------- */
1284 : const bool bAppendSubdataset =
1285 11430 : CPLFetchBool(papszOptions, "APPEND_SUBDATASET", false);
1286 : // Note: @QUIET_DELETE_ON_CREATE_COPY is set to NO by the KMLSuperOverlay
1287 : // driver when writing a .kmz file. Also by GDALTranslate() if it has
1288 : // already done a similar job.
1289 22835 : if (!bAppendSubdataset &&
1290 11405 : CPLFetchBool(papszOptions, "@QUIET_DELETE_ON_CREATE_COPY", true))
1291 : {
1292 8832 : QuietDeleteForCreateCopy(pszFilename, poSrcDS);
1293 : }
1294 :
1295 : int iIdxQuietDeleteOnCreateCopy =
1296 11430 : CSLPartialFindString(papszOptions, "@QUIET_DELETE_ON_CREATE_COPY=");
1297 11430 : if (iIdxQuietDeleteOnCreateCopy >= 0)
1298 : {
1299 2573 : if (papszOptionsToDelete == nullptr)
1300 1553 : papszOptionsToDelete = CSLDuplicate(papszOptions);
1301 2573 : papszOptionsToDelete = CSLRemoveStrings(
1302 : papszOptionsToDelete, iIdxQuietDeleteOnCreateCopy, 1, nullptr);
1303 2573 : papszOptions = papszOptionsToDelete;
1304 : }
1305 :
1306 : /* -------------------------------------------------------------------- */
1307 : /* If _INTERNAL_DATASET=YES, the returned dataset will not be */
1308 : /* registered in the global list of open datasets. */
1309 : /* -------------------------------------------------------------------- */
1310 : const int iIdxInternalDataset =
1311 11430 : CSLPartialFindString(papszOptions, "_INTERNAL_DATASET=");
1312 11430 : bool bInternalDataset = false;
1313 11430 : if (iIdxInternalDataset >= 0)
1314 : {
1315 : bInternalDataset =
1316 4165 : CPLFetchBool(papszOptions, "_INTERNAL_DATASET", false);
1317 4165 : if (papszOptionsToDelete == nullptr)
1318 4165 : papszOptionsToDelete = CSLDuplicate(papszOptions);
1319 4165 : papszOptionsToDelete = CSLRemoveStrings(
1320 : papszOptionsToDelete, iIdxInternalDataset, 1, nullptr);
1321 4165 : papszOptions = papszOptionsToDelete;
1322 : }
1323 :
1324 : /* -------------------------------------------------------------------- */
1325 : /* Validate creation options. */
1326 : /* -------------------------------------------------------------------- */
1327 11430 : if (CPLTestBool(
1328 : CPLGetConfigOption("GDAL_VALIDATE_CREATION_OPTIONS", "YES")))
1329 : {
1330 22860 : auto poSrcGroup = poSrcDS->GetRootGroup();
1331 11430 : if (poSrcGroup != nullptr && GetMetadataItem(GDAL_DCAP_MULTIDIM_RASTER))
1332 : {
1333 224 : CPLStringList aosDatasetCO;
1334 119 : for (const char *pszOption : cpl::Iterate(papszOptions))
1335 : {
1336 7 : if (!STARTS_WITH_CI(pszOption, "ARRAY:"))
1337 0 : aosDatasetCO.AddString(pszOption);
1338 : }
1339 112 : GDALValidateCreationOptions(this, aosDatasetCO.List());
1340 : }
1341 : else
1342 : {
1343 11318 : GDALValidateCreationOptions(this, papszOptions);
1344 : }
1345 : }
1346 :
1347 : /* -------------------------------------------------------------------- */
1348 : /* Advise the source raster that we are going to read it completely */
1349 : /* -------------------------------------------------------------------- */
1350 :
1351 11430 : const int nXSize = poSrcDS->GetRasterXSize();
1352 11430 : const int nYSize = poSrcDS->GetRasterYSize();
1353 11430 : GDALDataType eDT = GDT_Unknown;
1354 11430 : if (nBandCount > 0)
1355 : {
1356 11196 : GDALRasterBand *poSrcBand = poSrcDS->GetRasterBand(1);
1357 11196 : if (poSrcBand)
1358 11196 : eDT = poSrcBand->GetRasterDataType();
1359 : }
1360 11430 : poSrcDS->AdviseRead(0, 0, nXSize, nYSize, nXSize, nYSize, eDT, nBandCount,
1361 11430 : nullptr, nullptr);
1362 :
1363 : /* -------------------------------------------------------------------- */
1364 : /* If the format provides a CreateCopy() method use that, */
1365 : /* otherwise fallback to the internal implementation using the */
1366 : /* Create() method. */
1367 : /* -------------------------------------------------------------------- */
1368 11430 : GDALDataset *poDstDS = nullptr;
1369 11430 : auto l_pfnCreateCopy = GetCreateCopyCallback();
1370 21728 : if (l_pfnCreateCopy != nullptr &&
1371 10298 : !CPLTestBool(CPLGetConfigOption("GDAL_DEFAULT_CREATE_COPY", "NO")))
1372 : {
1373 10298 : poDstDS = l_pfnCreateCopy(pszFilename, poSrcDS, bStrict,
1374 : const_cast<char **>(papszOptions),
1375 : pfnProgress, pProgressData);
1376 10298 : if (poDstDS != nullptr)
1377 : {
1378 18134 : if (poDstDS->GetDescription() == nullptr ||
1379 9067 : strlen(poDstDS->GetDescription()) == 0)
1380 409 : poDstDS->SetDescription(pszFilename);
1381 :
1382 9067 : if (poDstDS->poDriver == nullptr)
1383 8008 : poDstDS->poDriver = this;
1384 :
1385 9067 : if (!bInternalDataset)
1386 4902 : poDstDS->AddToDatasetOpenList();
1387 : }
1388 : }
1389 : else
1390 : {
1391 1132 : poDstDS = DefaultCreateCopy(pszFilename, poSrcDS, bStrict, papszOptions,
1392 : pfnProgress, pProgressData);
1393 : }
1394 :
1395 11430 : CSLDestroy(papszOptionsToDelete);
1396 11430 : return poDstDS;
1397 : }
1398 :
1399 : /************************************************************************/
1400 : /* GDALCreateCopy() */
1401 : /************************************************************************/
1402 :
1403 : /**
1404 : * \brief Create a copy of a dataset.
1405 : *
1406 : * @see GDALDriver::CreateCopy()
1407 : */
1408 :
1409 6606 : GDALDatasetH CPL_STDCALL GDALCreateCopy(GDALDriverH hDriver,
1410 : const char *pszFilename,
1411 : GDALDatasetH hSrcDS, int bStrict,
1412 : CSLConstList papszOptions,
1413 : GDALProgressFunc pfnProgress,
1414 : void *pProgressData)
1415 :
1416 : {
1417 6606 : VALIDATE_POINTER1(hDriver, "GDALCreateCopy", nullptr);
1418 6606 : VALIDATE_POINTER1(hSrcDS, "GDALCreateCopy", nullptr);
1419 :
1420 6606 : return GDALDriver::FromHandle(hDriver)->CreateCopy(
1421 : pszFilename, GDALDataset::FromHandle(hSrcDS), bStrict, papszOptions,
1422 6606 : pfnProgress, pProgressData);
1423 : }
1424 :
1425 : /************************************************************************/
1426 : /* CanVectorTranslateFrom() */
1427 : /************************************************************************/
1428 :
1429 : /** Returns whether the driver can translate from a vector dataset,
1430 : * using the arguments passed to GDALVectorTranslate() stored in
1431 : * papszVectorTranslateArguments.
1432 : *
1433 : * This is used to determine if the driver supports the VectorTranslateFrom()
1434 : * operation.
1435 : *
1436 : * @param pszDestName Target dataset name
1437 : * @param poSourceDS Source dataset
1438 : * @param papszVectorTranslateArguments Non-positional arguments passed to
1439 : * GDALVectorTranslate() (may be nullptr)
1440 : * @param[out] ppapszFailureReasons nullptr, or a pointer to an null-terminated
1441 : * array of strings to record the reason(s) for the impossibility.
1442 : * @return true if VectorTranslateFrom() can be called with the same arguments.
1443 : * @since GDAL 3.8
1444 : */
1445 903 : bool GDALDriver::CanVectorTranslateFrom(
1446 : const char *pszDestName, GDALDataset *poSourceDS,
1447 : CSLConstList papszVectorTranslateArguments, char ***ppapszFailureReasons)
1448 :
1449 : {
1450 903 : if (ppapszFailureReasons)
1451 : {
1452 0 : *ppapszFailureReasons = nullptr;
1453 : }
1454 :
1455 903 : if (!pfnCanVectorTranslateFrom)
1456 : {
1457 897 : if (ppapszFailureReasons)
1458 : {
1459 0 : *ppapszFailureReasons = CSLAddString(
1460 : nullptr,
1461 : "CanVectorTranslateFrom() not implemented for this driver");
1462 : }
1463 897 : return false;
1464 : }
1465 :
1466 6 : char **papszFailureReasons = nullptr;
1467 6 : bool bRet = pfnCanVectorTranslateFrom(
1468 : pszDestName, poSourceDS, papszVectorTranslateArguments,
1469 : ppapszFailureReasons ? ppapszFailureReasons : &papszFailureReasons);
1470 6 : if (!ppapszFailureReasons)
1471 : {
1472 2 : for (const char *pszReason :
1473 10 : cpl::Iterate(static_cast<CSLConstList>(papszFailureReasons)))
1474 : {
1475 2 : CPLDebug("GDAL", "%s", pszReason);
1476 : }
1477 6 : CSLDestroy(papszFailureReasons);
1478 : }
1479 6 : return bRet;
1480 : }
1481 :
1482 193 : bool GDALDriver::HasOpenOption(const char *pszOpenOptionName) const
1483 : {
1484 193 : if (pszOpenOptionName == nullptr)
1485 0 : return false;
1486 :
1487 : // Const cast is safe here since we are only reading the metadata
1488 386 : auto pszOOMd{const_cast<GDALDriver *>(this)->GetMetadataItem(
1489 193 : GDAL_DMD_OPENOPTIONLIST)};
1490 193 : if (pszOOMd == nullptr)
1491 74 : return false;
1492 :
1493 238 : const CPLXMLTreeCloser oXml{CPLParseXMLString(pszOOMd)};
1494 1148 : for (CPLXMLNode *option = oXml->psChild; option != nullptr;
1495 1029 : option = option->psNext)
1496 : {
1497 1030 : if (EQUAL(CPLGetXMLValue(CPLGetXMLNode(option, "name"), nullptr, ""),
1498 : pszOpenOptionName))
1499 1 : return true;
1500 : }
1501 118 : return false;
1502 : }
1503 :
1504 : /************************************************************************/
1505 : /* VectorTranslateFrom() */
1506 : /************************************************************************/
1507 :
1508 : /** Create a copy of a vector dataset, using the arguments passed to
1509 : * GDALVectorTranslate() stored in papszVectorTranslateArguments.
1510 : *
1511 : * This may be implemented by some drivers that can convert from an existing
1512 : * dataset in an optimized way.
1513 : *
1514 : * This is for example used by the PMTiles to convert from MBTiles.
1515 : *
1516 : * @param pszDestName Target dataset name
1517 : * @param poSourceDS Source dataset
1518 : * @param papszVectorTranslateArguments Non-positional arguments passed to
1519 : * GDALVectorTranslate() (may be nullptr)
1520 : * @param pfnProgress a function to be used to report progress of the copy.
1521 : * @param pProgressData application data passed into progress function.
1522 : * @return a new dataset in case of success, or nullptr in case of error.
1523 : * @since GDAL 3.8
1524 : */
1525 4 : GDALDataset *GDALDriver::VectorTranslateFrom(
1526 : const char *pszDestName, GDALDataset *poSourceDS,
1527 : CSLConstList papszVectorTranslateArguments, GDALProgressFunc pfnProgress,
1528 : void *pProgressData)
1529 :
1530 : {
1531 4 : if (!pfnVectorTranslateFrom)
1532 : {
1533 0 : CPLError(CE_Failure, CPLE_AppDefined,
1534 : "VectorTranslateFrom() not implemented for this driver");
1535 0 : return nullptr;
1536 : }
1537 :
1538 4 : return pfnVectorTranslateFrom(pszDestName, poSourceDS,
1539 : papszVectorTranslateArguments, pfnProgress,
1540 4 : pProgressData);
1541 : }
1542 :
1543 : /************************************************************************/
1544 : /* QuietDelete() */
1545 : /************************************************************************/
1546 :
1547 : /**
1548 : * \brief Delete dataset if found.
1549 : *
1550 : * This is a helper method primarily used by Create() and
1551 : * CreateCopy() to predelete any dataset of the name soon to be
1552 : * created. It will attempt to delete the named dataset if
1553 : * one is found, otherwise it does nothing. An error is only
1554 : * returned if the dataset is found but the delete fails.
1555 : *
1556 : * This is a static method and it doesn't matter what driver instance
1557 : * it is invoked on. It will attempt to discover the correct driver
1558 : * using Identify().
1559 : *
1560 : * @param pszName the dataset name to try and delete.
1561 : * @param papszAllowedDrivers NULL to consider all candidate drivers, or a NULL
1562 : * terminated list of strings with the driver short names that must be
1563 : * considered. (Note: implemented only starting with GDAL 3.4.1)
1564 : * @return CE_None if the dataset does not exist, or is deleted without issues.
1565 : */
1566 :
1567 24729 : CPLErr GDALDriver::QuietDelete(const char *pszName,
1568 : CSLConstList papszAllowedDrivers)
1569 :
1570 : {
1571 : VSIStatBufL sStat;
1572 : const bool bExists =
1573 24729 : VSIStatExL(pszName, &sStat,
1574 24729 : VSI_STAT_EXISTS_FLAG | VSI_STAT_NATURE_FLAG) == 0;
1575 :
1576 : #ifdef S_ISFIFO
1577 24729 : if (bExists && S_ISFIFO(sStat.st_mode))
1578 0 : return CE_None;
1579 : #endif
1580 :
1581 24729 : GDALDriver *poDriver = nullptr;
1582 24729 : if (papszAllowedDrivers)
1583 : {
1584 76 : GDALOpenInfo oOpenInfo(pszName, GDAL_OF_ALL);
1585 38 : for (const char *pszDriverName : cpl::Iterate(papszAllowedDrivers))
1586 : {
1587 : GDALDriver *poTmpDriver =
1588 38 : GDALDriver::FromHandle(GDALGetDriverByName(pszDriverName));
1589 38 : if (poTmpDriver)
1590 : {
1591 : const bool bIdentifyRes =
1592 38 : poTmpDriver->pfnIdentifyEx
1593 76 : ? poTmpDriver->pfnIdentifyEx(poTmpDriver, &oOpenInfo) >
1594 : 0
1595 76 : : poTmpDriver->pfnIdentify &&
1596 38 : poTmpDriver->pfnIdentify(&oOpenInfo) > 0;
1597 38 : if (bIdentifyRes)
1598 : {
1599 38 : poDriver = poTmpDriver;
1600 38 : break;
1601 : }
1602 : }
1603 : }
1604 : }
1605 : else
1606 : {
1607 49382 : CPLErrorStateBackuper oErrorStateBackuper(CPLQuietErrorHandler);
1608 24691 : poDriver = GDALDriver::FromHandle(GDALIdentifyDriver(pszName, nullptr));
1609 : }
1610 :
1611 24729 : if (poDriver == nullptr)
1612 23804 : return CE_None;
1613 :
1614 968 : if (bExists && VSI_ISDIR(sStat.st_mode) &&
1615 43 : (EQUAL(poDriver->GetDescription(), "MapInfo File") ||
1616 43 : EQUAL(poDriver->GetDescription(), "ESRI Shapefile")))
1617 : {
1618 : // Those drivers are a bit special and handle directories as container
1619 : // of layers, but it is quite common to found other files too, and
1620 : // removing the directory might be non-desirable.
1621 42 : return CE_None;
1622 : }
1623 :
1624 883 : CPLDebug("GDAL", "QuietDelete(%s) invoking Delete()", pszName);
1625 :
1626 883 : poDriver->pfnDelete = poDriver->GetDeleteCallback();
1627 921 : const bool bQuiet = !bExists && poDriver->pfnDelete == nullptr &&
1628 38 : poDriver->pfnDeleteDataSource == nullptr;
1629 883 : if (bQuiet)
1630 : {
1631 76 : CPLErrorStateBackuper oErrorStateBackuper(CPLQuietErrorHandler);
1632 38 : return poDriver->Delete(pszName);
1633 : }
1634 : else
1635 : {
1636 845 : return poDriver->Delete(pszName);
1637 : }
1638 : }
1639 :
1640 : /************************************************************************/
1641 : /* Delete() */
1642 : /************************************************************************/
1643 :
1644 : /**
1645 : * \brief Delete named dataset.
1646 : *
1647 : * The driver will attempt to delete the named dataset in a driver specific
1648 : * fashion. Full featured drivers will delete all associated files,
1649 : * database objects, or whatever is appropriate. The default behavior when
1650 : * no driver specific behavior is provided is to attempt to delete all the
1651 : * files that are returned by GDALGetFileList() on the dataset handle.
1652 : *
1653 : * It is unwise to have open dataset handles on this dataset when it is
1654 : * deleted.
1655 : *
1656 : * Equivalent of the C function GDALDeleteDataset().
1657 : *
1658 : * @param pszFilename name of dataset to delete.
1659 : *
1660 : * @return CE_None on success, or CE_Failure if the operation fails.
1661 : */
1662 :
1663 4396 : CPLErr GDALDriver::Delete(const char *pszFilename)
1664 :
1665 : {
1666 4396 : pfnDelete = GetDeleteCallback();
1667 4396 : if (pfnDelete != nullptr)
1668 1076 : return pfnDelete(pszFilename);
1669 3320 : else if (pfnDeleteDataSource != nullptr)
1670 0 : return pfnDeleteDataSource(this, pszFilename);
1671 :
1672 : /* -------------------------------------------------------------------- */
1673 : /* Collect file list. */
1674 : /* -------------------------------------------------------------------- */
1675 3320 : GDALDatasetH hDS = GDALOpenEx(pszFilename, GDAL_OF_VERBOSE_ERROR, nullptr,
1676 : nullptr, nullptr);
1677 :
1678 3320 : if (hDS == nullptr)
1679 : {
1680 237 : if (CPLGetLastErrorNo() == 0)
1681 0 : CPLError(CE_Failure, CPLE_OpenFailed,
1682 : "Unable to open %s to obtain file list.", pszFilename);
1683 :
1684 237 : return CE_Failure;
1685 : }
1686 :
1687 6166 : const CPLStringList aosFileList(GDALGetFileList(hDS));
1688 :
1689 3083 : GDALClose(hDS);
1690 3083 : hDS = nullptr;
1691 :
1692 3083 : if (aosFileList.empty())
1693 : {
1694 0 : CPLError(CE_Failure, CPLE_NotSupported,
1695 : "Unable to determine files associated with %s, "
1696 : "delete fails.",
1697 : pszFilename);
1698 0 : return CE_Failure;
1699 : }
1700 :
1701 3083 : return Delete(nullptr, aosFileList.List());
1702 : }
1703 :
1704 : /************************************************************************/
1705 : /* Delete() */
1706 : /************************************************************************/
1707 :
1708 : /**
1709 : * \brief Delete a currently opened dataset
1710 : *
1711 : * The driver will attempt to delete the passed dataset in a driver specific
1712 : * fashion. Full featured drivers will delete all associated files,
1713 : * database objects, or whatever is appropriate. The default behavior when
1714 : * no driver specific behavior is provided is to attempt to delete all the
1715 : * files that are returned by GDALGetFileList() on the dataset handle.
1716 : *
1717 : * Note that this will generally not work on Windows systems that don't accept
1718 : * deleting opened files.
1719 : *
1720 : * At least one of poDS or papszFileList must not be NULL
1721 : *
1722 : * @param poDS dataset to delete, or NULL
1723 : * @param papszFileList File list to delete, typically obtained with
1724 : * poDS->GetFileList(), or NULL
1725 : *
1726 : * @return CE_None on success, or CE_Failure if the operation fails.
1727 : *
1728 : * @since 3.12
1729 : */
1730 :
1731 3094 : CPLErr GDALDriver::Delete(GDALDataset *poDS, CSLConstList papszFileList)
1732 :
1733 : {
1734 3094 : if (poDS)
1735 : {
1736 10 : pfnDelete = GetDeleteCallback();
1737 10 : if (pfnDelete != nullptr)
1738 6 : return pfnDelete(poDS->GetDescription());
1739 4 : else if (pfnDeleteDataSource != nullptr)
1740 0 : return pfnDeleteDataSource(this, poDS->GetDescription());
1741 : }
1742 :
1743 : /* -------------------------------------------------------------------- */
1744 : /* Delete all files. */
1745 : /* -------------------------------------------------------------------- */
1746 3088 : CPLErr eErr = CE_None;
1747 6831 : for (int i = 0; papszFileList && papszFileList[i]; ++i)
1748 : {
1749 3743 : if (VSIUnlink(papszFileList[i]) != 0)
1750 : {
1751 4 : CPLError(CE_Failure, CPLE_AppDefined, "Deleting %s failed:\n%s",
1752 2 : papszFileList[i], VSIStrerror(errno));
1753 2 : eErr = CE_Failure;
1754 : }
1755 : }
1756 :
1757 3088 : return eErr;
1758 : }
1759 :
1760 : /************************************************************************/
1761 : /* GDALDeleteDataset() */
1762 : /************************************************************************/
1763 :
1764 : /**
1765 : * \brief Delete named dataset.
1766 : *
1767 : * @see GDALDriver::Delete()
1768 : */
1769 :
1770 2391 : CPLErr CPL_STDCALL GDALDeleteDataset(GDALDriverH hDriver,
1771 : const char *pszFilename)
1772 :
1773 : {
1774 2391 : if (hDriver == nullptr)
1775 10 : hDriver = GDALIdentifyDriver(pszFilename, nullptr);
1776 :
1777 2391 : if (hDriver == nullptr)
1778 : {
1779 1 : CPLError(CE_Failure, CPLE_AppDefined, "No identifiable driver for %s.",
1780 : pszFilename);
1781 1 : return CE_Failure;
1782 : }
1783 :
1784 : #ifdef OGRAPISPY_ENABLED
1785 2390 : if (GDALGetMetadataItem(hDriver, GDAL_DCAP_VECTOR, nullptr))
1786 : {
1787 453 : OGRAPISpyDeleteDataSource(hDriver, pszFilename);
1788 : }
1789 : #endif
1790 :
1791 2390 : return GDALDriver::FromHandle(hDriver)->Delete(pszFilename);
1792 : }
1793 :
1794 : /************************************************************************/
1795 : /* DefaultRename() */
1796 : /* */
1797 : /* The generic implementation based on the file list used when */
1798 : /* there is no format specific implementation. */
1799 : /************************************************************************/
1800 :
1801 : //! @cond Doxygen_Suppress
1802 173 : CPLErr GDALDriver::DefaultRename(const char *pszNewName, const char *pszOldName)
1803 :
1804 : {
1805 : /* -------------------------------------------------------------------- */
1806 : /* Collect file list. */
1807 : /* -------------------------------------------------------------------- */
1808 173 : GDALDatasetH hDS = GDALOpen(pszOldName, GA_ReadOnly);
1809 :
1810 173 : if (hDS == nullptr)
1811 : {
1812 0 : if (CPLGetLastErrorNo() == 0)
1813 0 : CPLError(CE_Failure, CPLE_OpenFailed,
1814 : "Unable to open %s to obtain file list.", pszOldName);
1815 :
1816 0 : return CE_Failure;
1817 : }
1818 :
1819 173 : char **papszFileList = GDALGetFileList(hDS);
1820 :
1821 173 : GDALClose(hDS);
1822 :
1823 173 : if (CSLCount(papszFileList) == 0)
1824 : {
1825 0 : CPLError(CE_Failure, CPLE_NotSupported,
1826 : "Unable to determine files associated with %s,\n"
1827 : "rename fails.",
1828 : pszOldName);
1829 :
1830 0 : return CE_Failure;
1831 : }
1832 :
1833 : /* -------------------------------------------------------------------- */
1834 : /* Produce a list of new filenames that correspond to the old */
1835 : /* names. */
1836 : /* -------------------------------------------------------------------- */
1837 173 : CPLErr eErr = CE_None;
1838 : char **papszNewFileList =
1839 173 : CPLCorrespondingPaths(pszOldName, pszNewName, papszFileList);
1840 :
1841 173 : if (papszNewFileList == nullptr)
1842 0 : return CE_Failure;
1843 :
1844 353 : for (int i = 0; papszFileList[i] != nullptr; ++i)
1845 : {
1846 180 : if (CPLMoveFile(papszNewFileList[i], papszFileList[i]) != 0)
1847 : {
1848 0 : eErr = CE_Failure;
1849 : // Try to put the ones we moved back.
1850 0 : for (--i; i >= 0; i--)
1851 : {
1852 : // Nothing we can do if the moving back doesn't work...
1853 0 : CPL_IGNORE_RET_VAL(
1854 0 : CPLMoveFile(papszFileList[i], papszNewFileList[i]));
1855 : }
1856 0 : break;
1857 : }
1858 : }
1859 :
1860 173 : CSLDestroy(papszNewFileList);
1861 173 : CSLDestroy(papszFileList);
1862 :
1863 173 : return eErr;
1864 : }
1865 :
1866 : //! @endcond
1867 :
1868 : /************************************************************************/
1869 : /* Rename() */
1870 : /************************************************************************/
1871 :
1872 : /**
1873 : * \brief Rename a dataset.
1874 : *
1875 : * Rename a dataset. This may including moving the dataset to a new directory
1876 : * or even a new filesystem.
1877 : *
1878 : * It is unwise to have open dataset handles on this dataset when it is
1879 : * being renamed.
1880 : *
1881 : * Equivalent of the C function GDALRenameDataset().
1882 : *
1883 : * @param pszNewName new name for the dataset.
1884 : * @param pszOldName old name for the dataset.
1885 : *
1886 : * @return CE_None on success, or CE_Failure if the operation fails.
1887 : */
1888 :
1889 175 : CPLErr GDALDriver::Rename(const char *pszNewName, const char *pszOldName)
1890 :
1891 : {
1892 175 : pfnRename = GetRenameCallback();
1893 175 : if (pfnRename != nullptr)
1894 3 : return pfnRename(pszNewName, pszOldName);
1895 :
1896 172 : return DefaultRename(pszNewName, pszOldName);
1897 : }
1898 :
1899 : /************************************************************************/
1900 : /* GDALRenameDataset() */
1901 : /************************************************************************/
1902 :
1903 : /**
1904 : * \brief Rename a dataset.
1905 : *
1906 : * @see GDALDriver::Rename()
1907 : */
1908 :
1909 176 : CPLErr CPL_STDCALL GDALRenameDataset(GDALDriverH hDriver,
1910 : const char *pszNewName,
1911 : const char *pszOldName)
1912 :
1913 : {
1914 176 : if (hDriver == nullptr)
1915 3 : hDriver = GDALIdentifyDriver(pszOldName, nullptr);
1916 :
1917 176 : if (hDriver == nullptr)
1918 : {
1919 1 : CPLError(CE_Failure, CPLE_AppDefined, "No identifiable driver for %s.",
1920 : pszOldName);
1921 1 : return CE_Failure;
1922 : }
1923 :
1924 175 : return GDALDriver::FromHandle(hDriver)->Rename(pszNewName, pszOldName);
1925 : }
1926 :
1927 : /************************************************************************/
1928 : /* DefaultCopyFiles() */
1929 : /* */
1930 : /* The default implementation based on file lists used when */
1931 : /* there is no format specific implementation. */
1932 : /************************************************************************/
1933 :
1934 : //! @cond Doxygen_Suppress
1935 10 : CPLErr GDALDriver::DefaultCopyFiles(const char *pszNewName,
1936 : const char *pszOldName)
1937 :
1938 : {
1939 : /* -------------------------------------------------------------------- */
1940 : /* Collect file list. */
1941 : /* -------------------------------------------------------------------- */
1942 10 : GDALDatasetH hDS = GDALOpen(pszOldName, GA_ReadOnly);
1943 :
1944 10 : if (hDS == nullptr)
1945 : {
1946 0 : if (CPLGetLastErrorNo() == 0)
1947 0 : CPLError(CE_Failure, CPLE_OpenFailed,
1948 : "Unable to open %s to obtain file list.", pszOldName);
1949 :
1950 0 : return CE_Failure;
1951 : }
1952 :
1953 10 : char **papszFileList = GDALGetFileList(hDS);
1954 :
1955 10 : GDALClose(hDS);
1956 10 : hDS = nullptr;
1957 :
1958 10 : if (CSLCount(papszFileList) == 0)
1959 : {
1960 0 : CPLError(CE_Failure, CPLE_NotSupported,
1961 : "Unable to determine files associated with %s,\n"
1962 : "rename fails.",
1963 : pszOldName);
1964 :
1965 0 : return CE_Failure;
1966 : }
1967 :
1968 : /* -------------------------------------------------------------------- */
1969 : /* Produce a list of new filenames that correspond to the old */
1970 : /* names. */
1971 : /* -------------------------------------------------------------------- */
1972 10 : CPLErr eErr = CE_None;
1973 : char **papszNewFileList =
1974 10 : CPLCorrespondingPaths(pszOldName, pszNewName, papszFileList);
1975 :
1976 10 : if (papszNewFileList == nullptr)
1977 0 : return CE_Failure;
1978 :
1979 28 : for (int i = 0; papszFileList[i] != nullptr; ++i)
1980 : {
1981 18 : if (CPLCopyFile(papszNewFileList[i], papszFileList[i]) != 0)
1982 : {
1983 0 : eErr = CE_Failure;
1984 : // Try to put the ones we moved back.
1985 0 : for (--i; i >= 0; --i)
1986 0 : VSIUnlink(papszNewFileList[i]);
1987 0 : break;
1988 : }
1989 : }
1990 :
1991 10 : CSLDestroy(papszNewFileList);
1992 10 : CSLDestroy(papszFileList);
1993 :
1994 10 : return eErr;
1995 : }
1996 :
1997 : //! @endcond
1998 :
1999 : /************************************************************************/
2000 : /* CopyFiles() */
2001 : /************************************************************************/
2002 :
2003 : /**
2004 : * \brief Copy the files of a dataset.
2005 : *
2006 : * Copy all the files associated with a dataset.
2007 : *
2008 : * Equivalent of the C function GDALCopyDatasetFiles().
2009 : *
2010 : * @param pszNewName new name for the dataset.
2011 : * @param pszOldName old name for the dataset.
2012 : *
2013 : * @return CE_None on success, or CE_Failure if the operation fails.
2014 : */
2015 :
2016 12 : CPLErr GDALDriver::CopyFiles(const char *pszNewName, const char *pszOldName)
2017 :
2018 : {
2019 12 : pfnCopyFiles = GetCopyFilesCallback();
2020 12 : if (pfnCopyFiles != nullptr)
2021 3 : return pfnCopyFiles(pszNewName, pszOldName);
2022 :
2023 9 : return DefaultCopyFiles(pszNewName, pszOldName);
2024 : }
2025 :
2026 : /************************************************************************/
2027 : /* GDALCopyDatasetFiles() */
2028 : /************************************************************************/
2029 :
2030 : /**
2031 : * \brief Copy the files of a dataset.
2032 : *
2033 : * @see GDALDriver::CopyFiles()
2034 : */
2035 :
2036 13 : CPLErr CPL_STDCALL GDALCopyDatasetFiles(GDALDriverH hDriver,
2037 : const char *pszNewName,
2038 : const char *pszOldName)
2039 :
2040 : {
2041 13 : if (hDriver == nullptr)
2042 8 : hDriver = GDALIdentifyDriver(pszOldName, nullptr);
2043 :
2044 13 : if (hDriver == nullptr)
2045 : {
2046 1 : CPLError(CE_Failure, CPLE_AppDefined, "No identifiable driver for %s.",
2047 : pszOldName);
2048 1 : return CE_Failure;
2049 : }
2050 :
2051 12 : return GDALDriver::FromHandle(hDriver)->CopyFiles(pszNewName, pszOldName);
2052 : }
2053 :
2054 : /************************************************************************/
2055 : /* GDALDriverHasOpenOption() */
2056 : /************************************************************************/
2057 :
2058 : /**
2059 : * \brief Returns TRUE if the given open option is supported by the driver.
2060 : * @param hDriver the handle of the driver
2061 : * @param pszOpenOptionName name of the open option to be checked
2062 : * @return TRUE if the driver supports the open option
2063 : * @since GDAL 3.11
2064 : */
2065 2 : bool GDALDriverHasOpenOption(GDALDriverH hDriver, const char *pszOpenOptionName)
2066 : {
2067 2 : VALIDATE_POINTER1(hDriver, "GDALDriverHasOpenOption", false);
2068 2 : return GDALDriver::FromHandle(hDriver)->HasOpenOption(pszOpenOptionName);
2069 : }
2070 :
2071 : /************************************************************************/
2072 : /* GDALGetDriverShortName() */
2073 : /************************************************************************/
2074 :
2075 : /**
2076 : * \brief Return the short name of a driver
2077 : *
2078 : * This is the string that can be
2079 : * passed to the GDALGetDriverByName() function.
2080 : *
2081 : * For the GeoTIFF driver, this is "GTiff"
2082 : *
2083 : * @param hDriver the handle of the driver
2084 : * @return the short name of the driver. The
2085 : * returned string should not be freed and is owned by the driver.
2086 : */
2087 :
2088 3886860 : const char *CPL_STDCALL GDALGetDriverShortName(GDALDriverH hDriver)
2089 :
2090 : {
2091 3886860 : VALIDATE_POINTER1(hDriver, "GDALGetDriverShortName", nullptr);
2092 :
2093 3886860 : return GDALDriver::FromHandle(hDriver)->GetDescription();
2094 : }
2095 :
2096 : /************************************************************************/
2097 : /* GDALGetDriverLongName() */
2098 : /************************************************************************/
2099 :
2100 : /**
2101 : * \brief Return the long name of a driver
2102 : *
2103 : * For the GeoTIFF driver, this is "GeoTIFF"
2104 : *
2105 : * @param hDriver the handle of the driver
2106 : * @return the long name of the driver or empty string. The
2107 : * returned string should not be freed and is owned by the driver.
2108 : */
2109 :
2110 504 : const char *CPL_STDCALL GDALGetDriverLongName(GDALDriverH hDriver)
2111 :
2112 : {
2113 504 : VALIDATE_POINTER1(hDriver, "GDALGetDriverLongName", nullptr);
2114 :
2115 : const char *pszLongName =
2116 504 : GDALDriver::FromHandle(hDriver)->GetMetadataItem(GDAL_DMD_LONGNAME);
2117 :
2118 504 : if (pszLongName == nullptr)
2119 0 : return "";
2120 :
2121 504 : return pszLongName;
2122 : }
2123 :
2124 : /************************************************************************/
2125 : /* GDALGetDriverHelpTopic() */
2126 : /************************************************************************/
2127 :
2128 : /**
2129 : * \brief Return the URL to the help that describes the driver
2130 : *
2131 : * That URL is relative to the GDAL documentation directory.
2132 : *
2133 : * For the GeoTIFF driver, this is "frmt_gtiff.html"
2134 : *
2135 : * @param hDriver the handle of the driver
2136 : * @return the URL to the help that describes the driver or NULL. The
2137 : * returned string should not be freed and is owned by the driver.
2138 : */
2139 :
2140 0 : const char *CPL_STDCALL GDALGetDriverHelpTopic(GDALDriverH hDriver)
2141 :
2142 : {
2143 0 : VALIDATE_POINTER1(hDriver, "GDALGetDriverHelpTopic", nullptr);
2144 :
2145 0 : return GDALDriver::FromHandle(hDriver)->GetMetadataItem(GDAL_DMD_HELPTOPIC);
2146 : }
2147 :
2148 : /************************************************************************/
2149 : /* GDALGetDriverCreationOptionList() */
2150 : /************************************************************************/
2151 :
2152 : /**
2153 : * \brief Return the list of creation options of the driver
2154 : *
2155 : * Return the list of creation options of the driver used by Create() and
2156 : * CreateCopy() as an XML string
2157 : *
2158 : * @param hDriver the handle of the driver
2159 : * @return an XML string that describes the list of creation options or
2160 : * empty string. The returned string should not be freed and is
2161 : * owned by the driver.
2162 : */
2163 :
2164 0 : const char *CPL_STDCALL GDALGetDriverCreationOptionList(GDALDriverH hDriver)
2165 :
2166 : {
2167 0 : VALIDATE_POINTER1(hDriver, "GDALGetDriverCreationOptionList", nullptr);
2168 :
2169 : const char *pszOptionList =
2170 0 : GDALDriver::FromHandle(hDriver)->GetMetadataItem(
2171 0 : GDAL_DMD_CREATIONOPTIONLIST);
2172 :
2173 0 : if (pszOptionList == nullptr)
2174 0 : return "";
2175 :
2176 0 : return pszOptionList;
2177 : }
2178 :
2179 : /************************************************************************/
2180 : /* GDALValidateCreationOptions() */
2181 : /************************************************************************/
2182 :
2183 : /**
2184 : * \brief Validate the list of creation options that are handled by a driver
2185 : *
2186 : * This is a helper method primarily used by Create() and
2187 : * CreateCopy() to validate that the passed in list of creation options
2188 : * is compatible with the GDAL_DMD_CREATIONOPTIONLIST metadata item defined
2189 : * by some drivers. @see GDALGetDriverCreationOptionList()
2190 : *
2191 : * If the GDAL_DMD_CREATIONOPTIONLIST metadata item is not defined, this
2192 : * function will return TRUE. Otherwise it will check that the keys and values
2193 : * in the list of creation options are compatible with the capabilities declared
2194 : * by the GDAL_DMD_CREATIONOPTIONLIST metadata item. In case of incompatibility
2195 : * a (non fatal) warning will be emitted and FALSE will be returned.
2196 : *
2197 : * @param hDriver the handle of the driver with whom the lists of creation
2198 : * option must be validated
2199 : * @param papszCreationOptions the list of creation options. An array of
2200 : * strings, whose last element is a NULL pointer
2201 : * @return TRUE if the list of creation options is compatible with the Create()
2202 : * and CreateCopy() method of the driver, FALSE otherwise.
2203 : */
2204 :
2205 36163 : int CPL_STDCALL GDALValidateCreationOptions(GDALDriverH hDriver,
2206 : CSLConstList papszCreationOptions)
2207 : {
2208 36163 : VALIDATE_POINTER1(hDriver, "GDALValidateCreationOptions", FALSE);
2209 : const char *pszOptionList =
2210 36163 : GDALDriver::FromHandle(hDriver)->GetMetadataItem(
2211 36163 : GDAL_DMD_CREATIONOPTIONLIST);
2212 36163 : CPLString osDriver;
2213 : osDriver.Printf("driver %s",
2214 36163 : GDALDriver::FromHandle(hDriver)->GetDescription());
2215 36163 : bool bFoundOptionToRemove = false;
2216 36163 : constexpr const char *const apszExcludedOptions[] = {
2217 : "APPEND_SUBDATASET", "COPY_SRC_MDD", "SRC_MDD", "SKIP_HOLES"};
2218 52915 : for (const char *pszCO : cpl::Iterate(papszCreationOptions))
2219 : {
2220 84390 : for (const char *pszExcludedOptions : apszExcludedOptions)
2221 : {
2222 67638 : if (STARTS_WITH_CI(pszCO, pszExcludedOptions) &&
2223 201 : pszCO[strlen(pszExcludedOptions)] == '=')
2224 : {
2225 201 : bFoundOptionToRemove = true;
2226 201 : break;
2227 : }
2228 : }
2229 16953 : if (bFoundOptionToRemove)
2230 201 : break;
2231 : }
2232 36163 : CSLConstList papszOptionsToValidate = papszCreationOptions;
2233 36163 : char **papszOptionsToFree = nullptr;
2234 36163 : if (bFoundOptionToRemove)
2235 : {
2236 616 : for (const char *pszCO : cpl::Iterate(papszCreationOptions))
2237 : {
2238 415 : bool bMatch = false;
2239 1680 : for (const char *pszExcludedOptions : apszExcludedOptions)
2240 : {
2241 1479 : if (STARTS_WITH_CI(pszCO, pszExcludedOptions) &&
2242 214 : pszCO[strlen(pszExcludedOptions)] == '=')
2243 : {
2244 214 : bMatch = true;
2245 214 : break;
2246 : }
2247 : }
2248 415 : if (!bMatch)
2249 201 : papszOptionsToFree = CSLAddString(papszOptionsToFree, pszCO);
2250 : }
2251 201 : papszOptionsToValidate = papszOptionsToFree;
2252 : }
2253 :
2254 36163 : const bool bRet = CPL_TO_BOOL(GDALValidateOptions(
2255 : pszOptionList, papszOptionsToValidate, "creation option", osDriver));
2256 36163 : CSLDestroy(papszOptionsToFree);
2257 36163 : return bRet;
2258 : }
2259 :
2260 : /************************************************************************/
2261 : /* GDALValidateOpenOptions() */
2262 : /************************************************************************/
2263 :
2264 62283 : int GDALValidateOpenOptions(GDALDriverH hDriver,
2265 : const char *const *papszOpenOptions)
2266 : {
2267 62283 : VALIDATE_POINTER1(hDriver, "GDALValidateOpenOptions", FALSE);
2268 : const char *pszOptionList =
2269 62283 : GDALDriver::FromHandle(hDriver)->GetMetadataItem(
2270 62283 : GDAL_DMD_OPENOPTIONLIST);
2271 124566 : CPLString osDriver;
2272 : osDriver.Printf("driver %s",
2273 62283 : GDALDriver::FromHandle(hDriver)->GetDescription());
2274 62283 : return GDALValidateOptions(pszOptionList, papszOpenOptions, "open option",
2275 62283 : osDriver);
2276 : }
2277 :
2278 : /************************************************************************/
2279 : /* GDALValidateOptions() */
2280 : /************************************************************************/
2281 :
2282 112460 : int GDALValidateOptions(const char *pszOptionList,
2283 : const char *const *papszOptionsToValidate,
2284 : const char *pszErrorMessageOptionType,
2285 : const char *pszErrorMessageContainerName)
2286 : {
2287 112460 : if (papszOptionsToValidate == nullptr || *papszOptionsToValidate == nullptr)
2288 95380 : return TRUE;
2289 17080 : if (pszOptionList == nullptr)
2290 181 : return TRUE;
2291 :
2292 16899 : CPLXMLNode *psNode = CPLParseXMLString(pszOptionList);
2293 16899 : if (psNode == nullptr)
2294 : {
2295 0 : CPLError(CE_Warning, CPLE_AppDefined,
2296 : "Could not parse %s list of %s. Assuming options are valid.",
2297 : pszErrorMessageOptionType, pszErrorMessageContainerName);
2298 0 : return TRUE;
2299 : }
2300 :
2301 16899 : bool bRet = true;
2302 46349 : while (*papszOptionsToValidate)
2303 : {
2304 29450 : char *pszKey = nullptr;
2305 : const char *pszValue =
2306 29450 : CPLParseNameValue(*papszOptionsToValidate, &pszKey);
2307 29450 : if (pszKey == nullptr)
2308 : {
2309 1 : CPLError(CE_Warning, CPLE_NotSupported,
2310 : "%s '%s' is not formatted with the key=value format",
2311 : pszErrorMessageOptionType, *papszOptionsToValidate);
2312 1 : bRet = false;
2313 :
2314 1 : ++papszOptionsToValidate;
2315 2204 : continue;
2316 : }
2317 :
2318 29449 : if (EQUAL(pszKey, "VALIDATE_OPEN_OPTIONS"))
2319 : {
2320 0 : ++papszOptionsToValidate;
2321 0 : CPLFree(pszKey);
2322 0 : continue;
2323 : }
2324 :
2325 : // Must we be forgiving in case of missing option ?
2326 29449 : bool bWarnIfMissingKey = true;
2327 29449 : if (pszKey[0] == '@')
2328 : {
2329 2188 : bWarnIfMissingKey = false;
2330 2188 : memmove(pszKey, pszKey + 1, strlen(pszKey + 1) + 1);
2331 : }
2332 :
2333 29449 : CPLXMLNode *psChildNode = psNode->psChild;
2334 289245 : while (psChildNode)
2335 : {
2336 287042 : if (EQUAL(psChildNode->pszValue, "OPTION"))
2337 : {
2338 : const char *pszOptionName =
2339 287042 : CPLGetXMLValue(psChildNode, "name", "");
2340 : /* For option names terminated by wildcard (NITF BLOCKA option
2341 : * names for example) */
2342 287042 : if (strlen(pszOptionName) > 0 &&
2343 287042 : pszOptionName[strlen(pszOptionName) - 1] == '*' &&
2344 378 : EQUALN(pszOptionName, pszKey, strlen(pszOptionName) - 1))
2345 : {
2346 216 : break;
2347 : }
2348 :
2349 : /* For option names beginning by a wildcard */
2350 286826 : if (pszOptionName[0] == '*' &&
2351 57 : strlen(pszKey) > strlen(pszOptionName) &&
2352 9 : EQUAL(pszKey + strlen(pszKey) - strlen(pszOptionName + 1),
2353 : pszOptionName + 1))
2354 : {
2355 2 : break;
2356 : }
2357 :
2358 : // For options names with * in the middle
2359 286824 : const char *pszStarInOptionName = strchr(pszOptionName, '*');
2360 286824 : if (pszStarInOptionName &&
2361 183 : pszStarInOptionName != pszOptionName &&
2362 : pszStarInOptionName !=
2363 183 : pszOptionName + strlen(pszOptionName) - 1 &&
2364 21 : strlen(pszKey) > static_cast<size_t>(pszStarInOptionName -
2365 12 : pszOptionName) &&
2366 12 : EQUALN(pszKey, pszOptionName,
2367 : static_cast<size_t>(pszStarInOptionName -
2368 12 : pszOptionName)) &&
2369 12 : EQUAL(pszKey +
2370 : static_cast<size_t>(pszStarInOptionName -
2371 : pszOptionName) +
2372 : 1,
2373 : pszStarInOptionName + 1))
2374 : {
2375 6 : break;
2376 : }
2377 :
2378 286818 : if (EQUAL(pszOptionName, pszKey))
2379 : {
2380 26915 : break;
2381 : }
2382 : const char *pszAlias =
2383 259903 : CPLGetXMLValue(psChildNode, "alias", nullptr);
2384 : const char *pszDeprecatedAlias =
2385 259903 : pszAlias ? nullptr
2386 259177 : : CPLGetXMLValue(psChildNode, "deprecated_alias",
2387 259903 : nullptr);
2388 259903 : if (!pszAlias && pszDeprecatedAlias)
2389 151 : pszAlias = pszDeprecatedAlias;
2390 259903 : if (pszAlias && EQUAL(pszAlias, pszKey))
2391 : {
2392 107 : if (pszDeprecatedAlias)
2393 : {
2394 0 : CPLDebug(
2395 : "GDAL",
2396 : "Using deprecated alias '%s'. New name is '%s'",
2397 : pszAlias, pszOptionName);
2398 : }
2399 107 : break;
2400 : }
2401 : }
2402 259796 : psChildNode = psChildNode->psNext;
2403 : }
2404 29449 : if (psChildNode == nullptr)
2405 : {
2406 2225 : if (bWarnIfMissingKey &&
2407 22 : (!EQUAL(pszErrorMessageOptionType, "open option") ||
2408 0 : CPLFetchBool(papszOptionsToValidate, "VALIDATE_OPEN_OPTIONS",
2409 : true)))
2410 : {
2411 22 : CPLError(CE_Warning, CPLE_NotSupported,
2412 : "%s does not support %s %s",
2413 : pszErrorMessageContainerName,
2414 : pszErrorMessageOptionType, pszKey);
2415 22 : bRet = false;
2416 : }
2417 :
2418 2203 : CPLFree(pszKey);
2419 2203 : ++papszOptionsToValidate;
2420 2203 : continue;
2421 : }
2422 :
2423 : #ifdef DEBUG
2424 27246 : CPLXMLNode *psChildSubNode = psChildNode->psChild;
2425 161699 : while (psChildSubNode)
2426 : {
2427 134453 : if (psChildSubNode->eType == CXT_Attribute)
2428 : {
2429 94375 : if (!(EQUAL(psChildSubNode->pszValue, "name") ||
2430 67129 : EQUAL(psChildSubNode->pszValue, "alias") ||
2431 66943 : EQUAL(psChildSubNode->pszValue, "deprecated_alias") ||
2432 66857 : EQUAL(psChildSubNode->pszValue, "alt_config_option") ||
2433 66837 : EQUAL(psChildSubNode->pszValue, "description") ||
2434 43871 : EQUAL(psChildSubNode->pszValue, "type") ||
2435 16625 : EQUAL(psChildSubNode->pszValue, "min") ||
2436 16334 : EQUAL(psChildSubNode->pszValue, "max") ||
2437 15975 : EQUAL(psChildSubNode->pszValue, "default") ||
2438 1020 : EQUAL(psChildSubNode->pszValue, "maxsize") ||
2439 995 : EQUAL(psChildSubNode->pszValue, "required") ||
2440 940 : EQUAL(psChildSubNode->pszValue, "scope")))
2441 : {
2442 : /* Driver error */
2443 0 : CPLError(CE_Warning, CPLE_NotSupported,
2444 : "%s : unhandled attribute '%s' for %s %s.",
2445 : pszErrorMessageContainerName,
2446 : psChildSubNode->pszValue, pszKey,
2447 : pszErrorMessageOptionType);
2448 : }
2449 : }
2450 134453 : psChildSubNode = psChildSubNode->psNext;
2451 : }
2452 : #endif
2453 :
2454 27246 : const char *pszType = CPLGetXMLValue(psChildNode, "type", nullptr);
2455 27246 : const char *pszMin = CPLGetXMLValue(psChildNode, "min", nullptr);
2456 27246 : const char *pszMax = CPLGetXMLValue(psChildNode, "max", nullptr);
2457 27246 : if (pszType != nullptr)
2458 : {
2459 27246 : if (EQUAL(pszType, "INT") || EQUAL(pszType, "INTEGER"))
2460 : {
2461 8713 : const char *pszValueIter = pszValue;
2462 22400 : while (*pszValueIter)
2463 : {
2464 13689 : if (!((*pszValueIter >= '0' && *pszValueIter <= '9') ||
2465 20 : *pszValueIter == '+' || *pszValueIter == '-'))
2466 : {
2467 2 : CPLError(CE_Warning, CPLE_NotSupported,
2468 : "'%s' is an unexpected value for %s %s of "
2469 : "type int.",
2470 : pszValue, pszKey, pszErrorMessageOptionType);
2471 2 : bRet = false;
2472 2 : break;
2473 : }
2474 13687 : ++pszValueIter;
2475 : }
2476 8713 : if (*pszValueIter == '\0')
2477 : {
2478 8711 : if (pszMin && atoi(pszValue) < atoi(pszMin))
2479 : {
2480 10 : CPLError(CE_Warning, CPLE_NotSupported,
2481 : "'%s' is an unexpected value for %s %s that "
2482 : "should be >= %s.",
2483 : pszValue, pszKey, pszErrorMessageOptionType,
2484 : pszMin);
2485 10 : bRet = false;
2486 : }
2487 8711 : if (pszMax && atoi(pszValue) > atoi(pszMax))
2488 : {
2489 12 : CPLError(CE_Warning, CPLE_NotSupported,
2490 : "'%s' is an unexpected value for %s %s that "
2491 : "should be <= %s.",
2492 : pszValue, pszKey, pszErrorMessageOptionType,
2493 : pszMax);
2494 12 : bRet = false;
2495 : }
2496 8713 : }
2497 : }
2498 18533 : else if (EQUAL(pszType, "UNSIGNED INT"))
2499 : {
2500 3 : const char *pszValueIter = pszValue;
2501 10 : while (*pszValueIter)
2502 : {
2503 7 : if (!((*pszValueIter >= '0' && *pszValueIter <= '9') ||
2504 0 : *pszValueIter == '+'))
2505 : {
2506 0 : CPLError(CE_Warning, CPLE_NotSupported,
2507 : "'%s' is an unexpected value for %s %s of "
2508 : "type unsigned int.",
2509 : pszValue, pszKey, pszErrorMessageOptionType);
2510 0 : bRet = false;
2511 0 : break;
2512 : }
2513 7 : ++pszValueIter;
2514 : }
2515 3 : if (*pszValueIter == '\0')
2516 : {
2517 3 : if (pszMin && atoi(pszValue) < atoi(pszMin))
2518 : {
2519 0 : CPLError(CE_Warning, CPLE_NotSupported,
2520 : "'%s' is an unexpected value for %s %s that "
2521 : "should be >= %s.",
2522 : pszValue, pszKey, pszErrorMessageOptionType,
2523 : pszMin);
2524 0 : bRet = false;
2525 : }
2526 3 : if (pszMax && atoi(pszValue) > atoi(pszMax))
2527 : {
2528 0 : CPLError(CE_Warning, CPLE_NotSupported,
2529 : "'%s' is an unexpected value for %s %s that "
2530 : "should be <= %s.",
2531 : pszValue, pszKey, pszErrorMessageOptionType,
2532 : pszMax);
2533 0 : bRet = false;
2534 : }
2535 : }
2536 : }
2537 18530 : else if (EQUAL(pszType, "FLOAT"))
2538 : {
2539 766 : char *endPtr = nullptr;
2540 766 : double dfVal = CPLStrtod(pszValue, &endPtr);
2541 766 : if (!(endPtr == nullptr || *endPtr == '\0'))
2542 : {
2543 2 : CPLError(
2544 : CE_Warning, CPLE_NotSupported,
2545 : "'%s' is an unexpected value for %s %s of type float.",
2546 : pszValue, pszKey, pszErrorMessageOptionType);
2547 2 : bRet = false;
2548 : }
2549 : else
2550 : {
2551 764 : if (pszMin && dfVal < CPLAtof(pszMin))
2552 : {
2553 2 : CPLError(CE_Warning, CPLE_NotSupported,
2554 : "'%s' is an unexpected value for %s %s that "
2555 : "should be >= %s.",
2556 : pszValue, pszKey, pszErrorMessageOptionType,
2557 : pszMin);
2558 2 : bRet = false;
2559 : }
2560 764 : if (pszMax && dfVal > CPLAtof(pszMax))
2561 : {
2562 0 : CPLError(CE_Warning, CPLE_NotSupported,
2563 : "'%s' is an unexpected value for %s %s that "
2564 : "should be <= %s.",
2565 : pszValue, pszKey, pszErrorMessageOptionType,
2566 : pszMax);
2567 0 : bRet = false;
2568 : }
2569 : }
2570 : }
2571 17764 : else if (EQUAL(pszType, "BOOLEAN"))
2572 : {
2573 3965 : if (!(EQUAL(pszValue, "ON") || EQUAL(pszValue, "TRUE") ||
2574 3901 : EQUAL(pszValue, "YES") || EQUAL(pszValue, "OFF") ||
2575 431 : EQUAL(pszValue, "FALSE") || EQUAL(pszValue, "NO")))
2576 : {
2577 0 : CPLError(CE_Warning, CPLE_NotSupported,
2578 : "'%s' is an unexpected value for %s %s of type "
2579 : "boolean.",
2580 : pszValue, pszKey, pszErrorMessageOptionType);
2581 0 : bRet = false;
2582 : }
2583 : }
2584 13799 : else if (EQUAL(pszType, "STRING-SELECT"))
2585 : {
2586 7083 : bool bMatchFound = false;
2587 7083 : CPLXMLNode *psStringSelect = psChildNode->psChild;
2588 43673 : while (psStringSelect)
2589 : {
2590 43631 : if (psStringSelect->eType == CXT_Element &&
2591 21145 : EQUAL(psStringSelect->pszValue, "Value"))
2592 : {
2593 21145 : CPLXMLNode *psOptionNode = psStringSelect->psChild;
2594 35876 : while (psOptionNode)
2595 : {
2596 21772 : if (psOptionNode->eType == CXT_Text &&
2597 21026 : EQUAL(psOptionNode->pszValue, pszValue))
2598 : {
2599 6922 : bMatchFound = true;
2600 6922 : break;
2601 : }
2602 14850 : if (psOptionNode->eType == CXT_Attribute &&
2603 746 : (EQUAL(psOptionNode->pszValue, "alias") ||
2604 15 : EQUAL(psOptionNode->pszValue,
2605 731 : "deprecated_alias")) &&
2606 731 : EQUAL(psOptionNode->psChild->pszValue,
2607 : pszValue))
2608 : {
2609 119 : bMatchFound = true;
2610 119 : break;
2611 : }
2612 14731 : psOptionNode = psOptionNode->psNext;
2613 : }
2614 21145 : if (bMatchFound)
2615 7041 : break;
2616 : }
2617 36590 : psStringSelect = psStringSelect->psNext;
2618 : }
2619 7083 : if (!bMatchFound)
2620 : {
2621 42 : CPLError(CE_Warning, CPLE_NotSupported,
2622 : "'%s' is an unexpected value for %s %s of type "
2623 : "string-select.",
2624 : pszValue, pszKey, pszErrorMessageOptionType);
2625 42 : bRet = false;
2626 : }
2627 : }
2628 6716 : else if (EQUAL(pszType, "STRING"))
2629 : {
2630 : const char *pszMaxSize =
2631 6716 : CPLGetXMLValue(psChildNode, "maxsize", nullptr);
2632 6716 : if (pszMaxSize != nullptr)
2633 : {
2634 25 : if (static_cast<int>(strlen(pszValue)) > atoi(pszMaxSize))
2635 : {
2636 1 : CPLError(CE_Warning, CPLE_NotSupported,
2637 : "'%s' is of size %d, whereas maximum size for "
2638 : "%s %s is %d.",
2639 1 : pszValue, static_cast<int>(strlen(pszValue)),
2640 : pszKey, pszErrorMessageOptionType,
2641 : atoi(pszMaxSize));
2642 1 : bRet = false;
2643 : }
2644 : }
2645 : }
2646 : else
2647 : {
2648 : /* Driver error */
2649 0 : CPLError(CE_Warning, CPLE_NotSupported,
2650 : "%s : type '%s' for %s %s is not recognized.",
2651 : pszErrorMessageContainerName, pszType, pszKey,
2652 : pszErrorMessageOptionType);
2653 : }
2654 : }
2655 : else
2656 : {
2657 : /* Driver error */
2658 0 : CPLError(CE_Warning, CPLE_NotSupported, "%s : no type for %s %s.",
2659 : pszErrorMessageContainerName, pszKey,
2660 : pszErrorMessageOptionType);
2661 : }
2662 27246 : CPLFree(pszKey);
2663 27246 : ++papszOptionsToValidate;
2664 : }
2665 :
2666 16899 : CPLDestroyXMLNode(psNode);
2667 16899 : return bRet ? TRUE : FALSE;
2668 : }
2669 :
2670 : /************************************************************************/
2671 : /* GDALIdentifyDriver() */
2672 : /************************************************************************/
2673 :
2674 : /**
2675 : * \brief Identify the driver that can open a dataset.
2676 : *
2677 : * This function will try to identify the driver that can open the passed file
2678 : * name by invoking the Identify method of each registered GDALDriver in turn.
2679 : * The first driver that successfully identifies the file name will be returned.
2680 : * If all drivers fail then NULL is returned.
2681 : *
2682 : * In order to reduce the need for such searches to touch the operating system
2683 : * file system machinery, it is possible to give an optional list of files.
2684 : * This is the list of all files at the same level in the file system as the
2685 : * target file, including the target file. The filenames will not include any
2686 : * path components, and are essentially just the output of VSIReadDir() on the
2687 : * parent directory. If the target object does not have filesystem semantics
2688 : * then the file list should be NULL.
2689 : *
2690 : * @param pszFilename the name of the file to access. In the case of
2691 : * exotic drivers this may not refer to a physical file, but instead contain
2692 : * information for the driver on how to access a dataset.
2693 : *
2694 : * @param papszFileList an array of strings, whose last element is the NULL
2695 : * pointer. These strings are filenames that are auxiliary to the main
2696 : * filename. The passed value may be NULL.
2697 : *
2698 : * @return A GDALDriverH handle or NULL on failure. For C++ applications
2699 : * this handle can be cast to a GDALDriver *.
2700 : */
2701 :
2702 26173 : GDALDriverH CPL_STDCALL GDALIdentifyDriver(const char *pszFilename,
2703 : CSLConstList papszFileList)
2704 :
2705 : {
2706 26173 : return GDALIdentifyDriverEx(pszFilename, 0, nullptr, papszFileList);
2707 : }
2708 :
2709 : /************************************************************************/
2710 : /* GDALIdentifyDriverEx() */
2711 : /************************************************************************/
2712 :
2713 : /**
2714 : * \brief Identify the driver that can open a dataset.
2715 : *
2716 : * This function will try to identify the driver that can open the passed file
2717 : * name by invoking the Identify method of each registered GDALDriver in turn.
2718 : * The first driver that successfully identifies the file name will be returned.
2719 : * If all drivers fail then NULL is returned.
2720 : *
2721 : * In order to reduce the need for such searches to touch the operating system
2722 : * file system machinery, it is possible to give an optional list of files.
2723 : * This is the list of all files at the same level in the file system as the
2724 : * target file, including the target file. The filenames will not include any
2725 : * path components, and are essentially just the output of VSIReadDir() on the
2726 : * parent directory. If the target object does not have filesystem semantics
2727 : * then the file list should be NULL.
2728 : *
2729 : * @param pszFilename the name of the file to access. In the case of
2730 : * exotic drivers this may not refer to a physical file, but instead contain
2731 : * information for the driver on how to access a dataset.
2732 : *
2733 : * @param nIdentifyFlags a combination of GDAL_OF_RASTER for raster drivers
2734 : * or GDAL_OF_VECTOR for vector drivers. If none of the value is specified,
2735 : * both kinds are implied.
2736 : *
2737 : * @param papszAllowedDrivers NULL to consider all candidate drivers, or a NULL
2738 : * terminated list of strings with the driver short names that must be
2739 : * considered.
2740 : *
2741 : * @param papszFileList an array of strings, whose last element is the NULL
2742 : * pointer. These strings are filenames that are auxiliary to the main
2743 : * filename. The passed value may be NULL.
2744 : *
2745 : * @return A GDALDriverH handle or NULL on failure. For C++ applications
2746 : * this handle can be cast to a GDALDriver *.
2747 : */
2748 :
2749 26263 : GDALDriverH CPL_STDCALL GDALIdentifyDriverEx(
2750 : const char *pszFilename, unsigned int nIdentifyFlags,
2751 : const char *const *papszAllowedDrivers, const char *const *papszFileList)
2752 : {
2753 26263 : GDALDriverManager *poDM = GetGDALDriverManager();
2754 26263 : CPLAssert(nullptr != poDM);
2755 :
2756 : // If no driver kind is specified, assume all are to be probed.
2757 26263 : if ((nIdentifyFlags & GDAL_OF_KIND_MASK) == 0)
2758 26220 : nIdentifyFlags |= GDAL_OF_KIND_MASK & ~GDAL_OF_MULTIDIM_RASTER;
2759 :
2760 52526 : GDALOpenInfo oOpenInfo(pszFilename, nIdentifyFlags, papszFileList);
2761 26263 : oOpenInfo.papszAllowedDrivers = papszAllowedDrivers;
2762 :
2763 52526 : CPLErrorStateBackuper oBackuper;
2764 26263 : CPLErrorSetState(CE_None, CPLE_AppDefined, "");
2765 :
2766 26263 : const int nDriverCount = poDM->GetDriverCount();
2767 :
2768 : // First pass: only use drivers that have a pfnIdentify implementation.
2769 52526 : std::vector<GDALDriver *> apoSecondPassDrivers;
2770 5733680 : for (int iDriver = 0; iDriver < nDriverCount; ++iDriver)
2771 : {
2772 5708700 : GDALDriver *poDriver = poDM->GetDriver(iDriver);
2773 5716030 : if (papszAllowedDrivers != nullptr &&
2774 7328 : CSLFindString(papszAllowedDrivers,
2775 : GDALGetDriverShortName(poDriver)) == -1)
2776 : {
2777 1073220 : continue;
2778 : }
2779 :
2780 5702710 : VALIDATE_POINTER1(poDriver, "GDALIdentifyDriver", nullptr);
2781 :
2782 5701420 : if (poDriver->pfnIdentify == nullptr &&
2783 1062100 : poDriver->pfnIdentifyEx == nullptr)
2784 : {
2785 1062100 : continue;
2786 : }
2787 :
2788 4639360 : if (papszAllowedDrivers != nullptr &&
2789 44 : CSLFindString(papszAllowedDrivers,
2790 : GDALGetDriverShortName(poDriver)) == -1)
2791 0 : continue;
2792 13913200 : if ((nIdentifyFlags & GDAL_OF_RASTER) != 0 &&
2793 4639820 : (nIdentifyFlags & GDAL_OF_VECTOR) == 0 &&
2794 508 : poDriver->GetMetadataItem(GDAL_DCAP_RASTER) == nullptr)
2795 141 : continue;
2796 13920900 : if ((nIdentifyFlags & GDAL_OF_VECTOR) != 0 &&
2797 4644090 : (nIdentifyFlags & GDAL_OF_RASTER) == 0 &&
2798 4912 : poDriver->GetMetadataItem(GDAL_DCAP_VECTOR) == nullptr)
2799 3693 : continue;
2800 :
2801 4635480 : if (poDriver->pfnIdentifyEx)
2802 : {
2803 0 : if (poDriver->pfnIdentifyEx(poDriver, &oOpenInfo) > 0)
2804 0 : return poDriver;
2805 : }
2806 : else
2807 : {
2808 4635480 : const int nIdentifyRes = poDriver->pfnIdentify(&oOpenInfo);
2809 4635480 : if (nIdentifyRes > 0)
2810 1286 : return poDriver;
2811 4660180 : if (nIdentifyRes < 0 &&
2812 25988 : poDriver->GetMetadataItem("IS_NON_LOADED_PLUGIN"))
2813 : {
2814 : // Not loaded plugin
2815 36 : apoSecondPassDrivers.push_back(poDriver);
2816 : }
2817 : }
2818 : }
2819 :
2820 : // second pass: try loading plugin drivers
2821 25010 : for (auto poDriver : apoSecondPassDrivers)
2822 : {
2823 : // Force plugin driver loading
2824 34 : poDriver->GetMetadata();
2825 34 : if (poDriver->pfnIdentify(&oOpenInfo) > 0)
2826 1 : return poDriver;
2827 : }
2828 :
2829 : // third pass: slow method.
2830 5628760 : for (int iDriver = 0; iDriver < nDriverCount; ++iDriver)
2831 : {
2832 5603900 : GDALDriver *poDriver = poDM->GetDriver(iDriver);
2833 5607730 : if (papszAllowedDrivers != nullptr &&
2834 3824 : CSLFindString(papszAllowedDrivers,
2835 : GDALGetDriverShortName(poDriver)) == -1)
2836 : {
2837 3807 : continue;
2838 : }
2839 :
2840 5600100 : VALIDATE_POINTER1(poDriver, "GDALIdentifyDriver", nullptr);
2841 :
2842 16798900 : if ((nIdentifyFlags & GDAL_OF_RASTER) != 0 &&
2843 5600540 : (nIdentifyFlags & GDAL_OF_VECTOR) == 0 &&
2844 448 : poDriver->GetMetadataItem(GDAL_DCAP_RASTER) == nullptr)
2845 137 : continue;
2846 16800500 : if ((nIdentifyFlags & GDAL_OF_VECTOR) != 0 &&
2847 5601530 : (nIdentifyFlags & GDAL_OF_RASTER) == 0 &&
2848 1570 : poDriver->GetMetadataItem(GDAL_DCAP_VECTOR) == nullptr)
2849 953 : continue;
2850 :
2851 5599010 : if (poDriver->pfnIdentifyEx != nullptr)
2852 : {
2853 0 : if (poDriver->pfnIdentifyEx(poDriver, &oOpenInfo) == 0)
2854 0 : continue;
2855 : }
2856 5599010 : else if (poDriver->pfnIdentify != nullptr)
2857 : {
2858 4555430 : if (poDriver->pfnIdentify(&oOpenInfo) == 0)
2859 4529940 : continue;
2860 : }
2861 :
2862 : GDALDataset *poDS;
2863 1069070 : if (poDriver->pfnOpen != nullptr)
2864 : {
2865 1019260 : poDS = poDriver->pfnOpen(&oOpenInfo);
2866 1019260 : if (poDS != nullptr)
2867 : {
2868 91 : delete poDS;
2869 91 : return GDALDriver::ToHandle(poDriver);
2870 : }
2871 :
2872 1019170 : if (CPLGetLastErrorType() != CE_None)
2873 24 : return nullptr;
2874 : }
2875 49807 : else if (poDriver->pfnOpenWithDriverArg != nullptr)
2876 : {
2877 0 : poDS = poDriver->pfnOpenWithDriverArg(poDriver, &oOpenInfo);
2878 0 : if (poDS != nullptr)
2879 : {
2880 0 : delete poDS;
2881 0 : return GDALDriver::ToHandle(poDriver);
2882 : }
2883 :
2884 0 : if (CPLGetLastErrorType() != CE_None)
2885 0 : return nullptr;
2886 : }
2887 : }
2888 :
2889 24861 : return nullptr;
2890 : }
2891 :
2892 : /************************************************************************/
2893 : /* GetMetadataItem() */
2894 : /************************************************************************/
2895 :
2896 12684500 : const char *GDALDriver::GetMetadataItem(const char *pszName,
2897 : const char *pszDomain)
2898 : {
2899 12684500 : if (pszDomain == nullptr || pszDomain[0] == '\0')
2900 : {
2901 12684300 : if (EQUAL(pszName, GDAL_DMD_OVERVIEW_CREATIONOPTIONLIST))
2902 : {
2903 2190 : const char *pszVal = GDALMajorObject::GetMetadataItem(pszName, "");
2904 2190 : if (pszVal)
2905 1968 : return pszVal;
2906 222 : if (GetMetadataItem(GDAL_DCAP_RASTER))
2907 : {
2908 153 : auto poDM = GetGDALDriverManager();
2909 153 : auto poGTiffDrv = poDM->GetDriverByName("GTiff");
2910 153 : if (poGTiffDrv)
2911 : {
2912 : const char *pszXML =
2913 153 : poGTiffDrv->GetMetadataItem(pszName, "");
2914 153 : if (pszXML)
2915 : {
2916 306 : CPLString osXML(pszXML);
2917 153 : osXML.replaceAll("<Value>INTERNAL</Value>", "");
2918 153 : return CPLSPrintf("%s", osXML.c_str());
2919 : }
2920 : }
2921 : }
2922 : }
2923 : }
2924 12682400 : return GDALMajorObject::GetMetadataItem(pszName, pszDomain);
2925 : }
2926 :
2927 : /************************************************************************/
2928 : /* SetMetadataItem() */
2929 : /************************************************************************/
2930 :
2931 4459620 : CPLErr GDALDriver::SetMetadataItem(const char *pszName, const char *pszValue,
2932 : const char *pszDomain)
2933 :
2934 : {
2935 4459620 : if (pszDomain == nullptr || pszDomain[0] == '\0')
2936 : {
2937 : /* Automatically sets GDAL_DMD_EXTENSIONS from GDAL_DMD_EXTENSION */
2938 4649980 : if (EQUAL(pszName, GDAL_DMD_EXTENSION) &&
2939 195704 : GDALMajorObject::GetMetadataItem(GDAL_DMD_EXTENSIONS) == nullptr)
2940 : {
2941 195704 : GDALMajorObject::SetMetadataItem(GDAL_DMD_EXTENSIONS, pszValue);
2942 : }
2943 : /* and vice-versa if there is a single extension in GDAL_DMD_EXTENSIONS */
2944 8597120 : else if (EQUAL(pszName, GDAL_DMD_EXTENSIONS) &&
2945 4267460 : strchr(pszValue, ' ') == nullptr &&
2946 8887 : GDALMajorObject::GetMetadataItem(GDAL_DMD_EXTENSION) ==
2947 : nullptr)
2948 : {
2949 8887 : GDALMajorObject::SetMetadataItem(GDAL_DMD_EXTENSION, pszValue);
2950 : }
2951 : }
2952 4459620 : return GDALMajorObject::SetMetadataItem(pszName, pszValue, pszDomain);
2953 : }
2954 :
2955 : /************************************************************************/
2956 : /* InstantiateAlgorithm() */
2957 : /************************************************************************/
2958 :
2959 : //! @cond Doxygen_Suppress
2960 :
2961 : GDALAlgorithm *
2962 174 : GDALDriver::InstantiateAlgorithm(const std::vector<std::string> &aosPath)
2963 : {
2964 174 : pfnInstantiateAlgorithm = GetInstantiateAlgorithmCallback();
2965 174 : if (pfnInstantiateAlgorithm)
2966 174 : return pfnInstantiateAlgorithm(aosPath);
2967 0 : return nullptr;
2968 : }
2969 :
2970 : /************************************************************************/
2971 : /* DeclareAlgorithm() */
2972 : /************************************************************************/
2973 :
2974 8930 : void GDALDriver::DeclareAlgorithm(const std::vector<std::string> &aosPath)
2975 : {
2976 17860 : const std::string osDriverName = GetDescription();
2977 8930 : auto &singleton = GDALGlobalAlgorithmRegistry::GetSingleton();
2978 :
2979 17860 : if (!singleton.HasDeclaredSubAlgorithm({"driver"}))
2980 : {
2981 3150 : singleton.DeclareAlgorithm(
2982 : {"driver"},
2983 67 : []() -> std::unique_ptr<GDALAlgorithm>
2984 : {
2985 134 : return std::make_unique<GDALContainerAlgorithm>(
2986 67 : "driver", "Command for driver specific operations.");
2987 1575 : });
2988 : }
2989 :
2990 : std::vector<std::string> path = {"driver",
2991 53580 : CPLString(osDriverName).tolower()};
2992 8930 : if (!singleton.HasDeclaredSubAlgorithm(path))
2993 : {
2994 316 : auto lambda = [osDriverName]() -> std::unique_ptr<GDALAlgorithm>
2995 : {
2996 : auto poDriver =
2997 316 : GetGDALDriverManager()->GetDriverByName(osDriverName.c_str());
2998 316 : if (poDriver)
2999 : {
3000 : const char *pszHelpTopic =
3001 316 : poDriver->GetMetadataItem(GDAL_DMD_HELPTOPIC);
3002 632 : return std::make_unique<GDALContainerAlgorithm>(
3003 632 : CPLString(osDriverName).tolower(),
3004 632 : std::string("Command for ")
3005 316 : .append(osDriverName)
3006 : .append(" driver specific operations."),
3007 632 : pszHelpTopic ? std::string("/").append(pszHelpTopic)
3008 316 : : std::string());
3009 : }
3010 0 : return nullptr;
3011 7875 : };
3012 7875 : singleton.DeclareAlgorithm(path, std::move(lambda));
3013 : }
3014 :
3015 8930 : path.insert(path.end(), aosPath.begin(), aosPath.end());
3016 :
3017 174 : auto lambda = [osDriverName, aosPath]() -> std::unique_ptr<GDALAlgorithm>
3018 : {
3019 : auto poDriver =
3020 174 : GetGDALDriverManager()->GetDriverByName(osDriverName.c_str());
3021 174 : if (poDriver)
3022 : return std::unique_ptr<GDALAlgorithm>(
3023 174 : poDriver->InstantiateAlgorithm(aosPath));
3024 0 : return nullptr;
3025 17860 : };
3026 :
3027 8930 : singleton.DeclareAlgorithm(path, std::move(lambda));
3028 :
3029 8930 : CPL_IGNORE_RET_VAL(osDriverName);
3030 8930 : }
3031 :
3032 : //! @endcond
3033 :
3034 : /************************************************************************/
3035 : /* DoesDriverHandleExtension() */
3036 : /************************************************************************/
3037 :
3038 185703 : static bool DoesDriverHandleExtension(GDALDriverH hDriver, const char *pszExt)
3039 : {
3040 185703 : bool bRet = false;
3041 : const char *pszDriverExtensions =
3042 185703 : GDALGetMetadataItem(hDriver, GDAL_DMD_EXTENSIONS, nullptr);
3043 185703 : if (pszDriverExtensions)
3044 : {
3045 310466 : const CPLStringList aosTokens(CSLTokenizeString(pszDriverExtensions));
3046 155233 : const int nTokens = aosTokens.size();
3047 346401 : for (int j = 0; j < nTokens; ++j)
3048 : {
3049 195685 : if (EQUAL(pszExt, aosTokens[j]))
3050 : {
3051 4517 : bRet = true;
3052 4517 : break;
3053 : }
3054 : }
3055 : }
3056 185703 : return bRet;
3057 : }
3058 :
3059 : /************************************************************************/
3060 : /* IsOnlyExpectedGDBDrivers() */
3061 : /************************************************************************/
3062 :
3063 1 : static bool IsOnlyExpectedGDBDrivers(const CPLStringList &aosDriverNames)
3064 : {
3065 3 : for (const char *pszDrvName : aosDriverNames)
3066 : {
3067 2 : if (!EQUAL(pszDrvName, "OpenFileGDB") &&
3068 1 : !EQUAL(pszDrvName, "FileGDB") && !EQUAL(pszDrvName, "GPSBabel"))
3069 : {
3070 0 : return false;
3071 : }
3072 : }
3073 1 : return true;
3074 : }
3075 :
3076 : /************************************************************************/
3077 : /* GDALGetOutputDriversForDatasetName() */
3078 : /************************************************************************/
3079 :
3080 : /** Return a list of driver short names that are likely candidates for the
3081 : * provided output file name.
3082 : *
3083 : * @param pszDestDataset Output dataset name (might not exist).
3084 : * @param nDatasetTypeFlag GDAL_OF_RASTER, GDAL_OF_VECTOR, GDAL_OF_MULTIDIM_RASTER
3085 : * or a binary-or'ed combination of them
3086 : * @param bSingleMatch Whether a single match is desired, that is to say the
3087 : * returned list will contain at most one item, which will
3088 : * be the first driver in the order they are registered to
3089 : * match the output dataset name. Note that in this mode, if
3090 : * nDatasetTypeFlag==GDAL_OF_RASTER and pszDestDataset has
3091 : * no extension, GTiff will be selected.
3092 : * @param bEmitWarning Whether a warning should be emitted when bSingleMatch is
3093 : * true and there are more than 2 candidates.
3094 : * @return NULL terminated list of driver short names.
3095 : * To be freed with CSLDestroy()
3096 : * @since 3.9
3097 : */
3098 2640 : char **GDALGetOutputDriversForDatasetName(const char *pszDestDataset,
3099 : int nDatasetTypeFlag,
3100 : bool bSingleMatch, bool bEmitWarning)
3101 : {
3102 5280 : CPLStringList aosDriverNames;
3103 5280 : CPLStringList aosMissingDriverNames;
3104 :
3105 5280 : std::string osExt = CPLGetExtensionSafe(pszDestDataset);
3106 2640 : if (EQUAL(osExt.c_str(), "zip"))
3107 : {
3108 2 : const CPLString osLower(CPLString(pszDestDataset).tolower());
3109 1 : if (osLower.endsWith(".shp.zip"))
3110 : {
3111 1 : osExt = "shp.zip";
3112 : }
3113 0 : else if (osLower.endsWith(".gpkg.zip"))
3114 : {
3115 0 : osExt = "gpkg.zip";
3116 : }
3117 : }
3118 2639 : else if (EQUAL(osExt.c_str(), "json"))
3119 : {
3120 1 : const CPLString osLower(CPLString(pszDestDataset).tolower());
3121 1 : if (osLower.endsWith(".gdalg.json"))
3122 0 : return nullptr;
3123 : }
3124 :
3125 2640 : auto poDM = GetGDALDriverManager();
3126 2640 : const int nDriverCount = poDM->GetDriverCount(true);
3127 2640 : GDALDriver *poMissingPluginDriver = nullptr;
3128 5280 : std::string osMatchingPrefix;
3129 596245 : for (int i = 0; i < nDriverCount; i++)
3130 : {
3131 593605 : GDALDriver *poDriver = poDM->GetDriver(i, true);
3132 593605 : bool bOk = false;
3133 593605 : if ((poDriver->GetMetadataItem(GDAL_DCAP_CREATE) != nullptr ||
3134 361288 : poDriver->GetMetadataItem(GDAL_DCAP_CREATECOPY) != nullptr ||
3135 1187210 : poDriver->GetMetadataItem(GDAL_DCAP_UPDATE) != nullptr) &&
3136 308877 : (((nDatasetTypeFlag & GDAL_OF_RASTER) &&
3137 248975 : poDriver->GetMetadataItem(GDAL_DCAP_RASTER) != nullptr) ||
3138 149278 : ((nDatasetTypeFlag & GDAL_OF_VECTOR) &&
3139 59317 : poDriver->GetMetadataItem(GDAL_DCAP_VECTOR) != nullptr) ||
3140 120888 : ((nDatasetTypeFlag & GDAL_OF_MULTIDIM_RASTER) &&
3141 585 : poDriver->GetMetadataItem(GDAL_DCAP_MULTIDIM_RASTER) != nullptr)))
3142 : {
3143 188039 : bOk = true;
3144 : }
3145 409832 : else if (poDriver->GetMetadataItem(GDAL_DCAP_VECTOR_TRANSLATE_FROM) &&
3146 4266 : (nDatasetTypeFlag & GDAL_OF_VECTOR) != 0)
3147 : {
3148 0 : bOk = true;
3149 : }
3150 593605 : if (bOk)
3151 : {
3152 373742 : if (!osExt.empty() &&
3153 185703 : DoesDriverHandleExtension(GDALDriver::ToHandle(poDriver),
3154 : osExt.c_str()))
3155 : {
3156 4517 : if (poDriver->GetMetadataItem("MISSING_PLUGIN_FILENAME"))
3157 : {
3158 0 : poMissingPluginDriver = poDriver;
3159 0 : aosMissingDriverNames.AddString(poDriver->GetDescription());
3160 : }
3161 : else
3162 4517 : aosDriverNames.AddString(poDriver->GetDescription());
3163 : }
3164 : else
3165 : {
3166 : const char *pszPrefix =
3167 183522 : poDriver->GetMetadataItem(GDAL_DMD_CONNECTION_PREFIX);
3168 183522 : if (pszPrefix && STARTS_WITH_CI(pszDestDataset, pszPrefix))
3169 : {
3170 9 : if (poDriver->GetMetadataItem("MISSING_PLUGIN_FILENAME"))
3171 : {
3172 0 : osMatchingPrefix = pszPrefix;
3173 0 : poMissingPluginDriver = poDriver;
3174 : aosMissingDriverNames.AddString(
3175 0 : poDriver->GetDescription());
3176 : }
3177 : else
3178 9 : aosDriverNames.AddString(poDriver->GetDescription());
3179 : }
3180 : }
3181 : }
3182 : }
3183 :
3184 : // GMT is registered before netCDF for opening reasons, but we want
3185 : // netCDF to be used by default for output.
3186 2647 : if (EQUAL(osExt.c_str(), "nc") && aosDriverNames.size() == 2 &&
3187 2647 : EQUAL(aosDriverNames[0], "GMT") && EQUAL(aosDriverNames[1], "netCDF"))
3188 : {
3189 0 : aosDriverNames.Clear();
3190 0 : aosDriverNames.AddString("netCDF");
3191 0 : aosDriverNames.AddString("GMT");
3192 : }
3193 :
3194 2640 : if (bSingleMatch)
3195 : {
3196 2569 : if (nDatasetTypeFlag == GDAL_OF_RASTER)
3197 : {
3198 2128 : if (aosDriverNames.empty())
3199 : {
3200 12 : if (osExt.empty())
3201 : {
3202 8 : aosDriverNames.AddString("GTiff");
3203 : }
3204 : }
3205 2116 : else if (aosDriverNames.size() >= 2)
3206 : {
3207 3844 : if (bEmitWarning && !(EQUAL(aosDriverNames[0], "GTiff") &&
3208 1922 : EQUAL(aosDriverNames[1], "COG")))
3209 : {
3210 0 : CPLError(CE_Warning, CPLE_AppDefined,
3211 : "Several drivers matching %s extension. Using %s",
3212 : osExt.c_str(), aosDriverNames[0]);
3213 : }
3214 3844 : const std::string osDrvName = aosDriverNames[0];
3215 1922 : aosDriverNames.Clear();
3216 1922 : aosDriverNames.AddString(osDrvName.c_str());
3217 : }
3218 : }
3219 442 : else if (EQUAL(osExt.c_str(), "gdb") &&
3220 1 : IsOnlyExpectedGDBDrivers(aosDriverNames))
3221 : {
3222 : // Do not warn about that case given that FileGDB write support
3223 : // forwards to OpenFileGDB one. And also consider GPSBabel as too
3224 : // marginal to deserve the warning.
3225 1 : aosDriverNames.Clear();
3226 1 : aosDriverNames.AddString("OpenFileGDB");
3227 : }
3228 440 : else if (aosDriverNames.size() >= 2)
3229 : {
3230 0 : if (bEmitWarning)
3231 : {
3232 0 : CPLError(CE_Warning, CPLE_AppDefined,
3233 : "Several drivers matching %s %s. Using %s",
3234 0 : osMatchingPrefix.empty() ? osExt.c_str()
3235 0 : : osMatchingPrefix.c_str(),
3236 0 : osMatchingPrefix.empty() ? "extension" : "prefix",
3237 : aosDriverNames[0]);
3238 : }
3239 0 : const std::string osDrvName = aosDriverNames[0];
3240 0 : aosDriverNames.Clear();
3241 0 : aosDriverNames.AddString(osDrvName.c_str());
3242 : }
3243 : }
3244 :
3245 2670 : if (aosDriverNames.empty() && bEmitWarning &&
3246 2670 : aosMissingDriverNames.size() == 1 && poMissingPluginDriver)
3247 : {
3248 0 : CPLError(CE_Failure, CPLE_AppDefined,
3249 : "No installed driver matching %s %s, but %s driver is "
3250 : "known. However plugin %s",
3251 0 : osMatchingPrefix.empty() ? osExt.c_str()
3252 0 : : osMatchingPrefix.c_str(),
3253 0 : osMatchingPrefix.empty() ? "extension" : "prefix",
3254 0 : poMissingPluginDriver->GetDescription(),
3255 0 : GDALGetMessageAboutMissingPluginDriver(poMissingPluginDriver)
3256 : .c_str());
3257 : }
3258 2669 : else if (aosDriverNames.empty() && bEmitWarning &&
3259 29 : aosMissingDriverNames.empty())
3260 : {
3261 799 : for (const auto &sConnectionPrefix : asKnownConnectionPrefixes)
3262 : {
3263 771 : if (STARTS_WITH_CI(pszDestDataset, sConnectionPrefix.pszPrefix))
3264 : {
3265 1 : CPLError(CE_Failure, CPLE_AppDefined,
3266 : "Filename %s starts with the connection prefix of "
3267 : "driver %s, which is not enabled in this GDAL build. "
3268 : "If that filename is really intended, explicitly "
3269 : "specify its output format.",
3270 1 : pszDestDataset, sConnectionPrefix.pszDriverName);
3271 1 : break;
3272 : }
3273 : }
3274 : }
3275 :
3276 2640 : return aosDriverNames.StealList();
3277 : }
3278 :
3279 : /************************************************************************/
3280 : /* GDALGetMessageAboutMissingPluginDriver() */
3281 : /************************************************************************/
3282 :
3283 : std::string
3284 0 : GDALGetMessageAboutMissingPluginDriver(GDALDriver *poMissingPluginDriver)
3285 : {
3286 : std::string osMsg =
3287 0 : poMissingPluginDriver->GetMetadataItem("MISSING_PLUGIN_FILENAME");
3288 : osMsg += " is not available in your "
3289 0 : "installation.";
3290 0 : if (const char *pszInstallationMsg = poMissingPluginDriver->GetMetadataItem(
3291 0 : GDAL_DMD_PLUGIN_INSTALLATION_MESSAGE))
3292 : {
3293 0 : osMsg += " ";
3294 0 : osMsg += pszInstallationMsg;
3295 : }
3296 :
3297 : VSIStatBuf sStat;
3298 0 : if (const char *pszGDALDriverPath =
3299 0 : CPLGetConfigOption("GDAL_DRIVER_PATH", nullptr))
3300 : {
3301 0 : if (VSIStat(pszGDALDriverPath, &sStat) != 0)
3302 : {
3303 0 : if (osMsg.back() != '.')
3304 0 : osMsg += ".";
3305 0 : osMsg += " Directory '";
3306 0 : osMsg += pszGDALDriverPath;
3307 0 : osMsg += "' pointed by GDAL_DRIVER_PATH does not exist.";
3308 : }
3309 : }
3310 : else
3311 : {
3312 0 : if (osMsg.back() != '.')
3313 0 : osMsg += ".";
3314 : #ifdef INSTALL_PLUGIN_FULL_DIR
3315 : if (VSIStat(INSTALL_PLUGIN_FULL_DIR, &sStat) != 0)
3316 : {
3317 : osMsg += " Directory '";
3318 : osMsg += INSTALL_PLUGIN_FULL_DIR;
3319 : osMsg += "' hardcoded in the GDAL library does not "
3320 : "exist and the GDAL_DRIVER_PATH "
3321 : "configuration option is not set.";
3322 : }
3323 : else
3324 : #endif
3325 : {
3326 : osMsg += " The GDAL_DRIVER_PATH configuration "
3327 0 : "option is not set.";
3328 : }
3329 : }
3330 0 : return osMsg;
3331 : }
|
