1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
|
/******************************************************************************
*
* Project: OpenGIS Simple Features Reference Implementation
* Purpose: Implements OGRSQLiteDriver class.
* Author: Frank Warmerdam, warmerdam@pobox.com
*
******************************************************************************
*
* Contributor: Alessandro Furieri, a.furieri@lqt.it
* Portions of this module properly supporting SpatiaLite DB creation
* Developed for Faunalia ( http://www.faunalia.it) with funding from
* Regione Toscana - Settore SISTEMA INFORMATIVO TERRITORIALE ED AMBIENTALE
*
******************************************************************************
* Copyright (c) 2004, Frank Warmerdam <warmerdam@pobox.com>
* Copyright (c) 2007-2013, Even Rouault <even dot rouault at spatialys.com>
*
* SPDX-License-Identifier: MIT
****************************************************************************/
#include "cpl_port.h"
#include "ogr_sqlite.h"
#include <cstring>
#include <string>
#include "cpl_conv.h"
#include "cpl_error.h"
#include "cpl_string.h"
#include "cpl_vsi.h"
#include "gdal.h"
#include "gdal_priv.h"
#include "ogr_core.h"
#include "sqlite3.h"
/************************************************************************/
/* OGRSQLiteDriverIdentify() */
/************************************************************************/
static int OGRSQLiteDriverIdentify(GDALOpenInfo *poOpenInfo)
{
if (STARTS_WITH_CI(poOpenInfo->pszFilename, "SQLITE:"))
{
return TRUE;
}
CPLString osExt(CPLGetExtensionSafe(poOpenInfo->pszFilename));
if (EQUAL(osExt, "gpkg") && GDALGetDriverByName("GPKG") != nullptr)
{
return FALSE;
}
if (EQUAL(osExt, "mbtiles") && GDALGetDriverByName("MBTILES") != nullptr)
{
if (CSLCount(poOpenInfo->papszAllowedDrivers) == 1 &&
EQUAL(poOpenInfo->papszAllowedDrivers[0], "SQLite"))
{
return TRUE;
}
return FALSE;
}
if (STARTS_WITH_CI(poOpenInfo->pszFilename, "VirtualShape:") &&
EQUAL(osExt, "shp"))
{
return TRUE;
}
#ifdef HAVE_RASTERLITE2
if (STARTS_WITH_CI(poOpenInfo->pszFilename, "RASTERLITE2:"))
return poOpenInfo->nOpenFlags & GDAL_OF_RASTER;
#endif
if (EQUAL(poOpenInfo->pszFilename, ":memory:"))
return TRUE;
#ifdef SQLITE_OPEN_URI
// This code enables support for named memory databases in SQLite.
// Named memory databases use file name format
// file:name?mode=memory&cache=shared
// SQLITE_USE_URI is checked only to enable backward compatibility, in case
// we accidentally hijacked some other format.
if (STARTS_WITH(poOpenInfo->pszFilename, "file:") &&
CPLTestBool(CPLGetConfigOption("SQLITE_USE_URI", "YES")))
{
char *queryparams = strchr(poOpenInfo->pszFilename, '?');
if (queryparams)
{
if (strstr(queryparams, "mode=memory") != nullptr)
return TRUE;
}
}
#endif
/* -------------------------------------------------------------------- */
/* Verify that the target is a real file, and has an */
/* appropriate magic string at the beginning. */
/* -------------------------------------------------------------------- */
if (poOpenInfo->nHeaderBytes < 100)
return FALSE;
#ifdef ENABLE_SQL_SQLITE_FORMAT
if (STARTS_WITH(reinterpret_cast<const char *>(poOpenInfo->pabyHeader),
"-- SQL SQLITE"))
{
return TRUE;
}
if (STARTS_WITH(reinterpret_cast<const char *>(poOpenInfo->pabyHeader),
"-- SQL RASTERLITE"))
{
return -1;
}
if (STARTS_WITH(reinterpret_cast<const char *>(poOpenInfo->pabyHeader),
"-- SQL MBTILES"))
{
if (GDALGetDriverByName("MBTILES") != nullptr)
return FALSE;
if (poOpenInfo->eAccess == GA_Update)
return FALSE;
return -1;
}
#endif
if (!STARTS_WITH(reinterpret_cast<const char *>(poOpenInfo->pabyHeader),
"SQLite format 3"))
return FALSE;
// In case we are opening /vsizip/foo.zip with a .gpkg inside
if ((memcmp(poOpenInfo->pabyHeader + 68, "GP10", 4) == 0 ||
memcmp(poOpenInfo->pabyHeader + 68, "GP11", 4) == 0 ||
memcmp(poOpenInfo->pabyHeader + 68, "GPKG", 4) == 0) &&
GDALGetDriverByName("GPKG") != nullptr)
{
return FALSE;
}
// Could be a Rasterlite or MBTiles file as well
return -1;
}
/************************************************************************/
/* Open() */
/************************************************************************/
static GDALDataset *OGRSQLiteDriverOpen(GDALOpenInfo *poOpenInfo)
{
if (OGRSQLiteDriverIdentify(poOpenInfo) == FALSE)
return nullptr;
/* -------------------------------------------------------------------- */
/* Check VirtualShape:xxx.shp syntax */
/* -------------------------------------------------------------------- */
const auto nLen = strlen(poOpenInfo->pszFilename);
if (STARTS_WITH_CI(poOpenInfo->pszFilename, "VirtualShape:") && nLen > 4 &&
EQUAL(poOpenInfo->pszFilename + nLen - 4, ".SHP"))
{
auto poDS = std::make_unique<OGRSQLiteDataSource>();
char **papszOptions = CSLAddString(nullptr, "SPATIALITE=YES");
int nRet = poDS->Create(":memory:", papszOptions);
poDS->SetDescription(poOpenInfo->pszFilename);
CSLDestroy(papszOptions);
if (!nRet)
{
return nullptr;
}
char *pszSQLiteFilename =
CPLStrdup(poOpenInfo->pszFilename + strlen("VirtualShape:"));
if (!std::unique_ptr<GDALDataset>(GDALDataset::Open(
pszSQLiteFilename, GDAL_OF_VECTOR, nullptr, nullptr, nullptr)))
{
CPLFree(pszSQLiteFilename);
return nullptr;
}
char *pszLastDot = strrchr(pszSQLiteFilename, '.');
if (pszLastDot)
*pszLastDot = '\0';
const std::string osTableName = CPLGetBasenameSafe(pszSQLiteFilename);
char *pszSQL = CPLStrdup(CPLSPrintf(
"CREATE VIRTUAL TABLE %s USING VirtualShape(%s, CP1252, -1)",
osTableName.c_str(), pszSQLiteFilename));
poDS->ExecuteSQL(pszSQL, nullptr, nullptr);
CPLFree(pszSQL);
CPLFree(pszSQLiteFilename);
poDS->DisableUpdate();
return poDS.release();
}
/* -------------------------------------------------------------------- */
/* We think this is really an SQLite database, go ahead and try */
/* and open it. */
/* -------------------------------------------------------------------- */
OGRSQLiteDataSource *poDS = new OGRSQLiteDataSource();
if (!poDS->Open(poOpenInfo))
{
delete poDS;
return nullptr;
}
else
return poDS;
}
/************************************************************************/
/* Create() */
/************************************************************************/
static GDALDataset *OGRSQLiteDriverCreate(const char *pszName, int nBands,
CPL_UNUSED int nXSize,
CPL_UNUSED int nYSize,
CPL_UNUSED GDALDataType eDT,
char **papszOptions)
{
if (nBands != 0)
{
CPLError(CE_Failure, CPLE_NotSupported,
"Raster creation through Create() interface is not supported. "
"Only CreateCopy() is supported");
return nullptr;
}
/* -------------------------------------------------------------------- */
/* First, ensure there isn't any such file yet. */
/* -------------------------------------------------------------------- */
VSIStatBufL sStatBuf;
if (VSIStatL(pszName, &sStatBuf) == 0)
{
CPLError(CE_Failure, CPLE_AppDefined,
"It seems a file system object called '%s' already exists.",
pszName);
return nullptr;
}
/* -------------------------------------------------------------------- */
/* Try to create datasource. */
/* -------------------------------------------------------------------- */
OGRSQLiteDataSource *poDS = new OGRSQLiteDataSource();
if (!poDS->Create(pszName, papszOptions))
{
delete poDS;
return nullptr;
}
return poDS;
}
/************************************************************************/
/* Delete() */
/************************************************************************/
static CPLErr OGRSQLiteDriverDelete(const char *pszName)
{
if (VSIUnlink(pszName) == 0)
return CE_None;
else
return CE_Failure;
}
/************************************************************************/
/* RegisterOGRSQLite() */
/************************************************************************/
void RegisterOGRSQLite()
{
if (!GDAL_CHECK_VERSION("SQLite driver"))
return;
if (GDALGetDriverByName("SQLite") != nullptr)
return;
GDALDriver *poDriver = new GDALDriver();
poDriver->SetDescription("SQLite");
poDriver->SetMetadataItem(GDAL_DCAP_VECTOR, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_CREATE_LAYER, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_DELETE_LAYER, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_CREATE_FIELD, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_DELETE_FIELD, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_REORDER_FIELDS, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_CURVE_GEOMETRIES, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_MEASURED_GEOMETRIES, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_Z_GEOMETRIES, "YES");
poDriver->SetMetadataItem(GDAL_DMD_SUPPORTED_SQL_DIALECTS, "SQLITE OGRSQL");
#ifdef HAVE_RASTERLITE2
poDriver->SetMetadataItem(GDAL_DCAP_RASTER, "YES");
poDriver->SetMetadataItem(GDAL_DMD_LONGNAME,
"SQLite / Spatialite / RasterLite2");
poDriver->SetMetadataItem(GDAL_DMD_SUBDATASETS, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_CREATE_SUBDATASETS, "YES");
#else
poDriver->SetMetadataItem(GDAL_DMD_LONGNAME, "SQLite / Spatialite");
#endif
poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, "drivers/vector/sqlite.html");
poDriver->SetMetadataItem(GDAL_DMD_EXTENSIONS, "sqlite db");
poDriver->SetMetadataItem(
GDAL_DMD_OPENOPTIONLIST,
"<OpenOptionList>"
" <Option name='LIST_ALL_TABLES' type='boolean' description='Whether "
"all tables, including non-spatial ones, should be listed' "
"default='NO'/>"
" <Option name='LIST_VIRTUAL_OGR' type='boolean' description='Whether "
"VirtualOGR virtual tables should be listed. Should only be enabled on "
"trusted datasources to avoid potential safety issues' default='NO'/>"
" <Option name='PRELUDE_STATEMENTS' type='string' description='SQL "
"statement(s) to send on the SQLite connection before any other ones'/>"
#ifdef HAVE_RASTERLITE2
" <Option name='1BIT_AS_8BIT' type='boolean' scope='raster' "
"description='Whether to promote 1-bit monochrome raster as 8-bit, so "
"as to have higher quality overviews' default='YES'/>"
#endif
" <Option name='OGR_SCHEMA' type='string' description='"
"Partially or totally overrides the auto-detected schema to use for "
"creating the layer. "
"The overrides are defined as a JSON list of field definitions. "
"This can be a filename or a JSON string or a URL.'/>"
"</OpenOptionList>");
CPLString osCreationOptions(
"<CreationOptionList>"
#ifdef HAVE_SPATIALITE
" <Option name='SPATIALITE' type='boolean' description='Whether to "
"create a Spatialite database' default='NO'/>"
#endif
" <Option name='METADATA' type='boolean' description='Whether to "
"create the geometry_columns and spatial_ref_sys tables' "
"default='YES'/>"
" <Option name='INIT_WITH_EPSG' type='boolean' description='Whether "
"to insert the content of the EPSG CSV files into the spatial_ref_sys "
"table ' default='NO'/>"
#ifdef HAVE_RASTERLITE2
" <Option name='APPEND_SUBDATASET' scope='raster' type='boolean' "
"description='Whether to add the raster to the existing file' "
"default='NO'/>"
" <Option name='COVERAGE' scope='raster' type='string' "
"description='Coverage name'/>"
" <Option name='SECTION' scope='raster' type='string' "
"description='Section name'/>"
" <Option name='COMPRESS' scope='raster' type='string-select' "
"description='Raster compression' default='NONE'>"
" <Value>NONE</Value>"
#endif
);
#ifdef HAVE_RASTERLITE2
if (rl2_is_supported_codec(RL2_COMPRESSION_DEFLATE))
osCreationOptions += " <Value>DEFLATE</Value>";
if (rl2_is_supported_codec(RL2_COMPRESSION_LZMA))
osCreationOptions += " <Value>LZMA</Value>";
if (rl2_is_supported_codec(RL2_COMPRESSION_PNG))
osCreationOptions += " <Value>PNG</Value>";
if (rl2_is_supported_codec(RL2_COMPRESSION_CCITTFAX4))
osCreationOptions += " <Value>CCITTFAX4</Value>";
if (rl2_is_supported_codec(RL2_COMPRESSION_JPEG))
osCreationOptions += " <Value>JPEG</Value>";
if (rl2_is_supported_codec(RL2_COMPRESSION_LOSSY_WEBP))
osCreationOptions += " <Value>WEBP</Value>";
if (rl2_is_supported_codec(RL2_COMPRESSION_LOSSY_JP2))
osCreationOptions += " <Value>JPEG2000</Value>";
#endif
osCreationOptions +=
#ifdef HAVE_RASTERLITE2
" </Option>"
" <Option name='QUALITY' scope='raster' type='int' description='Image "
"quality for JPEG, WEBP and JPEG2000 compressions'/>"
" <Option name='PIXEL_TYPE' scope='raster' type='string-select' "
"description='Raster pixel type. Determines photometric "
"interpretation'>"
" <Value>MONOCHROME</Value>"
" <Value>PALETTE</Value>"
" <Value>GRAYSCALE</Value>"
" <Value>RGB</Value>"
" <Value>MULTIBAND</Value>"
" <Value>DATAGRID</Value>"
" </Option>"
" <Option name='BLOCKXSIZE' scope='raster' type='int' "
"description='Block width' default='512'/>"
" <Option name='BLOCKYSIZE' scope='raster' type='int' "
"description='Block height' default='512'/>"
" <Option name='NBITS' scope='raster' type='int' description='Force "
"bit width. 1, 2 or 4 are supported'/>"
" <Option name='PYRAMIDIZE' scope='raster' type='boolean' "
"description='Whether to automatically build relevant "
"pyramids/overviews' default='NO'/>"
#endif
"</CreationOptionList>";
poDriver->SetMetadataItem(GDAL_DMD_CREATIONOPTIONLIST, osCreationOptions);
poDriver->SetMetadataItem(
GDAL_DS_LAYER_CREATIONOPTIONLIST,
"<LayerCreationOptionList>"
" <Option name='FORMAT' type='string-select' description='Format of "
"geometry columns'>"
" <Value>WKB</Value>"
" <Value>WKT</Value>"
#ifdef HAVE_SPATIALITE
" <Value>SPATIALITE</Value>"
#endif
" </Option>"
" <Option name='GEOMETRY_NAME' type='string' description='Name of "
"geometry column. Defaults to WKT_GEOMETRY for FORMAT=WKT or GEOMETRY "
"otherwise'/>"
" <Option name='LAUNDER' type='boolean' description='Whether layer "
"and field names will be laundered' default='YES'/>"
#ifdef HAVE_SPATIALITE
" <Option name='SPATIAL_INDEX' type='boolean' description='Whether to "
"create a spatial index for Spatialite databases' default='YES'/>"
" <Option name='COMPRESS_GEOM' type='boolean' description='Whether to "
"use compressed format of Spatialite geometries' default='NO'/>"
#endif
" <Option name='SRID' type='int' description='Forced SRID of the "
"layer'/>"
" <Option name='COMPRESS_COLUMNS' type='string' "
"description='=column_name1[,column_name2, ...]. list of (String) "
"columns that must be compressed with ZLib DEFLATE algorithm'/>"
" <Option name='OVERWRITE' type='boolean' description='Whether to "
"overwrite an existing table with the layer name to be created' "
"default='NO'/>"
" <Option name='FID' type='string' description='Name of the FID "
"column to create' default='OGC_FID'/>"
#if SQLITE_VERSION_NUMBER >= 3037000
" <Option name='STRICT' type='boolean' description='Whether to create "
"the table in STRICT mode (only compatible of readers with sqlite >= "
"3.37)' default='NO'/>"
#endif
"</LayerCreationOptionList>");
poDriver->SetMetadataItem(GDAL_DMD_CREATIONFIELDDATATYPES,
"Integer Integer64 Real String Date DateTime "
"Time Binary IntegerList Integer64List "
"RealList StringList");
poDriver->SetMetadataItem(GDAL_DMD_CREATIONFIELDDATASUBTYPES,
"Boolean Int16 Float32");
poDriver->SetMetadataItem(GDAL_DMD_CREATION_FIELD_DEFN_FLAGS,
"WidthPrecision Nullable Default Unique");
poDriver->SetMetadataItem(
GDAL_DMD_ALTER_FIELD_DEFN_FLAGS,
"Name Type WidthPrecision Nullable Default Unique");
#ifdef HAVE_RASTERLITE2
poDriver->SetMetadataItem(GDAL_DMD_CREATIONDATATYPES,
"Byte Int8 UInt16 Int16 UInt32 Int32 Float32 "
"Float64");
#endif
poDriver->SetMetadataItem(GDAL_DCAP_NOTNULL_FIELDS, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_DEFAULT_FIELDS, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_UNIQUE_FIELDS, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_NOTNULL_GEOMFIELDS, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_VIRTUALIO, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_MULTIPLE_VECTOR_LAYERS, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_RELATIONSHIPS, "YES");
poDriver->SetMetadataItem(GDAL_DCAP_CREATE_RELATIONSHIP, "YES");
poDriver->SetMetadataItem(GDAL_DMD_RELATIONSHIP_FLAGS,
"OneToMany Association Composite");
poDriver->SetMetadataItem(GDAL_DMD_RELATIONSHIP_RELATED_TABLE_TYPES,
"features");
#ifdef ENABLE_SQL_SQLITE_FORMAT
poDriver->SetMetadataItem("ENABLE_SQL_SQLITE_FORMAT", "YES");
#endif
#ifdef SQLITE_HAS_COLUMN_METADATA
poDriver->SetMetadataItem("SQLITE_HAS_COLUMN_METADATA", "YES");
#endif
poDriver->SetMetadataItem(GDAL_DCAP_UPDATE, "YES");
poDriver->SetMetadataItem(GDAL_DMD_UPDATE_ITEMS, "Features");
poDriver->pfnOpen = OGRSQLiteDriverOpen;
poDriver->pfnIdentify = OGRSQLiteDriverIdentify;
poDriver->pfnCreate = OGRSQLiteDriverCreate;
#ifdef HAVE_RASTERLITE2
poDriver->pfnCreateCopy = OGRSQLiteDriverCreateCopy;
#endif
poDriver->pfnDelete = OGRSQLiteDriverDelete;
poDriver->pfnUnloadDriver = OGRSQLiteDriverUnload;
GetGDALDriverManager()->RegisterDriver(poDriver);
}
|
