Skip to content

Commit 757df93

Browse files
rouaultrouault
authored
Merge pull request OSGeo#11978 from dbaston/warp-init-dest-harden
Warper: Guard against some invalid values of INIT_DEST
2 parents a599c26 + b58b45a commit 757df93

File tree

3 files changed

+102
-102
lines changed

3 files changed

+102
-102
lines changed

‎alg/gdalwarper.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -555,9 +555,9 @@ class CPL_DLL GDALWarpOperation
555555
CPLErr Initialize(const GDALWarpOptions *psNewOptions);
556556
void *CreateDestinationBuffer(int nDstXSize, int nDstYSize,
557557
int *pbWasInitialized = nullptr);
558-
void InitializeDestinationBuffer(void *pDstBuffer, int nDstXSize,
559-
int nDstYSize,
560-
int *pbWasInitialized = nullptr);
558+
CPLErr InitializeDestinationBuffer(void *pDstBuffer, int nDstXSize,
559+
int nDstYSize,
560+
int *pbWasInitialized = nullptr) const;
561561
static void DestroyDestinationBuffer(void *pDstBuffer);
562562

563563
const GDALWarpOptions *GetOptions();

‎alg/gdalwarpoperation.cpp

+37-14
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
#include "cpl_port.h"
1515
#include "gdalwarper.h"
1616

17+
#include <cctype>
1718
#include <climits>
1819
#include <cmath>
1920
#include <cstddef>
@@ -713,8 +714,13 @@ void *GDALWarpOperation::CreateDestinationBuffer(int nDstXSize, int nDstYSize,
713714
nDstYSize);
714715
if (pDstBuffer)
715716
{
716-
InitializeDestinationBuffer(pDstBuffer, nDstXSize, nDstYSize,
717-
pbInitialized);
717+
auto eErr = InitializeDestinationBuffer(pDstBuffer, nDstXSize,
718+
nDstYSize, pbInitialized);
719+
if (eErr != CE_None)
720+
{
721+
CPLFree(pDstBuffer);
722+
return nullptr;
723+
}
718724
}
719725
return pDstBuffer;
720726
}
@@ -738,10 +744,10 @@ void *GDALWarpOperation::CreateDestinationBuffer(int nDstXSize, int nDstYSize,
738744
* initialized.
739745
* @since 3.10
740746
*/
741-
void GDALWarpOperation::InitializeDestinationBuffer(void *pDstBuffer,
742-
int nDstXSize,
743-
int nDstYSize,
744-
int *pbInitialized)
747+
CPLErr GDALWarpOperation::InitializeDestinationBuffer(void *pDstBuffer,
748+
int nDstXSize,
749+
int nDstYSize,
750+
int *pbInitialized) const
745751
{
746752
const int nWordSize = GDALGetDataTypeSizeBytes(psOptions->eWorkingDataType);
747753

@@ -760,27 +766,34 @@ void GDALWarpOperation::InitializeDestinationBuffer(void *pDstBuffer,
760766
{
761767
*pbInitialized = FALSE;
762768
}
763-
return;
769+
return CE_None;
764770
}
765771

766772
if (pbInitialized != nullptr)
767773
{
768774
*pbInitialized = TRUE;
769775
}
770776

771-
char **papszInitValues =
772-
CSLTokenizeStringComplex(pszInitDest, ",", FALSE, FALSE);
773-
const int nInitCount = CSLCount(papszInitValues);
777+
CPLStringList aosInitValues(
778+
CSLTokenizeStringComplex(pszInitDest, ",", FALSE, FALSE));
779+
const int nInitCount = aosInitValues.Count();
774780

775781
for (int iBand = 0; iBand < psOptions->nBandCount; iBand++)
776782
{
777783
double adfInitRealImag[2] = {0.0, 0.0};
778784
const char *pszBandInit =
779-
papszInitValues[std::min(iBand, nInitCount - 1)];
785+
aosInitValues[std::min(iBand, nInitCount - 1)];
780786

781-
if (EQUAL(pszBandInit, "NO_DATA") &&
782-
psOptions->padfDstNoDataReal != nullptr)
787+
if (EQUAL(pszBandInit, "NO_DATA"))
783788
{
789+
if (psOptions->padfDstNoDataReal == nullptr)
790+
{
791+
CPLError(CE_Failure, CPLE_AppDefined,
792+
"BAND_INIT was set to NO_DATA, but a NoData value was "
793+
"not defined.");
794+
return CE_Failure;
795+
}
796+
784797
adfInitRealImag[0] = psOptions->padfDstNoDataReal[iBand];
785798
if (psOptions->padfDstNoDataImag != nullptr)
786799
{
@@ -789,6 +802,16 @@ void GDALWarpOperation::InitializeDestinationBuffer(void *pDstBuffer,
789802
}
790803
else
791804
{
805+
for (const char *c = pszBandInit; *c != '\0'; c++)
806+
{
807+
if (std::isalpha(*c) && *c != 'i')
808+
{
809+
CPLError(CE_Failure, CPLE_AppDefined,
810+
"Unexpected value of BAND_INIT: %s", pszBandInit);
811+
return CE_Failure;
812+
}
813+
}
814+
792815
CPLStringToComplex(pszBandInit, adfInitRealImag + 0,
793816
adfInitRealImag + 1);
794817
}
@@ -821,7 +844,7 @@ void GDALWarpOperation::InitializeDestinationBuffer(void *pDstBuffer,
821844
}
822845
}
823846

824-
CSLDestroy(papszInitValues);
847+
return CE_None;
825848
}
826849

827850
/**

‎autotest/utilities/test_gdalwarp_lib.py

+62-85
Original file line numberDiff line numberDiff line change
@@ -2347,7 +2347,22 @@ def test_gdalwarp_lib_override_default_output_nodata(frmt, tmp_path):
23472347
# Test automatting setting (or not) of SKIP_NOSOURCE=YES
23482348

23492349

2350-
def test_gdalwarp_lib_auto_skip_nosource(tmp_vsimem):
2350+
@pytest.mark.parametrize(
2351+
"options,checksum",
2352+
[
2353+
("-wo SKIP_NOSOURCE=NO", 41500),
2354+
("", 41500),
2355+
("-wo INIT_DEST=0", 41500),
2356+
("-wo INIT_DEST=NO_DATA -dstnodata 0", 41500),
2357+
("-dstnodata 0", 41500),
2358+
("-dstnodata 1", 51132),
2359+
("-dstnodata 1 -wo INIT_DEST=NO_DATA", 51132),
2360+
("-dstnodata 1 -wo INIT_DEST=1", 51132),
2361+
("-dstnodata 127 -wo INIT_DEST=0", 41500),
2362+
],
2363+
)
2364+
@pytest.mark.parametrize("output_format", ("GTiff", "MEM"))
2365+
def test_gdalwarp_lib_auto_skip_nosource(tmp_vsimem, options, checksum, output_format):
23512366

23522367
sr = osr.SpatialReference()
23532368
sr.ImportFromEPSG(4326)
@@ -2359,80 +2374,20 @@ def test_gdalwarp_lib_auto_skip_nosource(tmp_vsimem):
23592374

23602375
tmpfilename = tmp_vsimem / "test_gdalwarp_lib_auto_skip_nosource.tif"
23612376

2362-
for options in [
2363-
"-wo SKIP_NOSOURCE=NO",
2364-
"",
2365-
"-wo INIT_DEST=0",
2366-
"-wo INIT_DEST=NO_DATA",
2367-
"-dstnodata 0",
2368-
]:
2369-
if gdal.VSIStatL(tmpfilename) is not None:
2370-
gdal.Unlink(tmpfilename)
2371-
out_ds = gdal.Warp(
2372-
tmpfilename,
2373-
src_ds,
2374-
options="-te 1.5 48 3.5 49.5 -wm 100000 " + "-of GTiff " + options,
2375-
)
2376-
cs = out_ds.GetRasterBand(1).Checksum()
2377-
assert cs == 41500, (options, cs)
2378-
2379-
# Same with MEM
2380-
for options in ["", "-wo INIT_DEST=0", "-dstnodata 0"]:
2381-
if gdal.VSIStatL(tmpfilename) is not None:
2382-
gdal.Unlink(tmpfilename)
2383-
out_ds = gdal.Warp(
2384-
tmpfilename,
2385-
src_ds,
2386-
options="-te 1.5 48 3.5 49.5 -wm 100000 " + "-of MEM " + options,
2387-
)
2388-
cs = out_ds.GetRasterBand(1).Checksum()
2389-
assert cs == 41500, (options, cs)
2390-
2391-
# Use fill/nodata at 1
2392-
for options in [ # '-wo SKIP_NOSOURCE=NO -dstnodata 1',
2393-
"-dstnodata 1",
2394-
"-dstnodata 1 -wo INIT_DEST=NO_DATA",
2395-
"-dstnodata 1 -wo INIT_DEST=1",
2396-
]:
2397-
if gdal.VSIStatL(tmpfilename) is not None:
2398-
gdal.Unlink(tmpfilename)
2399-
out_ds = gdal.Warp(
2400-
tmpfilename,
2401-
src_ds,
2402-
options="-te 1.5 48 3.5 49.5 -wm 100000 " + "-of GTiff " + options,
2403-
)
2404-
cs = out_ds.GetRasterBand(1).Checksum()
2405-
assert cs == 51132, (options, cs)
2406-
2407-
# Same with MEM
2408-
for options in [ # '-wo SKIP_NOSOURCE=NO -dstnodata 1',
2409-
"-dstnodata 1",
2410-
"-dstnodata 1 -wo INIT_DEST=NO_DATA",
2411-
"-dstnodata 1 -wo INIT_DEST=1",
2412-
]:
2413-
if gdal.VSIStatL(tmpfilename) is not None:
2414-
gdal.Unlink(tmpfilename)
2415-
out_ds = gdal.Warp(
2416-
tmpfilename,
2417-
src_ds,
2418-
options="-te 1.5 48 3.5 49.5 -wm 100000 " + "-of MEM " + options,
2419-
)
2420-
cs = out_ds.GetRasterBand(1).Checksum()
2421-
assert cs == 51132, (options, cs)
2422-
2423-
# Rather dummy: use a INIT_DEST different of the target dstnodata
2424-
for options in [ # '-wo SKIP_NOSOURCE=NO -dstnodata 1 -wo INIT_DEST=0',
2425-
"-dstnodata 127 -wo INIT_DEST=0"
2426-
]:
2427-
if gdal.VSIStatL(tmpfilename) is not None:
2428-
gdal.Unlink(tmpfilename)
2429-
out_ds = gdal.Warp(
2430-
tmpfilename,
2431-
src_ds,
2432-
options="-te 1.5 48 3.5 49.5 -wm 100000 " + "-of GTiff " + options,
2433-
)
2434-
cs = out_ds.GetRasterBand(1).Checksum()
2435-
assert cs == 41500, (options, cs)
2377+
out_ds = gdal.Warp(
2378+
tmpfilename,
2379+
src_ds,
2380+
options=f"-te 1.5 48 3.5 49.5 -wm 100000 -of {output_format} {options}",
2381+
)
2382+
cs = out_ds.GetRasterBand(1).Checksum()
2383+
2384+
assert cs == checksum, options
2385+
2386+
2387+
def test_gdalwarp_lib_auto_skip_nosource_2(tmp_vsimem):
2388+
2389+
sr = osr.SpatialReference()
2390+
sr.ImportFromEPSG(4326)
24362391

24372392
# Test with 2 input datasets
24382393
src_ds1 = gdal.GetDriverByName("MEM").Create("", 500, 500)
@@ -2445,16 +2400,13 @@ def test_gdalwarp_lib_auto_skip_nosource(tmp_vsimem):
24452400
src_ds2.SetGeoTransform([2.5, 0.001, 0, 49, 0, -0.001])
24462401
src_ds2.SetProjection(sr.ExportToWkt())
24472402

2448-
for options in [""]:
2449-
if gdal.VSIStatL(tmpfilename) is not None:
2450-
gdal.Unlink(tmpfilename)
2451-
out_ds = gdal.Warp(
2452-
tmpfilename,
2453-
[src_ds1, src_ds2],
2454-
options="-te 1.5 48 3.5 49.5 -wm 100000 " + "-of GTiff " + options,
2455-
)
2456-
cs = out_ds.GetRasterBand(1).Checksum()
2457-
assert cs == 41500, (options, cs)
2403+
out_ds = gdal.Warp(
2404+
tmp_vsimem / "out.tif",
2405+
[src_ds1, src_ds2],
2406+
options="-te 1.5 48 3.5 49.5 -wm 100000 -of GTiff ",
2407+
)
2408+
cs = out_ds.GetRasterBand(1).Checksum()
2409+
assert cs == 41500
24582410

24592411

24602412
###############################################################################
@@ -4419,3 +4371,28 @@ def test_gdalwarp_lib_cubic_multiband_uint16_4sample_optim():
44194371
4689,
44204372
5007,
44214373
]
4374+
4375+
4376+
###############################################################################
4377+
# Test invalid values of INIT_DEST
4378+
4379+
4380+
def test_gdalwarp_lib_init_dest_invalid(tmp_vsimem):
4381+
4382+
src_ds = gdal.Open("../gcore/data/byte.tif")
4383+
4384+
with pytest.raises(Exception, match="Unexpected value of BAND_INIT"):
4385+
gdal.Warp(
4386+
tmp_vsimem / "out.tif",
4387+
src_ds,
4388+
outputBounds=(440000, 3750120, 441920, 3751320),
4389+
warpOptions={"INIT_DEST": "NODATA"},
4390+
)
4391+
4392+
with pytest.raises(Exception, match="NoData value was not defined"):
4393+
gdal.Warp(
4394+
tmp_vsimem / "out.tif",
4395+
src_ds,
4396+
outputBounds=(440000, 3750120, 441920, 3751320),
4397+
warpOptions={"INIT_DEST": "NO_DATA"},
4398+
)

0 commit comments

Comments
 (0)