QGIS API Documentation 3.43.0-Master (a93bf8b6462)
qgsvectorfilewriter.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsvectorfilewriter.cpp
3 generic vector file writer
4 -------------------
5 begin : Sat Jun 16 2004
6 copyright : (C) 2004 by Tim Sutton
7 email : tim at linfiniti.com
8 ***************************************************************************/
9
10/***************************************************************************
11 * *
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
16 * *
17 ***************************************************************************/
18
19#include "qgsapplication.h"
20#include "qgsfields.h"
21
22#include "qgsgdalutils.h"
23#include "qgsfielddomain.h"
24#include "qgslogger.h"
25#include "qgsmaplayerutils.h"
26#include "qgsmessagelog.h"
28#include "qgsvectorfilewriter.h"
29#include "qgssettings.h"
30#include "qgssymbol.h"
31#include "qgssymbollayer.h"
32#include "qgslocalec.h"
33#include "qgsogrutils.h"
34#include "qgsvectorlayer.h"
35#include "qgsproviderregistry.h"
37#include "qgsreadwritelocker.h"
38
39#include <QFile>
40#include <QFileInfo>
41#include <QDir>
42#include <QTextCodec>
43#include <QTextStream>
44#include <QSet>
45#include <QMetaType>
46#include <QMutex>
47#include <QRegularExpression>
48#include <QJsonDocument>
49
50#include <cassert>
51#include <cstdlib> // size_t
52#include <limits> // std::numeric_limits
53
54#include <ogr_srs_api.h>
55#include <cpl_error.h>
56#include <cpl_conv.h>
57#include <cpl_string.h>
58#include <gdal.h>
59
64
65QVariant QgsVectorFileWriter::FieldValueConverter::convert( int /*fieldIdxInLayer*/, const QVariant &value )
66{
67 return value;
68}
69
74
75QgsVectorFileWriter::QgsVectorFileWriter( const QString &vectorFileName,
76 const QString &fileEncoding,
77 const QgsFields &fields,
78 Qgis::WkbType geometryType,
80 const QString &driverName,
81 const QStringList &datasourceOptions,
82 const QStringList &layerOptions,
83 QString *newFilename,
86 QString *newLayer,
87 const QgsCoordinateTransformContext &transformContext,
88 FieldNameSource fieldNameSource )
89 : mError( NoError )
90 , mWkbType( geometryType )
92 , mSymbologyScale( 1.0 )
93{
94 init( vectorFileName, fileEncoding, fields, geometryType,
95 srs, driverName, datasourceOptions, layerOptions, newFilename, nullptr,
96 QString(), CreateOrOverwriteFile, newLayer, sinkFlags, transformContext, fieldNameSource, nullptr );
97}
98
99QgsVectorFileWriter::QgsVectorFileWriter( const QString &vectorFileName,
100 const QString &fileEncoding,
101 const QgsFields &fields,
102 Qgis::WkbType geometryType,
104 const QString &driverName,
105 const QStringList &datasourceOptions,
106 const QStringList &layerOptions,
107 QString *newFilename,
108 Qgis::FeatureSymbologyExport symbologyExport,
109 FieldValueConverter *fieldValueConverter,
110 const QString &layerName,
112 QString *newLayer,
113 const QgsCoordinateTransformContext &transformContext,
115 FieldNameSource fieldNameSource,
116 bool includeConstraints,
117 bool setFieldDomains,
118 const QgsAbstractDatabaseProviderConnection *sourceDatabaseProviderConnection )
119 : mError( NoError )
120 , mWkbType( geometryType )
121 , mSymbologyExport( symbologyExport )
122 , mSymbologyScale( 1.0 )
123 , mIncludeConstraints( includeConstraints )
124 , mSetFieldDomains( setFieldDomains )
125{
126 init( vectorFileName, fileEncoding, fields, geometryType, srs, driverName,
127 datasourceOptions, layerOptions, newFilename, fieldValueConverter,
128 layerName, action, newLayer, sinkFlags, transformContext, fieldNameSource, sourceDatabaseProviderConnection );
129}
130
132 const QString &fileName,
133 const QgsFields &fields,
134 Qgis::WkbType geometryType,
136 const QgsCoordinateTransformContext &transformContext,
139 QString *newFilename,
140 QString *newLayer
141)
142{
144 return new QgsVectorFileWriter( fileName, options.fileEncoding, fields, geometryType, srs,
145 options.driverName, options.datasourceOptions, options.layerOptions,
146 newFilename, options.symbologyExport, options.fieldValueConverter, options.layerName,
147 options.actionOnExistingFile, newLayer, transformContext, sinkFlags, options.fieldNameSource, options.includeConstraints, options.setFieldDomains, options.sourceDatabaseProviderConnection );
149}
150
151bool QgsVectorFileWriter::supportsFeatureStyles( const QString &driverName )
152{
153 if ( driverName == QLatin1String( "MapInfo MIF" ) )
154 {
155 return true;
156 }
157 GDALDriverH gdalDriver = GDALGetDriverByName( driverName.toLocal8Bit().constData() );
158 if ( !gdalDriver )
159 return false;
160
161 char **driverMetadata = GDALGetMetadata( gdalDriver, nullptr );
162 if ( !driverMetadata )
163 return false;
164
165#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,7,0)
166 return CSLFetchBoolean( driverMetadata, GDAL_DCAP_FEATURE_STYLES_WRITE, false );
167#else
168 return CSLFetchBoolean( driverMetadata, GDAL_DCAP_FEATURE_STYLES, false );
169#endif
170}
171
172void QgsVectorFileWriter::init( QString vectorFileName,
173 QString fileEncoding,
174 const QgsFields &fields,
175 Qgis::WkbType geometryType,
177 const QString &driverName,
178 QStringList datasourceOptions,
179 QStringList layerOptions,
180 QString *newFilename,
181 FieldValueConverter *fieldValueConverter,
182 const QString &layerNameIn,
183 ActionOnExistingFile action,
184 QString *newLayer, SinkFlags sinkFlags,
185 const QgsCoordinateTransformContext &transformContext, FieldNameSource fieldNameSource,
186 const QgsAbstractDatabaseProviderConnection *sourceDatabaseProviderConnection )
187{
188#if GDAL_VERSION_NUM < GDAL_COMPUTE_VERSION(3,5,0)
189 ( void )sourceDatabaseProviderConnection;
190#endif
191
192 mRenderContext.setRendererScale( mSymbologyScale );
193
194 if ( vectorFileName.isEmpty() )
195 {
196 mErrorMessage = QObject::tr( "Empty filename given" );
198 return;
199 }
200
201 if ( driverName == QLatin1String( "MapInfo MIF" ) )
202 {
203 mOgrDriverName = QStringLiteral( "MapInfo File" );
204 }
205 else if ( driverName == QLatin1String( "SpatiaLite" ) )
206 {
207 mOgrDriverName = QStringLiteral( "SQLite" );
208 if ( !datasourceOptions.contains( QStringLiteral( "SPATIALITE=YES" ) ) )
209 {
210 datasourceOptions.append( QStringLiteral( "SPATIALITE=YES" ) );
211 }
212 }
213 else if ( driverName == QLatin1String( "DBF file" ) )
214 {
215 mOgrDriverName = QStringLiteral( "ESRI Shapefile" );
216 if ( !layerOptions.contains( QStringLiteral( "SHPT=NULL" ) ) )
217 {
218 layerOptions.append( QStringLiteral( "SHPT=NULL" ) );
219 }
221 }
222 else
223 {
224 mOgrDriverName = driverName;
225 }
226
227#if GDAL_VERSION_NUM < GDAL_COMPUTE_VERSION(3,3,1)
228 QString fidFieldName;
229 if ( mOgrDriverName == QLatin1String( "GPKG" ) )
230 {
231 for ( const QString &layerOption : layerOptions )
232 {
233 if ( layerOption.startsWith( QLatin1String( "FID=" ) ) )
234 {
235 fidFieldName = layerOption.mid( 4 );
236 break;
237 }
238 }
239 if ( fidFieldName.isEmpty() )
240 fidFieldName = QStringLiteral( "fid" );
241 }
242#endif
243
244 // find driver in OGR
245 OGRSFDriverH poDriver;
247
248 poDriver = OGRGetDriverByName( mOgrDriverName.toLocal8Bit().constData() );
249
250 if ( !poDriver )
251 {
252 mErrorMessage = QObject::tr( "OGR driver for '%1' not found (OGR error: %2)" )
253 .arg( driverName,
254 QString::fromUtf8( CPLGetLastErrorMsg() ) );
256 return;
257 }
258
259 mOgrDriverLongName = QString( GDALGetMetadataItem( poDriver, GDAL_DMD_LONGNAME, nullptr ) );
260
261 MetaData metadata;
262 bool metadataFound = driverMetadata( driverName, metadata );
263
264 if ( mOgrDriverName == QLatin1String( "ESRI Shapefile" ) )
265 {
266 if ( layerOptions.join( QString() ).toUpper().indexOf( QLatin1String( "ENCODING=" ) ) == -1 )
267 {
268 layerOptions.append( "ENCODING=" + convertCodecNameForEncodingOption( fileEncoding ) );
269 }
270
271 if ( driverName == QLatin1String( "ESRI Shapefile" ) && !vectorFileName.endsWith( QLatin1String( ".shp" ), Qt::CaseInsensitive ) )
272 {
273 vectorFileName += QLatin1String( ".shp" );
274 }
275 else if ( driverName == QLatin1String( "DBF file" ) && !vectorFileName.endsWith( QLatin1String( ".dbf" ), Qt::CaseInsensitive ) )
276 {
277 vectorFileName += QLatin1String( ".dbf" );
278 }
279
280 if ( action == CreateOrOverwriteFile || action == CreateOrOverwriteLayer )
281 deleteShapeFile( vectorFileName );
282 }
283 else
284 {
285 if ( metadataFound )
286 {
287 QStringList allExts = metadata.glob.split( ' ', Qt::SkipEmptyParts );
288 bool found = false;
289 const auto constAllExts = allExts;
290 for ( const QString &ext : constAllExts )
291 {
292 // Remove the wildcard (*) at the beginning of the extension
293 if ( vectorFileName.endsWith( ext.mid( 1 ), Qt::CaseInsensitive ) )
294 {
295 found = true;
296 break;
297 }
298 }
299
300 if ( !found )
301 {
302 allExts = metadata.ext.split( ' ', Qt::SkipEmptyParts );
303 vectorFileName += '.' + allExts[0];
304 }
305 }
306
307 if ( action == CreateOrOverwriteFile )
308 {
309 if ( vectorFileName.endsWith( QLatin1String( ".gdb" ), Qt::CaseInsensitive ) )
310 {
311 QDir dir( vectorFileName );
312 if ( dir.exists() )
313 {
314 QFileInfoList fileList = dir.entryInfoList(
315 QDir::NoDotAndDotDot | QDir::System | QDir::Hidden | QDir::AllDirs | QDir::Files, QDir::DirsFirst );
316 const auto constFileList = fileList;
317 for ( const QFileInfo &info : constFileList )
318 {
319 QFile::remove( info.absoluteFilePath() );
320 }
321 }
322 QDir().rmdir( vectorFileName );
323 }
324 else
325 {
326 QFile::remove( vectorFileName );
327 }
328 }
329 }
330
331 if ( metadataFound && !metadata.compulsoryEncoding.isEmpty() )
332 {
333 if ( fileEncoding.compare( metadata.compulsoryEncoding, Qt::CaseInsensitive ) != 0 )
334 {
335 QgsDebugMsgLevel( QStringLiteral( "forced %1 encoding for %2" ).arg( metadata.compulsoryEncoding, driverName ), 2 );
336 fileEncoding = metadata.compulsoryEncoding;
337 }
338
339 }
340
341 char **options = nullptr;
342 if ( !datasourceOptions.isEmpty() )
343 {
344 options = new char *[ datasourceOptions.size() + 1 ];
345 for ( int i = 0; i < datasourceOptions.size(); i++ )
346 {
347 QgsDebugMsgLevel( QStringLiteral( "-dsco=%1" ).arg( datasourceOptions[i] ), 2 );
348 options[i] = CPLStrdup( datasourceOptions[i].toUtf8().constData() );
349 }
350 options[ datasourceOptions.size()] = nullptr;
351 }
352
353 mAttrIdxToOgrIdx.remove( 0 );
354
355 // create the data source
356 if ( action == CreateOrOverwriteFile )
357 mDS.reset( OGR_Dr_CreateDataSource( poDriver, vectorFileName.toUtf8().constData(), options ) );
358 else
359 mDS.reset( OGROpen( vectorFileName.toUtf8().constData(), TRUE, nullptr ) );
360
361 if ( options )
362 {
363 for ( int i = 0; i < datasourceOptions.size(); i++ )
364 CPLFree( options[i] );
365 delete [] options;
366 options = nullptr;
367 }
368
369 if ( !mDS )
370 {
372 if ( action == CreateOrOverwriteFile )
373 mErrorMessage = QObject::tr( "Creation of data source failed (OGR error: %1)" )
374 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
375 else
376 mErrorMessage = QObject::tr( "Opening of data source in update mode failed (OGR error: %1)" )
377 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
378 return;
379 }
380
381 QString layerName( layerNameIn );
382 if ( layerName.isEmpty() )
383 layerName = QFileInfo( vectorFileName ).baseName();
384
385 if ( action == CreateOrOverwriteLayer )
386 {
387 const int layer_count = OGR_DS_GetLayerCount( mDS.get() );
388 for ( int i = 0; i < layer_count; i++ )
389 {
390 OGRLayerH hLayer = OGR_DS_GetLayer( mDS.get(), i );
391 if ( EQUAL( OGR_L_GetName( hLayer ), layerName.toUtf8().constData() ) )
392 {
393 if ( OGR_DS_DeleteLayer( mDS.get(), i ) != OGRERR_NONE )
394 {
396 mErrorMessage = QObject::tr( "Overwriting of existing layer failed (OGR error: %1)" )
397 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
398 return;
399 }
400 break;
401 }
402 }
403 }
404
405 if ( action == CreateOrOverwriteFile )
406 {
407 QgsDebugMsgLevel( QStringLiteral( "Created data source" ), 2 );
408 }
409 else
410 {
411 QgsDebugMsgLevel( QStringLiteral( "Opened data source in update mode" ), 2 );
412 }
413
414 // use appropriate codec
415 mCodec = QTextCodec::codecForName( fileEncoding.toLocal8Bit().constData() );
416 if ( !mCodec )
417 {
418 QgsDebugError( "error finding QTextCodec for " + fileEncoding );
419
420 QgsSettings settings;
421 QString enc = settings.value( QStringLiteral( "UI/encoding" ), "System" ).toString();
422 mCodec = QTextCodec::codecForName( enc.toLocal8Bit().constData() );
423 if ( !mCodec )
424 {
425 QgsDebugError( "error finding QTextCodec for " + enc );
426 mCodec = QTextCodec::codecForLocale();
427 Q_ASSERT( mCodec );
428 }
429 }
430
431 // consider spatial reference system of the layer
432 if ( driverName == QLatin1String( "KML" ) || driverName == QLatin1String( "LIBKML" ) || driverName == QLatin1String( "GPX" ) )
433 {
434 if ( srs.authid() != QLatin1String( "EPSG:4326" ) )
435 {
436 // Those drivers outputs WGS84 geometries, let's align our output CRS to have QGIS take charge of geometry transformation
438 mCoordinateTransform.reset( new QgsCoordinateTransform( srs, wgs84, transformContext ) );
439 srs = wgs84;
440 }
441 }
442
444
445 // datasource created, now create the output layer
446 OGRwkbGeometryType wkbType = ogrTypeFromWkbType( geometryType );
447
448 // Remove FEATURE_DATASET layer option (used for ESRI File GDB driver) if its value is not set
449 int optIndex = layerOptions.indexOf( QLatin1String( "FEATURE_DATASET=" ) );
450 if ( optIndex != -1 )
451 {
452 layerOptions.removeAt( optIndex );
453 }
454
455 if ( !layerOptions.isEmpty() )
456 {
457 options = new char *[ layerOptions.size() + 1 ];
458 for ( int i = 0; i < layerOptions.size(); i++ )
459 {
460 QgsDebugMsgLevel( QStringLiteral( "-lco=%1" ).arg( layerOptions[i] ), 2 );
461 options[i] = CPLStrdup( layerOptions[i].toUtf8().constData() );
462 }
463 options[ layerOptions.size()] = nullptr;
464 }
465
466 // disable encoding conversion of OGR Shapefile layer
467 CPLSetConfigOption( "SHAPE_ENCODING", "" );
468
469 if ( action == CreateOrOverwriteFile || action == CreateOrOverwriteLayer )
470 {
471 mLayer = OGR_DS_CreateLayer( mDS.get(), layerName.toUtf8().constData(), mOgrRef, wkbType, options );
472 if ( newLayer && mLayer )
473 {
474 *newLayer = OGR_L_GetName( mLayer );
475 if ( driverName == QLatin1String( "GPX" ) )
476 {
477 // See logic in GDAL ogr/ogrsf_frmts/gpx/ogrgpxdatasource.cpp ICreateLayer()
478 switch ( QgsWkbTypes::flatType( geometryType ) )
479 {
481 {
482 if ( !EQUAL( layerName.toUtf8().constData(), "track_points" ) &&
483 !EQUAL( layerName.toUtf8().constData(), "route_points" ) )
484 {
485 *newLayer = QStringLiteral( "waypoints" );
486 }
487 }
488 break;
489
491 {
492 const char *pszForceGPXTrack
493 = CSLFetchNameValue( options, "FORCE_GPX_TRACK" );
494 if ( pszForceGPXTrack && CPLTestBool( pszForceGPXTrack ) )
495 *newLayer = QStringLiteral( "tracks" );
496 else
497 *newLayer = QStringLiteral( "routes" );
498
499 }
500 break;
501
503 {
504 const char *pszForceGPXRoute
505 = CSLFetchNameValue( options, "FORCE_GPX_ROUTE" );
506 if ( pszForceGPXRoute && CPLTestBool( pszForceGPXRoute ) )
507 *newLayer = QStringLiteral( "routes" );
508 else
509 *newLayer = QStringLiteral( "tracks" );
510 }
511 break;
512
513 default:
514 break;
515 }
516 }
517 }
518 }
519 else if ( driverName == QLatin1String( "DGN" ) )
520 {
521 mLayer = OGR_DS_GetLayerByName( mDS.get(), "elements" );
522 }
523 else
524 {
525 mLayer = OGR_DS_GetLayerByName( mDS.get(), layerName.toUtf8().constData() );
526 }
527
528 if ( options )
529 {
530 for ( int i = 0; i < layerOptions.size(); i++ )
531 CPLFree( options[i] );
532 delete [] options;
533 options = nullptr;
534 }
535
536 if ( srs.isValid() )
537 {
538 if ( mOgrDriverName == QLatin1String( "ESRI Shapefile" ) )
539 {
540 QString layerName = vectorFileName.left( vectorFileName.indexOf( QLatin1String( ".shp" ), Qt::CaseInsensitive ) );
541 QFile prjFile( layerName + ".qpj" );
542 if ( prjFile.exists() )
543 prjFile.remove();
544 }
545 }
546
547 if ( !mLayer )
548 {
549 if ( action == CreateOrOverwriteFile || action == CreateOrOverwriteLayer )
550 mErrorMessage = QObject::tr( "Creation of layer failed (OGR error: %1)" )
551 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
552 else
553 mErrorMessage = QObject::tr( "Opening of layer failed (OGR error: %1)" )
554 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
556 return;
557 }
558
559 OGRFeatureDefnH defn = OGR_L_GetLayerDefn( mLayer );
560
561 QgsDebugMsgLevel( QStringLiteral( "created layer" ), 2 );
562
563 // create the fields
564 QgsDebugMsgLevel( "creating " + QString::number( fields.size() ) + " fields", 2 );
565
566 mFields = fields;
568 QSet<int> existingIdxs;
569
570 mFieldValueConverter = fieldValueConverter;
571
572#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,7,0)
573 if ( const char *pszCreateFieldDefnFlags = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATION_FIELD_DEFN_FLAGS, nullptr ) )
574 {
575 char **papszTokens = CSLTokenizeString2( pszCreateFieldDefnFlags, " ", 0 );
576 if ( CSLFindString( papszTokens, "AlternativeName" ) >= 0 )
577 {
579 }
580 if ( CSLFindString( papszTokens, "Comment" ) >= 0 )
581 {
583 }
584 CSLDestroy( papszTokens );
585 }
586#endif
587
588 switch ( action )
589 {
593 {
594#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,5,0)
595 QSet<QString> existingDestDomainNames;
596 if ( sourceDatabaseProviderConnection )
597 {
598 char **domainNames = GDALDatasetGetFieldDomainNames( mDS.get(), nullptr );
599 for ( const char *const *iterDomainNames = domainNames; iterDomainNames && *iterDomainNames; ++iterDomainNames )
600 {
601 existingDestDomainNames.insert( QString::fromUtf8( *iterDomainNames ) );
602 }
603 CSLDestroy( domainNames );
604 }
605#endif
606#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,6,0)
607 QSet< QString > usedAlternativeNames;
608#endif
609
610 const QString ogrFidColumnName { OGR_L_GetFIDColumn( mLayer ) };
611 const int fidNameIndex = OGR_FD_GetFieldIndex( defn, ogrFidColumnName.toUtf8() );
612 // if native fid column in created layer matches an attribute from the user-specified fields, we'll be
613 // promoting that to a real attribute.
614 const bool promoteFidColumnToAttribute = !ogrFidColumnName.isEmpty() && fidNameIndex < 0 && fields.lookupField( ogrFidColumnName ) >= 0;
615 int offsetRoomForFid = promoteFidColumnToAttribute ? 1 : 0;
616
617 for ( int fldIdx = 0; fldIdx < fields.count(); ++fldIdx )
618 {
619 QgsField attrField = fields.at( fldIdx );
620
621 if ( fieldValueConverter )
622 {
623 attrField = fieldValueConverter->fieldDefinition( fields.at( fldIdx ) );
624 }
625
626 if ( action == AppendToLayerAddFields )
627 {
628 int ogrIdx = OGR_FD_GetFieldIndex( defn, mCodec->fromUnicode( attrField.name() ) );
629 if ( ogrIdx >= 0 )
630 {
631 mAttrIdxToOgrIdx.insert( fldIdx, ogrIdx );
632 continue;
633 }
634 }
635
636 QString name;
637 switch ( fieldNameSource )
638 {
639 case Original:
640 name = attrField.name();
641 break;
642
643 case PreferAlias:
644 name = !attrField.alias().isEmpty() ? attrField.alias() : attrField.name();
645 break;
646 }
647
648 OGRFieldType ogrType = OFTString; //default to string
649 OGRFieldSubType ogrSubType = OFSTNone;
650 int ogrWidth = attrField.length();
651 int ogrPrecision = attrField.precision();
652 if ( ogrPrecision > 0 )
653 ++ogrWidth;
654
655 switch ( attrField.type() )
656 {
657 case QMetaType::Type::LongLong:
658 {
659 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES, nullptr );
660 if ( pszDataTypes && strstr( pszDataTypes, "Integer64" ) )
661 ogrType = OFTInteger64;
662 else
663 ogrType = OFTReal;
664 ogrWidth = ogrWidth > 0 && ogrWidth <= 20 ? ogrWidth : 20;
665 ogrPrecision = 0;
666 break;
667 }
668 case QMetaType::Type::QString:
669 ogrType = OFTString;
670 if ( ( ogrWidth <= 0 || ogrWidth > 255 ) && mOgrDriverName == QLatin1String( "ESRI Shapefile" ) )
671 ogrWidth = 255;
672 break;
673
674 case QMetaType::Type::Int:
675 ogrType = OFTInteger;
676 ogrWidth = ogrWidth > 0 && ogrWidth <= 10 ? ogrWidth : 10;
677 ogrPrecision = 0;
678 break;
679
680 case QMetaType::Type::Bool:
681 ogrType = OFTInteger;
682 ogrSubType = OFSTBoolean;
683 ogrWidth = 1;
684 ogrPrecision = 0;
685 break;
686
687 case QMetaType::Type::Double:
688#if GDAL_VERSION_NUM < GDAL_COMPUTE_VERSION(3,3,1)
689 if ( mOgrDriverName == QLatin1String( "GPKG" ) && attrField.precision() == 0 && attrField.name().compare( fidFieldName, Qt::CaseInsensitive ) == 0 )
690 {
691 // Convert field to match required FID type
692 ogrType = OFTInteger64;
693 break;
694 }
695#endif
696 ogrType = OFTReal;
697 break;
698
699 case QMetaType::Type::QDate:
700 ogrType = OFTDate;
701 break;
702
703 case QMetaType::Type::QTime:
704 if ( mOgrDriverName == QLatin1String( "ESRI Shapefile" ) )
705 {
706 ogrType = OFTString;
707 ogrWidth = 12; // %02d:%02d:%06.3f
708 }
709 else
710 {
711 ogrType = OFTTime;
712 }
713 break;
714
715 case QMetaType::Type::QDateTime:
716 if ( mOgrDriverName == QLatin1String( "ESRI Shapefile" ) )
717 {
718 ogrType = OFTString;
719 ogrWidth = 24; // "%04d/%02d/%02d %02d:%02d:%06.3f"
720 }
721 else
722 {
723 ogrType = OFTDateTime;
724 }
725 break;
726
727 case QMetaType::Type::QByteArray:
728 ogrType = OFTBinary;
729 break;
730
731 case QMetaType::Type::QStringList:
732 {
733 // handle GPKG conversion to JSON
734 if ( mOgrDriverName == QLatin1String( "GPKG" ) )
735 {
736 ogrType = OFTString;
737 ogrSubType = OFSTJSON;
738 break;
739 }
740
741 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES, nullptr );
742 if ( pszDataTypes && strstr( pszDataTypes, "StringList" ) )
743 {
744 ogrType = OFTStringList;
745 mSupportedListSubTypes.insert( QMetaType::Type::QString );
746 }
747 else
748 {
749 ogrType = OFTString;
750 ogrWidth = 255;
751 }
752 break;
753 }
754
755 case QMetaType::Type::QVariantMap:
756 {
757 // handle GPKG conversion to JSON
758 const char *pszDataSubTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATASUBTYPES, nullptr );
759 if ( pszDataSubTypes && strstr( pszDataSubTypes, "JSON" ) )
760 {
761 ogrType = OFTString;
762 ogrSubType = OFSTJSON;
763 break;
764 }
765 }
766
767 //intentional fall-through
768 [[fallthrough]];
769
770 case QMetaType::Type::QVariantList:
771 // handle GPKG conversion to JSON
772 if ( mOgrDriverName == QLatin1String( "GPKG" ) )
773 {
774 ogrType = OFTString;
775 ogrSubType = OFSTJSON;
776 break;
777 }
778
779 // fall through to default for other unsupported types
780 if ( attrField.subType() == QMetaType::Type::QString )
781 {
782 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES, nullptr );
783 if ( pszDataTypes && strstr( pszDataTypes, "StringList" ) )
784 {
785 ogrType = OFTStringList;
786 mSupportedListSubTypes.insert( QMetaType::Type::QString );
787 }
788 else
789 {
790 ogrType = OFTString;
791 ogrWidth = 255;
792 }
793 break;
794 }
795 else if ( attrField.subType() == QMetaType::Type::Int )
796 {
797 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES, nullptr );
798 if ( pszDataTypes && strstr( pszDataTypes, "IntegerList" ) )
799 {
800 ogrType = OFTIntegerList;
801 mSupportedListSubTypes.insert( QMetaType::Type::Int );
802 }
803 else
804 {
805 ogrType = OFTString;
806 ogrWidth = 255;
807 }
808 break;
809 }
810 else if ( attrField.subType() == QMetaType::Type::Double )
811 {
812 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES, nullptr );
813 if ( pszDataTypes && strstr( pszDataTypes, "RealList" ) )
814 {
815 ogrType = OFTRealList;
816 mSupportedListSubTypes.insert( QMetaType::Type::Double );
817 }
818 else
819 {
820 ogrType = OFTString;
821 ogrWidth = 255;
822 }
823 break;
824 }
825 else if ( attrField.subType() == QMetaType::Type::LongLong )
826 {
827 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES, nullptr );
828 if ( pszDataTypes && strstr( pszDataTypes, "Integer64List" ) )
829 {
830 ogrType = OFTInteger64List;
831 mSupportedListSubTypes.insert( QMetaType::Type::LongLong );
832 }
833 else
834 {
835 ogrType = OFTString;
836 ogrWidth = 255;
837 }
838 break;
839 }
840 //intentional fall-through
841 [[fallthrough]];
842
843 default:
844 //assert(0 && "invalid variant type!");
845 mErrorMessage = QObject::tr( "Unsupported type for field %1" )
846 .arg( attrField.name() );
848 return;
849 }
850
851 if ( mOgrDriverName == QLatin1String( "SQLite" ) && name.compare( QLatin1String( "ogc_fid" ), Qt::CaseInsensitive ) == 0 )
852 {
853 int i;
854 for ( i = 0; i < 10; i++ )
855 {
856 name = QStringLiteral( "ogc_fid%1" ).arg( i );
857
858 int j;
859 for ( j = 0; j < fields.size() && name.compare( fields.at( j ).name(), Qt::CaseInsensitive ) != 0; j++ )
860 ;
861
862 if ( j == fields.size() )
863 break;
864 }
865
866 if ( i == 10 )
867 {
868 mErrorMessage = QObject::tr( "No available replacement for internal fieldname ogc_fid found" ).arg( attrField.name() );
870 return;
871 }
872
873 QgsMessageLog::logMessage( QObject::tr( "Reserved attribute name ogc_fid replaced with %1" ).arg( name ), QObject::tr( "OGR" ) );
874 }
875
876 // create field definition
877 gdal::ogr_field_def_unique_ptr fld( OGR_Fld_Create( mCodec->fromUnicode( name ), ogrType ) );
878 if ( ogrWidth > 0 )
879 {
880 OGR_Fld_SetWidth( fld.get(), ogrWidth );
881 }
882
883 if ( ogrPrecision >= 0 )
884 {
885 OGR_Fld_SetPrecision( fld.get(), ogrPrecision );
886 }
887
888 if ( ogrSubType != OFSTNone )
889 OGR_Fld_SetSubType( fld.get(), ogrSubType );
890
891#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,6,0)
892 if ( !attrField.alias().isEmpty() )
893 {
894 QString alternativeName = attrField.alias();
895 int counter = 1;
896 while ( usedAlternativeNames.contains( alternativeName ) )
897 {
898 // field alternative names MUST be unique (at least for Geopackage, but let's apply the constraint universally)
899 alternativeName = attrField.alias() + QStringLiteral( " (%1)" ).arg( ++counter );
900 }
901 OGR_Fld_SetAlternativeName( fld.get(), mCodec->fromUnicode( alternativeName ).constData() );
902 usedAlternativeNames.insert( alternativeName );
903 }
904#endif
905#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,7,0)
906 OGR_Fld_SetComment( fld.get(), mCodec->fromUnicode( attrField.comment() ).constData() );
907#endif
908
910 {
912 {
913 OGR_Fld_SetNullable( fld.get(), false );
914 }
916 {
917 OGR_Fld_SetUnique( fld.get(), true );
918 }
919 }
920#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,5,0)
921 if ( mSetFieldDomains && sourceDatabaseProviderConnection )
922 {
923 const QString domainName = attrField.constraints().domainName();
924 if ( !domainName.isEmpty() )
925 {
926 bool canSetFieldDomainName = false;
927 if ( existingDestDomainNames.contains( domainName ) )
928 {
929 // If the target dataset already knows this field domain,
930 // we can directly assign its name to the new field.
931 canSetFieldDomainName = true;
932 }
933 else if ( GDALDatasetTestCapability( mDS.get(), ODsCAddFieldDomain ) )
934 {
935 // Otherwise, if the output dataset can create field domains,
936 // - convert the QGIS field domain to a GDAL one
937 // - register it to the GDAL dataset
938 // - if successful, note that we know that field domain (if it
939 // is shared by other fields)
940 // - assign its name to the new field.
941 try
942 {
943 std::unique_ptr<QgsFieldDomain> domain( sourceDatabaseProviderConnection->fieldDomain( domainName ) );
944 if ( domain )
945 {
946 OGRFieldDomainH hFieldDomain = QgsOgrUtils::convertFieldDomain( domain.get() );
947 if ( hFieldDomain )
948 {
949 char *pszFailureReason = nullptr;
950 if ( GDALDatasetAddFieldDomain( mDS.get(), hFieldDomain, &pszFailureReason ) )
951 {
952 existingDestDomainNames.insert( domainName );
953 canSetFieldDomainName = true;
954 }
955 else
956 {
957 QgsDebugError( QStringLiteral( "cannot create field domain: %1" ).arg( pszFailureReason ) );
958 }
959 CPLFree( pszFailureReason );
960 OGR_FldDomain_Destroy( hFieldDomain );
961 }
962 }
963 }
965 {
966 QgsDebugError( QStringLiteral( "Cannot retrieve field domain: %1" ).arg( domainName ) );
967 }
968 }
969 if ( canSetFieldDomainName )
970 {
971 OGR_Fld_SetDomainName( fld.get(), domainName.toUtf8().toStdString().c_str() );
972 }
973 }
974 }
975#endif
976
977 // create the field
978 QgsDebugMsgLevel( "creating field " + attrField.name() +
979 " type " + QString( QVariant::typeToName( attrField.type() ) ) +
980 " width " + QString::number( ogrWidth ) +
981 " precision " + QString::number( ogrPrecision ), 2 );
982 if ( OGR_L_CreateField( mLayer, fld.get(), true ) != OGRERR_NONE )
983 {
984 QgsDebugError( "error creating field " + attrField.name() );
985 mErrorMessage = QObject::tr( "Creation of field %1 (%2) failed (OGR error: %3)" )
986 .arg( attrField.name(),
987 QVariant::typeToName( attrField.type() ),
988 QString::fromUtf8( CPLGetLastErrorMsg() ) );
990 return;
991 }
992
993 int ogrIdx = OGR_FD_GetFieldIndex( defn, mCodec->fromUnicode( name ) );
994 QgsDebugMsgLevel( QStringLiteral( "returned field index for %1: %2" ).arg( name ).arg( ogrIdx ), 2 );
995 if ( ogrIdx < 0 || existingIdxs.contains( ogrIdx ) )
996 {
997 // GDAL 1.7 not just truncates, but launders more aggressivly.
998 ogrIdx = OGR_FD_GetFieldCount( defn ) - 1;
999
1000 if ( ogrIdx < 0 )
1001 {
1002 QgsDebugError( "error creating field " + attrField.name() );
1003 mErrorMessage = QObject::tr( "Created field %1 not found (OGR error: %2)" )
1004 .arg( attrField.name(),
1005 QString::fromUtf8( CPLGetLastErrorMsg() ) );
1007 return;
1008 }
1009 }
1010
1011 if ( promoteFidColumnToAttribute )
1012 {
1013 if ( ogrFidColumnName.compare( attrField.name(), Qt::CaseInsensitive ) == 0 )
1014 {
1015 ogrIdx = 0;
1016 offsetRoomForFid = 0;
1017 }
1018 else
1019 {
1020 // shuffle to make space for fid column
1021 ogrIdx += offsetRoomForFid;
1022 }
1023 }
1024
1025 existingIdxs.insert( ogrIdx );
1026 mAttrIdxToOgrIdx.insert( fldIdx, ogrIdx );
1027 }
1028 }
1029 break;
1030
1032 {
1033 for ( int fldIdx = 0; fldIdx < fields.count(); ++fldIdx )
1034 {
1035 QgsField attrField = fields.at( fldIdx );
1036 QString name( attrField.name() );
1037 int ogrIdx = OGR_FD_GetFieldIndex( defn, mCodec->fromUnicode( name ) );
1038 if ( ogrIdx >= 0 )
1039 mAttrIdxToOgrIdx.insert( fldIdx, ogrIdx );
1040 }
1041 }
1042 break;
1043 }
1044
1045 // Geopackages require a unique feature id. If the input feature stream cannot guarantee
1046 // the uniqueness of the FID column, we drop it and let OGR generate new ones
1047 if ( sinkFlags.testFlag( QgsFeatureSink::RegeneratePrimaryKey ) && driverName == QLatin1String( "GPKG" ) )
1048 {
1049 int fidIdx = fields.lookupField( QStringLiteral( "FID" ) );
1050
1051 if ( fidIdx >= 0 )
1052 mAttrIdxToOgrIdx.remove( fidIdx );
1053 }
1054
1055 QgsDebugMsgLevel( QStringLiteral( "Done creating fields" ), 2 );
1056
1057 mWkbType = geometryType;
1058
1059 if ( newFilename )
1060 *newFilename = vectorFileName;
1061
1062 // enabling transaction on databases that support it
1063 mUsingTransaction = true;
1064 if ( OGRERR_NONE != OGR_L_StartTransaction( mLayer ) )
1065 {
1066 mUsingTransaction = false;
1067 }
1068}
1069
1071{
1072 return OGR_G_CreateGeometry( ogrTypeFromWkbType( wkbType ) );
1073}
1074
1076class QgsVectorFileWriterMetadataContainer
1077{
1078 public:
1079
1080 QgsVectorFileWriterMetadataContainer()
1081 {
1082 QMap<QString, QgsVectorFileWriter::Option *> datasetOptions;
1083 QMap<QString, QgsVectorFileWriter::Option *> layerOptions;
1084
1085 // Arrow
1086 datasetOptions.clear();
1087 layerOptions.clear();
1088
1089 layerOptions.insert( QStringLiteral( "COMPRESSION" ), new QgsVectorFileWriter::SetOption(
1090 QObject::tr( "Compression method." ),
1091 QStringList()
1092 << QStringLiteral( "UNCOMPRESSED" )
1093 << QStringLiteral( "ZSTD" )
1094 << QStringLiteral( "LZ4" ),
1095 QStringLiteral( "LZ4" ), // Default value
1096 false // Allow None
1097 ) );
1098
1099 layerOptions.insert( QStringLiteral( "GEOMETRY_ENCODING" ), new QgsVectorFileWriter::SetOption(
1100 QObject::tr( "Geometry encoding." ),
1101 QStringList()
1102 << QStringLiteral( "GEOARROW" )
1103 << QStringLiteral( "WKB" )
1104 << QStringLiteral( "WKT" ),
1105 QStringLiteral( "GEOARROW" ), // Default value
1106 false // Allow None
1107 ) );
1108
1109 layerOptions.insert( QStringLiteral( "BATCH_SIZE" ), new QgsVectorFileWriter::IntOption(
1110 QObject::tr( "Maximum number of rows per batch." ),
1111 65536 // Default value
1112 ) );
1113
1114 layerOptions.insert( QStringLiteral( "FID" ), new QgsVectorFileWriter::StringOption(
1115 QObject::tr( "Name for the feature identifier column" ),
1116 QString() // Default value
1117 ) );
1118
1119 layerOptions.insert( QStringLiteral( "GEOMETRY_NAME" ), new QgsVectorFileWriter::StringOption(
1120 QObject::tr( "Name for the geometry column" ),
1121 QStringLiteral( "geometry" ) // Default value
1122 ) );
1123
1124 driverMetadata.insert( QStringLiteral( "Arrow" ),
1126 QStringLiteral( "(Geo)Arrow" ),
1127 QObject::tr( "(Geo)Arrow" ),
1128 QStringLiteral( "*.arrow *.feather *.arrows *.ipc" ),
1129 QStringLiteral( "arrow" ),
1130 datasetOptions,
1131 layerOptions,
1132 QStringLiteral( "UTF-8" )
1133 )
1134 );
1135
1136 // Arc/Info ASCII Coverage
1137 datasetOptions.clear();
1138 layerOptions.clear();
1139
1140 driverMetadata.insert( QStringLiteral( "AVCE00" ),
1142 QStringLiteral( "Arc/Info ASCII Coverage" ),
1143 QObject::tr( "Arc/Info ASCII Coverage" ),
1144 QStringLiteral( "*.e00" ),
1145 QStringLiteral( "e00" ),
1146 datasetOptions,
1147 layerOptions
1148 )
1149 );
1150
1151 // Comma Separated Value
1152 datasetOptions.clear();
1153 layerOptions.clear();
1154
1155 layerOptions.insert( QStringLiteral( "LINEFORMAT" ), new QgsVectorFileWriter::SetOption(
1156 QObject::tr( "By default when creating new .csv files they "
1157 "are created with the line termination conventions "
1158 "of the local platform (CR/LF on Win32 or LF on all other systems). "
1159 "This may be overridden through the use of the LINEFORMAT option." ),
1160 QStringList()
1161 << QStringLiteral( "CRLF" )
1162 << QStringLiteral( "LF" ),
1163 QString(), // Default value
1164 true // Allow None
1165 ) );
1166
1167 layerOptions.insert( QStringLiteral( "GEOMETRY" ), new QgsVectorFileWriter::SetOption(
1168 QObject::tr( "By default, the geometry of a feature written to a .csv file is discarded. "
1169 "It is possible to export the geometry in its WKT representation by "
1170 "specifying GEOMETRY=AS_WKT. It is also possible to export point geometries "
1171 "into their X,Y,Z components by specifying GEOMETRY=AS_XYZ, GEOMETRY=AS_XY "
1172 "or GEOMETRY=AS_YX." ),
1173 QStringList()
1174 << QStringLiteral( "AS_WKT" )
1175 << QStringLiteral( "AS_XYZ" )
1176 << QStringLiteral( "AS_XY" )
1177 << QStringLiteral( "AS_YX" ),
1178 QString(), // Default value
1179 true // Allow None
1180 ) );
1181
1182 layerOptions.insert( QStringLiteral( "GEOMETRY_NAME" ), new QgsVectorFileWriter::StringOption(
1183 QObject::tr( "Name of geometry column. Only used if GEOMETRY=AS_WKT. Defaults to 'WKT'." ),
1184 QStringLiteral( "WKT" ) // Default value
1185 ) );
1186
1187 layerOptions.insert( QStringLiteral( "CREATE_CSVT" ), new QgsVectorFileWriter::BoolOption(
1188 QObject::tr( "Create the associated .csvt file to describe the type of each "
1189 "column of the layer and its optional width and precision. "
1190 "This option also creates a .prj file which stores coordinate system information." ),
1191 false // Default value
1192 ) );
1193
1194 layerOptions.insert( QStringLiteral( "SEPARATOR" ), new QgsVectorFileWriter::SetOption(
1195 QObject::tr( "Field separator character." ),
1196 QStringList()
1197 << QStringLiteral( "COMMA" )
1198 << QStringLiteral( "SEMICOLON" )
1199 << QStringLiteral( "TAB" )
1200 << QStringLiteral( "SPACE" )
1201#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,12,0)
1202 << QStringLiteral( "PIPE" )
1203#endif
1204 , QStringLiteral( "COMMA" ) // Default value
1205 ) );
1206
1207 layerOptions.insert( QStringLiteral( "STRING_QUOTING" ), new QgsVectorFileWriter::SetOption(
1208 QObject::tr( "Double-quote strings. IF_AMBIGUOUS means that string values that look like numbers will be quoted." ),
1209 QStringList()
1210 << QStringLiteral( "IF_NEEDED" )
1211 << QStringLiteral( "IF_AMBIGUOUS" )
1212 << QStringLiteral( "ALWAYS" ),
1213 QStringLiteral( "IF_AMBIGUOUS" ) // Default value
1214 ) );
1215
1216 layerOptions.insert( QStringLiteral( "WRITE_BOM" ), new QgsVectorFileWriter::BoolOption(
1217 QObject::tr( "Write a UTF-8 Byte Order Mark (BOM) at the start of the file." ),
1218 false // Default value
1219 ) );
1220
1221#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,12,0)
1222 layerOptions.insert( QStringLiteral( "HEADER" ), new QgsVectorFileWriter::BoolOption(
1223 QObject::tr( "Whether to write a header line with the field names." ),
1224 true // Default value
1225 ) );
1226#endif
1227
1228 driverMetadata.insert( QStringLiteral( "CSV" ),
1230 QStringLiteral( "Comma Separated Value [CSV]" ),
1231 QObject::tr( "Comma Separated Value [CSV]" ),
1232 QStringLiteral( "*.csv" ),
1233 QStringLiteral( "csv" ),
1234 datasetOptions,
1235 layerOptions
1236 )
1237 );
1238
1239 // FlatGeobuf
1240 datasetOptions.clear();
1241 layerOptions.clear();
1242
1243 driverMetadata.insert( QStringLiteral( "FlatGeobuf" ),
1245 QStringLiteral( "FlatGeobuf" ),
1246 QObject::tr( "FlatGeobuf" ),
1247 QStringLiteral( "*.fgb" ),
1248 QStringLiteral( "fgb" ),
1249 datasetOptions,
1250 layerOptions,
1251 QStringLiteral( "UTF-8" )
1252 )
1253 );
1254
1255 // ESRI Shapefile
1256 datasetOptions.clear();
1257 layerOptions.clear();
1258
1259 layerOptions.insert( QStringLiteral( "SHPT" ), new QgsVectorFileWriter::SetOption(
1260 QObject::tr( "Override the type of shapefile created. "
1261 "Can be one of NULL for a simple .dbf file with no .shp file, POINT, "
1262 "ARC, POLYGON or MULTIPOINT for 2D, or POINTZ, ARCZ, POLYGONZ or "
1263 "MULTIPOINTZ for 3D;" ) +
1264 QObject::tr( " POINTM, ARCM, POLYGONM or MULTIPOINTM for measured geometries"
1265 " and POINTZM, ARCZM, POLYGONZM or MULTIPOINTZM for 3D measured"
1266 " geometries." ) +
1267 QObject::tr( " MULTIPATCH files are supported since GDAL 2.2." ) +
1268 ""
1269 , QStringList()
1270 << QStringLiteral( "NULL" )
1271 << QStringLiteral( "POINT" )
1272 << QStringLiteral( "ARC" )
1273 << QStringLiteral( "POLYGON" )
1274 << QStringLiteral( "MULTIPOINT" )
1275 << QStringLiteral( "POINTZ" )
1276 << QStringLiteral( "ARCZ" )
1277 << QStringLiteral( "POLYGONZ" )
1278 << QStringLiteral( "MULTIPOINTZ" )
1279 << QStringLiteral( "POINTM" )
1280 << QStringLiteral( "ARCM" )
1281 << QStringLiteral( "POLYGONM" )
1282 << QStringLiteral( "MULTIPOINTM" )
1283 << QStringLiteral( "POINTZM" )
1284 << QStringLiteral( "ARCZM" )
1285 << QStringLiteral( "POLYGONZM" )
1286 << QStringLiteral( "MULTIPOINTZM" )
1287 << QStringLiteral( "MULTIPATCH" )
1288 << QString(),
1289 QString(), // Default value
1290 true // Allow None
1291 ) );
1292
1293 // there does not seem to be a reason to provide this option to the user again
1294 // as we set encoding for shapefiles based on "fileEncoding" parameter passed to the writer
1295#if 0
1296 layerOptions.insert( "ENCODING", new QgsVectorFileWriter::SetOption(
1297 QObject::tr( "Set the encoding value in the DBF file. "
1298 "The default value is LDID/87. It is not clear "
1299 "what other values may be appropriate." ),
1300 QStringList()
1301 << "LDID/87",
1302 "LDID/87" // Default value
1303 ) );
1304#endif
1305
1306 layerOptions.insert( QStringLiteral( "RESIZE" ), new QgsVectorFileWriter::BoolOption(
1307 QObject::tr( "Set to YES to resize fields to their optimal size." ),
1308 false // Default value
1309 ) );
1310
1311 driverMetadata.insert( QStringLiteral( "ESRI" ),
1313 QStringLiteral( "ESRI Shapefile" ),
1314 QObject::tr( "ESRI Shapefile" ),
1315 QStringLiteral( "*.shp" ),
1316 QStringLiteral( "shp" ),
1317 datasetOptions,
1318 layerOptions
1319 )
1320 );
1321
1322 // DBF File
1323 datasetOptions.clear();
1324 layerOptions.clear();
1325
1326 driverMetadata.insert( QStringLiteral( "DBF File" ),
1328 QStringLiteral( "DBF File" ),
1329 QObject::tr( "DBF File" ),
1330 QStringLiteral( "*.dbf" ),
1331 QStringLiteral( "dbf" ),
1332 datasetOptions,
1333 layerOptions
1334 )
1335 );
1336
1337 // GeoJSON
1338 datasetOptions.clear();
1339 layerOptions.clear();
1340
1341 layerOptions.insert( QStringLiteral( "WRITE_BBOX" ), new QgsVectorFileWriter::BoolOption(
1342 QObject::tr( "Set to YES to write a bbox property with the bounding box "
1343 "of the geometries at the feature and feature collection level." ),
1344 false // Default value
1345 ) );
1346
1347 layerOptions.insert( QStringLiteral( "COORDINATE_PRECISION" ), new QgsVectorFileWriter::IntOption(
1348 QObject::tr( "Maximum number of figures after decimal separator to write in coordinates. "
1349 "Defaults to 15. Truncation will occur to remove trailing zeros." ),
1350 15 // Default value
1351 ) );
1352
1353 layerOptions.insert( QStringLiteral( "RFC7946" ), new QgsVectorFileWriter::BoolOption(
1354 QObject::tr( "Whether to use RFC 7946 standard. "
1355 "If disabled GeoJSON 2008 initial version will be used. "
1356 "Default is NO (thus GeoJSON 2008). See also Documentation (via Help button)" ),
1357 false // Default value
1358 ) );
1359
1360 driverMetadata.insert( QStringLiteral( "GeoJSON" ),
1362 QStringLiteral( "GeoJSON" ),
1363 QObject::tr( "GeoJSON" ),
1364 QStringLiteral( "*.geojson" ),
1365 QStringLiteral( "geojson" ),
1366 datasetOptions,
1367 layerOptions,
1368 QStringLiteral( "UTF-8" )
1369 )
1370 );
1371
1372 // GeoJSONSeq
1373 datasetOptions.clear();
1374 layerOptions.clear();
1375
1376 layerOptions.insert( QStringLiteral( "COORDINATE_PRECISION" ), new QgsVectorFileWriter::IntOption(
1377 QObject::tr( "Maximum number of figures after decimal separator to write in coordinates. "
1378 "Defaults to 15. Truncation will occur to remove trailing zeros." ),
1379 15 // Default value
1380 ) );
1381
1382 layerOptions.insert( QStringLiteral( "RS" ), new QgsVectorFileWriter::BoolOption(
1383 QObject::tr( "Whether to start records with the RS=0x1E character (RFC 8142 standard). "
1384 "Defaults to NO: Newline Delimited JSON (geojsonl). \n"
1385 "If set to YES: RFC 8142 standard: GeoJSON Text Sequences (geojsons)." ),
1386 false // Default value = NO
1387 ) );
1388
1389 driverMetadata.insert( QStringLiteral( "GeoJSONSeq" ),
1391 QStringLiteral( "GeoJSON - Newline Delimited" ),
1392 QObject::tr( "GeoJSON - Newline Delimited" ),
1393 QStringLiteral( "*.geojsonl *.geojsons *.json" ),
1394 QStringLiteral( "geojsonl geojsons json" ),
1395 datasetOptions,
1396 layerOptions,
1397 QStringLiteral( "UTF-8" )
1398 )
1399 );
1400
1401 // GeoRSS
1402 datasetOptions.clear();
1403 layerOptions.clear();
1404
1405 datasetOptions.insert( QStringLiteral( "FORMAT" ), new QgsVectorFileWriter::SetOption(
1406 QObject::tr( "whether the document must be in RSS 2.0 or Atom 1.0 format. "
1407 "Default value : RSS" ),
1408 QStringList()
1409 << QStringLiteral( "RSS" )
1410 << QStringLiteral( "ATOM" ),
1411 QStringLiteral( "RSS" ) // Default value
1412 ) );
1413
1414 datasetOptions.insert( QStringLiteral( "GEOM_DIALECT" ), new QgsVectorFileWriter::SetOption(
1415 QObject::tr( "The encoding of location information. Default value : SIMPLE. "
1416 "W3C_GEO only supports point geometries. "
1417 "SIMPLE or W3C_GEO only support geometries in geographic WGS84 coordinates." ),
1418 QStringList()
1419 << QStringLiteral( "SIMPLE" )
1420 << QStringLiteral( "GML" )
1421 << QStringLiteral( "W3C_GEO" ),
1422 QStringLiteral( "SIMPLE" ) // Default value
1423 ) );
1424
1425 datasetOptions.insert( QStringLiteral( "USE_EXTENSIONS" ), new QgsVectorFileWriter::BoolOption(
1426 QObject::tr( "If defined to YES, extension fields will be written. "
1427 "If the field name not found in the base schema matches "
1428 "the foo_bar pattern, foo will be considered as the namespace "
1429 "of the element, and a <foo:bar> element will be written. "
1430 "Otherwise, elements will be written in the <ogr:> namespace." ),
1431 false // Default value
1432 ) );
1433
1434 datasetOptions.insert( QStringLiteral( "WRITE_HEADER_AND_FOOTER" ), new QgsVectorFileWriter::BoolOption(
1435 QObject::tr( "If defined to NO, only <entry> or <item> elements will be written. "
1436 "The user will have to provide the appropriate header and footer of the document." ),
1437 true // Default value
1438 ) );
1439
1440 datasetOptions.insert( QStringLiteral( "HEADER" ), new QgsVectorFileWriter::StringOption(
1441 QObject::tr( "XML content that will be put between the <channel> element and the "
1442 "first <item> element for a RSS document, or between the xml tag and "
1443 "the first <entry> element for an Atom document." ),
1444 QString() // Default value
1445 ) );
1446
1447 datasetOptions.insert( QStringLiteral( "TITLE" ), new QgsVectorFileWriter::StringOption(
1448 QObject::tr( "Value put inside the <title> element in the header. "
1449 "If not provided, a dummy value will be used as that element is compulsory." ),
1450 QString() // Default value
1451 ) );
1452
1453 datasetOptions.insert( QStringLiteral( "DESCRIPTION" ), new QgsVectorFileWriter::StringOption(
1454 QObject::tr( "Value put inside the <description> element in the header. "
1455 "If not provided, a dummy value will be used as that element is compulsory." ),
1456 QString() // Default value
1457 ) );
1458
1459 datasetOptions.insert( QStringLiteral( "LINK" ), new QgsVectorFileWriter::StringOption(
1460 QObject::tr( "Value put inside the <link> element in the header. "
1461 "If not provided, a dummy value will be used as that element is compulsory." ),
1462 QString() // Default value
1463 ) );
1464
1465 datasetOptions.insert( QStringLiteral( "UPDATED" ), new QgsVectorFileWriter::StringOption(
1466 QObject::tr( "Value put inside the <updated> element in the header. "
1467 "Should be formatted as a XML datetime. "
1468 "If not provided, a dummy value will be used as that element is compulsory." ),
1469 QString() // Default value
1470 ) );
1471
1472 datasetOptions.insert( QStringLiteral( "AUTHOR_NAME" ), new QgsVectorFileWriter::StringOption(
1473 QObject::tr( "Value put inside the <author><name> element in the header. "
1474 "If not provided, a dummy value will be used as that element is compulsory." ),
1475 QString() // Default value
1476 ) );
1477
1478 datasetOptions.insert( QStringLiteral( "ID" ), new QgsVectorFileWriter::StringOption(
1479 QObject::tr( "Value put inside the <id> element in the header. "
1480 "If not provided, a dummy value will be used as that element is compulsory." ),
1481 QString() // Default value
1482 ) );
1483
1484 driverMetadata.insert( QStringLiteral( "GeoRSS" ),
1486 QStringLiteral( "GeoRSS" ),
1487 QObject::tr( "GeoRSS" ),
1488 QStringLiteral( "*.xml" ),
1489 QStringLiteral( "xml" ),
1490 datasetOptions,
1491 layerOptions,
1492 QStringLiteral( "UTF-8" )
1493 )
1494 );
1495
1496 // Geography Markup Language [GML]
1497 datasetOptions.clear();
1498 layerOptions.clear();
1499
1500 datasetOptions.insert( QStringLiteral( "XSISCHEMAURI" ), new QgsVectorFileWriter::StringOption(
1501 QObject::tr( "If provided, this URI will be inserted as the schema location. "
1502 "Note that the schema file isn't actually accessed by OGR, so it "
1503 "is up to the user to ensure it will match the schema of the OGR "
1504 "produced GML data file." ),
1505 QString() // Default value
1506 ) );
1507
1508 datasetOptions.insert( QStringLiteral( "XSISCHEMA" ), new QgsVectorFileWriter::SetOption(
1509 QObject::tr( "This writes a GML application schema file to a corresponding "
1510 ".xsd file (with the same basename). If INTERNAL is used the "
1511 "schema is written within the GML file, but this is experimental "
1512 "and almost certainly not valid XML. "
1513 "OFF disables schema generation (and is implicit if XSISCHEMAURI is used)." ),
1514 QStringList()
1515 << QStringLiteral( "EXTERNAL" )
1516 << QStringLiteral( "INTERNAL" )
1517 << QStringLiteral( "OFF" ),
1518 QStringLiteral( "EXTERNAL" ) // Default value
1519 ) );
1520
1521 datasetOptions.insert( QStringLiteral( "PREFIX" ), new QgsVectorFileWriter::StringOption(
1522 QObject::tr( "This is the prefix for the application target namespace." ),
1523 QStringLiteral( "ogr" ) // Default value
1524 ) );
1525
1526 datasetOptions.insert( QStringLiteral( "STRIP_PREFIX" ), new QgsVectorFileWriter::BoolOption(
1527 QObject::tr( "Can be set to TRUE to avoid writing the prefix of the "
1528 "application target namespace in the GML file." ),
1529 false // Default value
1530 ) );
1531
1532 datasetOptions.insert( QStringLiteral( "TARGET_NAMESPACE" ), new QgsVectorFileWriter::StringOption(
1533 QObject::tr( "Defaults to 'http://ogr.maptools.org/'. "
1534 "This is the application target namespace." ),
1535 QStringLiteral( "http://ogr.maptools.org/" ) // Default value
1536 ) );
1537
1538 datasetOptions.insert( QStringLiteral( "FORMAT" ), new QgsVectorFileWriter::SetOption(
1539 QObject::tr( "GML version to use." ),
1540 QStringList()
1541 << QStringLiteral( "GML2" )
1542 << QStringLiteral( "GML3" )
1543 << QStringLiteral( "GML3Deegree" )
1544 << QStringLiteral( "GML3.2" ),
1545 QStringLiteral( "GML3.2" ) // Default value
1546 ) );
1547
1548 datasetOptions.insert( QStringLiteral( "GML3_LONGSRS" ), new QgsVectorFileWriter::BoolOption(
1549 QObject::tr( "Only valid when FORMAT=GML3/GML3Degree/GML3.2. Default to YES. " //needs review here
1550 "If YES, SRS with EPSG authority will be written with the "
1551 "'urn:ogc:def:crs:EPSG::' prefix. In the case the SRS is a "
1552 "geographic SRS without explicit AXIS order, but that the same "
1553 "SRS authority code imported with ImportFromEPSGA() should be "
1554 "treated as lat/long, then the function will take care of coordinate "
1555 "order swapping. If set to NO, SRS with EPSG authority will be "
1556 "written with the 'EPSG:' prefix, even if they are in lat/long order." ),
1557 true // Default value
1558 ) );
1559
1560 datasetOptions.insert( QStringLiteral( "WRITE_FEATURE_BOUNDED_BY" ), new QgsVectorFileWriter::BoolOption(
1561 QObject::tr( "only valid when FORMAT=GML3/GML3Degree/GML3.2) Default to YES. "
1562 "If set to NO, the <gml:boundedBy> element will not be written for "
1563 "each feature." ),
1564 true // Default value
1565 ) );
1566
1567 datasetOptions.insert( QStringLiteral( "SPACE_INDENTATION" ), new QgsVectorFileWriter::BoolOption(
1568 QObject::tr( "Default to YES. If YES, the output will be indented with spaces "
1569 "for more readability, but at the expense of file size." ),
1570 true // Default value
1571 ) );
1572
1573
1574 driverMetadata.insert( QStringLiteral( "GML" ),
1576 QStringLiteral( "Geography Markup Language [GML]" ),
1577 QObject::tr( "Geography Markup Language [GML]" ),
1578 QStringLiteral( "*.gml" ),
1579 QStringLiteral( "gml" ),
1580 datasetOptions,
1581 layerOptions,
1582 QStringLiteral( "UTF-8" )
1583 )
1584 );
1585
1586 // GeoPackage
1587 datasetOptions.clear();
1588 layerOptions.clear();
1589
1590 layerOptions.insert( QStringLiteral( "IDENTIFIER" ), new QgsVectorFileWriter::StringOption(
1591 QObject::tr( "Human-readable identifier (e.g. short name) for the layer content" ),
1592 QString() // Default value
1593 ) );
1594
1595 layerOptions.insert( QStringLiteral( "DESCRIPTION" ), new QgsVectorFileWriter::StringOption(
1596 QObject::tr( "Human-readable description for the layer content" ),
1597 QString() // Default value
1598 ) );
1599
1600 layerOptions.insert( QStringLiteral( "FID" ), new QgsVectorFileWriter::StringOption(
1601 QObject::tr( "Name for the feature identifier column" ),
1602 QStringLiteral( "fid" ) // Default value
1603 ) );
1604
1605 layerOptions.insert( QStringLiteral( "GEOMETRY_NAME" ), new QgsVectorFileWriter::StringOption(
1606 QObject::tr( "Name for the geometry column" ),
1607 QStringLiteral( "geom" ) // Default value
1608 ) );
1609
1610 layerOptions.insert( QStringLiteral( "SPATIAL_INDEX" ), new QgsVectorFileWriter::BoolOption(
1611 QObject::tr( "If a spatial index must be created." ),
1612 true // Default value
1613 ) );
1614
1615 driverMetadata.insert( QStringLiteral( "GPKG" ),
1617 QStringLiteral( "GeoPackage" ),
1618 QObject::tr( "GeoPackage" ),
1619#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,7,0)
1620 QStringLiteral( "*.gpkg *.gpkg.zip" ),
1621#else
1622 QStringLiteral( "*.gpkg" ),
1623#endif
1624 QStringLiteral( "gpkg" ),
1625 datasetOptions,
1626 layerOptions,
1627 QStringLiteral( "UTF-8" )
1628 )
1629 );
1630
1631 // Generic Mapping Tools [GMT]
1632 datasetOptions.clear();
1633 layerOptions.clear();
1634
1635 driverMetadata.insert( QStringLiteral( "GMT" ),
1637 QStringLiteral( "Generic Mapping Tools [GMT]" ),
1638 QObject::tr( "Generic Mapping Tools [GMT]" ),
1639 QStringLiteral( "*.gmt" ),
1640 QStringLiteral( "gmt" ),
1641 datasetOptions,
1642 layerOptions
1643 )
1644 );
1645
1646 // GPS eXchange Format [GPX]
1647 datasetOptions.clear();
1648 layerOptions.clear();
1649
1650 layerOptions.insert( QStringLiteral( "FORCE_GPX_TRACK" ), new QgsVectorFileWriter::BoolOption(
1651 QObject::tr( "By default when writing a layer whose features are of "
1652 "type wkbLineString, the GPX driver chooses to write "
1653 "them as routes. If FORCE_GPX_TRACK=YES is specified, "
1654 "they will be written as tracks." ),
1655 false // Default value
1656 ) );
1657
1658 layerOptions.insert( QStringLiteral( "FORCE_GPX_ROUTE" ), new QgsVectorFileWriter::BoolOption(
1659 QObject::tr( "By default when writing a layer whose features are of "
1660 "type wkbMultiLineString, the GPX driver chooses to write "
1661 "them as tracks. If FORCE_GPX_ROUTE=YES is specified, "
1662 "they will be written as routes, provided that the multilines "
1663 "are composed of only one single line." ),
1664 false // Default value
1665 ) );
1666
1667 datasetOptions.insert( QStringLiteral( "GPX_USE_EXTENSIONS" ), new QgsVectorFileWriter::BoolOption(
1668 QObject::tr( "If GPX_USE_EXTENSIONS=YES is specified, "
1669 "extra fields will be written inside the <extensions> tag." ),
1670 false // Default value
1671 ) );
1672
1673 datasetOptions.insert( QStringLiteral( "GPX_EXTENSIONS_NS" ), new QgsVectorFileWriter::StringOption(
1674 QObject::tr( "Only used if GPX_USE_EXTENSIONS=YES and GPX_EXTENSIONS_NS_URL "
1675 "is set. The namespace value used for extension tags. By default, 'ogr'." ),
1676 QStringLiteral( "ogr" ) // Default value
1677 ) );
1678
1679 datasetOptions.insert( QStringLiteral( "GPX_EXTENSIONS_NS_URL" ), new QgsVectorFileWriter::StringOption(
1680 QObject::tr( "Only used if GPX_USE_EXTENSIONS=YES and GPX_EXTENSIONS_NS "
1681 "is set. The namespace URI. By default, 'http://osgeo.org/gdal'." ),
1682 QStringLiteral( "http://osgeo.org/gdal" ) // Default value
1683 ) );
1684
1685 datasetOptions.insert( QStringLiteral( "LINEFORMAT" ), new QgsVectorFileWriter::SetOption(
1686 QObject::tr( "By default files are created with the line termination "
1687 "conventions of the local platform (CR/LF on win32 or LF "
1688 "on all other systems). This may be overridden through use "
1689 "of the LINEFORMAT layer creation option which may have a value "
1690 "of CRLF (DOS format) or LF (Unix format)." ),
1691 QStringList()
1692 << QStringLiteral( "CRLF" )
1693 << QStringLiteral( "LF" ),
1694 QString(), // Default value
1695 true // Allow None
1696 ) );
1697
1698 driverMetadata.insert( QStringLiteral( "GPX" ),
1700 QStringLiteral( "GPS eXchange Format [GPX]" ),
1701 QObject::tr( "GPS eXchange Format [GPX]" ),
1702 QStringLiteral( "*.gpx" ),
1703 QStringLiteral( "gpx" ),
1704 datasetOptions,
1705 layerOptions,
1706 QStringLiteral( "UTF-8" )
1707 )
1708 );
1709
1710 // INTERLIS 1
1711 datasetOptions.clear();
1712 layerOptions.clear();
1713
1714 driverMetadata.insert( QStringLiteral( "Interlis 1" ),
1716 QStringLiteral( "INTERLIS 1" ),
1717 QObject::tr( "INTERLIS 1" ),
1718 QStringLiteral( "*.itf *.xml *.ili" ),
1719 QStringLiteral( "ili" ),
1720 datasetOptions,
1721 layerOptions
1722 )
1723 );
1724
1725 // INTERLIS 2
1726 datasetOptions.clear();
1727 layerOptions.clear();
1728
1729 driverMetadata.insert( QStringLiteral( "Interlis 2" ),
1731 QStringLiteral( "INTERLIS 2" ),
1732 QObject::tr( "INTERLIS 2" ),
1733 QStringLiteral( "*.xtf *.xml *.ili" ),
1734 QStringLiteral( "ili" ),
1735 datasetOptions,
1736 layerOptions
1737 )
1738 );
1739
1740 // Keyhole Markup Language [KML]
1741 datasetOptions.clear();
1742 layerOptions.clear();
1743
1744 datasetOptions.insert( QStringLiteral( "NameField" ), new QgsVectorFileWriter::StringOption(
1745 QObject::tr( "Allows you to specify the field to use for the KML <name> element." ),
1746 QStringLiteral( "Name" ) // Default value
1747 ) );
1748
1749 datasetOptions.insert( QStringLiteral( "DescriptionField" ), new QgsVectorFileWriter::StringOption(
1750 QObject::tr( "Allows you to specify the field to use for the KML <description> element." ),
1751 QStringLiteral( "Description" ) // Default value
1752 ) );
1753
1754 datasetOptions.insert( QStringLiteral( "AltitudeMode" ), new QgsVectorFileWriter::SetOption(
1755 QObject::tr( "Allows you to specify the AltitudeMode to use for KML geometries. "
1756 "This will only affect 3D geometries and must be one of the valid KML options." ),
1757 QStringList()
1758 << QStringLiteral( "clampToGround" )
1759 << QStringLiteral( "relativeToGround" )
1760 << QStringLiteral( "absolute" ),
1761 QStringLiteral( "relativeToGround" ) // Default value
1762 ) );
1763
1764 datasetOptions.insert( QStringLiteral( "DOCUMENT_ID" ), new QgsVectorFileWriter::StringOption(
1765 QObject::tr( "The DOCUMENT_ID datasource creation option can be used to specified "
1766 "the id of the root <Document> node. The default value is root_doc." ),
1767 QStringLiteral( "root_doc" ) // Default value
1768 ) );
1769
1770 driverMetadata.insert( QStringLiteral( "KML" ),
1772 QStringLiteral( "Keyhole Markup Language [KML]" ),
1773 QObject::tr( "Keyhole Markup Language [KML]" ),
1774 QStringLiteral( "*.kml" ),
1775 QStringLiteral( "kml" ),
1776 datasetOptions,
1777 layerOptions,
1778 QStringLiteral( "UTF-8" )
1779 )
1780 );
1781
1782 // Mapinfo
1783 datasetOptions.clear();
1784 layerOptions.clear();
1785
1786 auto insertMapInfoOptions = []( QMap<QString, QgsVectorFileWriter::Option *> &datasetOptions, QMap<QString, QgsVectorFileWriter::Option *> &layerOptions )
1787 {
1788 datasetOptions.insert( QStringLiteral( "SPATIAL_INDEX_MODE" ), new QgsVectorFileWriter::SetOption(
1789 QObject::tr( "Use this to turn on 'quick spatial index mode'. "
1790 "In this mode writing files can be about 5 times faster, "
1791 "but spatial queries can be up to 30 times slower." ),
1792 QStringList()
1793 << QStringLiteral( "QUICK" )
1794 << QStringLiteral( "OPTIMIZED" ),
1795 QStringLiteral( "QUICK" ), // Default value
1796 true // Allow None
1797 ) );
1798
1799 datasetOptions.insert( QStringLiteral( "BLOCK_SIZE" ), new QgsVectorFileWriter::IntOption(
1800 QObject::tr( "(multiples of 512): Block size for .map files. Defaults "
1801 "to 512. MapInfo 15.2 and above creates .tab files with a "
1802 "blocksize of 16384 bytes. Any MapInfo version should be "
1803 "able to handle block sizes from 512 to 32256." ),
1804 512
1805 ) );
1806 layerOptions.insert( QStringLiteral( "BOUNDS" ), new QgsVectorFileWriter::StringOption(
1807 QObject::tr( "xmin,ymin,xmax,ymax: Define custom layer bounds to increase the "
1808 "accuracy of the coordinates. Note: the geometry of written "
1809 "features must be within the defined box." ),
1810 QString() // Default value
1811 ) );
1812 };
1813 insertMapInfoOptions( datasetOptions, layerOptions );
1814
1815 driverMetadata.insert( QStringLiteral( "MapInfo File" ),
1817 QStringLiteral( "Mapinfo" ),
1818 QObject::tr( "Mapinfo TAB" ),
1819 QStringLiteral( "*.tab" ),
1820 QStringLiteral( "tab" ),
1821 datasetOptions,
1822 layerOptions
1823 )
1824 );
1825 datasetOptions.clear();
1826 layerOptions.clear();
1827 insertMapInfoOptions( datasetOptions, layerOptions );
1828
1829 // QGIS internal alias for MIF files
1830 driverMetadata.insert( QStringLiteral( "MapInfo MIF" ),
1832 QStringLiteral( "Mapinfo" ),
1833 QObject::tr( "Mapinfo MIF" ),
1834 QStringLiteral( "*.mif" ),
1835 QStringLiteral( "mif" ),
1836 datasetOptions,
1837 layerOptions
1838 )
1839 );
1840
1841 // Microstation DGN
1842 datasetOptions.clear();
1843 layerOptions.clear();
1844
1845 datasetOptions.insert( QStringLiteral( "3D" ), new QgsVectorFileWriter::BoolOption(
1846 QObject::tr( "Determine whether 2D (seed_2d.dgn) or 3D (seed_3d.dgn) "
1847 "seed file should be used. This option is ignored if the SEED option is provided." ),
1848 false // Default value
1849 ) );
1850
1851 datasetOptions.insert( QStringLiteral( "SEED" ), new QgsVectorFileWriter::StringOption(
1852 QObject::tr( "Override the seed file to use." ),
1853 QString() // Default value
1854 ) );
1855
1856 datasetOptions.insert( QStringLiteral( "COPY_WHOLE_SEED_FILE" ), new QgsVectorFileWriter::BoolOption(
1857 QObject::tr( "Indicate whether the whole seed file should be copied. "
1858 "If not, only the first three elements will be copied." ),
1859 false // Default value
1860 ) );
1861
1862 datasetOptions.insert( QStringLiteral( "COPY_SEED_FILE_COLOR_TABLE" ), new QgsVectorFileWriter::BoolOption(
1863 QObject::tr( "Indicates whether the color table should be copied from the seed file." ),
1864 false // Default value
1865 ) );
1866
1867 datasetOptions.insert( QStringLiteral( "MASTER_UNIT_NAME" ), new QgsVectorFileWriter::StringOption(
1868 QObject::tr( "Override the master unit name from the seed file with "
1869 "the provided one or two character unit name." ),
1870 QString() // Default value
1871 ) );
1872
1873 datasetOptions.insert( QStringLiteral( "SUB_UNIT_NAME" ), new QgsVectorFileWriter::StringOption(
1874 QObject::tr( "Override the sub unit name from the seed file with the provided "
1875 "one or two character unit name." ),
1876 QString() // Default value
1877 ) );
1878
1879 datasetOptions.insert( QStringLiteral( "SUB_UNITS_PER_MASTER_UNIT" ), new QgsVectorFileWriter::IntOption(
1880 QObject::tr( "Override the number of subunits per master unit. "
1881 "By default the seed file value is used." ),
1882 0 // Default value
1883 ) );
1884
1885 datasetOptions.insert( QStringLiteral( "UOR_PER_SUB_UNIT" ), new QgsVectorFileWriter::IntOption(
1886 QObject::tr( "Override the number of UORs (Units of Resolution) "
1887 "per sub unit. By default the seed file value is used." ),
1888 0 // Default value
1889 ) );
1890
1891 datasetOptions.insert( QStringLiteral( "ORIGIN" ), new QgsVectorFileWriter::StringOption(
1892 QObject::tr( "ORIGIN=x,y,z: Override the origin of the design plane. "
1893 "By default the origin from the seed file is used." ),
1894 QString() // Default value
1895 ) );
1896
1897 driverMetadata.insert( QStringLiteral( "DGN" ),
1899 QStringLiteral( "Microstation DGN" ),
1900 QObject::tr( "Microstation DGN" ),
1901 QStringLiteral( "*.dgn" ),
1902 QStringLiteral( "dgn" ),
1903 datasetOptions,
1904 layerOptions
1905 )
1906 );
1907
1908 // S-57 Base file
1909 datasetOptions.clear();
1910 layerOptions.clear();
1911
1912 datasetOptions.insert( QStringLiteral( "UPDATES" ), new QgsVectorFileWriter::SetOption(
1913 QObject::tr( "Should update files be incorporated into the base data on the fly." ),
1914 QStringList()
1915 << QStringLiteral( "APPLY" )
1916 << QStringLiteral( "IGNORE" ),
1917 QStringLiteral( "APPLY" ) // Default value
1918 ) );
1919
1920 datasetOptions.insert( QStringLiteral( "SPLIT_MULTIPOINT" ), new QgsVectorFileWriter::BoolOption(
1921 QObject::tr( "Should multipoint soundings be split into many single point sounding features. "
1922 "Multipoint geometries are not well handled by many formats, "
1923 "so it can be convenient to split single sounding features with many points "
1924 "into many single point features." ),
1925 false // Default value
1926 ) );
1927
1928 datasetOptions.insert( QStringLiteral( "ADD_SOUNDG_DEPTH" ), new QgsVectorFileWriter::BoolOption(
1929 QObject::tr( "Should a DEPTH attribute be added on SOUNDG features and assign the depth "
1930 "of the sounding. This should only be enabled when SPLIT_MULTIPOINT is "
1931 "also enabled." ),
1932 false // Default value
1933 ) );
1934
1935 datasetOptions.insert( QStringLiteral( "RETURN_PRIMITIVES" ), new QgsVectorFileWriter::BoolOption(
1936 QObject::tr( "Should all the low level geometry primitives be returned as special "
1937 "IsolatedNode, ConnectedNode, Edge and Face layers." ),
1938 false // Default value
1939 ) );
1940
1941 datasetOptions.insert( QStringLiteral( "PRESERVE_EMPTY_NUMBERS" ), new QgsVectorFileWriter::BoolOption(
1942 QObject::tr( "If enabled, numeric attributes assigned an empty string as a value will "
1943 "be preserved as a special numeric value. This option should not generally "
1944 "be needed, but may be useful when translated S-57 to S-57 losslessly." ),
1945 false // Default value
1946 ) );
1947
1948 datasetOptions.insert( QStringLiteral( "LNAM_REFS" ), new QgsVectorFileWriter::BoolOption(
1949 QObject::tr( "Should LNAM and LNAM_REFS fields be attached to features capturing "
1950 "the feature to feature relationships in the FFPT group of the S-57 file." ),
1951 true // Default value
1952 ) );
1953
1954 datasetOptions.insert( QStringLiteral( "RETURN_LINKAGES" ), new QgsVectorFileWriter::BoolOption(
1955 QObject::tr( "Should additional attributes relating features to their underlying "
1956 "geometric primitives be attached. These are the values of the FSPT group, "
1957 "and are primarily needed when doing S-57 to S-57 translations." ),
1958 false // Default value
1959 ) );
1960
1961 datasetOptions.insert( QStringLiteral( "RECODE_BY_DSSI" ), new QgsVectorFileWriter::BoolOption(
1962 QObject::tr( "Should attribute values be recoded to UTF-8 from the character encoding "
1963 "specified in the S57 DSSI record." ),
1964 false // Default value
1965 ) );
1966
1967 // set OGR_S57_OPTIONS = "RETURN_PRIMITIVES=ON,RETURN_LINKAGES=ON,LNAM_REFS=ON"
1968
1969 driverMetadata.insert( QStringLiteral( "S57" ),
1971 QStringLiteral( "S-57 Base file" ),
1972 QObject::tr( "S-57 Base file" ),
1973 QStringLiteral( "*.000" ),
1974 QStringLiteral( "000" ),
1975 datasetOptions,
1976 layerOptions
1977 )
1978 );
1979
1980 // Spatial Data Transfer Standard [SDTS]
1981 datasetOptions.clear();
1982 layerOptions.clear();
1983
1984 driverMetadata.insert( QStringLiteral( "SDTS" ),
1986 QStringLiteral( "Spatial Data Transfer Standard [SDTS]" ),
1987 QObject::tr( "Spatial Data Transfer Standard [SDTS]" ),
1988 QStringLiteral( "*catd.ddf" ),
1989 QStringLiteral( "ddf" ),
1990 datasetOptions,
1991 layerOptions
1992 )
1993 );
1994
1995 // SQLite
1996 datasetOptions.clear();
1997 layerOptions.clear();
1998
1999 datasetOptions.insert( QStringLiteral( "METADATA" ), new QgsVectorFileWriter::BoolOption(
2000 QObject::tr( "Can be used to avoid creating the geometry_columns and spatial_ref_sys "
2001 "tables in a new database. By default these metadata tables are created "
2002 "when a new database is created." ),
2003 true // Default value
2004 ) );
2005
2006 // Will handle the SpatiaLite alias
2007 datasetOptions.insert( QStringLiteral( "SPATIALITE" ), new QgsVectorFileWriter::HiddenOption(
2008 QStringLiteral( "NO" )
2009 ) );
2010
2011
2012 datasetOptions.insert( QStringLiteral( "INIT_WITH_EPSG" ), new QgsVectorFileWriter::HiddenOption(
2013 QStringLiteral( "NO" )
2014 ) );
2015
2016 layerOptions.insert( QStringLiteral( "FORMAT" ), new QgsVectorFileWriter::SetOption(
2017 QObject::tr( "Controls the format used for the geometry column. Defaults to WKB. "
2018 "This is generally more space and processing efficient, but harder "
2019 "to inspect or use in simple applications than WKT (Well Known Text)." ),
2020 QStringList()
2021 << QStringLiteral( "WKB" )
2022 << QStringLiteral( "WKT" ),
2023 QStringLiteral( "WKB" ) // Default value
2024 ) );
2025
2026 layerOptions.insert( QStringLiteral( "LAUNDER" ), new QgsVectorFileWriter::BoolOption(
2027 QObject::tr( "Controls whether layer and field names will be laundered for easier use "
2028 "in SQLite. Laundered names will be converted to lower case and some special "
2029 "characters(' - #) will be changed to underscores." ),
2030 true // Default value
2031 ) );
2032
2033 layerOptions.insert( QStringLiteral( "SPATIAL_INDEX" ), new QgsVectorFileWriter::HiddenOption(
2034 QStringLiteral( "NO" )
2035 ) );
2036
2037 layerOptions.insert( QStringLiteral( "COMPRESS_GEOM" ), new QgsVectorFileWriter::HiddenOption(
2038 QStringLiteral( "NO" )
2039 ) );
2040
2041 layerOptions.insert( QStringLiteral( "SRID" ), new QgsVectorFileWriter::HiddenOption(
2042 QString()
2043 ) );
2044
2045 layerOptions.insert( QStringLiteral( "COMPRESS_COLUMNS" ), new QgsVectorFileWriter::StringOption(
2046 QObject::tr( "column_name1[,column_name2, …] A list of (String) columns that "
2047 "must be compressed with ZLib DEFLATE algorithm. This might be beneficial "
2048 "for databases that have big string blobs. However, use with care, since "
2049 "the value of such columns will be seen as compressed binary content with "
2050 "other SQLite utilities (or previous OGR versions). With OGR, when inserting, "
2051 "modifying or querying compressed columns, compression/decompression is "
2052 "done transparently. However, such columns cannot be (easily) queried with "
2053 "an attribute filter or WHERE clause. Note: in table definition, such columns "
2054 "have the 'VARCHAR_deflate' declaration type." ),
2055 QString() // Default value
2056 ) );
2057
2058 driverMetadata.insert( QStringLiteral( "SQLite" ),
2060 QStringLiteral( "SQLite" ),
2061 QObject::tr( "SQLite" ),
2062 QStringLiteral( "*.sqlite" ),
2063 QStringLiteral( "sqlite" ),
2064 datasetOptions,
2065 layerOptions,
2066 QStringLiteral( "UTF-8" )
2067 )
2068 );
2069
2070 // SpatiaLite
2071 datasetOptions.clear();
2072 layerOptions.clear();
2073
2074 datasetOptions.insert( QStringLiteral( "METADATA" ), new QgsVectorFileWriter::BoolOption(
2075 QObject::tr( "Can be used to avoid creating the geometry_columns and spatial_ref_sys "
2076 "tables in a new database. By default these metadata tables are created "
2077 "when a new database is created." ),
2078 true // Default value
2079 ) );
2080
2081 datasetOptions.insert( QStringLiteral( "SPATIALITE" ), new QgsVectorFileWriter::HiddenOption(
2082 QStringLiteral( "YES" )
2083 ) );
2084
2085 datasetOptions.insert( QStringLiteral( "INIT_WITH_EPSG" ), new QgsVectorFileWriter::BoolOption(
2086 QObject::tr( "Insert the content of the EPSG CSV files into the spatial_ref_sys table. "
2087 "Set to NO for regular SQLite databases." ),
2088 true // Default value
2089 ) );
2090
2091 layerOptions.insert( QStringLiteral( "FORMAT" ), new QgsVectorFileWriter::HiddenOption(
2092 QStringLiteral( "SPATIALITE" )
2093 ) );
2094
2095 layerOptions.insert( QStringLiteral( "LAUNDER" ), new QgsVectorFileWriter::BoolOption(
2096 QObject::tr( "Controls whether layer and field names will be laundered for easier use "
2097 "in SQLite. Laundered names will be converted to lower case and some special "
2098 "characters(' - #) will be changed to underscores." ),
2099 true // Default value
2100 ) );
2101
2102 layerOptions.insert( QStringLiteral( "SPATIAL_INDEX" ), new QgsVectorFileWriter::BoolOption(
2103 QObject::tr( "If the database is of the SpatiaLite flavor, and if OGR is linked "
2104 "against libspatialite, this option can be used to control if a spatial "
2105 "index must be created." ),
2106 true // Default value
2107 ) );
2108
2109 layerOptions.insert( QStringLiteral( "COMPRESS_GEOM" ), new QgsVectorFileWriter::BoolOption(
2110 QObject::tr( "If the format of the geometry BLOB is of the SpatiaLite flavor, "
2111 "this option can be used to control if the compressed format for "
2112 "geometries (LINESTRINGs, POLYGONs) must be used." ),
2113 false // Default value
2114 ) );
2115
2116 layerOptions.insert( QStringLiteral( "SRID" ), new QgsVectorFileWriter::StringOption(
2117 QObject::tr( "Used to force the SRID number of the SRS associated with the layer. "
2118 "When this option isn't specified and that a SRS is associated with the "
2119 "layer, a search is made in the spatial_ref_sys to find a match for the "
2120 "SRS, and, if there is no match, a new entry is inserted for the SRS in "
2121 "the spatial_ref_sys table. When the SRID option is specified, this "
2122 "search (and the eventual insertion of a new entry) will not be done: "
2123 "the specified SRID is used as such." ),
2124 QString() // Default value
2125 ) );
2126
2127 layerOptions.insert( QStringLiteral( "COMPRESS_COLUMNS" ), new QgsVectorFileWriter::StringOption(
2128 QObject::tr( "column_name1[,column_name2, …] A list of (String) columns that "
2129 "must be compressed with ZLib DEFLATE algorithm. This might be beneficial "
2130 "for databases that have big string blobs. However, use with care, since "
2131 "the value of such columns will be seen as compressed binary content with "
2132 "other SQLite utilities (or previous OGR versions). With OGR, when inserting, "
2133 "modifying or queryings compressed columns, compression/decompression is "
2134 "done transparently. However, such columns cannot be (easily) queried with "
2135 "an attribute filter or WHERE clause. Note: in table definition, such columns "
2136 "have the 'VARCHAR_deflate' declaration type." ),
2137 QString() // Default value
2138 ) );
2139
2140 driverMetadata.insert( QStringLiteral( "SpatiaLite" ),
2142 QStringLiteral( "SpatiaLite" ),
2143 QObject::tr( "SpatiaLite" ),
2144 QStringLiteral( "*.sqlite" ),
2145 QStringLiteral( "sqlite" ),
2146 datasetOptions,
2147 layerOptions,
2148 QStringLiteral( "UTF-8" )
2149 )
2150 );
2151 // AutoCAD DXF
2152 datasetOptions.clear();
2153 layerOptions.clear();
2154
2155 datasetOptions.insert( QStringLiteral( "HEADER" ), new QgsVectorFileWriter::StringOption(
2156 QObject::tr( "Override the header file used - in place of header.dxf." ),
2157 QString() // Default value
2158 ) );
2159
2160 datasetOptions.insert( QStringLiteral( "TRAILER" ), new QgsVectorFileWriter::StringOption(
2161 QObject::tr( "Override the trailer file used - in place of trailer.dxf." ),
2162 QString() // Default value
2163 ) );
2164
2165 driverMetadata.insert( QStringLiteral( "DXF" ),
2167 QStringLiteral( "AutoCAD DXF" ),
2168 QObject::tr( "AutoCAD DXF" ),
2169 QStringLiteral( "*.dxf" ),
2170 QStringLiteral( "dxf" ),
2171 datasetOptions,
2172 layerOptions
2173 )
2174 );
2175
2176 // Geoconcept
2177 datasetOptions.clear();
2178 layerOptions.clear();
2179
2180 datasetOptions.insert( QStringLiteral( "EXTENSION" ), new QgsVectorFileWriter::SetOption(
2181 QObject::tr( "Indicates the GeoConcept export file extension. "
2182 "TXT was used by earlier releases of GeoConcept. GXT is currently used." ),
2183 QStringList()
2184 << QStringLiteral( "GXT" )
2185 << QStringLiteral( "TXT" ),
2186 QStringLiteral( "GXT" ) // Default value
2187 ) );
2188
2189 datasetOptions.insert( QStringLiteral( "CONFIG" ), new QgsVectorFileWriter::StringOption(
2190 QObject::tr( "Path to the GCT: the GCT file describes the GeoConcept types definitions: "
2191 "In this file, every line must start with //# followed by a keyword. "
2192 "Lines starting with // are comments." ),
2193 QString() // Default value
2194 ) );
2195
2196 datasetOptions.insert( QStringLiteral( "FEATURETYPE" ), new QgsVectorFileWriter::StringOption(
2197 QObject::tr( "Defines the feature to be created. The TYPE corresponds to one of the Name "
2198 "found in the GCT file for a type section. The SUBTYPE corresponds to one of "
2199 "the Name found in the GCT file for a sub-type section within the previous "
2200 "type section." ),
2201 QString() // Default value
2202 ) );
2203
2204 driverMetadata.insert( QStringLiteral( "Geoconcept" ),
2206 QStringLiteral( "Geoconcept" ),
2207 QObject::tr( "Geoconcept" ),
2208 QStringLiteral( "*.gxt *.txt" ),
2209 QStringLiteral( "gxt" ),
2210 datasetOptions,
2211 layerOptions
2212 )
2213 );
2214
2215 // ESRI OpenFileGDB
2216 datasetOptions.clear();
2217 layerOptions.clear();
2218
2219#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,9,0)
2220 layerOptions.insert( QStringLiteral( "TARGET_ARCGIS_VERSION" ), new QgsVectorFileWriter::SetOption(
2221 QObject::tr( "Selects which ArcGIS version this dataset should be compatible with. ALL is used by default and means any ArcGIS 10.x or ArcGIS Pro version. Using ARCGIS_PRO_3_2_OR_LATER is required to export 64-bit integer fields as such, otherwise they will be converted as Real fields. ARCGIS_PRO_3_2_OR_LATER also supports proper Date and Time field types." ),
2222 QStringList()
2223 << QStringLiteral( "ALL" )
2224 << QStringLiteral( "ARCGIS_PRO_3_2_OR_LATER" ),
2225 QStringLiteral( "ALL" ) // Default value
2226 ) );
2227#endif
2228
2229 layerOptions.insert( QStringLiteral( "FEATURE_DATASET" ), new QgsVectorFileWriter::StringOption(
2230 QObject::tr( "When this option is set, the new layer will be created inside the named "
2231 "FeatureDataset folder. If the folder does not already exist, it will be created." ),
2232 QString() // Default value
2233 ) );
2234
2235 layerOptions.insert( QStringLiteral( "LAYER_ALIAS" ), new QgsVectorFileWriter::StringOption(
2236 QObject::tr( "Set layer name alias." ),
2237 QString() // Default value
2238 ) );
2239
2240 layerOptions.insert( QStringLiteral( "GEOMETRY_NAME" ), new QgsVectorFileWriter::StringOption(
2241 QObject::tr( "Set name of geometry column in new layer. Defaults to 'SHAPE'." ),
2242 QStringLiteral( "SHAPE" ) // Default value
2243 ) );
2244
2245 layerOptions.insert( QStringLiteral( "GEOMETRY_NULLABLE" ), new QgsVectorFileWriter::BoolOption(
2246 QObject::tr( "Whether the values of the geometry column can be NULL. Can be set to NO so that geometry is required. Default to 'YES'." ),
2247 true // Default value
2248 ) );
2249
2250 layerOptions.insert( QStringLiteral( "FID" ), new QgsVectorFileWriter::StringOption(
2251 QObject::tr( "Name of the OID column to create. Defaults to 'OBJECTID'." ),
2252 QStringLiteral( "OBJECTID" ) // Default value
2253 ) );
2254
2255 // TODO missing options -- requires double option type
2256 // XYTOLERANCE
2257 // ZTOLERANCE
2258 // MTOLERANCE
2259 // XORIGIN
2260 // YORIGIN
2261 // ZORIGIN
2262 // MORIGIN
2263 // XYSCALE
2264 // ZSCALE
2265 // ZORIGIN
2266
2267 layerOptions.insert( QStringLiteral( "COLUMN_TYPES" ), new QgsVectorFileWriter::StringOption(
2268 QObject::tr( "A list of strings of format field_name=fgdb_field_type (separated by comma) to force the FileGDB column type of fields to be created." ),
2269 QString( ) // Default value
2270 ) );
2271
2272 layerOptions.insert( QStringLiteral( "DOCUMENTATION" ), new QgsVectorFileWriter::StringOption(
2273 QObject::tr( "XML documentation for the layer." ),
2274 QString( ) // Default value
2275 ) );
2276 layerOptions.insert( QStringLiteral( "CONFIGURATION_KEYWORD" ), new QgsVectorFileWriter::SetOption(
2277 QObject::tr( "Customize how data is stored. By default text in UTF-8 and data up to 1TB." ),
2278 {QStringLiteral( "DEFAULTS" ), QStringLiteral( "MAX_FILE_SIZE_4GB" ), QStringLiteral( "MAX_FILE_SIZE_256TB" )},
2279 QStringLiteral( "DEFAULTS" ), // Default value
2280 false // Allow None
2281 ) );
2282
2283 layerOptions.insert( QStringLiteral( "CREATE_SHAPE_AREA_AND_LENGTH_FIELDS" ), new QgsVectorFileWriter::BoolOption(
2284 QObject::tr( " Defaults to NO (through CreateLayer() API). When this option is set, a Shape_Area and Shape_Length special fields will be created for polygonal layers (Shape_Length only for linear layers). These fields will automatically be populated with the feature’s area or length whenever a new feature is added to the dataset or an existing feature is amended. When using ogr2ogr with a source layer that has Shape_Area/Shape_Length special fields, and this option is not explicitly specified, it will be automatically set, so that the resulting FileGeodatabase has those fields properly tagged." ),
2285 false // Default value
2286 ) );
2287
2288 driverMetadata.insert( QStringLiteral( "OpenFileGDB" ),
2290 QStringLiteral( "ESRI File Geodatabase" ),
2291 QObject::tr( "ESRI File Geodatabase" ),
2292 QStringLiteral( "*.gdb" ),
2293 QStringLiteral( "gdb" ),
2294 datasetOptions,
2295 layerOptions,
2296 QStringLiteral( "UTF-8" )
2297 )
2298 );
2299
2300#if GDAL_VERSION_NUM < GDAL_COMPUTE_VERSION(3,11,0)
2301 // ESRI FileGDB (using ESRI FileGDB API SDK)
2302 datasetOptions.clear();
2303 layerOptions.clear();
2304
2305 layerOptions.insert( QStringLiteral( "FEATURE_DATASET" ), new QgsVectorFileWriter::StringOption(
2306 QObject::tr( "When this option is set, the new layer will be created inside the named "
2307 "FeatureDataset folder. If the folder does not already exist, it will be created." ),
2308 QString() // Default value
2309 ) );
2310
2311 layerOptions.insert( QStringLiteral( "GEOMETRY_NAME" ), new QgsVectorFileWriter::StringOption(
2312 QObject::tr( "Set name of geometry column in new layer. Defaults to 'SHAPE'." ),
2313 QStringLiteral( "SHAPE" ) // Default value
2314 ) );
2315
2316 layerOptions.insert( QStringLiteral( "FID" ), new QgsVectorFileWriter::StringOption(
2317 QObject::tr( "Name of the OID column to create. Defaults to 'OBJECTID'." ),
2318 QStringLiteral( "OBJECTID" ) // Default value
2319 ) );
2320
2321 driverMetadata.insert( QStringLiteral( "FileGDB" ),
2323 QStringLiteral( "ESRI FileGDB" ),
2324 QObject::tr( "ESRI FileGDB" ),
2325 QStringLiteral( "*.gdb" ),
2326 QStringLiteral( "gdb" ),
2327 datasetOptions,
2328 layerOptions,
2329 QStringLiteral( "UTF-8" )
2330 )
2331 );
2332#endif
2333
2334 // XLSX
2335 datasetOptions.clear();
2336 layerOptions.clear();
2337
2338 layerOptions.insert( QStringLiteral( "OGR_XLSX_FIELD_TYPES" ), new QgsVectorFileWriter::SetOption(
2339 QObject::tr( "By default, the driver will try to detect the data type of fields. If set "
2340 "to STRING, all fields will be of String type." ),
2341 QStringList()
2342 << QStringLiteral( "AUTO" )
2343 << QStringLiteral( "STRING" ),
2344 QStringLiteral( "AUTO" ), // Default value
2345 false // Allow None
2346 ) );
2347
2348 layerOptions.insert( QStringLiteral( "OGR_XLSX_HEADERS" ), new QgsVectorFileWriter::SetOption(
2349 QObject::tr( "By default, the driver will read the first lines of each sheet to detect "
2350 "if the first line might be the name of columns. If set to FORCE, the driver "
2351 "will consider the first line as the header line. If set to "
2352 "DISABLE, it will be considered as the first feature. Otherwise "
2353 "auto-detection will occur." ),
2354 QStringList()
2355 << QStringLiteral( "FORCE" )
2356 << QStringLiteral( "DISABLE" )
2357 << QStringLiteral( "AUTO" ),
2358 QStringLiteral( "AUTO" ), // Default value
2359 false // Allow None
2360 ) );
2361
2362 driverMetadata.insert( QStringLiteral( "XLSX" ),
2364 QStringLiteral( "MS Office Open XML spreadsheet" ),
2365 QObject::tr( "MS Office Open XML spreadsheet [XLSX]" ),
2366 QStringLiteral( "*.xlsx" ),
2367 QStringLiteral( "xlsx" ),
2368 datasetOptions,
2369 layerOptions,
2370 QStringLiteral( "UTF-8" )
2371 )
2372 );
2373
2374 // ODS
2375 datasetOptions.clear();
2376 layerOptions.clear();
2377
2378 layerOptions.insert( QStringLiteral( "OGR_ODS_FIELD_TYPES" ), new QgsVectorFileWriter::SetOption(
2379 QObject::tr( "By default, the driver will try to detect the data type of fields. If set "
2380 "to STRING, all fields will be of String type." ),
2381 QStringList()
2382 << QStringLiteral( "AUTO" )
2383 << QStringLiteral( "STRING" ),
2384 QStringLiteral( "AUTO" ), // Default value
2385 false // Allow None
2386 ) );
2387
2388 layerOptions.insert( QStringLiteral( "OGR_ODS_HEADERS" ), new QgsVectorFileWriter::SetOption(
2389 QObject::tr( "By default, the driver will read the first lines of each sheet to detect "
2390 "if the first line might be the name of columns. If set to FORCE, the driver "
2391 "will consider the first line as the header line. If set to "
2392 "DISABLE, it will be considered as the first feature. Otherwise "
2393 "auto-detection will occur." ),
2394 QStringList()
2395 << QStringLiteral( "FORCE" )
2396 << QStringLiteral( "DISABLE" )
2397 << QStringLiteral( "AUTO" ),
2398 QStringLiteral( "AUTO" ), // Default value
2399 false // Allow None
2400 ) );
2401
2402 driverMetadata.insert( QStringLiteral( "ODS" ),
2404 QStringLiteral( "Open Document Spreadsheet" ),
2405 QObject::tr( "Open Document Spreadsheet [ODS]" ),
2406 QStringLiteral( "*.ods" ),
2407 QStringLiteral( "ods" ),
2408 datasetOptions,
2409 layerOptions,
2410 QStringLiteral( "UTF-8" )
2411 )
2412 );
2413
2414 // Parquet
2415 datasetOptions.clear();
2416 layerOptions.clear();
2417
2418 layerOptions.insert( QStringLiteral( "COMPRESSION" ), new QgsVectorFileWriter::SetOption(
2419 QObject::tr( "Compression method." ),
2420 QStringList()
2421 << QStringLiteral( "UNCOMPRESSED" )
2422 << QStringLiteral( "SNAPPY" ),
2423 QStringLiteral( "SNAPPY" ), // Default value
2424 false // Allow None
2425 ) );
2426
2427 layerOptions.insert( QStringLiteral( "GEOMETRY_ENCODING" ), new QgsVectorFileWriter::SetOption(
2428 QObject::tr( "Geometry encoding." ),
2429 QStringList()
2430 << QStringLiteral( "WKB" )
2431 << QStringLiteral( "WKT" )
2432 << QStringLiteral( "GEOARROW" ),
2433 QStringLiteral( "WKB" ), // Default value
2434 false // Allow None
2435 ) );
2436
2437 layerOptions.insert( QStringLiteral( "ROW_GROUP_SIZE" ), new QgsVectorFileWriter::IntOption(
2438 QObject::tr( "Maximum number of rows per group." ),
2439 65536 // Default value
2440 ) );
2441
2442 layerOptions.insert( QStringLiteral( "FID" ), new QgsVectorFileWriter::StringOption(
2443 QObject::tr( "Name for the feature identifier column" ),
2444 QString() // Default value
2445 ) );
2446
2447 layerOptions.insert( QStringLiteral( "GEOMETRY_NAME" ), new QgsVectorFileWriter::StringOption(
2448 QObject::tr( "Name for the geometry column" ),
2449 QStringLiteral( "geometry" ) // Default value
2450 ) );
2451
2452 layerOptions.insert( QStringLiteral( "EDGES" ), new QgsVectorFileWriter::SetOption(
2453 QObject::tr( "Name of the coordinate system for the edges." ),
2454 QStringList()
2455 << QStringLiteral( "PLANAR" )
2456 << QStringLiteral( "SPHERICAL" ),
2457 QStringLiteral( "PLANAR" ), // Default value
2458 false // Allow None
2459 ) );
2460
2461 driverMetadata.insert( QStringLiteral( "Parquet" ),
2463 QStringLiteral( "(Geo)Parquet" ),
2464 QObject::tr( "(Geo)Parquet" ),
2465 QStringLiteral( "*.parquet" ),
2466 QStringLiteral( "parquet" ),
2467 datasetOptions,
2468 layerOptions,
2469 QStringLiteral( "UTF-8" )
2470 )
2471 );
2472
2473 // PGDump
2474 datasetOptions.clear();
2475 layerOptions.clear();
2476
2477 datasetOptions.insert( QStringLiteral( "LINEFORMAT" ), new QgsVectorFileWriter::SetOption(
2478 QObject::tr( "Line termination character sequence." ),
2479 QStringList()
2480 << QStringLiteral( "CRLF" )
2481 << QStringLiteral( "LF" ),
2482 QStringLiteral( "LF" ), // Default value
2483 false // Allow None
2484 ) );
2485
2486
2487 layerOptions.insert( QStringLiteral( "GEOM_TYPE" ), new QgsVectorFileWriter::SetOption(
2488 QObject::tr( "Format of geometry columns." ),
2489 QStringList()
2490 << QStringLiteral( "geometry" )
2491 << QStringLiteral( "geography" ),
2492 QStringLiteral( "geometry" ), // Default value
2493 false // Allow None
2494 ) );
2495
2496 layerOptions.insert( QStringLiteral( "LAUNDER" ), new QgsVectorFileWriter::BoolOption(
2497 QObject::tr( "Controls whether layer and field names will be laundered for easier use. "
2498 "Laundered names will be converted to lower case and some special "
2499 "characters(' - #) will be changed to underscores." ),
2500 true // Default value
2501 ) );
2502
2503 layerOptions.insert( QStringLiteral( "GEOMETRY_NAME" ), new QgsVectorFileWriter::StringOption(
2504 QObject::tr( "Name for the geometry column. Defaults to wkb_geometry "
2505 "for GEOM_TYPE=geometry or the_geog for GEOM_TYPE=geography" ) ) );
2506
2507 layerOptions.insert( QStringLiteral( "SCHEMA" ), new QgsVectorFileWriter::StringOption(
2508 QObject::tr( "Name of schema into which to create the new table" ) ) );
2509
2510 layerOptions.insert( QStringLiteral( "CREATE_SCHEMA" ), new QgsVectorFileWriter::BoolOption(
2511 QObject::tr( "Whether to explicitly emit the CREATE SCHEMA statement to create the specified schema." ),
2512 true // Default value
2513 ) );
2514
2515 layerOptions.insert( QStringLiteral( "CREATE_TABLE" ), new QgsVectorFileWriter::BoolOption(
2516 QObject::tr( "Whether to explicitly recreate the table if necessary." ),
2517 true // Default value
2518 ) );
2519
2520 layerOptions.insert( QStringLiteral( "DROP_TABLE" ), new QgsVectorFileWriter::SetOption(
2521 QObject::tr( "Whether to explicitly destroy tables before recreating them." ),
2522 QStringList()
2523 << QStringLiteral( "YES" )
2524 << QStringLiteral( "NO" )
2525 << QStringLiteral( "IF_EXISTS" ),
2526 QStringLiteral( "YES" ), // Default value
2527 false // Allow None
2528 ) );
2529
2530 layerOptions.insert( QStringLiteral( "SRID" ), new QgsVectorFileWriter::StringOption(
2531 QObject::tr( "Used to force the SRID number of the SRS associated with the layer. "
2532 "When this option isn't specified and that a SRS is associated with the "
2533 "layer, a search is made in the spatial_ref_sys to find a match for the "
2534 "SRS, and, if there is no match, a new entry is inserted for the SRS in "
2535 "the spatial_ref_sys table. When the SRID option is specified, this "
2536 "search (and the eventual insertion of a new entry) will not be done: "
2537 "the specified SRID is used as such." ),
2538 QString() // Default value
2539 ) );
2540
2541 layerOptions.insert( QStringLiteral( "POSTGIS_VERSION" ), new QgsVectorFileWriter::StringOption(
2542 QObject::tr( "Can be set to 2.0 or 2.2 for PostGIS 2.0/2.2 compatibility. "
2543 "Important to set it correctly if using non-linear geometry types" ),
2544 QStringLiteral( "2.2" ) // Default value
2545 ) );
2546
2547 driverMetadata.insert( QStringLiteral( "PGDUMP" ),
2549 QStringLiteral( "PostgreSQL SQL dump" ),
2550 QObject::tr( "PostgreSQL SQL dump" ),
2551 QStringLiteral( "*.sql" ),
2552 QStringLiteral( "sql" ),
2553 datasetOptions,
2554 layerOptions,
2555 QStringLiteral( "UTF-8" )
2556 )
2557 );
2558
2559 }
2560
2561 QgsVectorFileWriterMetadataContainer( const QgsVectorFileWriterMetadataContainer &other ) = delete;
2562 QgsVectorFileWriterMetadataContainer &operator=( const QgsVectorFileWriterMetadataContainer &other ) = delete;
2563 ~QgsVectorFileWriterMetadataContainer()
2564 {
2565 for ( auto it = driverMetadata.constBegin(); it != driverMetadata.constEnd(); ++it )
2566 {
2567 for ( auto optionIt = it.value().driverOptions.constBegin(); optionIt != it.value().driverOptions.constEnd(); ++optionIt )
2568 delete optionIt.value();
2569 for ( auto optionIt = it.value().layerOptions.constBegin(); optionIt != it.value().layerOptions.constEnd(); ++optionIt )
2570 delete optionIt.value();
2571 }
2572 }
2573
2574 QMap<QString, QgsVectorFileWriter::MetaData> driverMetadata;
2575
2576};
2578
2579bool QgsVectorFileWriter::driverMetadata( const QString &driverName, QgsVectorFileWriter::MetaData &driverMetadata )
2580{
2581 static QgsVectorFileWriterMetadataContainer sDriverMetadata;
2582 QMap<QString, MetaData>::ConstIterator it = sDriverMetadata.driverMetadata.constBegin();
2583
2584 for ( ; it != sDriverMetadata.driverMetadata.constEnd(); ++it )
2585 {
2586 if ( it.key() == QLatin1String( "PGDUMP" ) &&
2587 driverName != QLatin1String( "PGDUMP" ) &&
2588 driverName != QLatin1String( "PostgreSQL SQL dump" ) )
2589 {
2590 // We do not want the 'PG' driver to be wrongly identified with PGDUMP
2591 continue;
2592 }
2593 if ( it.key().startsWith( driverName ) || it.value().longName.startsWith( driverName ) )
2594 {
2595 driverMetadata = it.value();
2596 return true;
2597 }
2598 }
2599
2600 return false;
2601}
2602
2603QStringList QgsVectorFileWriter::defaultDatasetOptions( const QString &driverName )
2604{
2605 MetaData metadata;
2606 bool ok = driverMetadata( driverName, metadata );
2607 if ( !ok )
2608 return QStringList();
2609 return concatenateOptions( metadata.driverOptions );
2610}
2611
2612QStringList QgsVectorFileWriter::defaultLayerOptions( const QString &driverName )
2613{
2614 MetaData metadata;
2615 bool ok = driverMetadata( driverName, metadata );
2616 if ( !ok )
2617 return QStringList();
2618 return concatenateOptions( metadata.layerOptions );
2619}
2620
2622{
2623
2624 OGRwkbGeometryType ogrType = static_cast<OGRwkbGeometryType>( type );
2625
2627 {
2628 ogrType = static_cast<OGRwkbGeometryType>( QgsWkbTypes::to25D( type ) );
2629 }
2630 return ogrType;
2631}
2632
2637
2639{
2640 return mErrorMessage;
2641}
2642
2644{
2645 return mOgrDriverName;
2646}
2647
2649{
2650 return mOgrDriverLongName;
2651}
2652
2654{
2655 return mCapabilities;
2656}
2657
2662
2664{
2665 QgsFeatureList::iterator fIt = features.begin();
2666 bool result = true;
2667 for ( ; fIt != features.end(); ++fIt )
2668 {
2669 result = result && addFeatureWithStyle( *fIt, nullptr, Qgis::DistanceUnit::Meters );
2670 }
2671 return result;
2672}
2673
2675{
2676 return mErrorMessage;
2677}
2678
2680{
2681 // create the feature
2682 gdal::ogr_feature_unique_ptr poFeature = createFeature( feature );
2683 if ( !poFeature )
2684 return false;
2685
2686 //add OGR feature style type
2688 {
2689 mRenderContext.expressionContext().setFeature( feature );
2690 //SymbolLayerSymbology: concatenate ogr styles of all symbollayers
2691 QgsSymbolList symbols = renderer->symbolsForFeature( feature, mRenderContext );
2692 QString styleString;
2693 QString currentStyle;
2694
2695 QgsSymbolList::const_iterator symbolIt = symbols.constBegin();
2696 for ( ; symbolIt != symbols.constEnd(); ++symbolIt )
2697 {
2698 int nSymbolLayers = ( *symbolIt )->symbolLayerCount();
2699 for ( int i = 0; i < nSymbolLayers; ++i )
2700 {
2701#if 0
2702 QMap< QgsSymbolLayer *, QString >::const_iterator it = mSymbolLayerTable.find( ( *symbolIt )->symbolLayer( i ) );
2703 if ( it == mSymbolLayerTable.constEnd() )
2704 {
2705 continue;
2706 }
2707#endif
2708 double mmsf = mmScaleFactor( mSymbologyScale, ( *symbolIt )->outputUnit(), outputUnit );
2709 double musf = mapUnitScaleFactor( mSymbologyScale, ( *symbolIt )->outputUnit(), outputUnit );
2710
2711 currentStyle = ( *symbolIt )->symbolLayer( i )->ogrFeatureStyle( mmsf, musf );//"@" + it.value();
2712
2713 switch ( mSymbologyExport )
2714 {
2716 {
2717 if ( symbolIt != symbols.constBegin() || i != 0 )
2718 {
2719 styleString.append( ';' );
2720 }
2721 styleString.append( currentStyle );
2722 break;
2723 }
2725 {
2726 OGR_F_SetStyleString( poFeature.get(), currentStyle.toLocal8Bit().constData() );
2727 if ( !writeFeature( mLayer, poFeature.get() ) )
2728 {
2729 return false;
2730 }
2731 break;
2732 }
2733
2735 break;
2736 }
2737 }
2738 }
2739 OGR_F_SetStyleString( poFeature.get(), styleString.toLocal8Bit().constData() );
2740 }
2741
2742 switch ( mSymbologyExport )
2743 {
2746 {
2747 if ( !writeFeature( mLayer, poFeature.get() ) )
2748 {
2749 return false;
2750 }
2751 break;
2752 }
2753
2755 break;
2756 }
2757
2758 return true;
2759}
2760
2761gdal::ogr_feature_unique_ptr QgsVectorFileWriter::createFeature( const QgsFeature &feature )
2762{
2763 QgsLocaleNumC l; // Make sure the decimal delimiter is a dot
2764 Q_UNUSED( l )
2765
2766 gdal::ogr_feature_unique_ptr poFeature( OGR_F_Create( OGR_L_GetLayerDefn( mLayer ) ) );
2767
2768 // attribute handling
2769 for ( QMap<int, int>::const_iterator it = mAttrIdxToOgrIdx.constBegin(); it != mAttrIdxToOgrIdx.constEnd(); ++it )
2770 {
2771 int fldIdx = it.key();
2772 int ogrField = it.value();
2773
2774 QVariant attrValue = feature.attribute( fldIdx );
2775 QgsField field = mFields.at( fldIdx );
2776
2777 if ( feature.isUnsetValue( fldIdx ) )
2778 {
2779 OGR_F_UnsetField( poFeature.get(), ogrField );
2780 continue;
2781 }
2782 else if ( QgsVariantUtils::isNull( attrValue ) )
2783 {
2784// Starting with GDAL 2.2, there are 2 concepts: unset fields and null fields
2785// whereas previously there was only unset fields. For a GeoJSON output,
2786// leaving a field unset will cause it to not appear at all in the output
2787// feature.
2788// When all features of a layer have a field unset, this would cause the
2789// field to not be present at all in the output, and thus on reading to
2790// have disappeared. #16812
2791#ifdef OGRNullMarker
2792 OGR_F_SetFieldNull( poFeature.get(), ogrField );
2793#endif
2794 continue;
2795 }
2796
2798 {
2799 field = mFieldValueConverter->fieldDefinition( field );
2800 attrValue = mFieldValueConverter->convert( fldIdx, attrValue );
2801 }
2802
2803 // Check type compatibility before passing attribute value to OGR
2804 QString errorMessage;
2805 if ( ! field.convertCompatible( attrValue, &errorMessage ) )
2806 {
2807 mErrorMessage = QObject::tr( "Error converting value (%1) for attribute field %2: %3" )
2808 .arg( feature.attribute( fldIdx ).toString(),
2809 mFields.at( fldIdx ).name(), errorMessage );
2810 QgsMessageLog::logMessage( mErrorMessage, QObject::tr( "OGR" ) );
2812 return nullptr;
2813 }
2814
2815 switch ( field.type() )
2816 {
2817 case QMetaType::Type::Int:
2818 OGR_F_SetFieldInteger( poFeature.get(), ogrField, attrValue.toInt() );
2819 break;
2820 case QMetaType::Type::LongLong:
2821 OGR_F_SetFieldInteger64( poFeature.get(), ogrField, attrValue.toLongLong() );
2822 break;
2823 case QMetaType::Type::Bool:
2824 OGR_F_SetFieldInteger( poFeature.get(), ogrField, attrValue.toInt() );
2825 break;
2826 case QMetaType::Type::QString:
2827 OGR_F_SetFieldString( poFeature.get(), ogrField, mCodec->fromUnicode( attrValue.toString() ).constData() );
2828 break;
2829 case QMetaType::Type::Double:
2830 OGR_F_SetFieldDouble( poFeature.get(), ogrField, attrValue.toDouble() );
2831 break;
2832 case QMetaType::Type::QDate:
2833 OGR_F_SetFieldDateTime( poFeature.get(), ogrField,
2834 attrValue.toDate().year(),
2835 attrValue.toDate().month(),
2836 attrValue.toDate().day(),
2837 0, 0, 0, 0 );
2838 break;
2839 case QMetaType::Type::QDateTime:
2840 if ( mOgrDriverName == QLatin1String( "ESRI Shapefile" ) )
2841 {
2842 OGR_F_SetFieldString( poFeature.get(), ogrField, mCodec->fromUnicode( attrValue.toDateTime().toString( QStringLiteral( "yyyy/MM/dd hh:mm:ss.zzz" ) ) ).constData() );
2843 }
2844 else
2845 {
2846 const QDateTime dt = attrValue.toDateTime();
2847 const QDate date = dt.date();
2848 const QTime time = dt.time();
2849 OGR_F_SetFieldDateTimeEx( poFeature.get(), ogrField,
2850 date.year(),
2851 date.month(),
2852 date.day(),
2853 time.hour(),
2854 time.minute(),
2855 static_cast<float>( time.second() + static_cast< double >( time.msec() ) / 1000 ),
2857 }
2858 break;
2859 case QMetaType::Type::QTime:
2860 if ( mOgrDriverName == QLatin1String( "ESRI Shapefile" ) )
2861 {
2862 OGR_F_SetFieldString( poFeature.get(), ogrField, mCodec->fromUnicode( attrValue.toString() ).constData() );
2863 }
2864 else
2865 {
2866 const QTime time = attrValue.toTime();
2867 OGR_F_SetFieldDateTimeEx( poFeature.get(), ogrField,
2868 0, 0, 0,
2869 time.hour(),
2870 time.minute(),
2871 static_cast<float>( time.second() + static_cast< double >( time.msec() ) / 1000 ),
2872 0 );
2873 }
2874 break;
2875
2876 case QMetaType::Type::QByteArray:
2877 {
2878 const QByteArray ba = attrValue.toByteArray();
2879 OGR_F_SetFieldBinary( poFeature.get(), ogrField, ba.size(), const_cast< GByte * >( reinterpret_cast< const GByte * >( ba.data() ) ) );
2880 break;
2881 }
2882
2883 case QMetaType::Type::UnknownType:
2884 break;
2885
2886 case QMetaType::Type::QStringList:
2887 {
2888 // handle GPKG conversion to JSON
2889 if ( mOgrDriverName == QLatin1String( "GPKG" ) )
2890 {
2891 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
2892 QString jsonString;
2893 if ( !doc.isNull() )
2894 {
2895 jsonString = QString::fromUtf8( doc.toJson( QJsonDocument::Compact ).constData() );
2896 }
2897 OGR_F_SetFieldString( poFeature.get(), ogrField, mCodec->fromUnicode( jsonString.constData() ) );
2898 break;
2899 }
2900
2901 QStringList list = attrValue.toStringList();
2902 if ( mSupportedListSubTypes.contains( QMetaType::Type::QString ) )
2903 {
2904 int count = list.count();
2905 char **lst = new char *[count + 1];
2906 if ( count > 0 )
2907 {
2908 int pos = 0;
2909 for ( const QString &string : list )
2910 {
2911 lst[pos] = CPLStrdup( mCodec->fromUnicode( string ).data() );
2912 pos++;
2913 }
2914 }
2915 lst[count] = nullptr;
2916 OGR_F_SetFieldStringList( poFeature.get(), ogrField, lst );
2917 CSLDestroy( lst );
2918 }
2919 else
2920 {
2921 OGR_F_SetFieldString( poFeature.get(), ogrField, mCodec->fromUnicode( list.join( ',' ) ).constData() );
2922 }
2923 break;
2924 }
2925
2926 case QMetaType::Type::QVariantList:
2927 // handle GPKG conversion to JSON
2928 if ( mOgrDriverName == QLatin1String( "GPKG" ) )
2929 {
2930 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
2931 QString jsonString;
2932 if ( !doc.isNull() )
2933 {
2934 jsonString = QString::fromUtf8( doc.toJson( QJsonDocument::Compact ).data() );
2935 }
2936 OGR_F_SetFieldString( poFeature.get(), ogrField, mCodec->fromUnicode( jsonString.constData() ) );
2937 break;
2938 }
2939
2940 // fall through to default for unsupported types
2941 if ( field.subType() == QMetaType::Type::QString )
2942 {
2943 QStringList list = attrValue.toStringList();
2944 if ( mSupportedListSubTypes.contains( QMetaType::Type::QString ) )
2945 {
2946 int count = list.count();
2947 char **lst = new char *[count + 1];
2948 if ( count > 0 )
2949 {
2950 int pos = 0;
2951 for ( const QString &string : list )
2952 {
2953 lst[pos] = CPLStrdup( mCodec->fromUnicode( string ).data() );
2954 pos++;
2955 }
2956 }
2957 lst[count] = nullptr;
2958 OGR_F_SetFieldStringList( poFeature.get(), ogrField, lst );
2959 CSLDestroy( lst );
2960 }
2961 else
2962 {
2963 OGR_F_SetFieldString( poFeature.get(), ogrField, mCodec->fromUnicode( list.join( ',' ) ).constData() );
2964 }
2965 break;
2966 }
2967 else if ( field.subType() == QMetaType::Type::Int )
2968 {
2969 const QVariantList list = attrValue.toList();
2970 if ( mSupportedListSubTypes.contains( QMetaType::Type::Int ) )
2971 {
2972 const int count = list.count();
2973 int *lst = new int[count];
2974 if ( count > 0 )
2975 {
2976 int pos = 0;
2977 for ( const QVariant &value : list )
2978 {
2979 lst[pos] = value.toInt();
2980 pos++;
2981 }
2982 }
2983 OGR_F_SetFieldIntegerList( poFeature.get(), ogrField, count, lst );
2984 delete [] lst;
2985 }
2986 else
2987 {
2988 QStringList strings;
2989 strings.reserve( list.size() );
2990 for ( const QVariant &value : list )
2991 {
2992 strings << QString::number( value.toInt() );
2993 }
2994 OGR_F_SetFieldString( poFeature.get(), ogrField, mCodec->fromUnicode( strings.join( ',' ) ).constData() );
2995 }
2996 break;
2997 }
2998 else if ( field.subType() == QMetaType::Type::Double )
2999 {
3000 const QVariantList list = attrValue.toList();
3001 if ( mSupportedListSubTypes.contains( QMetaType::Type::Double ) )
3002 {
3003 const int count = list.count();
3004 double *lst = new double[count];
3005 if ( count > 0 )
3006 {
3007 int pos = 0;
3008 for ( const QVariant &value : list )
3009 {
3010 lst[pos] = value.toDouble();
3011 pos++;
3012 }
3013 }
3014 OGR_F_SetFieldDoubleList( poFeature.get(), ogrField, count, lst );
3015 delete [] lst;
3016 }
3017 else
3018 {
3019 QStringList strings;
3020 strings.reserve( list.size() );
3021 for ( const QVariant &value : list )
3022 {
3023 strings << QString::number( value.toDouble() );
3024 }
3025 OGR_F_SetFieldString( poFeature.get(), ogrField, mCodec->fromUnicode( strings.join( ',' ) ).constData() );
3026 }
3027 break;
3028 }
3029 else if ( field.subType() == QMetaType::Type::LongLong )
3030 {
3031 const QVariantList list = attrValue.toList();
3032 if ( mSupportedListSubTypes.contains( QMetaType::Type::LongLong ) )
3033 {
3034 const int count = list.count();
3035 long long *lst = new long long[count];
3036 if ( count > 0 )
3037 {
3038 int pos = 0;
3039 for ( const QVariant &value : list )
3040 {
3041 lst[pos] = value.toLongLong();
3042 pos++;
3043 }
3044 }
3045 OGR_F_SetFieldInteger64List( poFeature.get(), ogrField, count, lst );
3046 delete [] lst;
3047 }
3048 else
3049 {
3050 QStringList strings;
3051 strings.reserve( list.size() );
3052 for ( const QVariant &value : list )
3053 {
3054 strings << QString::number( value.toLongLong() );
3055 }
3056 OGR_F_SetFieldString( poFeature.get(), ogrField, mCodec->fromUnicode( strings.join( ',' ) ).constData() );
3057 }
3058 break;
3059 }
3060 //intentional fall-through
3061 [[fallthrough]];
3062
3063 case QMetaType::Type::QVariantMap:
3064 {
3065 // handle GPKG conversion to JSON
3066 const char *pszDataSubTypes = GDALGetMetadataItem( OGRGetDriverByName( mOgrDriverName.toLocal8Bit().constData() ), GDAL_DMD_CREATIONFIELDDATASUBTYPES, nullptr );
3067 if ( pszDataSubTypes && strstr( pszDataSubTypes, "JSON" ) )
3068 {
3069 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
3070 QString jsonString;
3071 if ( !doc.isNull() )
3072 {
3073 const QByteArray json { doc.toJson( QJsonDocument::Compact ) };
3074 jsonString = QString::fromUtf8( json.data() );
3075 }
3076 OGR_F_SetFieldString( poFeature.get(), ogrField, mCodec->fromUnicode( jsonString.constData() ) );
3077 break;
3078 }
3079 }
3080
3081 //intentional fall-through
3082 [[fallthrough]];
3083
3084
3085 default:
3086 mErrorMessage = QObject::tr( "Invalid variant type for field %1[%2]: received %3 with type %4" )
3087 .arg( mFields.at( fldIdx ).name() )
3088 .arg( ogrField )
3089 .arg( attrValue.typeName(),
3090 attrValue.toString() );
3091 QgsMessageLog::logMessage( mErrorMessage, QObject::tr( "OGR" ) );
3093 return nullptr;
3094 }
3095 }
3096
3098 {
3099 if ( feature.hasGeometry() )
3100 {
3101 // build geometry from WKB
3102 QgsGeometry geom = feature.geometry();
3103 if ( mCoordinateTransform )
3104 {
3105 // output dataset requires coordinate transform
3106 try
3107 {
3108 geom.transform( *mCoordinateTransform );
3109 }
3110 catch ( QgsCsException & )
3111 {
3112 QgsLogger::warning( QObject::tr( "Feature geometry failed to transform" ) );
3113 return nullptr;
3114 }
3115 }
3116
3117 // turn single geometry to multi geometry if needed
3120 {
3121 geom.convertToMultiType();
3122 }
3123
3124 if ( geom.wkbType() != mWkbType )
3125 {
3126 OGRGeometryH mGeom2 = nullptr;
3127
3128 // If requested WKB type is 25D and geometry WKB type is 3D,
3129 // we must force the use of 25D.
3131 {
3132 //ND: I suspect there's a bug here, in that this is NOT converting the geometry's WKB type,
3133 //so the exported WKB has a different type to what the OGRGeometry is expecting.
3134 //possibly this is handled already in OGR, but it should be fixed regardless by actually converting
3135 //geom to the correct WKB type
3136 Qgis::WkbType wkbType = geom.wkbType();
3137 if ( wkbType >= Qgis::WkbType::PointZ && wkbType <= Qgis::WkbType::MultiPolygonZ )
3138 {
3139 Qgis::WkbType wkbType25d = static_cast<Qgis::WkbType>( static_cast< quint32>( geom.wkbType() ) - static_cast< quint32>( Qgis::WkbType::PointZ ) + static_cast<quint32>( Qgis::WkbType::Point25D ) );
3140 mGeom2 = createEmptyGeometry( wkbType25d );
3141 }
3142 }
3143
3144 // drop m/z value if not present in output wkb type
3145 if ( !QgsWkbTypes::hasZ( mWkbType ) && QgsWkbTypes::hasZ( geom.wkbType() ) )
3146 geom.get()->dropZValue();
3147 if ( !QgsWkbTypes::hasM( mWkbType ) && QgsWkbTypes::hasM( geom.wkbType() ) )
3148 geom.get()->dropMValue();
3149
3150 // add m/z values if not present in the input wkb type -- this is needed for formats which determine
3151 // geometry type based on features, e.g. geojson
3152 if ( QgsWkbTypes::hasZ( mWkbType ) && !QgsWkbTypes::hasZ( geom.wkbType() ) )
3153 {
3154 if ( mOgrDriverName == QLatin1String( "ESRI Shapefile" ) )
3155 geom.get()->addZValue( std::numeric_limits<double>::quiet_NaN() );
3156 else
3157 geom.get()->addZValue( 0 );
3158 }
3159 if ( QgsWkbTypes::hasM( mWkbType ) && !QgsWkbTypes::hasM( geom.wkbType() ) )
3160 {
3161 if ( mOgrDriverName == QLatin1String( "ESRI Shapefile" ) )
3162 geom.get()->addMValue( std::numeric_limits<double>::quiet_NaN() );
3163 else
3164 geom.get()->addMValue( 0 );
3165 }
3166
3167 if ( !mGeom2 )
3168 {
3169 // there's a problem when layer type is set as wkbtype Polygon
3170 // although there are also features of type MultiPolygon
3171 // (at least in OGR provider)
3172 // If the feature's wkbtype is different from the layer's wkbtype,
3173 // try to export it too.
3174 //
3175 // Btw. OGRGeometry must be exactly of the type of the geometry which it will receive
3176 // i.e. Polygons can't be imported to OGRMultiPolygon
3177 mGeom2 = createEmptyGeometry( geom.wkbType() );
3178 }
3179
3180 if ( !mGeom2 )
3181 {
3182 mErrorMessage = QObject::tr( "Feature geometry not imported (OGR error: %1)" )
3183 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3185 QgsMessageLog::logMessage( mErrorMessage, QObject::tr( "OGR" ) );
3186 return nullptr;
3187 }
3188
3190 if ( mOgrDriverName == QLatin1String( "ESRI Shapefile" ) )
3192
3193 QByteArray wkb( geom.asWkb( wkbFlags ) );
3194 OGRErr err = OGR_G_ImportFromWkb( mGeom2, reinterpret_cast<unsigned char *>( const_cast<char *>( wkb.constData() ) ), wkb.length() );
3195 if ( err != OGRERR_NONE )
3196 {
3197 mErrorMessage = QObject::tr( "Feature geometry not imported (OGR error: %1)" )
3198 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3200 QgsMessageLog::logMessage( mErrorMessage, QObject::tr( "OGR" ) );
3201 return nullptr;
3202 }
3203
3204 // pass ownership to geometry
3205 OGR_F_SetGeometryDirectly( poFeature.get(), mGeom2 );
3206 }
3207 else // wkb type matches
3208 {
3210 if ( mOgrDriverName == QLatin1String( "ESRI Shapefile" ) )
3212
3213 QByteArray wkb( geom.asWkb( wkbFlags ) );
3214 OGRGeometryH ogrGeom = createEmptyGeometry( mWkbType );
3215 OGRErr err = OGR_G_ImportFromWkb( ogrGeom, reinterpret_cast<unsigned char *>( const_cast<char *>( wkb.constData() ) ), wkb.length() );
3216 if ( err != OGRERR_NONE )
3217 {
3218 mErrorMessage = QObject::tr( "Feature geometry not imported (OGR error: %1)" )
3219 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3221 QgsMessageLog::logMessage( mErrorMessage, QObject::tr( "OGR" ) );
3222 return nullptr;
3223 }
3224
3225 // set geometry (ownership is passed to OGR)
3226 OGR_F_SetGeometryDirectly( poFeature.get(), ogrGeom );
3227 }
3228 }
3229 else
3230 {
3231 OGR_F_SetGeometryDirectly( poFeature.get(), createEmptyGeometry( mWkbType ) );
3232 }
3233 }
3234 return poFeature;
3235}
3236
3237void QgsVectorFileWriter::resetMap( const QgsAttributeList &attributes )
3238{
3239 QMap<int, int> omap( mAttrIdxToOgrIdx );
3240 mAttrIdxToOgrIdx.clear();
3241 for ( int i = 0; i < attributes.size(); i++ )
3242 {
3243 if ( omap.find( i ) != omap.end() )
3244 mAttrIdxToOgrIdx.insert( attributes[i], omap[i] );
3245 }
3246}
3247
3248bool QgsVectorFileWriter::writeFeature( OGRLayerH layer, OGRFeatureH feature )
3249{
3250 if ( OGR_L_CreateFeature( layer, feature ) != OGRERR_NONE )
3251 {
3252 mErrorMessage = QObject::tr( "Feature creation error (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3254 QgsMessageLog::logMessage( mErrorMessage, QObject::tr( "OGR" ) );
3255 return false;
3256 }
3257 return true;
3258}
3259
3261{
3262 if ( mUsingTransaction )
3263 {
3264 if ( OGRERR_NONE != OGR_L_CommitTransaction( mLayer ) )
3265 {
3266 QgsDebugError( QStringLiteral( "Error while committing transaction on OGRLayer." ) );
3267 }
3268 }
3269 mDS.reset();
3270
3271 if ( mOgrRef )
3272 {
3273 OSRRelease( mOgrRef );
3274 }
3275}
3276
3279 const QString &fileName,
3280 const QString &fileEncoding,
3281 const QgsCoordinateReferenceSystem &destCRS,
3282 const QString &driverName,
3283 bool onlySelected,
3284 QString *errorMessage,
3285 const QStringList &datasourceOptions,
3286 const QStringList &layerOptions,
3287 bool skipAttributeCreation,
3288 QString *newFilename,
3289 Qgis::FeatureSymbologyExport symbologyExport,
3290 double symbologyScale,
3291 const QgsRectangle *filterExtent,
3292 Qgis::WkbType overrideGeometryType,
3293 bool forceMulti,
3294 bool includeZ,
3295 const QgsAttributeList &attributes,
3296 FieldValueConverter *fieldValueConverter,
3297 QString *newLayer )
3298{
3300 if ( destCRS.isValid() && layer )
3301 {
3302 ct = QgsCoordinateTransform( layer->crs(), destCRS, layer->transformContext() );
3303 }
3304
3305 SaveVectorOptions options;
3306 options.fileEncoding = fileEncoding;
3307 options.ct = ct;
3308 options.driverName = driverName;
3309 options.onlySelectedFeatures = onlySelected;
3310 options.datasourceOptions = datasourceOptions;
3311 options.layerOptions = layerOptions;
3312 options.skipAttributeCreation = skipAttributeCreation;
3315 if ( filterExtent )
3316 options.filterExtent = *filterExtent;
3317 options.overrideGeometryType = overrideGeometryType;
3318 options.forceMulti = forceMulti;
3319 options.includeZ = includeZ;
3320 options.attributes = attributes;
3321 options.fieldValueConverter = fieldValueConverter;
3322 return writeAsVectorFormatV3( layer, fileName, layer->transformContext(), options, errorMessage, newFilename, newLayer );
3323}
3324
3326 const QString &fileName,
3327 const QString &fileEncoding,
3328 const QgsCoordinateTransform &ct,
3329 const QString &driverName,
3330 bool onlySelected,
3331 QString *errorMessage,
3332 const QStringList &datasourceOptions,
3333 const QStringList &layerOptions,
3334 bool skipAttributeCreation,
3335 QString *newFilename,
3336 Qgis::FeatureSymbologyExport symbologyExport,
3337 double symbologyScale,
3338 const QgsRectangle *filterExtent,
3339 Qgis::WkbType overrideGeometryType,
3340 bool forceMulti,
3341 bool includeZ,
3342 const QgsAttributeList &attributes,
3343 FieldValueConverter *fieldValueConverter,
3344 QString *newLayer )
3345{
3346 SaveVectorOptions options;
3347 options.fileEncoding = fileEncoding;
3348 options.ct = ct;
3349 options.driverName = driverName;
3350 options.onlySelectedFeatures = onlySelected;
3351 options.datasourceOptions = datasourceOptions;
3352 options.layerOptions = layerOptions;
3353 options.skipAttributeCreation = skipAttributeCreation;
3356 if ( filterExtent )
3357 options.filterExtent = *filterExtent;
3358 options.overrideGeometryType = overrideGeometryType;
3359 options.forceMulti = forceMulti;
3360 options.includeZ = includeZ;
3361 options.attributes = attributes;
3362 options.fieldValueConverter = fieldValueConverter;
3363 return writeAsVectorFormatV3( layer, fileName, layer->transformContext(), options, errorMessage, newFilename, newLayer );
3364}
3365
3366
3368 : driverName( QStringLiteral( "GPKG" ) )
3369{
3370}
3371
3372
3373
3374QgsVectorFileWriter::WriterError QgsVectorFileWriter::prepareWriteAsVectorFormat( QgsVectorLayer *layer, const QgsVectorFileWriter::SaveVectorOptions &options, QgsVectorFileWriter::PreparedWriterDetails &details )
3375{
3376 if ( !layer || !layer->isValid() )
3377 {
3378 return ErrInvalidLayer;
3379 }
3380
3381 if ( layer->renderer() )
3382 details.renderer.reset( layer->renderer()->clone() );
3383 details.sourceCrs = layer->crs();
3384 details.sourceWkbType = layer->wkbType();
3385 details.sourceFields = layer->fields();
3386 details.providerType = layer->providerType();
3387 details.featureCount = options.onlySelectedFeatures ? layer->selectedFeatureCount() : layer->featureCount();
3388 if ( layer->dataProvider() )
3389 details.dataSourceUri = layer->dataProvider()->dataSourceUri();
3390 details.storageType = layer->storageType();
3391 details.selectedFeatureIds = layer->selectedFeatureIds();
3392 details.providerUriParams = QgsProviderRegistry::instance()->decodeUri( layer->providerType(), layer->dataProvider()->dataSourceUri() );
3393
3394 if ( details.storageType == QLatin1String( "ESRI Shapefile" ) )
3395 {
3397 if ( options.onlySelectedFeatures )
3398 {
3399 req.setFilterFids( details.selectedFeatureIds );
3400 }
3401 req.setNoAttributes();
3402 details.geometryTypeScanIterator = layer->getFeatures( req );
3403 }
3404
3405 details.expressionContext = QgsExpressionContext( QgsExpressionContextUtils::globalProjectLayerScopes( layer ) );
3406 details.renderContext.setExpressionContext( details.expressionContext );
3407 details.renderContext.setRendererScale( options.symbologyScale );
3408
3409 details.shallTransform = false;
3410 if ( options.ct.isValid() )
3411 {
3412 // This means we should transform
3413 details.outputCrs = options.ct.destinationCrs();
3414 details.shallTransform = true;
3415 }
3416 else
3417 {
3418 // This means we shouldn't transform, use source CRS as output (if defined)
3419 details.outputCrs = details.sourceCrs;
3420 }
3421
3422 details.destWkbType = details.sourceWkbType;
3424 {
3425 details.destWkbType = QgsWkbTypes::flatType( options.overrideGeometryType );
3426 if ( QgsWkbTypes::hasZ( options.overrideGeometryType ) || options.includeZ )
3427 details.destWkbType = QgsWkbTypes::addZ( details.destWkbType );
3428 }
3429 if ( options.forceMulti )
3430 {
3431 details.destWkbType = QgsWkbTypes::multiType( details.destWkbType );
3432 }
3433
3434 details.attributes = options.attributes;
3435 if ( options.skipAttributeCreation )
3436 details.attributes.clear();
3437 else if ( details.attributes.isEmpty() )
3438 {
3439 const QgsAttributeList allAttributes = details.sourceFields.allAttributesList();
3440 for ( int idx : allAttributes )
3441 {
3442 QgsField fld = details.sourceFields.at( idx );
3443 if ( details.providerType == QLatin1String( "oracle" ) && fld.typeName().contains( QLatin1String( "SDO_GEOMETRY" ) ) )
3444 continue;
3445 details.attributes.append( idx );
3446 }
3447 }
3448
3449 if ( !details.attributes.isEmpty() )
3450 {
3451 for ( int attrIdx : std::as_const( details.attributes ) )
3452 {
3453 if ( details.sourceFields.exists( attrIdx ) )
3454 {
3455 QgsField field = details.sourceFields.at( attrIdx );
3456 field.setName( options.attributesExportNames.value( attrIdx, field.name() ) );
3457 details.outputFields.append( field );
3458 }
3459 else
3460 {
3461 QgsDebugError( QStringLiteral( "No such source field with index '%1' available." ).arg( attrIdx ) );
3462 }
3463 }
3464 }
3465
3466 // not ideal - would be nice to avoid this happening in the preparation step if possible,
3467 // but currently requires access to the layer's minimumValue/maximumValue methods
3468 if ( details.providerType == QLatin1String( "spatialite" ) )
3469 {
3470 for ( int i = 0; i < details.outputFields.size(); i++ )
3471 {
3472 if ( details.outputFields.at( i ).type() == QMetaType::Type::LongLong )
3473 {
3474 QVariant min;
3475 QVariant max;
3476 layer->minimumAndMaximumValue( i, min, max );
3477 if ( std::max( std::llabs( min.toLongLong() ), std::llabs( max.toLongLong() ) ) < std::numeric_limits<int>::max() )
3478 {
3479 details.outputFields[i].setType( QMetaType::Type::Int );
3480 }
3481 }
3482 }
3483 }
3484
3485
3486 //add possible attributes needed by renderer
3487 addRendererAttributes( details.renderer.get(), details.renderContext, details.sourceFields, details.attributes );
3488
3490 req.setSubsetOfAttributes( details.attributes );
3491 if ( options.onlySelectedFeatures )
3492 req.setFilterFids( details.selectedFeatureIds );
3493
3494 if ( !options.filterExtent.isNull() )
3495 {
3496 QgsRectangle filterRect = options.filterExtent;
3497 bool useFilterRect = true;
3498 if ( details.shallTransform )
3499 {
3500 try
3501 {
3502 // map filter rect back from destination CRS to layer CRS
3503 QgsCoordinateTransform extentTransform = options.ct;
3504 extentTransform.setBallparkTransformsAreAppropriate( true );
3505 filterRect = extentTransform.transformBoundingBox( filterRect, Qgis::TransformDirection::Reverse );
3506 }
3507 catch ( QgsCsException & )
3508 {
3509 useFilterRect = false;
3510 }
3511 }
3512 if ( useFilterRect )
3513 {
3514 req.setFilterRect( filterRect );
3515 }
3516 details.filterRectGeometry = QgsGeometry::fromRect( options.filterExtent );
3517 details.filterRectEngine.reset( QgsGeometry::createGeometryEngine( details.filterRectGeometry.constGet() ) );
3518 details.filterRectEngine->prepareGeometry();
3519 }
3520 details.sourceFeatureIterator = layer->getFeatures( req );
3521
3522 if ( !options.sourceDatabaseProviderConnection )
3523 {
3524 details.sourceDatabaseProviderConnection.reset( QgsMapLayerUtils::databaseConnection( layer ) );
3525 }
3526
3527 return NoError;
3528}
3529
3530QgsVectorFileWriter::WriterError QgsVectorFileWriter::writeAsVectorFormat( PreparedWriterDetails &details, const QString &fileName, const QgsVectorFileWriter::SaveVectorOptions &options, QString *newFilename, QString *errorMessage, QString *newLayer )
3531{
3532 return writeAsVectorFormatV2( details, fileName, QgsCoordinateTransformContext(), options, newFilename, newLayer, errorMessage );
3533}
3534
3535QgsVectorFileWriter::WriterError QgsVectorFileWriter::writeAsVectorFormatV2( PreparedWriterDetails &details, const QString &fileName, const QgsCoordinateTransformContext &transformContext, const QgsVectorFileWriter::SaveVectorOptions &options, QString *newFilename, QString *newLayer, QString *errorMessage, SinkFlags sinkFlags )
3536{
3537 Qgis::WkbType destWkbType = details.destWkbType;
3538
3539 int lastProgressReport = 0;
3540 long long total = details.featureCount;
3541
3542 // Special rules for OGR layers
3543 if ( details.providerType == QLatin1String( "ogr" ) && !details.dataSourceUri.isEmpty() )
3544 {
3545 QString srcFileName( details.providerUriParams.value( QStringLiteral( "path" ) ).toString() );
3546 if ( QFile::exists( srcFileName ) && QFileInfo( fileName ).canonicalFilePath() == QFileInfo( srcFileName ).canonicalFilePath() )
3547 {
3548 // Check the layer name too if it's a GPKG/SpatiaLite/SQLite OGR driver (pay attention: camel case in layerName)
3549 QgsDataSourceUri uri( details.dataSourceUri );
3550 if ( !( ( options.driverName == QLatin1String( "GPKG" ) ||
3551 options.driverName == QLatin1String( "SpatiaLite" ) ||
3552 options.driverName == QLatin1String( "SQLite" ) ) &&
3553 options.layerName != details.providerUriParams.value( QStringLiteral( "layerName" ) ) ) )
3554 {
3555 if ( errorMessage )
3556 *errorMessage = QObject::tr( "Cannot overwrite an OGR layer in place" );
3557 return ErrCreateDataSource;
3558 }
3559 }
3560
3561 // Shapefiles might contain multi types although wkbType() only reports singles
3562 if ( details.storageType == QLatin1String( "ESRI Shapefile" ) && !QgsWkbTypes::isMultiType( destWkbType ) )
3563 {
3564 QgsFeatureIterator fit = details.geometryTypeScanIterator;
3565 QgsFeature fet;
3566 long scanned = 0;
3567 while ( fit.nextFeature( fet ) )
3568 {
3569 if ( options.feedback && options.feedback->isCanceled() )
3570 {
3571 return Canceled;
3572 }
3573 if ( options.feedback )
3574 {
3575 //dedicate first 5% of progress bar to this scan
3576 int newProgress = static_cast<int>( ( 5.0 * scanned ) / total );
3577 if ( newProgress != lastProgressReport )
3578 {
3579 lastProgressReport = newProgress;
3580 options.feedback->setProgress( lastProgressReport );
3581 }
3582 }
3583
3584 if ( fet.hasGeometry() && QgsWkbTypes::isMultiType( fet.geometry().wkbType() ) )
3585 {
3586 destWkbType = QgsWkbTypes::multiType( destWkbType );
3587 break;
3588 }
3589 scanned++;
3590 }
3591 }
3592 }
3593
3594 QString tempNewFilename;
3595 QString tempNewLayer;
3596
3597 QgsVectorFileWriter::SaveVectorOptions newOptions = options;
3598 if ( !newOptions.sourceDatabaseProviderConnection )
3599 {
3600 newOptions.sourceDatabaseProviderConnection = details.sourceDatabaseProviderConnection.get();
3601 }
3602
3603 std::unique_ptr< QgsVectorFileWriter > writer( create( fileName, details.outputFields, destWkbType, details.outputCrs, transformContext, newOptions, sinkFlags, &tempNewFilename, &tempNewLayer ) );
3604 writer->setSymbologyScale( options.symbologyScale );
3605
3606 if ( newFilename )
3607 *newFilename = tempNewFilename;
3608
3609 if ( newLayer )
3610 *newLayer = tempNewLayer;
3611
3612 if ( newFilename )
3613 {
3614 QgsDebugMsgLevel( "newFilename = " + *newFilename, 2 );
3615 }
3616
3617 // check whether file creation was successful
3618 WriterError err = writer->hasError();
3619 if ( err != NoError )
3620 {
3621 if ( errorMessage )
3622 *errorMessage = writer->errorMessage();
3623 return err;
3624 }
3625
3626 if ( errorMessage )
3627 {
3628 errorMessage->clear();
3629 }
3630
3631 QgsFeature fet;
3632
3633 //create symbol table if needed
3634 if ( writer->symbologyExport() != Qgis::FeatureSymbologyExport::NoSymbology )
3635 {
3636 //writer->createSymbolLayerTable( layer, writer->mDS );
3637 }
3638
3639 switch ( writer->symbologyExport() )
3640 {
3642 {
3643 QgsFeatureRenderer *r = details.renderer.get();
3645 && r->usingSymbolLevels() )
3646 {
3647 QgsVectorFileWriter::WriterError error = writer->exportFeaturesSymbolLevels( details, details.sourceFeatureIterator, options.ct, errorMessage );
3648 return ( error == NoError ) ? NoError : ErrFeatureWriteFailed;
3649 }
3650 break;
3651 }
3654 break;
3655 }
3656
3657 int n = 0, errors = 0;
3658
3659 //unit type
3660 Qgis::DistanceUnit mapUnits = details.sourceCrs.mapUnits();
3661 if ( options.ct.isValid() )
3662 {
3663 mapUnits = options.ct.destinationCrs().mapUnits();
3664 }
3665
3666 writer->startRender( details.renderer.get(), details.sourceFields );
3667
3668 writer->resetMap( details.attributes );
3669 // Reset mFields to layer fields, and not just exported fields
3670 writer->mFields = details.sourceFields;
3671
3672 // write all features
3673 long saved = 0;
3674 int initialProgress = lastProgressReport;
3675 while ( details.sourceFeatureIterator.nextFeature( fet ) )
3676 {
3677 if ( options.feedback && options.feedback->isCanceled() )
3678 {
3679 return Canceled;
3680 }
3681
3682 saved++;
3683 if ( options.feedback )
3684 {
3685 //avoid spamming progress reports
3686 int newProgress = static_cast<int>( initialProgress + ( ( 100.0 - initialProgress ) * saved ) / total );
3687 if ( newProgress < 100 && newProgress != lastProgressReport )
3688 {
3689 lastProgressReport = newProgress;
3690 options.feedback->setProgress( lastProgressReport );
3691 }
3692 }
3693
3694 if ( details.shallTransform )
3695 {
3696 try
3697 {
3698 if ( fet.hasGeometry() )
3699 {
3700 QgsGeometry g = fet.geometry();
3701 g.transform( options.ct );
3702 fet.setGeometry( g );
3703 }
3704 }
3705 catch ( QgsCsException &e )
3706 {
3707 const QString msg = QObject::tr( "Failed to transform feature with ID '%1'. Writing stopped. (Exception: %2)" )
3708 .arg( fet.id() ).arg( e.what() );
3709 QgsLogger::warning( msg );
3710 if ( errorMessage )
3711 *errorMessage = msg;
3712
3713 return ErrProjection;
3714 }
3715 }
3716
3717 if ( fet.hasGeometry() && details.filterRectEngine && !details.filterRectEngine->intersects( fet.geometry().constGet() ) )
3718 continue;
3719
3720 if ( details.attributes.empty() && options.skipAttributeCreation )
3721 {
3722 fet.initAttributes( 0 );
3723 }
3724
3725 if ( !writer->addFeatureWithStyle( fet, writer->mRenderer.get(), mapUnits ) )
3726 {
3727 WriterError err = writer->hasError();
3728 if ( err != NoError && errorMessage )
3729 {
3730 if ( errorMessage->isEmpty() )
3731 {
3732 *errorMessage = QObject::tr( "Feature write errors:" );
3733 }
3734 *errorMessage += '\n' + writer->errorMessage();
3735 }
3736 errors++;
3737
3738 if ( errors > 1000 )
3739 {
3740 if ( errorMessage )
3741 {
3742 *errorMessage += QObject::tr( "Stopping after %n error(s)", nullptr, errors );
3743 }
3744
3745 n = -1;
3746 break;
3747 }
3748 }
3749 n++;
3750 }
3751
3752 writer->stopRender();
3753
3754 if ( errors > 0 && errorMessage && n > 0 )
3755 {
3756 *errorMessage += QObject::tr( "\nOnly %1 of %2 features written." ).arg( n - errors ).arg( n );
3757 }
3758
3759 writer.reset();
3760
3761 bool metadataFailure = false;
3762 if ( options.saveMetadata )
3763 {
3764 QString uri = QgsProviderRegistry::instance()->encodeUri( QStringLiteral( "ogr" ), QVariantMap
3765 {
3766 {QStringLiteral( "path" ), tempNewFilename },
3767 {QStringLiteral( "layerName" ), tempNewLayer }
3768 } );
3769
3770 try
3771 {
3772 QString error;
3773 if ( !QgsProviderRegistry::instance()->saveLayerMetadata( QStringLiteral( "ogr" ), uri, options.layerMetadata, error ) )
3774 {
3775 if ( errorMessage )
3776 {
3777 if ( !errorMessage->isEmpty() )
3778 *errorMessage += '\n';
3779 *errorMessage += error;
3780 }
3781 metadataFailure = true;
3782 }
3783 }
3784 catch ( QgsNotSupportedException &e )
3785 {
3786 if ( errorMessage )
3787 {
3788 if ( !errorMessage->isEmpty() )
3789 *errorMessage += '\n';
3790 *errorMessage += e.what();
3791 }
3792 metadataFailure = true;
3793 }
3794 }
3795
3796 return errors == 0 ? ( !metadataFailure ? NoError : ErrSavingMetadata ) : ErrFeatureWriteFailed;
3797}
3798
3800 const QString &fileName,
3801 const SaveVectorOptions &options,
3802 QString *newFilename,
3803 QString *errorMessage,
3804 QString *newLayer )
3805{
3806 QgsVectorFileWriter::PreparedWriterDetails details;
3807 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3808 if ( err != NoError )
3809 return err;
3810
3811 return writeAsVectorFormatV2( details, fileName, layer->transformContext(), options, newFilename, newLayer, errorMessage );
3812}
3813
3815 const QString &fileName,
3816 const QgsCoordinateTransformContext &transformContext,
3817 const SaveVectorOptions &options,
3818 QString *newFilename,
3819 QString *newLayer,
3820 QString *errorMessage )
3821{
3822 QgsVectorFileWriter::PreparedWriterDetails details;
3823 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3824 if ( err != NoError )
3825 return err;
3826
3827 return writeAsVectorFormatV2( details, fileName, transformContext, options, newFilename, newLayer, errorMessage );
3828}
3829
3830QgsVectorFileWriter::WriterError QgsVectorFileWriter::writeAsVectorFormatV3( QgsVectorLayer *layer, const QString &fileName, const QgsCoordinateTransformContext &transformContext, const QgsVectorFileWriter::SaveVectorOptions &options, QString *errorMessage, QString *newFilename, QString *newLayer )
3831{
3832 QgsVectorFileWriter::PreparedWriterDetails details;
3833 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3834 if ( err != NoError )
3835 return err;
3836
3837 return writeAsVectorFormatV2( details, fileName, transformContext, options, newFilename, newLayer, errorMessage );
3838}
3839
3840bool QgsVectorFileWriter::deleteShapeFile( const QString &fileName )
3841{
3842 QFileInfo fi( fileName );
3843 QDir dir = fi.dir();
3844
3845 QStringList filter;
3846 for ( const char *suffix : { ".shp", ".shx", ".dbf", ".prj", ".qix", ".qpj", ".cpg", ".sbn", ".sbx", ".idm", ".ind" } )
3847 {
3848 filter << fi.completeBaseName() + suffix;
3849 }
3850
3851 bool ok = true;
3852 const auto constEntryList = dir.entryList( filter );
3853 for ( const QString &file : constEntryList )
3854 {
3855 QFile f( dir.canonicalPath() + '/' + file );
3856 if ( !f.remove() )
3857 {
3858 QgsDebugError( QStringLiteral( "Removing file %1 failed: %2" ).arg( file, f.errorString() ) );
3859 ok = false;
3860 }
3861 }
3862
3863 return ok;
3864}
3865
3867{
3868 mSymbologyScale = d;
3869 mRenderContext.setRendererScale( mSymbologyScale );
3870}
3871
3873{
3874 QStringList driverNames;
3875 const QSet< QString > multiLayerExtensions = qgis::listToSet( QgsGdalUtils::multiLayerFileExtensions() );
3876
3877 for ( int i = 0; i < GDALGetDriverCount(); ++i )
3878 {
3879 GDALDriverH driver = GDALGetDriver( i );
3880 if ( !driver )
3881 {
3882 QgsLogger::warning( "unable to get driver " + QString::number( i ) );
3883 continue;
3884 }
3885
3886 const QString driverExtensions = GDALGetMetadataItem( driver, GDAL_DMD_EXTENSIONS, "" );
3887 if ( driverExtensions.isEmpty() )
3888 continue;
3889
3890 const QSet< QString > splitExtensions = qgis::listToSet( driverExtensions.split( ' ', Qt::SkipEmptyParts ) );
3891 if ( splitExtensions.intersects( multiLayerExtensions ) )
3892 {
3893 driverNames << GDALGetDescription( driver );
3894 }
3895 }
3896 return driverNames;
3897}
3898
3899QList< QgsVectorFileWriter::FilterFormatDetails > QgsVectorFileWriter::supportedFiltersAndFormats( const VectorFormatOptions options )
3900{
3901 static QReadWriteLock sFilterLock;
3902 static QMap< VectorFormatOptions, QList< QgsVectorFileWriter::FilterFormatDetails > > sFilters;
3903
3904 QgsReadWriteLocker locker( sFilterLock, QgsReadWriteLocker::Read );
3905
3906 const auto it = sFilters.constFind( options );
3907 if ( it != sFilters.constEnd() )
3908 return it.value();
3909
3911 QList< QgsVectorFileWriter::FilterFormatDetails > results;
3912
3914 int const drvCount = OGRGetDriverCount();
3915
3916 const QStringList multiLayerDrivers = multiLayerFormats();
3917
3918 for ( int i = 0; i < drvCount; ++i )
3919 {
3920 OGRSFDriverH drv = OGRGetDriver( i );
3921 if ( drv )
3922 {
3923 const QString drvName = GDALGetDescription( drv );
3924
3925 if ( options & SupportsMultipleLayers )
3926 {
3927 if ( !multiLayerDrivers.contains( drvName ) )
3928 continue;
3929 }
3930
3931 GDALDriverH gdalDriver = GDALGetDriverByName( drvName.toLocal8Bit().constData() );
3932 bool nonSpatialFormat = false;
3933 if ( gdalDriver )
3934 {
3935 nonSpatialFormat = GDALGetMetadataItem( gdalDriver, GDAL_DCAP_NONSPATIAL, nullptr );
3936 }
3937
3938 if ( OGR_Dr_TestCapability( drv, "CreateDataSource" ) != 0 )
3939 {
3940 if ( options & SkipNonSpatialFormats )
3941 {
3942 // skip non-spatial formats
3943 if ( nonSpatialFormat )
3944 continue;
3945 }
3946
3947 QString filterString = filterForDriver( drvName );
3948 if ( filterString.isEmpty() )
3949 continue;
3950
3951 MetaData metadata;
3952 QStringList globs;
3953 if ( driverMetadata( drvName, metadata ) && !metadata.glob.isEmpty() )
3954 {
3955 globs = metadata.glob.toLower().split( ' ' );
3956 }
3957
3958 FilterFormatDetails details;
3959 details.driverName = drvName;
3960 details.filterString = filterString;
3961 details.globs = globs;
3962
3963 results << details;
3964 }
3965 }
3966 }
3967
3968 std::sort( results.begin(), results.end(), [options]( const FilterFormatDetails & a, const FilterFormatDetails & b ) -> bool
3969 {
3970 if ( options & SortRecommended )
3971 {
3972 if ( a.driverName == QLatin1String( "GPKG" ) )
3973 return true; // Make https://twitter.com/shapefiIe a sad little fellow
3974 else if ( b.driverName == QLatin1String( "GPKG" ) )
3975 return false;
3976 else if ( a.driverName == QLatin1String( "ESRI Shapefile" ) )
3977 return true;
3978 else if ( b.driverName == QLatin1String( "ESRI Shapefile" ) )
3979 return false;
3980 }
3981
3982 return a.filterString.toLower().localeAwareCompare( b.filterString.toLower() ) < 0;
3983 } );
3984
3985 sFilters.insert( options, results );
3986 return results;
3987}
3988
3990{
3991 const auto formats = supportedFiltersAndFormats( options );
3992 QSet< QString > extensions;
3993
3994 const thread_local QRegularExpression rx( QStringLiteral( "\\*\\.(.*)$" ) );
3995
3996 for ( const FilterFormatDetails &format : formats )
3997 {
3998 for ( const QString &glob : format.globs )
3999 {
4000 const QRegularExpressionMatch match = rx.match( glob );
4001 if ( !match.hasMatch() )
4002 continue;
4003
4004 const QString matched = match.captured( 1 );
4005 extensions.insert( matched );
4006 }
4007 }
4008
4009 QStringList extensionList( extensions.constBegin(), extensions.constEnd() );
4010
4011 std::sort( extensionList.begin(), extensionList.end(), [options]( const QString & a, const QString & b ) -> bool
4012 {
4013 if ( options & SortRecommended )
4014 {
4015 if ( a == QLatin1String( "gpkg" ) )
4016 return true; // Make https://twitter.com/shapefiIe a sad little fellow
4017 else if ( b == QLatin1String( "gpkg" ) )
4018 return false;
4019 else if ( a == QLatin1String( "shp" ) )
4020 return true;
4021 else if ( b == QLatin1String( "shp" ) )
4022 return false;
4023 }
4024
4025 return a.toLower().localeAwareCompare( b.toLower() ) < 0;
4026 } );
4027
4028 return extensionList;
4029}
4030
4031QList< QgsVectorFileWriter::DriverDetails > QgsVectorFileWriter::ogrDriverList( const VectorFormatOptions options )
4032{
4033 QList< QgsVectorFileWriter::DriverDetails > results;
4034
4036 const int drvCount = OGRGetDriverCount();
4037
4038 const QStringList multiLayerDrivers = multiLayerFormats();
4039
4040 QStringList writableDrivers;
4041 for ( int i = 0; i < drvCount; ++i )
4042 {
4043 OGRSFDriverH drv = OGRGetDriver( i );
4044 if ( drv )
4045 {
4046 const QString drvName = GDALGetDescription( drv );
4047
4048 if ( options & SupportsMultipleLayers )
4049 {
4050 if ( !multiLayerDrivers.contains( drvName ) )
4051 continue;
4052 }
4053
4054 if ( options & SkipNonSpatialFormats )
4055 {
4056 // skip non-spatial formats
4057 // TODO - use GDAL metadata to determine this, when support exists in GDAL
4058 if ( drvName == QLatin1String( "ODS" ) || drvName == QLatin1String( "XLSX" ) || drvName == QLatin1String( "XLS" ) )
4059 continue;
4060 }
4061
4062 if ( drvName == QLatin1String( "ESRI Shapefile" ) )
4063 {
4064 writableDrivers << QStringLiteral( "DBF file" );
4065 }
4066 if ( OGR_Dr_TestCapability( drv, "CreateDataSource" ) != 0 )
4067 {
4068 // Add separate format for Mapinfo MIF (MITAB is OGR default)
4069 if ( drvName == QLatin1String( "MapInfo File" ) )
4070 {
4071 writableDrivers << QStringLiteral( "MapInfo MIF" );
4072 }
4073 else if ( drvName == QLatin1String( "SQLite" ) )
4074 {
4075 // Unfortunately it seems that there is no simple way to detect if
4076 // OGR SQLite driver is compiled with SpatiaLite support.
4077 // We have HAVE_SPATIALITE in QGIS, but that may differ from OGR
4078 // http://lists.osgeo.org/pipermail/gdal-dev/2012-November/034580.html
4079 // -> test if creation fails
4080 QString option = QStringLiteral( "SPATIALITE=YES" );
4081 char *options[2] = { CPLStrdup( option.toLocal8Bit().constData() ), nullptr };
4082 OGRSFDriverH poDriver;
4084 poDriver = OGRGetDriverByName( drvName.toLocal8Bit().constData() );
4085 if ( poDriver )
4086 {
4087 gdal::ogr_datasource_unique_ptr ds( OGR_Dr_CreateDataSource( poDriver, QStringLiteral( "/vsimem/spatialitetest.sqlite" ).toUtf8().constData(), options ) );
4088 if ( ds )
4089 {
4090 writableDrivers << QStringLiteral( "SpatiaLite" );
4091 OGR_Dr_DeleteDataSource( poDriver, QStringLiteral( "/vsimem/spatialitetest.sqlite" ).toUtf8().constData() );
4092 }
4093 }
4094 CPLFree( options[0] );
4095 }
4096 writableDrivers << drvName;
4097 }
4098 }
4099 }
4100
4101 results.reserve( writableDrivers.count() );
4102 for ( const QString &drvName : std::as_const( writableDrivers ) )
4103 {
4104 MetaData metadata;
4105 if ( driverMetadata( drvName, metadata ) && !metadata.trLongName.isEmpty() )
4106 {
4107 DriverDetails details;
4108 details.driverName = drvName;
4109 details.longName = metadata.trLongName;
4110 results << details;
4111 }
4112 }
4113
4114 std::sort( results.begin(), results.end(), [options]( const DriverDetails & a, const DriverDetails & b ) -> bool
4115 {
4116 if ( options & SortRecommended )
4117 {
4118 if ( a.driverName == QLatin1String( "GPKG" ) )
4119 return true; // Make https://twitter.com/shapefiIe a sad little fellow
4120 else if ( b.driverName == QLatin1String( "GPKG" ) )
4121 return false;
4122 else if ( a.driverName == QLatin1String( "ESRI Shapefile" ) )
4123 return true;
4124 else if ( b.driverName == QLatin1String( "ESRI Shapefile" ) )
4125 return false;
4126 }
4127
4128 return a.longName.toLower().localeAwareCompare( b.longName.toLower() ) < 0;
4129 } );
4130 return results;
4131}
4132
4133QString QgsVectorFileWriter::driverForExtension( const QString &extension )
4134{
4135 QString ext = extension.trimmed();
4136 if ( ext.isEmpty() )
4137 return QString();
4138
4139 if ( ext.startsWith( '.' ) )
4140 ext.remove( 0, 1 );
4141
4142 GDALAllRegister();
4143 int const drvCount = GDALGetDriverCount();
4144
4145 for ( int i = 0; i < drvCount; ++i )
4146 {
4147 GDALDriverH drv = GDALGetDriver( i );
4148 if ( drv )
4149 {
4150 char **driverMetadata = GDALGetMetadata( drv, nullptr );
4151 if ( CSLFetchBoolean( driverMetadata, GDAL_DCAP_CREATE, false ) && CSLFetchBoolean( driverMetadata, GDAL_DCAP_VECTOR, false ) )
4152 {
4153 QString drvName = GDALGetDriverShortName( drv );
4154 QStringList driverExtensions = QString( GDALGetMetadataItem( drv, GDAL_DMD_EXTENSIONS, nullptr ) ).split( ' ' );
4155
4156 const auto constDriverExtensions = driverExtensions;
4157 for ( const QString &driver : constDriverExtensions )
4158 {
4159 if ( driver.compare( ext, Qt::CaseInsensitive ) == 0 )
4160 return drvName;
4161 }
4162 }
4163 }
4164 }
4165 return QString();
4166}
4167
4169{
4170 QString filterString;
4171 const auto driverFormats = supportedFiltersAndFormats( options );
4172 for ( const FilterFormatDetails &details : driverFormats )
4173 {
4174 if ( !filterString.isEmpty() )
4175 filterString += QLatin1String( ";;" );
4176
4177 filterString += details.filterString;
4178 }
4179 return filterString;
4180}
4181
4182QString QgsVectorFileWriter::filterForDriver( const QString &driverName )
4183{
4184 MetaData metadata;
4185 if ( !driverMetadata( driverName, metadata ) || metadata.trLongName.isEmpty() || metadata.glob.isEmpty() )
4186 return QString();
4187
4188 return QStringLiteral( "%1 (%2 %3)" ).arg( metadata.trLongName,
4189 metadata.glob.toLower(),
4190 metadata.glob.toUpper() );
4191}
4192
4194{
4195 if ( codecName == QLatin1String( "System" ) )
4196 return QStringLiteral( "LDID/0" );
4197
4198 const thread_local QRegularExpression re( QRegularExpression::anchoredPattern( QString( "(CP|windows-|ISO[ -])(.+)" ) ), QRegularExpression::CaseInsensitiveOption );
4199 const QRegularExpressionMatch match = re.match( codecName );
4200 if ( match.hasMatch() )
4201 {
4202 QString c = match.captured( 2 ).remove( '-' );
4203 bool isNumber;
4204 ( void ) c.toInt( &isNumber );
4205 if ( isNumber )
4206 return c;
4207 }
4208 return codecName;
4209}
4210
4211void QgsVectorFileWriter::createSymbolLayerTable( QgsVectorLayer *vl, const QgsCoordinateTransform &ct, OGRDataSourceH ds )
4212{
4213 if ( !vl || !ds )
4214 {
4215 return;
4216 }
4217
4218 QgsFeatureRenderer *renderer = vl->renderer();
4219 if ( !renderer )
4220 {
4221 return;
4222 }
4223
4224 //unit type
4225 Qgis::DistanceUnit mapUnits = vl->crs().mapUnits();
4226 if ( ct.isValid() )
4227 {
4228 mapUnits = ct.destinationCrs().mapUnits();
4229 }
4230
4231 mSymbolLayerTable.clear();
4232 OGRStyleTableH ogrStyleTable = OGR_STBL_Create();
4233 OGRStyleMgrH styleManager = OGR_SM_Create( ogrStyleTable );
4234
4235 //get symbols
4236 int nTotalLevels = 0;
4237 QgsSymbolList symbolList = renderer->symbols( mRenderContext );
4238 QgsSymbolList::iterator symbolIt = symbolList.begin();
4239 for ( ; symbolIt != symbolList.end(); ++symbolIt )
4240 {
4241 double mmsf = mmScaleFactor( mSymbologyScale, ( *symbolIt )->outputUnit(), mapUnits );
4242 double musf = mapUnitScaleFactor( mSymbologyScale, ( *symbolIt )->outputUnit(), mapUnits );
4243
4244 int nLevels = ( *symbolIt )->symbolLayerCount();
4245 for ( int i = 0; i < nLevels; ++i )
4246 {
4247 mSymbolLayerTable.insert( ( *symbolIt )->symbolLayer( i ), QString::number( nTotalLevels ) );
4248 OGR_SM_AddStyle( styleManager, QString::number( nTotalLevels ).toLocal8Bit(),
4249 ( *symbolIt )->symbolLayer( i )->ogrFeatureStyle( mmsf, musf ).toLocal8Bit() );
4250 ++nTotalLevels;
4251 }
4252 }
4253 OGR_DS_SetStyleTableDirectly( ds, ogrStyleTable );
4254}
4255
4256QgsVectorFileWriter::WriterError QgsVectorFileWriter::exportFeaturesSymbolLevels( const PreparedWriterDetails &details, QgsFeatureIterator &fit,
4257 const QgsCoordinateTransform &ct, QString *errorMessage )
4258{
4259 if ( !details.renderer )
4260 return ErrInvalidLayer;
4261
4262 mRenderContext.expressionContext() = details.expressionContext;
4263
4264 QHash< QgsSymbol *, QList<QgsFeature> > features;
4265
4266 //unit type
4267 Qgis::DistanceUnit mapUnits = details.sourceCrs.mapUnits();
4268 if ( ct.isValid() )
4269 {
4270 mapUnits = ct.destinationCrs().mapUnits();
4271 }
4272
4273 startRender( details.renderer.get(), details.sourceFields );
4274
4275 //fetch features
4276 QgsFeature fet;
4277 QgsSymbol *featureSymbol = nullptr;
4278 while ( fit.nextFeature( fet ) )
4279 {
4280 if ( ct.isValid() )
4281 {
4282 try
4283 {
4284 if ( fet.hasGeometry() )
4285 {
4286 QgsGeometry g = fet.geometry();
4287 g.transform( ct );
4288 fet.setGeometry( g );
4289 }
4290 }
4291 catch ( QgsCsException &e )
4292 {
4293 QString msg = QObject::tr( "Failed to transform, writing stopped. (Exception: %1)" )
4294 .arg( e.what() );
4295 QgsLogger::warning( msg );
4296 if ( errorMessage )
4297 *errorMessage = msg;
4298
4299 return ErrProjection;
4300 }
4301 }
4302 mRenderContext.expressionContext().setFeature( fet );
4303
4304 featureSymbol = mRenderer->symbolForFeature( fet, mRenderContext );
4305 if ( !featureSymbol )
4306 {
4307 continue;
4308 }
4309
4310 QHash< QgsSymbol *, QList<QgsFeature> >::iterator it = features.find( featureSymbol );
4311 if ( it == features.end() )
4312 {
4313 it = features.insert( featureSymbol, QList<QgsFeature>() );
4314 }
4315 it.value().append( fet );
4316 }
4317
4318 //find out order
4319 QgsSymbolLevelOrder levels;
4320 QgsSymbolList symbols = mRenderer->symbols( mRenderContext );
4321 for ( int i = 0; i < symbols.count(); i++ )
4322 {
4323 QgsSymbol *sym = symbols[i];
4324 for ( int j = 0; j < sym->symbolLayerCount(); j++ )
4325 {
4326 int level = sym->symbolLayer( j )->renderingPass();
4327 if ( level < 0 || level >= 1000 ) // ignore invalid levels
4328 continue;
4329 QgsSymbolLevelItem item( sym, j );
4330 while ( level >= levels.count() ) // append new empty levels
4331 levels.append( QgsSymbolLevel() );
4332 levels[level].append( item );
4333 }
4334 }
4335
4336 int nErrors = 0;
4337 int nTotalFeatures = 0;
4338
4339 //export symbol layers and symbology
4340 for ( int l = 0; l < levels.count(); l++ )
4341 {
4342 QgsSymbolLevel &level = levels[l];
4343 for ( int i = 0; i < level.count(); i++ )
4344 {
4345 QgsSymbolLevelItem &item = level[i];
4346 QHash< QgsSymbol *, QList<QgsFeature> >::iterator levelIt = features.find( item.symbol() );
4347 if ( levelIt == features.end() )
4348 {
4349 ++nErrors;
4350 continue;
4351 }
4352
4353 double mmsf = mmScaleFactor( mSymbologyScale, levelIt.key()->outputUnit(), mapUnits );
4354 double musf = mapUnitScaleFactor( mSymbologyScale, levelIt.key()->outputUnit(), mapUnits );
4355
4356 int llayer = item.layer();
4357 QList<QgsFeature> &featureList = levelIt.value();
4358 QList<QgsFeature>::iterator featureIt = featureList.begin();
4359 for ( ; featureIt != featureList.end(); ++featureIt )
4360 {
4361 ++nTotalFeatures;
4362 gdal::ogr_feature_unique_ptr ogrFeature = createFeature( *featureIt );
4363 if ( !ogrFeature )
4364 {
4365 ++nErrors;
4366 continue;
4367 }
4368
4369 QString styleString = levelIt.key()->symbolLayer( llayer )->ogrFeatureStyle( mmsf, musf );
4370 if ( !styleString.isEmpty() )
4371 {
4372 OGR_F_SetStyleString( ogrFeature.get(), styleString.toLocal8Bit().constData() );
4373 if ( !writeFeature( mLayer, ogrFeature.get() ) )
4374 {
4375 ++nErrors;
4376 }
4377 }
4378 }
4379 }
4380 }
4381
4382 stopRender();
4383
4384 if ( nErrors > 0 && errorMessage )
4385 {
4386 *errorMessage += QObject::tr( "\nOnly %1 of %2 features written." ).arg( nTotalFeatures - nErrors ).arg( nTotalFeatures );
4387 }
4388
4390}
4391
4392double QgsVectorFileWriter::mmScaleFactor( double scale, Qgis::RenderUnit symbolUnits, Qgis::DistanceUnit mapUnits )
4393{
4394 if ( symbolUnits == Qgis::RenderUnit::Millimeters )
4395 {
4396 return 1.0;
4397 }
4398 else
4399 {
4400 //conversion factor map units -> mm
4401 if ( mapUnits == Qgis::DistanceUnit::Meters )
4402 {
4403 return 1000 / scale;
4404 }
4405
4406 }
4407 return 1.0; //todo: map units
4408}
4409
4410double QgsVectorFileWriter::mapUnitScaleFactor( double scale, Qgis::RenderUnit symbolUnits, Qgis::DistanceUnit mapUnits )
4411{
4412 if ( symbolUnits == Qgis::RenderUnit::MapUnits )
4413 {
4414 return 1.0;
4415 }
4416 else
4417 {
4418 if ( symbolUnits == Qgis::RenderUnit::Millimeters && mapUnits == Qgis::DistanceUnit::Meters )
4419 {
4420 return scale / 1000;
4421 }
4422 }
4423 return 1.0;
4424}
4425
4426void QgsVectorFileWriter::startRender( QgsFeatureRenderer *sourceRenderer, const QgsFields &fields )
4427{
4428 mRenderer = createSymbologyRenderer( sourceRenderer );
4429 if ( !mRenderer )
4430 {
4431 return;
4432 }
4433
4434 mRenderer->startRender( mRenderContext, fields );
4435}
4436
4437void QgsVectorFileWriter::stopRender()
4438{
4439 if ( !mRenderer )
4440 {
4441 return;
4442 }
4443
4444 mRenderer->stopRender( mRenderContext );
4445}
4446
4447std::unique_ptr<QgsFeatureRenderer> QgsVectorFileWriter::createSymbologyRenderer( QgsFeatureRenderer *sourceRenderer ) const
4448{
4449 switch ( mSymbologyExport )
4450 {
4452 {
4453 return nullptr;
4454 }
4457 break;
4458 }
4459
4460 if ( !sourceRenderer )
4461 {
4462 return nullptr;
4463 }
4464
4465 return std::unique_ptr< QgsFeatureRenderer >( sourceRenderer->clone() );
4466}
4467
4468void QgsVectorFileWriter::addRendererAttributes( QgsFeatureRenderer *renderer, QgsRenderContext &context, const QgsFields &fields, QgsAttributeList &attList )
4469{
4470 if ( renderer )
4471 {
4472 const QSet<QString> rendererAttributes = renderer->usedAttributes( context );
4473 for ( const QString &attr : rendererAttributes )
4474 {
4475 int index = fields.lookupField( attr );
4476 if ( index != -1 )
4477 {
4478 attList.append( index );
4479 }
4480 }
4481 }
4482}
4483
4484QStringList QgsVectorFileWriter::concatenateOptions( const QMap<QString, QgsVectorFileWriter::Option *> &options )
4485{
4486 QStringList list;
4487 QMap<QString, QgsVectorFileWriter::Option *>::ConstIterator it;
4488
4489 for ( it = options.constBegin(); it != options.constEnd(); ++it )
4490 {
4491 QgsVectorFileWriter::Option *option = it.value();
4492 switch ( option->type )
4493 {
4495 {
4496 QgsVectorFileWriter::IntOption *opt = dynamic_cast<QgsVectorFileWriter::IntOption *>( option );
4497 if ( opt )
4498 {
4499 list.append( QStringLiteral( "%1=%2" ).arg( it.key() ).arg( opt->defaultValue ) );
4500 }
4501 break;
4502 }
4503
4505 {
4506 QgsVectorFileWriter::SetOption *opt = dynamic_cast<QgsVectorFileWriter::SetOption *>( option );
4507 if ( opt && !opt->defaultValue.isEmpty() )
4508 {
4509 list.append( QStringLiteral( "%1=%2" ).arg( it.key(), opt->defaultValue ) );
4510 }
4511 break;
4512 }
4513
4515 {
4517 if ( opt && !opt->defaultValue.isNull() )
4518 {
4519 list.append( QStringLiteral( "%1=%2" ).arg( it.key(), opt->defaultValue ) );
4520 }
4521 break;
4522 }
4523
4526 if ( opt && !opt->mValue.isEmpty() )
4527 {
4528 list.append( QStringLiteral( "%1=%2" ).arg( it.key(), opt->mValue ) );
4529 }
4530 break;
4531 }
4532 }
4533
4534 return list;
4535}
4536
4538{
4539 OGRSFDriverH hDriver = nullptr;
4540 gdal::ogr_datasource_unique_ptr hDS( OGROpen( datasetName.toUtf8().constData(), TRUE, &hDriver ) );
4541 if ( !hDS )
4543 const QString drvName = GDALGetDescription( hDriver );
4545 if ( OGR_DS_TestCapability( hDS.get(), ODsCCreateLayer ) )
4546 {
4547 // Shapefile driver returns True for a "foo.shp" dataset name,
4548 // creating "bar.shp" new layer, but this would be a bit confusing
4549 // for the user, so pretent that it does not support that
4550 if ( !( drvName == QLatin1String( "ESRI Shapefile" ) && QFile::exists( datasetName ) ) )
4551 caps |= CanAddNewLayer;
4552 }
4553 if ( OGR_DS_TestCapability( hDS.get(), ODsCDeleteLayer ) )
4554 {
4555 caps |= CanDeleteLayer;
4556 }
4557 int layer_count = OGR_DS_GetLayerCount( hDS.get() );
4558 if ( layer_count )
4559 {
4560 OGRLayerH hLayer = OGR_DS_GetLayer( hDS.get(), 0 );
4561 if ( hLayer )
4562 {
4563 if ( OGR_L_TestCapability( hLayer, OLCSequentialWrite ) )
4564 {
4566 if ( OGR_L_TestCapability( hLayer, OLCCreateField ) )
4567 {
4569 }
4570 }
4571 }
4572 }
4573 return caps;
4574}
4575
4576bool QgsVectorFileWriter::targetLayerExists( const QString &datasetName,
4577 const QString &layerNameIn )
4578{
4579 OGRSFDriverH hDriver = nullptr;
4580 gdal::ogr_datasource_unique_ptr hDS( OGROpen( datasetName.toUtf8().constData(), TRUE, &hDriver ) );
4581 if ( !hDS )
4582 return false;
4583
4584 QString layerName( layerNameIn );
4585 if ( layerName.isEmpty() )
4586 layerName = QFileInfo( datasetName ).baseName();
4587
4588 return OGR_DS_GetLayerByName( hDS.get(), layerName.toUtf8().constData() );
4589}
4590
4591
4592bool QgsVectorFileWriter::areThereNewFieldsToCreate( const QString &datasetName,
4593 const QString &layerName,
4594 QgsVectorLayer *layer,
4595 const QgsAttributeList &attributes )
4596{
4597 OGRSFDriverH hDriver = nullptr;
4598 gdal::ogr_datasource_unique_ptr hDS( OGROpen( datasetName.toUtf8().constData(), TRUE, &hDriver ) );
4599 if ( !hDS )
4600 return false;
4601 OGRLayerH hLayer = OGR_DS_GetLayerByName( hDS.get(), layerName.toUtf8().constData() );
4602 if ( !hLayer )
4603 {
4604 return false;
4605 }
4606 bool ret = false;
4607 OGRFeatureDefnH defn = OGR_L_GetLayerDefn( hLayer );
4608 const auto constAttributes = attributes;
4609 for ( int idx : constAttributes )
4610 {
4611 QgsField fld = layer->fields().at( idx );
4612 if ( OGR_FD_GetFieldIndex( defn, fld.name().toUtf8().constData() ) < 0 )
4613 {
4614 ret = true;
4615 break;
4616 }
4617 }
4618 return ret;
4619}
@ FieldComments
Writer can support field comments.
@ FieldAliases
Writer can support field aliases.
DistanceUnit
Units of distance.
Definition qgis.h:4875
QFlags< VectorFileWriterCapability > VectorFileWriterCapabilities
Capabilities supported by a QgsVectorFileWriter object.
Definition qgis.h:1047
RenderUnit
Rendering size units.
Definition qgis.h:5045
@ Millimeters
Millimeters.
@ MapUnits
Map units.
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:256
@ LineString
LineString.
@ MultiPolygon25D
MultiPolygon25D.
@ GeometryCollectionZ
GeometryCollectionZ.
@ NoGeometry
No geometry.
@ MultiLineString
MultiLineString.
@ Unknown
Unknown.
@ PointZ
PointZ.
@ MultiPolygonZ
MultiPolygonZ.
@ Point25D
Point25D.
FeatureSymbologyExport
Options for exporting features considering their symbology.
Definition qgis.h:5403
@ PerFeature
Keeps the number of features and export symbology per feature.
@ PerSymbolLayer
Exports one feature per symbol layer (considering symbol levels)
@ NoSymbology
Export only data.
@ Reverse
Reverse/inverse transform (from destination to source)
Provides common functionality for database based connections.
virtual QgsFieldDomain * fieldDomain(const QString &name) const
Returns the field domain with the specified name from the provider.
virtual bool addZValue(double zValue=0)=0
Adds a z-dimension to the geometry, initialized to a preset value.
virtual bool dropMValue()=0
Drops any measure values which exist in the geometry.
QFlags< WkbFlag > WkbFlags
virtual bool addMValue(double mValue=0)=0
Adds a measure to the geometry, initialized to a preset value.
virtual bool dropZValue()=0
Drops any z-dimensions which exist in the geometry.
@ FlagExportTrianglesAsPolygons
Triangles should be exported as polygon geometries.
@ FlagExportNanAsDoubleMin
Use -DOUBLE_MAX to represent NaN.
static void registerOgrDrivers()
Register OGR drivers ensuring this only happens once.
Represents a coordinate reference system (CRS).
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
static Q_INVOKABLE QgsCoordinateReferenceSystem fromEpsgId(long epsg)
Creates a CRS from a given EPSG ID.
Contains information about the context in which a coordinate transform is executed.
Handles coordinate transforms between two coordinate systems.
void setBallparkTransformsAreAppropriate(bool appropriate)
Sets whether approximate "ballpark" results are appropriate for this coordinate transform.
QgsRectangle transformBoundingBox(const QgsRectangle &rectangle, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward, bool handle180Crossover=false) const
Transforms a rectangle from the source CRS to the destination CRS.
bool isValid() const
Returns true if the coordinate transform is valid, ie both the source and destination CRS have been s...
QgsCoordinateReferenceSystem destinationCrs() const
Returns the destination coordinate reference system, which the transform will transform coordinates t...
Custom exception class for Coordinate Reference System related exceptions.
virtual QString dataSourceUri(bool expandAuthConfig=false) const
Gets the data source specification.
Stores the component parts of a data source URI (e.g.
QString what() const
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
Abstract base class for all 2D vector feature renderers.
virtual QgsSymbolList symbolsForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns list of symbols used for rendering the feature.
virtual QgsSymbolList symbols(QgsRenderContext &context) const
Returns list of symbols used by the renderer.
bool usingSymbolLevels() const
virtual QgsFeatureRenderer::Capabilities capabilities()
Returns details about internals of this renderer.
virtual QSet< QString > usedAttributes(const QgsRenderContext &context) const =0
Returns a list of attributes required by this renderer.
@ SymbolLevels
Rendering with symbol levels (i.e. implements symbols(), symbolForFeature())
virtual QgsFeatureRenderer * clone() const =0
Create a deep copy of this renderer.
Wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFilterFids(const QgsFeatureIds &fids)
Sets the feature IDs that should be fetched.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
QgsFeatureRequest & setNoAttributes()
Set that no attributes will be fetched.
QgsFeatureRequest & setFilterRect(const QgsRectangle &rectangle)
Sets the rectangle from which features will be taken.
QFlags< SinkFlag > SinkFlags
@ RegeneratePrimaryKey
This flag indicates, that a primary key field cannot be guaranteed to be unique and the sink should i...
QFlags< Flag > Flags
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
void initAttributes(int fieldCount)
Initialize this feature with the given number of fields.
QgsFeatureId id
Definition qgsfeature.h:66
QgsGeometry geometry
Definition qgsfeature.h:69
bool hasGeometry() const
Returns true if the feature has an associated geometry.
bool isUnsetValue(int fieldIdx) const
Returns true if the attribute at the specified index is an unset value.
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
bool isCanceled() const
Tells whether the operation has been canceled already.
Definition qgsfeedback.h:53
void setProgress(double progress)
Sets the current progress for the feedback object.
Definition qgsfeedback.h:61
QString domainName() const
Returns the associated field domain name, for providers which support field domains.
@ ConstraintNotNull
Field may not be null.
@ ConstraintUnique
Field must have a unique value.
Encapsulate a field in an attribute table or data source.
Definition qgsfield.h:53
QMetaType::Type type
Definition qgsfield.h:60
QString typeName() const
Gets the field type.
Definition qgsfield.cpp:162
QString name
Definition qgsfield.h:62
int precision
Definition qgsfield.h:59
int length
Definition qgsfield.h:58
bool convertCompatible(QVariant &v, QString *errorMessage=nullptr) const
Converts the provided variant to a compatible format.
Definition qgsfield.cpp:474
void setName(const QString &name)
Set the field name.
Definition qgsfield.cpp:228
QMetaType::Type subType() const
If the field is a collection, gets its element's type.
Definition qgsfield.cpp:157
QString alias
Definition qgsfield.h:63
QString comment
Definition qgsfield.h:61
QgsFieldConstraints constraints
Definition qgsfield.h:65
Container of fields for a vector layer.
Definition qgsfields.h:46
int count
Definition qgsfields.h:50
int size() const
Returns number of items.
void clear()
Removes all fields.
Definition qgsfields.cpp:58
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
static QStringList multiLayerFileExtensions()
Returns a list of file extensions which potentially contain multiple layers representing GDAL raster ...
A geometry is the spatial representation of a feature.
static QgsGeometry fromRect(const QgsRectangle &rect)
Creates a new geometry from a QgsRectangle.
Qgis::GeometryOperationResult transform(const QgsCoordinateTransform &ct, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward, bool transformZ=false)
Transforms this geometry as described by the coordinate transform ct.
QgsAbstractGeometry * get()
Returns a modifiable (non-const) reference to the underlying abstract geometry primitive.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
bool convertToMultiType()
Converts single type geometry into multitype geometry e.g.
QByteArray asWkb(QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const
Export the geometry to WKB.
Qgis::WkbType wkbType() const
Returns type of the geometry as a WKB type (point / linestring / polygon etc.)
static QgsGeometryEngine * createGeometryEngine(const QgsAbstractGeometry *geometry, double precision=0.0, Qgis::GeosCreationFlags flags=Qgis::GeosCreationFlag::SkipEmptyInteriorRings)
Creates and returns a new geometry engine representing the specified geometry using precision on a gr...
Sets the current locale to the c locale for the lifetime of the object.
Definition qgslocalec.h:32
static void warning(const QString &msg)
Goes to qWarning.
static QgsAbstractDatabaseProviderConnection * databaseConnection(const QgsMapLayer *layer)
Creates and returns the (possibly nullptr) database connection for a layer.
QString providerType() const
Returns the provider type (provider key) for this layer.
QgsCoordinateReferenceSystem crs
Definition qgsmaplayer.h:84
QgsCoordinateTransformContext transformContext() const
Returns the layer data provider coordinate transform context or a default transform context if the la...
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true, const char *file=__builtin_FILE(), const char *function=__builtin_FUNCTION(), int line=__builtin_LINE())
Adds a message to the log instance (and creates it if necessary).
Custom exception class which is raised when an operation is not supported.
static OGRSpatialReferenceH crsToOGRSpatialReference(const QgsCoordinateReferenceSystem &crs)
Returns a OGRSpatialReferenceH corresponding to the specified crs object.
static std::unique_ptr< QgsFieldDomain > convertFieldDomain(OGRFieldDomainH domain)
Converts an OGR field domain definition to a QgsFieldDomain equivalent.
static int OGRTZFlagFromQt(const QDateTime &datetime)
Gets the value of OGRField::Date::TZFlag from the timezone of a QDateTime.
Custom exception class for provider connection related exceptions.
QVariantMap decodeUri(const QString &providerKey, const QString &uri)
Breaks a provider data source URI into its component paths (e.g.
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
QString encodeUri(const QString &providerKey, const QVariantMap &parts)
Reassembles a provider data source URI from its component paths (e.g.
bool saveLayerMetadata(const QString &providerKey, const QString &uri, const QgsLayerMetadata &metadata, QString &errorMessage)
Saves metadata to the layer corresponding to the specified uri.
A convenience class that simplifies locking and unlocking QReadWriteLocks.
@ Write
Lock for write.
void changeMode(Mode mode)
Change the mode of the lock to mode.
A rectangle specified with double values.
Contains information about the context of a rendering operation.
QgsExpressionContext & expressionContext()
Gets the expression context.
void setRendererScale(double scale)
Sets the renderer map scale.
Stores settings for use within QGIS.
Definition qgssettings.h:65
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
int renderingPass() const
Specifies the rendering pass in which this symbol layer should be rendered.
Represents a symbol level during vector rendering operations.
Definition qgsrenderer.h:65
int layer() const
The layer of this symbol level.
QgsSymbol * symbol() const
The symbol of this symbol level.
Abstract base class for all rendered symbols.
Definition qgssymbol.h:231
QgsSymbolLayer * symbolLayer(int layer)
Returns the symbol layer at the specified index.
int symbolLayerCount() const
Returns the total number of symbol layers contained in the symbol.
Definition qgssymbol.h:353
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
An available option for configuring file writing for a particular output format, presenting an boolea...
Interface to convert raw field values to their user-friendly values.
virtual QVariant convert(int fieldIdxInLayer, const QVariant &value)
Convert the provided value, for field fieldIdxInLayer.
virtual QgsVectorFileWriter::FieldValueConverter * clone() const
Creates a clone of the FieldValueConverter.
virtual QgsField fieldDefinition(const QgsField &field)
Returns a possibly modified field definition.
A hidden option for file writing for a particular output format.
An available option for configuring file writing for a particular output format, presenting an intege...
Describes an available option for configuring file writing for a particular output format.
QgsVectorFileWriter::OptionType type
Options to pass to QgsVectorFileWriter::writeAsVectorFormat().
bool forceMulti
Sets to true to force creation of multipart geometries.
QgsCoordinateTransform ct
Transform to reproject exported geometries with, or invalid transform for no transformation.
QStringList attributesExportNames
Attributes export names.
QgsLayerMetadata layerMetadata
Layer metadata to save for the exported vector file.
QString layerName
Layer name. If let empty, it will be derived from the filename.
QgsRectangle filterExtent
If not empty, only features intersecting the extent will be saved.
bool includeConstraints
Set to true to transfer field constraints to the exported vector file.
const QgsAbstractDatabaseProviderConnection * sourceDatabaseProviderConnection
Source database provider connection, for field domains.
QgsVectorFileWriter::FieldValueConverter * fieldValueConverter
Field value converter.
QStringList layerOptions
List of OGR layer creation options.
Qgis::WkbType overrideGeometryType
Set to a valid geometry type to override the default geometry type for the layer.
bool includeZ
Sets to true to include z dimension in output. This option is only valid if overrideGeometryType is s...
Qgis::FeatureSymbologyExport symbologyExport
Symbology to export.
bool saveMetadata
Set to true to save layer metadata for the exported vector file.
QgsVectorFileWriter::ActionOnExistingFile actionOnExistingFile
Action on existing file.
QgsAttributeList attributes
Attributes to export (empty means all unless skipAttributeCreation is set)
bool onlySelectedFeatures
Write only selected features of layer.
QgsVectorFileWriter::FieldNameSource fieldNameSource
Source for exported field names.
bool skipAttributeCreation
Only write geometries.
bool setFieldDomains
Set to true to transfer field domains to the exported vector file.
QStringList datasourceOptions
List of OGR data source creation options.
QgsFeedback * feedback
Optional feedback object allowing cancellation of layer save.
An available option for configuring file writing for a particular output format, presenting a choice ...
An available option for configuring file writing for a particular output format, presenting a freefor...
A convenience class for writing vector layers to disk based formats (e.g.
static QgsVectorFileWriter::WriterError writeAsVectorFormatV3(QgsVectorLayer *layer, const QString &fileName, const QgsCoordinateTransformContext &transformContext, const QgsVectorFileWriter::SaveVectorOptions &options, QString *errorMessage=nullptr, QString *newFilename=nullptr, QString *newLayer=nullptr)
Writes a layer out to a vector file.
Qgis::FeatureSymbologyExport mSymbologyExport
QString lastError() const override
Returns the most recent error encountered by the sink, e.g.
@ CanAddNewFieldsToExistingLayer
Flag to indicate that new fields can be added to an existing layer. Imply CanAppendToExistingLayer.
@ CanAppendToExistingLayer
Flag to indicate that new features can be added to an existing layer.
@ CanAddNewLayer
Flag to indicate that a new layer can be added to the dataset.
@ CanDeleteLayer
Flag to indicate that an existing layer can be deleted.
static QgsVectorFileWriter::EditionCapabilities editionCapabilities(const QString &datasetName)
Returns edition capabilities for an existing dataset name.
bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a single feature to the sink.
static bool supportsFeatureStyles(const QString &driverName)
Returns true if the specified driverName supports feature styles.
Qgis::WkbType mWkbType
Geometry type which is being used.
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a list of features to the sink.
double mSymbologyScale
Scale for symbology export (e.g. for symbols units in map units)
QMap< int, int > mAttrIdxToOgrIdx
Map attribute indizes to OGR field indexes.
@ Canceled
Writing was interrupted by manual cancellation.
@ ErrSavingMetadata
Metadata saving failed.
gdal::ogr_datasource_unique_ptr mDS
static Q_DECL_DEPRECATED QgsVectorFileWriter::WriterError writeAsVectorFormatV2(QgsVectorLayer *layer, const QString &fileName, const QgsCoordinateTransformContext &transformContext, const QgsVectorFileWriter::SaveVectorOptions &options, QString *newFilename=nullptr, QString *newLayer=nullptr, QString *errorMessage=nullptr)
Writes a layer out to a vector file.
OGRGeometryH createEmptyGeometry(Qgis::WkbType wkbType)
QFlags< EditionCapability > EditionCapabilities
Combination of CanAddNewLayer, CanAppendToExistingLayer, CanAddNewFieldsToExistingLayer or CanDeleteL...
~QgsVectorFileWriter() override
Close opened shapefile for writing.
static bool targetLayerExists(const QString &datasetName, const QString &layerName)
Returns whether the target layer already exists.
double symbologyScale() const
Returns the reference scale for output.
static QStringList defaultLayerOptions(const QString &driverName)
Returns a list of the default layer options for a specified driver.
static QString driverForExtension(const QString &extension)
Returns the OGR driver name for a specified file extension.
Qgis::VectorFileWriterCapabilities capabilities() const
Returns the capabilities supported by the writer.
static QList< QgsVectorFileWriter::FilterFormatDetails > supportedFiltersAndFormats(VectorFormatOptions options=SortRecommended)
Returns a list or pairs, with format filter string as first element and OGR format key as second elem...
OGRSpatialReferenceH mOgrRef
static bool driverMetadata(const QString &driverName, MetaData &driverMetadata)
static QgsVectorFileWriter * create(const QString &fileName, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &srs, const QgsCoordinateTransformContext &transformContext, const QgsVectorFileWriter::SaveVectorOptions &options, QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), QString *newFilename=nullptr, QString *newLayer=nullptr)
Create a new vector file writer.
QString driver() const
Returns the GDAL (short) driver name associated with the output file.
static bool deleteShapeFile(const QString &fileName)
Delete a shapefile (and its accompanying shx / dbf / prj / qix / qpj / cpg / sbn / sbx / idm / ind)
Q_DECL_DEPRECATED QgsVectorFileWriter(const QString &vectorFileName, const QString &fileEncoding, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &srs=QgsCoordinateReferenceSystem(), const QString &driverName="GPKG", const QStringList &datasourceOptions=QStringList(), const QStringList &layerOptions=QStringList(), QString *newFilename=nullptr, Qgis::FeatureSymbologyExport symbologyExport=Qgis::FeatureSymbologyExport::NoSymbology, QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), QString *newLayer=nullptr, const QgsCoordinateTransformContext &transformContext=QgsCoordinateTransformContext(), FieldNameSource fieldNameSource=Original)
Create a new vector file writer.
static Q_DECL_DEPRECATED QgsVectorFileWriter::WriterError writeAsVectorFormat(QgsVectorLayer *layer, const QString &fileName, const QString &fileEncoding, const QgsCoordinateReferenceSystem &destCRS=QgsCoordinateReferenceSystem(), const QString &driverName="GPKG", bool onlySelected=false, QString *errorMessage=nullptr, const QStringList &datasourceOptions=QStringList(), const QStringList &layerOptions=QStringList(), bool skipAttributeCreation=false, QString *newFilename=nullptr, Qgis::FeatureSymbologyExport symbologyExport=Qgis::FeatureSymbologyExport::NoSymbology, double symbologyScale=1.0, const QgsRectangle *filterExtent=nullptr, Qgis::WkbType overrideGeometryType=Qgis::WkbType::Unknown, bool forceMulti=false, bool includeZ=false, const QgsAttributeList &attributes=QgsAttributeList(), QgsVectorFileWriter::FieldValueConverter *fieldValueConverter=nullptr, QString *newLayer=nullptr)
Write contents of vector layer to an (OGR supported) vector format.
static QString filterForDriver(const QString &driverName)
Creates a filter for an OGR driver key.
QgsVectorFileWriter::WriterError hasError() const
Checks whether there were any errors in constructor.
@ SupportsMultipleLayers
Filter to only formats which support multiple layers.
@ SkipNonSpatialFormats
Filter out any formats which do not have spatial support (e.g. those which cannot save geometries)
static bool areThereNewFieldsToCreate(const QString &datasetName, const QString &layerName, QgsVectorLayer *layer, const QgsAttributeList &attributes)
Returns whether there are among the attributes specified some that do not exist yet in the layer.
static QList< QgsVectorFileWriter::DriverDetails > ogrDriverList(VectorFormatOptions options=SortRecommended)
Returns the driver list that can be used for dialogs.
QString driverLongName() const
Returns the GDAL long driver name associated with the output file.
QFlags< VectorFormatOption > VectorFormatOptions
WriterError mError
Contains error value if construction was not successful.
Qgis::FeatureSymbologyExport symbologyExport() const
Returns the feature symbology export handling for the writer.
FieldNameSource
Source for exported field names.
@ PreferAlias
Use the field alias as the exported field name, wherever one is set. Otherwise use the original field...
@ Original
Use original field names.
bool mIncludeConstraints
Whether to transfer field constraints to output.
static QStringList defaultDatasetOptions(const QString &driverName)
Returns a list of the default dataset options for a specified driver.
bool addFeatureWithStyle(QgsFeature &feature, QgsFeatureRenderer *renderer, Qgis::DistanceUnit outputUnit=Qgis::DistanceUnit::Meters)
Adds a feature to the currently opened data source, using the style from a specified renderer.
static QStringList supportedFormatExtensions(VectorFormatOptions options=SortRecommended)
Returns a list of file extensions for supported formats, e.g "shp", "gpkg".
bool mSetFieldDomains
Whether to set field domains to output.
static QString convertCodecNameForEncodingOption(const QString &codecName)
Converts codec name to string passed to ENCODING layer creation option of OGR Shapefile.
FieldValueConverter * mFieldValueConverter
Field value converter.
QString errorMessage() const
Retrieves error message.
void setSymbologyScale(double scale)
Set reference scale for output.
static OGRwkbGeometryType ogrTypeFromWkbType(Qgis::WkbType type)
Gets the ogr geometry type from an internal QGIS wkb type enum.
QMap< QgsSymbolLayer *, QString > mSymbolLayerTable
static QString fileFilterString(VectorFormatOptions options=SortRecommended)
Returns filter string that can be used for dialogs.
ActionOnExistingFile
Enumeration to describe how to handle existing files.
@ CreateOrOverwriteLayer
Create or overwrite layer.
@ CreateOrOverwriteFile
Create or overwrite file.
@ AppendToLayerNoNewFields
Append features to existing layer, but do not create new fields.
@ AppendToLayerAddFields
Append features to existing layer, and create new fields if needed.
Represents a vector layer which manages a vector based dataset.
long long featureCount(const QString &legendKey) const
Number of features rendered with specified legend key.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
int selectedFeatureCount() const
Returns the number of features that are selected in this layer.
Q_INVOKABLE const QgsFeatureIds & selectedFeatureIds() const
Returns a list of the selected features IDs in this layer.
QString storageType() const
Returns the permanent storage type for this layer as a friendly name.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
QgsFeatureRenderer * renderer()
Returns the feature renderer used for rendering the features in the layer in 2D map views.
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
void minimumAndMaximumValue(int index, QVariant &minimum, QVariant &maximum) const
Calculates both the minimum and maximum value for an attribute column.
static Qgis::WkbType to25D(Qgis::WkbType type)
Will convert the 25D version of the flat type if supported or Unknown if not supported.
static Qgis::WkbType addZ(Qgis::WkbType type)
Adds the z dimension to a WKB type and returns the new type.
static Q_INVOKABLE bool hasZ(Qgis::WkbType type)
Tests whether a WKB type contains the z-dimension.
static Qgis::WkbType singleType(Qgis::WkbType type)
Returns the single type for a WKB type.
Definition qgswkbtypes.h:53
static Q_INVOKABLE bool hasM(Qgis::WkbType type)
Tests whether a WKB type contains m values.
static Qgis::WkbType multiType(Qgis::WkbType type)
Returns the multi type for a WKB type.
static Qgis::WkbType flatType(Qgis::WkbType type)
Returns the flat type for a WKB type.
static Q_INVOKABLE bool isMultiType(Qgis::WkbType type)
Returns true if the WKB type is a multi type.
std::unique_ptr< std::remove_pointer< OGRFeatureH >::type, OGRFeatureDeleter > ogr_feature_unique_ptr
Scoped OGR feature.
std::unique_ptr< std::remove_pointer< OGRDataSourceH >::type, OGRDataSourceDeleter > ogr_datasource_unique_ptr
Scoped OGR data source.
std::unique_ptr< std::remove_pointer< OGRFieldDefnH >::type, OGRFldDeleter > ogr_field_def_unique_ptr
Scoped OGR field definition.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
#define Q_NOWARN_DEPRECATED_POP
Definition qgis.h:6920
#define Q_NOWARN_DEPRECATED_PUSH
Definition qgis.h:6919
QList< QgsFeature > QgsFeatureList
QList< int > QgsAttributeList
Definition qgsfield.h:27
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:41
#define QgsDebugError(str)
Definition qgslogger.h:40
QList< QgsSymbolLevel > QgsSymbolLevelOrder
Definition qgsrenderer.h:93
QList< QgsSymbolLevelItem > QgsSymbolLevel
Definition qgsrenderer.h:89
QList< QgsSymbol * > QgsSymbolList
Definition qgsrenderer.h:48
QStringList multiLayerFormats()
Details of available driver formats.
QString longName
Descriptive, user friendly name for the driver.
QString driverName
Unique driver name.
Details of available filters and formats.
QString filterString
Filter string for file picker dialogs.
QStringList globs
Matching glob patterns for format, e.g.
QMap< QString, QgsVectorFileWriter::Option * > driverOptions
QMap< QString, QgsVectorFileWriter::Option * > layerOptions