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 ) {
78 addGeomItem( wkbNone );
79 addGeomItem( wkbPoint );
80 addGeomItem( wkbLineString );
81 addGeomItem( wkbPolygon );
82 addGeomItem( wkbMultiPoint );
83 addGeomItem( wkbMultiLineString );
84 addGeomItem( wkbMultiPolygon );
88 addGeomItem( wkbCircularString );
90 addGeomItem( wkbCompoundCurve );
91 addGeomItem( wkbCurvePolygon );
92 addGeomItem( wkbMultiCurve );
93 addGeomItem( wkbMultiSurface );
94 mGeometryTypeBox->setCurrentIndex( -1 );
96 mGeometryWithZCheckBox->setEnabled(
false );
97 mGeometryWithMCheckBox->setEnabled(
false );
98 mGeometryColumnEdit->setEnabled(
false );
99 mGeometryColumnEdit->setText( QStringLiteral(
"geometry" ) );
101 mCheckBoxCreateSpatialIndex->setEnabled(
false );
102 mCrsSelector->setEnabled(
false );
103 mCrsSelector->setShowAccuracyWarnings(
true );
115 mOkButton = buttonBox->button( QDialogButtonBox::Ok );
116 mOkButton->setEnabled(
false );
118 connect( mFieldNameEdit, &QLineEdit::textChanged,
this, &QgsNewGeoPackageLayerDialog::fieldNameChanged );
119 connect( mAttributeView, &QTreeWidget::itemSelectionChanged,
this, &QgsNewGeoPackageLayerDialog::selectionChanged );
120 connect( mTableNameEdit, &QLineEdit::textChanged,
this, &QgsNewGeoPackageLayerDialog::checkOk );
121 connect( mGeometryTypeBox,
static_cast<void ( QComboBox::* )(
int )
>( &QComboBox::currentIndexChanged ),
this, &QgsNewGeoPackageLayerDialog::checkOk );
123 mAddAttributeButton->setEnabled(
false );
124 mRemoveAttributeButton->setEnabled(
false );
125 mButtonUp->setEnabled(
false );
126 mButtonDown->setEnabled(
false );
128 mCheckBoxCreateSpatialIndex->setChecked(
true );
132 mDatabase->setFilter( tr(
"GeoPackage" ) +
" (*.gpkg)" );
133 mDatabase->setDialogTitle( tr(
"Select Existing or Create a New GeoPackage Database File…" ) );
134 mDatabase->setDefaultRoot( settings.
value( QStringLiteral(
"UI/lastVectorFileFilterDir" ), QDir::homePath() ).toString() );
135 mDatabase->setConfirmOverwrite(
false );
138 const QFileInfo tmplFileInfo( filePath );
139 settings.
setValue( QStringLiteral(
"UI/lastVectorFileFilterDir" ), tmplFileInfo.absolutePath() );
140 if ( !filePath.isEmpty() && !mTableNameEdited )
142 const QFileInfo fileInfo( filePath );
143 mTableNameEdit->setText( fileInfo.baseName() );
150 QCompleter *completer =
new QCompleter(
this );
151 completer->setModel( ogrProviderModel );
153 completer->setCompletionMode( QCompleter::PopupCompletion );
154 completer->setFilterMode( Qt::MatchContains );
155 mDatabase->lineEdit()->setCompleter( completer );
160 mCrsSelector->setCrs(
crs );
165 mDatabase->setReadOnly(
true );
168void QgsNewGeoPackageLayerDialog::mFieldTypeBox_currentIndexChanged(
int )
170 const QString myType = mFieldTypeBox->currentData( Qt::UserRole ).toString();
171 mFieldLengthEdit->setEnabled( myType == QLatin1String(
"text" ) );
172 if ( myType != QLatin1String(
"text" ) )
173 mFieldLengthEdit->clear();
177void QgsNewGeoPackageLayerDialog::mGeometryTypeBox_currentIndexChanged(
int )
179 const OGRwkbGeometryType geomType =
static_cast<OGRwkbGeometryType
>( mGeometryTypeBox->currentData( Qt::UserRole ).toInt() );
180 const bool isSpatial = geomType != wkbNone;
181 mGeometryWithZCheckBox->setEnabled( isSpatial );
182 mGeometryWithMCheckBox->setEnabled( isSpatial );
183 mGeometryColumnEdit->setEnabled( isSpatial );
184 mCheckBoxCreateSpatialIndex->setEnabled( isSpatial );
185 mCrsSelector->setEnabled( isSpatial );
188void QgsNewGeoPackageLayerDialog::mTableNameEdit_textChanged(
const QString &text )
190 mTableNameEdited = !text.isEmpty();
191 if ( !text.isEmpty() && !mLayerIdentifierEdited )
193 mLayerIdentifierEdit->setText( text );
197void QgsNewGeoPackageLayerDialog::mTableNameEdit_textEdited(
const QString &text )
200 mTableNameEdited = !text.isEmpty();
203void QgsNewGeoPackageLayerDialog::mLayerIdentifierEdit_textEdited(
const QString &text )
206 mLayerIdentifierEdited = !text.isEmpty();
209void QgsNewGeoPackageLayerDialog::checkOk()
211 const bool ok = !mDatabase->filePath().isEmpty() && !mTableNameEdit->text().isEmpty() && mGeometryTypeBox->currentIndex() != -1;
213 mOkButton->setEnabled( ok );
216void QgsNewGeoPackageLayerDialog::mAddAttributeButton_clicked()
218 if ( !mFieldNameEdit->text().isEmpty() )
220 const QString myName = mFieldNameEdit->text();
221 const QString featureId = mFeatureIdColumnEdit->text().isEmpty() ? QStringLiteral(
DEFAULT_OGR_FID_COLUMN_TITLE ) : mFeatureIdColumnEdit->text();
222 if ( myName.compare( featureId, Qt::CaseInsensitive ) == 0 )
224 QMessageBox::critical(
this, tr(
"Add Field" ), tr(
"The field cannot have the same name as the feature identifier." ) );
229 const QString myType = mFieldTypeBox->currentData( Qt::UserRole ).toString();
230 const QString length = mFieldLengthEdit->text();
231 mAttributeView->addTopLevelItem(
new QTreeWidgetItem( QStringList() << myName << myType << length ) );
235 mFieldNameEdit->clear();
237 if ( !mFieldNameEdit->hasFocus() )
239 mFieldNameEdit->setFocus();
244void QgsNewGeoPackageLayerDialog::mRemoveAttributeButton_clicked()
246 delete mAttributeView->currentItem();
251void QgsNewGeoPackageLayerDialog::fieldNameChanged(
const QString &name )
253 mAddAttributeButton->setDisabled( name.isEmpty() || !mAttributeView->findItems( name, Qt::MatchExactly ).isEmpty() );
256void QgsNewGeoPackageLayerDialog::selectionChanged()
258 mRemoveAttributeButton->setDisabled( mAttributeView->selectedItems().isEmpty() );
259 mButtonUp->setDisabled( mAttributeView->selectedItems().isEmpty() );
260 mButtonDown->setDisabled( mAttributeView->selectedItems().isEmpty() );
263void QgsNewGeoPackageLayerDialog::buttonBox_accepted()
269void QgsNewGeoPackageLayerDialog::buttonBox_rejected()
274void QgsNewGeoPackageLayerDialog::moveFieldsUp()
276 int currentRow = mAttributeView->currentIndex().row();
277 if ( currentRow == 0 )
280 mAttributeView->insertTopLevelItem( currentRow - 1, mAttributeView->takeTopLevelItem( currentRow ) );
281 mAttributeView->setCurrentIndex( mAttributeView->model()->index( currentRow - 1, 0 ) );
284void QgsNewGeoPackageLayerDialog::moveFieldsDown()
286 int currentRow = mAttributeView->currentIndex().row();
287 if ( currentRow == mAttributeView->topLevelItemCount() - 1 )
290 mAttributeView->insertTopLevelItem( currentRow + 1, mAttributeView->takeTopLevelItem( currentRow ) );
291 mAttributeView->setCurrentIndex( mAttributeView->model()->index( currentRow + 1, 0 ) );
294bool QgsNewGeoPackageLayerDialog::apply()
296 if ( !mFieldNameEdit->text().trimmed().isEmpty() )
298 const QString currentFieldName = mFieldNameEdit->text();
299 bool currentFound =
false;
300 QTreeWidgetItemIterator it( mAttributeView );
303 QTreeWidgetItem *item = *it;
304 if ( item->text( 0 ) == currentFieldName )
314 if ( QMessageBox::question(
this, windowTitle(), 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 ), QMessageBox::Ok | QMessageBox::Cancel ) != QMessageBox::Ok )
321 QString fileName( mDatabase->filePath() );
322 if ( !fileName.endsWith( QLatin1String(
".gpkg" ), Qt::CaseInsensitive ) )
323 fileName += QLatin1String(
".gpkg" );
325 bool createNewDb =
false;
327 if ( QFile::exists( fileName ) )
329 bool overwrite =
false;
336 msgBox.setIcon( QMessageBox::Question );
337 msgBox.setWindowTitle( tr(
"New GeoPackage Layer" ) );
338 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?" ) );
339 QPushButton *overwriteButton = msgBox.addButton( tr(
"Overwrite" ), QMessageBox::ActionRole );
340 QPushButton *addNewLayerButton = msgBox.addButton( tr(
"Add New Layer" ), QMessageBox::ActionRole );
341 msgBox.setStandardButtons( QMessageBox::Cancel );
342 msgBox.setDefaultButton( addNewLayerButton );
344 if ( property(
"hideDialogs" ).toBool() )
346 overwrite = property(
"question_existing_db_answer_overwrite" ).toBool();
348 cancel = !property(
"question_existing_db_answer_add_new_layer" ).toBool();
352 const int ret = msgBox.exec();
353 if ( ret == QMessageBox::Cancel )
355 if ( msgBox.clickedButton() == overwriteButton )
376 QFile( fileName ).remove();
385 OGRSFDriverH hGpkgDriver = OGRGetDriverByName(
"GPKG" );
388 if ( !property(
"hideDialogs" ).toBool() )
389 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), tr(
"Layer creation failed. GeoPackage driver not found." ) );
396 hDS.reset( OGR_Dr_CreateDataSource( hGpkgDriver, fileName.toUtf8().constData(),
nullptr ) );
399 const QString msg( tr(
"Creation of database failed (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
400 if ( !property(
"hideDialogs" ).toBool() )
401 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), msg );
407 OGRSFDriverH hDriver =
nullptr;
408 hDS.reset( OGROpen( fileName.toUtf8().constData(),
true, &hDriver ) );
411 const QString msg( tr(
"Opening of database failed (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
412 if ( !property(
"hideDialogs" ).toBool() )
413 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), msg );
416 if ( hDriver != hGpkgDriver )
418 const QString msg( tr(
"Opening of file succeeded, but this is not a GeoPackage database." ) );
419 if ( !property(
"hideDialogs" ).toBool() )
420 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), msg );
425 const QString tableName( mTableNameEdit->text() );
427 bool overwriteTable =
false;
428 if ( OGR_DS_GetLayerByName( hDS.get(), tableName.toUtf8().constData() ) )
430 if ( property(
"hideDialogs" ).toBool() )
432 overwriteTable = property(
"question_existing_layer_answer_overwrite" ).toBool();
434 else if ( QMessageBox::question(
this, tr(
"New GeoPackage Layer" ), tr(
"A table with the same name already exists. Do you want to overwrite it?" ), QMessageBox::Yes | QMessageBox::No, QMessageBox::No ) == QMessageBox::Yes )
436 overwriteTable =
true;
439 if ( !overwriteTable )
445 const QString layerIdentifier( mLayerIdentifierEdit->text() );
446 const QString layerDescription( mLayerDescriptionEdit->text() );
448 OGRwkbGeometryType wkbType =
static_cast<OGRwkbGeometryType
>( mGeometryTypeBox->currentData( Qt::UserRole ).toInt() );
451 if ( mGeometryWithZCheckBox->isChecked() )
452 wkbType = OGR_GT_SetZ( wkbType );
454 if ( mGeometryWithMCheckBox->isChecked() )
455 wkbType = OGR_GT_SetM( wkbType );
460 if ( wkbType != wkbNone && srs.
isValid() )
466 char **options =
nullptr;
468 if ( overwriteTable )
469 options = CSLSetNameValue( options,
"OVERWRITE",
"YES" );
470 if ( !layerIdentifier.isEmpty() )
471 options = CSLSetNameValue( options,
"IDENTIFIER", layerIdentifier.toUtf8().constData() );
472 if ( !layerDescription.isEmpty() )
473 options = CSLSetNameValue( options,
"DESCRIPTION", layerDescription.toUtf8().constData() );
475 const QString featureId( mFeatureIdColumnEdit->text() );
476 if ( !featureId.isEmpty() )
477 options = CSLSetNameValue( options,
"FID", featureId.toUtf8().constData() );
479 const QString geometryColumn( mGeometryColumnEdit->text() );
480 if ( wkbType != wkbNone && !geometryColumn.isEmpty() )
481 options = CSLSetNameValue( options,
"GEOMETRY_COLUMN", geometryColumn.toUtf8().constData() );
483 if ( wkbType != wkbNone )
484 options = CSLSetNameValue( options,
"SPATIAL_INDEX", mCheckBoxCreateSpatialIndex->isChecked() ?
"YES" :
"NO" );
486 OGRLayerH hLayer = OGR_DS_CreateLayer( hDS.get(), tableName.toUtf8().constData(), hSRS, wkbType, options );
487 CSLDestroy( options );
492 const QString msg( tr(
"Creation of layer failed (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
493 if ( !property(
"hideDialogs" ).toBool() )
494 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), msg );
498 QTreeWidgetItemIterator it( mAttributeView );
501 const QString fieldName( ( *it )->text( 0 ) );
502 const QString fieldType( ( *it )->text( 1 ) );
503 const QString fieldWidth( ( *it )->text( 2 ) );
505 OGRFieldType ogrType( OFTString );
506 OGRFieldSubType ogrSubType = OFSTNone;
507 if ( fieldType == QLatin1String(
"text" ) )
509 else if ( fieldType == QLatin1String(
"integer" ) )
510 ogrType = OFTInteger;
511 else if ( fieldType == QLatin1String(
"integer64" ) )
512 ogrType = OFTInteger64;
513 else if ( fieldType == QLatin1String(
"real" ) )
515 else if ( fieldType == QLatin1String(
"date" ) )
517 else if ( fieldType == QLatin1String(
"datetime" ) )
518 ogrType = OFTDateTime;
519 else if ( fieldType == QLatin1String(
"bool" ) )
521 ogrType = OFTInteger;
522 ogrSubType = OFSTBoolean;
524 else if ( fieldType == QLatin1String(
"binary" ) )
526 else if ( fieldType == QLatin1String(
"json" ) )
529 ogrSubType = OFSTJSON;
532 const int ogrWidth = fieldWidth.toInt();
535 if ( ogrSubType != OFSTNone )
536 OGR_Fld_SetSubType( fld.get(), ogrSubType );
538 if ( ogrType != OFTBinary )
539 OGR_Fld_SetWidth( fld.get(), ogrWidth );
541 if ( OGR_L_CreateField( hLayer, fld.get(),
true ) != OGRERR_NONE )
543 if ( !property(
"hideDialogs" ).toBool() )
545 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), tr(
"Creation of field %1 failed (OGR error: %2)" ).arg( fieldName, QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
556 OGR_L_ResetReading( hLayer );
557 if ( CPLGetLastErrorType() != CE_None )
559 const QString msg( tr(
"Creation of layer failed (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
560 if ( !property(
"hideDialogs" ).toBool() )
561 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), msg );
566 const QString uri( QStringLiteral(
"%1|layername=%2" ).arg( fileName, tableName ) );
567 const QString userVisiblelayerName( layerIdentifier.isEmpty() ? tableName : layerIdentifier );
569 std::unique_ptr<QgsVectorLayer> layer = std::make_unique<QgsVectorLayer>( uri, userVisiblelayerName, QStringLiteral(
"ogr" ), layerOptions );
570 if ( layer->isValid() )
575 QList<QgsMapLayer *> myList;
576 myList << layer.release();
589 if ( !property(
"hideDialogs" ).toBool() )
590 QMessageBox::critical(
this, tr(
"New GeoPackage Layer" ), tr(
"%1 is an invalid layer and cannot be loaded." ).arg( tableName ) );
598 mBehavior = behavior;
603 mAddToProject = addToProject;
606void QgsNewGeoPackageLayerDialog::showHelp()
608 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.