21#include "moc_qgsnewgeopackagelayerdialog.cpp"
43#include <ogr_srs_api.h>
44#include <gdal_version.h>
46#include <cpl_string.h>
48#define DEFAULT_OGR_FID_COLUMN_TITLE "fid"
51 : QDialog( parent, fl )
54 setObjectName( QStringLiteral(
"QgsNewGeoPackageLayerDialog" ) );
57 connect( mAddAttributeButton, &QToolButton::clicked,
this, &QgsNewGeoPackageLayerDialog::mAddAttributeButton_clicked );
58 connect( mRemoveAttributeButton, &QToolButton::clicked,
this, &QgsNewGeoPackageLayerDialog::mRemoveAttributeButton_clicked );
59 connect( mFieldTypeBox,
static_cast<void ( QComboBox::* )(
int )
>( &QComboBox::currentIndexChanged ),
this, &QgsNewGeoPackageLayerDialog::mFieldTypeBox_currentIndexChanged );
60 connect( mGeometryTypeBox,
static_cast<void ( QComboBox::* )(
int )
>( &QComboBox::currentIndexChanged ),
this, &QgsNewGeoPackageLayerDialog::mGeometryTypeBox_currentIndexChanged );
61 connect( mTableNameEdit, &QLineEdit::textChanged,
this, &QgsNewGeoPackageLayerDialog::mTableNameEdit_textChanged );
62 connect( mTableNameEdit, &QLineEdit::textEdited,
this, &QgsNewGeoPackageLayerDialog::mTableNameEdit_textEdited );
63 connect( mLayerIdentifierEdit, &QLineEdit::textEdited,
this, &QgsNewGeoPackageLayerDialog::mLayerIdentifierEdit_textEdited );
64 connect( buttonBox, &QDialogButtonBox::accepted,
this, &QgsNewGeoPackageLayerDialog::buttonBox_accepted );
65 connect( buttonBox, &QDialogButtonBox::rejected,
this, &QgsNewGeoPackageLayerDialog::buttonBox_rejected );
66 connect( buttonBox, &QDialogButtonBox::helpRequested,
this, &QgsNewGeoPackageLayerDialog::showHelp );
67 connect( mButtonUp, &QToolButton::clicked,
this, &QgsNewGeoPackageLayerDialog::moveFieldsUp );
68 connect( mButtonDown, &QToolButton::clicked,
this, &QgsNewGeoPackageLayerDialog::moveFieldsDown );
73 const auto addGeomItem = [
this]( OGRwkbGeometryType ogrGeomType )
79 addGeomItem( wkbNone );
80 addGeomItem( wkbPoint );
81 addGeomItem( wkbLineString );
82 addGeomItem( wkbPolygon );
83 addGeomItem( wkbMultiPoint );
84 addGeomItem( wkbMultiLineString );
85 addGeomItem( wkbMultiPolygon );
89 addGeomItem( wkbCircularString );
91 addGeomItem( wkbCompoundCurve );
92 addGeomItem( wkbCurvePolygon );
93 addGeomItem( wkbMultiCurve );
94 addGeomItem( wkbMultiSurface );
95 mGeometryTypeBox->setCurrentIndex( -1 );
97 mGeometryWithZCheckBox->setEnabled(
false );
98 mGeometryWithMCheckBox->setEnabled(
false );
99 mGeometryColumnEdit->setEnabled(
false );
100 mGeometryColumnEdit->setText( QStringLiteral(
"geometry" ) );
102 mCheckBoxCreateSpatialIndex->setEnabled(
false );
103 mCrsSelector->setEnabled(
false );
104 mCrsSelector->setShowAccuracyWarnings(
true );
116 mOkButton = buttonBox->button( QDialogButtonBox::Ok );
117 mOkButton->setEnabled(
false );
119 connect( mFieldNameEdit, &QLineEdit::textChanged,
this, &QgsNewGeoPackageLayerDialog::fieldNameChanged );
120 connect( mAttributeView, &QTreeWidget::itemSelectionChanged,
this, &QgsNewGeoPackageLayerDialog::selectionChanged );
121 connect( mTableNameEdit, &QLineEdit::textChanged,
this, &QgsNewGeoPackageLayerDialog::checkOk );
122 connect( mGeometryTypeBox,
static_cast<void( QComboBox::* )(
int )
>( &QComboBox::currentIndexChanged ),
this, &QgsNewGeoPackageLayerDialog::checkOk );
124 mAddAttributeButton->setEnabled(
false );
125 mRemoveAttributeButton->setEnabled(
false );
126 mButtonUp->setEnabled(
false );
127 mButtonDown->setEnabled(
false );
129 mCheckBoxCreateSpatialIndex->setChecked(
true );
133 mDatabase->setFilter( tr(
"GeoPackage" ) +
" (*.gpkg)" );
134 mDatabase->setDialogTitle( tr(
"Select Existing or Create a New GeoPackage Database File…" ) );
135 mDatabase->setDefaultRoot( settings.
value( QStringLiteral(
"UI/lastVectorFileFilterDir" ), QDir::homePath() ).toString() );
136 mDatabase->setConfirmOverwrite(
false );
140 const QFileInfo tmplFileInfo( filePath );
141 settings.
setValue( QStringLiteral(
"UI/lastVectorFileFilterDir" ), tmplFileInfo.absolutePath() );
142 if ( !filePath.isEmpty() && !mTableNameEdited )
144 const QFileInfo fileInfo( filePath );
145 mTableNameEdit->setText( fileInfo.baseName() );
152 QCompleter *completer =
new QCompleter(
this );
153 completer->setModel( ogrProviderModel );
155 completer->setCompletionMode( QCompleter::PopupCompletion );
156 completer->setFilterMode( Qt::MatchContains );
157 mDatabase->lineEdit()->setCompleter( completer );
162 mCrsSelector->setCrs(
crs );
167 mDatabase->setReadOnly(
true );
170void QgsNewGeoPackageLayerDialog::mFieldTypeBox_currentIndexChanged(
int )
172 const QString myType = mFieldTypeBox->currentData( Qt::UserRole ).toString();
173 mFieldLengthEdit->setEnabled( myType == QLatin1String(
"text" ) );
174 if ( myType != QLatin1String(
"text" ) )
175 mFieldLengthEdit->clear();
179void QgsNewGeoPackageLayerDialog::mGeometryTypeBox_currentIndexChanged(
int )
181 const OGRwkbGeometryType geomType =
static_cast<OGRwkbGeometryType
>
182 ( mGeometryTypeBox->currentData( Qt::UserRole ).toInt() );
183 const bool isSpatial = geomType != wkbNone;
184 mGeometryWithZCheckBox->setEnabled( isSpatial );
185 mGeometryWithMCheckBox->setEnabled( isSpatial );
186 mGeometryColumnEdit->setEnabled( isSpatial );
187 mCheckBoxCreateSpatialIndex->setEnabled( isSpatial );
188 mCrsSelector->setEnabled( isSpatial );
191void QgsNewGeoPackageLayerDialog::mTableNameEdit_textChanged(
const QString &text )
193 mTableNameEdited = !text.isEmpty();
194 if ( !text.isEmpty() && !mLayerIdentifierEdited )
196 mLayerIdentifierEdit->setText( text );
200void QgsNewGeoPackageLayerDialog::mTableNameEdit_textEdited(
const QString &text )
203 mTableNameEdited = !text.isEmpty();
206void QgsNewGeoPackageLayerDialog::mLayerIdentifierEdit_textEdited(
const QString &text )
209 mLayerIdentifierEdited = !text.isEmpty();
212void QgsNewGeoPackageLayerDialog::checkOk()
214 const bool ok = !mDatabase->filePath().isEmpty() &&
215 !mTableNameEdit->text().isEmpty() &&
216 mGeometryTypeBox->currentIndex() != -1;
218 mOkButton->setEnabled( ok );
221void QgsNewGeoPackageLayerDialog::mAddAttributeButton_clicked()
223 if ( !mFieldNameEdit->text().isEmpty() )
225 const QString myName = mFieldNameEdit->text();
226 const QString featureId = mFeatureIdColumnEdit->text().isEmpty() ? QStringLiteral(
DEFAULT_OGR_FID_COLUMN_TITLE ) : mFeatureIdColumnEdit->text();
227 if ( myName.compare( featureId, Qt::CaseInsensitive ) == 0 )
229 QMessageBox::critical(
this, tr(
"Add Field" ), tr(
"The field cannot have the same name as the feature identifier." ) );
234 const QString myType = mFieldTypeBox->currentData( Qt::UserRole ).toString();
235 const QString length = mFieldLengthEdit->text();
236 mAttributeView->addTopLevelItem(
new QTreeWidgetItem( QStringList() << myName << myType << length ) );
240 mFieldNameEdit->clear();
242 if ( !mFieldNameEdit->hasFocus() )
244 mFieldNameEdit->setFocus();
249void QgsNewGeoPackageLayerDialog::mRemoveAttributeButton_clicked()
251 delete mAttributeView->currentItem();
256void QgsNewGeoPackageLayerDialog::fieldNameChanged(
const QString &name )
258 mAddAttributeButton->setDisabled( name.isEmpty() || ! mAttributeView->findItems( name, Qt::MatchExactly ).isEmpty() );
261void QgsNewGeoPackageLayerDialog::selectionChanged()
263 mRemoveAttributeButton->setDisabled( mAttributeView->selectedItems().isEmpty() );
264 mButtonUp->setDisabled( mAttributeView->selectedItems().isEmpty() );
265 mButtonDown->setDisabled( mAttributeView->selectedItems().isEmpty() );
268void QgsNewGeoPackageLayerDialog::buttonBox_accepted()
274void QgsNewGeoPackageLayerDialog::buttonBox_rejected()
279void QgsNewGeoPackageLayerDialog::moveFieldsUp()
281 int currentRow = mAttributeView->currentIndex().row();
282 if ( currentRow == 0 )
285 mAttributeView->insertTopLevelItem( currentRow - 1, mAttributeView->takeTopLevelItem( currentRow ) );
286 mAttributeView->setCurrentIndex( mAttributeView->model()->index( currentRow - 1, 0 ) );
289void QgsNewGeoPackageLayerDialog::moveFieldsDown()
291 int currentRow = mAttributeView->currentIndex().row();
292 if ( currentRow == mAttributeView->topLevelItemCount() - 1 )
295 mAttributeView->insertTopLevelItem( currentRow + 1, mAttributeView->takeTopLevelItem( currentRow ) );
296 mAttributeView->setCurrentIndex( mAttributeView->model()->index( currentRow + 1, 0 ) );
299bool QgsNewGeoPackageLayerDialog::apply()
301 if ( !mFieldNameEdit->text().trimmed().isEmpty() )
303 const QString currentFieldName = mFieldNameEdit->text();
304 bool currentFound =
false;
305 QTreeWidgetItemIterator it( mAttributeView );
308 QTreeWidgetItem *item = *it;
309 if ( item->text( 0 ) == currentFieldName )
319 if ( QMessageBox::question(
this, windowTitle(),
320 tr(
"The field “%1” has not been added to the fields list. Are you sure you want to proceed and discard this field?" ).arg( currentFieldName ),
321 QMessageBox::Ok | QMessageBox::Cancel ) != QMessageBox::Ok )
328 QString fileName( mDatabase->filePath() );
329 if ( !fileName.endsWith( QLatin1String(
".gpkg" ), Qt::CaseInsensitive ) )
330 fileName += QLatin1String(
".gpkg" );
332 bool createNewDb =
false;
334 if ( QFile::exists( fileName ) )
336 bool overwrite =
false;
343 msgBox.setIcon( QMessageBox::Question );
344 msgBox.setWindowTitle( tr(
"New GeoPackage Layer" ) );
345 msgBox.setText( tr(
"The File already exists. Do you want to overwrite the existing file with a new database or add a new layer to it?" ) );
346 QPushButton *overwriteButton = msgBox.addButton( tr(
"Overwrite" ), QMessageBox::ActionRole );
347 QPushButton *addNewLayerButton = msgBox.addButton( tr(
"Add New Layer" ), QMessageBox::ActionRole );
348 msgBox.setStandardButtons( QMessageBox::Cancel );
349 msgBox.setDefaultButton( addNewLayerButton );
351 if ( property(
"hideDialogs" ).toBool() )
353 overwrite = property(
"question_existing_db_answer_overwrite" ).toBool();
355 cancel = !property(
"question_existing_db_answer_add_new_layer" ).toBool();
359 const int ret = msgBox.exec();
360 if ( ret == QMessageBox::Cancel )
362 if ( msgBox.clickedButton() == overwriteButton )
383 QFile( fileName ).remove();
392 OGRSFDriverH hGpkgDriver = OGRGetDriverByName(
"GPKG" );
395 if ( !property(
"hideDialogs" ).toBool() )
396 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ),
397 tr(
"Layer creation failed. GeoPackage driver not found." ) );
404 hDS.reset( OGR_Dr_CreateDataSource( hGpkgDriver, fileName.toUtf8().constData(),
nullptr ) );
407 const QString msg( tr(
"Creation of database failed (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
408 if ( !property(
"hideDialogs" ).toBool() )
409 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), msg );
415 OGRSFDriverH hDriver =
nullptr;
416 hDS.reset( OGROpen( fileName.toUtf8().constData(),
true, &hDriver ) );
419 const QString msg( tr(
"Opening of database failed (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
420 if ( !property(
"hideDialogs" ).toBool() )
421 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), msg );
424 if ( hDriver != hGpkgDriver )
426 const QString msg( tr(
"Opening of file succeeded, but this is not a GeoPackage database." ) );
427 if ( !property(
"hideDialogs" ).toBool() )
428 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), msg );
433 const QString tableName( mTableNameEdit->text() );
435 bool overwriteTable =
false;
436 if ( OGR_DS_GetLayerByName( hDS.get(), tableName.toUtf8().constData() ) )
438 if ( property(
"hideDialogs" ).toBool() )
440 overwriteTable = property(
"question_existing_layer_answer_overwrite" ).toBool();
442 else if ( QMessageBox::question(
this, tr(
"New GeoPackage Layer" ),
443 tr(
"A table with the same name already exists. Do you want to overwrite it?" ),
444 QMessageBox::Yes | QMessageBox::No, QMessageBox::No ) == QMessageBox::Yes )
446 overwriteTable =
true;
449 if ( !overwriteTable )
455 const QString layerIdentifier( mLayerIdentifierEdit->text() );
456 const QString layerDescription( mLayerDescriptionEdit->text() );
458 OGRwkbGeometryType wkbType =
static_cast<OGRwkbGeometryType
>
459 ( mGeometryTypeBox->currentData( Qt::UserRole ).toInt() );
462 if ( mGeometryWithZCheckBox->isChecked() )
463 wkbType = OGR_GT_SetZ( wkbType );
465 if ( mGeometryWithMCheckBox->isChecked() )
466 wkbType = OGR_GT_SetM( wkbType );
471 if ( wkbType != wkbNone && srs.
isValid() )
477 char **options =
nullptr;
479 if ( overwriteTable )
480 options = CSLSetNameValue( options,
"OVERWRITE",
"YES" );
481 if ( !layerIdentifier.isEmpty() )
482 options = CSLSetNameValue( options,
"IDENTIFIER", layerIdentifier.toUtf8().constData() );
483 if ( !layerDescription.isEmpty() )
484 options = CSLSetNameValue( options,
"DESCRIPTION", layerDescription.toUtf8().constData() );
486 const QString featureId( mFeatureIdColumnEdit->text() );
487 if ( !featureId.isEmpty() )
488 options = CSLSetNameValue( options,
"FID", featureId.toUtf8().constData() );
490 const QString geometryColumn( mGeometryColumnEdit->text() );
491 if ( wkbType != wkbNone && !geometryColumn.isEmpty() )
492 options = CSLSetNameValue( options,
"GEOMETRY_COLUMN", geometryColumn.toUtf8().constData() );
494 if ( wkbType != wkbNone )
495 options = CSLSetNameValue( options,
"SPATIAL_INDEX", mCheckBoxCreateSpatialIndex->isChecked() ?
"YES" :
"NO" );
497 OGRLayerH hLayer = OGR_DS_CreateLayer( hDS.get(), tableName.toUtf8().constData(), hSRS, wkbType, options );
498 CSLDestroy( options );
503 const QString msg( tr(
"Creation of layer failed (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
504 if ( !property(
"hideDialogs" ).toBool() )
505 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), msg );
509 QTreeWidgetItemIterator it( mAttributeView );
512 const QString fieldName( ( *it )->text( 0 ) );
513 const QString fieldType( ( *it )->text( 1 ) );
514 const QString fieldWidth( ( *it )->text( 2 ) );
516 OGRFieldType ogrType( OFTString );
517 OGRFieldSubType ogrSubType = OFSTNone;
518 if ( fieldType == QLatin1String(
"text" ) )
520 else if ( fieldType == QLatin1String(
"integer" ) )
521 ogrType = OFTInteger;
522 else if ( fieldType == QLatin1String(
"integer64" ) )
523 ogrType = OFTInteger64;
524 else if ( fieldType == QLatin1String(
"real" ) )
526 else if ( fieldType == QLatin1String(
"date" ) )
528 else if ( fieldType == QLatin1String(
"datetime" ) )
529 ogrType = OFTDateTime;
530 else if ( fieldType == QLatin1String(
"bool" ) )
532 ogrType = OFTInteger;
533 ogrSubType = OFSTBoolean;
535 else if ( fieldType == QLatin1String(
"binary" ) )
537 else if ( fieldType == QLatin1String(
"json" ) )
540 ogrSubType = OFSTJSON;
543 const int ogrWidth = fieldWidth.toInt();
546 if ( ogrSubType != OFSTNone )
547 OGR_Fld_SetSubType( fld.get(), ogrSubType );
549 if ( ogrType != OFTBinary )
550 OGR_Fld_SetWidth( fld.get(), ogrWidth );
552 if ( OGR_L_CreateField( hLayer, fld.get(),
true ) != OGRERR_NONE )
554 if ( !property(
"hideDialogs" ).toBool() )
556 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ),
557 tr(
"Creation of field %1 failed (OGR error: %2)" )
558 .arg( fieldName, QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
569 OGR_L_ResetReading( hLayer );
570 if ( CPLGetLastErrorType() != CE_None )
572 const QString msg( tr(
"Creation of layer failed (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
573 if ( !property(
"hideDialogs" ).toBool() )
574 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), msg );
579 const QString uri( QStringLiteral(
"%1|layername=%2" ).arg( fileName, tableName ) );
580 const QString userVisiblelayerName( layerIdentifier.isEmpty() ? tableName : layerIdentifier );
582 std::unique_ptr< QgsVectorLayer > layer = std::make_unique< QgsVectorLayer >( uri, userVisiblelayerName, QStringLiteral(
"ogr" ), layerOptions );
583 if ( layer->isValid() )
588 QList<QgsMapLayer *> myList;
589 myList << layer.release();
602 if ( !property(
"hideDialogs" ).toBool() )
603 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), tr(
"%1 is an invalid layer and cannot be loaded." ).arg( tableName ) );
611 mBehavior = behavior;
616 mAddToProject = addToProject;
619void QgsNewGeoPackageLayerDialog::showHelp()
621 QgsHelp::openHelp( QStringLiteral(
"managing_data_source/create_layers.html#creating-a-new-geopackage-layer" ) );
WkbType
The WKB type describes the number of dimensions a geometry has.
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
This class represents a coordinate reference system (CRS).
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
static QIcon iconForFieldType(QMetaType::Type type, QMetaType::Type subType=QMetaType::Type::UnknownType, const QString &typeString=QString())
Returns an icon corresponding to a field type.
static void enableAutoGeometryRestore(QWidget *widget, const QString &key=QString())
Register the widget to allow its position to be automatically saved and restored when open and closed...
static void openHelp(const QString &key)
Opens help topic for the given help key using default system web browser.
static QIcon iconForWkbType(Qgis::WkbType type)
Returns the icon for a vector layer whose geometry type is provided.
OverwriteBehavior
Behavior to use when an existing geopackage already exists.
@ AddNewLayer
Keep existing contents and add new layer.
@ Overwrite
Overwrite whole geopackage.
@ Prompt
Prompt user for action.
void setAddToProject(bool addToProject)
Sets whether a newly created layer should automatically be added to the current project.
void setCrs(const QgsCoordinateReferenceSystem &crs)
Sets the crs value for the new layer in the dialog.
void lockDatabasePath()
Sets the database path widgets to a locked and read-only mode.
QgsNewGeoPackageLayerDialog(QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
Constructor.
void setOverwriteBehavior(OverwriteBehavior behavior)
Sets the behavior to use when a path to an existing geopackage file is used.
static Qgis::WkbType ogrGeometryTypeToQgsWkbType(OGRwkbGeometryType ogrGeomType)
Converts a OGRwkbGeometryType to QgsWkbTypes::Type.
static OGRSpatialReferenceH crsToOGRSpatialReference(const QgsCoordinateReferenceSystem &crs)
Returns a OGRSpatialReferenceH corresponding to the specified crs object.
static QgsProject * instance()
Returns the QgsProject singleton instance.
QgsCoordinateTransformContext transformContext
A model containing registered connection names for a specific data provider.
@ Uri
Connection URI string.
This class is a composition of two QSettings instances:
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
void setValue(const QString &key, const QVariant &value, QgsSettings::Section section=QgsSettings::NoSection)
Sets the value of setting key to value.
static QString typeToDisplayString(QMetaType::Type type, QMetaType::Type subType=QMetaType::Type::UnknownType)
Returns a user-friendly translated string representing a QVariant type.
static QString translatedDisplayString(Qgis::WkbType type)
Returns a translated display string type for a WKB type, e.g., the geometry name used in WKT geometry...
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.
void * OGRSpatialReferenceH
#define DEFAULT_OGR_FID_COLUMN_TITLE
const QgsCoordinateReferenceSystem & crs
Setting options for loading vector layers.