QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
qgsprocessingfeedback.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsprocessingfeedback.cpp
3 -------------------------
4 begin : June 2017
5 copyright : (C) 2017 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
19#include "qgsgeos.h"
21#include "qgsmessagelog.h"
22#include <ogr_api.h>
23#include <gdal_version.h>
24#include <proj.h>
25
26#ifdef HAVE_PDAL_QGIS
27#include <pdal/pdal.hpp>
28#endif
29
31 : mLogFeedback( logFeedback )
32{
33
34}
35
36void QgsProcessingFeedback::setProgressText( const QString &text )
37{
38 mHtmlLog.append( text.toHtmlEscaped().replace( '\n', QLatin1String( "<br>" ) ) + QStringLiteral( "<br/>" ) );
39 mTextLog.append( text + '\n' );
40}
41
42void QgsProcessingFeedback::log( const QString &htmlMessage, const QString &textMessage )
43{
44 constexpr int MESSAGE_COUNT_LIMIT = 10000;
45 // Avoid logging too many messages, which might blow memory.
46 if ( mMessageLoggedCount == MESSAGE_COUNT_LIMIT )
47 return;
48 ++mMessageLoggedCount;
49 if ( mMessageLoggedCount == MESSAGE_COUNT_LIMIT )
50 {
51 mHtmlLog.append( QStringLiteral( "<span style=\"color:red\">%1</span><br/>" ).arg( tr( "Message log truncated" ) ) );
52 mTextLog.append( tr( "Message log truncated" ) + '\n' );
53 }
54 else
55 {
56 mHtmlLog.append( htmlMessage );
57 mTextLog.append( textMessage );
58 }
59}
60
61
62void QgsProcessingFeedback::reportError( const QString &error, bool )
63{
64 if ( mLogFeedback )
65 QgsMessageLog::logMessage( error, tr( "Processing" ), Qgis::MessageLevel::Critical );
66
67 log( QStringLiteral( "<span style=\"color:red\">%1</span><br/>" ).arg( error.toHtmlEscaped() ).replace( '\n', QLatin1String( "<br>" ) ),
68 error + '\n' );
69}
70
71void QgsProcessingFeedback::pushWarning( const QString &warning )
72{
73 if ( mLogFeedback )
74 QgsMessageLog::logMessage( warning, tr( "Processing" ), Qgis::MessageLevel::Warning );
75
76 log( QStringLiteral( "<span style=\"color:#b85a20;\">%1</span><br/>" ).arg( warning.toHtmlEscaped() ).replace( '\n', QLatin1String( "<br>" ) ) + QStringLiteral( "<br/>" ),
77 warning + '\n' );
78}
79
80void QgsProcessingFeedback::pushInfo( const QString &info )
81{
82 if ( mLogFeedback )
83 QgsMessageLog::logMessage( info, tr( "Processing" ), Qgis::MessageLevel::Info );
84
85 mHtmlLog.append( info.toHtmlEscaped().replace( '\n', QLatin1String( "<br>" ) ) + QStringLiteral( "<br/>" ) );
86 mTextLog.append( info + '\n' );
87}
88
89void QgsProcessingFeedback::pushFormattedMessage( const QString &html, const QString &text )
90{
91 if ( mLogFeedback )
92 QgsMessageLog::logMessage( text, tr( "Processing" ), Qgis::MessageLevel::Info );
93
94 mHtmlLog.append( html + QStringLiteral( "<br/>" ) );
95 mTextLog.append( text + '\n' );
96}
97
98void QgsProcessingFeedback::pushCommandInfo( const QString &info )
99{
100 if ( mLogFeedback )
101 QgsMessageLog::logMessage( info, tr( "Processing" ), Qgis::MessageLevel::Info );
102
103 log( QStringLiteral( "<code>%1</code><br/>" ).arg( info.toHtmlEscaped().replace( '\n', QLatin1String( "<br>" ) ) ),
104 info + '\n' );
105}
106
107void QgsProcessingFeedback::pushDebugInfo( const QString &info )
108{
109 if ( mLogFeedback )
110 QgsMessageLog::logMessage( info, tr( "Processing" ), Qgis::MessageLevel::Info );
111
112 log( QStringLiteral( "<span style=\"color:#777\">%1</span><br/>" ).arg( info.toHtmlEscaped().replace( '\n', QLatin1String( "<br>" ) ) ),
113 info + '\n' );
114}
115
116void QgsProcessingFeedback::pushConsoleInfo( const QString &info )
117{
118 if ( mLogFeedback )
119 QgsMessageLog::logMessage( info, tr( "Processing" ), Qgis::MessageLevel::Info );
120
121 log( QStringLiteral( "<code style=\"color:#777\">%1</code><br/>" ).arg( info.toHtmlEscaped().replace( '\n', QLatin1String( "<br>" ) ) ),
122 info + '\n' );
123}
124
126{
127 pushDebugInfo( tr( "QGIS version: %1" ).arg( Qgis::version() ) );
128 if ( QString( Qgis::devVersion() ) != QLatin1String( "exported" ) )
129 {
130 pushDebugInfo( tr( "QGIS code revision: %1" ).arg( Qgis::devVersion() ) );
131 }
132 pushDebugInfo( tr( "Qt version: %1" ).arg( qVersion() ) );
133 pushDebugInfo( tr( "Python version: %1" ).arg( PYTHON_VERSION ) );
134 pushDebugInfo( tr( "GDAL version: %1" ).arg( GDALVersionInfo( "RELEASE_NAME" ) ) );
135 pushDebugInfo( tr( "GEOS version: %1" ).arg( GEOSversion() ) );
136
137 const PJ_INFO info = proj_info();
138 pushDebugInfo( tr( "PROJ version: %1" ).arg( info.release ) );
139
140#ifdef HAVE_PDAL_QGIS
141#if PDAL_VERSION_MAJOR_INT > 1 || (PDAL_VERSION_MAJOR_INT == 1 && PDAL_VERSION_MINOR_INT >= 7)
142 pushDebugInfo( tr( "PDAL version: %1" ).arg( QString::fromStdString( pdal::Config::fullVersionString() ) ) );
143#else
144 pushDebugInfo( tr( "PDAL version: %1" ).arg( QString::fromStdString( pdal::GetFullVersionString() ) ) );
145#endif
146#endif
147
148 if ( provider && !provider->versionInfo().isEmpty() )
149 {
150 pushDebugInfo( tr( "%1 version: %2" ).arg( provider->name(), provider->versionInfo() ) );
151 }
152}
153
155{
156 if ( results.empty() )
157 return;
158
159 pushInfo( tr( "Results:" ) );
160
161 const QList< const QgsProcessingOutputDefinition * > outputs = algorithm->outputDefinitions();
162 for ( const QgsProcessingOutputDefinition *output : outputs )
163 {
164 const QString outputName = output->name();
165 if ( outputName == QLatin1String( "CHILD_RESULTS" ) || outputName == QLatin1String( "CHILD_INPUTS" ) )
166 continue;
167
168 if ( !results.contains( outputName ) )
169 continue;
170
171 bool ok = false;
172 const QString textValue = output->valueAsString( results.value( output->name() ), context, ok );
173 const QString formattedValue = output->valueAsFormattedString( results.value( output->name() ), context, ok );
174 if ( ok )
175 {
176 pushFormattedMessage( QStringLiteral( "<code>&nbsp;&nbsp;%1: %2</code>" ).arg( output->name(), formattedValue ),
177 QStringLiteral( " %1: %2" ).arg( output->name(), textValue ) );
178 }
179 }
180}
181
183{
184 return mHtmlLog;
185}
186
188{
189 return mTextLog;
190}
191
192
194 : mChildSteps( childAlgorithmCount )
195 , mFeedback( feedback )
196{
197 connect( mFeedback, &QgsFeedback::canceled, this, &QgsFeedback::cancel, Qt::DirectConnection );
198 connect( this, &QgsFeedback::progressChanged, this, &QgsProcessingMultiStepFeedback::updateOverallProgress );
199}
200
202{
203 mCurrentStep = step;
204 mFeedback->setProgress( 100.0 * static_cast< double >( mCurrentStep ) / mChildSteps );
205}
206
208{
209 mFeedback->setProgressText( text );
210}
211
212void QgsProcessingMultiStepFeedback::reportError( const QString &error, bool fatalError )
213{
214 mFeedback->reportError( error, fatalError );
215}
216
218{
219 mFeedback->pushWarning( warning );
220}
221
223{
224 mFeedback->pushInfo( info );
225}
226
228{
229 mFeedback->pushCommandInfo( info );
230}
231
233{
234 mFeedback->pushDebugInfo( info );
235}
236
238{
239 mFeedback->pushConsoleInfo( info );
240}
241
242void QgsProcessingMultiStepFeedback::pushFormattedMessage( const QString &html, const QString &text )
243{
244 mFeedback->pushFormattedMessage( html, text );
245}
246
248{
249 return mFeedback->htmlLog();
250}
251
253{
254 return mFeedback->textLog();
255}
256
257void QgsProcessingMultiStepFeedback::updateOverallProgress( double progress )
258{
259 const double baseProgress = 100.0 * static_cast< double >( mCurrentStep ) / mChildSteps;
260 const double currentAlgorithmProgress = progress / mChildSteps;
261 mFeedback->setProgress( baseProgress + currentAlgorithmProgress );
262}
263
static QString version()
Version string.
Definition qgis.cpp:258
@ Warning
Warning message.
Definition qgis.h:101
@ Critical
Critical/error message.
Definition qgis.h:102
@ Info
Information message.
Definition qgis.h:100
static QString devVersion()
The development version.
Definition qgis.cpp:275
void progressChanged(double progress)
Emitted when the feedback object reports a progress change.
void canceled()
Internal routines can connect to this signal if they use event loop.
void cancel()
Tells the internal routines that the current operation should be canceled. This should be run by the ...
void setProgress(double progress)
Sets the current progress for the feedback object.
Definition qgsfeedback.h:61
double progress() const
Returns the current progress reported by the feedback object.
Definition qgsfeedback.h:77
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
Abstract base class for processing algorithms.
QgsProcessingOutputDefinitions outputDefinitions() const
Returns an ordered list of output definitions utilized by the algorithm.
Contains information about the context in which a processing algorithm is executed.
Base class for providing feedback from a processing algorithm.
virtual void pushCommandInfo(const QString &info)
Pushes an informational message containing a command from the 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.
void pushVersionInfo(const QgsProcessingProvider *provider=nullptr)
Pushes a summary of the QGIS (and underlying library) version information to the log.
virtual QString textLog() const
Returns the plain text contents of the log, which contains all messages pushed to the feedback object...
QgsProcessingFeedback(bool logFeedback=true)
Constructor for QgsProcessingFeedback.
void pushFormattedResults(const QgsProcessingAlgorithm *algorithm, QgsProcessingContext &context, const QVariantMap &results)
Pushes a summary of the execution results to the log.
virtual QString htmlLog() const
Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback ob...
virtual void pushDebugInfo(const QString &info)
Pushes an informational message containing debugging helpers from the algorithm.
virtual void pushFormattedMessage(const QString &html, const QString &text)
Pushes a pre-formatted message from the algorithm.
virtual void reportError(const QString &error, bool fatalError=false)
Reports that the algorithm encountered an error while executing.
virtual void pushConsoleInfo(const QString &info)
Pushes a console feedback message from the algorithm.
virtual void setProgressText(const QString &text)
Sets a progress report text string.
QgsProcessingMultiStepFeedback(int steps, QgsProcessingFeedback *feedback)
Constructor for QgsProcessingMultiStepFeedback, for a process with the specified number of steps.
void pushDebugInfo(const QString &info) override
Pushes an informational message containing debugging helpers from the algorithm.
void pushFormattedMessage(const QString &html, const QString &text) override
Pushes a pre-formatted message from the algorithm.
void pushConsoleInfo(const QString &info) override
Pushes a console feedback message from the algorithm.
void pushInfo(const QString &info) override
Pushes a general informational message from the algorithm.
void pushWarning(const QString &warning) override
Pushes a warning informational message from the algorithm.
void setProgressText(const QString &text) override
Sets a progress report text string.
void setCurrentStep(int step)
Sets the step which is being executed.
void reportError(const QString &error, bool fatalError=false) override
Reports that the algorithm encountered an error while executing.
QString textLog() const override
Returns the plain text contents of the log, which contains all messages pushed to the feedback object...
void pushCommandInfo(const QString &info) override
Pushes an informational message containing a command from the algorithm.
QString htmlLog() const override
Returns the HTML formatted contents of the log, which contains all messages pushed to the feedback ob...
Base class for the definition of processing outputs.
Abstract base class for processing providers.
virtual QString versionInfo() const
Returns a version information string for the provider, or an empty string if this is not applicable (...
virtual QString name() const =0
Returns the provider name, which is used to describe the provider within the GUI.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm 's parent class) implements the new pure virtual createInstance(self) call