QGIS API Documentation 3.41.0-Master (d2aaa9c6e02)
Loading...
Searching...
No Matches
qgswmsgetcapabilities.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgswmsgetmap.h
3 -------------------------
4 begin : December 20 , 2016
5 copyright : (C) 2007 by Marco Hugentobler (original code)
6 (C) 2014 by Alessandro Pasotti (original code)
7 (C) 2016 by David Marteau
8 email : marco dot hugentobler at karto dot baug dot ethz dot ch
9 a dot pasotti at itopen dot it
10 david dot marteau at 3liz dot com
11 ***************************************************************************/
12
13/***************************************************************************
14 * *
15 * This program is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU General Public License as published by *
17 * the Free Software Foundation; either version 2 of the License, or *
18 * (at your option) any later version. *
19 * *
20 ***************************************************************************/
21#include "qgswmsutils.h"
24
25#include "qgslayoutmanager.h"
26#include "qgslayoutatlas.h"
27#include "qgsprintlayout.h"
28#include "qgslayoutitemmap.h"
29#include "qgslayoutitemlabel.h"
30#include "qgslayoutitemhtml.h"
31#include "qgslayoutframe.h"
34#include "qgsexception.h"
36#include "qgsvectorlayer.h"
38#include "qgsrasterlayer.h"
39#include "qgsrasterrenderer.h"
41
42namespace QgsWms
43{
44 namespace
45 {
46
47 void appendLayerProjectSettings( QDomDocument &doc, QDomElement &layerElem, QgsMapLayer *currentLayer );
48
49 void appendDrawingOrder( QDomDocument &doc, QDomElement &parentElem, QgsServerInterface *serverIface, const QgsProject *project );
50
51 void appendLayerWgs84BoundingRect( QDomDocument &doc, QDomElement &layerElement, const QgsRectangle &wgs84BoundingRect );
52
53 void appendLayerCrsExtents( QDomDocument &doc, QDomElement &layerElement, const QMap<QString, QgsRectangle> &crsExtents );
54
55 void appendCrsElementToLayer( QDomDocument &doc, QDomElement &layerElement, const QDomElement &precedingElement, const QString &crsText );
56
57 void appendCrsElementsToLayer( QDomDocument &doc, QDomElement &layerElement, const QStringList &crsList, const QStringList &constrainedCrsList );
58
59 void appendLayerStyles( QDomDocument &doc, QDomElement &layerElem, const QgsWmsLayerInfos &layerInfos, const QgsProject *project, const QgsWmsRequest &request, const QgsServerSettings *settings );
60
61 void appendLayersFromTreeGroup( QDomDocument &doc, QDomElement &parentLayer, QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, const QgsLayerTreeGroup *layerTreeGroup, const QMap<QString, QgsWmsLayerInfos> &wmsLayerInfos, bool projectSettings );
62
63 void addKeywordListElement( const QgsProject *project, QDomDocument &doc, QDomElement &parent );
64 } // namespace
65
66 void writeGetCapabilities( QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, QgsServerResponse &response, bool projectSettings )
67 {
68#ifdef HAVE_SERVER_PYTHON_PLUGINS
69 QgsAccessControl *accessControl = serverIface->accessControls();
70#endif
71
72 QDomDocument doc;
73 const QDomDocument *capabilitiesDocument = nullptr;
74
75 // Data for WMS capabilities server memory cache
76 QString configFilePath = serverIface->configFilePath();
77 QgsCapabilitiesCache *capabilitiesCache = serverIface->capabilitiesCache();
78 QStringList cacheKeyList;
79 cacheKeyList << ( projectSettings ? QStringLiteral( "projectSettings" ) : request.wmsParameters().version() );
80 cacheKeyList << QgsServerProjectUtils::serviceUrl( request.serverParameters().service(), request, *serverIface->serverSettings() );
81 bool cache = true;
82
83#ifdef HAVE_SERVER_PYTHON_PLUGINS
84 if ( accessControl )
85 cache = accessControl->fillCacheKey( cacheKeyList );
86#endif
87 QString cacheKey = cacheKeyList.join( '-' );
88
89#ifdef HAVE_SERVER_PYTHON_PLUGINS
90 QgsServerCacheManager *cacheManager = serverIface->cacheManager();
91 if ( cacheManager && cacheManager->getCachedDocument( &doc, project, request, accessControl ) )
92 {
93 capabilitiesDocument = &doc;
94 }
95#endif
96 if ( !capabilitiesDocument && cache ) //capabilities xml not in cache plugins
97 {
98 capabilitiesDocument = capabilitiesCache->searchCapabilitiesDocument( configFilePath, cacheKey );
99 }
100
101 if ( !capabilitiesDocument ) //capabilities xml not in cache. Create a new one
102 {
103 QgsMessageLog::logMessage( QStringLiteral( "WMS capabilities document not found in cache" ), QStringLiteral( "Server" ) );
104
105 doc = getCapabilities( serverIface, project, request, projectSettings );
106
107#ifdef HAVE_SERVER_PYTHON_PLUGINS
108 if ( cacheManager && cacheManager->setCachedDocument( &doc, project, request, accessControl ) )
109 {
110 capabilitiesDocument = &doc;
111 }
112#endif
113
114 // cppcheck-suppress identicalInnerCondition
115 if ( !capabilitiesDocument )
116 {
117 capabilitiesCache->insertCapabilitiesDocument( configFilePath, cacheKey, &doc );
118 capabilitiesDocument = capabilitiesCache->searchCapabilitiesDocument( configFilePath, cacheKey );
119 }
120 if ( !capabilitiesDocument )
121 {
122 capabilitiesDocument = &doc;
123 }
124 else
125 {
126 QgsMessageLog::logMessage( QStringLiteral( "Set WMS capabilities document in cache" ), QStringLiteral( "Server" ) );
127 }
128 }
129 else
130 {
131 QgsMessageLog::logMessage( QStringLiteral( "Found WMS capabilities document in cache" ), QStringLiteral( "Server" ) );
132 }
133
134 response.setHeader( QStringLiteral( "Content-Type" ), QStringLiteral( "text/xml; charset=utf-8" ) );
135 response.write( capabilitiesDocument->toByteArray() );
136 }
137
138 QDomDocument getCapabilities( QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, bool projectSettings )
139 {
140 QDomDocument doc;
141 QDomElement wmsCapabilitiesElement;
142
143 // Get service URL
144 QUrl href = serviceUrl( request, project, *serverIface->serverSettings() );
145
146 //href needs to be a prefix
147 QString hrefString = href.toString();
148 hrefString.append( href.hasQuery() ? "&" : "?" );
149
150 // XML declaration
151 QDomProcessingInstruction xmlDeclaration = doc.createProcessingInstruction( QStringLiteral( "xml" ), QStringLiteral( "version=\"1.0\" encoding=\"utf-8\"" ) );
152
153 // Append format helper
154 std::function<void( QDomElement &, const QString & )> appendFormat = [&doc]( QDomElement &elem, const QString &format ) {
155 QDomElement formatElem = doc.createElement( QStringLiteral( "Format" ) /*wms:Format*/ );
156 formatElem.appendChild( doc.createTextNode( format ) );
157 elem.appendChild( formatElem );
158 };
159
160 if ( request.wmsParameters().version() == QLatin1String( "1.1.1" ) )
161 {
162 doc = QDomDocument( QStringLiteral( "WMT_MS_Capabilities SYSTEM 'http://schemas.opengis.net/wms/1.1.1/WMS_MS_Capabilities.dtd'" ) ); //WMS 1.1.1 needs DOCTYPE "SYSTEM http://schemas.opengis.net/wms/1.1.1/WMS_MS_Capabilities.dtd"
163 doc.appendChild( xmlDeclaration );
164 wmsCapabilitiesElement = doc.createElement( QStringLiteral( "WMT_MS_Capabilities" ) /*wms:WMS_Capabilities*/ );
165 }
166 else // 1.3.0 as default
167 {
168 doc.appendChild( xmlDeclaration );
169 wmsCapabilitiesElement = doc.createElement( QStringLiteral( "WMS_Capabilities" ) /*wms:WMS_Capabilities*/ );
170 wmsCapabilitiesElement.setAttribute( QStringLiteral( "xmlns" ), QStringLiteral( "http://www.opengis.net/wms" ) );
171 wmsCapabilitiesElement.setAttribute( QStringLiteral( "xmlns:sld" ), QStringLiteral( "http://www.opengis.net/sld" ) );
172 wmsCapabilitiesElement.setAttribute( QStringLiteral( "xmlns:qgs" ), QStringLiteral( "http://www.qgis.org/wms" ) );
173 wmsCapabilitiesElement.setAttribute( QStringLiteral( "xmlns:xsi" ), QStringLiteral( "http://www.w3.org/2001/XMLSchema-instance" ) );
174 QString schemaLocation = QStringLiteral( "http://www.opengis.net/wms" );
175 schemaLocation += QLatin1String( " http://schemas.opengis.net/wms/1.3.0/capabilities_1_3_0.xsd" );
176 schemaLocation += QLatin1String( " http://www.opengis.net/sld" );
177 schemaLocation += QLatin1String( " http://schemas.opengis.net/sld/1.1.0/sld_capabilities.xsd" );
178
180 {
181 wmsCapabilitiesElement.setAttribute( QStringLiteral( "xmlns:inspire_common" ), QStringLiteral( "http://inspire.ec.europa.eu/schemas/common/1.0" ) );
182 wmsCapabilitiesElement.setAttribute( QStringLiteral( "xmlns:inspire_vs" ), QStringLiteral( "http://inspire.ec.europa.eu/schemas/inspire_vs/1.0" ) );
183 schemaLocation += QLatin1String( " http://inspire.ec.europa.eu/schemas/inspire_vs/1.0" );
184 schemaLocation += QLatin1String( " http://inspire.ec.europa.eu/schemas/inspire_vs/1.0/inspire_vs.xsd" );
185 }
186
187 schemaLocation += QLatin1String( " http://www.qgis.org/wms" );
188 schemaLocation += " " + hrefString + "SERVICE=WMS&REQUEST=GetSchemaExtension";
189
190 wmsCapabilitiesElement.setAttribute( QStringLiteral( "xsi:schemaLocation" ), schemaLocation );
191 }
192 wmsCapabilitiesElement.setAttribute( QStringLiteral( "version" ), request.wmsParameters().version() );
193 doc.appendChild( wmsCapabilitiesElement );
194
195 //INSERT Service
196 wmsCapabilitiesElement.appendChild( getServiceElement( doc, project, request, serverIface->serverSettings() ) );
197
198 //wms:Capability element
199 QDomElement capabilityElement = getCapabilityElement( doc, project, request, projectSettings, serverIface );
200 wmsCapabilitiesElement.appendChild( capabilityElement );
201
202 if ( projectSettings )
203 {
204 //Insert <ComposerTemplate> elements derived from wms:_ExtendedCapabilities
205 capabilityElement.appendChild( getComposerTemplatesElement( doc, project ) );
206
207 //WFS layers
208 capabilityElement.appendChild( getWFSLayersElement( doc, project ) );
209 }
210
211 capabilityElement.appendChild(
212 getLayersAndStylesCapabilitiesElement( doc, serverIface, project, request, projectSettings )
213 );
214
215 if ( projectSettings )
216 {
217 appendDrawingOrder( doc, capabilityElement, serverIface, project );
218 }
219
220 return doc;
221 }
222
223 QDomElement getServiceElement( QDomDocument &doc, const QgsProject *project, const QgsWmsRequest &request, const QgsServerSettings *serverSettings )
224 {
225 //Service element
226 QDomElement serviceElem = doc.createElement( QStringLiteral( "Service" ) );
227
228 //Service name
229 QDomElement nameElem = doc.createElement( QStringLiteral( "Name" ) );
230 QDomText nameText = doc.createTextNode( QStringLiteral( "WMS" ) );
231 nameElem.appendChild( nameText );
232 serviceElem.appendChild( nameElem );
233
234 // Service title
235 QDomElement titleElem = doc.createElement( QStringLiteral( "Title" ) );
236 QDomText titleText = doc.createTextNode( QgsServerProjectUtils::owsServiceTitle( *project ) );
237 titleElem.appendChild( titleText );
238 serviceElem.appendChild( titleElem );
239
240 QString abstract = QgsServerProjectUtils::owsServiceAbstract( *project );
241 if ( !abstract.isEmpty() )
242 {
243 QDomElement abstractElem = doc.createElement( QStringLiteral( "Abstract" ) );
244 QDomText abstractText = doc.createCDATASection( abstract );
245 abstractElem.appendChild( abstractText );
246 serviceElem.appendChild( abstractElem );
247 }
248
249 addKeywordListElement( project, doc, serviceElem );
250
251 QString onlineResource = QgsServerProjectUtils::owsServiceOnlineResource( *project );
252 if ( onlineResource.isEmpty() )
253 {
254 onlineResource = serviceUrl( request, project, *serverSettings ).toString();
255 }
256 QDomElement onlineResourceElem = doc.createElement( QStringLiteral( "OnlineResource" ) );
257 onlineResourceElem.setAttribute( QStringLiteral( "xmlns:xlink" ), QStringLiteral( "http://www.w3.org/1999/xlink" ) );
258 onlineResourceElem.setAttribute( QStringLiteral( "xlink:type" ), QStringLiteral( "simple" ) );
259 onlineResourceElem.setAttribute( QStringLiteral( "xlink:href" ), onlineResource );
260 serviceElem.appendChild( onlineResourceElem );
261
262 QString contactPerson = QgsServerProjectUtils::owsServiceContactPerson( *project );
263 QString contactOrganization = QgsServerProjectUtils::owsServiceContactOrganization( *project );
264 QString contactPosition = QgsServerProjectUtils::owsServiceContactPosition( *project );
265 QString contactMail = QgsServerProjectUtils::owsServiceContactMail( *project );
266 QString contactPhone = QgsServerProjectUtils::owsServiceContactPhone( *project );
267 if ( !contactPerson.isEmpty() || !contactOrganization.isEmpty() || !contactPosition.isEmpty() || !contactMail.isEmpty() || !contactPhone.isEmpty() )
268 {
269 //Contact information
270 QDomElement contactInfoElem = doc.createElement( QStringLiteral( "ContactInformation" ) );
271
272 //Contact person primary
273 if ( !contactPerson.isEmpty() || !contactOrganization.isEmpty() )
274 {
275 QDomElement contactPersonPrimaryElem = doc.createElement( QStringLiteral( "ContactPersonPrimary" ) );
276
277 QDomText contactPersonText;
278 if ( !contactPerson.isEmpty() )
279 {
280 contactPersonText = doc.createTextNode( contactPerson );
281 }
282 else
283 {
284 contactPersonText = doc.createTextNode( QStringLiteral( "unknown" ) );
285 }
286 QDomElement contactPersonElem = doc.createElement( QStringLiteral( "ContactPerson" ) );
287 contactPersonElem.appendChild( contactPersonText );
288 contactPersonPrimaryElem.appendChild( contactPersonElem );
289
290 QDomText contactOrganizationText;
291 if ( !contactOrganization.isEmpty() )
292 {
293 contactOrganizationText = doc.createTextNode( contactOrganization );
294 }
295 else
296 {
297 contactOrganizationText = doc.createTextNode( QStringLiteral( "unknown" ) );
298 }
299 QDomElement contactOrganizationElem = doc.createElement( QStringLiteral( "ContactOrganization" ) );
300 contactOrganizationElem.appendChild( contactOrganizationText );
301 contactPersonPrimaryElem.appendChild( contactOrganizationElem );
302
303 contactInfoElem.appendChild( contactPersonPrimaryElem );
304 }
305
306 if ( !contactPosition.isEmpty() )
307 {
308 QDomElement contactPositionElem = doc.createElement( QStringLiteral( "ContactPosition" ) );
309 QDomText contactPositionText = doc.createTextNode( contactPosition );
310 contactPositionElem.appendChild( contactPositionText );
311 contactInfoElem.appendChild( contactPositionElem );
312 }
313
314 if ( !contactPhone.isEmpty() )
315 {
316 QDomElement phoneElem = doc.createElement( QStringLiteral( "ContactVoiceTelephone" ) );
317 QDomText phoneText = doc.createTextNode( contactPhone );
318 phoneElem.appendChild( phoneText );
319 contactInfoElem.appendChild( phoneElem );
320 }
321
322 if ( !contactMail.isEmpty() )
323 {
324 QDomElement mailElem = doc.createElement( QStringLiteral( "ContactElectronicMailAddress" ) );
325 QDomText mailText = doc.createTextNode( contactMail );
326 mailElem.appendChild( mailText );
327 contactInfoElem.appendChild( mailElem );
328 }
329
330 serviceElem.appendChild( contactInfoElem );
331 }
332
333 QDomElement feesElem = doc.createElement( QStringLiteral( "Fees" ) );
334 QDomText feesText = doc.createTextNode( QStringLiteral( "None" ) ); // default value if fees are unknown
335 QString fees = QgsServerProjectUtils::owsServiceFees( *project );
336 if ( !fees.isEmpty() )
337 {
338 feesText = doc.createTextNode( fees );
339 }
340 feesElem.appendChild( feesText );
341 serviceElem.appendChild( feesElem );
342
343 QDomElement accessConstraintsElem = doc.createElement( QStringLiteral( "AccessConstraints" ) );
344 QDomText accessConstraintsText = doc.createTextNode( QStringLiteral( "None" ) ); // default value if access constraints are unknown
345 QString accessConstraints = QgsServerProjectUtils::owsServiceAccessConstraints( *project );
346 if ( !accessConstraints.isEmpty() )
347 {
348 accessConstraintsText = doc.createTextNode( accessConstraints );
349 }
350 accessConstraintsElem.appendChild( accessConstraintsText );
351 serviceElem.appendChild( accessConstraintsElem );
352
353 if ( request.wmsParameters().version() == QLatin1String( "1.3.0" ) )
354 {
355 int maxWidth = QgsServerProjectUtils::wmsMaxWidth( *project );
356 if ( maxWidth > 0 )
357 {
358 QDomElement maxWidthElem = doc.createElement( QStringLiteral( "MaxWidth" ) );
359 QDomText maxWidthText = doc.createTextNode( QString::number( maxWidth ) );
360 maxWidthElem.appendChild( maxWidthText );
361 serviceElem.appendChild( maxWidthElem );
362 }
363
364 int maxHeight = QgsServerProjectUtils::wmsMaxHeight( *project );
365 if ( maxHeight > 0 )
366 {
367 QDomElement maxHeightElem = doc.createElement( QStringLiteral( "MaxHeight" ) );
368 QDomText maxHeightText = doc.createTextNode( QString::number( maxHeight ) );
369 maxHeightElem.appendChild( maxHeightText );
370 serviceElem.appendChild( maxHeightElem );
371 }
372 }
373
374 return serviceElem;
375 }
376
377 QDomElement getCapabilityElement( QDomDocument &doc, const QgsProject *project, const QgsWmsRequest &request, bool projectSettings, QgsServerInterface *serverIface )
378 {
379 const QString version = request.wmsParameters().version();
380
381 // Get service URL
382 QUrl href = serviceUrl( request, project, *serverIface->serverSettings() );
383
384 //href needs to be a prefix
385 QString hrefString = href.toString();
386 hrefString.append( href.hasQuery() ? "&" : "?" );
387
388 QDomElement capabilityElem = doc.createElement( QStringLiteral( "Capability" ) /*wms:Capability*/ );
389
390 //wms:Request element
391 QDomElement requestElem = doc.createElement( QStringLiteral( "Request" ) /*wms:Request*/ );
392 capabilityElem.appendChild( requestElem );
393
394 QDomElement dcpTypeElem = doc.createElement( QStringLiteral( "DCPType" ) /*wms:DCPType*/ );
395 QDomElement httpElem = doc.createElement( QStringLiteral( "HTTP" ) /*wms:HTTP*/ );
396 dcpTypeElem.appendChild( httpElem );
397
398 // Append format helper
399 std::function<void( QDomElement &, const QString & )> appendFormat = [&doc]( QDomElement &elem, const QString &format ) {
400 QDomElement formatElem = doc.createElement( QStringLiteral( "Format" ) /*wms:Format*/ );
401 formatElem.appendChild( doc.createTextNode( format ) );
402 elem.appendChild( formatElem );
403 };
404
405 QDomElement elem;
406
407 //wms:GetCapabilities
408 elem = doc.createElement( QStringLiteral( "GetCapabilities" ) /*wms:GetCapabilities*/ );
409 appendFormat( elem, ( version == QLatin1String( "1.1.1" ) ? "application/vnd.ogc.wms_xml" : "text/xml" ) );
410 elem.appendChild( dcpTypeElem );
411 requestElem.appendChild( elem );
412
413 //only Get supported for the moment
414 QDomElement getElem = doc.createElement( QStringLiteral( "Get" ) /*wms:Get*/ );
415 httpElem.appendChild( getElem );
416 QDomElement olResourceElem = doc.createElement( QStringLiteral( "OnlineResource" ) /*wms:OnlineResource*/ );
417 olResourceElem.setAttribute( QStringLiteral( "xmlns:xlink" ), QStringLiteral( "http://www.w3.org/1999/xlink" ) );
418 olResourceElem.setAttribute( QStringLiteral( "xlink:type" ), QStringLiteral( "simple" ) );
419 olResourceElem.setAttribute( QStringLiteral( "xlink:href" ), hrefString );
420 getElem.appendChild( olResourceElem );
421
422 //wms:GetMap
423 elem = doc.createElement( QStringLiteral( "GetMap" ) /*wms:GetMap*/ );
424 appendFormat( elem, QStringLiteral( "image/jpeg" ) );
425 appendFormat( elem, QStringLiteral( "image/png" ) );
426 appendFormat( elem, QStringLiteral( "image/png; mode=16bit" ) );
427 appendFormat( elem, QStringLiteral( "image/png; mode=8bit" ) );
428 appendFormat( elem, QStringLiteral( "image/png; mode=1bit" ) );
429 appendFormat( elem, QStringLiteral( "application/dxf" ) );
430 appendFormat( elem, QStringLiteral( "application/pdf" ) );
431 elem.appendChild( dcpTypeElem.cloneNode().toElement() ); //this is the same as for 'GetCapabilities'
432 requestElem.appendChild( elem );
433
434 //wms:GetFeatureInfo
435 elem = doc.createElement( QStringLiteral( "GetFeatureInfo" ) );
436 appendFormat( elem, QStringLiteral( "text/plain" ) );
437 appendFormat( elem, QStringLiteral( "text/html" ) );
438 appendFormat( elem, QStringLiteral( "text/xml" ) );
439 appendFormat( elem, QStringLiteral( "application/vnd.ogc.gml" ) );
440 appendFormat( elem, QStringLiteral( "application/vnd.ogc.gml/3.1.1" ) );
441 appendFormat( elem, QStringLiteral( "application/json" ) );
442 appendFormat( elem, QStringLiteral( "application/geo+json" ) );
443 elem.appendChild( dcpTypeElem.cloneNode().toElement() ); //this is the same as for 'GetCapabilities'
444 requestElem.appendChild( elem );
445
446 //wms:GetLegendGraphic
447 elem = doc.createElement( ( version == QLatin1String( "1.1.1" ) ? "GetLegendGraphic" : "sld:GetLegendGraphic" ) /*wms:GetLegendGraphic*/ );
448 appendFormat( elem, QStringLiteral( "image/jpeg" ) );
449 appendFormat( elem, QStringLiteral( "image/png" ) );
450 appendFormat( elem, QStringLiteral( "application/json" ) );
451 elem.appendChild( dcpTypeElem.cloneNode().toElement() ); //this is the same as for 'GetCapabilities'
452 requestElem.appendChild( elem );
453
454 //wms:DescribeLayer
455 elem = doc.createElement( ( version == QLatin1String( "1.1.1" ) ? "DescribeLayer" : "sld:DescribeLayer" ) /*wms:GetLegendGraphic*/ );
456 appendFormat( elem, QStringLiteral( "text/xml" ) );
457 elem.appendChild( dcpTypeElem.cloneNode().toElement() ); //this is the same as for 'GetCapabilities'
458 requestElem.appendChild( elem );
459
460 //wms:GetStyles
461 elem = doc.createElement( ( version == QLatin1String( "1.1.1" ) ? "GetStyles" : "qgs:GetStyles" ) /*wms:GetStyles*/ );
462 appendFormat( elem, QStringLiteral( "text/xml" ) );
463 elem.appendChild( dcpTypeElem.cloneNode().toElement() ); //this is the same as for 'GetCapabilities'
464 requestElem.appendChild( elem );
465
466 if ( ( !serverIface->serverSettings() || !serverIface->serverSettings()->getPrintDisabled() ) && projectSettings ) //remove composer templates from GetCapabilities in the long term
467 {
468 //wms:GetPrint
469 elem = doc.createElement( QStringLiteral( "GetPrint" ) /*wms:GetPrint*/ );
470 appendFormat( elem, QStringLiteral( "svg" ) );
471 appendFormat( elem, QStringLiteral( "png" ) );
472 appendFormat( elem, QStringLiteral( "pdf" ) );
473 elem.appendChild( dcpTypeElem.cloneNode().toElement() ); //this is the same as for 'GetCapabilities'
474 requestElem.appendChild( elem );
475 }
476
477 //Exception element is mandatory
478 elem = doc.createElement( QStringLiteral( "Exception" ) );
479 appendFormat( elem, ( version == QLatin1String( "1.1.1" ) ? "application/vnd.ogc.se_xml" : "XML" ) );
480 capabilityElem.appendChild( elem );
481
482 //UserDefinedSymbolization element
483 if ( version == QLatin1String( "1.3.0" ) )
484 {
485 elem = doc.createElement( QStringLiteral( "sld:UserDefinedSymbolization" ) );
486 elem.setAttribute( QStringLiteral( "SupportSLD" ), QStringLiteral( "1" ) );
487 elem.setAttribute( QStringLiteral( "UserLayer" ), QStringLiteral( "0" ) );
488 elem.setAttribute( QStringLiteral( "UserStyle" ), QStringLiteral( "1" ) );
489 elem.setAttribute( QStringLiteral( "RemoteWFS" ), QStringLiteral( "0" ) );
490 elem.setAttribute( QStringLiteral( "InlineFeature" ), QStringLiteral( "0" ) );
491 elem.setAttribute( QStringLiteral( "RemoteWCS" ), QStringLiteral( "0" ) );
492 capabilityElem.appendChild( elem );
493
495 {
496 capabilityElem.appendChild( getInspireCapabilitiesElement( doc, project ) );
497 }
498 }
499
500 return capabilityElem;
501 }
502
503 QDomElement getInspireCapabilitiesElement( QDomDocument &doc, const QgsProject *project )
504 {
505 QDomElement inspireCapabilitiesElem;
506
508 return inspireCapabilitiesElem;
509
510 inspireCapabilitiesElem = doc.createElement( QStringLiteral( "inspire_vs:ExtendedCapabilities" ) );
511
512 QString inspireMetadataUrl = QgsServerProjectUtils::wmsInspireMetadataUrl( *project );
513 // inspire scenario 1
514 if ( !inspireMetadataUrl.isEmpty() )
515 {
516 QDomElement inspireCommonMetadataUrlElem = doc.createElement( QStringLiteral( "inspire_common:MetadataUrl" ) );
517 inspireCommonMetadataUrlElem.setAttribute( QStringLiteral( "xsi:type" ), QStringLiteral( "inspire_common:resourceLocatorType" ) );
518
519 QDomElement inspireCommonMetadataUrlUrlElem = doc.createElement( QStringLiteral( "inspire_common:URL" ) );
520 inspireCommonMetadataUrlUrlElem.appendChild( doc.createTextNode( inspireMetadataUrl ) );
521 inspireCommonMetadataUrlElem.appendChild( inspireCommonMetadataUrlUrlElem );
522
523 QString inspireMetadataUrlType = QgsServerProjectUtils::wmsInspireMetadataUrlType( *project );
524 if ( !inspireMetadataUrlType.isNull() )
525 {
526 QDomElement inspireCommonMetadataUrlMediaTypeElem = doc.createElement( QStringLiteral( "inspire_common:MediaType" ) );
527 inspireCommonMetadataUrlMediaTypeElem.appendChild( doc.createTextNode( inspireMetadataUrlType ) );
528 inspireCommonMetadataUrlElem.appendChild( inspireCommonMetadataUrlMediaTypeElem );
529 }
530
531 inspireCapabilitiesElem.appendChild( inspireCommonMetadataUrlElem );
532 }
533 else
534 {
535 QDomElement inspireCommonResourceTypeElem = doc.createElement( QStringLiteral( "inspire_common:ResourceType" ) );
536 inspireCommonResourceTypeElem.appendChild( doc.createTextNode( QStringLiteral( "service" ) ) );
537 inspireCapabilitiesElem.appendChild( inspireCommonResourceTypeElem );
538
539 QDomElement inspireCommonSpatialDataServiceTypeElem = doc.createElement( QStringLiteral( "inspire_common:SpatialDataServiceType" ) );
540 inspireCommonSpatialDataServiceTypeElem.appendChild( doc.createTextNode( QStringLiteral( "view" ) ) );
541 inspireCapabilitiesElem.appendChild( inspireCommonSpatialDataServiceTypeElem );
542
543 QString inspireTemporalReference = QgsServerProjectUtils::wmsInspireTemporalReference( *project );
544 if ( !inspireTemporalReference.isNull() )
545 {
546 QDomElement inspireCommonTemporalReferenceElem = doc.createElement( QStringLiteral( "inspire_common:TemporalReference" ) );
547 QDomElement inspireCommonDateOfLastRevisionElem = doc.createElement( QStringLiteral( "inspire_common:DateOfLastRevision" ) );
548 inspireCommonDateOfLastRevisionElem.appendChild( doc.createTextNode( inspireTemporalReference ) );
549 inspireCommonTemporalReferenceElem.appendChild( inspireCommonDateOfLastRevisionElem );
550 inspireCapabilitiesElem.appendChild( inspireCommonTemporalReferenceElem );
551 }
552
553 QDomElement inspireCommonMetadataPointOfContactElem = doc.createElement( QStringLiteral( "inspire_common:MetadataPointOfContact" ) );
554
555 QString contactOrganization = QgsServerProjectUtils::owsServiceContactOrganization( *project );
556 QDomElement inspireCommonOrganisationNameElem = doc.createElement( QStringLiteral( "inspire_common:OrganisationName" ) );
557 if ( !contactOrganization.isNull() )
558 {
559 inspireCommonOrganisationNameElem.appendChild( doc.createTextNode( contactOrganization ) );
560 }
561 inspireCommonMetadataPointOfContactElem.appendChild( inspireCommonOrganisationNameElem );
562
563 QString contactMail = QgsServerProjectUtils::owsServiceContactMail( *project );
564 QDomElement inspireCommonEmailAddressElem = doc.createElement( QStringLiteral( "inspire_common:EmailAddress" ) );
565 if ( !contactMail.isNull() )
566 {
567 inspireCommonEmailAddressElem.appendChild( doc.createTextNode( contactMail ) );
568 }
569 inspireCommonMetadataPointOfContactElem.appendChild( inspireCommonEmailAddressElem );
570
571 inspireCapabilitiesElem.appendChild( inspireCommonMetadataPointOfContactElem );
572
573 QString inspireMetadataDate = QgsServerProjectUtils::wmsInspireMetadataDate( *project );
574 if ( !inspireMetadataDate.isNull() )
575 {
576 QDomElement inspireCommonMetadataDateElem = doc.createElement( QStringLiteral( "inspire_common:MetadataDate" ) );
577 inspireCommonMetadataDateElem.appendChild( doc.createTextNode( inspireMetadataDate ) );
578 inspireCapabilitiesElem.appendChild( inspireCommonMetadataDateElem );
579 }
580 }
581
582 // Supported languages
583 QDomElement inspireCommonSupportedLanguagesElem = doc.createElement( QStringLiteral( "inspire_common:SupportedLanguages" ) );
584 inspireCommonSupportedLanguagesElem.setAttribute( QStringLiteral( "xsi:type" ), QStringLiteral( "inspire_common:supportedLanguagesType" ) );
585
586 QDomElement inspireCommonLanguageElem = doc.createElement( QStringLiteral( "inspire_common:Language" ) );
587 inspireCommonLanguageElem.appendChild( doc.createTextNode( QgsServerProjectUtils::wmsInspireLanguage( *project ) ) );
588
589 QDomElement inspireCommonDefaultLanguageElem = doc.createElement( QStringLiteral( "inspire_common:DefaultLanguage" ) );
590 inspireCommonDefaultLanguageElem.appendChild( inspireCommonLanguageElem );
591 inspireCommonSupportedLanguagesElem.appendChild( inspireCommonDefaultLanguageElem );
592
593#if 0
594 /* Supported language has to be different from default one */
595 QDomElement inspireCommonSupportedLanguageElem = doc.createElement( "inspire_common:SupportedLanguage" );
596 inspireCommonSupportedLanguageElem.appendChild( inspireCommonLanguageElem.cloneNode().toElement() );
597 inspireCommonSupportedLanguagesElem.appendChild( inspireCommonSupportedLanguageElem );
598#endif
599
600 inspireCapabilitiesElem.appendChild( inspireCommonSupportedLanguagesElem );
601
602 QDomElement inspireCommonResponseLanguageElem = doc.createElement( QStringLiteral( "inspire_common:ResponseLanguage" ) );
603 inspireCommonResponseLanguageElem.appendChild( inspireCommonLanguageElem.cloneNode().toElement() );
604 inspireCapabilitiesElem.appendChild( inspireCommonResponseLanguageElem );
605
606 return inspireCapabilitiesElem;
607 }
608
609 QDomElement getComposerTemplatesElement( QDomDocument &doc, const QgsProject *project )
610 {
611 QList<QgsPrintLayout *> projectComposers = project->layoutManager()->printLayouts();
612 if ( projectComposers.size() == 0 )
613 return QDomElement();
614
615 QStringList restrictedComposers = QgsServerProjectUtils::wmsRestrictedComposers( *project );
616
617 QDomElement composerTemplatesElem = doc.createElement( QStringLiteral( "ComposerTemplates" ) );
618 QList<QgsPrintLayout *>::const_iterator cIt = projectComposers.constBegin();
619 for ( ; cIt != projectComposers.constEnd(); ++cIt )
620 {
621 QgsPrintLayout *layout = *cIt;
622 if ( restrictedComposers.contains( layout->name() ) )
623 continue;
624
625 // Check that we have at least one page
626 if ( layout->pageCollection()->pageCount() < 1 )
627 continue;
628
629 // Get width and height from first page of the collection
630 QgsLayoutSize layoutSize( layout->pageCollection()->page( 0 )->sizeWithUnits() );
633
634 QDomElement composerTemplateElem = doc.createElement( QStringLiteral( "ComposerTemplate" ) );
635 composerTemplateElem.setAttribute( QStringLiteral( "name" ), layout->name() );
636
637 //get paper width and height in mm from composition
638 composerTemplateElem.setAttribute( QStringLiteral( "width" ), width.length() );
639 composerTemplateElem.setAttribute( QStringLiteral( "height" ), height.length() );
640
641 //atlas enabled and atlas covering layer
642 QgsLayoutAtlas *atlas = layout->atlas();
643 if ( atlas && atlas->enabled() )
644 {
645 composerTemplateElem.setAttribute( QStringLiteral( "atlasEnabled" ), QStringLiteral( "1" ) );
646 QgsVectorLayer *cLayer = atlas->coverageLayer();
647 if ( cLayer )
648 {
649 QString layerName = cLayer->serverProperties()->shortName();
651 {
652 layerName = cLayer->id();
653 }
654 else if ( layerName.isEmpty() )
655 {
656 layerName = cLayer->name();
657 }
658 composerTemplateElem.setAttribute( QStringLiteral( "atlasCoverageLayer" ), layerName );
659 }
660 }
661
662 //add available composer maps and their size in mm
663 QList<QgsLayoutItemMap *> layoutMapList;
664 layout->layoutItems<QgsLayoutItemMap>( layoutMapList );
665 QList<QgsLayoutItemMap *>::const_iterator cmIt = layoutMapList.constBegin();
666 // Add map id
667 int mapId = 0;
668 for ( ; cmIt != layoutMapList.constEnd(); ++cmIt )
669 {
670 const QgsLayoutItemMap *composerMap = *cmIt;
671
672 QDomElement composerMapElem = doc.createElement( QStringLiteral( "ComposerMap" ) );
673 composerMapElem.setAttribute( QStringLiteral( "name" ), QStringLiteral( "map%1" ).arg( mapId ) );
674 composerMapElem.setAttribute( QStringLiteral( "itemName" ), composerMap->displayName() );
675 mapId++;
676 composerMapElem.setAttribute( QStringLiteral( "width" ), composerMap->rect().width() );
677 composerMapElem.setAttribute( QStringLiteral( "height" ), composerMap->rect().height() );
678 composerTemplateElem.appendChild( composerMapElem );
679 }
680
681 //add available composer labels
682 QList<QgsLayoutItemLabel *> composerLabelList;
683 layout->layoutItems<QgsLayoutItemLabel>( composerLabelList );
684 QList<QgsLayoutItemLabel *>::const_iterator clIt = composerLabelList.constBegin();
685 for ( ; clIt != composerLabelList.constEnd(); ++clIt )
686 {
687 QgsLayoutItemLabel *composerLabel = *clIt;
688 QString id = composerLabel->id();
689 if ( id.isEmpty() )
690 continue;
691
692 QDomElement composerLabelElem = doc.createElement( QStringLiteral( "ComposerLabel" ) );
693 composerLabelElem.setAttribute( QStringLiteral( "name" ), id );
694 composerTemplateElem.appendChild( composerLabelElem );
695 }
696
697 //add available composer HTML
698 QList<QgsLayoutItemHtml *> composerHtmlList;
699 layout->layoutObjects<QgsLayoutItemHtml>( composerHtmlList );
700 QList<QgsLayoutItemHtml *>::const_iterator chIt = composerHtmlList.constBegin();
701 for ( ; chIt != composerHtmlList.constEnd(); ++chIt )
702 {
703 QgsLayoutItemHtml *composerHtml = *chIt;
704 if ( composerHtml->frameCount() == 0 )
705 continue;
706
707 QString id = composerHtml->frame( 0 )->id();
708 if ( id.isEmpty() )
709 continue;
710
711 QDomElement composerHtmlElem = doc.createElement( QStringLiteral( "ComposerHtml" ) );
712 composerHtmlElem.setAttribute( QStringLiteral( "name" ), id );
713 composerTemplateElem.appendChild( composerHtmlElem );
714 }
715
716 composerTemplatesElem.appendChild( composerTemplateElem );
717 }
718
719 if ( composerTemplatesElem.childNodes().size() == 0 )
720 return QDomElement();
721
722 return composerTemplatesElem;
723 }
724
725 QDomElement getWFSLayersElement( QDomDocument &doc, const QgsProject *project )
726 {
727 QStringList wfsLayerIds = QgsServerProjectUtils::wfsLayerIds( *project );
728 if ( wfsLayerIds.size() == 0 )
729 return QDomElement();
730
731 QDomElement wfsLayersElem = doc.createElement( QStringLiteral( "WFSLayers" ) );
732 for ( int i = 0; i < wfsLayerIds.size(); ++i )
733 {
734 QgsMapLayer *layer = project->mapLayer( wfsLayerIds.at( i ) );
735 if ( !layer || layer->type() != Qgis::LayerType::Vector )
736 {
737 continue;
738 }
739
740 QDomElement wfsLayerElem = doc.createElement( QStringLiteral( "WFSLayer" ) );
742 {
743 wfsLayerElem.setAttribute( QStringLiteral( "name" ), layer->id() );
744 }
745 else
746 {
747 wfsLayerElem.setAttribute( QStringLiteral( "name" ), layer->name() );
748 }
749 wfsLayersElem.appendChild( wfsLayerElem );
750 }
751
752 return wfsLayersElem;
753 }
754
755 void handleLayersFromTreeGroup( QDomDocument &doc, QDomElement &parentLayer, QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, const QgsLayerTreeGroup *layerTreeGroup, const QMap<QString, QgsWmsLayerInfos> &wmsLayerInfos, bool projectSettings )
756 {
757 const auto layerIds = layerTreeGroup->findLayerIds();
758
759 parentLayer.setAttribute(
760 QStringLiteral( "queryable" ),
761 hasQueryableLayers( layerIds, wmsLayerInfos ) ? QStringLiteral( "1" ) : QStringLiteral( "0" )
762 );
763
764 const QgsRectangle wgs84BoundingRect = combineWgs84BoundingRect( layerIds, wmsLayerInfos );
765 QMap<QString, QgsRectangle> crsExtents = combineCrsExtents( layerIds, wmsLayerInfos );
766
767 appendCrsElementsToLayer( doc, parentLayer, crsExtents.keys(), QStringList() );
768 appendLayerWgs84BoundingRect( doc, parentLayer, wgs84BoundingRect );
769 appendLayerCrsExtents( doc, parentLayer, crsExtents );
770
771 appendLayersFromTreeGroup( doc, parentLayer, serverIface, project, request, layerTreeGroup, wmsLayerInfos, projectSettings );
772 }
773
774 QDomElement getLayersAndStylesCapabilitiesElement( QDomDocument &doc, QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, bool projectSettings )
775 {
776 const QgsLayerTree *projectLayerTreeRoot = project->layerTreeRoot();
777
778 QDomElement layerParentElem = doc.createElement( QStringLiteral( "Layer" ) );
779
780 // Root Layer name
781 QString rootLayerName = QgsServerProjectUtils::wmsRootName( *project );
782 if ( rootLayerName.isEmpty() && !project->title().isEmpty() )
783 {
784 rootLayerName = project->title();
785 }
786
787 if ( !rootLayerName.isEmpty() )
788 {
789 QDomElement layerParentNameElem = doc.createElement( QStringLiteral( "Name" ) );
790 QDomText layerParentNameText = doc.createTextNode( rootLayerName );
791 layerParentNameElem.appendChild( layerParentNameText );
792 layerParentElem.appendChild( layerParentNameElem );
793 }
794
795 // Root Layer title
796 QDomElement layerParentTitleElem = doc.createElement( QStringLiteral( "Title" ) );
797 QDomText layerParentTitleText = doc.createTextNode( QgsServerProjectUtils::owsServiceTitle( *project ) );
798 layerParentTitleElem.appendChild( layerParentTitleText );
799 layerParentElem.appendChild( layerParentTitleElem );
800
801 // Root Layer abstract
802 const QString rootLayerAbstract = QgsServerProjectUtils::owsServiceAbstract( *project );
803 if ( !rootLayerAbstract.isEmpty() )
804 {
805 QDomElement layerParentAbstElem = doc.createElement( QStringLiteral( "Abstract" ) );
806 QDomText layerParentAbstText = doc.createCDATASection( rootLayerAbstract );
807 layerParentAbstElem.appendChild( layerParentAbstText );
808 layerParentElem.appendChild( layerParentAbstElem );
809 }
810
811 // Keyword list
812 addKeywordListElement( project, doc, layerParentElem );
813
814 // Root Layer tree name
815 if ( projectSettings )
816 {
817 QDomElement treeNameElem = doc.createElement( QStringLiteral( "TreeName" ) );
818 QDomText treeNameText = doc.createTextNode( project->title() );
819 treeNameElem.appendChild( treeNameText );
820 layerParentElem.appendChild( treeNameElem );
821 }
822
823 // Instantiate CRS's from the project's crs list
824 // This will prevent us to re-instantiate all the crs's each
825 // time we will need to rebuild a bounding box.
826 auto outputCrsList = QList<QgsCoordinateReferenceSystem>();
827 for ( const QString &crsDef : QgsServerProjectUtils::wmsOutputCrsList( *project ) )
828 {
830 if ( crs.isValid() )
831 {
832 outputCrsList.append( crs );
833 }
834 }
835
836 // Get WMS layer infos
837 const QMap<QString, QgsWmsLayerInfos> wmsLayerInfos = QgsWmsLayerInfos::buildWmsLayerInfos( serverIface, project, outputCrsList );
838
839 const QgsRectangle wmsExtent = QgsServerProjectUtils::wmsExtent( *project );
840
841 if ( !wmsExtent.isEmpty() )
842 {
844
845 // Get WMS WGS84 bounding rectangle
846 QgsRectangle wmsWgs84BoundingRect;
847 try
848 {
849 wmsWgs84BoundingRect = QgsWmsLayerInfos::transformExtent(
850 wmsExtent, project->crs(), wgs84, project->transformContext(), true
851 );
852 }
853 catch ( QgsCsException &cse )
854 {
856 QStringLiteral( "Error transforming extent: %1" ).arg( cse.what() ),
857 QStringLiteral( "Server" ),
859 );
860 }
861
862 // Get WMS extents in output CRSes
863 QMap<QString, QgsRectangle> wmsCrsExtents;
864 try
865 {
867 wmsExtent, project->crs(), outputCrsList, project->transformContext()
868 );
869 }
870 catch ( QgsCsException &cse )
871 {
872 QgsMessageLog::logMessage( QStringLiteral( "Error transforming extent: %1" ).arg( cse.what() ), QStringLiteral( "Server" ), Qgis::MessageLevel::Warning );
873 }
874
875 layerParentElem.setAttribute(
876 QStringLiteral( "queryable" ),
877 hasQueryableLayers( projectLayerTreeRoot->findLayerIds(), wmsLayerInfos ) ? QStringLiteral( "1" ) : QStringLiteral( "0" )
878 );
879
880 appendCrsElementsToLayer( doc, layerParentElem, wmsCrsExtents.keys(), QStringList() );
881 appendLayerWgs84BoundingRect( doc, layerParentElem, wmsWgs84BoundingRect );
882 appendLayerCrsExtents( doc, layerParentElem, wmsCrsExtents );
883
884 appendLayersFromTreeGroup( doc, layerParentElem, serverIface, project, request, projectLayerTreeRoot, wmsLayerInfos, projectSettings );
885 }
886 else
887 {
888 handleLayersFromTreeGroup( doc, layerParentElem, serverIface, project, request, projectLayerTreeRoot, wmsLayerInfos, projectSettings );
889 }
890
891 return layerParentElem;
892 }
893
894 namespace
895 {
896
897 void appendLayersFromTreeGroup( QDomDocument &doc, QDomElement &parentLayer, QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, const QgsLayerTreeGroup *layerTreeGroup, const QMap<QString, QgsWmsLayerInfos> &wmsLayerInfos, bool projectSettings )
898 {
899 const QString version = request.wmsParameters().version();
900
901 bool siaFormat = QgsServerProjectUtils::wmsInfoFormatSia2045( *project );
902 const QStringList restrictedLayers = QgsServerProjectUtils::wmsRestrictedLayers( *project );
903 const bool skipNameForGroup = QgsServerProjectUtils::wmsSkipNameForGroup( *project );
904
905 QList<QgsLayerTreeNode *> layerTreeGroupChildren = layerTreeGroup->children();
906 for ( int i = 0; i < layerTreeGroupChildren.size(); ++i )
907 {
908 QgsLayerTreeNode *treeNode = layerTreeGroupChildren.at( i );
909 QDomElement layerElem = doc.createElement( QStringLiteral( "Layer" ) );
910
911 if ( projectSettings )
912 {
913 layerElem.setAttribute( QStringLiteral( "visible" ), treeNode->isVisible() );
914 layerElem.setAttribute( QStringLiteral( "visibilityChecked" ), treeNode->itemVisibilityChecked() );
915 layerElem.setAttribute( QStringLiteral( "expanded" ), treeNode->isExpanded() );
916 }
917
918 if ( treeNode->nodeType() == QgsLayerTreeNode::NodeGroup )
919 {
920 QgsLayerTreeGroup *treeGroupChild = static_cast<QgsLayerTreeGroup *>( treeNode );
921
922 QString name = treeGroupChild->name();
923 if ( restrictedLayers.contains( name ) ) //unpublished group
924 {
925 continue;
926 }
927
928 if ( projectSettings )
929 {
930 layerElem.setAttribute( QStringLiteral( "mutuallyExclusive" ), treeGroupChild->isMutuallyExclusive() );
931 }
932
933 QString shortName = treeGroupChild->customProperty( QStringLiteral( "wmsShortName" ) ).toString();
934 QString title = treeGroupChild->customProperty( QStringLiteral( "wmsTitle" ) ).toString();
935
936 if ( !skipNameForGroup )
937 {
938 QDomElement nameElem = doc.createElement( QStringLiteral( "Name" ) );
939 QDomText nameText;
940 if ( !shortName.isEmpty() )
941 nameText = doc.createTextNode( shortName );
942 else
943 nameText = doc.createTextNode( name );
944 nameElem.appendChild( nameText );
945 layerElem.appendChild( nameElem );
946 }
947
948 QDomElement titleElem = doc.createElement( QStringLiteral( "Title" ) );
949 QDomText titleText;
950 if ( !title.isEmpty() )
951 titleText = doc.createTextNode( title );
952 else
953 titleText = doc.createTextNode( name );
954 titleElem.appendChild( titleText );
955 layerElem.appendChild( titleElem );
956
957 QString abstract = treeGroupChild->customProperty( QStringLiteral( "wmsAbstract" ) ).toString();
958 if ( !abstract.isEmpty() )
959 {
960 QDomElement abstractElem = doc.createElement( QStringLiteral( "Abstract" ) );
961 QDomText abstractText = doc.createTextNode( abstract );
962 abstractElem.appendChild( abstractText );
963 layerElem.appendChild( abstractElem );
964 }
965
966 // Layer tree name
967 if ( projectSettings )
968 {
969 QDomElement treeNameElem = doc.createElement( QStringLiteral( "TreeName" ) );
970 QDomText treeNameText = doc.createTextNode( name );
971 treeNameElem.appendChild( treeNameText );
972 layerElem.appendChild( treeNameElem );
973 }
974
975 handleLayersFromTreeGroup( doc, layerElem, serverIface, project, request, treeGroupChild, wmsLayerInfos, projectSettings );
976
977 // Check if child layer elements have been added
978 if ( layerElem.elementsByTagName( QStringLiteral( "Layer" ) ).length() == 0 )
979 {
980 continue;
981 }
982 }
983 else
984 {
985 QgsLayerTreeLayer *treeLayer = static_cast<QgsLayerTreeLayer *>( treeNode );
986 QgsMapLayer *l = treeLayer->layer();
987 if ( !wmsLayerInfos.contains( treeLayer->layerId() ) ) //unpublished layer
988 {
989 continue;
990 }
991
992 const QgsWmsLayerInfos &layerInfos = wmsLayerInfos[treeLayer->layerId()];
993
994 layerElem.setAttribute(
995 QStringLiteral( "queryable" ),
996 layerInfos.queryable ? QStringLiteral( "1" ) : QStringLiteral( "0" )
997 );
998
999 QDomElement nameElem = doc.createElement( QStringLiteral( "Name" ) );
1000 QDomText nameText = doc.createTextNode( layerInfos.name );
1001 nameElem.appendChild( nameText );
1002 layerElem.appendChild( nameElem );
1003
1004 QDomElement titleElem = doc.createElement( QStringLiteral( "Title" ) );
1005 QDomText titleText = doc.createTextNode( layerInfos.title );
1006 titleElem.appendChild( titleText );
1007 layerElem.appendChild( titleElem );
1008
1009 if ( !layerInfos.abstract.isEmpty() )
1010 {
1011 QDomElement abstractElem = doc.createElement( QStringLiteral( "Abstract" ) );
1012 QDomText abstractText = doc.createTextNode( layerInfos.abstract );
1013 abstractElem.appendChild( abstractText );
1014 layerElem.appendChild( abstractElem );
1015 }
1016
1017 //keyword list
1018 if ( !layerInfos.keywords.isEmpty() )
1019 {
1020 QDomElement keywordListElem = doc.createElement( QStringLiteral( "KeywordList" ) );
1021 for ( const QString &keyword : std::as_const( layerInfos.keywords ) )
1022 {
1023 QDomElement keywordElem = doc.createElement( QStringLiteral( "Keyword" ) );
1024 QDomText keywordText = doc.createTextNode( keyword.trimmed() );
1025 keywordElem.appendChild( keywordText );
1026 if ( siaFormat )
1027 {
1028 keywordElem.setAttribute( QStringLiteral( "vocabulary" ), QStringLiteral( "SIA_Geo405" ) );
1029 }
1030 keywordListElem.appendChild( keywordElem );
1031 }
1032 layerElem.appendChild( keywordListElem );
1033 }
1034
1035 // Append not null Bounding rectangles
1036 if ( !layerInfos.wgs84BoundingRect.isNull() )
1037 {
1038 appendCrsElementsToLayer( doc, layerElem, layerInfos.crsExtents.keys(), QStringList() );
1039
1040 appendLayerWgs84BoundingRect( doc, layerElem, layerInfos.wgs84BoundingRect );
1041
1042 appendLayerCrsExtents( doc, layerElem, layerInfos.crsExtents );
1043 }
1044
1045 // add details about supported styles of the layer
1046 appendLayerStyles( doc, layerElem, layerInfos, project, request, serverIface->serverSettings() );
1047
1048 //min/max scale denominatorScaleBasedVisibility
1049 if ( layerInfos.hasScaleBasedVisibility )
1050 {
1051 // Convert double to string and remove trailing zero and last point if present
1052 auto formatScale = []( double value ) {
1053 const thread_local QRegularExpression trailingZeroRegEx = QRegularExpression( QStringLiteral( "0+$" ) );
1054 const thread_local QRegularExpression trailingPointRegEx = QRegularExpression( QStringLiteral( "[.]+$" ) );
1055 return QString::number( value, 'f' ).remove( trailingZeroRegEx ).remove( trailingPointRegEx );
1056 };
1057
1058 if ( version == QLatin1String( "1.1.1" ) )
1059 {
1060 double OGC_PX_M = 0.00028; // OGC reference pixel size in meter, also used by qgis
1061 double SCALE_TO_SCALEHINT = OGC_PX_M * M_SQRT2;
1062
1063 QDomElement scaleHintElem = doc.createElement( QStringLiteral( "ScaleHint" ) );
1064 scaleHintElem.setAttribute( QStringLiteral( "min" ), formatScale( layerInfos.maxScale * SCALE_TO_SCALEHINT ) );
1065 scaleHintElem.setAttribute( QStringLiteral( "max" ), formatScale( layerInfos.minScale * SCALE_TO_SCALEHINT ) );
1066 layerElem.appendChild( scaleHintElem );
1067 }
1068 else
1069 {
1070 QDomElement minScaleElem = doc.createElement( QStringLiteral( "MinScaleDenominator" ) );
1071 QDomText minScaleText = doc.createTextNode( formatScale( layerInfos.maxScale ) );
1072 minScaleElem.appendChild( minScaleText );
1073 layerElem.appendChild( minScaleElem );
1074
1075 QDomElement maxScaleElem = doc.createElement( QStringLiteral( "MaxScaleDenominator" ) );
1076 QDomText maxScaleText = doc.createTextNode( formatScale( layerInfos.minScale ) );
1077 maxScaleElem.appendChild( maxScaleText );
1078 layerElem.appendChild( maxScaleElem );
1079 }
1080 }
1081
1082 // layer data URL
1083 if ( !layerInfos.dataUrl.isEmpty() )
1084 {
1085 QDomElement dataUrlElem = doc.createElement( QStringLiteral( "DataURL" ) );
1086 QDomElement dataUrlFormatElem = doc.createElement( QStringLiteral( "Format" ) );
1087 QString dataUrlFormat = l->serverProperties()->dataUrlFormat();
1088 QDomText dataUrlFormatText = doc.createTextNode( dataUrlFormat );
1089 dataUrlFormatElem.appendChild( dataUrlFormatText );
1090 dataUrlElem.appendChild( dataUrlFormatElem );
1091 QDomElement dataORElem = doc.createElement( QStringLiteral( "OnlineResource" ) );
1092 dataORElem.setAttribute( QStringLiteral( "xmlns:xlink" ), QStringLiteral( "http://www.w3.org/1999/xlink" ) );
1093 dataORElem.setAttribute( QStringLiteral( "xlink:type" ), QStringLiteral( "simple" ) );
1094 dataORElem.setAttribute( QStringLiteral( "xlink:href" ), layerInfos.dataUrl );
1095 dataUrlElem.appendChild( dataORElem );
1096 layerElem.appendChild( dataUrlElem );
1097 }
1098
1099 // layer attribution
1100 if ( !layerInfos.attribution.isEmpty() )
1101 {
1102 QDomElement attribElem = doc.createElement( QStringLiteral( "Attribution" ) );
1103 QDomElement attribTitleElem = doc.createElement( QStringLiteral( "Title" ) );
1104 QDomText attribText = doc.createTextNode( layerInfos.attribution );
1105 attribTitleElem.appendChild( attribText );
1106 attribElem.appendChild( attribTitleElem );
1107 if ( !layerInfos.attributionUrl.isEmpty() )
1108 {
1109 QDomElement attribORElem = doc.createElement( QStringLiteral( "OnlineResource" ) );
1110 attribORElem.setAttribute( QStringLiteral( "xmlns:xlink" ), QStringLiteral( "http://www.w3.org/1999/xlink" ) );
1111 attribORElem.setAttribute( QStringLiteral( "xlink:type" ), QStringLiteral( "simple" ) );
1112 attribORElem.setAttribute( QStringLiteral( "xlink:href" ), layerInfos.attributionUrl );
1113 attribElem.appendChild( attribORElem );
1114 }
1115 layerElem.appendChild( attribElem );
1116 }
1117
1118 // layer metadata URL
1119 for ( const QgsMapLayerServerProperties::MetadataUrl &metadataUrl : std::as_const( layerInfos.metadataUrls ) )
1120 {
1121 QDomElement metaUrlElem = doc.createElement( QStringLiteral( "MetadataURL" ) );
1122 const QString metadataUrlType = metadataUrl.type;
1123 if ( version == QLatin1String( "1.1.1" ) )
1124 {
1125 metaUrlElem.setAttribute( QStringLiteral( "type" ), metadataUrlType );
1126 }
1127 else if ( metadataUrlType == QLatin1String( "FGDC" ) )
1128 {
1129 metaUrlElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "FGDC:1998" ) );
1130 }
1131 else if ( metadataUrlType == QLatin1String( "TC211" ) )
1132 {
1133 metaUrlElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "ISO19115:2003" ) );
1134 }
1135 else
1136 {
1137 metaUrlElem.setAttribute( QStringLiteral( "type" ), metadataUrlType );
1138 }
1139 const QString metadataUrlFormat = metadataUrl.format;
1140 if ( !metadataUrlFormat.isEmpty() )
1141 {
1142 QDomElement metaUrlFormatElem = doc.createElement( QStringLiteral( "Format" ) );
1143 QDomText metaUrlFormatText = doc.createTextNode( metadataUrlFormat );
1144 metaUrlFormatElem.appendChild( metaUrlFormatText );
1145 metaUrlElem.appendChild( metaUrlFormatElem );
1146 }
1147 QDomElement metaUrlORElem = doc.createElement( QStringLiteral( "OnlineResource" ) );
1148 metaUrlORElem.setAttribute( QStringLiteral( "xmlns:xlink" ), QStringLiteral( "http://www.w3.org/1999/xlink" ) );
1149 metaUrlORElem.setAttribute( QStringLiteral( "xlink:type" ), QStringLiteral( "simple" ) );
1150 metaUrlORElem.setAttribute( QStringLiteral( "xlink:href" ), metadataUrl.url );
1151 metaUrlElem.appendChild( metaUrlORElem );
1152 layerElem.appendChild( metaUrlElem );
1153 }
1154
1155 bool timeDimensionAdded { false };
1156
1157 // Add dimensions
1158 if ( l->type() == Qgis::LayerType::Vector )
1159 {
1160 QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( l );
1161 QgsMapLayerServerProperties *serverProperties = static_cast<QgsMapLayerServerProperties *>( vl->serverProperties() );
1162 const QList<QgsMapLayerServerProperties::WmsDimensionInfo> wmsDims = serverProperties->wmsDimensions();
1163 for ( const QgsMapLayerServerProperties::WmsDimensionInfo &dim : wmsDims )
1164 {
1165 int fieldIndex = vl->fields().indexOf( dim.fieldName );
1166 // Check field index
1167 if ( fieldIndex == -1 )
1168 {
1169 continue;
1170 }
1171 // get unique values
1172 QSet<QVariant> uniqueValues = vl->uniqueValues( fieldIndex );
1173
1174 // get unique values from endfield name if define
1175 if ( !dim.endFieldName.isEmpty() )
1176 {
1177 int endFieldIndex = vl->fields().indexOf( dim.endFieldName );
1178 // Check end field index
1179 if ( endFieldIndex == -1 )
1180 {
1181 continue;
1182 }
1183 uniqueValues.unite( vl->uniqueValues( endFieldIndex ) );
1184 }
1185 // sort unique values
1186 QList<QVariant> values = qgis::setToList( uniqueValues );
1187 std::sort( values.begin(), values.end() );
1188
1189 QDomElement dimElem = doc.createElement( QStringLiteral( "Dimension" ) );
1190 dimElem.setAttribute( QStringLiteral( "name" ), dim.name );
1191
1192 if ( dim.name.toUpper() == QLatin1String( "TIME" ) )
1193 {
1194 timeDimensionAdded = true;
1195 }
1196
1197 if ( !dim.units.isEmpty() )
1198 {
1199 dimElem.setAttribute( QStringLiteral( "units" ), dim.units );
1200 }
1201 if ( !dim.unitSymbol.isEmpty() )
1202 {
1203 dimElem.setAttribute( QStringLiteral( "unitSymbol" ), dim.unitSymbol );
1204 }
1205 if ( !values.isEmpty() && dim.defaultDisplayType == QgsMapLayerServerProperties::WmsDimensionInfo::MinValue )
1206 {
1207 dimElem.setAttribute( QStringLiteral( "default" ), values.first().toString() );
1208 }
1209 else if ( !values.isEmpty() && dim.defaultDisplayType == QgsMapLayerServerProperties::WmsDimensionInfo::MaxValue )
1210 {
1211 dimElem.setAttribute( QStringLiteral( "default" ), values.last().toString() );
1212 }
1213 else if ( dim.defaultDisplayType == QgsMapLayerServerProperties::WmsDimensionInfo::ReferenceValue )
1214 {
1215 dimElem.setAttribute( QStringLiteral( "default" ), dim.referenceValue.toString() );
1216 }
1217 dimElem.setAttribute( QStringLiteral( "multipleValues" ), QStringLiteral( "1" ) );
1218 dimElem.setAttribute( QStringLiteral( "nearestValue" ), QStringLiteral( "0" ) );
1219 if ( projectSettings )
1220 {
1221 dimElem.setAttribute( QStringLiteral( "fieldName" ), dim.fieldName );
1222 dimElem.setAttribute( QStringLiteral( "endFieldName" ), dim.endFieldName );
1223 }
1224 // values list
1225 QStringList strValues;
1226 for ( const QVariant &v : values )
1227 {
1228 strValues << v.toString();
1229 }
1230 QDomText dimValuesText = doc.createTextNode( strValues.join( QLatin1String( ", " ) ) );
1231 dimElem.appendChild( dimValuesText );
1232 layerElem.appendChild( dimElem );
1233 }
1234 }
1235
1236 // Add WMS time dimension if not already added
1237 if ( !timeDimensionAdded
1238 && l->temporalProperties()
1239 && l->temporalProperties()->isActive() )
1240 {
1241 QDomElement dimElem = doc.createElement( QStringLiteral( "Dimension" ) );
1242 dimElem.setAttribute( QStringLiteral( "name" ), QStringLiteral( "TIME" ) );
1243 dimElem.setAttribute( QStringLiteral( "units" ), QStringLiteral( "ISO8601" ) );
1244
1245 // TODO: set "default" (reference value)
1246
1247 // Add all values
1248 const QList<QgsDateTimeRange> allRanges { l->temporalProperties()->allTemporalRanges( l ) };
1249
1250 // Apparently, for vectors allTemporalRanges is always empty :/
1251 // there is no way to know the type of range or the individual instants
1252
1253 bool isDateList { true };
1254 bool isInstantList { true };
1255
1256 QList<QDateTime> values;
1257 for ( const auto &r : std::as_const( allRanges ) )
1258 {
1259 if ( r.isInstant() )
1260 {
1261 if ( r.begin().time() != QTime( 0, 0, 0, 0 ) )
1262 {
1263 isDateList = false;
1264 }
1265 values.append( r.begin() );
1266 }
1267 else
1268 {
1269 isInstantList = false;
1270 break;
1271 }
1272 }
1273
1274 // Only list individual values for list of instants,
1275 // otherwise only the extent will be shown
1276 if ( isInstantList )
1277 {
1278 // values list
1279 QStringList strValues;
1280 for ( const auto &v : values )
1281 {
1282 if ( isDateList )
1283 {
1284 strValues << v.date().toString( Qt::DateFormat::ISODate );
1285 }
1286 else
1287 {
1288 strValues << v.toString( Qt::DateFormat::ISODate );
1289 }
1290 }
1291 QDomText dimValuesText = doc.createTextNode( strValues.join( QChar( ',' ) ) );
1292 dimElem.appendChild( dimValuesText );
1293 }
1294
1295 layerElem.appendChild( dimElem );
1296
1297 QDomElement timeExtentElem = doc.createElement( QStringLiteral( "Extent" ) );
1298 timeExtentElem.setAttribute( QStringLiteral( "name" ), QStringLiteral( "TIME" ) );
1299
1300 const QgsDateTimeRange timeExtent { l->temporalProperties()->calculateTemporalExtent( l ) };
1301 QString extent;
1302 if ( isDateList )
1303 {
1304 extent = QStringLiteral( "%1/%2" ).arg( timeExtent.begin().date().toString( Qt::DateFormat::ISODate ), timeExtent.end().date().toString( Qt::DateFormat::ISODate ) );
1305 }
1306 else
1307 {
1308 extent = QStringLiteral( "%1/%2" ).arg( timeExtent.begin().toString( Qt::DateFormat::ISODate ), timeExtent.end().toString( Qt::DateFormat::ISODate ) );
1309 }
1310 QDomText extentValueText = doc.createTextNode( extent );
1311 timeExtentElem.appendChild( extentValueText );
1312 layerElem.appendChild( timeExtentElem );
1313 }
1314
1315 if ( projectSettings )
1316 {
1317 appendLayerProjectSettings( doc, layerElem, l );
1318 }
1319 }
1320
1321 parentLayer.appendChild( layerElem );
1322 }
1323 }
1324
1325 void appendLayerStyles( QDomDocument &doc, QDomElement &layerElem, const QgsWmsLayerInfos &layerInfos, const QgsProject *project, const QgsWmsRequest &request, const QgsServerSettings *settings )
1326 {
1327 // Get service URL
1328 QUrl href = serviceUrl( request, project, *settings );
1329
1330 //href needs to be a prefix
1331 QString hrefString = href.toString();
1332 hrefString.append( href.hasQuery() ? "&" : "?" );
1333 for ( const QString &styleName : std::as_const( layerInfos.styles ) )
1334 {
1335 QDomElement styleElem = doc.createElement( QStringLiteral( "Style" ) );
1336 QDomElement styleNameElem = doc.createElement( QStringLiteral( "Name" ) );
1337 QDomText styleNameText = doc.createTextNode( styleName );
1338 styleNameElem.appendChild( styleNameText );
1339 QDomElement styleTitleElem = doc.createElement( QStringLiteral( "Title" ) );
1340 QDomText styleTitleText = doc.createTextNode( styleName );
1341 styleTitleElem.appendChild( styleTitleText );
1342 styleElem.appendChild( styleNameElem );
1343 styleElem.appendChild( styleTitleElem );
1344
1345 // QString LegendURL for explicit layerbased GetLegendGraphic request
1346 QDomElement getLayerLegendGraphicElem = doc.createElement( QStringLiteral( "LegendURL" ) );
1347
1348 QString customHrefString = layerInfos.legendUrl;
1349
1350 QStringList getLayerLegendGraphicFormats;
1351 if ( !customHrefString.isEmpty() )
1352 {
1353 getLayerLegendGraphicFormats << layerInfos.legendUrlFormat;
1354 }
1355 else
1356 {
1357 getLayerLegendGraphicFormats << QStringLiteral( "image/png" ); // << "jpeg" << "image/jpeg"
1358 }
1359
1360 for ( const QString &getLayerLegendGraphicFormat : std::as_const( getLayerLegendGraphicFormats ) )
1361 {
1362 QDomElement getLayerLegendGraphicFormatElem = doc.createElement( QStringLiteral( "Format" ) );
1363 QDomText getLayerLegendGraphicFormatText = doc.createTextNode( getLayerLegendGraphicFormat );
1364 getLayerLegendGraphicFormatElem.appendChild( getLayerLegendGraphicFormatText );
1365 getLayerLegendGraphicElem.appendChild( getLayerLegendGraphicFormatElem );
1366 }
1367
1368 // no parameters on custom hrefUrl, because should link directly to graphic
1369 if ( customHrefString.isEmpty() )
1370 {
1371 QUrl mapUrl( hrefString );
1372 QUrlQuery mapUrlQuery( mapUrl.query() );
1373 mapUrlQuery.addQueryItem( QStringLiteral( "SERVICE" ), QStringLiteral( "WMS" ) );
1374 mapUrlQuery.addQueryItem( QStringLiteral( "VERSION" ), request.wmsParameters().version() );
1375 mapUrlQuery.addQueryItem( QStringLiteral( "REQUEST" ), QStringLiteral( "GetLegendGraphic" ) );
1376 mapUrlQuery.addQueryItem( QStringLiteral( "LAYER" ), layerInfos.name );
1377 mapUrlQuery.addQueryItem( QStringLiteral( "FORMAT" ), QStringLiteral( "image/png" ) );
1378 mapUrlQuery.addQueryItem( QStringLiteral( "STYLE" ), styleName );
1379 if ( request.wmsParameters().version() == QLatin1String( "1.3.0" ) )
1380 {
1381 mapUrlQuery.addQueryItem( QStringLiteral( "SLD_VERSION" ), QStringLiteral( "1.1.0" ) );
1382 }
1383 mapUrl.setQuery( mapUrlQuery );
1384 customHrefString = mapUrl.toString();
1385 }
1386
1387 QDomElement getLayerLegendGraphicORElem = doc.createElement( QStringLiteral( "OnlineResource" ) );
1388 getLayerLegendGraphicORElem.setAttribute( QStringLiteral( "xmlns:xlink" ), QStringLiteral( "http://www.w3.org/1999/xlink" ) );
1389 getLayerLegendGraphicORElem.setAttribute( QStringLiteral( "xlink:type" ), QStringLiteral( "simple" ) );
1390 getLayerLegendGraphicORElem.setAttribute( QStringLiteral( "xlink:href" ), customHrefString );
1391 getLayerLegendGraphicElem.appendChild( getLayerLegendGraphicORElem );
1392 styleElem.appendChild( getLayerLegendGraphicElem );
1393
1394 layerElem.appendChild( styleElem );
1395 }
1396 }
1397
1398 void appendCrsElementsToLayer( QDomDocument &doc, QDomElement &layerElement, const QStringList &crsList, const QStringList &constrainedCrsList )
1399 {
1400 if ( layerElement.isNull() )
1401 {
1402 return;
1403 }
1404
1405 const QString version = doc.documentElement().attribute( QStringLiteral( "version" ) );
1406
1407 //insert the CRS elements after the title element to be in accordance with the WMS 1.3 specification
1408 QDomElement titleElement = layerElement.firstChildElement( QStringLiteral( "Title" ) );
1409 QDomElement abstractElement = layerElement.firstChildElement( QStringLiteral( "Abstract" ) );
1410 QDomElement keywordListElement = layerElement.firstChildElement( QStringLiteral( "KeywordList" ) );
1411 QDomElement CRSPrecedingElement = !keywordListElement.isNull() ? keywordListElement : !abstractElement.isNull() ? abstractElement
1412 : titleElement;
1413
1414 if ( CRSPrecedingElement.isNull() )
1415 {
1416 // keyword list element is never empty
1417 const QDomElement keyElement = layerElement.firstChildElement( QStringLiteral( "KeywordList" ) );
1418 CRSPrecedingElement = keyElement;
1419 }
1420
1421 //In case the number of advertised CRS is constrained
1422 if ( !constrainedCrsList.isEmpty() )
1423 {
1424 for ( int i = constrainedCrsList.size() - 1; i >= 0; --i )
1425 {
1426 appendCrsElementToLayer( doc, layerElement, CRSPrecedingElement, constrainedCrsList.at( i ) );
1427 }
1428 }
1429 else //no crs constraint
1430 {
1431 for ( const QString &crs : crsList )
1432 {
1433 appendCrsElementToLayer( doc, layerElement, CRSPrecedingElement, crs );
1434 }
1435 }
1436
1437 // Support for CRS:84 is mandatory (equals EPSG:4326 with reversed axis)
1438 // https://github.com/opengeospatial/ets-wms13/blob/47155399c09b200cb21382874fdb21d5fae4ab6e/src/site/markdown/index.md
1439 if ( version == QLatin1String( "1.3.0" ) )
1440 {
1441 appendCrsElementToLayer( doc, layerElement, CRSPrecedingElement, QString( "CRS:84" ) );
1442 }
1443 }
1444
1445 void appendCrsElementToLayer( QDomDocument &doc, QDomElement &layerElement, const QDomElement &precedingElement, const QString &crsText )
1446 {
1447 if ( crsText.isEmpty() )
1448 return;
1449 const QString version = doc.documentElement().attribute( QStringLiteral( "version" ) );
1450 QDomElement crsElement = doc.createElement( version == QLatin1String( "1.1.1" ) ? "SRS" : "CRS" );
1451 QDomText crsTextNode = doc.createTextNode( crsText );
1452 crsElement.appendChild( crsTextNode );
1453 layerElement.insertAfter( crsElement, precedingElement );
1454 }
1455
1456 void appendLayerWgs84BoundingRect( QDomDocument &doc, QDomElement &layerElem, const QgsRectangle &wgs84BoundingRect )
1457 {
1458 //LatLonBoundingBox / Ex_GeographicBounding box is optional
1459 if ( wgs84BoundingRect.isNull() )
1460 {
1461 return;
1462 }
1463
1464 //Ex_GeographicBoundingBox
1465 QDomElement ExGeoBBoxElement;
1466 const int wgs84precision = 6;
1467 const QString version = doc.documentElement().attribute( QStringLiteral( "version" ) );
1468 if ( version == QLatin1String( "1.1.1" ) ) // WMS Version 1.1.1
1469 {
1470 ExGeoBBoxElement = doc.createElement( QStringLiteral( "LatLonBoundingBox" ) );
1471 ExGeoBBoxElement.setAttribute( QStringLiteral( "minx" ), qgsDoubleToString( QgsServerProjectUtils::floorWithPrecision( wgs84BoundingRect.xMinimum(), wgs84precision ), wgs84precision ) );
1472 ExGeoBBoxElement.setAttribute( QStringLiteral( "miny" ), qgsDoubleToString( QgsServerProjectUtils::floorWithPrecision( wgs84BoundingRect.yMinimum(), wgs84precision ), wgs84precision ) );
1473 ExGeoBBoxElement.setAttribute( QStringLiteral( "maxx" ), qgsDoubleToString( QgsServerProjectUtils::ceilWithPrecision( wgs84BoundingRect.xMaximum(), wgs84precision ), wgs84precision ) );
1474 ExGeoBBoxElement.setAttribute( QStringLiteral( "maxy" ), qgsDoubleToString( QgsServerProjectUtils::ceilWithPrecision( wgs84BoundingRect.yMaximum(), wgs84precision ), wgs84precision ) );
1475 }
1476 else // WMS Version 1.3.0
1477 {
1478 ExGeoBBoxElement = doc.createElement( QStringLiteral( "EX_GeographicBoundingBox" ) );
1479 QDomElement wBoundLongitudeElement = doc.createElement( QStringLiteral( "westBoundLongitude" ) );
1480 QDomText wBoundLongitudeText = doc.createTextNode( qgsDoubleToString( QgsServerProjectUtils::floorWithPrecision( wgs84BoundingRect.xMinimum(), wgs84precision ), wgs84precision ) );
1481 wBoundLongitudeElement.appendChild( wBoundLongitudeText );
1482 ExGeoBBoxElement.appendChild( wBoundLongitudeElement );
1483 QDomElement eBoundLongitudeElement = doc.createElement( QStringLiteral( "eastBoundLongitude" ) );
1484 QDomText eBoundLongitudeText = doc.createTextNode( qgsDoubleToString( QgsServerProjectUtils::ceilWithPrecision( wgs84BoundingRect.xMaximum(), wgs84precision ), wgs84precision ) );
1485 eBoundLongitudeElement.appendChild( eBoundLongitudeText );
1486 ExGeoBBoxElement.appendChild( eBoundLongitudeElement );
1487 QDomElement sBoundLatitudeElement = doc.createElement( QStringLiteral( "southBoundLatitude" ) );
1488 QDomText sBoundLatitudeText = doc.createTextNode( qgsDoubleToString( QgsServerProjectUtils::floorWithPrecision( wgs84BoundingRect.yMinimum(), wgs84precision ), wgs84precision ) );
1489 sBoundLatitudeElement.appendChild( sBoundLatitudeText );
1490 ExGeoBBoxElement.appendChild( sBoundLatitudeElement );
1491 QDomElement nBoundLatitudeElement = doc.createElement( QStringLiteral( "northBoundLatitude" ) );
1492 QDomText nBoundLatitudeText = doc.createTextNode( qgsDoubleToString( QgsServerProjectUtils::ceilWithPrecision( wgs84BoundingRect.yMaximum(), wgs84precision ), wgs84precision ) );
1493 nBoundLatitudeElement.appendChild( nBoundLatitudeText );
1494 ExGeoBBoxElement.appendChild( nBoundLatitudeElement );
1495 }
1496
1497 const QDomElement lastCRSElem = layerElem.lastChildElement( version == QLatin1String( "1.1.1" ) ? "SRS" : "CRS" );
1498 if ( !lastCRSElem.isNull() )
1499 {
1500 layerElem.insertAfter( ExGeoBBoxElement, lastCRSElem );
1501 }
1502 else
1503 {
1504 layerElem.appendChild( ExGeoBBoxElement );
1505 }
1506 }
1507
1508 void appendLayerCrsExtents( QDomDocument &doc, QDomElement &layerElem, const QMap<QString, QgsRectangle> &crsExtents )
1509 {
1510 const QString version = doc.documentElement().attribute( QStringLiteral( "version" ) );
1511
1512 const auto &keys = crsExtents.keys();
1513 for ( const QString &crsText : std::as_const( keys ) )
1514 {
1516 QgsRectangle crsExtent( crsExtents[crsText] );
1517
1518 if ( crsExtent.isNull() )
1519 {
1520 continue;
1521 }
1522
1523 int precision = 3;
1524 if ( crs.isGeographic() )
1525 {
1526 precision = 6;
1527 }
1528
1529 //BoundingBox element
1530 QDomElement bBoxElement = doc.createElement( QStringLiteral( "BoundingBox" ) );
1531 if ( crs.isValid() )
1532 {
1533 bBoxElement.setAttribute( version == QLatin1String( "1.1.1" ) ? "SRS" : "CRS", crs.authid() );
1534 }
1535
1536 if ( version != QLatin1String( "1.1.1" ) && crs.hasAxisInverted() )
1537 {
1538 crsExtent.invert();
1539 }
1540
1541 bBoxElement.setAttribute( QStringLiteral( "minx" ), qgsDoubleToString( QgsServerProjectUtils::floorWithPrecision( crsExtent.xMinimum(), precision ), precision ) );
1542 bBoxElement.setAttribute( QStringLiteral( "miny" ), qgsDoubleToString( QgsServerProjectUtils::floorWithPrecision( crsExtent.yMinimum(), precision ), precision ) );
1543 bBoxElement.setAttribute( QStringLiteral( "maxx" ), qgsDoubleToString( QgsServerProjectUtils::ceilWithPrecision( crsExtent.xMaximum(), precision ), precision ) );
1544 bBoxElement.setAttribute( QStringLiteral( "maxy" ), qgsDoubleToString( QgsServerProjectUtils::ceilWithPrecision( crsExtent.yMaximum(), precision ), precision ) );
1545
1546 QDomElement lastBBoxElem = layerElem.lastChildElement( QStringLiteral( "BoundingBox" ) );
1547 if ( !lastBBoxElem.isNull() )
1548 {
1549 layerElem.insertAfter( bBoxElement, lastBBoxElem );
1550 }
1551 else
1552 {
1553 lastBBoxElem = layerElem.lastChildElement( version == QLatin1String( "1.1.1" ) ? "LatLonBoundingBox" : "EX_GeographicBoundingBox" );
1554 if ( !lastBBoxElem.isNull() )
1555 {
1556 layerElem.insertAfter( bBoxElement, lastBBoxElem );
1557 }
1558 else
1559 {
1560 layerElem.appendChild( bBoxElement );
1561 }
1562 }
1563 }
1564 }
1565
1566 void appendDrawingOrder( QDomDocument &doc, QDomElement &parentElem, QgsServerInterface *serverIface, const QgsProject *project )
1567 {
1568#ifdef HAVE_SERVER_PYTHON_PLUGINS
1569 QgsAccessControl *accessControl = serverIface->accessControls();
1570#else
1571 ( void ) serverIface;
1572#endif
1573 bool useLayerIds = QgsServerProjectUtils::wmsUseLayerIds( *project );
1574 QStringList restrictedLayers = QgsServerProjectUtils::wmsRestrictedLayers( *project );
1575
1576 QStringList layerList;
1577
1578 const QgsLayerTree *projectLayerTreeRoot = project->layerTreeRoot();
1579 QList<QgsMapLayer *> projectLayerOrder = projectLayerTreeRoot->layerOrder();
1580 for ( int i = 0; i < projectLayerOrder.size(); ++i )
1581 {
1582 QgsMapLayer *l = projectLayerOrder.at( i );
1583
1584 if ( restrictedLayers.contains( l->name() ) ) //unpublished layer
1585 {
1586 continue;
1587 }
1588#ifdef HAVE_SERVER_PYTHON_PLUGINS
1589 if ( accessControl && !accessControl->layerReadPermission( l ) )
1590 {
1591 continue;
1592 }
1593#endif
1594 QString wmsName = l->name();
1595 if ( useLayerIds )
1596 {
1597 wmsName = l->id();
1598 }
1599 else if ( !l->serverProperties()->shortName().isEmpty() )
1600 {
1601 wmsName = l->serverProperties()->shortName();
1602 }
1603
1604 layerList << wmsName;
1605 }
1606
1607 if ( !layerList.isEmpty() )
1608 {
1609 QStringList reversedList;
1610 reversedList.reserve( layerList.size() );
1611 for ( int i = layerList.size() - 1; i >= 0; --i )
1612 reversedList << layerList[i];
1613
1614 QDomElement layerDrawingOrderElem = doc.createElement( QStringLiteral( "LayerDrawingOrder" ) );
1615 QDomText drawingOrderText = doc.createTextNode( reversedList.join( ',' ) );
1616 layerDrawingOrderElem.appendChild( drawingOrderText );
1617 parentElem.appendChild( layerDrawingOrderElem );
1618 }
1619 }
1620
1621 void appendLayerProjectSettings( QDomDocument &doc, QDomElement &layerElem, QgsMapLayer *currentLayer )
1622 {
1623 if ( !currentLayer )
1624 {
1625 return;
1626 }
1627
1628 // Layer tree name
1629 QDomElement treeNameElem = doc.createElement( QStringLiteral( "TreeName" ) );
1630 QDomText treeNameText = doc.createTextNode( currentLayer->name() );
1631 treeNameElem.appendChild( treeNameText );
1632 layerElem.appendChild( treeNameElem );
1633
1634 switch ( currentLayer->type() )
1635 {
1637 {
1638 QgsVectorLayer *vLayer = static_cast<QgsVectorLayer *>( currentLayer );
1639
1640 int displayFieldIdx = -1;
1641 QString displayField = QStringLiteral( "maptip" );
1642 QgsExpression exp( vLayer->displayExpression() );
1643 if ( exp.isField() )
1644 {
1645 displayField = static_cast<const QgsExpressionNodeColumnRef *>( exp.rootNode() )->name();
1646 displayFieldIdx = vLayer->fields().lookupField( displayField );
1647 }
1648
1649 //attributes
1650 QDomElement attributesElem = doc.createElement( QStringLiteral( "Attributes" ) );
1651 const QgsFields layerFields = vLayer->fields();
1652 for ( int idx = 0; idx < layerFields.count(); ++idx )
1653 {
1654 QgsField field = layerFields.at( idx );
1656 {
1657 continue;
1658 }
1659 // field alias in case of displayField
1660 if ( idx == displayFieldIdx )
1661 {
1662 displayField = vLayer->attributeDisplayName( idx );
1663 }
1664 QDomElement attributeElem = doc.createElement( QStringLiteral( "Attribute" ) );
1665 attributeElem.setAttribute( QStringLiteral( "name" ), field.name() );
1666 attributeElem.setAttribute( QStringLiteral( "type" ), QVariant::typeToName( field.type() ) );
1667 attributeElem.setAttribute( QStringLiteral( "typeName" ), field.typeName() );
1668 QString alias = field.alias();
1669 if ( !alias.isEmpty() )
1670 {
1671 attributeElem.setAttribute( QStringLiteral( "alias" ), alias );
1672 }
1673
1674 //edit type to text
1675 attributeElem.setAttribute( QStringLiteral( "editType" ), vLayer->editorWidgetSetup( idx ).type() );
1676 attributeElem.setAttribute( QStringLiteral( "comment" ), field.comment() );
1677 attributeElem.setAttribute( QStringLiteral( "length" ), field.length() );
1678 attributeElem.setAttribute( QStringLiteral( "precision" ), field.precision() );
1679 attributesElem.appendChild( attributeElem );
1680 }
1681
1682 //displayfield
1683 layerElem.setAttribute( QStringLiteral( "displayField" ), displayField );
1684
1685 //primary key
1686 QgsAttributeList pkAttributes = vLayer->primaryKeyAttributes();
1687 if ( pkAttributes.size() > 0 )
1688 {
1689 QDomElement pkElem = doc.createElement( QStringLiteral( "PrimaryKey" ) );
1690 QgsAttributeList::const_iterator pkIt = pkAttributes.constBegin();
1691 for ( ; pkIt != pkAttributes.constEnd(); ++pkIt )
1692 {
1693 QDomElement pkAttributeElem = doc.createElement( QStringLiteral( "PrimaryKeyAttribute" ) );
1694 QDomText pkAttName = doc.createTextNode( layerFields.at( *pkIt ).name() );
1695 pkAttributeElem.appendChild( pkAttName );
1696 pkElem.appendChild( pkAttributeElem );
1697 }
1698 layerElem.appendChild( pkElem );
1699 }
1700
1701 //geometry type
1702 layerElem.setAttribute( QStringLiteral( "geometryType" ), QgsWkbTypes::displayString( vLayer->wkbType() ) );
1703
1704 //opacity
1705 layerElem.setAttribute( QStringLiteral( "opacity" ), QString::number( vLayer->opacity() ) );
1706
1707 layerElem.appendChild( attributesElem );
1708 break;
1709 }
1710
1712 {
1713 const QgsDataProvider *provider = currentLayer->dataProvider();
1714 if ( provider && provider->name() == "wms" )
1715 {
1716 //advertise as web map background layer
1717 QVariant wmsBackgroundLayer = currentLayer->customProperty( QStringLiteral( "WMSBackgroundLayer" ), false );
1718 QDomElement wmsBackgroundLayerElem = doc.createElement( "WMSBackgroundLayer" );
1719 QDomText wmsBackgroundLayerText = doc.createTextNode( wmsBackgroundLayer.toBool() ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
1720 wmsBackgroundLayerElem.appendChild( wmsBackgroundLayerText );
1721 layerElem.appendChild( wmsBackgroundLayerElem );
1722
1723 //publish datasource
1724 QVariant wmsPublishDataSourceUrl = currentLayer->customProperty( QStringLiteral( "WMSPublishDataSourceUrl" ), false );
1725 if ( wmsPublishDataSourceUrl.toBool() )
1726 {
1727 bool tiled = qobject_cast<const QgsRasterDataProvider *>( provider )
1728 ? !qobject_cast<const QgsRasterDataProvider *>( provider )->nativeResolutions().isEmpty()
1729 : false;
1730
1731 QDomElement dataSourceElem = doc.createElement( tiled ? QStringLiteral( "WMTSDataSource" ) : QStringLiteral( "WMSDataSource" ) );
1732 QDomText dataSourceUri = doc.createTextNode( provider->dataSourceUri() );
1733 dataSourceElem.appendChild( dataSourceUri );
1734 layerElem.appendChild( dataSourceElem );
1735 }
1736 }
1737
1738 QVariant wmsPrintLayer = currentLayer->customProperty( QStringLiteral( "WMSPrintLayer" ) );
1739 if ( wmsPrintLayer.isValid() )
1740 {
1741 QDomElement wmsPrintLayerElem = doc.createElement( "WMSPrintLayer" );
1742 QDomText wmsPrintLayerText = doc.createTextNode( wmsPrintLayer.toString() );
1743 wmsPrintLayerElem.appendChild( wmsPrintLayerText );
1744 layerElem.appendChild( wmsPrintLayerElem );
1745 }
1746
1747 //opacity
1748 QgsRasterLayer *rl = static_cast<QgsRasterLayer *>( currentLayer );
1749 QgsRasterRenderer *rasterRenderer = rl->renderer();
1750 if ( rasterRenderer )
1751 {
1752 layerElem.setAttribute( QStringLiteral( "opacity" ), QString::number( rasterRenderer->opacity() ) );
1753 }
1754 break;
1755 }
1756
1764 break;
1765 }
1766 }
1767
1768 void addKeywordListElement( const QgsProject *project, QDomDocument &doc, QDomElement &parent )
1769 {
1770 bool sia2045 = QgsServerProjectUtils::wmsInfoFormatSia2045( *project );
1771
1772 QDomElement keywordsElem = doc.createElement( QStringLiteral( "KeywordList" ) );
1773 //add default keyword
1774 QDomElement keywordElem = doc.createElement( QStringLiteral( "Keyword" ) );
1775 keywordElem.setAttribute( QStringLiteral( "vocabulary" ), QStringLiteral( "ISO" ) );
1776 QDomText keywordText = doc.createTextNode( QStringLiteral( "infoMapAccessService" ) );
1777 keywordElem.appendChild( keywordText );
1778 keywordsElem.appendChild( keywordElem );
1779 parent.appendChild( keywordsElem );
1780 QStringList keywords = QgsServerProjectUtils::owsServiceKeywords( *project );
1781 for ( const QString &keyword : std::as_const( keywords ) )
1782 {
1783 if ( !keyword.isEmpty() )
1784 {
1785 keywordElem = doc.createElement( QStringLiteral( "Keyword" ) );
1786 keywordText = doc.createTextNode( keyword );
1787 keywordElem.appendChild( keywordText );
1788 if ( sia2045 )
1789 {
1790 keywordElem.setAttribute( QStringLiteral( "vocabulary" ), QStringLiteral( "SIA_Geo405" ) );
1791 }
1792 keywordsElem.appendChild( keywordElem );
1793 }
1794 }
1795 parent.appendChild( keywordsElem );
1796 }
1797 } // namespace
1798
1799 bool hasQueryableLayers( const QStringList &layerIds, const QMap<QString, QgsWmsLayerInfos> &wmsLayerInfos )
1800 {
1801 for ( const QString &id : std::as_const( layerIds ) )
1802 {
1803 if ( !wmsLayerInfos.contains( id ) )
1804 {
1805 continue;
1806 }
1807 if ( wmsLayerInfos[id].queryable )
1808 {
1809 return true;
1810 }
1811 }
1812 return false;
1813 }
1814
1815 QgsRectangle combineWgs84BoundingRect( const QStringList &layerIds, const QMap<QString, QgsWmsLayerInfos> &wmsLayerInfos )
1816 {
1817 QgsRectangle combined;
1818 bool empty = true;
1819
1820 for ( const QString &id : std::as_const( layerIds ) )
1821 {
1822 if ( !wmsLayerInfos.contains( id ) )
1823 {
1824 continue;
1825 }
1826
1827 QgsRectangle rect = wmsLayerInfos[id].wgs84BoundingRect;
1828 if ( rect.isNull() )
1829 {
1830 continue;
1831 }
1832
1833 if ( rect.isEmpty() )
1834 {
1835 continue;
1836 }
1837
1838 if ( empty )
1839 {
1840 combined = rect;
1841 empty = false;
1842 }
1843 else
1844 {
1845 combined.combineExtentWith( rect );
1846 }
1847 }
1848
1849 return combined;
1850 }
1851
1852 QMap<QString, QgsRectangle> combineCrsExtents( const QStringList &layerIds, const QMap<QString, QgsWmsLayerInfos> &wmsLayerInfos )
1853 {
1854 QMap<QString, QgsRectangle> combined;
1855
1856 for ( const QString &id : std::as_const( layerIds ) )
1857 {
1858 if ( !wmsLayerInfos.contains( id ) )
1859 {
1860 continue;
1861 }
1862
1863 const QgsWmsLayerInfos &layerInfos = wmsLayerInfos[id];
1864 const auto keys = layerInfos.crsExtents.keys();
1865 for ( const QString &crs : std::as_const( keys ) )
1866 {
1867 const QgsRectangle rect = layerInfos.crsExtents[crs];
1868 if ( rect.isNull() )
1869 {
1870 continue;
1871 }
1872
1873 if ( rect.isEmpty() )
1874 {
1875 continue;
1876 }
1877
1878 if ( !combined.contains( crs ) )
1879 {
1880 combined[crs] = rect;
1881 }
1882 else
1883 {
1884 combined[crs].combineExtentWith( rect );
1885 }
1886 }
1887 }
1888
1889 return combined;
1890 }
1891
1892} // namespace QgsWms
@ Millimeters
Millimeters.
@ Warning
Warning message.
Definition qgis.h:156
@ Group
Composite group layer. Added in QGIS 3.24.
@ Plugin
Plugin based layer.
@ TiledScene
Tiled scene layer. Added in QGIS 3.34.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ Vector
Vector layer.
@ VectorTile
Vector tile layer. Added in QGIS 3.14.
@ Mesh
Mesh layer. Added in QGIS 3.2.
@ Raster
Raster layer.
@ PointCloud
Point cloud layer. Added in QGIS 3.18.
@ HideFromWms
Field is not available if layer is served as WMS from QGIS server.
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 fillCacheKey(QStringList &cacheKey) const
Fill the capabilities caching key.
A cache for capabilities xml documents (by configuration file path)
const QDomDocument * searchCapabilitiesDocument(const QString &configFilePath, const QString &key)
Returns cached capabilities document (or 0 if document for configuration file not in cache)
void insertCapabilitiesDocument(const QString &configFilePath, const QString &key, const QDomDocument *doc)
Inserts new capabilities document (creates a copy of the document, does not take ownership)
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 isValid() const
Returns whether this CRS is correctly initialized and usable.
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.
Abstract base class for spatial data provider implementations.
virtual QString name() const =0
Returns a provider name.
virtual QString dataSourceUri(bool expandAuthConfig=false) const
Gets the data source specification.
QString what() const
An expression node which takes it value from a feature's field.
Class for parsing and evaluation of expressions (formerly called "search strings").
Encapsulate a field in an attribute table or data source.
Definition qgsfield.h:53
QMetaType::Type type
Definition qgsfield.h:60
QString typeName() const
Gets the field type.
Definition qgsfield.cpp:161
QString name
Definition qgsfield.h:62
int precision
Definition qgsfield.h:59
int length
Definition qgsfield.h:58
Qgis::FieldConfigurationFlags configurationFlags
Definition qgsfield.h:66
QString alias
Definition qgsfield.h:63
QString comment
Definition qgsfield.h:61
Container of fields for a vector layer.
Definition qgsfields.h:46
int count
Definition qgsfields.h:50
Q_INVOKABLE int indexOf(const QString &fieldName) const
Gets the field index from the field name.
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
Layer tree group node serves as a container for layers and further groups.
QString name() const override
Returns the group's name.
QStringList findLayerIds() const
Find layer IDs used in all layer nodes.
bool isMutuallyExclusive() const
Returns whether the group is mutually exclusive (only one child can be checked at a time)
Layer tree node points to a map layer.
QString layerId() const
Returns the ID for the map layer associated with this node.
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.
bool isVisible() const
Returns whether a node is really visible (ie checked and all its ancestors checked as well)
QList< QgsLayerTreeNode * > children()
Gets list of children of the node. Children are owned by the parent.
QVariant customProperty(const QString &key, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer. Properties are stored in a map and saved in project file.
NodeType nodeType() const
Find out about type of the node. It is usually shorter to use convenience functions from QgsLayerTree...
bool isExpanded() const
Returns whether the node should be shown as expanded or collapsed in GUI.
bool itemVisibilityChecked() const
Returns whether a node is checked (independently of its ancestors or children)
Namespace with helper functions for layer tree operations.
QList< QgsMapLayer * > layerOrder() const
The order in which layers will be rendered on the canvas.
Class used to render QgsLayout as an atlas, by iterating over the features from an associated vector ...
bool enabled() const
Returns whether the atlas generation is enabled.
QgsVectorLayer * coverageLayer() const
Returns the coverage layer used for the atlas features.
A layout multiframe subclass for HTML content.
A layout item subclass for text labels.
Layout graphical items for displaying a map.
QString displayName() const override
Gets item display name.
QgsLayoutSize sizeWithUnits() const
Returns the item's current size, including units.
QString id() const
Returns the item's ID name.
QList< QgsPrintLayout * > printLayouts() const
Returns a list of all print layouts contained in the manager.
This class provides a method of storing measurements for use in QGIS layouts using a variety of diffe...
double length() const
Returns the length of the measurement.
int frameCount() const
Returns the number of frames associated with this multiframe.
QgsLayoutFrame * frame(int index) const
Returns the child frame at a specified index from the multiframe.
int pageCount() const
Returns the number of pages in the collection.
QgsLayoutItemPage * page(int pageNumber)
Returns a specific page (by pageNumber) from the collection.
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layo...
double height() const
Returns the height of the size.
double width() const
Returns the width of the size.
QgsLayoutPageCollection * pageCollection()
Returns a pointer to the layout's page collection, which stores and manages page items in the layout.
void layoutItems(QList< T * > &itemList) const
Returns a list of layout items of a specific type.
Definition qgslayout.h:120
void layoutObjects(QList< T * > &objectList) const
Returns a list of layout objects (items and multiframes) of a specific type.
Definition qgslayout.h:139
QgsLayoutMeasurement convertFromLayoutUnits(double length, Qgis::LayoutUnit unit) const
Converts a length measurement from the layout's native units to a specified target unit.
Manages QGIS Server properties for a map layer.
QString dataUrlFormat() const
Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
QString shortName() const
Returns the short name of the layer used by QGIS Server to identify the layer.
virtual QgsDateTimeRange calculateTemporalExtent(QgsMapLayer *layer) const
Attempts to calculate the overall temporal extent for the specified layer, using the settings defined...
virtual QList< QgsDateTimeRange > allTemporalRanges(QgsMapLayer *layer) const
Attempts to calculate the overall list of all temporal extents which are contained in the specified l...
Base class for all map layer types.
Definition qgsmaplayer.h:76
QString name
Definition qgsmaplayer.h:80
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
QgsMapLayerServerProperties * serverProperties()
Returns QGIS Server Properties for the map layer.
QString id
Definition qgsmaplayer.h:79
Qgis::LayerType type
Definition qgsmaplayer.h:86
virtual QgsMapLayerTemporalProperties * temporalProperties()
Returns the layer's temporal properties.
double opacity
Definition qgsmaplayer.h:88
virtual Q_INVOKABLE QgsDataProvider * dataProvider()
Returns the layer's data provider, it may be nullptr.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
Print layout, a QgsLayout subclass for static or atlas-based layouts.
QgsLayoutAtlas * atlas()
Returns the print layout's atlas.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:107
QString title() const
Returns the project's title.
Q_INVOKABLE QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
QgsCoordinateTransformContext transformContext
Definition qgsproject.h:113
QgsLayerTree * layerTreeRoot() const
Returns pointer to the root (invisible) node of the project's layer tree.
const QgsLayoutManager * layoutManager() const
Returns the project's layout manager, which manages print layouts, atlases and reports within the pro...
QgsCoordinateReferenceSystem crs
Definition qgsproject.h:112
Represents a raster layer.
QgsRasterRenderer * renderer() const
Returns the raster's renderer.
Raster renderer pipe that applies colors to a raster.
double opacity() const
Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1....
A rectangle specified with double values.
double xMinimum
double yMinimum
double xMaximum
double yMaximum
void combineExtentWith(const QgsRectangle &rect)
Expands the rectangle so that it covers both the original rectangle and the given 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 QString configFilePath()=0
Returns the configuration file path.
virtual QgsAccessControl * accessControls() const =0
Gets the registered access control filters.
virtual QgsServerSettings * serverSettings()=0
Returns the server settings.
virtual QgsCapabilitiesCache * capabilitiesCache()=0
Gets pointer to the capabiblities cache.
QString service() const
Returns SERVICE parameter as a string or an empty string if not defined.
QgsServerParameters serverParameters() const
Returns parameters.
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...
Provides a way to retrieve settings by prioritizing according to environment variables,...
bool getPrintDisabled() const
Returns true if WMS GetPrint request is disabled and the project's reading flag QgsProject::ReadFlag:...
const QList< QgsServerWmsDimensionProperties::WmsDimensionInfo > wmsDimensions() const
Returns the QGIS Server WMS Dimension list.
bool isActive() const
Returns true if the temporal property is active.
Represents a vector layer which manages a vector based data sets.
QString attributeDisplayName(int index) const
Convenience function that returns the attribute alias if defined or the field name else.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
QString displayExpression
QgsEditorWidgetSetup editorWidgetSetup(int index) const
Returns the editor widget setup for the field at the specified index.
QgsAttributeList primaryKeyAttributes() const
Returns the list of attributes which make up the layer's primary keys.
QSet< QVariant > uniqueValues(int fieldIndex, int limit=-1) const FINAL
Calculates a list of unique values contained within an attribute in the layer.
static QString displayString(Qgis::WkbType type)
Returns a non-translated display string type for a WKB type, e.g., the geometry name used in WKT geom...
WMS Layer infos.
QString legendUrlFormat
WMS layer legend URL format.
QString title
WMS layer title.
QStringList keywords
WMS layer keywords.
QString legendUrl
WMS layer legend URL.
QString abstract
WMS layer abstract.
static QgsRectangle transformExtent(const QgsRectangle &extent, const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination, const QgsCoordinateTransformContext &context, const bool &ballparkTransformsAreAppropriate=false)
Returns a transformed extent.
QString attribution
WMS layer attribution.
QString dataUrl
WMS layer dataUrl.
double maxScale
WMS layer maximum scale (if negative, no maximum scale is defined)
QMap< QString, QgsRectangle > crsExtents
WMS layer CRS extents (can be empty)
QString attributionUrl
WMS layer attribution URL.
static QMap< QString, QgsRectangle > transformExtentToCrsList(const QgsRectangle &extent, const QgsCoordinateReferenceSystem &source, const QList< QgsCoordinateReferenceSystem > &destinations, const QgsCoordinateTransformContext &context)
Returns a map with CRS authid as key and the transformed extent as value.
QString name
WMS layer name.
static QMap< QString, QgsWmsLayerInfos > buildWmsLayerInfos(QgsServerInterface *serverIface, const QgsProject *project, const QList< QgsCoordinateReferenceSystem > &outputCrsList)
Returns the WMS layers definition to build WMS capabilities.
bool hasScaleBasedVisibility
WMS layer has scale based visibility.
double minScale
WMS layer minimum scale (if negative, no maximum scale is defined)
bool queryable
WMS layer is queryable.
QgsRectangle wgs84BoundingRect
WMS layer WGS84 bounding rectangle (can be empty)
QString version() const override
Returns VERSION parameter as a string or an empty string if not defined.
Class defining request interface passed to WMS service.
const QgsWmsParameters & wmsParameters() const
Returns the parameters interpreted for the WMS service.
SERVER_EXPORT QString wmsRootName(const QgsProject &project)
Returns the WMS root layer name defined in a QGIS project.
SERVER_EXPORT bool wmsInfoFormatSia2045(const QgsProject &project)
Returns if the info format is SIA20145.
SERVER_EXPORT bool wmsSkipNameForGroup(const QgsProject &project)
Returns if name attribute should be skipped for groups in WMS capabilities document.
SERVER_EXPORT QString wmsInspireMetadataUrl(const QgsProject &project)
Returns the Inspire metadata URL.
SERVER_EXPORT double ceilWithPrecision(double number, int places)
Returns a double greater than number to the specified number of places.
SERVER_EXPORT QStringList wmsRestrictedComposers(const QgsProject &project)
Returns the restricted composer list.
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 QString owsServiceAccessConstraints(const QgsProject &project)
Returns the owsService access constraints defined in project.
SERVER_EXPORT QStringList wfsLayerIds(const QgsProject &project)
Returns the Layer ids list defined in a QGIS project as published in WFS.
SERVER_EXPORT QString owsServiceOnlineResource(const QgsProject &project)
Returns the owsService online resource defined in project.
SERVER_EXPORT QString owsServiceFees(const QgsProject &project)
Returns the owsService fees defined in project.
SERVER_EXPORT QStringList owsServiceKeywords(const QgsProject &project)
Returns the owsService keywords defined in project.
SERVER_EXPORT QString owsServiceContactPosition(const QgsProject &project)
Returns the owsService contact position defined in project.
SERVER_EXPORT QString serviceUrl(const QString &service, const QgsServerRequest &request, const QgsServerSettings &settings)
Returns the service url defined in the environment variable or with HTTP header.
SERVER_EXPORT QString wmsInspireTemporalReference(const QgsProject &project)
Returns the Inspire temporal reference.
SERVER_EXPORT QStringList wmsOutputCrsList(const QgsProject &project)
Returns the WMS output CRS list.
SERVER_EXPORT QString wmsInspireMetadataDate(const QgsProject &project)
Returns the Inspire metadata date.
SERVER_EXPORT QString owsServiceContactOrganization(const QgsProject &project)
Returns the owsService contact organization defined in project.
SERVER_EXPORT QStringList wmsRestrictedLayers(const QgsProject &project)
Returns the restricted layer name list.
SERVER_EXPORT QString wmsInspireLanguage(const QgsProject &project)
Returns the Inspire language.
SERVER_EXPORT QString wmsInspireMetadataUrlType(const QgsProject &project)
Returns the Inspire metadata URL type.
SERVER_EXPORT bool wmsInspireActivate(const QgsProject &project)
Returns if Inspire is activated.
SERVER_EXPORT int wmsMaxWidth(const QgsProject &project)
Returns the maximum width for WMS images defined in a QGIS project.
SERVER_EXPORT QString owsServiceTitle(const QgsProject &project)
Returns the owsService title defined in project.
SERVER_EXPORT QString owsServiceContactMail(const QgsProject &project)
Returns the owsService contact mail defined in project.
SERVER_EXPORT QString owsServiceAbstract(const QgsProject &project)
Returns the owsService abstract defined in project.
SERVER_EXPORT double floorWithPrecision(double number, int places)
Returns a double less than number to the specified number of places.
SERVER_EXPORT int wmsMaxHeight(const QgsProject &project)
Returns the maximum height for WMS images defined in a QGIS project.
SERVER_EXPORT QString owsServiceContactPhone(const QgsProject &project)
Returns the owsService contact phone defined in project.
SERVER_EXPORT QString owsServiceContactPerson(const QgsProject &project)
Returns the owsService contact person defined in project.
Median cut implementation.
QDomElement getWFSLayersElement(QDomDocument &doc, const QgsProject *project)
Create WFSLayers element for get capabilities document.
void writeGetCapabilities(QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, QgsServerResponse &response, bool projectSettings)
Output GetCapabilities response.
QDomElement getLayersAndStylesCapabilitiesElement(QDomDocument &doc, QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, bool projectSettings)
Create element for get capabilities document.
QDomElement getInspireCapabilitiesElement(QDomDocument &doc, const QgsProject *project)
Create InspireCapabilities element for get capabilities document.
void handleLayersFromTreeGroup(QDomDocument &doc, QDomElement &parentLayer, QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, const QgsLayerTreeGroup *layerTreeGroup, const QMap< QString, QgsWmsLayerInfos > &wmsLayerInfos, bool projectSettings)
QDomElement getComposerTemplatesElement(QDomDocument &doc, const QgsProject *project)
Create ComposerTemplates element for get capabilities document.
QDomElement getServiceElement(QDomDocument &doc, const QgsProject *project, const QgsWmsRequest &request, const QgsServerSettings *serverSettings)
Create Service element for get capabilities document.
QDomElement getCapabilityElement(QDomDocument &doc, const QgsProject *project, const QgsWmsRequest &request, bool projectSettings, QgsServerInterface *serverIface)
Create Capability element for get capabilities document.
QDomDocument getCapabilities(QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, bool projectSettings)
Creates the WMS GetCapabilities XML document.
bool hasQueryableLayers(const QStringList &layerIds, const QMap< QString, QgsWmsLayerInfos > &wmsLayerInfos)
Returns true if at least one layer from the layers ids is queryable.
QgsRectangle combineWgs84BoundingRect(const QStringList &layerIds, const QMap< QString, QgsWmsLayerInfos > &wmsLayerInfos)
Returns the combination of the WGS84 bounding rectangle of the layers from the list of layers ids.
QMap< QString, QgsRectangle > combineCrsExtents(const QStringList &layerIds, const QMap< QString, QgsWmsLayerInfos > &wmsLayerInfos)
Returns the combinations of the extent CRSes of the layers from the list of layers ids.
QUrl serviceUrl(const QgsServerRequest &request, const QgsProject *project, const QgsServerSettings &settings)
Returns WMS service URL.
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
Definition qgis.h:6008
CONSTLATIN1STRING geoEpsgCrsAuthId()
Geographic coord sys from EPSG authority.
Definition qgis.h:6580
QList< int > QgsAttributeList
Definition qgsfield.h:27
const QgsCoordinateReferenceSystem & crs
int precision
const double OGC_PX_M
Setting to define QGIS Server WMS Dimension.