Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmexportlayersinformation.cpp
       3                 :            :                          ---------------------------------
       4                 :            :     begin                : December 2020
       5                 :            :     copyright            : (C) 2020 by Mathieu Pellerin
       6                 :            :     email                : nirvn dot asia at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #include "qgsalgorithmexportlayersinformation.h"
      19                 :            : #include "qgsproviderregistry.h"
      20                 :            : 
      21                 :            : ///@cond PRIVATE
      22                 :            : 
      23                 :          0 : QString QgsExportLayersInformationAlgorithm::name() const
      24                 :            : {
      25                 :          0 :   return QStringLiteral( "exportlayersinformation" );
      26                 :            : }
      27                 :            : 
      28                 :          0 : QString QgsExportLayersInformationAlgorithm::displayName() const
      29                 :            : {
      30                 :          0 :   return QObject::tr( "Export layer(s) information" );
      31                 :            : }
      32                 :            : 
      33                 :          0 : QStringList QgsExportLayersInformationAlgorithm::tags() const
      34                 :            : {
      35                 :          0 :   return QObject::tr( "metadata,details,extent" ).split( ',' );
      36                 :          0 : }
      37                 :            : 
      38                 :          0 : QString QgsExportLayersInformationAlgorithm::group() const
      39                 :            : {
      40                 :          0 :   return QObject::tr( "Layer tools" );
      41                 :            : }
      42                 :            : 
      43                 :          0 : QString QgsExportLayersInformationAlgorithm::groupId() const
      44                 :            : {
      45                 :          0 :   return QStringLiteral( "layertools" );
      46                 :            : }
      47                 :            : 
      48                 :          0 : void QgsExportLayersInformationAlgorithm::initAlgorithm( const QVariantMap & )
      49                 :            : {
      50                 :          0 :   addParameter( new QgsProcessingParameterMultipleLayers( QStringLiteral( "LAYERS" ), QObject::tr( "Input layer(s)" ), QgsProcessing::TypeMapLayer ) );
      51                 :          0 :   addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Output" ), QgsProcessing::TypeVectorPolygon, QVariant() ) );
      52                 :          0 : }
      53                 :            : 
      54                 :          0 : QString QgsExportLayersInformationAlgorithm::shortHelpString() const
      55                 :            : {
      56                 :          0 :   return QObject::tr( "Creates a polygon layer with features corresponding to the extent of selected layer(s).\n\n"
      57                 :            :                       "Additional layer details - CRS, provider name, file path, layer name, subset filter, abstract and attribution - are attached as attributes to each feature." );
      58                 :            : }
      59                 :            : 
      60                 :          0 : QgsExportLayersInformationAlgorithm *QgsExportLayersInformationAlgorithm::createInstance() const
      61                 :            : {
      62                 :          0 :   return new QgsExportLayersInformationAlgorithm();
      63                 :          0 : }
      64                 :            : 
      65                 :          0 : bool QgsExportLayersInformationAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      66                 :            : {
      67                 :          0 :   const QList< QgsMapLayer * > layers = parameterAsLayerList( parameters, QStringLiteral( "LAYERS" ), context );
      68                 :          0 :   for ( QgsMapLayer *layer : layers )
      69                 :            :   {
      70                 :          0 :     if ( !mCrs.isValid() )
      71                 :            :     {
      72                 :          0 :       mCrs = layer->crs();
      73                 :          0 :     }
      74                 :          0 :     else if ( mCrs.authid() != QLatin1String( "EPSG:4326" ) )
      75                 :            :     {
      76                 :          0 :       if ( mCrs != layer->crs() )
      77                 :            :       {
      78                 :            :         // mixed CRSes, set output CRS to EPSG:4326
      79                 :          0 :         mCrs = QgsCoordinateReferenceSystem( QStringLiteral( "EPSG:4326" ) );
      80                 :          0 :       }
      81                 :          0 :     }
      82                 :          0 :     mLayers.emplace_back( layer->clone() );
      83                 :            :   }
      84                 :            : 
      85                 :          0 :   if ( !mCrs.isValid() )
      86                 :          0 :     mCrs = QgsCoordinateReferenceSystem( QStringLiteral( "EPSG:4326" ) );
      87                 :            : 
      88                 :          0 :   if ( mLayers.empty() )
      89                 :          0 :     feedback->reportError( QObject::tr( "No layers selected" ), false );
      90                 :            : 
      91                 :            :   return true;
      92                 :          0 : }
      93                 :            : 
      94                 :          0 : QVariantMap QgsExportLayersInformationAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      95                 :            : {
      96                 :          0 :   QgsFields outFields;
      97                 :          0 :   outFields.append( QgsField( QStringLiteral( "name" ), QVariant::String ) );
      98                 :          0 :   outFields.append( QgsField( QStringLiteral( "source" ), QVariant::String ) );
      99                 :          0 :   outFields.append( QgsField( QStringLiteral( "crs" ), QVariant::String ) );
     100                 :          0 :   outFields.append( QgsField( QStringLiteral( "provider" ), QVariant::String ) );
     101                 :          0 :   outFields.append( QgsField( QStringLiteral( "file_path" ), QVariant::String ) );
     102                 :          0 :   outFields.append( QgsField( QStringLiteral( "layer_name" ), QVariant::String ) );
     103                 :          0 :   outFields.append( QgsField( QStringLiteral( "subset" ), QVariant::String ) );
     104                 :          0 :   outFields.append( QgsField( QStringLiteral( "abstract" ), QVariant::String ) );
     105                 :          0 :   outFields.append( QgsField( QStringLiteral( "attribution" ), QVariant::String ) );
     106                 :            : 
     107                 :          0 :   QString outputDest;
     108                 :          0 :   std::unique_ptr< QgsFeatureSink > outputSink( parameterAsSink( parameters, QStringLiteral( "OUTPUT" ), context, outputDest, outFields,
     109                 :          0 :       QgsWkbTypes::Polygon, mCrs ) );
     110                 :            : 
     111                 :          0 :   const QList< QgsMapLayer * > layers = parameterAsLayerList( parameters, QStringLiteral( "LAYERS" ), context );
     112                 :            : 
     113                 :          0 :   double step = layers.size() > 0 ? 100.0 / layers.size() : 1;
     114                 :          0 :   int i = 0;
     115                 :          0 :   for ( const std::unique_ptr< QgsMapLayer > &layer : mLayers )
     116                 :            :   {
     117                 :          0 :     i++;
     118                 :          0 :     if ( feedback->isCanceled() )
     119                 :            :     {
     120                 :          0 :       break;
     121                 :            :     }
     122                 :            : 
     123                 :          0 :     feedback->setProgress( i * step );
     124                 :            : 
     125                 :          0 :     QgsFeature feature;
     126                 :            : 
     127                 :          0 :     QgsAttributes attributes;
     128                 :          0 :     attributes << layer->name()
     129                 :          0 :                << layer->source()
     130                 :          0 :                << layer->crs().authid();
     131                 :          0 :     if ( layer->dataProvider() )
     132                 :            :     {
     133                 :          0 :       const QVariantMap parts = QgsProviderRegistry::instance()->decodeUri( layer->dataProvider()->name(), layer->source() );
     134                 :          0 :       attributes << layer->dataProvider()->name()
     135                 :          0 :                  << parts[ QStringLiteral( "path" ) ]
     136                 :          0 :                  << parts[ QStringLiteral( "layerName" ) ]
     137                 :          0 :                  << parts[ QStringLiteral( "subset" ) ];
     138                 :          0 :     }
     139                 :            :     else
     140                 :            :     {
     141                 :          0 :       attributes << QVariant() << QVariant() << QVariant() << QVariant();
     142                 :            :     }
     143                 :          0 :     attributes << layer->metadata().rights().join( ';' )
     144                 :          0 :                << layer->abstract();
     145                 :          0 :     feature.setAttributes( attributes );
     146                 :            : 
     147                 :          0 :     QgsRectangle rect = layer->extent();
     148                 :          0 :     if ( !rect.isEmpty() )
     149                 :            :     {
     150                 :          0 :       if ( layer->crs() != mCrs )
     151                 :            :       {
     152                 :          0 :         QgsCoordinateTransform transform( layer->crs(), mCrs, context.transformContext() );
     153                 :            :         try
     154                 :            :         {
     155                 :          0 :           rect = transform.transformBoundingBox( rect );
     156                 :          0 :         }
     157                 :            :         catch ( QgsCsException &e )
     158                 :            :         {
     159                 :          0 :           Q_UNUSED( e )
     160                 :          0 :           rect = QgsRectangle();
     161                 :          0 :           feedback->pushInfo( QObject::tr( "Extent of layer %1 could not be reprojected" ).arg( layer->name() ) );
     162                 :          0 :         }
     163                 :          0 :       }
     164                 :          0 :       feature.setGeometry( QgsGeometry::fromRect( rect ) );
     165                 :          0 :     }
     166                 :          0 :     outputSink->addFeature( feature, QgsFeatureSink::FastInsert );
     167                 :          0 :   }
     168                 :            : 
     169                 :          0 :   QVariantMap outputs;
     170                 :          0 :   outputs.insert( QStringLiteral( "OUTPUT" ), outputDest );
     171                 :          0 :   return outputs;
     172                 :          0 : }
     173                 :            : 
     174                 :            : ///@endcond