[processing] Add json syntax option for encoding data defined parameter

values Refs #50482
qgis · Jan 16, 2023 · 7b29e79 · 7b29e79
1 parent 2d403b0
commit 7b29e79
Show file tree

Hide file tree

Showing 6 changed files with 103 additions and 3 deletions.
diff --git a/python/core/auto_generated/processing/qgsprocessingutils.sip.in b/python/core/auto_generated/processing/qgsprocessingutils.sip.in
@@ -496,6 +496,15 @@ Removes any raw pointer values from an input ``map``, replacing them with
 appropriate string values where possible.
 
 .. versionadded:: 3.26
+%End
+
+    static QVariantMap preprocessQgisProcessParameters( const QVariantMap &parameters, bool &ok, QString &error );
+%Docstring
+Pre-processes a set of ``parameter`` values for the qgis_process command.
+
+In particular, this function upgrades encoded data defined values to :py:class:`QgsProperty` objects.
+
+.. versionadded:: 3.30
 %End
 
 };

diff --git a/src/core/processing/qgsprocessingutils.cpp b/src/core/processing/qgsprocessingutils.cpp
@@ -1379,6 +1379,46 @@ QVariantMap QgsProcessingUtils::removePointerValuesFromMap( const QVariantMap &m
   return res;
 }
 
+QVariantMap QgsProcessingUtils::preprocessQgisProcessParameters( const QVariantMap &parameters, bool &ok, QString &error )
+{
+  QVariantMap output;
+  ok = true;
+  for ( auto it = parameters.constBegin(); it != parameters.constEnd(); ++it )
+  {
+    if ( it.value().type() == QVariant::Map )
+    {
+      const QVariantMap value = it.value().toMap();
+      if ( value.value( QStringLiteral( "type" ) ).toString() == QLatin1String( "data_defined" ) )
+      {
+        const QString expression = value.value( QStringLiteral( "expression" ) ).toString();
+        const QString field = value.value( QStringLiteral( "field" ) ).toString();
+        if ( !expression.isEmpty() )
+        {
+          output.insert( it.key(), QgsProperty::fromExpression( expression ) );
+        }
+        else if ( !field.isEmpty() )
+        {
+          output.insert( it.key(), QgsProperty::fromField( field ) );
+        }
+        else
+        {
+          ok = false;
+          error = QObject::tr( "Invalid data defined parameter for %1, requires 'expression' or 'field' values." ).arg( it.key() );
+        }
+      }
+      else
+      {
+        output.insert( it.key(), it.value() );
+      }
+    }
+    else
+    {
+      output.insert( it.key(), it.value() );
+    }
+  }
+  return output;
+}
+
 //
 // QgsProcessingFeatureSource
 //

diff --git a/src/core/processing/qgsprocessingutils.h b/src/core/processing/qgsprocessingutils.h
@@ -502,6 +502,15 @@ class CORE_EXPORT QgsProcessingUtils
      */
     static QVariantMap removePointerValuesFromMap( const QVariantMap &map );
 
+    /**
+     * Pre-processes a set of \a parameter values for the qgis_process command.
+     *
+     * In particular, this function upgrades encoded data defined values to QgsProperty objects.
+     *
+     * \since QGIS 3.30
+     */
+    static QVariantMap preprocessQgisProcessParameters( const QVariantMap &parameters, bool &ok, QString &error );
+
   private:
     static bool canUseLayer( const QgsRasterLayer *layer );
     static bool canUseLayer( const QgsMeshLayer *layer );

diff --git a/src/gui/processing/qgsprocessingalgorithmdialogbase.cpp b/src/gui/processing/qgsprocessingalgorithmdialogbase.cpp
@@ -234,7 +234,11 @@ QgsProcessingAlgorithmDialogBase::QgsProcessingAlgorithmDialogBase( QWidget *par
         if ( parameterValues.isEmpty() )
           return;
 
-        setParameters( parameterValues );
+        bool ok = false;
+        QString error;
+        const QVariantMap preparedValues = QgsProcessingUtils::preprocessQgisProcessParameters( parameterValues, ok, error );
+
+        setParameters( preparedValues );
       } );
 
       mButtonBox->addButton( mAdvancedButton, QDialogButtonBox::ResetRole );

diff --git a/src/process/qgsprocess.cpp b/src/process/qgsprocess.cpp
@@ -998,14 +998,23 @@ int QgsProcessingExec::showAlgorithmHelp( const QString &inputId, bool useJson )
   return 0;
 }
 
-int QgsProcessingExec::execute( const QString &inputId, const QVariantMap &params, const QString &ellipsoid, QgsUnitTypes::DistanceUnit distanceUnit, QgsUnitTypes::AreaUnit areaUnit, QgsProcessingContext::LogLevel logLevel, bool useJson, const QString &projectPath )
+int QgsProcessingExec::execute( const QString &inputId, const QVariantMap &inputs, const QString &ellipsoid, QgsUnitTypes::DistanceUnit distanceUnit, QgsUnitTypes::AreaUnit areaUnit, QgsProcessingContext::LogLevel logLevel, bool useJson, const QString &projectPath )
 {
   QVariantMap json;
   if ( useJson )
   {
     addVersionInformation( json );
   }
 
+  bool ok = false;
+  QString error;
+  const QVariantMap params = QgsProcessingUtils::preprocessQgisProcessParameters( inputs, ok, error );
+  if ( !ok )
+  {
+    std::cerr << error.toLocal8Bit().constData();
+    return 1;
+  }
+
   QString id = inputId;
 
   std::unique_ptr< QgsProcessingModelAlgorithm > model;
@@ -1200,7 +1209,7 @@ int QgsProcessingExec::execute( const QString &inputId, const QVariantMap &param
   } );
 #endif
 
-  bool ok = false;
+  ok = false;
   if ( !useJson )
     std::cout << "\n";
 

diff --git a/tests/src/analysis/testqgsprocessing.cpp b/tests/src/analysis/testqgsprocessing.cpp
@@ -799,6 +799,7 @@ class TestQgsProcessing: public QObject
     void sourceTypeToString_data();
     void sourceTypeToString();
     void formatHelp();
+    void preprocessParameters();
 
   private:
 
@@ -11675,6 +11676,34 @@ void TestQgsProcessing::formatHelp()
   QCOMPARE( QgsProcessingUtils::formatHelpMapAsHtml( help, &a ), QStringLiteral( "<html><body><p></p>\n<h2>Examples</h2>\n<p>aabbcc</p><br></body></html>" ) );
 }
 
+void TestQgsProcessing::preprocessParameters()
+{
+  QVariantMap inputs;
+  inputs.insert( QStringLiteral( "int" ), 5 );
+  inputs.insert( QStringLiteral( "string" ), QStringLiteral( "a string" ) );
+  inputs.insert( QStringLiteral( "data defined field" ), QVariantMap( {{QStringLiteral( "type" ), QStringLiteral( "data_defined" )}, {QStringLiteral( "field" ), QStringLiteral( "DEPTH_FIELD" ) }} ) );
+  inputs.insert( QStringLiteral( "data defined expression" ), QVariantMap( {{QStringLiteral( "type" ), QStringLiteral( "data_defined" )}, {QStringLiteral( "expression" ), QStringLiteral( "A_FIELD * 200" ) }} ) );
+  inputs.insert( QStringLiteral( "invalid" ), QVariantMap( {{QStringLiteral( "type" ), QStringLiteral( "data_defined" )}} ) );
+
+  bool ok = false;
+  QString error;
+  QVariantMap outputs = QgsProcessingUtils::preprocessQgisProcessParameters( inputs, ok, error );
+  QVERIFY( !ok );
+  QVERIFY( !error.isEmpty() );
+
+  inputs.remove( QStringLiteral( "invalid" ) );
+  error.clear();
+  outputs = QgsProcessingUtils::preprocessQgisProcessParameters( inputs, ok, error );
+  QVERIFY( ok );
+  QVERIFY( error.isEmpty() );
+
+  QCOMPARE( outputs.value( QStringLiteral( "int" ) ).toInt(), 5 );
+  QCOMPARE( outputs.value( QStringLiteral( "string" ) ).toString(), QStringLiteral( "a string" ) );
+  QCOMPARE( outputs.value( QStringLiteral( "data defined field" ) ).value< QgsProperty >().propertyType(), QgsProperty::FieldBasedProperty );
+  QCOMPARE( outputs.value( QStringLiteral( "data defined field" ) ).value< QgsProperty >().field(), QStringLiteral( "DEPTH_FIELD" ) );
+  QCOMPARE( outputs.value( QStringLiteral( "data defined expression" ) ).value< QgsProperty >().propertyType(), QgsProperty::ExpressionBasedProperty );
+  QCOMPARE( outputs.value( QStringLiteral( "data defined expression" ) ).value< QgsProperty >().expressionString(), QStringLiteral( "A_FIELD * 200" ) );
+}
 
 QGSTEST_MAIN( TestQgsProcessing )
 #include "testqgsprocessing.moc"