QGIS API Documentation 3.43.0-Master (e01d6d7c4c0)
qgsalgorithmdefineprojection.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmdefineprojection.cpp
3 ---------------------
4 begin : February 2025
5 copyright : (C) 2025 by Alexander Bruy
6 email : alexander dot bruy 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
19#include "qgsvectorlayer.h"
20#include "qgsproviderregistry.h"
21
23
24QString QgsDefineProjectionAlgorithm::name() const
25{
26 return QStringLiteral( "definecurrentprojection" );
27}
28
29QString QgsDefineProjectionAlgorithm::displayName() const
30{
31 return QObject::tr( "Define projection" );
32}
33
34QStringList QgsDefineProjectionAlgorithm::tags() const
35{
36 return QObject::tr( "layer,shp,prj,qpj,change,alter" ).split( ',' );
37}
38
39QString QgsDefineProjectionAlgorithm::group() const
40{
41 return QObject::tr( "Vector general" );
42}
43
44QString QgsDefineProjectionAlgorithm::groupId() const
45{
46 return QStringLiteral( "vectorgeneral" );
47}
48
49QString QgsDefineProjectionAlgorithm::shortHelpString() const
50{
51 return QObject::tr( "This algorithm sets an existing layer's projection to the provided CRS without reprojecting features. "
52 "Contrary to the \"Assign projection\" algorithm, it will not output a new layer.\n\n"
53 "If the input layer is a shapefile, the .prj file will be overwritten — or created if "
54 "missing — to match the provided CRS." );
55}
56
57QString QgsDefineProjectionAlgorithm::shortDescription() const
58{
59 return QObject::tr( "Sets an existing layer's projection to the provided CRS without reprojecting features." );
60}
61
62QgsDefineProjectionAlgorithm *QgsDefineProjectionAlgorithm::createInstance() const
63{
64 return new QgsDefineProjectionAlgorithm();
65}
66
67void QgsDefineProjectionAlgorithm::initAlgorithm( const QVariantMap & )
68{
69 addParameter( new QgsProcessingParameterVectorLayer( QStringLiteral( "INPUT" ), QObject::tr( "Input shapefile" ), QList<int>() << static_cast<int>( Qgis::ProcessingSourceType::VectorAnyGeometry ) ) );
70 addParameter( new QgsProcessingParameterCrs( QStringLiteral( "CRS" ), QObject::tr( "CRS" ), QgsCoordinateReferenceSystem( "EPSG:4326" ) ) );
71 addOutput( new QgsProcessingOutputVectorLayer( QStringLiteral( "OUTPUT" ), QObject::tr( "Layer with projection" ) ) );
72}
73
74bool QgsDefineProjectionAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
75{
76 QgsVectorLayer *layer = parameterAsVectorLayer( parameters, QStringLiteral( "INPUT" ), context );
77 const QgsCoordinateReferenceSystem crs = parameterAsCrs( parameters, QStringLiteral( "CRS" ), context );
78
79 if ( !layer )
80 throw QgsProcessingException( QObject::tr( "Invalid input layer" ) );
81
82 mLayerId = layer->id();
83
84 if ( layer->providerType().compare( QStringLiteral( "ogr" ), Qt::CaseSensitivity::CaseInsensitive ) == 0 )
85 {
86 const QVariantMap parts = QgsProviderRegistry::instance()->decodeUri( layer->providerType(), layer->dataProvider()->dataSourceUri() );
87 QString layerPath;
88 if ( parts.size() > 0 )
89 {
90 layerPath = parts.value( QStringLiteral( "path" ) ).toString();
91 }
92
93 if ( !layerPath.isEmpty() && layerPath.endsWith( QStringLiteral( ".shp" ), Qt::CaseSensitivity::CaseInsensitive ) )
94 {
95 const QString filePath = layerPath.chopped( 4 );
96 const QString wkt = crs.toWkt( Qgis::CrsWktVariant::Wkt1Esri );
97
98 QFile prjFile( filePath + QLatin1String( ".prj" ) );
99 if ( prjFile.open( QIODevice::WriteOnly | QIODevice::Truncate ) )
100 {
101 QTextStream stream( &prjFile );
102 stream << wkt << Qt::endl;
103 }
104 else
105 {
106 feedback->pushWarning( QObject::tr( "Failed to open .prj file for writing." ) );
107 }
108
109 QFile qpjFile( filePath + QLatin1String( ".qpj" ) );
110 if ( qpjFile.exists() )
111 {
112 qpjFile.remove();
113 }
114 }
115 else
116 {
117 feedback->pushWarning( QObject::tr( "Data source isn't a shapefile, skipping .prj creation" ) );
118 }
119 }
120 else
121 {
122 feedback->pushInfo( QObject::tr( "Data source isn't a shapefile, skipping .prj creation" ) );
123 }
124
125 layer->setCrs( crs );
126 layer->triggerRepaint();
127
128 return true;
129}
130
131QVariantMap QgsDefineProjectionAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
132{
133 Q_UNUSED( parameters );
134 Q_UNUSED( context );
135 Q_UNUSED( feedback );
136
137 QVariantMap results;
138 results.insert( QStringLiteral( "OUTPUT" ), mLayerId );
139 return results;
140}
141
@ VectorAnyGeometry
Any vector layer with geometry.
@ Wkt1Esri
WKT1 as traditionally output by ESRI software, deriving from OGC 99-049.
Represents a coordinate reference system (CRS).
QString toWkt(Qgis::CrsWktVariant variant=Qgis::CrsWktVariant::Wkt1Gdal, bool multiline=false, int indentationWidth=4) const
Returns a WKT representation of this CRS.
virtual QString dataSourceUri(bool expandAuthConfig=false) const
Gets the data source specification.
QString providerType() const
Returns the provider type (provider key) for this layer.
QString id
Definition qgsmaplayer.h:80
void triggerRepaint(bool deferredUpdate=false)
Will advise the map canvas (and any other interested party) that this layer requires to be repainted.
void setCrs(const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
Sets layer's spatial reference system.
Contains information about the context in which a processing algorithm is executed.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
virtual void pushInfo(const QString &info)
Pushes a general informational message from the algorithm.
virtual void pushWarning(const QString &warning)
Pushes a warning informational message from the algorithm.
A vector layer output for processing algorithms.
A coordinate reference system parameter for processing algorithms.
A vector layer (with or without geometry) parameter for processing algorithms.
QVariantMap decodeUri(const QString &providerKey, const QString &uri)
Breaks a provider data source URI into its component paths (e.g.
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
Represents a vector layer which manages a vector based dataset.
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
const QgsCoordinateReferenceSystem & crs