Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WFS] Fix filtering by QGIS expression in order to support "@geometry" (Fix #60094) #60105

Merged
merged 5 commits into from
Jan 11, 2025
+119 −32
Merged

[WFS] Fix filtering by QGIS expression in order to support "@geometry" (Fix #60094) #60105

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
57a5f33
[WFS] Fix @geometry in filter expression
agiudiceandrea Jan 10, 2025
04cf635
[WFS] Add test for @geometry in filter expression
agiudiceandrea Jan 10, 2025
cdb91f5
[WFS] Update QgsVectorLayer doc to use @geometry
agiudiceandrea Jan 10, 2025
42e7ad1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 10, 2025
9394110
[WFS] Better fix for @geometry in filter expression
agiudiceandrea Jan 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ Also note:

- You can use various functions available in the QGIS Expression list,
however the function must exist server side and have the same name and arguments to work.
- Use the special $geometry parameter to provide the layer geometry column as input
into the spatial binary operators e.g intersects($geometry, geomFromWKT('POINT (5 6)'))
- Use the special ``@geometry`` parameter to provide the layer geometry column as input
into the spatial binary operators e.g ``intersects(@geometry, geomFromWKT('POINT (5 6)'))``

OGC API Features data provider (oapif)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions python/core/auto_generated/vector/qgsvectorlayer.sip.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ Also note:

- You can use various functions available in the QGIS Expression list,
however the function must exist server side and have the same name and arguments to work.
- Use the special $geometry parameter to provide the layer geometry column as input
into the spatial binary operators e.g intersects($geometry, geomFromWKT('POINT (5 6)'))
- Use the special ``@geometry`` parameter to provide the layer geometry column as input
into the spatial binary operators e.g ``intersects(@geometry, geomFromWKT('POINT (5 6)'))``

OGC API Features data provider (oapif)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions src/core/qgsogcutils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2318,7 +2318,7 @@ static bool isGeometryColumn( const QgsExpressionNode *node )

const QgsExpressionNodeFunction *fn = static_cast<const QgsExpressionNodeFunction *>( node );
QgsExpressionFunction *fd = QgsExpression::Functions()[fn->fnIndex()];
return fd->name() == QLatin1String( "$geometry" );
return fd->name() == QLatin1String( "$geometry" ) || fn->referencedVariables().contains( QLatin1String( "geometry" ) );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not totally sure about that but couldn't there be situations where a complicated function would be used that would reference the "geometry" variable but also others, and thus would not just be "@geometry" ? If so, the following could be more appropriate:

Suggested change
return fd->name() == QLatin1String( "$geometry" ) || fn->referencedVariables().contains( QLatin1String( "geometry" ) );
return fd->name() == QLatin1String( "$geometry" ) || ( fn->referencedVariables().size() == 1 && fn->referencedVariables().contains( QLatin1String( "geometry" ) ) );

Copy link
Contributor Author

@agiudiceandrea agiudiceandrea Jan 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right! Anyway, thinking about it more carefully, it looks like even fn->referencedVariables().size() == 1 && fn->referencedVariables().contains( QLatin1String( "geometry" ) ) wouldn't reject an expression like intersects(centroid(@geometry), geomFromWKT(‘POINT (5 6)’)) while it should be.
It seems to me it should be used instead: fd->name() == QLatin1String( "var" ) && fn->referencedVariables().contains( QLatin1String( "geometry" ) )
so we ensure that the first argument is actually a "var" QgsExpressionNode::ntFunction which can only reference 1 variable, and not a generic function that references a "geometry" variable.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

t seems to me it should be used instead: fd->name() == QLatin1String( "var" ) && fn->referencedVariables().contains( QLatin1String( "geometry" ) )

yes that looks even better

agiudiceandrea marked this conversation as resolved.
Show resolved Hide resolved
}

static QgsGeometry geometryFromConstExpr( const QgsExpressionNode *node )
Expand Down Expand Up @@ -2382,7 +2382,7 @@ QDomElement QgsOgcUtilsExprToFilter::expressionFunctionToOgcFilter( const QgsExp
}
else
{
mErrorMessage = QObject::tr( "<BBOX> is currently supported only in form: bbox($geometry, geomFromWKT('…'))" );
mErrorMessage = QObject::tr( "<BBOX> is currently supported only in form: bbox(@geometry, geomFromWKT('…'))" );
return QDomElement();
}
}
Expand Down
4 changes: 2 additions & 2 deletions src/core/vector/qgsvectorlayer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,8 @@ typedef QSet<int> QgsAttributeIds;
*
* - You can use various functions available in the QGIS Expression list,
* however the function must exist server side and have the same name and arguments to work.
* - Use the special $geometry parameter to provide the layer geometry column as input
* into the spatial binary operators e.g intersects($geometry, geomFromWKT('POINT (5 6)'))
* - Use the special ``@geometry`` parameter to provide the layer geometry column as input
* into the spatial binary operators e.g ``intersects(@geometry, geomFromWKT('POINT (5 6)'))``
*
* \subsection oapif OGC API Features data provider (oapif)
*
Expand Down
135 changes: 111 additions & 24 deletions tests/src/core/testqgsogcutils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -733,26 +733,47 @@ void TestQgsOgcUtils::testExpressionToOgcFilter_data()
"</ogc:Not>"
"</ogc:Filter>" );

QTest::newRow( "intersects_bbox" ) << QStringLiteral( "intersects_bbox($geometry, geomFromWKT('POINT (5 6)'))" ) << QString( "<ogc:Filter xmlns:ogc=\"http://www.opengis.net/ogc\" xmlns:gml=\"http://www.opengis.net/gml\">"
"<ogc:BBOX>"
"<ogc:PropertyName>geometry</ogc:PropertyName>"
"<gml:Box><gml:coordinates ts=\" \" cs=\",\">5,6 5,6</gml:coordinates></gml:Box>"
"</ogc:BBOX>"
"</ogc:Filter>" );

QTest::newRow( "intersects + wkt" ) << QStringLiteral( "intersects($geometry, geomFromWKT('POINT (5 6)'))" ) << QString( "<ogc:Filter xmlns:ogc=\"http://www.opengis.net/ogc\" xmlns:gml=\"http://www.opengis.net/gml\">"
"<ogc:Intersects>"
"<ogc:PropertyName>geometry</ogc:PropertyName>"
"<gml:Point><gml:coordinates ts=\" \" cs=\",\">5,6</gml:coordinates></gml:Point>"
"</ogc:Intersects>"
"</ogc:Filter>" );

QTest::newRow( "contains + gml" ) << QStringLiteral( "contains($geometry, geomFromGML('<Point><coordinates cs=\",\" ts=\" \">5,6</coordinates></Point>'))" ) << QString( "<ogc:Filter xmlns:ogc=\"http://www.opengis.net/ogc\" xmlns:gml=\"http://www.opengis.net/gml\">"
"<ogc:Contains>"
"<ogc:PropertyName>geometry</ogc:PropertyName>"
"<Point><coordinates ts=\" \" cs=\",\">5,6</coordinates></Point>"
"</ogc:Contains>"
"</ogc:Filter>" );
QTest::newRow( "intersects_bbox $geometry" ) << QStringLiteral( "intersects_bbox($geometry, geomFromWKT('POINT (5 6)'))" ) << QString( "<ogc:Filter xmlns:ogc=\"http://www.opengis.net/ogc\" xmlns:gml=\"http://www.opengis.net/gml\">"
"<ogc:BBOX>"
"<ogc:PropertyName>geometry</ogc:PropertyName>"
"<gml:Box><gml:coordinates ts=\" \" cs=\",\">5,6 5,6</gml:coordinates></gml:Box>"
"</ogc:BBOX>"
"</ogc:Filter>" );

QTest::newRow( "intersects + wkt $geometry" ) << QStringLiteral( "intersects($geometry, geomFromWKT('POINT (5 6)'))" ) << QString( "<ogc:Filter xmlns:ogc=\"http://www.opengis.net/ogc\" xmlns:gml=\"http://www.opengis.net/gml\">"
"<ogc:Intersects>"
"<ogc:PropertyName>geometry</ogc:PropertyName>"
"<gml:Point><gml:coordinates ts=\" \" cs=\",\">5,6</gml:coordinates></gml:Point>"
"</ogc:Intersects>"
"</ogc:Filter>" );

QTest::newRow( "contains + gml $geometry" ) << QStringLiteral( "contains($geometry, geomFromGML('<Point><coordinates cs=\",\" ts=\" \">5,6</coordinates></Point>'))" ) << QString( "<ogc:Filter xmlns:ogc=\"http://www.opengis.net/ogc\" xmlns:gml=\"http://www.opengis.net/gml\">"
"<ogc:Contains>"
"<ogc:PropertyName>geometry</ogc:PropertyName>"
"<Point><coordinates ts=\" \" cs=\",\">5,6</coordinates></Point>"
"</ogc:Contains>"
"</ogc:Filter>" );

QTest::newRow( "intersects_bbox @geometry" ) << QStringLiteral( "intersects_bbox(@geometry, geomFromWKT('POINT (5 6)'))" ) << QString( "<ogc:Filter xmlns:ogc=\"http://www.opengis.net/ogc\" xmlns:gml=\"http://www.opengis.net/gml\">"
"<ogc:BBOX>"
"<ogc:PropertyName>geometry</ogc:PropertyName>"
"<gml:Box><gml:coordinates ts=\" \" cs=\",\">5,6 5,6</gml:coordinates></gml:Box>"
"</ogc:BBOX>"
"</ogc:Filter>" );

QTest::newRow( "intersects + wkt @geometry" ) << QStringLiteral( "intersects(@geometry, geomFromWKT('POINT (5 6)'))" ) << QString( "<ogc:Filter xmlns:ogc=\"http://www.opengis.net/ogc\" xmlns:gml=\"http://www.opengis.net/gml\">"
"<ogc:Intersects>"
"<ogc:PropertyName>geometry</ogc:PropertyName>"
"<gml:Point><gml:coordinates ts=\" \" cs=\",\">5,6</gml:coordinates></gml:Point>"
"</ogc:Intersects>"
"</ogc:Filter>" );

QTest::newRow( "contains + gml @geometry" ) << QStringLiteral( "contains(@geometry, geomFromGML('<Point><coordinates cs=\",\" ts=\" \">5,6</coordinates></Point>'))" ) << QString( "<ogc:Filter xmlns:ogc=\"http://www.opengis.net/ogc\" xmlns:gml=\"http://www.opengis.net/gml\">"
"<ogc:Contains>"
"<ogc:PropertyName>geometry</ogc:PropertyName>"
"<Point><coordinates ts=\" \" cs=\",\">5,6</coordinates></Point>"
"</ogc:Contains>"
"</ogc:Filter>" );
}

void TestQgsOgcUtils::testExpressionToOgcFilterWFS11()
Expand Down Expand Up @@ -791,7 +812,7 @@ void TestQgsOgcUtils::testExpressionToOgcFilterWFS11_data()
QTest::addColumn<QString>( "srsName" );
QTest::addColumn<QString>( "xmlText" );

QTest::newRow( "bbox" )
QTest::newRow( "bbox $geometry" )
<< QStringLiteral( "intersects_bbox($geometry, geomFromWKT('POLYGON((2 49,2 50,3 50,3 49,2 49))'))" )
<< QStringLiteral( "urn:ogc:def:crs:EPSG::4326" )
<< QString(
Expand All @@ -805,6 +826,21 @@ void TestQgsOgcUtils::testExpressionToOgcFilterWFS11_data()
"</ogc:BBOX>"
"</ogc:Filter>"
);

QTest::newRow( "bbox @geometry" )
<< QStringLiteral( "intersects_bbox(@geometry, geomFromWKT('POLYGON((2 49,2 50,3 50,3 49,2 49))'))" )
<< QStringLiteral( "urn:ogc:def:crs:EPSG::4326" )
<< QString(
"<ogc:Filter xmlns:ogc=\"http://www.opengis.net/ogc\" xmlns:gml=\"http://www.opengis.net/gml\">"
"<ogc:BBOX>"
"<ogc:PropertyName>my_geometry_name</ogc:PropertyName>"
"<gml:Envelope srsName=\"urn:ogc:def:crs:EPSG::4326\">"
"<gml:lowerCorner>49 2</gml:lowerCorner>"
"<gml:upperCorner>50 3</gml:upperCorner>"
"</gml:Envelope>"
"</ogc:BBOX>"
"</ogc:Filter>"
);
}

void TestQgsOgcUtils::testExpressionToOgcFilterWFS20()
Expand Down Expand Up @@ -860,7 +896,7 @@ void TestQgsOgcUtils::testExpressionToOgcFilterWFS20_data()
"</fes:PropertyIsEqualTo></fes:Filter>" )
<< QStringLiteral( "myns" ) << QStringLiteral( "http://example.com/myns" );

QTest::newRow( "bbox" )
QTest::newRow( "bbox $geometry" )
<< QStringLiteral( "intersects_bbox($geometry, geomFromWKT('POLYGON((2 49,2 50,3 50,3 49,2 49))'))" )
<< QStringLiteral( "urn:ogc:def:crs:EPSG::4326" )
<< QString(
Expand All @@ -876,7 +912,7 @@ void TestQgsOgcUtils::testExpressionToOgcFilterWFS20_data()
)
<< QString() << QString();

QTest::newRow( "bbox with namespace" )
QTest::newRow( "bbox with namespace $geometry" )
<< QStringLiteral( "intersects_bbox($geometry, geomFromWKT('POLYGON((2 49,2 50,3 50,3 49,2 49))'))" )
<< QStringLiteral( "urn:ogc:def:crs:EPSG::4326" )
<< QString(
Expand All @@ -892,7 +928,7 @@ void TestQgsOgcUtils::testExpressionToOgcFilterWFS20_data()
)
<< QStringLiteral( "myns" ) << QStringLiteral( "http://example.com/myns" );

QTest::newRow( "intersects" )
QTest::newRow( "intersects $geometry" )
<< QStringLiteral( "intersects($geometry, geomFromWKT('POLYGON((2 49,2 50,3 50,3 49,2 49))'))" )
<< QStringLiteral( "urn:ogc:def:crs:EPSG::4326" )
<< QString(
Expand All @@ -910,6 +946,57 @@ void TestQgsOgcUtils::testExpressionToOgcFilterWFS20_data()
"</fes:Filter>"
)
<< QString() << QString();

QTest::newRow( "bbox @geometry" )
<< QStringLiteral( "intersects_bbox(@geometry, geomFromWKT('POLYGON((2 49,2 50,3 50,3 49,2 49))'))" )
<< QStringLiteral( "urn:ogc:def:crs:EPSG::4326" )
<< QString(
"<fes:Filter xmlns:fes=\"http://www.opengis.net/fes/2.0\" xmlns:gml=\"http://www.opengis.net/gml/3.2\">"
"<fes:BBOX>"
"<fes:ValueReference>my_geometry_name</fes:ValueReference>"
"<gml:Envelope srsName=\"urn:ogc:def:crs:EPSG::4326\">"
"<gml:lowerCorner>49 2</gml:lowerCorner>"
"<gml:upperCorner>50 3</gml:upperCorner>"
"</gml:Envelope>"
"</fes:BBOX>"
"</fes:Filter>"
)
<< QString() << QString();

QTest::newRow( "bbox with namespace @geometry" )
<< QStringLiteral( "intersects_bbox(@geometry, geomFromWKT('POLYGON((2 49,2 50,3 50,3 49,2 49))'))" )
<< QStringLiteral( "urn:ogc:def:crs:EPSG::4326" )
<< QString(
"<fes:Filter xmlns:fes=\"http://www.opengis.net/fes/2.0\" xmlns:gml=\"http://www.opengis.net/gml/3.2\" xmlns:myns=\"http://example.com/myns\">"
"<fes:BBOX>"
"<fes:ValueReference>myns:my_geometry_name</fes:ValueReference>"
"<gml:Envelope srsName=\"urn:ogc:def:crs:EPSG::4326\">"
"<gml:lowerCorner>49 2</gml:lowerCorner>"
"<gml:upperCorner>50 3</gml:upperCorner>"
"</gml:Envelope>"
"</fes:BBOX>"
"</fes:Filter>"
)
<< QStringLiteral( "myns" ) << QStringLiteral( "http://example.com/myns" );

QTest::newRow( "intersects @geometry" )
<< QStringLiteral( "intersects(@geometry, geomFromWKT('POLYGON((2 49,2 50,3 50,3 49,2 49))'))" )
<< QStringLiteral( "urn:ogc:def:crs:EPSG::4326" )
<< QString(
"<fes:Filter xmlns:fes=\"http://www.opengis.net/fes/2.0\" xmlns:gml=\"http://www.opengis.net/gml/3.2\">"
"<fes:Intersects>"
"<fes:ValueReference>my_geometry_name</fes:ValueReference>"
"<gml:Polygon gml:id=\"qgis_id_geom_1\" srsName=\"urn:ogc:def:crs:EPSG::4326\">"
"<gml:exterior>"
"<gml:LinearRing>"
"<gml:posList srsDimension=\"2\">49 2 50 2 50 3 49 3 49 2</gml:posList>"
"</gml:LinearRing>"
"</gml:exterior>"
"</gml:Polygon>"
"</fes:Intersects>"
"</fes:Filter>"
)
<< QString() << QString();
}

Q_DECLARE_METATYPE( QgsOgcUtils::GMLVersion )
Expand Down
Loading