34#include <QRegularExpression>
40 void appendOwsLayerStyles( QDomDocument &doc, QDomElement &layerElem, QgsMapLayer *currentLayer );
42 void appendOwsLayersFromTreeGroup( QDomDocument &doc, QDomElement &parentLayer, QgsServerInterface *serverIface,
const QgsProject *project,
const QgsWmsRequest &request,
const QgsLayerTreeGroup *layerTreeGroup, QgsRectangle &combinedBBox,
const QString &strGroup );
44 void appendOwsGeneralAndResourceList( QDomDocument &doc, QDomElement &parentElement, QgsServerInterface *serverIface,
const QgsProject *project,
const QgsWmsRequest &request );
49#ifdef HAVE_SERVER_PYTHON_PLUGINS
54 const QDomDocument *contextDocument =
nullptr;
56#ifdef HAVE_SERVER_PYTHON_PLUGINS
58 if ( cacheManager && cacheManager->
getCachedDocument( &doc, project, request, accessControl ) )
60 contextDocument = &doc;
64 doc =
getContext( serverIface, project, request );
70 contextDocument = &doc;
73 doc =
getContext( serverIface, project, request );
74 contextDocument = &doc;
76 response.
setHeader( QStringLiteral(
"Content-Type" ), QStringLiteral(
"text/xml; charset=utf-8" ) );
77 response.
write( contextDocument->toByteArray() );
84 const QDomProcessingInstruction xmlDeclaration = doc.createProcessingInstruction( QStringLiteral(
"xml" ), QStringLiteral(
"version=\"1.0\" encoding=\"utf-8\"" ) );
86 doc.appendChild( xmlDeclaration );
88 QDomElement owsContextElem = doc.createElement( QStringLiteral(
"OWSContext" ) );
89 owsContextElem.setAttribute( QStringLiteral(
"xmlns" ), QStringLiteral(
"http://www.opengis.net/ows-context" ) );
90 owsContextElem.setAttribute( QStringLiteral(
"xmlns:ows-context" ), QStringLiteral(
"http://www.opengis.net/ows-context" ) );
91 owsContextElem.setAttribute( QStringLiteral(
"xmlns:context" ), QStringLiteral(
"http://www.opengis.net/context" ) );
92 owsContextElem.setAttribute( QStringLiteral(
"xmlns:ows" ), QStringLiteral(
"http://www.opengis.net/ows" ) );
93 owsContextElem.setAttribute( QStringLiteral(
"xmlns:sld" ), QStringLiteral(
"http://www.opengis.net/sld" ) );
94 owsContextElem.setAttribute( QStringLiteral(
"xmlns:ogc" ), QStringLiteral(
"http://www.opengis.net/ogc" ) );
95 owsContextElem.setAttribute( QStringLiteral(
"xmlns:gml" ), QStringLiteral(
"http://www.opengis.net/gml" ) );
96 owsContextElem.setAttribute( QStringLiteral(
"xmlns:kml" ), QStringLiteral(
"http://www.opengis.net/kml/2.2" ) );
97 owsContextElem.setAttribute( QStringLiteral(
"xmlns:xlink" ), QStringLiteral(
"http://www.w3.org/1999/xlink" ) );
98 owsContextElem.setAttribute( QStringLiteral(
"xmlns:ns9" ), QStringLiteral(
"http://www.w3.org/2005/Atom" ) );
99 owsContextElem.setAttribute( QStringLiteral(
"xmlns:xal" ), QStringLiteral(
"urn:oasis:names:tc:ciq:xsdschema:xAL:2.0" ) );
100 owsContextElem.setAttribute( QStringLiteral(
"xmlns:ins" ), QStringLiteral(
"http://www.inspire.org" ) );
101 owsContextElem.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"0.3.1" ) );
102 doc.appendChild( owsContextElem );
104 appendOwsGeneralAndResourceList( doc, owsContextElem, serverIface, project, request );
110 void appendOwsGeneralAndResourceList( QDomDocument &doc, QDomElement &parentElement,
QgsServerInterface *serverIface,
const QgsProject *project,
const QgsWmsRequest &request )
112 parentElement.setAttribute( QStringLiteral(
"id" ),
"ows-context-" + project->
baseName() );
115 QDomElement generalElem = doc.createElement( QStringLiteral(
"General" ) );
118 QDomElement windowElem = doc.createElement( QStringLiteral(
"Window" ) );
119 windowElem.setAttribute( QStringLiteral(
"height" ), QStringLiteral(
"600" ) );
120 windowElem.setAttribute( QStringLiteral(
"width" ), QStringLiteral(
"800" ) );
121 generalElem.appendChild( windowElem );
125 QDomElement titleElem = doc.createElement( QStringLiteral(
"ows:Title" ) );
126 const QDomText titleText = doc.createTextNode( title );
127 titleElem.appendChild( titleText );
128 generalElem.appendChild( titleElem );
132 if ( !abstract.isEmpty() )
134 QDomElement abstractElem = doc.createElement( QStringLiteral(
"ows:Abstract" ) );
135 const QDomText abstractText = doc.createCDATASection( abstract );
136 abstractElem.appendChild( abstractText );
137 generalElem.appendChild( abstractElem );
142 if ( !keywords.isEmpty() )
146 QDomElement keywordsElem = doc.createElement( QStringLiteral(
"ows:Keywords" ) );
148 for (
int i = 0; i < keywords.size(); ++i )
150 const QString keyword = keywords.at( i );
151 if ( !keyword.isEmpty() )
153 QDomElement keywordElem = doc.createElement( QStringLiteral(
"ows:Keyword" ) );
154 const QDomText keywordText = doc.createTextNode( keyword );
155 keywordElem.appendChild( keywordText );
158 keywordElem.setAttribute( QStringLiteral(
"vocabulary" ), QStringLiteral(
"SIA_Geo405" ) );
160 keywordsElem.appendChild( keywordElem );
163 generalElem.appendChild( keywordsElem );
167 parentElement.appendChild( generalElem );
170 QDomElement resourceListElem = doc.createElement( QStringLiteral(
"ResourceList" ) );
171 const QgsLayerTree *projectLayerTreeRoot = project->
layerTreeRoot();
172 QgsRectangle combinedBBox;
173 appendOwsLayersFromTreeGroup( doc, resourceListElem, serverIface, project, request, projectLayerTreeRoot, combinedBBox, QString() );
174 parentElement.appendChild( resourceListElem );
177 const QgsCoordinateReferenceSystem projectCrs = project->
crs();
181 mapRect = combinedBBox;
183 QDomElement bboxElem = doc.createElement( QStringLiteral(
"ows:BoundingBox" ) );
184 bboxElem.setAttribute( QStringLiteral(
"crs" ), projectCrs.
authid() );
189 QDomElement lowerCornerElem = doc.createElement( QStringLiteral(
"ows:LowerCorner" ) );
190 const QDomText lowerCornerText = doc.createTextNode( QString::number( mapRect.
xMinimum() ) +
" " + QString::number( mapRect.
yMinimum() ) );
191 lowerCornerElem.appendChild( lowerCornerText );
192 bboxElem.appendChild( lowerCornerElem );
193 QDomElement upperCornerElem = doc.createElement( QStringLiteral(
"ows:UpperCorner" ) );
194 const QDomText upperCornerText = doc.createTextNode( QString::number( mapRect.
xMaximum() ) +
" " + QString::number( mapRect.
yMaximum() ) );
195 upperCornerElem.appendChild( upperCornerText );
196 bboxElem.appendChild( upperCornerElem );
197 generalElem.appendChild( bboxElem );
200 void appendOwsLayersFromTreeGroup( QDomDocument &doc, QDomElement &parentLayer, QgsServerInterface *serverIface,
const QgsProject *project,
const QgsWmsRequest &request,
const QgsLayerTreeGroup *layerTreeGroup, QgsRectangle &combinedBBox,
const QString &strGroup )
204 const QList<QgsLayerTreeNode *> layerTreeGroupChildren = layerTreeGroup->
children();
205 for (
int i = 0; i < layerTreeGroupChildren.size(); ++i )
207 QgsLayerTreeNode *treeNode = layerTreeGroupChildren.at( i );
211 QgsLayerTreeGroup *treeGroupChild =
static_cast<QgsLayerTreeGroup *
>( treeNode );
213 const QString name = treeGroupChild->
name();
214 if ( restrictedLayers.contains( name ) )
220 if ( strGroup.isEmpty() )
226 group = strGroup +
"/" + name;
229 appendOwsLayersFromTreeGroup( doc, parentLayer, serverIface, project, request, treeGroupChild, combinedBBox, group );
233 QgsLayerTreeLayer *treeLayer =
static_cast<QgsLayerTreeLayer *
>( treeNode );
234 QgsMapLayer *l = treeLayer->
layer();
235 if ( restrictedLayers.contains( l->
name() ) )
239#ifdef HAVE_SERVER_PYTHON_PLUGINS
246 QDomElement layerElem = doc.createElement( QStringLiteral(
"Layer" ) );
251 layerElem.setAttribute( QStringLiteral(
"queryable" ), QStringLiteral(
"false" ) );
255 layerElem.setAttribute( QStringLiteral(
"queryable" ), QStringLiteral(
"true" ) );
261 layerElem.setAttribute( QStringLiteral(
"hidden" ), QStringLiteral(
"false" ) );
265 layerElem.setAttribute( QStringLiteral(
"hidden" ), QStringLiteral(
"true" ) );
269 if ( !strGroup.isEmpty() )
271 layerElem.setAttribute( QStringLiteral(
"group" ), strGroup );
276 layerElem.setAttribute( QStringLiteral(
"opacity" ), 1 );
278 QString wmsName = l->
name();
288 layerElem.setAttribute( QStringLiteral(
"name" ), wmsName );
290 const thread_local QRegularExpression sRegEx( QStringLiteral(
"[\\W]" ), QRegularExpression::UseUnicodePropertiesOption );
291 layerElem.setAttribute( QStringLiteral(
"id" ), wmsName.replace( sRegEx, QStringLiteral(
"_" ) ) );
294 QDomElement titleElem = doc.createElement( QStringLiteral(
"ows:Title" ) );
296 if ( title.isEmpty() )
300 const QDomText titleText = doc.createTextNode( title );
301 titleElem.appendChild( titleText );
302 layerElem.appendChild( titleElem );
305 QDomElement formatElem = doc.createElement( QStringLiteral(
"ows:OutputFormat" ) );
306 const QDomText formatText = doc.createTextNode( QStringLiteral(
"image/png" ) );
307 formatElem.appendChild( formatText );
308 layerElem.appendChild( formatElem );
314 QString hrefString = href.toString();
315 hrefString.append( href.hasQuery() ?
"&" :
"?" );
318 QDomElement serverElem = doc.createElement( QStringLiteral(
"Server" ) );
319 serverElem.setAttribute( QStringLiteral(
"service" ), QStringLiteral(
"urn:ogc:serviceType:WMS" ) );
320 serverElem.setAttribute( QStringLiteral(
"version" ), QStringLiteral(
"1.3.0" ) );
321 serverElem.setAttribute( QStringLiteral(
"default" ), QStringLiteral(
"true" ) );
322 QDomElement orServerElem = doc.createElement( QStringLiteral(
"OnlineResource" ) );
323 orServerElem.setAttribute( QStringLiteral(
"xlink:href" ), hrefString );
324 serverElem.appendChild( orServerElem );
325 layerElem.appendChild( serverElem );
328 if ( !abstract.isEmpty() )
330 QDomElement abstractElem = doc.createElement( QStringLiteral(
"ows:Abstract" ) );
331 const QDomText abstractText = doc.createTextNode( abstract );
332 abstractElem.appendChild( abstractText );
333 layerElem.appendChild( abstractElem );
339 const QString minScaleString = QString::number( l->
maximumScale() );
340 const QString maxScaleString = QString::number( l->
minimumScale() );
341 QDomElement minScaleElem = doc.createElement( QStringLiteral(
"sld:MinScaleDenominator" ) );
342 const QDomText minScaleText = doc.createTextNode( minScaleString );
343 minScaleElem.appendChild( minScaleText );
344 layerElem.appendChild( minScaleElem );
345 QDomElement maxScaleElem = doc.createElement( QStringLiteral(
"sld:MaxScaleDenominator" ) );
346 const QDomText maxScaleText = doc.createTextNode( maxScaleString );
347 maxScaleElem.appendChild( maxScaleText );
348 layerElem.appendChild( maxScaleElem );
352 appendOwsLayerStyles( doc, layerElem, l );
360 QDomElement keywordsElem = doc.createElement( QStringLiteral(
"ows:Keywords" ) );
361 for (
int i = 0; i < keywordStringList.size(); ++i )
363 QDomElement keywordElem = doc.createElement( QStringLiteral(
"ows:Keyword" ) );
364 const QDomText keywordText = doc.createTextNode( keywordStringList.at( i ).trimmed() );
365 keywordElem.appendChild( keywordText );
368 keywordElem.setAttribute( QStringLiteral(
"vocabulary" ), QStringLiteral(
"SIA_Geo405" ) );
370 keywordsElem.appendChild( keywordElem );
372 layerElem.appendChild( keywordsElem );
377 if ( !dataUrl.isEmpty() )
379 QDomElement dataUrlElem = doc.createElement( QStringLiteral(
"DataURL" ) );
381 dataUrlElem.setAttribute( QStringLiteral(
"format" ), dataUrlFormat );
382 QDomElement dataORElem = doc.createElement( QStringLiteral(
"OnlineResource" ) );
383 dataORElem.setAttribute( QStringLiteral(
"xmlns:xlink" ), QStringLiteral(
"http://www.w3.org/1999/xlink" ) );
384 dataORElem.setAttribute( QStringLiteral(
"xlink:type" ), QStringLiteral(
"simple" ) );
385 dataORElem.setAttribute( QStringLiteral(
"xlink:href" ), dataUrl );
386 dataUrlElem.appendChild( dataORElem );
387 layerElem.appendChild( dataUrlElem );
392 for (
const QgsMapLayerServerProperties::MetadataUrl &url : urls )
394 QDomElement metaUrlElem = doc.createElement( QStringLiteral(
"MetadataURL" ) );
395 metaUrlElem.setAttribute( QStringLiteral(
"format" ), url.format );
396 QDomElement metaUrlORElem = doc.createElement( QStringLiteral(
"OnlineResource" ) );
397 metaUrlORElem.setAttribute( QStringLiteral(
"xmlns:xlink" ), QStringLiteral(
"http://www.w3.org/1999/xlink" ) );
398 metaUrlORElem.setAttribute( QStringLiteral(
"xlink:type" ), QStringLiteral(
"simple" ) );
399 metaUrlORElem.setAttribute( QStringLiteral(
"xlink:href" ), url.url );
400 metaUrlElem.appendChild( metaUrlORElem );
401 layerElem.appendChild( metaUrlElem );
407 const QgsCoordinateTransform t( l->
crs(), project->
crs(), project );
408 const QgsRectangle BBox = t.transformBoundingBox( l->
extent() );
418 catch (
const QgsCsException &cse )
423 if ( parentLayer.hasChildNodes() )
425 parentLayer.insertBefore( layerElem, parentLayer.firstChild() );
429 parentLayer.appendChild( layerElem );
435 void appendOwsLayerStyles( QDomDocument &doc, QDomElement &layerElem, QgsMapLayer *currentLayer )
439 QDomElement styleListElem = doc.createElement( QStringLiteral(
"StyleList" ) );
441 QDomElement styleElem = doc.createElement( QStringLiteral(
"Style" ) );
442 styleElem.setAttribute( QStringLiteral(
"current" ), QStringLiteral(
"true" ) );
443 QDomElement styleNameElem = doc.createElement( QStringLiteral(
"Name" ) );
444 const QDomText styleNameText = doc.createTextNode( styleName );
445 styleNameElem.appendChild( styleNameText );
446 QDomElement styleTitleElem = doc.createElement( QStringLiteral(
"Title" ) );
447 const QDomText styleTitleText = doc.createTextNode( styleName );
448 styleTitleElem.appendChild( styleTitleText );
449 styleElem.appendChild( styleNameElem );
450 styleElem.appendChild( styleTitleElem );
451 styleListElem.appendChild( styleElem );
452 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.
bool hasAxisInverted() const
Returns whether the axis order is inverted for the CRS compared to the order east/north (longitude/la...
QString name() const override
Returns the group's name.
QgsMapLayer * layer() const
Returns the map layer associated with this node.
@ 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).
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.
QStringList styles() const
Returns list of all defined style names.
virtual QgsRectangle extent() const
Returns the extent of the layer.
QgsCoordinateReferenceSystem crs
QgsMapLayerServerProperties * serverProperties()
Returns QGIS Server Properties for the map layer.
QgsMapLayer::LayerFlags flags
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.
QgsMapLayerStyleManager * styleManager() const
Gets access to the layer's style manager.
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
void combineExtentWith(const QgsRectangle &rect)
Expands the rectangle so that it covers both the original rectangle and the given rectangle.
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.
Defines 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.
static bool wmsInfoFormatSia2045(const QgsProject &project)
Returns if the info format is SIA20145.
static QgsRectangle wmsExtent(const QgsProject &project)
Returns the WMS Extent restriction.
static bool wmsUseLayerIds(const QgsProject &project)
Returns if layer ids are used as name in WMS.
static QStringList owsServiceKeywords(const QgsProject &project)
Returns the owsService keywords defined in project.
static QStringList wmsRestrictedLayers(const QgsProject &project)
Returns the restricted layer name list.
static QString owsServiceTitle(const QgsProject &project)
Returns the owsService title defined in project.
static QString owsServiceAbstract(const QgsProject &project)
Returns the owsService abstract defined in project.
Defines the response interface passed to QgsService.
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...
Defines request interfaces passed to WMS service.
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.