30 , mInterface( interface )
37 qDeleteAll( mExternalLayers );
38 mExternalLayers.clear();
45 initRestrictedLayers();
48 searchLayersToRender();
49 removeUnwantedLayers();
50 checkLayerReadPermissions();
52 std::reverse( mLayersToRender.begin(), mLayersToRender.end() );
69 return mFlags.testFlag( flag );
92 if ( mSlds.contains( nickname ) )
94 sld = mSlds[ nickname ];
105 if ( mStyles.contains( nickname ) )
107 style = mStyles[ nickname ];
117 const QList<QgsWmsParametersLayer> cLayerParams { mParameters.
layersParameters() };
119 for (
const auto ¶ms : std::as_const( cLayerParams ) )
179 if ( !mParameters.
dpi().isEmpty() )
190 std::function <QStringList(
const QString &name )> findLeaves = [ & ](
const QString & name ) -> QStringList
193 if ( mLayerGroups.contains( name ) )
195 const auto &
layers { mLayerGroups[ name ] };
196 for (
const auto &l :
layers )
200 if ( mLayerGroups.contains( nick ) )
202 _result.append( name );
206 _result.append( findLeaves( nick ) );
212 _result.append( name );
217 for (
const auto &name : std::as_const( layerNames ) )
219 result.append( findLeaves( name ) );
226 return mLayersToRender;
231 return mNicknameLayers.values();
236 double denominator = -1;
238 if ( mScaleDenominator >= 0 )
240 denominator = mScaleDenominator;
253 removeUnwantedLayers();
273 std::find_if( mExternalLayers.cbegin(), mExternalLayers.cend(),
276 return l->id() == layer.id();
277 } ) == mExternalLayers.cend() )
281 else if ( name.isEmpty() )
293 for (
auto layer : mLayersToRender )
307 return layer( nickname ) !=
nullptr;
312 return mLayerGroups.value( nickname );
317 return mLayerGroups.contains( name );
320void QgsWmsRenderContext::initNicknameLayers()
331 initLayerGroupsRecursive( root, rootName.isEmpty() ? mProject->
title() : rootName );
334void QgsWmsRenderContext::initLayerGroupsRecursive(
const QgsLayerTreeGroup *group,
const QString &groupName )
336 if ( !groupName.isEmpty() )
338 mLayerGroups[groupName] = QList<QgsMapLayer *>();
339 const auto projectLayerTreeRoot { mProject->
layerTreeRoot() };
340 const auto treeGroupLayers { group->
findLayers() };
343 if ( ! projectLayerTreeRoot->hasCustomLayerOrder() )
345 for (
const auto &tl : treeGroupLayers )
347 mLayerGroups[groupName].push_back( tl->layer() );
352 const auto projectLayerOrder { projectLayerTreeRoot->layerOrder() };
354 QList<QgsMapLayer *> groupLayersList;
355 for (
const auto &tl : treeGroupLayers )
357 groupLayersList << tl->layer();
359 for (
const auto &l : projectLayerOrder )
361 if ( groupLayersList.contains( l ) )
363 mLayerGroups[groupName].push_back( l );
373 QString name = child->customProperty( QStringLiteral(
"wmsShortName" ) ).toString();
375 if ( name.isEmpty() )
376 name = child->name();
378 initLayerGroupsRecursive(
static_cast<const QgsLayerTreeGroup *
>( child ), name );
384void QgsWmsRenderContext::initRestrictedLayers()
386 mRestrictedLayers.clear();
392 QStringList restrictedLayersNames;
395 for (
const QString &l : std::as_const( restricted ) )
400 const QList<QgsLayerTreeLayer *> groupLayers = group->
findLayers();
403 restrictedLayersNames.append( treeLayer->name() );
408 restrictedLayersNames.append( l );
416 if ( restrictedLayersNames.contains(
layer->
name() ) )
423void QgsWmsRenderContext::searchLayersToRender()
425 mLayersToRender.clear();
429 if ( ! mParameters.
sldBody().isEmpty() )
431 searchLayersToRenderSld();
435 searchLayersToRenderStyle();
441 for (
const QString &layerName : queryLayerNames )
443 const QList<QgsMapLayer *>
layers = mNicknameLayers.values( layerName );
445 if ( !mLayersToRender.contains( lyr ) )
447 mLayersToRender.append( lyr );
455 for (
const QString &layerName : queryLayerNames )
457 const QList<QgsMapLayer *>
layers = mNicknameLayers.values( layerName );
459 if ( !mLayersToRender.contains( lyr ) )
461 mLayersToRender.append( lyr );
467void QgsWmsRenderContext::searchLayersToRenderSld()
477 ( void )doc.setContent(
sld,
true );
478 QDomElement docEl = doc.documentElement();
480 QDomElement root = doc.firstChildElement(
"StyledLayerDescriptor" );
481 QDomElement namedElem = root.firstChildElement(
"NamedLayer" );
483 if ( docEl.isNull() )
488 QDomNodeList named = docEl.elementsByTagName(
"NamedLayer" );
489 for (
int i = 0; i < named.size(); ++i )
491 QDomNodeList names = named.item( i ).toElement().elementsByTagName(
"Name" );
492 if ( !names.isEmpty() )
494 QString lname = names.item( 0 ).toElement().text();
495 if ( mNicknameLayers.contains( lname ) )
497 mSlds[lname] = namedElem;
498 mLayersToRender.append( mNicknameLayers.values( lname ) );
500 else if ( mLayerGroups.contains( lname ) )
505 param.mValue = lname;
512 mSlds[name] = namedElem;
513 mLayersToRender.insert( 0,
layer );
519 param.mValue = lname;
527void QgsWmsRenderContext::searchLayersToRenderStyle()
531 const QString nickname = param.mNickname;
532 const QString
style = param.mStyle;
537 std::unique_ptr<QgsMapLayer>
layer = std::make_unique< QgsRasterLayer >( param.mExternalUri, param.mNickname, QStringLiteral(
"wms" ) );
542 mExternalLayers.append(
layer.release() );
543 mLayersToRender.append( mExternalLayers.last() );
546 else if ( mNicknameLayers.contains( nickname ) )
548 if ( !
style.isEmpty() )
550 mStyles[nickname] =
style;
553 mLayersToRender.append( mNicknameLayers.values( nickname ) );
555 else if ( mLayerGroups.contains( nickname ) )
560 param.mValue = nickname;
569 if ( !
style.isEmpty() )
571 mStyles[ nickname ] =
style;
578 mLayersToRender.append( mNicknameLayers.values( name ) );
584 param.mValue = nickname;
591bool QgsWmsRenderContext::layerScaleVisibility(
const QString &name )
const
593 bool visible =
false;
595 if ( ! mNicknameLayers.contains( name ) )
600 const QList<QgsMapLayer *>
layers = mNicknameLayers.values( name );
604 bool useScaleConstraint = (
scaleDenominator() > 0 && scaleBasedVisibility );
659 if ( wmsMaxWidthEnv != -1 && wmsMaxWidthProj != -1 )
662 wmsMaxWidth = std::min( wmsMaxWidthProj, wmsMaxWidthEnv );
667 wmsMaxWidth = std::max( wmsMaxWidthProj, wmsMaxWidthEnv );
670 if ( wmsMaxWidth != -1 && width > wmsMaxWidth )
679 if ( wmsMaxHeightEnv != -1 && wmsMaxHeightProj != -1 )
682 wmsMaxHeight = std::min( wmsMaxHeightProj, wmsMaxHeightEnv );
687 wmsMaxHeight = std::max( wmsMaxHeightProj, wmsMaxHeightEnv );
690 if ( wmsMaxHeight != -1 && height > wmsMaxHeight )
703 switch ( mParameters.
format() )
711 const int bytes_per_line = ( ( width * depth + 31 ) >> 5 ) << 2;
713 if ( std::numeric_limits<int>::max() / depth < static_cast<uint>( width )
714 || bytes_per_line <= 0
716 || std::numeric_limits<int>::max() /
static_cast<uint
>( bytes_per_line ) <
static_cast<uint
>( height )
717 || std::numeric_limits<int>::max() /
sizeof( uchar * ) <
static_cast<uint
>( height ) )
731 if ( !mParameters.
bbox().isEmpty() && extent.
isEmpty() )
756 if ( !mParameters.
bbox().isEmpty() && extent.
isEmpty() )
762 QString
crs = mParameters.
crs();
763 if (
crs.compare(
"CRS:84", Qt::CaseInsensitive ) == 0 )
765 crs = QString(
"EPSG:4326" );
775 if ( !extent.
isEmpty() && height > 0 && width > 0 )
777 const double mapRatio = extent.
width() / extent.
height();
778 const double imageRatio =
static_cast<double>( width ) /
static_cast<double>( height );
782 const double cellsize = ( extent.
width() /
static_cast<double>( width ) ) * 0.5 + ( extent.
height() /
static_cast<double>( height ) ) * 0.5;
783 width = extent.
width() / cellsize;
784 height = extent.
height() / cellsize;
794 else if ( height <= 0 )
800 return QSize( width, height );
803void QgsWmsRenderContext::removeUnwantedLayers()
805 QList<QgsMapLayer *>
layers;
813 if ( !layerScaleVisibility( nickname ) )
816 if ( mRestrictedLayers.contains( nickname ) )
827 if ( ! wfsLayers.contains(
layer->
id() ) )
842 for (
const auto &
layer : mExternalLayers )
851void QgsWmsRenderContext::checkLayerReadPermissions()
853#ifdef HAVE_SERVER_PYTHON_PLUGINS
854 for (
const auto layer : mLayersToRender )
856 if ( !accessControl()->layerReadPermission(
layer ) )
864#ifdef HAVE_SERVER_PYTHON_PLUGINS
873 mSocketFeedback = feedback;
878 return mSocketFeedback;
A helper class that centralizes restrictions given by all the access control filter plugins.
Exception thrown in case of malformed request.
This class represents a coordinate reference system (CRS).
static QgsCoordinateReferenceSystem fromOgcWmsCrs(const QString &ogcCrs)
Creates a CRS from a given OGC WMS-format Coordinate Reference System string.
bool hasAxisInverted() const
Returns whether the axis order is inverted for the CRS compared to the order east/north (longitude/la...
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Layer tree group node serves as a container for layers and further groups.
QgsLayerTreeGroup * findGroup(const QString &name)
Find group node with specified name.
QList< QgsLayerTreeLayer * > findLayers() const
Find all layer nodes.
Layer tree node points to a map layer.
This class is a base class for nodes in a layer tree.
@ NodeGroup
Container of other groups and layers.
Base class for all map layer types.
bool isInScaleRange(double scale) const
Tests whether the layer should be visible at the specified scale.
QString id() const
Returns the layer's unique ID, which is used to access this layer from QgsProject.
QString shortName() const
Returns the short name of the layer used by QGIS Server to identify the layer.
bool hasScaleBasedVisibility() const
Returns whether scale based visibility is enabled for the layer.
A class to describe the version of a project.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
QString title() const
Returns the project's title.
QgsLayerTree * layerTreeRoot() const
Returns pointer to the root (invisible) node of the project's layer tree.
A rectangle specified with double values.
double width() const
Returns the width of the rectangle.
bool isEmpty() const
Returns true if the rectangle has no area.
double height() const
Returns the height of the rectangle.
void invert()
Swap x/y coordinates in the rectangle.
QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins.
virtual QgsAccessControl * accessControls() const =0
Gets the registered access control filters.
virtual QgsServerSettings * serverSettings()=0
Returns the server settings.
Provides a way to retrieve settings by prioritizing according to environment variables,...
int wmsMaxWidth() const
Returns the server-wide max width of a WMS GetMap request.
int wmsMaxHeight() const
Returns the server-wide max height of a WMS GetMap request.
Exception thrown in case of malformed request.
Exception thrown when data access violates access controls.
@ QGIS_InvalidParameterValue
WMS parameter received from the client.
Provides an interface to retrieve and manipulate WMS parameters received from the client.
int wmsPrecisionAsInt() const
Returns WMS_PRECISION parameter as an int or its default value if not defined.
QStringList allLayersNickname() const
Returns nickname of layers found in LAYER and LAYERS parameters.
QgsProjectVersion versionAsNumber() const
Returns VERSION parameter if defined or its default value.
QString scale() const
Returns SCALE parameter or an empty string if none is defined.
double scaleAsDouble() const
Returns SCALE as a double.
QgsRectangle bboxAsRectangle() const
Returns BBOX as a rectangle if defined and valid.
double dpiAsDouble() const
Returns DPI parameter as an int or its default value if not defined.
QList< QgsWmsParametersLayer > layersParameters() const
Returns parameters for each layer found in LAYER/LAYERS.
QString bbox() const
Returns BBOX if defined or an empty string.
int heightAsInt() const
Returns HEIGHT parameter as an int or its default value if not defined.
Format format() const
Returns format.
int widthAsInt() const
Returns WIDTH parameter as an int or its default value if not defined.
QString sldBody() const
Returns SLD_body if defined or an empty string.
int imageQualityAsInt() const
Returns IMAGE_QUALITY parameter as an integer.
int srcHeightAsInt() const
Returns SRCHEIGHT parameter as an int or its default value if not defined.
QString imageQuality() const
Returns IMAGE_QUALITY parameter or an empty string if not defined.
QString crs() const
Returns CRS or an empty string if none is defined.
bool tiledAsBool() const
Returns TILED parameter as a boolean.
QString dpi() const
Returns DPI parameter or an empty string if not defined.
QStringList queryLayersNickname() const
Returns nickname of layers found in QUERY_LAYERS parameter.
int srcWidthAsInt() const
Returns SRCWIDTH parameter as an int or its default value if not defined.
QSize mapSize(bool aspectRatio=true) const
Returns the size (in pixels) of the map to render, according to width and height WMS parameters as we...
bool isExternalLayer(const QString &name) const
Returns true if the layer is an external layer, false otherwise.
bool isValidGroup(const QString &name) const
Returns true if name is a group.
QStringList flattenedQueryLayers(const QStringList &layerNames) const
Returns a list of query layer names where group names are replaced by the names of their layer compon...
QgsFeedback * socketFeedback() const
Returns the response feedback if any.
~QgsWmsRenderContext()
Destructor for QgsWmsRenderContext.
QgsWmsRenderContext(const QgsProject *project, QgsServerInterface *interface)
Constructor for QgsWmsRenderContext.
QList< QgsMapLayer * > layers() const
Returns a list of all layers read from the project.
void setParameters(const QgsWmsParameters ¶meters)
Sets WMS parameters.
QList< QgsMapLayer * > layersToRender() const
Returns a list of all layers to actually render according to the current configuration.
int mapWidth() const
Returns WIDTH or SRCWIDTH according to UseSrcWidthHeight flag.
QgsMapLayer * layer(const QString &nickname) const
Returns the layer corresponding to the nickname, or a nullptr if not found or if the layer do not nee...
int tileBuffer() const
Returns the tile buffer value to use for rendering according to the current configuration.
bool updateExtent() const
Returns true if the extent has to be updated before the rendering, false otherwise.
const QgsServerSettings & settings() const
Returns settings of the server.
void setFlag(Flag flag, bool on=true)
Sets or unsets a rendering flag according to the on value.
bool isValidWidthHeight() const
Returns true if width and height are valid according to the maximum values defined within the project...
QList< QgsMapLayer * > layersFromGroup(const QString &nickname) const
Returns the group's layers list corresponding to the nickname, or an empty list if not found.
QgsWmsParameters parameters() const
Returns WMS parameters.
void setScaleDenominator(double scaleDenominator)
Sets a custom scale denominator.
QString style(const QgsMapLayer &layer) const
Returns a style's name for a specific layer.
QMap< QString, QList< QgsMapLayer * > > layerGroups() const
Returns a map having layer group names as keys and a list of layers as values.
double mapTileBuffer(int mapWidth) const
Returns the tile buffer in geographical units for the given map width in pixels.
QString layerNickname(const QgsMapLayer &layer) const
Returns the nickname (short name, id or name) of the layer according to the current configuration.
void setSocketFeedback(QgsFeedback *feedback)
Sets the response feedback.
double scaleDenominator() const
Returns the scale denominator to use for rendering according to the current configuration.
qreal dotsPerMm() const
Returns default dots per mm according to the current configuration.
bool testFlag(Flag flag) const
Returns the status of a rendering flag.
QDomElement sld(const QgsMapLayer &layer) const
Returns a SLD document for a specific layer.
bool isValidLayer(const QString &nickname) const
Returns true if the layer has to be rendered, false otherwise.
const QgsProject * project() const
Returns the project.
int precision() const
Returns the precision to use according to the current configuration.
int imageQuality() const
Returns the image quality to use for rendering according to the current configuration.
int mapHeight() const
Returns HEIGHT or SRCHEIGHT according to UseSrcWidthHeight flag.
bool renderMapTiles() const
Returns true if WMS requests should use the QgsMapSettings::RenderMapTile flag, so that no visible ar...
Flag
Available rendering options.
@ AddAllLayers
For GetPrint: add layers from LAYER(S) parameter.
SERVER_EXPORT int wmsTileBuffer(const QgsProject &project)
Returns the tile buffer in pixels for WMS images defined in a QGIS project.
SERVER_EXPORT QString wmsRootName(const QgsProject &project)
Returns the WMS root layer name defined in a QGIS project.
SERVER_EXPORT bool wmsSkipNameForGroup(const QgsProject &project)
Returns if name attribute should be skipped for groups in WMS capabilities document.
SERVER_EXPORT int wmsFeatureInfoPrecision(const QgsProject &project)
Returns the geometry precision for GetFeatureInfo request.
SERVER_EXPORT bool wmsUseLayerIds(const QgsProject &project)
Returns if layer ids are used as name in WMS.
SERVER_EXPORT QStringList wfsLayerIds(const QgsProject &project)
Returns the Layer ids list defined in a QGIS project as published in WFS.
SERVER_EXPORT bool wmsRenderMapTiles(const QgsProject &project)
Returns true if WMS requests should use the QgsMapSettings::RenderMapTile flag, so that no visible ar...
SERVER_EXPORT QStringList wmsRestrictedLayers(const QgsProject &project)
Returns the restricted layer name list.
SERVER_EXPORT int wmsImageQuality(const QgsProject &project)
Returns the quality for WMS images defined in a QGIS project.
SERVER_EXPORT int wmsMaxWidth(const QgsProject &project)
Returns the maximum width for WMS images defined in a QGIS project.
SERVER_EXPORT int wmsMaxHeight(const QgsProject &project)
Returns the maximum height for WMS images defined in a QGIS project.
Median cut implementation.
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
const QgsCoordinateReferenceSystem & outputCrs
const QgsCoordinateReferenceSystem & crs