qgsalgorithmmergevector.cpp

Go to the documentation of this file.

/***************************************************************************
                         qgsalgorithmmergevector.cpp
                         ------------------
    begin                : December 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsalgorithmmergevector.h"
 
#include "qgsprocessingparameters.h"
#include "qgsvectorlayer.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

 
QString QgsMergeVectorAlgorithm::name() const
{
  return u"mergevectorlayers"_s;
}
 
QString QgsMergeVectorAlgorithm::displayName() const
{
  return QObject::tr( "Merge vector layers" );
}
 
QStringList QgsMergeVectorAlgorithm::tags() const
{
  return QObject::tr( "vector,layers,collect,merge,combine" ).split( ',' );
}
 
QString QgsMergeVectorAlgorithm::group() const
{
  return QObject::tr( "Vector general" );
}
 
QString QgsMergeVectorAlgorithm::groupId() const
{
  return u"vectorgeneral"_s;
}
 
void QgsMergeVectorAlgorithm::initAlgorithm( const QVariantMap & )
{
  addParameter( new QgsProcessingParameterMultipleLayers( u"LAYERS"_s, QObject::tr( "Input layers" ), Qgis::ProcessingSourceType::Vector ) );
  addParameter( new QgsProcessingParameterCrs( u"CRS"_s, QObject::tr( "Destination CRS" ), QVariant(), true ) );
  addParameter( new QgsProcessingParameterFeatureSink( u"OUTPUT"_s, QObject::tr( "Merged" ) ) );
 
  // new boolean parameter to add source layer information
  addParameter( new QgsProcessingParameterBoolean( u"ADD_SOURCE_FIELDS"_s, QObject::tr( "Add source layer information (layer name and path)" ), true ) );
}
 
QString QgsMergeVectorAlgorithm::shortDescription() const
{
  return QObject::tr( "Combines multiple vector layers of the same geometry type into a single one." );
}
 
QString QgsMergeVectorAlgorithm::shortHelpString() const
{
  return QObject::tr(
    "This algorithm combines multiple vector layers of the same geometry type into a single one.\n\n"
    "The attribute table of the resulting layer will contain the fields from all input layers. "
    "If fields with the same name but different types are found then the exported field will be automatically converted into a string type field. "
    "Optionally, new fields storing the original layer name and source can be added.\n\n"
    "If any input layers contain Z or M values, then the output layer will also contain these values. Similarly, "
    "if any of the input layers are multi-part, the output layer will also be a multi-part layer.\n\n"
    "Optionally, the destination coordinate reference system (CRS) for the merged layer can be set. If it is not set, the CRS will be "
    "taken from the first input layer. All layers will all be reprojected to match this CRS."
  );
}
 
Qgis::ProcessingAlgorithmDocumentationFlags QgsMergeVectorAlgorithm::documentationFlags() const
{
  return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey;
}
 
QgsMergeVectorAlgorithm *QgsMergeVectorAlgorithm::createInstance() const
{
  return new QgsMergeVectorAlgorithm();
}
 
QVariantMap QgsMergeVectorAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
{
  QGS_MARK_ALGORITHM_SOURCE
 
  const QList<QgsMapLayer *> layers = parameterAsLayerList( parameters, u"LAYERS"_s, context );
 
  const bool addSourceFields = parameterAsBool( parameters, u"ADD_SOURCE_FIELDS"_s, context );
 
  QgsFields outputFields;
  long totalFeatureCount = 0;
  Qgis::WkbType outputType = Qgis::WkbType::Unknown;
  QgsCoordinateReferenceSystem outputCrs = parameterAsCrs( parameters, u"CRS"_s, context );
 
  if ( outputCrs.isValid() )
    feedback->pushInfo( QObject::tr( "Using specified destination CRS %1" ).arg( outputCrs.authid() ) );
 
  bool errored = false;
 
  // loop through input layers and determine geometry type, crs, fields, total feature count,...
  long i = 0;
  for ( QgsMapLayer *layer : layers )
  {
    i++;
 
    if ( feedback->isCanceled() )
      break;
 
    if ( !layer )
    {
      feedback->pushDebugInfo( QObject::tr( "Error retrieving map layer." ) );
      errored = true;
      continue;
    }
 
    if ( layer->type() != Qgis::LayerType::Vector )
      throw QgsProcessingException( QObject::tr( "All layers must be vector layers!" ) );
 
    QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer );
 
    const Qgis::WkbType layerWkbType = vl->wkbType();
    const QgsCoordinateReferenceSystem layerCrs = vl->crs();
    const QString layerName = vl->name();
 
    if ( !outputCrs.isValid() && layerCrs.isValid() )
    {
      outputCrs = layerCrs;
      feedback->pushInfo( QObject::tr( "Taking destination CRS %1 from layer" ).arg( outputCrs.authid() ) );
    }
 
    // check wkb type
    if ( outputType != Qgis::WkbType::Unknown && outputType != Qgis::WkbType::NoGeometry )
    {
      if ( QgsWkbTypes::geometryType( outputType ) != QgsWkbTypes::geometryType( layerWkbType ) )
        throw QgsProcessingException(
          QObject::tr( "All layers must have same geometry type! Encountered a %1 layer when expecting a %2 layer." )
            .arg( QgsWkbTypes::geometryDisplayString( QgsWkbTypes::geometryType( layerWkbType ) ), QgsWkbTypes::geometryDisplayString( QgsWkbTypes::geometryType( outputType ) ) )
        );
 
      if ( QgsWkbTypes::hasM( layerWkbType ) && !QgsWkbTypes::hasM( outputType ) )
      {
        outputType = QgsWkbTypes::addM( outputType );
        feedback->pushInfo( QObject::tr( "Found a layer with M values, upgrading output type to %1" ).arg( QgsWkbTypes::displayString( outputType ) ) );
      }
      if ( QgsWkbTypes::hasZ( layerWkbType ) && !QgsWkbTypes::hasZ( outputType ) )
      {
        outputType = QgsWkbTypes::addZ( outputType );
        feedback->pushInfo( QObject::tr( "Found a layer with Z values, upgrading output type to %1" ).arg( QgsWkbTypes::displayString( outputType ) ) );
      }
      if ( QgsWkbTypes::isMultiType( layerWkbType ) && !QgsWkbTypes::isMultiType( outputType ) )
      {
        outputType = QgsWkbTypes::multiType( outputType );
        feedback->pushInfo( QObject::tr( "Found a layer with multiparts, upgrading output type to %1" ).arg( QgsWkbTypes::displayString( outputType ) ) );
      }
    }
    else
    {
      outputType = layerWkbType;
      feedback->pushInfo( QObject::tr( "Setting output type to %1" ).arg( QgsWkbTypes::displayString( outputType ) ) );
    }
 
    totalFeatureCount += vl->featureCount();
 
    // check field type
    for ( const QgsField &sourceField : vl->fields() )
    {
      bool found = false;
      for ( QgsField &destField : outputFields )
      {
        if ( destField.name().compare( sourceField.name(), Qt::CaseInsensitive ) == 0 )
        {
          found = true;
          if ( destField.type() != sourceField.type() )
          {
            feedback->pushWarning(
              QObject::tr(
                "%1 field in layer %2 has different data type than the destination layer (%3 instead of %4). "
                "%1 field will be converted to string type."
              )
                .arg( sourceField.name(), layerName, sourceField.typeName(), destField.typeName() )
            );
            destField.setType( QMetaType::Type::QString );
            destField.setSubType( QMetaType::Type::UnknownType );
            destField.setLength( 0 );
            destField.setPrecision( 0 );
          }
          else if ( destField.type() == QMetaType::Type::QString && destField.length() < sourceField.length() )
          {
            feedback->pushWarning(
              QObject::tr(
                "%1 field in layer %2 has different field length than the destination layer (%3 vs %4). "
                "%1 field length will be extended to match the larger of the two."
              )
                .arg( sourceField.name(), layerName, QString::number( sourceField.length() ), QString::number( destField.length() ) )
            );
            destField.setLength( sourceField.length() );
          }
          else if ( destField.type() == QMetaType::Type::Double && destField.precision() < sourceField.precision() )
          {
            feedback->pushWarning(
              QObject::tr(
                "%1 field in layer %2 has different field precision than the destination layer (%3 vs %4). "
                "%1 field precision will be extended to match the larger of the two."
              )
                .arg( sourceField.name(), layerName, QString::number( sourceField.length() ), QString::number( destField.length() ) )
            );
            destField.setPrecision( sourceField.precision() );
          }
          break;
        }
      }
 
      if ( !found )
        outputFields.append( sourceField );
    }
  }
 
  bool addLayerField = false;
  bool addPathField = false;
  if ( addSourceFields ) // add source layer information
  {
    if ( outputFields.lookupField( u"layer"_s ) < 0 )
    {
      outputFields.append( QgsField( u"layer"_s, QMetaType::Type::QString, QString() ) );
      addLayerField = true;
    }
 
    if ( outputFields.lookupField( u"path"_s ) < 0 )
    {
      outputFields.append( QgsField( u"path"_s, QMetaType::Type::QString, QString() ) );
      addPathField = true;
    }
  }
 
  QString dest;
  std::unique_ptr<QgsFeatureSink> sink( parameterAsSink( parameters, u"OUTPUT"_s, context, dest, outputFields, outputType, outputCrs, QgsFeatureSink::RegeneratePrimaryKey ) );
  if ( !sink )
    throw QgsProcessingException( invalidSinkError( parameters, u"OUTPUT"_s ) );
 
  const bool hasZ = QgsWkbTypes::hasZ( outputType );
  const bool hasM = QgsWkbTypes::hasM( outputType );
  const bool isMulti = QgsWkbTypes::isMultiType( outputType );
  const double step = totalFeatureCount > 0 ? 100.0 / totalFeatureCount : 1;
  i = 0;
  int layerNumber = 0;
  for ( QgsMapLayer *layer : layers )
  {
    layerNumber++;
    if ( !layer )
      continue;
 
    QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer );
    if ( !vl )
      continue;
 
    const QString layerName = layer->name();
    const QString layerSource = layer->publicSource();
    const QgsFields layerFields = vl->fields();
 
    feedback->pushInfo( QObject::tr( "Packaging layer %1/%2: %3" ).arg( layerNumber ).arg( layers.count() ).arg( layerName ) );
 
    QgsFeatureIterator it = vl->getFeatures( QgsFeatureRequest().setDestinationCrs( outputCrs, context.transformContext() ) );
    QgsFeature f;
    while ( it.nextFeature( f ) )
    {
      if ( feedback->isCanceled() )
        break;
 
      // ensure feature geometry is of correct type
      if ( f.hasGeometry() )
      {
        bool changed = false;
        QgsGeometry g = f.geometry();
        if ( hasZ && !g.constGet()->is3D() )
        {
          g.get()->addZValue( 0 );
          changed = true;
        }
        if ( hasM && !g.constGet()->isMeasure() )
        {
          g.get()->addMValue( 0 );
          changed = true;
        }
        if ( isMulti && !g.isMultipart() )
        {
          g.convertToMultiType();
          changed = true;
        }
        if ( changed )
          f.setGeometry( g );
      }
 
      // process feature attributes
      QgsAttributes destAttributes;
      for ( const QgsField &destField : outputFields )
      {
        if ( addLayerField && destField.name() == "layer"_L1 )
        {
          destAttributes.append( layerName );
          continue;
        }
        else if ( addPathField && destField.name() == "path"_L1 )
        {
          destAttributes.append( layerSource );
          continue;
        }
 
        QVariant destAttribute;
        const int sourceIndex = layerFields.lookupField( destField.name() );
        if ( sourceIndex >= 0 )
        {
          destAttribute = f.attributes().at( sourceIndex );
        }
        destAttributes.append( destAttribute );
      }
      f.setAttributes( destAttributes );
 
      if ( !sink->addFeature( f, QgsFeatureSink::FastInsert ) )
        throw QgsProcessingException( writeFeatureError( sink.get(), parameters, u"OUTPUT"_s ) );
      else
        feedback->featureAddedToSink( u"OUTPUT"_s );
      i += 1;
      feedback->setProgress( i * step );
    }
  }
 
  if ( errored )
    throw QgsProcessingException( QObject::tr( "Error obtained while merging one or more layers." ) );
 
  sink->finalize();
  feedback->featureSinkFinalized( u"OUTPUT"_s );
 
  QVariantMap outputs;
  outputs.insert( u"OUTPUT"_s, dest );
  return outputs;
}