Merge pull request #51456 from domi4484/moveMergeFeatureToVectorLayer

Move merge selected features logic to QgsVectorLayerEditUtils
qgis · Feb 1, 2023 · d6ba49c · d6ba49c
2 parents 0a94cc2 + e8f29c8
commit d6ba49c
Show file tree

Hide file tree

Showing 9 changed files with 333 additions and 92 deletions.
diff --git a/python/core/auto_generated/vector/qgsvectorlayereditutils.sip.in b/python/core/auto_generated/vector/qgsvectorlayereditutils.sip.in
@@ -310,6 +310,21 @@ editing.
 :return: 2 in case vertex already exists or point does not intersect segment
 
 .. versionadded:: 3.16
+%End
+
+    bool mergeFeatures( const QgsFeatureId &targetFeatureId, const QgsFeatureIds &mergeFeatureIds, const QgsAttributes &mergeAttributes, const QgsGeometry &unionGeometry, QString &errorMessage /Out/ );
+%Docstring
+Merge features into a single one.
+
+:param targetFeatureId: id of the target feature (will be updated)
+:param mergeFeatureIds: id list of features to merge (will be deleted)
+:param mergeAttributes: are the resulting attributes in the merged feature
+:param unionGeometry: is the resulting geometry of the merged feature
+
+:return: - ``True`` if the merge was successful, or ``False`` if the operation failed.
+         - errorMessage: will be set to a descriptive error message if any occurs
+
+.. versionadded:: 3.30
 %End
 
 };

diff --git a/src/app/qgisapp.cpp b/src/app/qgisapp.cpp
@@ -103,6 +103,7 @@
 #include "qgsdockablewidgethelper.h"
 #include "vertextool/qgsvertexeditor.h"
 #include "qgsvectorlayerutils.h"
+#include "qgsvectorlayereditutils.h"
 #include "qgsadvanceddigitizingdockwidget.h"
 #include "qgsabstractdatasourcewidget.h"
 #include "qgsmeshlayer.h"
@@ -9638,9 +9639,8 @@ void QgisApp::mergeSelectedFeatures()
     return;
   }
 
-  //get selected feature ids (as a QSet<int> )
-  const QgsFeatureIds &featureIdSet = vl->selectedFeatureIds();
-  if ( featureIdSet.size() < 2 )
+  // Check at least two features are selected
+  if ( vl->selectedFeatureIds().size() < 2 )
   {
     visibleMessageBar()->pushMessage(
       tr( "Not enough features selected" ),
@@ -9714,104 +9714,38 @@ void QgisApp::mergeSelectedFeatures()
       }
       return;
     }
-  }
-
-  QgsAttributes attrs = d.mergedAttributes();
-  QgsAttributeMap newAttributes;
-  QString errorMessage;
-  QgsFeatureId mergeFeatureId = FID_NULL;
-  for ( int i = 0; i < attrs.count(); ++i )
-  {
-    QVariant val = attrs.at( i );
-    bool isDefaultValue = vl->fields().fieldOrigin( i ) == QgsFields::OriginProvider &&
-                          vl->dataProvider() &&
-                          vl->dataProvider()->defaultValueClause( vl->fields().fieldOriginIndex( i ) ) == val;
-    bool isPrimaryKey =  vl->fields().fieldOrigin( i ) == QgsFields::OriginProvider &&
-                         vl->dataProvider() &&
-                         vl->dataProvider()->pkAttributeIndexes().contains( vl->fields().fieldOriginIndex( i ) );
-
-    if ( isPrimaryKey && !isDefaultValue )
-    {
-      QgsFeatureRequest request;
-      request.setFlags( QgsFeatureRequest::Flag::NoGeometry );
-      // Handle multi pks
-      if ( vl->dataProvider()->pkAttributeIndexes().count() > 1 && vl->dataProvider()->pkAttributeIndexes().count() <= attrs.count() )
-      {
-        const auto pkIdxList { vl->dataProvider()->pkAttributeIndexes() };
-        QStringList conditions;
-        QStringList fieldNames;
-        for ( const int &pkIdx : std::as_const( pkIdxList ) )
-        {
-          const QgsField pkField { vl->fields().field( pkIdx ) };
-          conditions.push_back( QgsExpression::createFieldEqualityExpression( pkField.name(), attrs.at( pkIdx ), pkField.type( ) ) );
-          fieldNames.push_back( pkField.name() );
-        }
-        request.setSubsetOfAttributes( fieldNames, vl->fields( ) );
-        request.setFilterExpression( conditions.join( QLatin1String( " AND " ) ) );
-      }
-      else  // single pk
-      {
-        const QgsField pkField { vl->fields().field( i ) };
-        request.setSubsetOfAttributes( QStringList() << pkField.name(), vl->fields( ) );
-        request.setFilterExpression( QgsExpression::createFieldEqualityExpression( pkField.name(), val, pkField.type( ) ) );
-      }
-
-      QgsFeature f;
-      QgsFeatureIterator featureIterator = vl->getFeatures( request );
-      if ( featureIterator.nextFeature( f ) )
+    else if ( !QgsWkbTypes::isMultiType( vl->wkbType() ) )
+    {
+      const QgsGeometryCollection *c = qgsgeometry_cast<const QgsGeometryCollection *>( unionGeom.constGet() );
+      if ( ( c && c->partCount() > 1 ) || !unionGeom.convertToSingleType() )
       {
-        mergeFeatureId = f.id( );
+        visibleMessageBar()->pushMessage(
+          tr( "Merge failed" ),
+          tr( "Resulting geometry type (multipart) is incompatible with layer type (singlepart)." ),
+          Qgis::MessageLevel::Critical );
+        return;
       }
     }
-
-    // convert to destination data type
-    if ( !isDefaultValue && !vl->fields().at( i ).convertCompatible( val, &errorMessage ) )
-    {
-      visibleMessageBar()->pushMessage(
-        tr( "Invalid result" ),
-        tr( "Could not store value '%1' in field of type %2: %3" ).arg( attrs.at( i ).toString(), vl->fields().at( i ).typeName(), errorMessage ),
-        Qgis::MessageLevel::Warning );
-    }
-    newAttributes[ i ] = val;
-  }
-
-  vl->beginEditCommand( tr( "Merged features" ) );
-
-  QgsFeature mergeFeature;
-  if ( mergeFeatureId == FID_NULL )
-  {
-    // Create new feature
-    mergeFeature = QgsVectorLayerUtils::createFeature( vl, unionGeom, newAttributes );
-  }
-  else
-  {
-    // Merge into existing feature
-    featureIdsAfter.remove( mergeFeatureId );
-  }
-
-  // Delete other features
-  QgsFeatureIds::const_iterator feature_it = featureIdsAfter.constBegin();
-  for ( ; feature_it != featureIdsAfter.constEnd(); ++feature_it )
-  {
-    vl->deleteFeature( *feature_it );
   }
 
+  QString errorMessage;
+  QgsVectorLayerEditUtils vectorLayerEditUtils( vl );
+  bool success = vectorLayerEditUtils.mergeFeatures( d.targetFeatureId(), vl->selectedFeatureIds(), d.mergedAttributes(), unionGeom, errorMessage );
 
-  if ( mergeFeatureId == FID_NULL )
+  if ( !success )
   {
-    // Add the new feature
-    vl->addFeature( mergeFeature );
+    visibleMessageBar()->pushMessage(
+      tr( "Merge failed" ),
+      errorMessage,
+      Qgis::MessageLevel::Critical );
   }
-  else
+  else if ( success && !errorMessage.isEmpty() )
   {
-    // Modify merge feature
-    vl->changeGeometry( mergeFeatureId, unionGeom );
-    vl->changeAttributeValues( mergeFeatureId, newAttributes );
+    visibleMessageBar()->pushMessage(
+      tr( "Invalid result" ),
+      errorMessage,
+      Qgis::MessageLevel::Warning );
   }
-
-  vl->endEditCommand();
-
-  vl->triggerRepaint();
 }
 
 void QgisApp::vertexTool()

diff --git a/src/app/qgsmergeattributesdialog.cpp b/src/app/qgsmergeattributesdialog.cpp
@@ -108,6 +108,9 @@ QgsMergeAttributesDialog::QgsMergeAttributesDialog( const QgsFeatureList &featur
       break;
   }
 
+  if ( ! mFeatureList.isEmpty() )
+    mTargetFeatureId = mFeatureList.first().id();
+
   connect( mSkipAllButton, &QAbstractButton::clicked, this, &QgsMergeAttributesDialog::setAllToSkip );
   connect( mTableWidget, &QTableWidget::cellChanged, this, &QgsMergeAttributesDialog::tableWidgetCellChanged );
 
@@ -465,6 +468,8 @@ void QgsMergeAttributesDialog::setAllAttributesFromFeature( QgsFeatureId feature
       currentComboBox->setCurrentIndex( currentComboBox->findData( QStringLiteral( "f%1" ).arg( FID_TO_STRING( featureId ) ) ) );
     }
   }
+
+  mTargetFeatureId = featureId;
 }
 
 QVariant QgsMergeAttributesDialog::calcStatistic( int col, QgsStatisticalSummary::Statistic stat )
@@ -666,12 +671,18 @@ void QgsMergeAttributesDialog::mRemoveFeatureFromSelectionButton_clicked()
         f_it != mFeatureList.end();
         ++f_it )
   {
+    if ( f_it->id() == mTargetFeatureId )
+      mTargetFeatureId = FID_NULL;
+
     if ( f_it->id() == featureId )
     {
       mFeatureList.erase( f_it );
       break;
     }
   }
+
+  if ( mTargetFeatureId == FID_NULL && !mFeatureList.isEmpty() )
+    mTargetFeatureId = mFeatureList.first().id();
 }
 
 void QgsMergeAttributesDialog::tableWidgetCellChanged( int row, int column )
@@ -745,6 +756,11 @@ QgsAttributes QgsMergeAttributesDialog::mergedAttributes() const
   return results;
 }
 
+QgsFeatureId QgsMergeAttributesDialog::targetFeatureId() const
+{
+  return mTargetFeatureId;
+}
+
 QSet<int> QgsMergeAttributesDialog::skippedAttributeIndexes() const
 {
   QSet<int> skipped;

diff --git a/src/app/qgsmergeattributesdialog.h b/src/app/qgsmergeattributesdialog.h
@@ -49,6 +49,18 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA
 
     QgsAttributes mergedAttributes() const;
 
+    /**
+     * Returns the id of the target feature.
+     * By default it is the first feature of the list. Otherwise the feature explicitly selected
+     * with buttons "Take attributes from selected feature" or "Take attributes from feature with
+     * the largest area".
+     *
+     * \returns The id of the target feature.
+     *
+     * \since QGIS 3.30
+     */
+    QgsFeatureId targetFeatureId() const;
+
     /**
      * Returns a list of attribute indexes which should be skipped when merging (e.g., attributes
      * which have been set to "skip"
@@ -102,6 +114,7 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA
     void createRubberBandForFeature( QgsFeatureId featureId );
 
     QgsFeatureList mFeatureList;
+    QgsFeatureId mTargetFeatureId = FID_NULL;
     QgsVectorLayer *mVectorLayer = nullptr;
     QgsMapCanvas *mMapCanvas = nullptr;
     //! Item that highlights the selected feature in the merge table

diff --git a/src/core/vector/qgsvectorlayereditutils.cpp b/src/core/vector/qgsvectorlayereditutils.cpp
@@ -735,6 +735,56 @@ int QgsVectorLayerEditUtils::addTopologicalPoints( const QgsPointXY &p )
   return addTopologicalPoints( QgsPoint( p ) );
 }
 
+bool QgsVectorLayerEditUtils::mergeFeatures( const QgsFeatureId &targetFeatureId, const QgsFeatureIds &mergeFeatureIds, const QgsAttributes &mergeAttributes, const QgsGeometry &unionGeometry, QString &errorMessage )
+{
+  errorMessage.clear();
+
+  if ( mergeFeatureIds.isEmpty() )
+  {
+    errorMessage = QObject::tr( "List of features to merge is empty" );
+    return false;
+  }
+
+  QgsAttributeMap newAttributes;
+  for ( int i = 0; i < mergeAttributes.count(); ++i )
+  {
+    QVariant val = mergeAttributes.at( i );
+
+    bool isDefaultValue = mLayer->fields().fieldOrigin( i ) == QgsFields::OriginProvider &&
+                          mLayer->dataProvider() &&
+                          mLayer->dataProvider()->defaultValueClause( mLayer->fields().fieldOriginIndex( i ) ) == val;
+
+    // convert to destination data type
+    QString errorMessageConvertCompatible;
+    if ( !isDefaultValue && !mLayer->fields().at( i ).convertCompatible( val, &errorMessageConvertCompatible ) )
+    {
+      if ( errorMessage.isEmpty() )
+        errorMessage = QObject::tr( "Could not store value '%1' in field of type %2: %3" ).arg( mergeAttributes.at( i ).toString(), mLayer->fields().at( i ).typeName(), errorMessageConvertCompatible );
+    }
+    newAttributes[ i ] = val;
+  }
+
+  mLayer->beginEditCommand( QObject::tr( "Merged features" ) );
+
+  // Delete other features but the target feature
+  QgsFeatureIds::const_iterator feature_it = mergeFeatureIds.constBegin();
+  for ( ; feature_it != mergeFeatureIds.constEnd(); ++feature_it )
+  {
+    if ( *feature_it != targetFeatureId )
+      mLayer->deleteFeature( *feature_it );
+  }
+
+  // Modify merge feature
+  QgsGeometry mergeGeometry = unionGeometry;
+  mLayer->changeGeometry( targetFeatureId, mergeGeometry );
+  mLayer->changeAttributeValues( targetFeatureId, newAttributes );
+
+  mLayer->endEditCommand();
+
+  mLayer->triggerRepaint();
+
+  return true;
+}
 
 bool QgsVectorLayerEditUtils::boundingBoxFromPointList( const QgsPointSequence &list, double &xmin, double &ymin, double &xmax, double &ymax ) const
 {

diff --git a/src/core/vector/qgsvectorlayereditutils.h b/src/core/vector/qgsvectorlayereditutils.h
@@ -268,6 +268,20 @@ class CORE_EXPORT QgsVectorLayerEditUtils
      */
     int addTopologicalPoints( const QgsPointSequence &ps );
 
+    /**
+     * Merge features into a single one.
+     * \param targetFeatureId id of the target feature (will be updated)
+     * \param mergeFeatureIds id list of features to merge (will be deleted)
+     * \param mergeAttributes are the resulting attributes in the merged feature
+     * \param unionGeometry is the resulting geometry of the merged feature
+     * \param errorMessage will be set to a descriptive error message if any occurs
+     *
+     * \returns TRUE if the merge was successful, or FALSE if the operation failed.
+     *
+     * \since QGIS 3.30
+     */
+    bool mergeFeatures( const QgsFeatureId &targetFeatureId, const QgsFeatureIds &mergeFeatureIds, const QgsAttributes &mergeAttributes, const QgsGeometry &unionGeometry, QString &errorMessage SIP_OUT );
+
   private:
 
     /**

diff --git a/tests/src/app/CMakeLists.txt b/tests/src/app/CMakeLists.txt
@@ -45,6 +45,7 @@ set(TESTS
   testqgsmeshcalculatordialog.cpp
   testqgsgpsintegration.cpp
   testqgslabelpropertydialog.cpp
+  testqgsmergeattributesdialog.cpp
 )
 
 if (HAVE_GEOREFERENCER)