35#include <QRegularExpression>
41 void appendOwsLayerStyles( QDomDocument &doc, QDomElement &layerElem,
QgsMapLayer *currentLayer );
43 void appendOwsLayersFromTreeGroup( QDomDocument &doc,
44 QDomElement &parentLayer,
47 const QgsWmsRequest &request,
50 const QString &strGroup );
52 void appendOwsGeneralAndResourceList( QDomDocument &doc, QDomElement &parentElement,
54 const QgsWmsRequest &request );
61#ifdef HAVE_SERVER_PYTHON_PLUGINS
66 const QDomDocument *contextDocument =
nullptr;
68#ifdef HAVE_SERVER_PYTHON_PLUGINS
70 if ( cacheManager && cacheManager->
getCachedDocument( &doc, project, request, accessControl ) )
72 contextDocument = &doc;
76 doc =
getContext( serverIface, project, request );
82 contextDocument = &doc;
85 doc =
getContext( serverIface, project, request );
86 contextDocument = &doc;
88 response.
setHeader( QStringLiteral(
"Content-Type" ), QStringLiteral(
"text/xml; charset=utf-8" ) );
89 response.
write( contextDocument->toByteArray() );
98 const QDomProcessingInstruction xmlDeclaration = doc.createProcessingInstruction( QStringLiteral(
"xml" ),
99 QStringLiteral(
"version=\"1.0\" encoding=\"utf-8\"" ) );
101 doc.appendChild( xmlDeclaration );
103 QDomElement owsContextElem = doc.createElement( QStringLiteral(
"OWSContext" ) );
104 owsContextElem.setAttribute( QStringLiteral(
"xmlns" ), QStringLiteral(
"http://www.opengis.net/ows-context" ) );
105 owsContextElem.setAttribute( QStringLiteral(
"xmlns:ows-context" ), QStringLiteral(
"http://www.opengis.net/ows-context" ) );
106 owsContextElem.setAttribute( QStringLiteral(
"xmlns:context" ), QStringLiteral(
"http://www.opengis.net/context" ) );
107 owsContextElem.setAttribute( QStringLiteral(
"xmlns:ows" ), QStringLiteral(
"http://www.opengis.net/ows" ) );
108 owsContextElem.setAttribute( QStringLiteral(
"xmlns:sld" ), QStringLiteral(
"http://www.opengis.net/sld" ) );
109 owsContextElem.setAttribute( QStringLiteral(
"xmlns:ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) );
110 owsContextElem.setAttribute( QStringLiteral(
"xmlns:gml" ), QStringLiteral(
"http://www.opengis.net/gml" ) );
111 owsContextElem.setAttribute( QStringLiteral(
"xmlns:kml" ), QStringLiteral(
"http://www.opengis.net/kml/2.2" ) );
112 owsContextElem.setAttribute( QStringLiteral(
"xmlns:xlink" ), QStringLiteral(
"http://www.w3.org/1999/xlink" ) );
113 owsContextElem.setAttribute( QStringLiteral(
"xmlns:ns9" ), QStringLiteral(
"http://www.w3.org/2005/Atom" ) );
114 owsContextElem.setAttribute( QStringLiteral(
"xmlns:xal" ), QStringLiteral(
"urn:oasis:names:tc:ciq:xsdschema:xAL:2.0" ) );
115 owsContextElem.setAttribute( QStringLiteral(
"xmlns:ins" ), QStringLiteral(
"http://www.inspire.org" ) );
116 owsContextElem.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"0.3.1" ) );
117 doc.appendChild( owsContextElem );
119 appendOwsGeneralAndResourceList( doc, owsContextElem, serverIface, project, request );
125 void appendOwsGeneralAndResourceList( QDomDocument &doc, QDomElement &parentElement,
127 const QgsWmsRequest &request )
129 parentElement.setAttribute( QStringLiteral(
"id" ),
"ows-context-" + project->
baseName() );
132 QDomElement generalElem = doc.createElement( QStringLiteral(
"General" ) );
135 QDomElement windowElem = doc.createElement( QStringLiteral(
"Window" ) );
136 windowElem.setAttribute( QStringLiteral(
"height" ), QStringLiteral(
"600" ) );
137 windowElem.setAttribute( QStringLiteral(
"width" ), QStringLiteral(
"800" ) );
138 generalElem.appendChild( windowElem );
142 QDomElement titleElem = doc.createElement( QStringLiteral(
"ows:Title" ) );
143 const QDomText titleText = doc.createTextNode( title );
144 titleElem.appendChild( titleText );
145 generalElem.appendChild( titleElem );
149 if ( !abstract.isEmpty() )
151 QDomElement abstractElem = doc.createElement( QStringLiteral(
"ows:Abstract" ) );
152 const QDomText abstractText = doc.createCDATASection( abstract );
153 abstractElem.appendChild( abstractText );
154 generalElem.appendChild( abstractElem );
159 if ( !keywords.isEmpty() )
163 QDomElement keywordsElem = doc.createElement( QStringLiteral(
"ows:Keywords" ) );
165 for (
int i = 0; i < keywords.size(); ++i )
167 const QString keyword = keywords.at( i );
168 if ( !keyword.isEmpty() )
170 QDomElement keywordElem = doc.createElement( QStringLiteral(
"ows:Keyword" ) );
171 const QDomText keywordText = doc.createTextNode( keyword );
172 keywordElem.appendChild( keywordText );
175 keywordElem.setAttribute( QStringLiteral(
"vocabulary" ), QStringLiteral(
"SIA_Geo405" ) );
177 keywordsElem.appendChild( keywordElem );
180 generalElem.appendChild( keywordsElem );
184 parentElement.appendChild( generalElem );
187 QDomElement resourceListElem = doc.createElement( QStringLiteral(
"ResourceList" ) );
190 appendOwsLayersFromTreeGroup( doc, resourceListElem, serverIface, project, request, projectLayerTreeRoot, combinedBBox, QString() );
191 parentElement.appendChild( resourceListElem );
198 mapRect = combinedBBox;
200 QDomElement bboxElem = doc.createElement( QStringLiteral(
"ows:BoundingBox" ) );
201 bboxElem.setAttribute( QStringLiteral(
"crs" ), projectCrs.
authid() );
206 QDomElement lowerCornerElem = doc.createElement( QStringLiteral(
"ows:LowerCorner" ) );
207 const QDomText lowerCornerText = doc.createTextNode( QString::number( mapRect.
xMinimum() ) +
" " + QString::number( mapRect.
yMinimum() ) );
208 lowerCornerElem.appendChild( lowerCornerText );
209 bboxElem.appendChild( lowerCornerElem );
210 QDomElement upperCornerElem = doc.createElement( QStringLiteral(
"ows:UpperCorner" ) );
211 const QDomText upperCornerText = doc.createTextNode( QString::number( mapRect.
xMaximum() ) +
" " + QString::number( mapRect.
yMaximum() ) );
212 upperCornerElem.appendChild( upperCornerText );
213 bboxElem.appendChild( upperCornerElem );
214 generalElem.appendChild( bboxElem );
217 void appendOwsLayersFromTreeGroup( QDomDocument &doc,
218 QDomElement &parentLayer,
221 const QgsWmsRequest &request,
224 const QString &strGroup )
228 const QList< QgsLayerTreeNode * > layerTreeGroupChildren = layerTreeGroup->
children();
229 for (
int i = 0; i < layerTreeGroupChildren.size(); ++i )
237 const QString name = treeGroupChild->
name();
238 if ( restrictedLayers.contains( name ) )
244 if ( strGroup.isEmpty() )
250 group = strGroup +
"/" + name;
253 appendOwsLayersFromTreeGroup( doc, parentLayer, serverIface, project, request, treeGroupChild, combinedBBox, group );
259 if ( restrictedLayers.contains( l->
name() ) )
263#ifdef HAVE_SERVER_PYTHON_PLUGINS
270 QDomElement layerElem = doc.createElement( QStringLiteral(
"Layer" ) );
275 layerElem.setAttribute( QStringLiteral(
"queryable" ), QStringLiteral(
"false" ) );
279 layerElem.setAttribute( QStringLiteral(
"queryable" ), QStringLiteral(
"true" ) );
285 layerElem.setAttribute( QStringLiteral(
"hidden" ), QStringLiteral(
"false" ) );
289 layerElem.setAttribute( QStringLiteral(
"hidden" ), QStringLiteral(
"true" ) );
293 if ( !strGroup.isEmpty() )
295 layerElem.setAttribute( QStringLiteral(
"group" ), strGroup );
300 layerElem.setAttribute( QStringLiteral(
"opacity" ), 1 );
302 QString wmsName = l->
name();
312 layerElem.setAttribute( QStringLiteral(
"name" ), wmsName );
314 const thread_local QRegularExpression sRegEx( QStringLiteral(
"[\\W]" ), QRegularExpression::UseUnicodePropertiesOption );
315 layerElem.setAttribute( QStringLiteral(
"id" ), wmsName.replace( sRegEx, QStringLiteral(
"_" ) ) );
318 QDomElement titleElem = doc.createElement( QStringLiteral(
"ows:Title" ) );
320 if ( title.isEmpty() )
324 const QDomText titleText = doc.createTextNode( title );
325 titleElem.appendChild( titleText );
326 layerElem.appendChild( titleElem );
329 QDomElement formatElem = doc.createElement( QStringLiteral(
"ows:OutputFormat" ) );
330 const QDomText formatText = doc.createTextNode( QStringLiteral(
"image/png" ) );
331 formatElem.appendChild( formatText );
332 layerElem.appendChild( formatElem );
338 QString hrefString = href.toString();
339 hrefString.append( href.hasQuery() ?
"&" :
"?" );
342 QDomElement serverElem = doc.createElement( QStringLiteral(
"Server" ) );
343 serverElem.setAttribute( QStringLiteral(
"service" ), QStringLiteral(
"urn:ogc:serviceType:WMS" ) );
344 serverElem.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"1.3.0" ) );
345 serverElem.setAttribute( QStringLiteral(
"default" ), QStringLiteral(
"true" ) );
346 QDomElement orServerElem = doc.createElement( QStringLiteral(
"OnlineResource" ) );
347 orServerElem.setAttribute( QStringLiteral(
"xlink:href" ), hrefString );
348 serverElem.appendChild( orServerElem );
349 layerElem.appendChild( serverElem );
352 if ( !abstract.isEmpty() )
354 QDomElement abstractElem = doc.createElement( QStringLiteral(
"ows:Abstract" ) );
355 const QDomText abstractText = doc.createTextNode( abstract );
356 abstractElem.appendChild( abstractText );
357 layerElem.appendChild( abstractElem );
363 const QString minScaleString = QString::number( l->
maximumScale() );
364 const QString maxScaleString = QString::number( l->
minimumScale() );
365 QDomElement minScaleElem = doc.createElement( QStringLiteral(
"sld:MinScaleDenominator" ) );
366 const QDomText minScaleText = doc.createTextNode( minScaleString );
367 minScaleElem.appendChild( minScaleText );
368 layerElem.appendChild( minScaleElem );
369 QDomElement maxScaleElem = doc.createElement( QStringLiteral(
"sld:MaxScaleDenominator" ) );
370 const QDomText maxScaleText = doc.createTextNode( maxScaleString );
371 maxScaleElem.appendChild( maxScaleText );
372 layerElem.appendChild( maxScaleElem );
376 appendOwsLayerStyles( doc, layerElem, l );
384 QDomElement keywordsElem = doc.createElement( QStringLiteral(
"ows:Keywords" ) );
385 for (
int i = 0; i < keywordStringList.size(); ++i )
387 QDomElement keywordElem = doc.createElement( QStringLiteral(
"ows:Keyword" ) );
388 const QDomText keywordText = doc.createTextNode( keywordStringList.at( i ).trimmed() );
389 keywordElem.appendChild( keywordText );
392 keywordElem.setAttribute( QStringLiteral(
"vocabulary" ), QStringLiteral(
"SIA_Geo405" ) );
394 keywordsElem.appendChild( keywordElem );
396 layerElem.appendChild( keywordsElem );
401 if ( !dataUrl.isEmpty() )
403 QDomElement dataUrlElem = doc.createElement( QStringLiteral(
"DataURL" ) );
405 dataUrlElem.setAttribute( QStringLiteral(
"format" ), dataUrlFormat );
406 QDomElement dataORElem = doc.createElement( QStringLiteral(
"OnlineResource" ) );
407 dataORElem.setAttribute( QStringLiteral(
"xmlns:xlink" ), QStringLiteral(
"http://www.w3.org/1999/xlink" ) );
408 dataORElem.setAttribute( QStringLiteral(
"xlink:type" ), QStringLiteral(
"simple" ) );
409 dataORElem.setAttribute( QStringLiteral(
"xlink:href" ), dataUrl );
410 dataUrlElem.appendChild( dataORElem );
411 layerElem.appendChild( dataUrlElem );
418 QDomElement metaUrlElem = doc.createElement( QStringLiteral(
"MetadataURL" ) );
419 metaUrlElem.setAttribute( QStringLiteral(
"format" ), url.format );
420 QDomElement metaUrlORElem = doc.createElement( QStringLiteral(
"OnlineResource" ) );
421 metaUrlORElem.setAttribute( QStringLiteral(
"xmlns:xlink" ), QStringLiteral(
"http://www.w3.org/1999/xlink" ) );
422 metaUrlORElem.setAttribute( QStringLiteral(
"xlink:type" ), QStringLiteral(
"simple" ) );
423 metaUrlORElem.setAttribute( QStringLiteral(
"xlink:href" ), url.url );
424 metaUrlElem.appendChild( metaUrlORElem );
425 layerElem.appendChild( metaUrlElem );
447 if ( parentLayer.hasChildNodes() )
449 parentLayer.insertBefore( layerElem, parentLayer.firstChild() );
453 parentLayer.appendChild( layerElem );
459 void appendOwsLayerStyles( QDomDocument &doc, QDomElement &layerElem,
QgsMapLayer *currentLayer )
461 for (
const QString &styleName : currentLayer->styleManager()->styles() )
463 QDomElement styleListElem = doc.createElement( QStringLiteral(
"StyleList" ) );
465 QDomElement styleElem = doc.createElement( QStringLiteral(
"Style" ) );
466 styleElem.setAttribute( QStringLiteral(
"current" ), QStringLiteral(
"true" ) );
467 QDomElement styleNameElem = doc.createElement( QStringLiteral(
"Name" ) );
468 const QDomText styleNameText = doc.createTextNode( styleName );
469 styleNameElem.appendChild( styleNameText );
470 QDomElement styleTitleElem = doc.createElement( QStringLiteral(
"Title" ) );
471 const QDomText styleTitleText = doc.createTextNode( styleName );
472 styleTitleElem.appendChild( styleTitleText );
473 styleElem.appendChild( styleNameElem );
474 styleElem.appendChild( styleTitleElem );
475 styleListElem.appendChild( styleElem );
476 layerElem.appendChild( styleListElem );
A helper class that centralizes restrictions given by all the access control filter plugins.
bool layerReadPermission(const QgsMapLayer *layer) const
Returns the layer read right.
This class represents a coordinate reference system (CRS).
bool hasAxisInverted() const
Returns whether the axis order is inverted for the CRS compared to the order east/north (longitude/la...
Custom exception class for Coordinate Reference System related exceptions.
Layer tree group node serves as a container for layers and further groups.
QString name() const override
Returns the group's name.
Layer tree node points to a map layer.
QgsMapLayer * layer() const
Returns the map layer associated with this node.
This class is a base class for nodes in a layer tree.
@ NodeGroup
Container of other groups and layers.
QList< QgsLayerTreeNode * > children()
Gets list of children of the node. Children are owned by the parent.
NodeType nodeType() const
Find out about type of the node. It is usually shorter to use convenience functions from QgsLayerTree...
bool itemVisibilityChecked() const
Returns whether a node is checked (independently of its ancestors or children)
Namespace with helper functions for layer tree operations.
QString dataUrlFormat() const
Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
QString title() const
Returns the title of the layer used by QGIS Server in GetCapabilities request.
QString dataUrl() const
Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.
QString keywordList() const
Returns the keyword list of the layerused by QGIS Server in GetCapabilities request.
QString shortName() const
Returns the short name of the layer used by QGIS Server to identify the layer.
QString abstract() const
Returns the abstract of the layerused by QGIS Server in GetCapabilities request.
Base class for all map layer types.
virtual QgsRectangle extent() const
Returns the extent of the layer.
QgsMapLayer::LayerFlags flags() const
Returns the flags for this layer.
QgsCoordinateReferenceSystem crs
QgsMapLayerServerProperties * serverProperties()
Returns QGIS Server Properties for the map layer.
bool hasScaleBasedVisibility() const
Returns whether scale based visibility is enabled for the layer.
@ Identifiable
If the layer is identifiable using the identify map tool and as a WMS layer.
double minimumScale() const
Returns the minimum map scale (i.e.
double maximumScale() const
Returns the maximum map scale (i.e.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
QString baseName() const
Returns the base name of the project file without the path and without extension - derived from fileN...
QgsLayerTree * layerTreeRoot() const
Returns pointer to the root (invisible) node of the project's layer tree.
QgsCoordinateReferenceSystem crs
A rectangle specified with double values.
double xMinimum() const
Returns the x minimum value (left side of rectangle).
double yMinimum() const
Returns the y minimum value (bottom side of rectangle).
double xMaximum() const
Returns the x maximum value (right side of rectangle).
double yMaximum() const
Returns the y maximum value (top side of rectangle).
void combineExtentWith(const QgsRectangle &rect)
Expands the rectangle so that it covers both the original rectangle and the given rectangle.
bool isEmpty() const
Returns true if the rectangle has no area.
void invert()
Swap x/y coordinates in the rectangle.
A helper class that centralizes caches accesses given by all the server cache filter plugins.
bool setCachedDocument(const QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl) const
Updates or inserts the document in cache like capabilities.
bool getCachedDocument(QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl) const
Returns cached document (or 0 if document not in cache) like capabilities.
QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins.
virtual QgsServerCacheManager * cacheManager() const =0
Gets the registered server cache filters.
virtual QgsAccessControl * accessControls() const =0
Gets the registered access control filters.
virtual QgsServerSettings * serverSettings()=0
Returns the server settings.
QgsServerResponse Class defining response interface passed to services QgsService::executeRequest() m...
virtual void write(const QString &data)
Write string This is a convenient method that will write directly to the underlying I/O device.
virtual void setHeader(const QString &key, const QString &value)=0
Set Header entry Add Header entry to the response Note that it is usually an error to set Header afte...
Class defining request interface passed to WMS service.
SERVER_EXPORT bool wmsInfoFormatSia2045(const QgsProject &project)
Returns if the info format is SIA20145.
SERVER_EXPORT QgsRectangle wmsExtent(const QgsProject &project)
Returns the WMS Extent restriction.
SERVER_EXPORT bool wmsUseLayerIds(const QgsProject &project)
Returns if layer ids are used as name in WMS.
SERVER_EXPORT QStringList owsServiceKeywords(const QgsProject &project)
Returns the owsService keywords defined in project.
SERVER_EXPORT QStringList wmsRestrictedLayers(const QgsProject &project)
Returns the restricted layer name list.
SERVER_EXPORT QString owsServiceTitle(const QgsProject &project)
Returns the owsService title defined in project.
SERVER_EXPORT QString owsServiceAbstract(const QgsProject &project)
Returns the owsService abstract defined in project.
Median cut implementation.
void writeGetContext(QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, QgsServerResponse &response)
Output GetContext response.
QDomDocument getContext(QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request)
Returns XML document for the 'GetContext' request.
QUrl serviceUrl(const QgsServerRequest &request, const QgsProject *project, const QgsServerSettings &settings)
Returns WMS service URL.