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