Make QgsProcessingAlgRunnerTask work correctly

nyalldawson · nyalldawson · commit e1184cd69a74 · 2017-07-07T09:28:19.000+10:00
It now safely can execute algorithms in background threads
without issues
diff --git a/python/core/processing/qgsprocessingalgrunnertask.sip b/python/core/processing/qgsprocessingalgrunnertask.sip
@@ -33,6 +33,15 @@ class QgsProcessingAlgRunnerTask : QgsTask
 
     virtual void cancel();
 
+  signals:
+
+    void executed( bool successful, const QVariantMap &results );
+%Docstring
+ Emitted when the algorithm has finished execution. If the algorithm completed
+ execution without errors then ``successful`` will be true. The ``results`` argument
+ contains the results reported by the algorithm.
+%End
+
   protected:
 
     virtual bool run();
diff --git a/src/core/processing/qgsprocessingalgrunnertask.cpp b/src/core/processing/qgsprocessingalgrunnertask.cpp
@@ -24,7 +24,6 @@
 
 QgsProcessingAlgRunnerTask::QgsProcessingAlgRunnerTask( const QgsProcessingAlgorithm *algorithm, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
   : QgsTask( tr( "Running %1" ).arg( algorithm->name() ), QgsTask::CanCancel )
-  , mParameters( parameters )
   , mContext( context )
   , mFeedback( feedback )
   , mAlgorithm( algorithm->create() )
@@ -34,6 +33,8 @@ QgsProcessingAlgRunnerTask::QgsProcessingAlgRunnerTask( const QgsProcessingAlgor
     mOwnedFeedback.reset( new QgsProcessingFeedback() );
     mFeedback = mOwnedFeedback.get();
   }
+  if ( !mAlgorithm->prepare( parameters, context, mFeedback ) )
+    cancel();
 }
 
 void QgsProcessingAlgRunnerTask::cancel()
@@ -47,7 +48,7 @@ bool QgsProcessingAlgRunnerTask::run()
   bool ok = false;
   try
   {
-    mResults = mAlgorithm->run( mParameters, mContext, mFeedback, &ok );
+    ok = mAlgorithm->runPrepared( mContext, mFeedback );
   }
   catch ( QgsProcessingException & )
   {
@@ -59,12 +60,9 @@ bool QgsProcessingAlgRunnerTask::run()
 void QgsProcessingAlgRunnerTask::finished( bool result )
 {
   Q_UNUSED( result );
-  if ( !mResults.isEmpty() )
+  if ( result )
   {
-    QgsMapLayer *layer = QgsProcessingUtils::mapLayerFromString( mResults.value( "OUTPUT_LAYER" ).toString(), mContext );
-    if ( layer )
-    {
-      mContext.project()->addMapLayer( mContext.temporaryLayerStore()->takeMapLayer( layer ) );
-    }
+    mResults = mAlgorithm->postProcess( mContext, mFeedback );
   }
+  emit executed( result, mResults );
 }
diff --git a/src/core/processing/qgsprocessingalgrunnertask.h b/src/core/processing/qgsprocessingalgrunnertask.h
@@ -49,14 +49,22 @@ class CORE_EXPORT QgsProcessingAlgRunnerTask : public QgsTask
 
     virtual void cancel() override;
 
+  signals:
+
+    /**
+     * Emitted when the algorithm has finished execution. If the algorithm completed
+     * execution without errors then \a successful will be true. The \a results argument
+     * contains the results reported by the algorithm.
+     */
+    void executed( bool successful, const QVariantMap &results );
+
   protected:
 
     virtual bool run() override;
     virtual void finished( bool result ) override;
 
   private:
 
-    QVariantMap mParameters;
     QVariantMap mResults;
     QgsProcessingContext &mContext;
     QgsProcessingFeedback *mFeedback = nullptr;

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,6 @@`
`24`	`24`
`25`	`25`	`QgsProcessingAlgRunnerTask::QgsProcessingAlgRunnerTask( const QgsProcessingAlgorithm algorithm, const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback feedback )`
`26`	`26`	`: QgsTask( tr( "Running %1" ).arg( algorithm->name() ), QgsTask::CanCancel )`
`27`		`- , mParameters( parameters )`
`28`	`27`	`, mContext( context )`
`29`	`28`	`, mFeedback( feedback )`
`30`	`29`	`, mAlgorithm( algorithm->create() )`
`@@ -34,6 +33,8 @@ QgsProcessingAlgRunnerTask::QgsProcessingAlgRunnerTask( const QgsProcessingAlgor`
`34`	`33`	`mOwnedFeedback.reset( new QgsProcessingFeedback() );`
`35`	`34`	`mFeedback = mOwnedFeedback.get();`
`36`	`35`	`}`
	`36`	`+ if ( !mAlgorithm->prepare( parameters, context, mFeedback ) )`
	`37`	`+ cancel();`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`void QgsProcessingAlgRunnerTask::cancel()`
`@@ -47,7 +48,7 @@ bool QgsProcessingAlgRunnerTask::run()`
`47`	`48`	`bool ok = false;`
`48`	`49`	`try`
`49`	`50`	`{`
`50`		`- mResults = mAlgorithm->run( mParameters, mContext, mFeedback, &ok );`
	`51`	`+ ok = mAlgorithm->runPrepared( mContext, mFeedback );`
`51`	`52`	`}`
`52`	`53`	`catch ( QgsProcessingException & )`
`53`	`54`	`{`
`@@ -59,12 +60,9 @@ bool QgsProcessingAlgRunnerTask::run()`
`59`	`60`	`void QgsProcessingAlgRunnerTask::finished( bool result )`
`60`	`61`	`{`
`61`	`62`	`Q_UNUSED( result );`
`62`		`- if ( !mResults.isEmpty() )`
	`63`	`+ if ( result )`
`63`	`64`	`{`
`64`		`- QgsMapLayer *layer = QgsProcessingUtils::mapLayerFromString( mResults.value( "OUTPUT_LAYER" ).toString(), mContext );`
`65`		`- if ( layer )`
`66`		`- {`
`67`		`- mContext.project()->addMapLayer( mContext.temporaryLayerStore()->takeMapLayer( layer ) );`
`68`		`- }`
	`65`	`+ mResults = mAlgorithm->postProcess( mContext, mFeedback );`
`69`	`66`	`}`
	`67`	`+ emit executed( result, mResults );`
`70`	`68`	`}`