Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmrepairshapefile.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : December 2019
       5                 :            :     copyright            : (C) 2019 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson 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 "qgsalgorithmrepairshapefile.h"
      19                 :            : #include "qgsvectorlayer.h"
      20                 :            : #include "qgsvectordataprovider.h"
      21                 :            : #include "cpl_conv.h"
      22                 :            : 
      23                 :            : ///@cond PRIVATE
      24                 :            : 
      25                 :          0 : QString QgsRepairShapefileAlgorithm::name() const
      26                 :            : {
      27                 :          0 :   return QStringLiteral( "repairshapefile" );
      28                 :            : }
      29                 :            : 
      30                 :          0 : QString QgsRepairShapefileAlgorithm::displayName() const
      31                 :            : {
      32                 :          0 :   return QObject::tr( "Repair Shapefile" );
      33                 :            : }
      34                 :            : 
      35                 :          0 : QStringList QgsRepairShapefileAlgorithm::tags() const
      36                 :            : {
      37                 :          0 :   return QObject::tr( "fix,shp,shx,broken,missing" ).split( ',' );
      38                 :          0 : }
      39                 :            : 
      40                 :          0 : QString QgsRepairShapefileAlgorithm::group() const
      41                 :            : {
      42                 :          0 :   return QObject::tr( "Vector general" );
      43                 :            : }
      44                 :            : 
      45                 :          0 : QString QgsRepairShapefileAlgorithm::groupId() const
      46                 :            : {
      47                 :          0 :   return QStringLiteral( "vectorgeneral" );
      48                 :            : }
      49                 :            : 
      50                 :          0 : QString QgsRepairShapefileAlgorithm::shortHelpString() const
      51                 :            : {
      52                 :          0 :   return QObject::tr( "Repairs a broken Shapefile by recreating missing or broken SHX files." );
      53                 :            : }
      54                 :            : 
      55                 :          0 : QString QgsRepairShapefileAlgorithm::shortDescription() const
      56                 :            : {
      57                 :          0 :   return QObject::tr( "Repairs broken Shapefiles by recreating SHX files." );
      58                 :            : }
      59                 :            : 
      60                 :          0 : QgsRepairShapefileAlgorithm *QgsRepairShapefileAlgorithm::createInstance() const
      61                 :            : {
      62                 :          0 :   return new QgsRepairShapefileAlgorithm();
      63                 :            : }
      64                 :            : 
      65                 :          0 : void QgsRepairShapefileAlgorithm::initAlgorithm( const QVariantMap & )
      66                 :            : {
      67                 :          0 :   addParameter( new QgsProcessingParameterFile( QStringLiteral( "INPUT" ), QObject::tr( "Input Shapefile" ), QgsProcessingParameterFile::File,
      68                 :          0 :                 QStringLiteral( "shp" ), QVariant(), false, QObject::tr( "ESRI Shapefile" ) +
      69                 :          0 :                 QStringLiteral( " (*.shp *.SHP)" ) ) );
      70                 :            : 
      71                 :          0 :   addOutput( new QgsProcessingOutputVectorLayer( QStringLiteral( "OUTPUT" ), QObject::tr( "Repaired layer" ) ) );
      72                 :          0 : }
      73                 :            : 
      74                 :          0 : QVariantMap QgsRepairShapefileAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      75                 :            : {
      76                 :          0 :   const QString path = parameterAsFile( parameters, QStringLiteral( "INPUT" ), context );
      77                 :            : 
      78                 :          0 :   if ( !QFile::exists( path ) )
      79                 :          0 :     throw QgsProcessingException( QObject::tr( "Could not load source layer for %1." ).arg( QLatin1String( "INPUT" ) ) );
      80                 :            : 
      81                 :          0 :   CPLSetConfigOption( "SHAPE_RESTORE_SHX", "YES" );
      82                 :            : 
      83                 :          0 :   std::unique_ptr< QgsVectorLayer > layer = std::make_unique< QgsVectorLayer >( path );
      84                 :          0 :   if ( !layer->isValid() )
      85                 :          0 :     throw QgsProcessingException( QObject::tr( "Could not repair %1." ).arg( path ) );
      86                 :            : 
      87                 :          0 :   CPLSetConfigOption( "SHAPE_RESTORE_SHX", nullptr );
      88                 :            : 
      89                 :          0 :   feedback->pushInfo( QObject::tr( "Successfully repaired, found %1 features" ).arg( layer->featureCount() ) );
      90                 :            : 
      91                 :          0 :   QVariantMap outputs;
      92                 :          0 :   outputs.insert( QStringLiteral( "OUTPUT" ), path );
      93                 :          0 :   return outputs;
      94                 :          0 : }
      95                 :            : 
      96                 :            : ///@endcond