QGIS API Documentation 3.43.0-Master (c67cf405802)
qgswmsrenderer.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgswmsrenderer.cpp
3 -------------------
4 begin : May 14, 2006
5 copyright : (C) 2006 by Marco Hugentobler
6 (C) 2017 by David Marteau
7 email : marco dot hugentobler at karto dot baug dot ethz dot ch
8 david dot marteau at 3liz dot com
9 ***************************************************************************/
10
11/***************************************************************************
12 * *
13 * This program is free software; you can redistribute it and/or modify *
14 * it under the terms of the GNU General Public License as published by *
15 * the Free Software Foundation; either version 2 of the License, or *
16 * (at your option) any later version. *
17 * *
18 ***************************************************************************/
19
20#include "qgsjsonutils.h"
21#include "qgswmsrenderer.h"
22#include "qgsfilterrestorer.h"
23#include "qgsexception.h"
24#include "qgsfields.h"
25#include "qgsfieldformatter.h"
27#include "qgsfeatureiterator.h"
28#include "qgsgeometry.h"
29#include "qgslayertree.h"
30#include "qgslayoututils.h"
31#include "qgslayertreemodel.h"
32#include "qgslegendrenderer.h"
33#include "qgsmaplayer.h"
34#include "qgsmaprenderertask.h"
36#include "qgsmaptopixel.h"
37#include "qgsproject.h"
39#include "qgsrasterlayer.h"
40#include "qgsrasterrenderer.h"
41#include "qgsscalecalculator.h"
45#include "qgsvectorlayer.h"
46#include "qgsvectortilelayer.h"
47#include "qgsmessagelog.h"
48#include "qgsrenderer.h"
49#include "qgsfeature.h"
50#include "qgsaccesscontrol.h"
51#include "qgsfeaturerequest.h"
55#include "qgsserverfeatureid.h"
57#include "qgswkbtypes.h"
59#include "qgsannotation.h"
61#include "qgspallabeling.h"
62#include "qgswmsrestorer.h"
63#include "qgsdxfexport.h"
64#include "qgssymbollayerutils.h"
65#include "qgsserverexception.h"
66#include "qgsserverapiutils.h"
68#include "qgsfeaturestore.h"
73#include "qgsdimensionfilter.h"
74
75#include <QImage>
76#include <QPainter>
77#include <QStringList>
78#include <QTemporaryFile>
79#include <QDir>
80#include <QUrl>
81#include <nlohmann/json.hpp>
82
83//for printing
84#include "qgslayoutatlas.h"
85#include "qgslayoutmanager.h"
86#include "qgslayoutexporter.h"
87#include "qgslayoutsize.h"
90#include "qgsprintlayout.h"
92#include "qgslayoutitempage.h"
93#include "qgslayoutitemlabel.h"
94#include "qgslayoutitemlegend.h"
95#include "qgslayoutitemmap.h"
97#include "qgslayoutframe.h"
98#include "qgslayoutitemhtml.h"
100#include "qgsogcutils.h"
101
102namespace QgsWms
103{
105 : mContext( context )
106 {
107 mProject = mContext.project();
108
109 mWmsParameters = mContext.parameters();
110 mWmsParameters.dump();
111 }
112
114 {
115 removeTemporaryLayers();
116 }
117
119 {
120 // get layers
121 std::unique_ptr<QgsWmsRestorer> restorer;
122 restorer.reset( new QgsWmsRestorer( mContext ) );
123
124 // configure layers
125 QList<QgsMapLayer *> layers = mContext.layersToRender();
126 configureLayers( layers );
127
128 const qreal dpmm = mContext.dotsPerMm();
129
130 QgsLegendSettings settings = legendSettings();
131
132 // adjust the size settings if there any WMS cascading layers to renderer
133 const auto layersToRender = mContext.layersToRender();
134 for ( const auto &layer : std::as_const( layersToRender ) )
135 {
136 // If it is a cascading WMS layer, get legend node image size
137 if ( layer->dataProvider()->name() == QLatin1String( "wms" ) )
138 {
139 if ( QgsWmsLegendNode *layerNode = qobject_cast<QgsWmsLegendNode *>( model.findLegendNode( layer->id(), QString() ) ) )
140 {
141 const auto image { layerNode->getLegendGraphicBlocking() };
142 if ( !image.isNull() )
143 {
144 // Check that we are not exceeding the maximum size
145 if ( mContext.isValidWidthHeight( image.width(), image.height() ) )
146 {
147 const double w = image.width() / dpmm;
148 const double h = image.height() / dpmm;
149 const QSizeF newWmsSize { w, h };
150 settings.setWmsLegendSize( newWmsSize );
151 }
152 }
153 }
154 }
155 }
156
157 // init renderer
158 QgsLegendRenderer renderer( &model, settings );
159
160 // create context
161 QgsRenderContext context;
162 if ( !mWmsParameters.bbox().isEmpty() )
163 {
164 QgsMapSettings mapSettings;
166 std::unique_ptr<QImage> tmp( createImage( mContext.mapSize( false ) ) );
167 configureMapSettings( tmp.get(), mapSettings );
168 context = QgsRenderContext::fromMapSettings( mapSettings );
169 }
170 else
171 {
172 //use default scale settings
173 context = configureDefaultRenderContext();
174 }
175
176 // create image according to context
177 std::unique_ptr<QImage> image;
178 const QSizeF minSize = renderer.minimumSize( &context );
179 const QSize size( static_cast<int>( minSize.width() * dpmm ), static_cast<int>( minSize.height() * dpmm ) );
180 if ( !mContext.isValidWidthHeight( size.width(), size.height() ) )
181 {
182 throw QgsServerException( QStringLiteral( "Legend image is too large" ) );
183 }
184 image.reset( createImage( size ) );
185
186 // configure painter and adapt to the context
187 QPainter painter( image.get() );
188
189 context.setPainter( &painter );
190 if ( painter.renderHints() & QPainter::SmoothPixmapTransform )
192 if ( painter.renderHints() & QPainter::LosslessImageRendering )
194
196 QgsScopedRenderContextScaleToMm scaleContext( context );
197
198 // rendering
199 renderer.drawLegend( context );
200 painter.end();
201
202 return image.release();
203 }
204
206 {
207 // get layers
208 std::unique_ptr<QgsWmsRestorer> restorer;
209 restorer.reset( new QgsWmsRestorer( mContext ) );
210
211 // configure layers
212 QList<QgsMapLayer *> layers = mContext.layersToRender();
213 configureLayers( layers );
214
215 // create image
216 const QSize size( mWmsParameters.widthAsInt(), mWmsParameters.heightAsInt() );
217 //test if legend image is larger than max width/height
218 if ( !mContext.isValidWidthHeight( size.width(), size.height() ) )
219 {
220 throw QgsServerException( QStringLiteral( "Legend image is too large" ) );
221 }
222 std::unique_ptr<QImage> image( createImage( size ) );
223
224 // configure painter
225 const qreal dpmm = mContext.dotsPerMm();
226 std::unique_ptr<QPainter> painter;
227 painter.reset( new QPainter( image.get() ) );
228 painter->setRenderHint( QPainter::Antialiasing, true );
229 painter->scale( dpmm, dpmm );
230
231 // rendering
232 QgsLegendSettings settings = legendSettings();
234 ctx.painter = painter.get();
235
236 // create context
237 QgsRenderContext context = configureDefaultRenderContext( painter.get() );
238 ctx.context = &context;
239
240 nodeModel.drawSymbol( settings, &ctx, size.height() / dpmm );
241 painter->end();
242
243 return image.release();
244 }
245
247 {
248 // get layers
249 std::unique_ptr<QgsWmsRestorer> restorer;
250 restorer.reset( new QgsWmsRestorer( mContext ) );
251
252 // configure layers
253 QList<QgsMapLayer *> layers = mContext.layersToRender();
254 configureLayers( layers );
255
256 // init renderer
257 QgsLegendSettings settings = legendSettings();
258 settings.setJsonRenderFlags( jsonRenderFlags );
259 QgsLegendRenderer renderer( &model, settings );
260
261 // rendering
262 QgsRenderContext renderContext;
263 return renderer.exportLegendToJson( renderContext );
264 }
265
267 {
268 // get layers
269 std::unique_ptr<QgsWmsRestorer> restorer;
270 restorer.reset( new QgsWmsRestorer( mContext ) );
271
272 // configure layers
273 QList<QgsMapLayer *> layers = mContext.layersToRender();
274 configureLayers( layers );
275
276 // init renderer
277 QgsLegendSettings settings = legendSettings();
278 settings.setJsonRenderFlags( jsonRenderFlags );
279
280 // rendering
281 QgsRenderContext renderContext;
282 QJsonObject jsonSymbol { legendNode.exportSymbolToJson( settings, renderContext ) };
283
284 if ( jsonRenderFlags.testFlag( Qgis::LegendJsonRenderFlag::ShowRuleDetails ) )
285 {
287 if ( QgsVectorLayer *vLayer = qobject_cast<QgsVectorLayer *>( nodeLayer->layer() ) )
288 {
289 if ( vLayer->renderer() )
290 {
291 const QString ruleKey { legendNode.data( static_cast<int>( QgsLayerTreeModelLegendNode::CustomRole::RuleKey ) ).toString() };
292 bool ok = false;
293 const QString ruleExp { vLayer->renderer()->legendKeyToExpression( ruleKey, vLayer, ok ) };
294 if ( ok )
295 {
296 jsonSymbol[QStringLiteral( "rule" )] = ruleExp;
297 }
298 }
299 }
300 }
301
302 return jsonSymbol;
303 }
304
305 void QgsRenderer::runHitTest( const QgsMapSettings &mapSettings, HitTest &hitTest ) const
306 {
308
309 for ( const QString &id : mapSettings.layerIds() )
310 {
311 QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( mProject->mapLayer( id ) );
312 if ( !vl || !vl->renderer() )
313 continue;
314
315 if ( vl->hasScaleBasedVisibility() && vl->isInScaleRange( mapSettings.scale() ) )
316 {
317 hitTest[vl] = SymbolSet(); // no symbols -> will not be shown
318 continue;
319 }
320
321 QgsCoordinateTransform tr = mapSettings.layerTransform( vl );
322 context.setCoordinateTransform( tr );
324
325 SymbolSet &usedSymbols = hitTest[vl];
326 runHitTestLayer( vl, usedSymbols, context );
327 }
328 }
329
330 void QgsRenderer::runHitTestLayer( QgsVectorLayer *vl, SymbolSet &usedSymbols, QgsRenderContext &context ) const
331 {
332 std::unique_ptr<QgsFeatureRenderer> r( vl->renderer()->clone() );
333 bool moreSymbolsPerFeature = r->capabilities() & QgsFeatureRenderer::MoreSymbolsPerFeature;
334 r->startRender( context, vl->fields() );
335 QgsFeature f;
336 QgsFeatureRequest request( context.extent() );
338 QgsFeatureIterator fi = vl->getFeatures( request );
339 while ( fi.nextFeature( f ) )
340 {
341 context.expressionContext().setFeature( f );
342 if ( moreSymbolsPerFeature )
343 {
344 for ( QgsSymbol *s : r->originalSymbolsForFeature( f, context ) )
345 usedSymbols.insert( QgsSymbolLayerUtils::symbolProperties( s ) );
346 }
347 else
348 usedSymbols.insert( QgsSymbolLayerUtils::symbolProperties( r->originalSymbolForFeature( f, context ) ) );
349 }
350 r->stopRender( context );
351 }
352
354 {
355 // check size
356 if ( !mContext.isValidWidthHeight() )
357 {
358 throw QgsBadRequestException( QgsServiceException::QGIS_InvalidParameterValue, QStringLiteral( "The requested map size is too large" ) );
359 }
360
361 // init layer restorer before doing anything
362 std::unique_ptr<QgsWmsRestorer> restorer;
363 restorer.reset( new QgsWmsRestorer( mContext ) );
364
365 // configure layers
366 QgsMapSettings mapSettings;
368 QList<QgsMapLayer *> layers = mContext.layersToRender();
369 configureLayers( layers, &mapSettings );
370
371 // create the output image and the painter
372 std::unique_ptr<QPainter> painter;
373 std::unique_ptr<QImage> image( createImage( mContext.mapSize() ) );
374
375 // configure map settings (background, DPI, ...)
376 configureMapSettings( image.get(), mapSettings );
377
378 // add layers to map settings
379 mapSettings.setLayers( layers );
380
381 // run hit tests
383 runHitTest( mapSettings, symbols );
384
385 return symbols;
386 }
387
389 {
390 // init layer restorer before doing anything
391 std::unique_ptr<QgsWmsRestorer> restorer;
392 restorer.reset( new QgsWmsRestorer( mContext ) );
393
394 // GetPrint request needs a template parameter
395 const QString templateName = mWmsParameters.composerTemplate();
396 if ( templateName.isEmpty() )
397 {
399 }
400 else if ( QgsServerProjectUtils::wmsRestrictedComposers( *mProject ).contains( templateName ) )
401 {
403 }
404
405 // check template
406 const QgsLayoutManager *lManager = mProject->layoutManager();
407 QgsPrintLayout *sourceLayout( dynamic_cast<QgsPrintLayout *>( lManager->layoutByName( templateName ) ) );
408 if ( !sourceLayout )
409 {
411 }
412
413 // Check that layout has at least one page
414 if ( sourceLayout->pageCollection()->pageCount() < 1 )
415 {
416 throw QgsBadRequestException( QgsServiceException::QGIS_InvalidParameterValue, QStringLiteral( "The template has no pages" ) );
417 }
418
419 std::unique_ptr<QgsPrintLayout> layout( sourceLayout->clone() );
420
421 //atlas print?
422 QgsLayoutAtlas *atlas = nullptr;
423 QStringList atlasPk = mWmsParameters.atlasPk();
424 if ( !atlasPk.isEmpty() ) //atlas print requested?
425 {
426 atlas = layout->atlas();
427 if ( !atlas || !atlas->enabled() )
428 {
429 //error
430 throw QgsBadRequestException( QgsServiceException::QGIS_InvalidParameterValue, QStringLiteral( "The template has no atlas enabled" ) );
431 }
432
433 QgsVectorLayer *cLayer = atlas->coverageLayer();
434 if ( !cLayer )
435 {
436 throw QgsBadRequestException( QgsServiceException::QGIS_InvalidParameterValue, QStringLiteral( "The atlas has no coverage layer" ) );
437 }
438
439 int maxAtlasFeatures = QgsServerProjectUtils::wmsMaxAtlasFeatures( *mProject );
440 if ( atlasPk.size() == 1 && atlasPk.at( 0 ) == QLatin1String( "*" ) )
441 {
442 atlas->setFilterFeatures( false );
443 atlas->updateFeatures();
444 if ( atlas->count() > maxAtlasFeatures )
445 {
446 throw QgsBadRequestException( QgsServiceException::QGIS_InvalidParameterValue, QString( "The project configuration allows printing maximum %1 atlas features at a time" ).arg( maxAtlasFeatures ) );
447 }
448 }
449 else
450 {
451 const QgsAttributeList pkIndexes = cLayer->primaryKeyAttributes();
452 if ( pkIndexes.size() == 0 )
453 {
454 QgsDebugMsgLevel( QStringLiteral( "Atlas print: layer %1 has no primary key attributes" ).arg( cLayer->name() ), 2 );
455 }
456
457 // Handles the pk-less case
458 const int pkIndexesSize { std::max<int>( pkIndexes.size(), 1 ) };
459
460 QStringList pkAttributeNames;
461 for ( int pkIndex : std::as_const( pkIndexes ) )
462 {
463 pkAttributeNames.append( cLayer->fields().at( pkIndex ).name() );
464 }
465
466 const int nAtlasFeatures = atlasPk.size() / pkIndexesSize;
467 if ( nAtlasFeatures * pkIndexesSize != atlasPk.size() ) //Test if atlasPk.size() is a multiple of pkIndexesSize. Bail out if not
468 {
469 throw QgsBadRequestException( QgsServiceException::QGIS_InvalidParameterValue, QStringLiteral( "Wrong number of ATLAS_PK parameters" ) );
470 }
471
472 //number of atlas features might be restricted
473 if ( nAtlasFeatures > maxAtlasFeatures )
474 {
475 throw QgsBadRequestException( QgsServiceException::QGIS_InvalidParameterValue, QString( "%1 atlas features have been requested, but the project configuration only allows printing %2 atlas features at a time" ).arg( nAtlasFeatures ).arg( maxAtlasFeatures ) );
476 }
477
478 QString filterString;
479 int currentAtlasPk = 0;
480
481 for ( int i = 0; i < nAtlasFeatures; ++i )
482 {
483 if ( i > 0 )
484 {
485 filterString.append( " OR " );
486 }
487
488 filterString.append( "( " );
489
490 // If the layer has no PK attributes, assume FID
491 if ( pkAttributeNames.isEmpty() )
492 {
493 filterString.append( QStringLiteral( "$id = %1" ).arg( atlasPk.at( currentAtlasPk ) ) );
494 ++currentAtlasPk;
495 }
496 else
497 {
498 for ( int j = 0; j < pkIndexes.size(); ++j )
499 {
500 if ( j > 0 )
501 {
502 filterString.append( " AND " );
503 }
504 filterString.append( QgsExpression::createFieldEqualityExpression( pkAttributeNames.at( j ), atlasPk.at( currentAtlasPk ) ) );
505 ++currentAtlasPk;
506 }
507 }
508
509 filterString.append( " )" );
510 }
511
512 atlas->setFilterFeatures( true );
513
514 QString errorString;
515 atlas->setFilterExpression( filterString, errorString );
516
517 if ( !errorString.isEmpty() )
518 {
519 throw QgsException( QStringLiteral( "An error occurred during the Atlas print: %1" ).arg( errorString ) );
520 }
521 }
522 }
523
524 // configure layers
525 QgsMapSettings mapSettings;
527 QList<QgsMapLayer *> layers = mContext.layersToRender();
528 configureLayers( layers, &mapSettings );
529
530 // configure map settings (background, DPI, ...)
531 auto image = std::make_unique<QImage>();
532 configureMapSettings( image.get(), mapSettings );
533
534 // add layers to map settings
535 mapSettings.setLayers( layers );
536
537 // configure layout
538 configurePrintLayout( layout.get(), mapSettings, atlas );
539
540 QgsLayoutRenderContext &layoutRendererContext = layout->renderContext();
542 const QList<QgsMapLayer *> lyrs = mapSettings.layers();
543
544#ifdef HAVE_SERVER_PYTHON_PLUGINS
545 mContext.accessControl()->resolveFilterFeatures( lyrs );
546 filters.addProvider( mContext.accessControl() );
547#endif
548
549 QHash<const QgsVectorLayer *, QStringList> fltrs;
550 for ( QgsMapLayer *l : lyrs )
551 {
552 if ( QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( l ) )
553 {
554 fltrs.insert( vl, dimensionFilter( vl ) );
555 }
556 }
557
558 QgsDimensionFilter dimFilter( fltrs );
559 filters.addProvider( &dimFilter );
560 layoutRendererContext.setFeatureFilterProvider( &filters );
561
562 // Get the temporary output file
563 const QgsWmsParameters::Format format = mWmsParameters.format();
564 const QString extension = QgsWmsParameters::formatAsString( format ).toLower();
565
566 QTemporaryFile tempOutputFile( QDir::tempPath() + '/' + QStringLiteral( "XXXXXX.%1" ).arg( extension ) );
567 if ( !tempOutputFile.open() )
568 {
569 throw QgsException( QStringLiteral( "Could not open temporary file for the GetPrint request." ) );
570 }
571
572 QString exportError;
573 if ( format == QgsWmsParameters::SVG )
574 {
575 // Settings for the layout exporter
577 if ( !mWmsParameters.dpi().isEmpty() )
578 {
579 bool ok;
580 double dpi( mWmsParameters.dpi().toDouble( &ok ) );
581 if ( ok )
582 exportSettings.dpi = dpi;
583 }
584 // Set scales
585 exportSettings.predefinedMapScales = QgsLayoutUtils::predefinedScales( layout.get() );
586 // Draw selections
588 if ( atlas )
589 {
590 //export first page of atlas
591 atlas->beginRender();
592 if ( atlas->next() )
593 {
594 QgsLayoutExporter atlasSvgExport( atlas->layout() );
595 atlasSvgExport.exportToSvg( tempOutputFile.fileName(), exportSettings );
596 }
597 }
598 else
599 {
600 QgsLayoutExporter exporter( layout.get() );
601 exporter.exportToSvg( tempOutputFile.fileName(), exportSettings );
602 }
603 }
604 else if ( format == QgsWmsParameters::PNG || format == QgsWmsParameters::JPG )
605 {
606 // Settings for the layout exporter
608
609 // Get the dpi from input or use the default
610 double dpi( layout->renderContext().dpi() );
611 if ( !mWmsParameters.dpi().isEmpty() )
612 {
613 bool ok;
614 double _dpi = mWmsParameters.dpi().toDouble( &ok );
615 if ( ok )
616 dpi = _dpi;
617 }
618 exportSettings.dpi = dpi;
619 // Set scales
620 exportSettings.predefinedMapScales = QgsLayoutUtils::predefinedScales( layout.get() );
621 // Draw selections
623 // Destination image size in px
624 QgsLayoutSize layoutSize( layout->pageCollection()->page( 0 )->sizeWithUnits() );
625
626 QgsLayoutMeasurement width( layout->convertFromLayoutUnits( layoutSize.width(), Qgis::LayoutUnit::Millimeters ) );
627 QgsLayoutMeasurement height( layout->convertFromLayoutUnits( layoutSize.height(), Qgis::LayoutUnit::Millimeters ) );
628
629 const QSize imageSize = QSize( static_cast<int>( width.length() * dpi / 25.4 ), static_cast<int>( height.length() * dpi / 25.4 ) );
630
631 const QString paramWidth = mWmsParameters.width();
632 const QString paramHeight = mWmsParameters.height();
633
634 // Prefer width and height from the http request
635 // Fallback to predefined values from layout
636 // Preserve aspect ratio if only one value is specified
637 if ( !paramWidth.isEmpty() && !paramHeight.isEmpty() )
638 {
639 exportSettings.imageSize = QSize( paramWidth.toInt(), paramHeight.toInt() );
640 }
641 else if ( !paramWidth.isEmpty() && paramHeight.isEmpty() )
642 {
643 exportSettings.imageSize = QSize( paramWidth.toInt(), static_cast<double>( paramWidth.toInt() ) / imageSize.width() * imageSize.height() );
644 }
645 else if ( paramWidth.isEmpty() && !paramHeight.isEmpty() )
646 {
647 exportSettings.imageSize = QSize( static_cast<double>( paramHeight.toInt() ) / imageSize.height() * imageSize.width(), paramHeight.toInt() );
648 }
649 else
650 {
651 exportSettings.imageSize = imageSize;
652 }
653
654 // Export first page only (unless it's a pdf, see below)
655 exportSettings.pages.append( 0 );
656 if ( atlas )
657 {
658 //only can give back one page in server rendering
659 atlas->beginRender();
660 if ( atlas->next() )
661 {
662 QgsLayoutExporter atlasPngExport( atlas->layout() );
663 atlasPngExport.exportToImage( tempOutputFile.fileName(), exportSettings );
664 }
665 else
666 {
667 throw QgsServiceException( QStringLiteral( "Bad request" ), QStringLiteral( "Atlas error: empty atlas." ), QString(), 400 );
668 }
669 }
670 else
671 {
672 QgsLayoutExporter exporter( layout.get() );
673 exporter.exportToImage( tempOutputFile.fileName(), exportSettings );
674 }
675 }
676 else if ( format == QgsWmsParameters::PDF )
677 {
678 // Settings for the layout exporter
680 // TODO: handle size from input ?
681 if ( !mWmsParameters.dpi().isEmpty() )
682 {
683 bool ok;
684 double dpi( mWmsParameters.dpi().toDouble( &ok ) );
685 if ( ok )
686 exportSettings.dpi = dpi;
687 }
688 // Draw selections
690 // Print as raster
691 exportSettings.rasterizeWholeImage = layout->customProperty( QStringLiteral( "rasterize" ), false ).toBool();
692 // Set scales. 1. Prio: request, 2. Prio: predefined mapscales in layout
693 QVector<qreal> requestMapScales = mWmsParameters.pdfPredefinedMapScales();
694 if ( requestMapScales.size() > 0 )
695 {
696 exportSettings.predefinedMapScales = requestMapScales;
697 }
698 else
699 {
700 exportSettings.predefinedMapScales = QgsLayoutUtils::predefinedScales( layout.get() );
701 }
702 // Export themes
703 QStringList exportThemes = mWmsParameters.pdfExportMapThemes();
704 if ( exportThemes.size() > 0 )
705 {
706 exportSettings.exportThemes = exportThemes;
707 }
708 exportSettings.writeGeoPdf = mWmsParameters.writeGeospatialPdf();
709 exportSettings.textRenderFormat = mWmsParameters.pdfTextRenderFormat();
710 exportSettings.forceVectorOutput = mWmsParameters.pdfForceVectorOutput();
711 exportSettings.appendGeoreference = mWmsParameters.pdfAppendGeoreference();
712 exportSettings.simplifyGeometries = mWmsParameters.pdfSimplifyGeometries();
714 if ( mWmsParameters.pdfLosslessImageCompression() )
715 {
717 }
718 if ( mWmsParameters.pdfDisableTiledRasterRendering() )
719 {
721 }
722
723 // Export all pages
724 if ( atlas )
725 {
726 QgsLayoutExporter::exportToPdf( atlas, tempOutputFile.fileName(), exportSettings, exportError );
727 }
728 else
729 {
730 QgsLayoutExporter exporter( layout.get() );
731 exporter.exportToPdf( tempOutputFile.fileName(), exportSettings );
732 }
733 }
734 else //unknown format
735 {
737 }
738
739 if ( atlas )
740 {
741 handlePrintErrors( atlas->layout() );
742 }
743 else
744 {
745 handlePrintErrors( layout.get() );
746 }
747
748 return tempOutputFile.readAll();
749 }
750
751 bool QgsRenderer::configurePrintLayout( QgsPrintLayout *c, const QgsMapSettings &mapSettings, QgsLayoutAtlas *atlas )
752 {
753 c->renderContext().setSelectionColor( mapSettings.selectionColor() );
754 // Maps are configured first
755 QList<QgsLayoutItemMap *> maps;
756 c->layoutItems<QgsLayoutItemMap>( maps );
757 // Layout maps now use a string UUID as "id", let's assume that the first map
758 // has id 0 and so on ...
759 int mapId = 0;
760
761 for ( const auto &map : std::as_const( maps ) )
762 {
763 QgsWmsParametersComposerMap cMapParams = mWmsParameters.composerMapParameters( mapId );
764 mapId++;
765
766 // If there are no configured layers, we take layers from unprefixed LAYER(S) if any
767 if ( cMapParams.mLayers.isEmpty() )
768 {
769 cMapParams.mLayers = mWmsParameters.composerMapParameters( -1 ).mLayers;
770 }
771
772 if ( !atlas || !map->atlasDriven() ) //No need to extent, scale, rotation set with atlas feature
773 {
774 //map extent is mandatory
775 if ( !cMapParams.mHasExtent )
776 {
777 //remove map from composition if not referenced by the request
778 c->removeLayoutItem( map );
779 continue;
780 }
781 // Change CRS of map set to "project CRS" to match requested CRS
782 // (if map has a valid preset crs then we keep this crs and don't use the
783 // requested crs for this map item)
784 if ( mapSettings.destinationCrs().isValid() && !map->presetCrs().isValid() )
785 map->setCrs( mapSettings.destinationCrs() );
786
787 QgsRectangle r( cMapParams.mExtent );
788 if ( mWmsParameters.versionAsNumber() >= QgsProjectVersion( 1, 3, 0 ) && mapSettings.destinationCrs().hasAxisInverted() )
789 {
790 r.invert();
791 }
792 map->setExtent( r );
793
794 // scale
795 if ( cMapParams.mScale > 0 )
796 {
797 map->setScale( static_cast<double>( cMapParams.mScale ) );
798 }
799
800 // rotation
801 if ( cMapParams.mRotation )
802 {
803 map->setMapRotation( cMapParams.mRotation );
804 }
805 }
806
807 if ( !map->keepLayerSet() )
808 {
809 QList<QgsMapLayer *> layerSet;
810
811 for ( const auto &layer : std::as_const( cMapParams.mLayers ) )
812 {
813 if ( mContext.isValidGroup( layer.mNickname ) )
814 {
815 QList<QgsMapLayer *> layersFromGroup;
816
817 const QList<QgsMapLayer *> cLayersFromGroup = mContext.layersFromGroup( layer.mNickname );
818 for ( QgsMapLayer *layerFromGroup : cLayersFromGroup )
819 {
820 if ( !layerFromGroup )
821 {
822 continue;
823 }
824
825 layersFromGroup.push_front( layerFromGroup );
826 }
827
828 if ( !layersFromGroup.isEmpty() )
829 {
830 layerSet.append( layersFromGroup );
831 }
832 }
833 else
834 {
835 QgsMapLayer *mlayer = mContext.layer( layer.mNickname );
836
837 if ( !mlayer )
838 {
839 continue;
840 }
841
842 setLayerStyle( mlayer, layer.mStyle );
843 layerSet << mlayer;
844 }
845 }
846
847 std::reverse( layerSet.begin(), layerSet.end() );
848
849 // If the map is set to follow preset we need to disable follow preset and manually
850 // configure the layers here or the map item internal logic will override and get
851 // the layers from the map theme.
852 QMap<QString, QString> layersStyle;
853 if ( map->followVisibilityPreset() )
854 {
855 if ( atlas )
856 {
857 // Possibly triggers a refresh of the DD visibility preset (theme) name
858 // see issue GH #54475
859 atlas->updateFeatures();
860 atlas->first();
861 }
862
863 const QString presetName = map->followVisibilityPresetName();
864 if ( layerSet.isEmpty() )
865 {
866 // Get the layers from the theme
867 const QgsExpressionContext ex { map->createExpressionContext() };
868 layerSet = map->layersToRender( &ex );
869 }
870 // Disable the theme
871 map->setFollowVisibilityPreset( false );
872
873 // Collect the style of each layer in the theme that has been disabled
874 const QList<QgsMapThemeCollection::MapThemeLayerRecord> mapThemeRecords = QgsProject::instance()->mapThemeCollection()->mapThemeState( presetName ).layerRecords();
875 for ( const auto &layerMapThemeRecord : std::as_const( mapThemeRecords ) )
876 {
877 if ( layerSet.contains( layerMapThemeRecord.layer() ) )
878 {
879 layersStyle.insert( layerMapThemeRecord.layer()->id(), layerMapThemeRecord.layer()->styleManager()->style( layerMapThemeRecord.currentStyle ).xmlData() );
880 }
881 }
882 }
883
884 // Handle highlight layers
885 const QList<QgsMapLayer *> highlights = highlightLayers( cMapParams.mHighlightLayers );
886 for ( const auto &hl : std::as_const( highlights ) )
887 {
888 layerSet.prepend( hl );
889 }
890
891 map->setLayers( layerSet );
892 map->setKeepLayerSet( true );
893
894 // Set style override if a particular style should be used due to a map theme.
895 // It will actualize linked legend symbols too.
896 if ( !layersStyle.isEmpty() )
897 {
898 map->setLayerStyleOverrides( layersStyle );
899 map->setKeepLayerStyles( true );
900 }
901 }
902
903 //grid space x / y
904 if ( cMapParams.mGridX > 0 && cMapParams.mGridY > 0 )
905 {
906 map->grid()->setIntervalX( static_cast<double>( cMapParams.mGridX ) );
907 map->grid()->setIntervalY( static_cast<double>( cMapParams.mGridY ) );
908 }
909 }
910
911 // Labels
912 QList<QgsLayoutItemLabel *> labels;
913 c->layoutItems<QgsLayoutItemLabel>( labels );
914 for ( const auto &label : std::as_const( labels ) )
915 {
916 bool ok = false;
917 const QString labelId = label->id();
918 const QString labelParam = mWmsParameters.layoutParameter( labelId, ok );
919
920 if ( !ok )
921 continue;
922
923 if ( labelParam.isEmpty() )
924 {
925 //remove exported labels referenced in the request
926 //but with empty string
927 c->removeItem( label );
928 delete label;
929 continue;
930 }
931
932 label->setText( labelParam );
933 }
934
935 // HTMLs
936 QList<QgsLayoutItemHtml *> htmls;
937 c->layoutObjects<QgsLayoutItemHtml>( htmls );
938 for ( const auto &html : std::as_const( htmls ) )
939 {
940 if ( html->frameCount() == 0 )
941 continue;
942
943 QgsLayoutFrame *htmlFrame = html->frame( 0 );
944 bool ok = false;
945 const QString htmlId = htmlFrame->id();
946 const QString htmlValue = mWmsParameters.layoutParameter( htmlId, ok );
947
948 if ( !ok )
949 {
950 html->update();
951 continue;
952 }
953
954 //remove exported Htmls referenced in the request
955 //but with empty string
956 if ( htmlValue.isEmpty() )
957 {
958 c->removeMultiFrame( html );
959 delete html;
960 continue;
961 }
962
963 if ( html->contentMode() == QgsLayoutItemHtml::Url )
964 {
965 QUrl newUrl( htmlValue );
966 html->setUrl( newUrl );
967 }
968 else if ( html->contentMode() == QgsLayoutItemHtml::ManualHtml )
969 {
970 html->setHtml( htmlValue );
971 }
972 html->update();
973 }
974
975
976 // legends
977 QList<QgsLayoutItemLegend *> legends;
978 c->layoutItems<QgsLayoutItemLegend>( legends );
979 for ( const auto &legend : std::as_const( legends ) )
980 {
981 if ( legend->autoUpdateModel() )
982 {
983 // the legend has an auto-update model
984 // we will update it with map's layers
985 const QgsLayoutItemMap *map = legend->linkedMap();
986 if ( !map )
987 {
988 continue;
989 }
990
991 legend->setAutoUpdateModel( false );
992
993 // get model and layer tree root of the legend
994 QgsLegendModel *model = legend->model();
995 QStringList layerSet;
996 QList<QgsMapLayer *> mapLayers;
997 if ( map->layers().isEmpty() )
998 {
999 // in QGIS desktop, each layer has its legend, including invisible layers
1000 // and using maptheme, legend items are automatically filtered
1001 mapLayers = mProject->mapLayers( true ).values();
1002 }
1003 else
1004 {
1005 mapLayers = map->layers();
1006 }
1007 const QList<QgsMapLayer *> layerList = mapLayers;
1008 for ( const auto &layer : layerList )
1009 layerSet << layer->id();
1010
1011 //setLayerIdsToLegendModel( model, layerSet, map->scale() );
1012
1013 // get model and layer tree root of the legend
1014 QgsLayerTree *root = model->rootGroup();
1015
1016 // get layerIds find in the layer tree root
1017 const QStringList layerIds = root->findLayerIds();
1018
1019 // find the layer in the layer tree
1020 // remove it if the layer id is not in map layerIds
1021 for ( const auto &layerId : layerIds )
1022 {
1023 QgsLayerTreeLayer *nodeLayer = root->findLayer( layerId );
1024 if ( !nodeLayer )
1025 {
1026 continue;
1027 }
1028 if ( !layerSet.contains( layerId ) )
1029 {
1030 qobject_cast<QgsLayerTreeGroup *>( nodeLayer->parent() )->removeChildNode( nodeLayer );
1031 }
1032 else
1033 {
1034 QgsMapLayer *layer = nodeLayer->layer();
1035 if ( !layer->isInScaleRange( map->scale() ) )
1036 {
1037 qobject_cast<QgsLayerTreeGroup *>( nodeLayer->parent() )->removeChildNode( nodeLayer );
1038 }
1039 }
1040 }
1042 }
1043 }
1044 return true;
1045 }
1046
1047 std::unique_ptr<QImage> QgsRenderer::getMap()
1048 {
1049 // check size
1050 if ( !mContext.isValidWidthHeight() )
1051 {
1052 throw QgsBadRequestException( QgsServiceException::QGIS_InvalidParameterValue, QStringLiteral( "The requested map size is too large" ) );
1053 }
1054
1055 if ( mContext.socketFeedback() && mContext.socketFeedback()->isCanceled() )
1056 {
1057 return nullptr;
1058 }
1059
1060 // init layer restorer before doing anything
1061 std::unique_ptr<QgsWmsRestorer> restorer;
1062 restorer.reset( new QgsWmsRestorer( mContext ) );
1063
1064 // configure layers
1065 QList<QgsMapLayer *> layers = mContext.layersToRender();
1066
1067 QgsMapSettings mapSettings;
1069 configureLayers( layers, &mapSettings );
1070
1071 // create the output image and the painter
1072 std::unique_ptr<QPainter> painter;
1073 std::unique_ptr<QImage> image( createImage( mContext.mapSize() ) );
1074
1075 // configure map settings (background, DPI, ...)
1076 configureMapSettings( image.get(), mapSettings );
1077
1078 // add layers to map settings
1079 mapSettings.setLayers( layers );
1080
1081 // rendering step for layers
1082 QPainter *renderedPainter = layersRendering( mapSettings, image.get() );
1083 if ( !renderedPainter ) // job has been canceled
1084 {
1085 return nullptr;
1086 }
1087
1088 painter.reset( renderedPainter );
1089
1090 // rendering step for annotations
1091 annotationsRendering( painter.get(), mapSettings );
1092
1093 // painting is terminated
1094 painter->end();
1095
1096 // scale output image if necessary (required by WMS spec)
1097 QImage *scaledImage = scaleImage( image.get() );
1098 if ( scaledImage )
1099 image.reset( scaledImage );
1100
1101 // return
1102 if ( mContext.socketFeedback() && mContext.socketFeedback()->isCanceled() )
1103 {
1104 return nullptr;
1105 }
1106 return image;
1107 }
1108
1109 std::unique_ptr<QgsDxfExport> QgsRenderer::getDxf()
1110 {
1111 // configure layers
1112 QList<QgsMapLayer *> layers = mContext.layersToRender();
1113 configureLayers( layers );
1114
1115 // get dxf layers
1116 const QStringList attributes = mWmsParameters.dxfLayerAttributes();
1117 QList<QgsDxfExport::DxfLayer> dxfLayers;
1118 int layerIdx = -1;
1119 for ( QgsMapLayer *layer : layers )
1120 {
1121 layerIdx++;
1122 if ( layer->type() != Qgis::LayerType::Vector )
1123 continue;
1124
1125 // cast for dxf layers
1126 QgsVectorLayer *vlayer = static_cast<QgsVectorLayer *>( layer );
1127
1128 // get the layer attribute used in dxf
1129 int layerAttribute = -1;
1130 if ( attributes.size() > layerIdx )
1131 {
1132 layerAttribute = vlayer->fields().indexFromName( attributes[layerIdx] );
1133 }
1134
1135 dxfLayers.append( QgsDxfExport::DxfLayer( vlayer, layerAttribute ) );
1136 }
1137
1138 //map extent
1139 QgsRectangle mapExtent = mWmsParameters.bboxAsRectangle();
1140
1141 QString crs = mWmsParameters.crs();
1142 if ( crs.compare( QStringLiteral( "CRS:84" ), Qt::CaseInsensitive ) == 0 )
1143 {
1144 crs = QStringLiteral( "EPSG:4326" );
1145 mapExtent.invert();
1146 }
1147 else if ( crs.isEmpty() )
1148 {
1149 crs = QStringLiteral( "EPSG:4326" );
1150 }
1151
1153
1154 if ( !outputCRS.isValid() )
1155 {
1157 QgsWmsParameter parameter;
1158
1159 if ( mWmsParameters.versionAsNumber() >= QgsProjectVersion( 1, 3, 0 ) )
1160 {
1162 parameter = mWmsParameters[QgsWmsParameter::CRS];
1163 }
1164 else
1165 {
1167 parameter = mWmsParameters[QgsWmsParameter::SRS];
1168 }
1169
1170 throw QgsBadRequestException( code, parameter );
1171 }
1172
1173 //then set destinationCrs
1174
1175 // Change x- and y- of BBOX for WMS 1.3.0 if axis inverted
1176 if ( mWmsParameters.versionAsNumber() >= QgsProjectVersion( 1, 3, 0 ) && outputCRS.hasAxisInverted() )
1177 {
1178 mapExtent.invert();
1179 }
1180
1181
1182 // add layers to dxf
1183 auto dxf = std::make_unique<QgsDxfExport>();
1184 dxf->setExtent( mapExtent );
1185 dxf->setDestinationCrs( outputCRS );
1186 dxf->addLayers( dxfLayers );
1187 dxf->setLayerTitleAsName( mWmsParameters.dxfUseLayerTitleAsName() );
1188 dxf->setSymbologyExport( mWmsParameters.dxfMode() );
1190 {
1191 dxf->setSymbologyScale( mWmsParameters.dxfScale() );
1192 }
1193
1194 dxf->setForce2d( mWmsParameters.isForce2D() );
1195 QgsDxfExport::Flags flags;
1196 if ( mWmsParameters.noMText() )
1197 flags.setFlag( QgsDxfExport::Flag::FlagNoMText );
1198
1199 if ( mWmsParameters.exportLinesWithZeroWidth() )
1200 {
1202 }
1203
1204 dxf->setFlags( flags );
1205
1206 return dxf;
1207 }
1208
1209 std::unique_ptr<QgsMapRendererTask> QgsRenderer::getPdf( const QString &tmpFileName )
1210 {
1211 QgsMapSettings ms;
1212 ms.setExtent( mWmsParameters.bboxAsRectangle() );
1213 ms.setLayers( mContext.layersToRender() );
1215 ms.setOutputSize( QSize( mWmsParameters.widthAsInt(), mWmsParameters.heightAsInt() ) );
1216 ms.setDpiTarget( mWmsParameters.dpiAsDouble() );
1217
1219 if ( mWmsParameters.pdfExportMetadata() )
1220 {
1221 pdfExportDetails.author = QgsProject::instance()->metadata().author();
1222 pdfExportDetails.producer = QStringLiteral( "QGIS %1" ).arg( Qgis::version() );
1223 pdfExportDetails.creator = QStringLiteral( "QGIS %1" ).arg( Qgis::version() );
1224 pdfExportDetails.creationDateTime = QDateTime::currentDateTime();
1225 pdfExportDetails.subject = QgsProject::instance()->metadata().abstract();
1226 pdfExportDetails.title = QgsProject::instance()->metadata().title();
1227 pdfExportDetails.keywords = QgsProject::instance()->metadata().keywords();
1228 }
1230 const bool geospatialPdf = mWmsParameters.pdfAppendGeoreference();
1231 auto pdf = std::make_unique<QgsMapRendererTask>( ms, tmpFileName, QStringLiteral( "PDF" ), false, QgsTask::Hidden, geospatialPdf, pdfExportDetails );
1232 if ( mWmsParameters.pdfAppendGeoreference() )
1233 {
1234 pdf->setSaveWorldFile( true );
1235 }
1236 return pdf;
1237 }
1238
1239 static void infoPointToMapCoordinates( int i, int j, QgsPointXY *infoPoint, const QgsMapSettings &mapSettings )
1240 {
1241 //check if i, j are in the pixel range of the image
1242 if ( i < 0 || i > mapSettings.outputSize().width() )
1243 {
1245 param.mValue = i;
1247 }
1248
1249 if ( j < 0 || j > mapSettings.outputSize().height() )
1250 {
1251 QgsWmsParameter param( QgsWmsParameter::J );
1252 param.mValue = j;
1254 }
1255
1256 double xRes = mapSettings.extent().width() / mapSettings.outputSize().width();
1257 double yRes = mapSettings.extent().height() / mapSettings.outputSize().height();
1258 infoPoint->setX( mapSettings.extent().xMinimum() + i * xRes + xRes / 2.0 );
1259 infoPoint->setY( mapSettings.extent().yMaximum() - j * yRes - yRes / 2.0 );
1260 }
1261
1262 QByteArray QgsRenderer::getFeatureInfo( const QString &version )
1263 {
1264 // Verifying Mandatory parameters
1265 // The QUERY_LAYERS parameter is Mandatory
1266 if ( mWmsParameters.queryLayersNickname().isEmpty() )
1267 {
1269 }
1270
1271 // The I/J parameters are Mandatory if they are not replaced by X/Y or FILTER or FILTER_GEOM
1272 const bool ijDefined = !mWmsParameters.i().isEmpty() && !mWmsParameters.j().isEmpty();
1273 const bool xyDefined = !mWmsParameters.x().isEmpty() && !mWmsParameters.y().isEmpty();
1274 const bool filtersDefined = !mWmsParameters.filters().isEmpty();
1275 const bool filterGeomDefined = !mWmsParameters.filterGeom().isEmpty();
1276
1277 if ( !ijDefined && !xyDefined && !filtersDefined && !filterGeomDefined )
1278 {
1279 QgsWmsParameter parameter = mWmsParameters[QgsWmsParameter::I];
1280
1281 if ( mWmsParameters.j().isEmpty() )
1282 parameter = mWmsParameters[QgsWmsParameter::J];
1283
1285 }
1286
1287 const QgsWmsParameters::Format infoFormat = mWmsParameters.infoFormat();
1288 if ( infoFormat == QgsWmsParameters::Format::NONE )
1289 {
1291 }
1292
1293 // create the mapSettings and the output image
1294 std::unique_ptr<QImage> outputImage( createImage( mContext.mapSize() ) );
1295
1296 // init layer restorer before doing anything
1297 std::unique_ptr<QgsWmsRestorer> restorer;
1298 restorer.reset( new QgsWmsRestorer( mContext ) );
1299
1300 // The CRS parameter is considered as mandatory in configureMapSettings
1301 // but in the case of filter parameter, CRS parameter has not to be mandatory
1302 bool mandatoryCrsParam = true;
1303 if ( filtersDefined && !ijDefined && !xyDefined && mWmsParameters.crs().isEmpty() )
1304 {
1305 mandatoryCrsParam = false;
1306 }
1307
1308 // configure map settings (background, DPI, ...)
1309 QgsMapSettings mapSettings;
1311 configureMapSettings( outputImage.get(), mapSettings, mandatoryCrsParam );
1312
1313 // compute scale denominator
1314 QgsScaleCalculator scaleCalc( ( outputImage->logicalDpiX() + outputImage->logicalDpiY() ) / 2, mapSettings.destinationCrs().mapUnits() );
1315 const double scaleDenominator = scaleCalc.calculate( mWmsParameters.bboxAsRectangle(), outputImage->width() );
1316
1317 // configure layers
1318 QgsWmsRenderContext context = mContext;
1319 context.setScaleDenominator( scaleDenominator );
1320
1321 QList<QgsMapLayer *> layers = context.layersToRender();
1322 configureLayers( layers, &mapSettings );
1323
1324 // add layers to map settings
1325 mapSettings.setLayers( layers );
1326
1327#ifdef HAVE_SERVER_PYTHON_PLUGINS
1328 mContext.accessControl()->resolveFilterFeatures( mapSettings.layers() );
1329#endif
1330
1331 QDomDocument result = featureInfoDocument( layers, mapSettings, outputImage.get(), version );
1332
1333 QByteArray ba;
1334
1335 if ( infoFormat == QgsWmsParameters::Format::TEXT )
1336 ba = convertFeatureInfoToText( result );
1337 else if ( infoFormat == QgsWmsParameters::Format::HTML )
1338 ba = convertFeatureInfoToHtml( result );
1339 else if ( infoFormat == QgsWmsParameters::Format::JSON )
1340 ba = convertFeatureInfoToJson( layers, result, mapSettings.destinationCrs() );
1341 else
1342 ba = result.toByteArray();
1343
1344 return ba;
1345 }
1346
1347 QImage *QgsRenderer::createImage( const QSize &size ) const
1348 {
1349 std::unique_ptr<QImage> image;
1350
1351 // use alpha channel only if necessary because it slows down performance
1352 QgsWmsParameters::Format format = mWmsParameters.format();
1353 bool transparent = mWmsParameters.transparentAsBool();
1354
1355 if ( transparent && format != QgsWmsParameters::JPG )
1356 {
1357 image = std::make_unique<QImage>( size, QImage::Format_ARGB32_Premultiplied );
1358 image->fill( 0 );
1359 }
1360 else
1361 {
1362 image = std::make_unique<QImage>( size, QImage::Format_RGB32 );
1363 image->fill( mWmsParameters.backgroundColorAsColor() );
1364 }
1365
1366 // Check that image was correctly created
1367 if ( image->isNull() )
1368 {
1369 throw QgsException( QStringLiteral( "createImage: image could not be created, check for out of memory conditions" ) );
1370 }
1371
1372 const int dpm = static_cast<int>( mContext.dotsPerMm() * 1000.0 );
1373 image->setDotsPerMeterX( dpm );
1374 image->setDotsPerMeterY( dpm );
1375
1376 return image.release();
1377 }
1378
1379 void QgsRenderer::configureMapSettings( const QPaintDevice *paintDevice, QgsMapSettings &mapSettings, bool mandatoryCrsParam )
1380 {
1381 if ( !paintDevice )
1382 {
1383 throw QgsException( QStringLiteral( "configureMapSettings: no paint device" ) );
1384 }
1385
1386 mapSettings.setOutputSize( QSize( paintDevice->width(), paintDevice->height() ) );
1387 // Recalculate from input DPI: do not take the (integer) value from paint device
1388 // because it loose precision!
1389 mapSettings.setOutputDpi( mContext.dotsPerMm() * 25.4 );
1390
1391 //map extent
1392 QgsRectangle mapExtent = mWmsParameters.bboxAsRectangle();
1393 if ( !mWmsParameters.bbox().isEmpty() && mapExtent.isEmpty() )
1394 {
1396 }
1397
1398 QString crs = mWmsParameters.crs();
1399 if ( crs.compare( "CRS:84", Qt::CaseInsensitive ) == 0 )
1400 {
1401 crs = QString( "EPSG:4326" );
1402 mapExtent.invert();
1403 }
1404 else if ( crs.isEmpty() && !mandatoryCrsParam )
1405 {
1406 crs = QString( "EPSG:4326" );
1407 }
1408
1410
1411 //wms spec says that CRS parameter is mandatory.
1413 if ( !outputCRS.isValid() )
1414 {
1416 QgsWmsParameter parameter;
1417
1418 if ( mWmsParameters.versionAsNumber() >= QgsProjectVersion( 1, 3, 0 ) )
1419 {
1421 parameter = mWmsParameters[QgsWmsParameter::CRS];
1422 }
1423 else
1424 {
1426 parameter = mWmsParameters[QgsWmsParameter::SRS];
1427 }
1428
1429 throw QgsBadRequestException( code, parameter );
1430 }
1431
1432 //then set destinationCrs
1433 mapSettings.setDestinationCrs( outputCRS );
1434
1435 mapSettings.setTransformContext( mProject->transformContext() );
1436
1437 // Change x- and y- of BBOX for WMS 1.3.0 if axis inverted
1438 if ( mWmsParameters.versionAsNumber() >= QgsProjectVersion( 1, 3, 0 ) && outputCRS.hasAxisInverted() )
1439 {
1440 mapExtent.invert();
1441 }
1442
1443 mapSettings.setExtent( mapExtent );
1444
1445 // set the extent buffer
1446 mapSettings.setExtentBuffer( mContext.mapTileBuffer( paintDevice->width() ) );
1447
1448 /* Define the background color
1449 * Transparent or colored
1450 */
1451 QgsWmsParameters::Format format = mWmsParameters.format();
1452 bool transparent = mWmsParameters.transparentAsBool();
1453 QColor backgroundColor = mWmsParameters.backgroundColorAsColor();
1454
1455 //set background color
1456 if ( transparent && format != QgsWmsParameters::JPG )
1457 {
1458 mapSettings.setBackgroundColor( QColor( 0, 0, 0, 0 ) );
1459 }
1460 else if ( backgroundColor.isValid() )
1461 {
1462 mapSettings.setBackgroundColor( backgroundColor );
1463 }
1464
1465 // add context from project (global variables, ...)
1466 QgsExpressionContext context = mProject->createExpressionContext();
1467 context << QgsExpressionContextUtils::mapSettingsScope( mapSettings );
1468 mapSettings.setExpressionContext( context );
1469
1470 // add labeling engine settings
1471 mapSettings.setLabelingEngineSettings( mProject->labelingEngineSettings() );
1472
1473 mapSettings.setScaleMethod( mProject->scaleMethod() );
1474
1475 // enable rendering optimization
1477
1479
1480 // enable profiling
1481 if ( mContext.settings().logProfile() )
1482 {
1484 }
1485
1486 // set selection color
1487 mapSettings.setSelectionColor( mProject->selectionColor() );
1488
1489 // Set WMS temporal properties
1490 // Note that this cannot parse multiple time instants while the vector dimensions implementation can
1491 const QString timeString { mWmsParameters.dimensionValues().value( QStringLiteral( "TIME" ), QString() ) };
1492 if ( !timeString.isEmpty() )
1493 {
1494 bool isValidTemporalRange { true };
1495 QgsDateTimeRange range;
1496 // First try with a simple date/datetime instant
1497 const QDateTime dt { QDateTime::fromString( timeString, Qt::DateFormat::ISODateWithMs ) };
1498 if ( dt.isValid() )
1499 {
1500 range = QgsDateTimeRange( dt, dt );
1501 }
1502 else // parse as an interval
1503 {
1504 try
1505 {
1507 }
1508 catch ( const QgsServerApiBadRequestException &ex )
1509 {
1510 isValidTemporalRange = false;
1511 QgsMessageLog::logMessage( QStringLiteral( "Could not parse TIME parameter into a temporal range" ), "Server", Qgis::MessageLevel::Warning );
1512 }
1513 }
1514
1515 if ( isValidTemporalRange )
1516 {
1517 mIsTemporal = true;
1518 mapSettings.setIsTemporal( true );
1519 mapSettings.setTemporalRange( range );
1520 }
1521 }
1522 }
1523
1524 QgsRenderContext QgsRenderer::configureDefaultRenderContext( QPainter *painter )
1525 {
1527 context.setScaleFactor( mContext.dotsPerMm() );
1528 const double mmPerMapUnit = 1 / QgsServerProjectUtils::wmsDefaultMapUnitsPerMm( *mProject );
1529 context.setMapToPixel( QgsMapToPixel( 1 / ( mmPerMapUnit * context.scaleFactor() ) ) );
1530 QgsDistanceArea distanceArea = QgsDistanceArea();
1531 distanceArea.setSourceCrs( QgsCoordinateReferenceSystem( mWmsParameters.crs() ), mProject->transformContext() );
1532 distanceArea.setEllipsoid( Qgis::geoNone() );
1533 context.setDistanceArea( distanceArea );
1534 return context;
1535 }
1536
1537 QDomDocument QgsRenderer::featureInfoDocument( QList<QgsMapLayer *> &layers, const QgsMapSettings &mapSettings, const QImage *outputImage, const QString &version ) const
1538 {
1539 const QStringList queryLayers = mContext.flattenedQueryLayers( mContext.parameters().queryLayersNickname() );
1540
1541 bool ijDefined = ( !mWmsParameters.i().isEmpty() && !mWmsParameters.j().isEmpty() );
1542
1543 bool xyDefined = ( !mWmsParameters.x().isEmpty() && !mWmsParameters.y().isEmpty() );
1544
1545 bool filtersDefined = !mWmsParameters.filters().isEmpty();
1546
1547 bool filterGeomDefined = !mWmsParameters.filterGeom().isEmpty();
1548
1549 int featureCount = mWmsParameters.featureCountAsInt();
1550 if ( featureCount < 1 )
1551 {
1552 featureCount = 1;
1553 }
1554
1555 int i = mWmsParameters.iAsInt();
1556 int j = mWmsParameters.jAsInt();
1557 if ( xyDefined && !ijDefined )
1558 {
1559 i = mWmsParameters.xAsInt();
1560 j = mWmsParameters.yAsInt();
1561 }
1562 int width = mWmsParameters.widthAsInt();
1563 int height = mWmsParameters.heightAsInt();
1564 if ( ( i != -1 && j != -1 && width != 0 && height != 0 ) && ( width != outputImage->width() || height != outputImage->height() ) )
1565 {
1566 i *= ( outputImage->width() / static_cast<double>( width ) );
1567 j *= ( outputImage->height() / static_cast<double>( height ) );
1568 }
1569
1570 // init search variables
1571 std::unique_ptr<QgsRectangle> featuresRect;
1572 std::unique_ptr<QgsGeometry> filterGeom;
1573 std::unique_ptr<QgsPointXY> infoPoint;
1574
1575 if ( i != -1 && j != -1 )
1576 {
1577 infoPoint.reset( new QgsPointXY() );
1578 infoPointToMapCoordinates( i, j, infoPoint.get(), mapSettings );
1579 }
1580 else if ( filtersDefined )
1581 {
1582 featuresRect.reset( new QgsRectangle() );
1583 }
1584
1585 if ( filterGeomDefined )
1586 {
1587 filterGeom.reset( new QgsGeometry( QgsGeometry::fromWkt( mWmsParameters.filterGeom() ) ) );
1588 }
1589
1590 QDomDocument result;
1591 const QDomNode header = result.createProcessingInstruction( QStringLiteral( "xml" ), QStringLiteral( "version=\"1.0\" encoding=\"UTF-8\"" ) );
1592 result.appendChild( header );
1593
1594 QDomElement getFeatureInfoElement;
1595 QgsWmsParameters::Format infoFormat = mWmsParameters.infoFormat();
1596 if ( infoFormat == QgsWmsParameters::Format::GML )
1597 {
1598 getFeatureInfoElement = result.createElement( QStringLiteral( "wfs:FeatureCollection" ) );
1599 getFeatureInfoElement.setAttribute( QStringLiteral( "xmlns:wfs" ), QStringLiteral( "http://www.opengis.net/wfs" ) );
1600 getFeatureInfoElement.setAttribute( QStringLiteral( "xmlns:ogc" ), QStringLiteral( "http://www.opengis.net/ogc" ) );
1601 getFeatureInfoElement.setAttribute( QStringLiteral( "xmlns:gml" ), QStringLiteral( "http://www.opengis.net/gml" ) );
1602 getFeatureInfoElement.setAttribute( QStringLiteral( "xmlns:ows" ), QStringLiteral( "http://www.opengis.net/ows" ) );
1603 getFeatureInfoElement.setAttribute( QStringLiteral( "xmlns:xlink" ), QStringLiteral( "http://www.w3.org/1999/xlink" ) );
1604 getFeatureInfoElement.setAttribute( QStringLiteral( "xmlns:qgs" ), QStringLiteral( "http://qgis.org/gml" ) );
1605 getFeatureInfoElement.setAttribute( QStringLiteral( "xmlns:xsi" ), QStringLiteral( "http://www.w3.org/2001/XMLSchema-instance" ) );
1606 getFeatureInfoElement.setAttribute( QStringLiteral( "xsi:schemaLocation" ), QStringLiteral( "http://www.opengis.net/wfs http://schemas.opengis.net/wfs/1.0.0/wfs.xsd http://qgis.org/gml" ) );
1607 }
1608 else
1609 {
1610 QString featureInfoElemName = QgsServerProjectUtils::wmsFeatureInfoDocumentElement( *mProject );
1611 if ( featureInfoElemName.isEmpty() )
1612 {
1613 featureInfoElemName = QStringLiteral( "GetFeatureInfoResponse" );
1614 }
1615 QString featureInfoElemNs = QgsServerProjectUtils::wmsFeatureInfoDocumentElementNs( *mProject );
1616 if ( featureInfoElemNs.isEmpty() )
1617 {
1618 getFeatureInfoElement = result.createElement( featureInfoElemName );
1619 }
1620 else
1621 {
1622 getFeatureInfoElement = result.createElementNS( featureInfoElemNs, featureInfoElemName );
1623 }
1624 //feature info schema
1625 QString featureInfoSchema = QgsServerProjectUtils::wmsFeatureInfoSchema( *mProject );
1626 if ( !featureInfoSchema.isEmpty() )
1627 {
1628 getFeatureInfoElement.setAttribute( QStringLiteral( "xmlns:xsi" ), QStringLiteral( "http://www.w3.org/2001/XMLSchema-instance" ) );
1629 getFeatureInfoElement.setAttribute( QStringLiteral( "xsi:schemaLocation" ), featureInfoSchema );
1630 }
1631 }
1632 result.appendChild( getFeatureInfoElement );
1633
1634 //Render context is needed to determine feature visibility for vector layers
1635 QgsRenderContext renderContext = QgsRenderContext::fromMapSettings( mapSettings );
1636
1637 bool sia2045 = QgsServerProjectUtils::wmsInfoFormatSia2045( *mProject );
1638
1639 //layers can have assigned a different name for GetCapabilities
1640 QHash<QString, QString> layerAliasMap = QgsServerProjectUtils::wmsFeatureInfoLayerAliasMap( *mProject );
1641
1642 for ( const QString &queryLayer : queryLayers )
1643 {
1644 bool validLayer = false;
1645 bool queryableLayer = true;
1646 for ( QgsMapLayer *layer : std::as_const( layers ) )
1647 {
1648 if ( queryLayer == mContext.layerNickname( *layer ) )
1649 {
1650 validLayer = true;
1651 queryableLayer = layer->flags().testFlag( QgsMapLayer::Identifiable );
1652 if ( !queryableLayer )
1653 {
1654 break;
1655 }
1656
1657 QDomElement layerElement;
1658 if ( infoFormat == QgsWmsParameters::Format::GML )
1659 {
1660 layerElement = getFeatureInfoElement;
1661 }
1662 else
1663 {
1664 layerElement = result.createElement( QStringLiteral( "Layer" ) );
1665 QString layerName = queryLayer;
1666
1667 //check if the layer is given a different name for GetFeatureInfo output
1668 QHash<QString, QString>::const_iterator layerAliasIt = layerAliasMap.constFind( layerName );
1669 if ( layerAliasIt != layerAliasMap.constEnd() )
1670 {
1671 layerName = layerAliasIt.value();
1672 }
1673
1674 layerElement.setAttribute( QStringLiteral( "name" ), layerName );
1675 const QString layerTitle = layer->serverProperties()->title();
1676 if ( !layerTitle.isEmpty() )
1677 {
1678 layerElement.setAttribute( QStringLiteral( "title" ), layerTitle );
1679 }
1680 else
1681 {
1682 layerElement.setAttribute( QStringLiteral( "title" ), layerName );
1683 }
1684 getFeatureInfoElement.appendChild( layerElement );
1685 if ( sia2045 ) //the name might not be unique after alias replacement
1686 {
1687 layerElement.setAttribute( QStringLiteral( "id" ), layer->id() );
1688 }
1689 }
1690
1691 if ( layer->type() == Qgis::LayerType::Vector )
1692 {
1693 QgsVectorLayer *vectorLayer = qobject_cast<QgsVectorLayer *>( layer );
1694 if ( vectorLayer )
1695 {
1696 ( void ) featureInfoFromVectorLayer( vectorLayer, infoPoint.get(), featureCount, result, layerElement, mapSettings, renderContext, version, featuresRect.get(), filterGeom.get() );
1697 break;
1698 }
1699 }
1700 else
1701 {
1702 QgsRasterLayer *rasterLayer = qobject_cast<QgsRasterLayer *>( layer );
1703 if ( !rasterLayer )
1704 {
1705 break;
1706 }
1707 if ( !infoPoint )
1708 {
1709 break;
1710 }
1711 QgsPointXY layerInfoPoint = mapSettings.mapToLayerCoordinates( layer, *( infoPoint.get() ) );
1712 if ( !rasterLayer->extent().contains( layerInfoPoint ) )
1713 {
1714 break;
1715 }
1716 if ( infoFormat == QgsWmsParameters::Format::GML )
1717 {
1718 layerElement = result.createElement( QStringLiteral( "gml:featureMember" ) /*wfs:FeatureMember*/ );
1719 getFeatureInfoElement.appendChild( layerElement );
1720 }
1721
1722 ( void ) featureInfoFromRasterLayer( rasterLayer, mapSettings, &layerInfoPoint, renderContext, result, layerElement, version );
1723 }
1724 break;
1725 }
1726 }
1727 if ( !validLayer && !mContext.isValidLayer( queryLayer ) && !mContext.isValidGroup( queryLayer ) )
1728 {
1729 QgsWmsParameter param( QgsWmsParameter::LAYER );
1730 param.mValue = queryLayer;
1732 }
1733 else if ( ( validLayer && !queryableLayer ) || ( !validLayer && mContext.isValidGroup( queryLayer ) ) )
1734 {
1735 QgsWmsParameter param( QgsWmsParameter::LAYER );
1736 param.mValue = queryLayer;
1737 // Check if this layer belongs to a group and the group has any queryable layers
1738 bool hasGroupAndQueryable { false };
1739 if ( !mContext.parameters().queryLayersNickname().contains( queryLayer ) )
1740 {
1741 // Find which group this layer belongs to
1742 const QStringList constNicks { mContext.parameters().queryLayersNickname() };
1743 for ( const QString &ql : constNicks )
1744 {
1745 if ( mContext.layerGroups().contains( ql ) )
1746 {
1747 const QList<QgsMapLayer *> constLayers { mContext.layerGroups()[ql] };
1748 for ( const QgsMapLayer *ml : constLayers )
1749 {
1750 if ( ( !ml->serverProperties()->shortName().isEmpty() && ml->serverProperties()->shortName() == queryLayer ) || ( ml->name() == queryLayer ) )
1751 {
1752 param.mValue = ql;
1753 }
1754 if ( ml->flags().testFlag( QgsMapLayer::Identifiable ) )
1755 {
1756 hasGroupAndQueryable = true;
1757 break;
1758 }
1759 }
1760 break;
1761 }
1762 }
1763 }
1764 // Only throw if it's not a group or the group has no queryable children
1765 if ( !hasGroupAndQueryable )
1766 {
1768 }
1769 }
1770 }
1771
1772 if ( featuresRect && !featuresRect->isNull() )
1773 {
1774 if ( infoFormat == QgsWmsParameters::Format::GML )
1775 {
1776 QDomElement bBoxElem = result.createElement( QStringLiteral( "gml:boundedBy" ) );
1777 QDomElement boxElem;
1778 int gmlVersion = mWmsParameters.infoFormatVersion();
1779 if ( gmlVersion < 3 )
1780 {
1781 boxElem = QgsOgcUtils::rectangleToGMLBox( featuresRect.get(), result, 8 );
1782 }
1783 else
1784 {
1785 boxElem = QgsOgcUtils::rectangleToGMLEnvelope( featuresRect.get(), result, 8 );
1786 }
1787
1788 QgsCoordinateReferenceSystem crs = mapSettings.destinationCrs();
1789 if ( crs.isValid() )
1790 {
1791 boxElem.setAttribute( QStringLiteral( "srsName" ), crs.authid() );
1792 }
1793 bBoxElem.appendChild( boxElem );
1794 getFeatureInfoElement.insertBefore( bBoxElem, QDomNode() ); //insert as first child
1795 }
1796 else
1797 {
1798 QDomElement bBoxElem = result.createElement( QStringLiteral( "BoundingBox" ) );
1799 bBoxElem.setAttribute( QStringLiteral( "CRS" ), mapSettings.destinationCrs().authid() );
1800 bBoxElem.setAttribute( QStringLiteral( "minx" ), qgsDoubleToString( featuresRect->xMinimum(), 8 ) );
1801 bBoxElem.setAttribute( QStringLiteral( "maxx" ), qgsDoubleToString( featuresRect->xMaximum(), 8 ) );
1802 bBoxElem.setAttribute( QStringLiteral( "miny" ), qgsDoubleToString( featuresRect->yMinimum(), 8 ) );
1803 bBoxElem.setAttribute( QStringLiteral( "maxy" ), qgsDoubleToString( featuresRect->yMaximum(), 8 ) );
1804 getFeatureInfoElement.insertBefore( bBoxElem, QDomNode() ); //insert as first child
1805 }
1806 }
1807
1808 if ( sia2045 && infoFormat == QgsWmsParameters::Format::XML )
1809 {
1810 convertFeatureInfoToSia2045( result );
1811 }
1812
1813 return result;
1814 }
1815
1816 bool QgsRenderer::featureInfoFromVectorLayer( QgsVectorLayer *layer, const QgsPointXY *infoPoint, int nFeatures, QDomDocument &infoDocument, QDomElement &layerElement, const QgsMapSettings &mapSettings, QgsRenderContext &renderContext, const QString &version, QgsRectangle *featureBBox, QgsGeometry *filterGeom ) const
1817 {
1818 if ( !layer )
1819 {
1820 return false;
1821 }
1822
1823 QgsFeatureRequest fReq;
1824
1825 // Transform filter geometry to layer CRS
1826 std::unique_ptr<QgsGeometry> layerFilterGeom;
1827 if ( filterGeom )
1828 {
1829 layerFilterGeom.reset( new QgsGeometry( *filterGeom ) );
1830 layerFilterGeom->transform( QgsCoordinateTransform( mapSettings.destinationCrs(), layer->crs(), fReq.transformContext() ) );
1831 }
1832
1833 //we need a selection rect (0.01 of map width)
1834 QgsRectangle mapRect = mapSettings.extent();
1835 QgsRectangle layerRect = mapSettings.mapToLayerCoordinates( layer, mapRect );
1836
1837
1838 QgsRectangle searchRect;
1839
1840 //info point could be 0 in case there is only an attribute filter
1841 if ( infoPoint )
1842 {
1843 searchRect = featureInfoSearchRect( layer, mapSettings, renderContext, *infoPoint );
1844 }
1845 else if ( layerFilterGeom )
1846 {
1847 searchRect = layerFilterGeom->boundingBox();
1848 }
1849 else if ( !mWmsParameters.bbox().isEmpty() )
1850 {
1851 searchRect = layerRect;
1852 }
1853
1854 //do a select with searchRect and go through all the features
1855
1856 QgsFeature feature;
1857 QgsAttributes featureAttributes;
1858 int featureCounter = 0;
1859 layer->updateFields();
1860 const QgsFields fields = layer->fields();
1861 bool addWktGeometry = ( QgsServerProjectUtils::wmsFeatureInfoAddWktGeometry( *mProject ) && mWmsParameters.withGeometry() );
1862 bool segmentizeWktGeometry = QgsServerProjectUtils::wmsFeatureInfoSegmentizeWktGeometry( *mProject );
1863
1864 bool hasGeometry = QgsServerProjectUtils::wmsFeatureInfoAddWktGeometry( *mProject ) || addWktGeometry || featureBBox || layerFilterGeom;
1865 fReq.setFlags( ( ( hasGeometry ) ? Qgis::FeatureRequestFlag::NoFlags : Qgis::FeatureRequestFlag::NoGeometry ) | Qgis::FeatureRequestFlag::ExactIntersect );
1866
1867 if ( !searchRect.isEmpty() )
1868 {
1869 fReq.setFilterRect( searchRect );
1870 }
1871 else
1872 {
1873 fReq.setFlags( fReq.flags() & ~static_cast<int>( Qgis::FeatureRequestFlag::ExactIntersect ) );
1874 }
1875
1876
1877 if ( layerFilterGeom )
1878 {
1879 fReq.setFilterExpression( QString( "intersects( $geometry, geom_from_wkt('%1') )" ).arg( layerFilterGeom->asWkt() ) );
1880 }
1881
1882 mFeatureFilter.filterFeatures( layer, fReq );
1883
1884#ifdef HAVE_SERVER_PYTHON_PLUGINS
1885 mContext.accessControl()->filterFeatures( layer, fReq );
1886
1887 QStringList attributes;
1888 for ( const QgsField &field : fields )
1889 {
1890 attributes.append( field.name() );
1891 }
1892 attributes = mContext.accessControl()->layerAttributes( layer, attributes );
1893 fReq.setSubsetOfAttributes( attributes, layer->fields() );
1894#endif
1895
1896 QgsFeatureIterator fit = layer->getFeatures( fReq );
1897 std::unique_ptr<QgsFeatureRenderer> r2( layer->renderer() ? layer->renderer()->clone() : nullptr );
1898 if ( r2 )
1899 {
1900 r2->startRender( renderContext, layer->fields() );
1901 }
1902
1903 bool featureBBoxInitialized = false;
1904 while ( fit.nextFeature( feature ) )
1905 {
1906 if ( layer->wkbType() == Qgis::WkbType::NoGeometry && !searchRect.isEmpty() )
1907 {
1908 break;
1909 }
1910
1911 ++featureCounter;
1912 if ( featureCounter > nFeatures )
1913 {
1914 break;
1915 }
1916
1917 renderContext.expressionContext().setFeature( feature );
1918
1919 if ( layer->wkbType() != Qgis::WkbType::NoGeometry && !searchRect.isEmpty() )
1920 {
1921 if ( !r2 )
1922 {
1923 continue;
1924 }
1925
1926 //check if feature is rendered at all
1927 bool render = r2->willRenderFeature( feature, renderContext );
1928 if ( !render )
1929 {
1930 continue;
1931 }
1932 }
1933
1934 QgsRectangle box;
1935 if ( layer->wkbType() != Qgis::WkbType::NoGeometry && hasGeometry )
1936 {
1937 box = mapSettings.layerExtentToOutputExtent( layer, feature.geometry().boundingBox() );
1938 if ( featureBBox ) //extend feature info bounding box if requested
1939 {
1940 if ( !featureBBoxInitialized && featureBBox->isEmpty() )
1941 {
1942 *featureBBox = box;
1943 featureBBoxInitialized = true;
1944 }
1945 else
1946 {
1947 featureBBox->combineExtentWith( box );
1948 }
1949 }
1950 }
1951
1953 if ( layer->crs() != mapSettings.destinationCrs() )
1954 {
1955 outputCrs = mapSettings.destinationCrs();
1956 }
1957
1958 if ( mWmsParameters.infoFormat() == QgsWmsParameters::Format::GML )
1959 {
1960 bool withGeom = layer->wkbType() != Qgis::WkbType::NoGeometry && addWktGeometry;
1961 int gmlVersion = mWmsParameters.infoFormatVersion();
1962 QString typeName = mContext.layerNickname( *layer );
1963 QDomElement elem = createFeatureGML(
1964 &feature, layer, infoDocument, outputCrs, mapSettings, typeName, withGeom, gmlVersion
1965#ifdef HAVE_SERVER_PYTHON_PLUGINS
1966 ,
1967 &attributes
1968#endif
1969 );
1970 QDomElement featureMemberElem = infoDocument.createElement( QStringLiteral( "gml:featureMember" ) /*wfs:FeatureMember*/ );
1971 featureMemberElem.appendChild( elem );
1972 layerElement.appendChild( featureMemberElem );
1973 continue;
1974 }
1975 else
1976 {
1977 QDomElement featureElement = infoDocument.createElement( QStringLiteral( "Feature" ) );
1978 featureElement.setAttribute( QStringLiteral( "id" ), QgsServerFeatureId::getServerFid( feature, layer->dataProvider()->pkAttributeIndexes() ) );
1979 layerElement.appendChild( featureElement );
1980
1981 featureAttributes = feature.attributes();
1982 QgsEditFormConfig editConfig = layer->editFormConfig();
1984 {
1985 writeAttributesTabLayout( editConfig, layer, fields, featureAttributes, infoDocument, featureElement, renderContext
1986#ifdef HAVE_SERVER_PYTHON_PLUGINS
1987 ,
1988 &attributes
1989#endif
1990 );
1991 }
1992 else
1993 {
1994 for ( int i = 0; i < featureAttributes.count(); ++i )
1995 {
1996 writeVectorLayerAttribute( i, layer, fields, featureAttributes, infoDocument, featureElement, renderContext
1997#ifdef HAVE_SERVER_PYTHON_PLUGINS
1998 ,
1999 &attributes
2000#endif
2001 );
2002 }
2003 }
2004
2005 //add maptip attribute based on html/expression (in case there is no maptip attribute)
2006 QString mapTip = layer->mapTipTemplate();
2007 if ( !mapTip.isEmpty() && ( mWmsParameters.withMapTip() || mWmsParameters.htmlInfoOnlyMapTip() ) )
2008 {
2009 QDomElement maptipElem = infoDocument.createElement( QStringLiteral( "Attribute" ) );
2010 maptipElem.setAttribute( QStringLiteral( "name" ), QStringLiteral( "maptip" ) );
2011 QgsExpressionContext context { renderContext.expressionContext() };
2012 context.appendScope( QgsExpressionContextUtils::layerScope( layer ) );
2013 maptipElem.setAttribute( QStringLiteral( "value" ), QgsExpression::replaceExpressionText( mapTip, &context ) );
2014 featureElement.appendChild( maptipElem );
2015 }
2016
2017 QgsExpression displayExpression = layer->displayExpression();
2018 if ( displayExpression.isValid() && mWmsParameters.withDisplayName() )
2019 {
2020 QDomElement displayElem = infoDocument.createElement( QStringLiteral( "Attribute" ) );
2021 displayElem.setAttribute( QStringLiteral( "name" ), QStringLiteral( "displayName" ) );
2022 QgsExpressionContext context { renderContext.expressionContext() };
2023 context.appendScope( QgsExpressionContextUtils::layerScope( layer ) );
2024 displayExpression.prepare( &context );
2025 displayElem.setAttribute( QStringLiteral( "value" ), displayExpression.evaluate( &context ).toString() );
2026 featureElement.appendChild( displayElem );
2027 }
2028
2029 //append feature bounding box to feature info xml
2030 if ( QgsServerProjectUtils::wmsFeatureInfoAddWktGeometry( *mProject ) && layer->wkbType() != Qgis::WkbType::NoGeometry && hasGeometry )
2031 {
2032 QDomElement bBoxElem = infoDocument.createElement( QStringLiteral( "BoundingBox" ) );
2033 bBoxElem.setAttribute( version == QLatin1String( "1.1.1" ) ? "SRS" : "CRS", outputCrs.authid() );
2034 bBoxElem.setAttribute( QStringLiteral( "minx" ), qgsDoubleToString( box.xMinimum(), mContext.precision() ) );
2035 bBoxElem.setAttribute( QStringLiteral( "maxx" ), qgsDoubleToString( box.xMaximum(), mContext.precision() ) );
2036 bBoxElem.setAttribute( QStringLiteral( "miny" ), qgsDoubleToString( box.yMinimum(), mContext.precision() ) );
2037 bBoxElem.setAttribute( QStringLiteral( "maxy" ), qgsDoubleToString( box.yMaximum(), mContext.precision() ) );
2038 featureElement.appendChild( bBoxElem );
2039 }
2040
2041 //also append the wkt geometry as an attribute
2042 if ( layer->wkbType() != Qgis::WkbType::NoGeometry && addWktGeometry && hasGeometry )
2043 {
2044 QgsGeometry geom = feature.geometry();
2045 if ( !geom.isNull() )
2046 {
2047 if ( layer->crs() != outputCrs )
2048 {
2049 QgsCoordinateTransform transform = mapSettings.layerTransform( layer );
2050 if ( transform.isValid() )
2051 geom.transform( transform );
2052 }
2053
2054 if ( segmentizeWktGeometry )
2055 {
2056 const QgsAbstractGeometry *abstractGeom = geom.constGet();
2057 if ( abstractGeom )
2058 {
2059 if ( QgsWkbTypes::isCurvedType( abstractGeom->wkbType() ) )
2060 {
2061 QgsAbstractGeometry *segmentizedGeom = abstractGeom->segmentize();
2062 geom.set( segmentizedGeom );
2063 }
2064 }
2065 }
2066 QDomElement geometryElement = infoDocument.createElement( QStringLiteral( "Attribute" ) );
2067 geometryElement.setAttribute( QStringLiteral( "name" ), QStringLiteral( "geometry" ) );
2068 geometryElement.setAttribute( QStringLiteral( "value" ), geom.asWkt( mContext.precision() ) );
2069 geometryElement.setAttribute( QStringLiteral( "type" ), QStringLiteral( "derived" ) );
2070 featureElement.appendChild( geometryElement );
2071 }
2072 }
2073 }
2074 }
2075 if ( r2 )
2076 {
2077 r2->stopRender( renderContext );
2078 }
2079
2080 return true;
2081 }
2082
2083 void QgsRenderer::writeAttributesTabGroup( const QgsAttributeEditorElement *group, QgsVectorLayer *layer, const QgsFields &fields, QgsAttributes &featureAttributes, QDomDocument &doc, QDomElement &parentElem, QgsRenderContext &renderContext, QStringList *attributes ) const
2084 {
2085 const QgsAttributeEditorContainer *container = dynamic_cast<const QgsAttributeEditorContainer *>( group );
2086 if ( container )
2087 {
2088 QString groupName = container->name();
2089 QDomElement nameElem;
2090
2091 if ( !groupName.isEmpty() )
2092 {
2093 nameElem = doc.createElement( groupName );
2094 parentElem.appendChild( nameElem );
2095 }
2096
2097 const QList<QgsAttributeEditorElement *> children = container->children();
2098 for ( const QgsAttributeEditorElement *child : children )
2099 {
2100 if ( child->type() == Qgis::AttributeEditorType::Container )
2101 {
2102 writeAttributesTabGroup( child, layer, fields, featureAttributes, doc, nameElem.isNull() ? parentElem : nameElem, renderContext );
2103 }
2104 else if ( child->type() == Qgis::AttributeEditorType::Field )
2105 {
2106 const QgsAttributeEditorField *editorField = dynamic_cast<const QgsAttributeEditorField *>( child );
2107 if ( editorField )
2108 {
2109 const int idx { fields.indexFromName( editorField->name() ) };
2110 if ( idx >= 0 )
2111 {
2112 writeVectorLayerAttribute( idx, layer, fields, featureAttributes, doc, nameElem.isNull() ? parentElem : nameElem, renderContext, attributes );
2113 }
2114 }
2115 }
2116 }
2117 }
2118 }
2119
2120 void QgsRenderer::writeAttributesTabLayout( QgsEditFormConfig &config, QgsVectorLayer *layer, const QgsFields &fields, QgsAttributes &featureAttributes, QDomDocument &doc, QDomElement &featureElem, QgsRenderContext &renderContext, QStringList *attributes ) const
2121 {
2122 QgsAttributeEditorContainer *editorContainer = config.invisibleRootContainer();
2123 if ( !editorContainer )
2124 {
2125 return;
2126 }
2127
2128 writeAttributesTabGroup( editorContainer, layer, fields, featureAttributes, doc, featureElem, renderContext, attributes );
2129 }
2130
2131 void QgsRenderer::writeVectorLayerAttribute( int attributeIndex, QgsVectorLayer *layer, const QgsFields &fields, QgsAttributes &featureAttributes, QDomDocument &doc, QDomElement &featureElem, QgsRenderContext &renderContext, QStringList *attributes ) const
2132 {
2133#ifndef HAVE_SERVER_PYTHON_PLUGINS
2134 Q_UNUSED( attributes );
2135#endif
2136
2137 if ( !layer )
2138 {
2139 return;
2140 }
2141
2142 //skip attribute if it is explicitly excluded from WMS publication
2143 if ( fields.at( attributeIndex ).configurationFlags().testFlag( Qgis::FieldConfigurationFlag::HideFromWms ) )
2144 {
2145 return;
2146 }
2147#ifdef HAVE_SERVER_PYTHON_PLUGINS
2148 //skip attribute if it is excluded by access control
2149 if ( attributes && !attributes->contains( fields.at( attributeIndex ).name() ) )
2150 {
2151 return;
2152 }
2153#endif
2154
2155 QString attributeName = layer->attributeDisplayName( attributeIndex );
2156 QDomElement attributeElement = doc.createElement( QStringLiteral( "Attribute" ) );
2157 attributeElement.setAttribute( QStringLiteral( "name" ), attributeName );
2158 const QgsEditorWidgetSetup setup = layer->editorWidgetSetup( attributeIndex );
2159 attributeElement.setAttribute( QStringLiteral( "value" ), QgsExpression::replaceExpressionText( replaceValueMapAndRelation( layer, attributeIndex, featureAttributes[attributeIndex] ), &renderContext.expressionContext() ) );
2160 featureElem.appendChild( attributeElement );
2161 }
2162
2163 bool QgsRenderer::featureInfoFromRasterLayer( QgsRasterLayer *layer, const QgsMapSettings &mapSettings, const QgsPointXY *infoPoint, const QgsRenderContext &renderContext, QDomDocument &infoDocument, QDomElement &layerElement, const QString &version ) const
2164 {
2165 Q_UNUSED( version )
2166
2167 if ( !infoPoint || !layer || !layer->dataProvider() )
2168 {
2169 return false;
2170 }
2171
2172 QgsMessageLog::logMessage( QStringLiteral( "infoPoint: %1 %2" ).arg( infoPoint->x() ).arg( infoPoint->y() ), QStringLiteral( "Server" ), Qgis::MessageLevel::Info );
2173
2175 {
2176 return false;
2177 }
2178
2179 const Qgis::RasterIdentifyFormat identifyFormat(
2182 : Qgis::RasterIdentifyFormat::Value
2183 );
2184
2185 QgsRasterIdentifyResult identifyResult;
2186 if ( layer->crs() != mapSettings.destinationCrs() )
2187 {
2188 const QgsRectangle extent { mapSettings.extent() };
2189 const QgsCoordinateTransform transform { mapSettings.destinationCrs(), layer->crs(), mapSettings.transformContext() };
2190 if ( !transform.isValid() )
2191 {
2192 throw QgsBadRequestException( QgsServiceException::OGC_InvalidCRS, QStringLiteral( "CRS transform error from %1 to %2 in layer %3" ).arg( mapSettings.destinationCrs().authid() ).arg( layer->crs().authid() ).arg( layer->name() ) );
2193 }
2194 identifyResult = layer->dataProvider()->identify( *infoPoint, identifyFormat, transform.transform( extent ), mapSettings.outputSize().width(), mapSettings.outputSize().height() );
2195 }
2196 else
2197 {
2198 identifyResult = layer->dataProvider()->identify( *infoPoint, identifyFormat, mapSettings.extent(), mapSettings.outputSize().width(), mapSettings.outputSize().height() );
2199 }
2200
2201 if ( !identifyResult.isValid() )
2202 return false;
2203
2204 QMap<int, QVariant> attributes = identifyResult.results();
2205
2206 if ( mWmsParameters.infoFormat() == QgsWmsParameters::Format::GML )
2207 {
2208 QgsFeature feature;
2209 QgsFields fields;
2210 QgsCoordinateReferenceSystem layerCrs = layer->crs();
2211 int gmlVersion = mWmsParameters.infoFormatVersion();
2212 QString typeName = mContext.layerNickname( *layer );
2213
2214 if ( identifyFormat == Qgis::RasterIdentifyFormat::Value )
2215 {
2216 feature.initAttributes( attributes.count() );
2217 int index = 0;
2218 for ( auto it = attributes.constBegin(); it != attributes.constEnd(); ++it )
2219 {
2220 fields.append( QgsField( layer->bandName( it.key() ), QMetaType::Type::Double ) );
2221 feature.setAttribute( index++, QString::number( it.value().toDouble() ) );
2222 }
2223 feature.setFields( fields );
2224 QDomElement elem = createFeatureGML(
2225 &feature, nullptr, infoDocument, layerCrs, mapSettings, typeName, false, gmlVersion, nullptr
2226 );
2227 layerElement.appendChild( elem );
2228 }
2229 else
2230 {
2231 const auto values = identifyResult.results();
2232 for ( auto it = values.constBegin(); it != values.constEnd(); ++it )
2233 {
2234 QVariant value = it.value();
2235 if ( value.userType() == QMetaType::Type::Bool && !value.toBool() )
2236 {
2237 // sublayer not visible or not queryable
2238 continue;
2239 }
2240
2241 if ( value.userType() == QMetaType::Type::QString )
2242 {
2243 continue;
2244 }
2245
2246 // list of feature stores for a single sublayer
2247 const QgsFeatureStoreList featureStoreList = it.value().value<QgsFeatureStoreList>();
2248
2249 for ( const QgsFeatureStore &featureStore : featureStoreList )
2250 {
2251 const QgsFeatureList storeFeatures = featureStore.features();
2252 for ( const QgsFeature &feature : storeFeatures )
2253 {
2254 QDomElement elem = createFeatureGML(
2255 &feature, nullptr, infoDocument, layerCrs, mapSettings, typeName, false, gmlVersion, nullptr
2256 );
2257 layerElement.appendChild( elem );
2258 }
2259 }
2260 }
2261 }
2262 }
2263 else
2264 {
2265 if ( identifyFormat == Qgis::RasterIdentifyFormat::Value )
2266 {
2267 for ( auto it = attributes.constBegin(); it != attributes.constEnd(); ++it )
2268 {
2269 QDomElement attributeElement = infoDocument.createElement( QStringLiteral( "Attribute" ) );
2270 attributeElement.setAttribute( QStringLiteral( "name" ), layer->bandName( it.key() ) );
2271
2272 QString value;
2273 if ( !QgsVariantUtils::isNull( it.value() ) )
2274 {
2275 value = QString::number( it.value().toDouble() );
2276 }
2277
2278 attributeElement.setAttribute( QStringLiteral( "value" ), value );
2279 layerElement.appendChild( attributeElement );
2280 }
2281 }
2282 else // feature
2283 {
2284 const auto values = identifyResult.results();
2285 for ( auto it = values.constBegin(); it != values.constEnd(); ++it )
2286 {
2287 QVariant value = it.value();
2288 if ( value.userType() == QMetaType::Type::Bool && !value.toBool() )
2289 {
2290 // sublayer not visible or not queryable
2291 continue;
2292 }
2293
2294 if ( value.userType() == QMetaType::Type::QString )
2295 {
2296 continue;
2297 }
2298
2299 // list of feature stores for a single sublayer
2300 const QgsFeatureStoreList featureStoreList = it.value().value<QgsFeatureStoreList>();
2301 for ( const QgsFeatureStore &featureStore : featureStoreList )
2302 {
2303 const QgsFeatureList storeFeatures = featureStore.features();
2304 for ( const QgsFeature &feature : storeFeatures )
2305 {
2306 for ( const auto &fld : feature.fields() )
2307 {
2308 const auto val { feature.attribute( fld.name() ) };
2309 if ( val.isValid() )
2310 {
2311 QDomElement attributeElement = infoDocument.createElement( QStringLiteral( "Attribute" ) );
2312 attributeElement.setAttribute( QStringLiteral( "name" ), fld.name() );
2313 attributeElement.setAttribute( QStringLiteral( "value" ), val.toString() );
2314 layerElement.appendChild( attributeElement );
2315 }
2316 }
2317 }
2318 }
2319 }
2320 }
2321 //add maptip attribute based on html/expression
2322 QString mapTip = layer->mapTipTemplate();
2323 if ( !mapTip.isEmpty() && ( mWmsParameters.withMapTip() || mWmsParameters.htmlInfoOnlyMapTip() ) )
2324 {
2325 QDomElement maptipElem = infoDocument.createElement( QStringLiteral( "Attribute" ) );
2326 maptipElem.setAttribute( QStringLiteral( "name" ), QStringLiteral( "maptip" ) );
2327 QgsExpressionContext context { renderContext.expressionContext() };
2329 scope->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "layer_cursor_point" ), QVariant::fromValue( QgsGeometry::fromPointXY( QgsPointXY( infoPoint->x(), infoPoint->y() ) ) ) ) );
2330 context.appendScope( scope );
2331 maptipElem.setAttribute( QStringLiteral( "value" ), QgsExpression::replaceExpressionText( mapTip, &context ) );
2332 layerElement.appendChild( maptipElem );
2333 }
2334 }
2335 return true;
2336 }
2337
2338 bool QgsRenderer::testFilterStringSafety( const QString &filter ) const
2339 {
2340 //; too dangerous for sql injections
2341 if ( filter.contains( QLatin1String( ";" ) ) )
2342 {
2343 return false;
2344 }
2345
2346 QStringList tokens = filter.split( ' ', Qt::SkipEmptyParts );
2347 groupStringList( tokens, QStringLiteral( "'" ) );
2348 groupStringList( tokens, QStringLiteral( "\"" ) );
2349
2350 for ( auto tokenIt = tokens.constBegin(); tokenIt != tokens.constEnd(); ++tokenIt )
2351 {
2352 //allowlist of allowed characters and keywords
2353 if ( tokenIt->compare( QLatin1String( "," ) ) == 0
2354 || tokenIt->compare( QLatin1String( "(" ) ) == 0
2355 || tokenIt->compare( QLatin1String( ")" ) ) == 0
2356 || tokenIt->compare( QLatin1String( "=" ) ) == 0
2357 || tokenIt->compare( QLatin1String( "!=" ) ) == 0
2358 || tokenIt->compare( QLatin1String( "<" ) ) == 0
2359 || tokenIt->compare( QLatin1String( "<=" ) ) == 0
2360 || tokenIt->compare( QLatin1String( ">" ) ) == 0
2361 || tokenIt->compare( QLatin1String( ">=" ) ) == 0
2362 || tokenIt->compare( QLatin1String( "%" ) ) == 0
2363 || tokenIt->compare( QLatin1String( "IS" ), Qt::CaseInsensitive ) == 0
2364 || tokenIt->compare( QLatin1String( "NOT" ), Qt::CaseInsensitive ) == 0
2365 || tokenIt->compare( QLatin1String( "NULL" ), Qt::CaseInsensitive ) == 0
2366 || tokenIt->compare( QLatin1String( "AND" ), Qt::CaseInsensitive ) == 0
2367 || tokenIt->compare( QLatin1String( "OR" ), Qt::CaseInsensitive ) == 0
2368 || tokenIt->compare( QLatin1String( "IN" ), Qt::CaseInsensitive ) == 0
2369 || tokenIt->compare( QLatin1String( "LIKE" ), Qt::CaseInsensitive ) == 0
2370 || tokenIt->compare( QLatin1String( "ILIKE" ), Qt::CaseInsensitive ) == 0
2371 || tokenIt->compare( QLatin1String( "DMETAPHONE" ), Qt::CaseInsensitive ) == 0
2372 || tokenIt->compare( QLatin1String( "SOUNDEX" ), Qt::CaseInsensitive ) == 0
2373 || mContext.settings().allowedExtraSqlTokens().contains( *tokenIt, Qt::CaseSensitivity::CaseInsensitive ) )
2374 {
2375 continue;
2376 }
2377
2378 //numbers are OK
2379 bool isNumeric;
2380 ( void ) tokenIt->toDouble( &isNumeric );
2381 if ( isNumeric )
2382 {
2383 continue;
2384 }
2385
2386 //numeric strings need to be quoted once either with single or with double quotes
2387
2388 //empty strings are OK
2389 if ( *tokenIt == QLatin1String( "''" ) )
2390 {
2391 continue;
2392 }
2393
2394 //single quote
2395 if ( tokenIt->size() > 2
2396 && ( *tokenIt )[0] == QChar( '\'' )
2397 && ( *tokenIt )[tokenIt->size() - 1] == QChar( '\'' )
2398 && ( *tokenIt )[1] != QChar( '\'' )
2399 && ( *tokenIt )[tokenIt->size() - 2] != QChar( '\'' ) )
2400 {
2401 continue;
2402 }
2403
2404 //double quote
2405 if ( tokenIt->size() > 2
2406 && ( *tokenIt )[0] == QChar( '"' )
2407 && ( *tokenIt )[tokenIt->size() - 1] == QChar( '"' )
2408 && ( *tokenIt )[1] != QChar( '"' )
2409 && ( *tokenIt )[tokenIt->size() - 2] != QChar( '"' ) )
2410 {
2411 continue;
2412 }
2413
2414 return false;
2415 }
2416
2417 return true;
2418 }
2419
2420 void QgsRenderer::groupStringList( QStringList &list, const QString &groupString )
2421 {
2422 //group contents within single quotes together
2423 bool groupActive = false;
2424 int startGroup = -1;
2425 QString concatString;
2426
2427 for ( int i = 0; i < list.size(); ++i )
2428 {
2429 QString &str = list[i];
2430 if ( str.startsWith( groupString ) )
2431 {
2432 startGroup = i;
2433 groupActive = true;
2434 concatString.clear();
2435 }
2436
2437 if ( groupActive )
2438 {
2439 if ( i != startGroup )
2440 {
2441 concatString.append( " " );
2442 }
2443 concatString.append( str );
2444 }
2445
2446 if ( str.endsWith( groupString ) )
2447 {
2448 int endGroup = i;
2449 groupActive = false;
2450
2451 if ( startGroup != -1 )
2452 {
2453 list[startGroup] = concatString;
2454 for ( int j = startGroup + 1; j <= endGroup; ++j )
2455 {
2456 list.removeAt( startGroup + 1 );
2457 --i;
2458 }
2459 }
2460
2461 concatString.clear();
2462 startGroup = -1;
2463 }
2464 }
2465 }
2466
2467 void QgsRenderer::convertFeatureInfoToSia2045( QDomDocument &doc ) const
2468 {
2469 QDomDocument SIAInfoDoc;
2470 QDomElement infoDocElement = doc.documentElement();
2471 QDomElement SIAInfoDocElement = SIAInfoDoc.importNode( infoDocElement, false ).toElement();
2472 SIAInfoDoc.appendChild( SIAInfoDocElement );
2473
2474 QString currentAttributeName;
2475 QString currentAttributeValue;
2476 QDomElement currentAttributeElem;
2477 QString currentLayerName;
2478 QDomElement currentLayerElem;
2479 QDomNodeList layerNodeList = infoDocElement.elementsByTagName( QStringLiteral( "Layer" ) );
2480 for ( int i = 0; i < layerNodeList.size(); ++i )
2481 {
2482 currentLayerElem = layerNodeList.at( i ).toElement();
2483 currentLayerName = currentLayerElem.attribute( QStringLiteral( "name" ) );
2484
2485 QDomElement currentFeatureElem;
2486
2487 QDomNodeList featureList = currentLayerElem.elementsByTagName( QStringLiteral( "Feature" ) );
2488 if ( featureList.isEmpty() )
2489 {
2490 //raster?
2491 QDomNodeList attributeList = currentLayerElem.elementsByTagName( QStringLiteral( "Attribute" ) );
2492 QDomElement rasterLayerElem;
2493 if ( !attributeList.isEmpty() )
2494 {
2495 rasterLayerElem = SIAInfoDoc.createElement( currentLayerName );
2496 }
2497 for ( int j = 0; j < attributeList.size(); ++j )
2498 {
2499 currentAttributeElem = attributeList.at( j ).toElement();
2500 currentAttributeName = currentAttributeElem.attribute( QStringLiteral( "name" ) );
2501 currentAttributeValue = currentAttributeElem.attribute( QStringLiteral( "value" ) );
2502 QDomElement outAttributeElem = SIAInfoDoc.createElement( currentAttributeName );
2503 QDomText outAttributeText = SIAInfoDoc.createTextNode( currentAttributeValue );
2504 outAttributeElem.appendChild( outAttributeText );
2505 rasterLayerElem.appendChild( outAttributeElem );
2506 }
2507 if ( !attributeList.isEmpty() )
2508 {
2509 SIAInfoDocElement.appendChild( rasterLayerElem );
2510 }
2511 }
2512 else //vector
2513 {
2514 //property attributes
2515 QSet<QString> layerPropertyAttributes;
2516 QString currentLayerId = currentLayerElem.attribute( QStringLiteral( "id" ) );
2517 if ( !currentLayerId.isEmpty() )
2518 {
2519 QgsMapLayer *currentLayer = mProject->mapLayer( currentLayerId );
2520 if ( currentLayer )
2521 {
2522 QString WMSPropertyAttributesString = currentLayer->customProperty( QStringLiteral( "WMSPropertyAttributes" ) ).toString();
2523 if ( !WMSPropertyAttributesString.isEmpty() )
2524 {
2525 QStringList propertyList = WMSPropertyAttributesString.split( QStringLiteral( "//" ) );
2526 for ( auto propertyIt = propertyList.constBegin(); propertyIt != propertyList.constEnd(); ++propertyIt )
2527 {
2528 layerPropertyAttributes.insert( *propertyIt );
2529 }
2530 }
2531 }
2532 }
2533
2534 QDomElement propertyRefChild; //child to insert the next property after (or
2535 for ( int j = 0; j < featureList.size(); ++j )
2536 {
2537 QDomElement SIAFeatureElem = SIAInfoDoc.createElement( currentLayerName );
2538 currentFeatureElem = featureList.at( j ).toElement();
2539 QDomNodeList attributeList = currentFeatureElem.elementsByTagName( QStringLiteral( "Attribute" ) );
2540
2541 for ( int k = 0; k < attributeList.size(); ++k )
2542 {
2543 currentAttributeElem = attributeList.at( k ).toElement();
2544 currentAttributeName = currentAttributeElem.attribute( QStringLiteral( "name" ) );
2545 currentAttributeValue = currentAttributeElem.attribute( QStringLiteral( "value" ) );
2546 if ( layerPropertyAttributes.contains( currentAttributeName ) )
2547 {
2548 QDomElement propertyElem = SIAInfoDoc.createElement( QStringLiteral( "property" ) );
2549 QDomElement identifierElem = SIAInfoDoc.createElement( QStringLiteral( "identifier" ) );
2550 QDomText identifierText = SIAInfoDoc.createTextNode( currentAttributeName );
2551 identifierElem.appendChild( identifierText );
2552 QDomElement valueElem = SIAInfoDoc.createElement( QStringLiteral( "value" ) );
2553 QDomText valueText = SIAInfoDoc.createTextNode( currentAttributeValue );
2554 valueElem.appendChild( valueText );
2555 propertyElem.appendChild( identifierElem );
2556 propertyElem.appendChild( valueElem );
2557 if ( propertyRefChild.isNull() )
2558 {
2559 SIAFeatureElem.insertBefore( propertyElem, QDomNode() );
2560 propertyRefChild = propertyElem;
2561 }
2562 else
2563 {
2564 SIAFeatureElem.insertAfter( propertyElem, propertyRefChild );
2565 }
2566 }
2567 else
2568 {
2569 QDomElement SIAAttributeElem = SIAInfoDoc.createElement( currentAttributeName );
2570 QDomText SIAAttributeText = SIAInfoDoc.createTextNode( currentAttributeValue );
2571 SIAAttributeElem.appendChild( SIAAttributeText );
2572 SIAFeatureElem.appendChild( SIAAttributeElem );
2573 }
2574 }
2575 SIAInfoDocElement.appendChild( SIAFeatureElem );
2576 }
2577 }
2578 }
2579 doc = SIAInfoDoc;
2580 }
2581
2582 QByteArray QgsRenderer::convertFeatureInfoToHtml( const QDomDocument &doc ) const
2583 {
2584 const bool onlyMapTip = mWmsParameters.htmlInfoOnlyMapTip();
2585 QString featureInfoString = QStringLiteral( " <!DOCTYPE html>" );
2586 if ( !onlyMapTip )
2587 {
2588 featureInfoString.append( QStringLiteral( R"HTML(
2589
2590 <head>
2591 <title>Information</title>
2592 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
2593 <style>
2594 body {
2595 font-family: "Open Sans", "Calluna Sans", "Gill Sans MT", "Calibri", "Trebuchet MS", sans-serif;
2596 }
2597
2598 table,
2599 th,
2600 td {
2601 width: 100%;
2602 border: 1px solid black;
2603 border-collapse: collapse;
2604 text-align: left;
2605 padding: 2px;
2606 }
2607
2608 th {
2609 width: 25%;
2610 font-weight: bold;
2611 }
2612
2613 .layer-title {
2614 font-weight: bold;
2615 padding: 2px;
2616 }
2617 </style>
2618 </head>
2619
2620 <body>
2621 )HTML" ) );
2622 }
2623
2624 const QDomNodeList layerList = doc.elementsByTagName( QStringLiteral( "Layer" ) );
2625
2626 //layer loop
2627 for ( int i = 0; i < layerList.size(); ++i )
2628 {
2629 const QDomElement layerElem = layerList.at( i ).toElement();
2630
2631 //feature loop (for vector layers)
2632 const QDomNodeList featureNodeList = layerElem.elementsByTagName( QStringLiteral( "Feature" ) );
2633 const QDomElement currentFeatureElement;
2634
2635 if ( !featureNodeList.isEmpty() ) //vector layer
2636 {
2637 if ( !onlyMapTip )
2638 {
2639 const QString featureInfoLayerTitleString = QStringLiteral( " <div class='layer-title'>%1</div>" ).arg( layerElem.attribute( QStringLiteral( "title" ) ).toHtmlEscaped() );
2640 featureInfoString.append( featureInfoLayerTitleString );
2641 }
2642
2643 for ( int j = 0; j < featureNodeList.size(); ++j )
2644 {
2645 const QDomElement featureElement = featureNodeList.at( j ).toElement();
2646 if ( !onlyMapTip )
2647 {
2648 featureInfoString.append( QStringLiteral( R"HTML(
2649 <table>)HTML" ) );
2650 }
2651
2652 //attribute loop
2653 const QDomNodeList attributeNodeList = featureElement.elementsByTagName( QStringLiteral( "Attribute" ) );
2654 for ( int k = 0; k < attributeNodeList.size(); ++k )
2655 {
2656 const QDomElement attributeElement = attributeNodeList.at( k ).toElement();
2657 const QString name = attributeElement.attribute( QStringLiteral( "name" ) ).toHtmlEscaped();
2658 QString value = attributeElement.attribute( QStringLiteral( "value" ) );
2659 if ( name != QLatin1String( "maptip" ) )
2660 {
2661 value = value.toHtmlEscaped();
2662 }
2663
2664 if ( !onlyMapTip )
2665 {
2666 const QString featureInfoAttributeString = QStringLiteral( R"HTML(
2667 <tr>
2668 <th>%1</th>
2669 <td>%2</td>
2670 </tr>)HTML" )
2671 .arg( name, value );
2672
2673 featureInfoString.append( featureInfoAttributeString );
2674 }
2675 else if ( name == QLatin1String( "maptip" ) )
2676 {
2677 featureInfoString.append( QStringLiteral( R"HTML(
2678 %1)HTML" )
2679 .arg( value ) );
2680 break;
2681 }
2682 }
2683 if ( !onlyMapTip )
2684 {
2685 featureInfoString.append( QStringLiteral( R"HTML(
2686 </table>)HTML" ) );
2687 }
2688 }
2689 }
2690 else //no result or raster layer
2691 {
2692 const QDomNodeList attributeNodeList = layerElem.elementsByTagName( QStringLiteral( "Attribute" ) );
2693
2694 // raster layer
2695 if ( !attributeNodeList.isEmpty() )
2696 {
2697 if ( !onlyMapTip )
2698 {
2699 const QString featureInfoLayerTitleString = QStringLiteral( " <div class='layer-title'>%1</div>" ).arg( layerElem.attribute( QStringLiteral( "title" ) ).toHtmlEscaped() );
2700 featureInfoString.append( featureInfoLayerTitleString );
2701
2702 featureInfoString.append( QStringLiteral( R"HTML(
2703 <table>)HTML" ) );
2704 }
2705
2706 for ( int j = 0; j < attributeNodeList.size(); ++j )
2707 {
2708 const QDomElement attributeElement = attributeNodeList.at( j ).toElement();
2709 const QString name = attributeElement.attribute( QStringLiteral( "name" ) ).toHtmlEscaped();
2710 QString value = attributeElement.attribute( QStringLiteral( "value" ) );
2711 if ( value.isEmpty() )
2712 {
2713 value = QStringLiteral( "no data" );
2714 }
2715 if ( name != QLatin1String( "maptip" ) )
2716 {
2717 value = value.toHtmlEscaped();
2718 }
2719
2720 if ( !onlyMapTip )
2721 {
2722 const QString featureInfoAttributeString = QStringLiteral( R"HTML(
2723 <tr>
2724 <th>%1</th>
2725 <td>%2</td>
2726 </tr>)HTML" )
2727 .arg( name, value );
2728
2729
2730 featureInfoString.append( featureInfoAttributeString );
2731 }
2732 else if ( name == QLatin1String( "maptip" ) )
2733 {
2734 featureInfoString.append( QStringLiteral( R"HTML(
2735 %1)HTML" )
2736 .arg( value ) );
2737 break;
2738 }
2739 }
2740 if ( !onlyMapTip )
2741 {
2742 featureInfoString.append( QStringLiteral( R"HTML(
2743 </table>)HTML" ) );
2744 }
2745 }
2746 }
2747 }
2748
2749 //end the html body
2750 if ( !onlyMapTip )
2751 {
2752 featureInfoString.append( QStringLiteral( R"HTML(
2753 </body>)HTML" ) );
2754 }
2755
2756 return featureInfoString.toUtf8();
2757 }
2758
2759 QByteArray QgsRenderer::convertFeatureInfoToText( const QDomDocument &doc ) const
2760 {
2761 QString featureInfoString;
2762
2763 //the Text head
2764 featureInfoString.append( "GetFeatureInfo results\n" );
2765 featureInfoString.append( "\n" );
2766
2767 QDomNodeList layerList = doc.elementsByTagName( QStringLiteral( "Layer" ) );
2768
2769 //layer loop
2770 for ( int i = 0; i < layerList.size(); ++i )
2771 {
2772 QDomElement layerElem = layerList.at( i ).toElement();
2773
2774 featureInfoString.append( "Layer '" + layerElem.attribute( QStringLiteral( "name" ) ) + "'\n" );
2775
2776 //feature loop (for vector layers)
2777 QDomNodeList featureNodeList = layerElem.elementsByTagName( QStringLiteral( "Feature" ) );
2778 QDomElement currentFeatureElement;
2779
2780 if ( !featureNodeList.isEmpty() ) //vector layer
2781 {
2782 for ( int j = 0; j < featureNodeList.size(); ++j )
2783 {
2784 QDomElement featureElement = featureNodeList.at( j ).toElement();
2785 featureInfoString.append( "Feature " + featureElement.attribute( QStringLiteral( "id" ) ) + "\n" );
2786
2787 //attribute loop
2788 QDomNodeList attributeNodeList = featureElement.elementsByTagName( QStringLiteral( "Attribute" ) );
2789 for ( int k = 0; k < attributeNodeList.size(); ++k )
2790 {
2791 QDomElement attributeElement = attributeNodeList.at( k ).toElement();
2792 featureInfoString.append( attributeElement.attribute( QStringLiteral( "name" ) ) + " = '" + attributeElement.attribute( QStringLiteral( "value" ) ) + "'\n" );
2793 }
2794 }
2795 }
2796 else //raster layer
2797 {
2798 QDomNodeList attributeNodeList = layerElem.elementsByTagName( QStringLiteral( "Attribute" ) );
2799 for ( int j = 0; j < attributeNodeList.size(); ++j )
2800 {
2801 QDomElement attributeElement = attributeNodeList.at( j ).toElement();
2802 QString value = attributeElement.attribute( QStringLiteral( "value" ) );
2803 if ( value.isEmpty() )
2804 {
2805 value = QStringLiteral( "no data" );
2806 }
2807 featureInfoString.append( attributeElement.attribute( QStringLiteral( "name" ) ) + " = '" + value + "'\n" );
2808 }
2809 }
2810
2811 featureInfoString.append( "\n" );
2812 }
2813
2814 return featureInfoString.toUtf8();
2815 }
2816
2817 QByteArray QgsRenderer::convertFeatureInfoToJson( const QList<QgsMapLayer *> &layers, const QDomDocument &doc, const QgsCoordinateReferenceSystem &destCRS ) const
2818 {
2819 json json {
2820 { "type", "FeatureCollection" },
2821 { "features", json::array() },
2822 };
2823 const bool withGeometry = ( QgsServerProjectUtils::wmsFeatureInfoAddWktGeometry( *mProject ) && mWmsParameters.withGeometry() );
2824 const bool withDisplayName = mWmsParameters.withDisplayName();
2825
2826 const QDomNodeList layerList = doc.elementsByTagName( QStringLiteral( "Layer" ) );
2827 for ( int i = 0; i < layerList.size(); ++i )
2828 {
2829 const QDomElement layerElem = layerList.at( i ).toElement();
2830 const QString layerName = layerElem.attribute( QStringLiteral( "name" ) );
2831
2832 QgsMapLayer *layer = nullptr;
2833 for ( QgsMapLayer *l : layers )
2834 {
2835 if ( mContext.layerNickname( *l ).compare( layerName ) == 0 )
2836 {
2837 layer = l;
2838 }
2839 }
2840
2841 if ( !layer )
2842 continue;
2843
2844 if ( layer->type() == Qgis::LayerType::Vector )
2845 {
2846 QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer );
2847
2848 // search features to export
2849 QgsFeatureList features;
2850 QgsAttributeList attributes;
2851 const QDomNodeList featuresNode = layerElem.elementsByTagName( QStringLiteral( "Feature" ) );
2852 if ( featuresNode.isEmpty() )
2853 continue;
2854
2855 QMap<QgsFeatureId, QString> fidMap;
2856 QMap<QgsFeatureId, QString> fidDisplayNameMap;
2857
2858 for ( int j = 0; j < featuresNode.size(); ++j )
2859 {
2860 const QDomElement featureNode = featuresNode.at( j ).toElement();
2861 const QString fid = featureNode.attribute( QStringLiteral( "id" ) );
2862 QgsFeature feature;
2863 const QString expression { QgsServerFeatureId::getExpressionFromServerFid( fid, static_cast<QgsVectorDataProvider *>( layer->dataProvider() ) ) };
2864 if ( expression.isEmpty() )
2865 {
2866 feature = vl->getFeature( fid.toLongLong() );
2867 }
2868 else
2869 {
2870 QgsFeatureRequest request { QgsExpression( expression ) };
2871 request.setFlags( Qgis::FeatureRequestFlag::NoGeometry );
2872 vl->getFeatures( request ).nextFeature( feature );
2873 }
2874
2875 fidMap.insert( feature.id(), fid );
2876
2877 QString wkt;
2878 if ( withGeometry )
2879 {
2880 const QDomNodeList attrs = featureNode.elementsByTagName( "Attribute" );
2881 for ( int k = 0; k < attrs.count(); k++ )
2882 {
2883 const QDomElement elm = attrs.at( k ).toElement();
2884 if ( elm.attribute( QStringLiteral( "name" ) ).compare( "geometry" ) == 0 )
2885 {
2886 wkt = elm.attribute( "value" );
2887 break;
2888 }
2889 }
2890
2891 if ( !wkt.isEmpty() )
2892 {
2893 // CRS in WMS parameters may be different from the layer
2894 feature.setGeometry( QgsGeometry::fromWkt( wkt ) );
2895 }
2896 }
2897
2898 // Note: this is the feature expression display name, not the field alias
2899 if ( withDisplayName )
2900 {
2901 QString displayName;
2902 const QDomNodeList attrs = featureNode.elementsByTagName( "Attribute" );
2903 for ( int k = 0; k < attrs.count(); k++ )
2904 {
2905 const QDomElement elm = attrs.at( k ).toElement();
2906 if ( elm.attribute( QStringLiteral( "name" ) ).compare( "displayName" ) == 0 )
2907 {
2908 displayName = elm.attribute( "value" );
2909 break;
2910 }
2911 }
2912 fidDisplayNameMap.insert( feature.id(), displayName );
2913 }
2914
2915 features << feature;
2916
2917 // search attributes to export (one time only)
2918 if ( !attributes.isEmpty() )
2919 continue;
2920
2921 const QDomNodeList attributesNode = featureNode.elementsByTagName( QStringLiteral( "Attribute" ) );
2922 for ( int k = 0; k < attributesNode.size(); ++k )
2923 {
2924 const QDomElement attributeElement = attributesNode.at( k ).toElement();
2925 const QString fieldName = attributeElement.attribute( QStringLiteral( "name" ) );
2926 attributes << feature.fieldNameIndex( fieldName );
2927 }
2928 }
2929
2930 // export
2931 QgsJsonExporter exporter( vl );
2932 exporter.setAttributeDisplayName( true );
2933 exporter.setAttributes( attributes );
2934 exporter.setIncludeGeometry( withGeometry );
2935 exporter.setTransformGeometries( false );
2936
2937 QgsJsonUtils::addCrsInfo( json, destCRS );
2938
2939 for ( const auto &feature : std::as_const( features ) )
2940 {
2941 const QString id = QStringLiteral( "%1.%2" ).arg( layerName ).arg( fidMap.value( feature.id() ) );
2942 QVariantMap extraProperties;
2943 if ( withDisplayName )
2944 {
2945 extraProperties.insert( QStringLiteral( "display_name" ), fidDisplayNameMap.value( feature.id() ) );
2946 }
2947 json["features"].push_back( exporter.exportFeatureToJsonObject( feature, extraProperties, id ) );
2948 }
2949 }
2950 else // raster layer
2951 {
2952 auto properties = json::object();
2953 const QDomNodeList attributesNode = layerElem.elementsByTagName( QStringLiteral( "Attribute" ) );
2954 for ( int j = 0; j < attributesNode.size(); ++j )
2955 {
2956 const QDomElement attrElmt = attributesNode.at( j ).toElement();
2957 const QString name = attrElmt.attribute( QStringLiteral( "name" ) );
2958
2959 QString value = attrElmt.attribute( QStringLiteral( "value" ) );
2960 if ( value.isEmpty() )
2961 {
2962 value = QStringLiteral( "null" );
2963 }
2964
2965 properties[name.toStdString()] = value.toStdString();
2966 }
2967
2968 json["features"].push_back(
2969 { { "type", "Feature" },
2970 { "id", layerName.toStdString() },
2971 { "properties", properties }
2972 }
2973 );
2974 }
2975 }
2976#ifdef QGISDEBUG
2977 // This is only useful to generate human readable reference files for tests
2978 return QByteArray::fromStdString( json.dump( 2 ) );
2979#else
2980 return QByteArray::fromStdString( json.dump() );
2981#endif
2982 }
2983
2984 QDomElement QgsRenderer::createFeatureGML(
2985 const QgsFeature *feat,
2986 QgsVectorLayer *layer,
2987 QDomDocument &doc,
2989 const QgsMapSettings &mapSettings,
2990 const QString &typeName,
2991 bool withGeom,
2992 int version,
2993 QStringList *attributes
2994 ) const
2995 {
2996 //qgs:%TYPENAME%
2997 QDomElement typeNameElement = doc.createElement( "qgs:" + typeName /*qgs:%TYPENAME%*/ );
2998 QString fid;
2999 if ( layer && layer->dataProvider() )
3001 else
3002 fid = FID_TO_STRING( feat->id() );
3003
3004 typeNameElement.setAttribute( QStringLiteral( "fid" ), QStringLiteral( "%1.%2" ).arg( typeName, fid ) );
3005
3006 QgsCoordinateTransform transform;
3007 if ( layer && layer->crs() != crs )
3008 {
3009 transform = mapSettings.layerTransform( layer );
3010 }
3011
3012 QgsGeometry geom = feat->geometry();
3013
3014 QgsExpressionContext expressionContext;
3015 expressionContext << QgsExpressionContextUtils::globalScope()
3017 if ( layer )
3018 expressionContext << QgsExpressionContextUtils::layerScope( layer );
3019 expressionContext.setFeature( *feat );
3020
3021 QgsEditFormConfig editConfig { layer ? layer->editFormConfig() : QgsEditFormConfig() };
3022 const bool honorFormConfig { layer && QgsServerProjectUtils::wmsFeatureInfoUseAttributeFormSettings( *mProject ) && editConfig.layout() == Qgis::AttributeFormLayout::DragAndDrop };
3023
3024 // always add bounding box info if feature contains geometry and has been
3025 // explicitly configured in the project
3027 {
3028 QgsRectangle box = feat->geometry().boundingBox();
3029 if ( transform.isValid() )
3030 {
3031 try
3032 {
3033 box = transform.transformBoundingBox( box );
3034 }
3035 catch ( QgsCsException &e )
3036 {
3037 QgsMessageLog::logMessage( QStringLiteral( "Transform error caught: %1" ).arg( e.what() ) );
3038 }
3039 }
3040
3041 QDomElement bbElem = doc.createElement( QStringLiteral( "gml:boundedBy" ) );
3042 QDomElement boxElem;
3043 if ( version < 3 )
3044 {
3045 boxElem = QgsOgcUtils::rectangleToGMLBox( &box, doc, mContext.precision() );
3046 }
3047 else
3048 {
3049 boxElem = QgsOgcUtils::rectangleToGMLEnvelope( &box, doc, mContext.precision() );
3050 }
3051
3052 if ( crs.isValid() )
3053 {
3054 boxElem.setAttribute( QStringLiteral( "srsName" ), crs.authid() );
3055 }
3056 bbElem.appendChild( boxElem );
3057 typeNameElement.appendChild( bbElem );
3058 }
3059
3060 // find if an attribute is in any form tab
3061 std::function<bool( const QString &, const QgsAttributeEditorElement * )> findAttributeInTree;
3062 findAttributeInTree = [&findAttributeInTree, &layer]( const QString &attributeName, const QgsAttributeEditorElement *group ) -> bool {
3063 const QgsAttributeEditorContainer *container = dynamic_cast<const QgsAttributeEditorContainer *>( group );
3064 if ( container )
3065 {
3066 const QList<QgsAttributeEditorElement *> children = container->children();
3067 for ( const QgsAttributeEditorElement *child : children )
3068 {
3069 switch ( child->type() )
3070 {
3072 {
3073 if ( findAttributeInTree( attributeName, child ) )
3074 {
3075 return true;
3076 }
3077 break;
3078 }
3080 {
3081 if ( child->name() == attributeName )
3082 {
3083 return true;
3084 }
3085 break;
3086 }
3088 {
3089 const QgsAttributeEditorRelation *relationEditor = static_cast<const QgsAttributeEditorRelation *>( child );
3090 if ( relationEditor )
3091 {
3092 const QgsRelation &relation { relationEditor->relation() };
3093 if ( relation.referencedLayer() == layer )
3094 {
3095 const QgsAttributeList &referencedFields { relation.referencedFields() };
3096 for ( const auto &idx : std::as_const( referencedFields ) )
3097 {
3098 const QgsField f { layer->fields().at( idx ) };
3099 if ( f.name() == attributeName )
3100 {
3101 return true;
3102 }
3103 }
3104 }
3105 else if ( relation.referencingLayer() == layer )
3106 {
3107 const QgsAttributeList &referencingFields { relation.referencingFields() };
3108 for ( const auto &idx : std::as_const( referencingFields ) )
3109 {
3110 const QgsField f { layer->fields().at( idx ) };
3111 if ( f.name() == attributeName )
3112 {
3113 return true;
3114 }
3115 }
3116 }
3117 }
3118 break;
3119 }
3120 default:
3121 break;
3122 }
3123 }
3124 }
3125 return false;
3126 };
3127
3128 if ( withGeom && !geom.isNull() )
3129 {
3130 //add geometry column (as gml)
3131
3132 if ( transform.isValid() )
3133 {
3134 geom.transform( transform );
3135 }
3136
3137 QDomElement geomElem = doc.createElement( QStringLiteral( "qgs:geometry" ) );
3138 QDomElement gmlElem;
3139 if ( version < 3 )
3140 {
3141 gmlElem = QgsOgcUtils::geometryToGML( geom, doc, mContext.precision() );
3142 }
3143 else
3144 {
3145 gmlElem = QgsOgcUtils::geometryToGML( geom, doc, QStringLiteral( "GML3" ), mContext.precision() );
3146 }
3147
3148 if ( !gmlElem.isNull() )
3149 {
3150 if ( crs.isValid() )
3151 {
3152 gmlElem.setAttribute( QStringLiteral( "srsName" ), crs.authid() );
3153 }
3154 geomElem.appendChild( gmlElem );
3155 typeNameElement.appendChild( geomElem );
3156 }
3157 }
3158
3159 //read all allowed attribute values from the feature
3160 QgsAttributes featureAttributes = feat->attributes();
3161 QgsFields fields = feat->fields();
3162 for ( int i = 0; i < fields.count(); ++i )
3163 {
3164 QString attributeName = fields.at( i ).name();
3165 //skip attribute if it is explicitly excluded from WMS publication
3166 if ( fields.at( i ).configurationFlags().testFlag( Qgis::FieldConfigurationFlag::HideFromWms ) )
3167 {
3168 continue;
3169 }
3170 //skip attribute if it is excluded by access control
3171 if ( attributes && !attributes->contains( attributeName ) )
3172 {
3173 continue;
3174 }
3175
3176 if ( honorFormConfig )
3177 {
3178 const QgsAttributeEditorContainer *editorContainer = editConfig.invisibleRootContainer();
3179 if ( !editorContainer || !findAttributeInTree( attributeName, editorContainer ) )
3180 {
3181 continue;
3182 }
3183 }
3184
3185 QDomElement fieldElem = doc.createElement( "qgs:" + attributeName.replace( ' ', '_' ) );
3186 QString fieldTextString = featureAttributes.at( i ).toString();
3187 if ( layer )
3188 {
3189 fieldTextString = QgsExpression::replaceExpressionText( replaceValueMapAndRelation( layer, i, fieldTextString ), &expressionContext );
3190 }
3191 QDomText fieldText = doc.createTextNode( fieldTextString );
3192 fieldElem.appendChild( fieldText );
3193 typeNameElement.appendChild( fieldElem );
3194 }
3195
3196 //add maptip attribute based on html/expression (in case there is no maptip attribute)
3197 if ( layer )
3198 {
3199 QString mapTip = layer->mapTipTemplate();
3200
3201 if ( !mapTip.isEmpty() && ( mWmsParameters.withMapTip() || mWmsParameters.htmlInfoOnlyMapTip() ) )
3202 {
3203 QString fieldTextString = QgsExpression::replaceExpressionText( mapTip, &expressionContext );
3204 QDomElement fieldElem = doc.createElement( QStringLiteral( "qgs:maptip" ) );
3205 QDomText maptipText = doc.createTextNode( fieldTextString );
3206 fieldElem.appendChild( maptipText );
3207 typeNameElement.appendChild( fieldElem );
3208 }
3209 }
3210
3211 return typeNameElement;
3212 }
3213
3214 QString QgsRenderer::replaceValueMapAndRelation( QgsVectorLayer *vl, int idx, const QVariant &attributeVal )
3215 {
3216 const QgsEditorWidgetSetup setup = vl->editorWidgetSetup( idx );
3218 QString value( fieldFormatter->representValue( vl, idx, setup.config(), QVariant(), attributeVal ) );
3219
3220 if ( setup.config().value( QStringLiteral( "AllowMulti" ) ).toBool() && value.startsWith( QLatin1Char( '{' ) ) && value.endsWith( QLatin1Char( '}' ) ) )
3221 {
3222 value = value.mid( 1, value.size() - 2 );
3223 }
3224 return value;
3225 }
3226
3227 QgsRectangle QgsRenderer::featureInfoSearchRect( QgsVectorLayer *ml, const QgsMapSettings &mapSettings, const QgsRenderContext &rct, const QgsPointXY &infoPoint ) const
3228 {
3229 if ( !ml )
3230 {
3231 return QgsRectangle();
3232 }
3233
3234 double mapUnitTolerance = 0.0;
3236 {
3237 if ( !mWmsParameters.polygonTolerance().isEmpty()
3238 && mWmsParameters.polygonToleranceAsInt() > 0 )
3239 {
3240 mapUnitTolerance = mWmsParameters.polygonToleranceAsInt() * rct.mapToPixel().mapUnitsPerPixel();
3241 }
3242 else
3243 {
3244 mapUnitTolerance = mapSettings.extent().width() / 400.0;
3245 }
3246 }
3247 else if ( ml->geometryType() == Qgis::GeometryType::Line )
3248 {
3249 if ( !mWmsParameters.lineTolerance().isEmpty()
3250 && mWmsParameters.lineToleranceAsInt() > 0 )
3251 {
3252 mapUnitTolerance = mWmsParameters.lineToleranceAsInt() * rct.mapToPixel().mapUnitsPerPixel();
3253 }
3254 else
3255 {
3256 mapUnitTolerance = mapSettings.extent().width() / 200.0;
3257 }
3258 }
3259 else //points
3260 {
3261 if ( !mWmsParameters.pointTolerance().isEmpty()
3262 && mWmsParameters.pointToleranceAsInt() > 0 )
3263 {
3264 mapUnitTolerance = mWmsParameters.pointToleranceAsInt() * rct.mapToPixel().mapUnitsPerPixel();
3265 }
3266 else
3267 {
3268 mapUnitTolerance = mapSettings.extent().width() / 100.0;
3269 }
3270 }
3271
3272 // Make sure the map unit tolerance is at least 1 pixel
3273 mapUnitTolerance = std::max( mapUnitTolerance, 1.0 * rct.mapToPixel().mapUnitsPerPixel() );
3274
3275 QgsRectangle mapRectangle( infoPoint.x() - mapUnitTolerance, infoPoint.y() - mapUnitTolerance, infoPoint.x() + mapUnitTolerance, infoPoint.y() + mapUnitTolerance );
3276 return ( mapSettings.mapToLayerCoordinates( ml, mapRectangle ) );
3277 }
3278
3279 QList<QgsMapLayer *> QgsRenderer::highlightLayers( QList<QgsWmsParametersHighlightLayer> params )
3280 {
3281 QList<QgsMapLayer *> highlightLayers;
3282
3283 // try to create highlight layer for each geometry
3284 QString crs = mWmsParameters.crs();
3285 for ( const QgsWmsParametersHighlightLayer &param : params )
3286 {
3287 // create sld document from symbology
3288 QDomDocument sldDoc;
3289 QString errorMsg;
3290 int errorLine;
3291 int errorColumn;
3292 if ( !sldDoc.setContent( param.mSld, true, &errorMsg, &errorLine, &errorColumn ) )
3293 {
3294 QgsMessageLog::logMessage( QStringLiteral( "Error parsing SLD for layer %1 at line %2, column %3:\n%4" ).arg( param.mName ).arg( errorLine ).arg( errorColumn ).arg( errorMsg ), QStringLiteral( "Server" ), Qgis::MessageLevel::Warning );
3295 continue;
3296 }
3297
3298 // create renderer from sld document
3299 std::unique_ptr<QgsFeatureRenderer> renderer;
3300 QDomElement el = sldDoc.documentElement();
3301 renderer.reset( QgsFeatureRenderer::loadSld( el, param.mGeom.type(), errorMsg ) );
3302 if ( !renderer )
3303 {
3305 continue;
3306 }
3307
3308 // build url for vector layer
3309 const QString typeName = QgsWkbTypes::displayString( param.mGeom.wkbType() );
3310 QString url = typeName + "?crs=" + crs;
3311 if ( !param.mLabel.isEmpty() )
3312 {
3313 url += "&field=label:string";
3314 }
3315
3316 // create vector layer
3318 auto layer = std::make_unique<QgsVectorLayer>( url, param.mName, QLatin1String( "memory" ), options );
3319 if ( !layer->isValid() )
3320 {
3321 continue;
3322 }
3323
3324 // create feature with label if necessary
3325 QgsFeature fet( layer->fields() );
3326 if ( !param.mLabel.isEmpty() )
3327 {
3328 fet.setAttribute( 0, param.mLabel );
3329
3330 // init labeling engine
3331 QgsPalLayerSettings palSettings;
3332 palSettings.fieldName = "label"; // defined in url
3333 palSettings.priority = 10; // always drawn
3335 palSettings.placementSettings().setAllowDegradedPlacement( true );
3336 palSettings.dist = param.mLabelDistance;
3337
3338 if ( !qgsDoubleNear( param.mLabelRotation, 0 ) )
3339 {
3341 palSettings.dataDefinedProperties().setProperty( pR, param.mLabelRotation );
3342 }
3343
3345 switch ( param.mGeom.type() )
3346 {
3348 {
3349 if ( param.mHali.isEmpty() || param.mVali.isEmpty() || QgsWkbTypes::flatType( param.mGeom.wkbType() ) != Qgis::WkbType::Point )
3350 {
3353 }
3354 else //set label directly on point if there is hali/vali
3355 {
3356 QgsPointXY pt = param.mGeom.asPoint();
3358 QVariant x( pt.x() );
3359 palSettings.dataDefinedProperties().setProperty( pX, x );
3361 QVariant y( pt.y() );
3362 palSettings.dataDefinedProperties().setProperty( pY, y );
3364 palSettings.dataDefinedProperties().setProperty( pHali, param.mHali );
3366 palSettings.dataDefinedProperties().setProperty( pVali, param.mVali );
3367 }
3368
3369 break;
3370 }
3372 {
3373 QgsGeometry point = param.mGeom.pointOnSurface();
3374 QgsPointXY pt = point.asPoint();
3376
3378 QVariant x( pt.x() );
3379 palSettings.dataDefinedProperties().setProperty( pX, x );
3380
3382 QVariant y( pt.y() );
3383 palSettings.dataDefinedProperties().setProperty( pY, y );
3384
3386 QVariant hali( "Center" );
3387 palSettings.dataDefinedProperties().setProperty( pHali, hali );
3388
3390 QVariant vali( "Half" );
3391 palSettings.dataDefinedProperties().setProperty( pVali, vali );
3392 break;
3393 }
3394 default:
3395 {
3396 placement = Qgis::LabelPlacement::Line;
3398 break;
3399 }
3400 }
3401 palSettings.placement = placement;
3402 QgsTextFormat textFormat;
3403 QgsTextBufferSettings bufferSettings;
3404
3405 if ( param.mColor.isValid() )
3406 {
3407 textFormat.setColor( param.mColor );
3408 }
3409
3410 if ( param.mSize > 0 )
3411 {
3412 textFormat.setSize( param.mSize );
3413 }
3414
3415 // no weight property in PAL settings or QgsTextFormat
3416 /* if ( param.fontWeight > 0 )
3417 {
3418 } */
3419
3420 if ( !param.mFont.isEmpty() )
3421 {
3422 textFormat.setFont( param.mFont );
3423 }
3424
3425 if ( param.mBufferColor.isValid() )
3426 {
3427 bufferSettings.setColor( param.mBufferColor );
3428 }
3429
3430 if ( param.mBufferSize > 0 )
3431 {
3432 bufferSettings.setEnabled( true );
3433 bufferSettings.setSize( static_cast<double>( param.mBufferSize ) );
3434 }
3435
3436 textFormat.setBuffer( bufferSettings );
3437 palSettings.setFormat( textFormat );
3438
3439 QgsVectorLayerSimpleLabeling *simpleLabeling = new QgsVectorLayerSimpleLabeling( palSettings );
3440 layer->setLabeling( simpleLabeling );
3441 layer->setLabelsEnabled( true );
3442 }
3443 fet.setGeometry( param.mGeom );
3444
3445 // add feature to layer and set the SLD renderer
3446 layer->dataProvider()->addFeatures( QgsFeatureList() << fet );
3447 layer->setRenderer( renderer.release() );
3448
3449 // keep the vector as an highlight layer
3450 if ( layer->isValid() )
3451 {
3452 highlightLayers.append( layer.release() );
3453 }
3454 }
3455
3456 mTemporaryLayers.append( highlightLayers );
3457 return highlightLayers;
3458 }
3459
3460 void QgsRenderer::removeTemporaryLayers()
3461 {
3462 qDeleteAll( mTemporaryLayers );
3463 mTemporaryLayers.clear();
3464 }
3465
3466 QPainter *QgsRenderer::layersRendering( const QgsMapSettings &mapSettings, QImage *image ) const
3467 {
3468 QPainter *painter = nullptr;
3469
3471 filters.addProvider( &mFeatureFilter );
3472#ifdef HAVE_SERVER_PYTHON_PLUGINS
3473 mContext.accessControl()->resolveFilterFeatures( mapSettings.layers() );
3474 filters.addProvider( mContext.accessControl() );
3475#endif
3476 QgsMapRendererJobProxy renderJob( mContext.settings().parallelRendering(), mContext.settings().maxThreads(), &filters );
3477
3478 renderJob.render( mapSettings, image, mContext.socketFeedback() );
3479 painter = renderJob.takePainter();
3480
3481 if ( !renderJob.errors().isEmpty() )
3482 {
3483 const QgsMapRendererJob::Error e = renderJob.errors().at( 0 );
3484
3485 QString layerWMSName;
3486 QgsMapLayer *errorLayer = mProject->mapLayer( e.layerID );
3487 if ( errorLayer )
3488 {
3489 layerWMSName = mContext.layerNickname( *errorLayer );
3490 }
3491
3492 QString errorMessage = QStringLiteral( "Rendering error : '%1'" ).arg( e.message );
3493 if ( !layerWMSName.isEmpty() )
3494 {
3495 errorMessage = QStringLiteral( "Rendering error : '%1' in layer '%2'" ).arg( e.message, layerWMSName );
3496 }
3497 throw QgsException( errorMessage );
3498 }
3499
3500 return painter;
3501 }
3502
3503 void QgsRenderer::setLayerOpacity( QgsMapLayer *layer, int opacity ) const
3504 {
3505 if ( opacity >= 0 && opacity <= 255 )
3506 {
3507 switch ( layer->type() )
3508 {
3510 {
3511 QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer );
3512 vl->setOpacity( opacity / 255. );
3513 // Labeling
3514 if ( vl->labelsEnabled() && vl->labeling() )
3515 {
3516 QgsAbstractVectorLayerLabeling *labeling { vl->labeling() };
3517 labeling->multiplyOpacity( opacity / 255. );
3518 }
3519 break;
3520 }
3521
3523 {
3524 QgsRasterLayer *rl = qobject_cast<QgsRasterLayer *>( layer );
3525 QgsRasterRenderer *rasterRenderer = rl->renderer();
3526 rasterRenderer->setOpacity( opacity / 255. );
3527 break;
3528 }
3529
3531 {
3532 QgsVectorTileLayer *vl = qobject_cast<QgsVectorTileLayer *>( layer );
3533 vl->setOpacity( opacity / 255. );
3534 break;
3535 }
3536
3543 break;
3544 }
3545 }
3546 }
3547
3548 void QgsRenderer::setLayerFilter( QgsMapLayer *layer, const QList<QgsWmsParametersFilter> &filters )
3549 {
3550 if ( layer->type() == Qgis::LayerType::Vector )
3551 {
3552 QgsVectorLayer *filteredLayer = qobject_cast<QgsVectorLayer *>( layer );
3553 QStringList expList;
3554 for ( const QgsWmsParametersFilter &filter : filters )
3555 {
3556 if ( filter.mType == QgsWmsParametersFilter::OGC_FE )
3557 {
3558 // OGC filter
3559 QDomDocument filterXml;
3560 QString errorMsg;
3561 if ( !filterXml.setContent( filter.mFilter, true, &errorMsg ) )
3562 {
3563 throw QgsBadRequestException( QgsServiceException::QGIS_InvalidParameterValue, QStringLiteral( "Filter string rejected. Error message: %1. The XML string was: %2" ).arg( errorMsg, filter.mFilter ) );
3564 }
3565 QDomElement filterElem = filterXml.firstChildElement();
3566 std::unique_ptr<QgsExpression> filterExp( QgsOgcUtils::expressionFromOgcFilter( filterElem, filter.mVersion, filteredLayer ) );
3567
3568 if ( filterExp )
3569 {
3570 expList << filterExp->dump();
3571 }
3572 }
3573 else if ( filter.mType == QgsWmsParametersFilter::SQL )
3574 {
3575 // QGIS (SQL) filter
3576 if ( !testFilterStringSafety( filter.mFilter ) )
3577 {
3578 throw QgsSecurityException( QStringLiteral( "The filter string %1"
3579 " has been rejected because of security reasons."
3580 " Note: Text strings have to be enclosed in single or double quotes."
3581 " A space between each word / special character is mandatory."
3582 " Allowed Keywords and special characters are"
3583 " IS,NOT,NULL,AND,OR,IN,=,<,>=,>,>=,!=,',',(,),DMETAPHONE,SOUNDEX%2."
3584 " Not allowed are semicolons in the filter expression." )
3585 .arg(
3586 filter.mFilter, mContext.settings().allowedExtraSqlTokens().isEmpty() ? QString() : mContext.settings().allowedExtraSqlTokens().join( ',' ).prepend( ',' )
3587 ) );
3588 }
3589
3590 QString newSubsetString = filter.mFilter;
3591 if ( !filteredLayer->subsetString().isEmpty() )
3592 {
3593 newSubsetString.prepend( ") AND (" );
3594 newSubsetString.append( ")" );
3595 newSubsetString.prepend( filteredLayer->subsetString() );
3596 newSubsetString.prepend( "(" );
3597 }
3598 if ( !filteredLayer->setSubsetString( newSubsetString ) )
3599 {
3600 QgsMessageLog::logMessage( QStringLiteral( "Error setting subset string from filter for layer %1, filter: %2" ).arg( layer->name(), newSubsetString ), QStringLiteral( "Server" ), Qgis::MessageLevel::Warning );
3601 throw QgsBadRequestException( QgsServiceException::QGIS_InvalidParameterValue, QStringLiteral( "Filter not valid for layer %1: check the filter syntax and the field names." ).arg( layer->name() ) );
3602 }
3603 }
3604 }
3605
3606 expList.append( dimensionFilter( filteredLayer ) );
3607
3608 // Join and apply expressions provided by OGC filter and Dimensions
3609 QString exp;
3610 if ( expList.size() == 1 )
3611 {
3612 exp = expList[0];
3613 }
3614 else if ( expList.size() > 1 )
3615 {
3616 exp = QStringLiteral( "( %1 )" ).arg( expList.join( QLatin1String( " ) AND ( " ) ) );
3617 }
3618 if ( !exp.isEmpty() )
3619 {
3620 auto expression = std::make_unique<QgsExpression>( exp );
3621 if ( expression )
3622 {
3623 mFeatureFilter.setFilter( filteredLayer, *expression );
3624 }
3625 }
3626 }
3627 }
3628
3629 QStringList QgsRenderer::dimensionFilter( QgsVectorLayer *layer ) const
3630 {
3631 QStringList expList;
3632 // WMS Dimension filters
3633 QgsMapLayerServerProperties *serverProperties = static_cast<QgsMapLayerServerProperties *>( layer->serverProperties() );
3634 const QList<QgsMapLayerServerProperties::WmsDimensionInfo> wmsDims = serverProperties->wmsDimensions();
3635 if ( wmsDims.isEmpty() )
3636 {
3637 return expList;
3638 }
3639
3640 QMap<QString, QString> dimParamValues = mContext.parameters().dimensionValues();
3641 for ( const QgsMapLayerServerProperties::WmsDimensionInfo &dim : wmsDims )
3642 {
3643 // Skip temporal properties for this layer, give precedence to the dimensions implementation
3644 if ( mIsTemporal && dim.name.toUpper() == QLatin1String( "TIME" ) && layer->temporalProperties()->isActive() )
3645 {
3646 layer->temporalProperties()->setIsActive( false );
3647 }
3648 // Check field index
3649 int fieldIndex = layer->fields().indexOf( dim.fieldName );
3650 if ( fieldIndex == -1 )
3651 {
3652 continue;
3653 }
3654 // Check end field index
3655 int endFieldIndex = -1;
3656 if ( !dim.endFieldName.isEmpty() )
3657 {
3658 endFieldIndex = layer->fields().indexOf( dim.endFieldName );
3659 if ( endFieldIndex == -1 )
3660 {
3661 continue;
3662 }
3663 }
3664 // Apply dimension filtering
3665 if ( !dimParamValues.contains( dim.name.toUpper() ) )
3666 {
3667 // Default value based on type configured by user
3668 QVariant defValue;
3669 if ( dim.defaultDisplayType == QgsMapLayerServerProperties::WmsDimensionInfo::AllValues )
3670 {
3671 continue; // no filter by default for this dimension
3672 }
3673 else if ( dim.defaultDisplayType == QgsMapLayerServerProperties::WmsDimensionInfo::ReferenceValue )
3674 {
3675 defValue = dim.referenceValue;
3676 }
3677 else
3678 {
3679 // get unique values
3680 QSet<QVariant> uniqueValues = layer->uniqueValues( fieldIndex );
3681 if ( endFieldIndex != -1 )
3682 {
3683 uniqueValues.unite( layer->uniqueValues( endFieldIndex ) );
3684 }
3685 // sort unique values
3686 QList<QVariant> values = qgis::setToList( uniqueValues );
3687 std::sort( values.begin(), values.end() );
3688 if ( dim.defaultDisplayType == QgsMapLayerServerProperties::WmsDimensionInfo::MinValue )
3689 {
3690 defValue = values.first();
3691 }
3692 else if ( dim.defaultDisplayType == QgsMapLayerServerProperties::WmsDimensionInfo::MaxValue )
3693 {
3694 defValue = values.last();
3695 }
3696 }
3697 // build expression
3698 if ( endFieldIndex == -1 )
3699 {
3700 expList << QgsExpression::createFieldEqualityExpression( dim.fieldName, defValue );
3701 }
3702 else
3703 {
3704 QStringList expElems;
3705 expElems << QgsExpression::quotedColumnRef( dim.fieldName )
3706 << QStringLiteral( "<=" ) << QgsExpression::quotedValue( defValue )
3707 << QStringLiteral( "AND" ) << QgsExpression::quotedColumnRef( dim.endFieldName )
3708 << QStringLiteral( ">=" ) << QgsExpression::quotedValue( defValue );
3709 expList << expElems.join( ' ' );
3710 }
3711 }
3712 else
3713 {
3714 // Get field to convert value provided in parameters
3715 QgsField dimField = layer->fields().at( fieldIndex );
3716 // Value provided in parameters
3717 QString dimParamValue = dimParamValues[dim.name.toUpper()];
3718 // The expression list for this dimension
3719 QStringList dimExplist;
3720 // Multiple values are separated by ,
3721 QStringList dimValues = dimParamValue.split( ',' );
3722 for ( int i = 0; i < dimValues.size(); ++i )
3723 {
3724 QString dimValue = dimValues[i];
3725 // Trim value if necessary
3726 if ( dimValue.size() > 1 )
3727 {
3728 dimValue = dimValue.trimmed();
3729 }
3730 // Range value is separated by / for example 0/1
3731 if ( dimValue.contains( '/' ) )
3732 {
3733 QStringList rangeValues = dimValue.split( '/' );
3734 // Check range value size
3735 if ( rangeValues.size() != 2 )
3736 {
3737 continue; // throw an error
3738 }
3739 // Get range values
3740 QVariant rangeMin = QVariant( rangeValues[0] );
3741 QVariant rangeMax = QVariant( rangeValues[1] );
3742 // Convert and check range values
3743 if ( !dimField.convertCompatible( rangeMin ) )
3744 {
3745 continue; // throw an error
3746 }
3747 if ( !dimField.convertCompatible( rangeMax ) )
3748 {
3749 continue; // throw an error
3750 }
3751 // Build expression for this range
3752 QStringList expElems;
3753 if ( endFieldIndex == -1 )
3754 {
3755 // The field values are between min and max range
3756 expElems << QgsExpression::quotedColumnRef( dim.fieldName )
3757 << QStringLiteral( ">=" ) << QgsExpression::quotedValue( rangeMin )
3758 << QStringLiteral( "AND" ) << QgsExpression::quotedColumnRef( dim.fieldName )
3759 << QStringLiteral( "<=" ) << QgsExpression::quotedValue( rangeMax );
3760 }
3761 else
3762 {
3763 // The start field or the end field are lesser than min range
3764 // or the start field or the end field are greater than min range
3765 expElems << QStringLiteral( "(" ) << QgsExpression::quotedColumnRef( dim.fieldName )
3766 << QStringLiteral( ">=" ) << QgsExpression::quotedValue( rangeMin )
3767 << QStringLiteral( "OR" ) << QgsExpression::quotedColumnRef( dim.endFieldName )
3768 << QStringLiteral( ">=" ) << QgsExpression::quotedValue( rangeMin )
3769 << QStringLiteral( ") AND (" ) << QgsExpression::quotedColumnRef( dim.fieldName )
3770 << QStringLiteral( "<=" ) << QgsExpression::quotedValue( rangeMax )
3771 << QStringLiteral( "OR" ) << QgsExpression::quotedColumnRef( dim.endFieldName )
3772 << QStringLiteral( "<=" ) << QgsExpression::quotedValue( rangeMax )
3773 << QStringLiteral( ")" );
3774 }
3775 dimExplist << expElems.join( ' ' );
3776 }
3777 else
3778 {
3779 QVariant dimVariant = QVariant( dimValue );
3780 if ( !dimField.convertCompatible( dimVariant ) )
3781 {
3782 continue; // throw an error
3783 }
3784 // Build expression for this value
3785 if ( endFieldIndex == -1 )
3786 {
3787 // Field is equal to
3788 dimExplist << QgsExpression::createFieldEqualityExpression( dim.fieldName, dimVariant );
3789 }
3790 else
3791 {
3792 // The start field is lesser or equal to
3793 // and the end field is greater or equal to
3794 QStringList expElems;
3795 expElems << QgsExpression::quotedColumnRef( dim.fieldName )
3796 << QStringLiteral( "<=" ) << QgsExpression::quotedValue( dimVariant )
3797 << QStringLiteral( "AND" ) << QgsExpression::quotedColumnRef( dim.endFieldName )
3798 << QStringLiteral( ">=" ) << QgsExpression::quotedValue( dimVariant );
3799 dimExplist << expElems.join( ' ' );
3800 }
3801 }
3802 }
3803 // Build the expression for this dimension
3804 if ( dimExplist.size() == 1 )
3805 {
3806 expList << dimExplist;
3807 }
3808 else if ( dimExplist.size() > 1 )
3809 {
3810 expList << QStringLiteral( "( %1 )" ).arg( dimExplist.join( QLatin1String( " ) OR ( " ) ) );
3811 }
3812 }
3813 }
3814 return expList;
3815 }
3816
3817 void QgsRenderer::setLayerSelection( QgsMapLayer *layer, const QStringList &fids ) const
3818 {
3819 if ( !fids.empty() && layer->type() == Qgis::LayerType::Vector )
3820 {
3821 QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer );
3822
3823 QgsFeatureRequest request;
3825 const QgsFeatureIds selectedIds = request.filterFids();
3826
3827 if ( selectedIds.empty() )
3828 {
3830 }
3831 else
3832 {
3833 vl->selectByIds( selectedIds );
3834 }
3835 }
3836 }
3837
3838 void QgsRenderer::setLayerAccessControlFilter( QgsMapLayer *layer ) const
3839 {
3840#ifdef HAVE_SERVER_PYTHON_PLUGINS
3841 QgsOWSServerFilterRestorer::applyAccessControlLayerFilters( mContext.accessControl(), layer );
3842#else
3843 Q_UNUSED( layer )
3844#endif
3845 }
3846
3847 void QgsRenderer::updateExtent( const QgsMapLayer *layer, QgsMapSettings &mapSettings ) const
3848 {
3849 QgsRectangle layerExtent = mapSettings.layerToMapCoordinates( layer, layer->extent() );
3850 QgsRectangle mapExtent = mapSettings.extent();
3851 if ( !layerExtent.isEmpty() )
3852 {
3853 mapExtent.combineExtentWith( layerExtent );
3854 mapSettings.setExtent( mapExtent );
3855 }
3856 }
3857
3858 void QgsRenderer::annotationsRendering( QPainter *painter, const QgsMapSettings &mapSettings ) const
3859 {
3860 const QgsAnnotationManager *annotationManager = mProject->annotationManager();
3861 const QList<QgsAnnotation *> annotations = annotationManager->annotations();
3862
3863 QgsRenderContext renderContext = QgsRenderContext::fromQPainter( painter );
3865 renderContext.setFeedback( mContext.socketFeedback() );
3866
3867 for ( QgsAnnotation *annotation : annotations )
3868 {
3869 if ( mContext.socketFeedback() && mContext.socketFeedback()->isCanceled() )
3870 break;
3871 if ( !annotation || !annotation->isVisible() )
3872 continue;
3873
3874 //consider item position
3875 double offsetX = 0;
3876 double offsetY = 0;
3877 if ( annotation->hasFixedMapPosition() )
3878 {
3879 QgsPointXY mapPos = annotation->mapPosition();
3880 if ( mapSettings.destinationCrs() != annotation->mapPositionCrs() )
3881 {
3882 QgsCoordinateTransform coordTransform( annotation->mapPositionCrs(), mapSettings.destinationCrs(), mapSettings.transformContext() );
3883 try
3884 {
3885 mapPos = coordTransform.transform( mapPos );
3886 }
3887 catch ( const QgsCsException &e )
3888 {
3889 QgsMessageLog::logMessage( QStringLiteral( "Error transforming coordinates of annotation item: %1" ).arg( e.what() ) );
3890 }
3891 }
3892 const QgsPointXY devicePos = mapSettings.mapToPixel().transform( mapPos );
3893 offsetX = devicePos.x();
3894 offsetY = devicePos.y();
3895 }
3896 else
3897 {
3898 const QPointF relativePos = annotation->relativePosition();
3899 offsetX = mapSettings.outputSize().width() * relativePos.x();
3900 offsetY = mapSettings.outputSize().height() * relativePos.y();
3901 }
3902
3903 painter->save();
3904 painter->translate( offsetX, offsetY );
3905 annotation->render( renderContext );
3906 painter->restore();
3907 }
3908 }
3909
3910 QImage *QgsRenderer::scaleImage( const QImage *image ) const
3911 {
3912 // Test if width / height ratio of image is the same as the ratio of
3913 // WIDTH / HEIGHT parameters. If not, the image has to be scaled (required
3914 // by WMS spec)
3915 QImage *scaledImage = nullptr;
3916 const int width = mWmsParameters.widthAsInt();
3917 const int height = mWmsParameters.heightAsInt();
3918 if ( width != image->width() || height != image->height() )
3919 {
3920 scaledImage = new QImage( image->scaled( width, height, Qt::IgnoreAspectRatio, Qt::SmoothTransformation ) );
3921 }
3922
3923 return scaledImage;
3924 }
3925
3926 void QgsRenderer::handlePrintErrors( const QgsLayout *layout ) const
3927 {
3928 if ( !layout )
3929 {
3930 return;
3931 }
3932 QList<QgsLayoutItemMap *> mapList;
3933 layout->layoutItems( mapList );
3934
3935 QList<QgsLayoutItemMap *>::const_iterator mapIt = mapList.constBegin();
3936 for ( ; mapIt != mapList.constEnd(); ++mapIt )
3937 {
3938 if ( !( *mapIt )->renderingErrors().isEmpty() )
3939 {
3940 const QgsMapRendererJob::Error e = ( *mapIt )->renderingErrors().at( 0 );
3941 throw QgsException( QStringLiteral( "Rendering error : '%1' in layer %2" ).arg( e.message, e.layerID ) );
3942 }
3943 }
3944 }
3945
3946 void QgsRenderer::configureLayers( QList<QgsMapLayer *> &layers, QgsMapSettings *settings )
3947 {
3948 const bool useSld = !mContext.parameters().sldBody().isEmpty();
3949
3950 for ( auto layer : layers )
3951 {
3952 const QgsWmsParametersLayer param = mContext.parameters( *layer );
3953
3954 if ( !mContext.layersToRender().contains( layer ) )
3955 {
3956 continue;
3957 }
3958
3959 if ( mContext.isExternalLayer( param.mNickname ) )
3960 {
3961 if ( mContext.testFlag( QgsWmsRenderContext::UseOpacity ) )
3962 {
3963 setLayerOpacity( layer, param.mOpacity );
3964 }
3965 continue;
3966 }
3967
3968 if ( useSld )
3969 {
3970 setLayerSld( layer, mContext.sld( *layer ) );
3971 }
3972 else
3973 {
3974 setLayerStyle( layer, mContext.style( *layer ) );
3975 }
3976
3977 if ( mContext.testFlag( QgsWmsRenderContext::UseOpacity ) )
3978 {
3979 setLayerOpacity( layer, param.mOpacity );
3980 }
3981
3982 if ( mContext.testFlag( QgsWmsRenderContext::UseFilter ) )
3983 {
3984 setLayerFilter( layer, param.mFilter );
3985 }
3986
3988 {
3989 setLayerAccessControlFilter( layer );
3990 }
3991
3993 {
3994 setLayerSelection( layer, param.mSelection );
3995 }
3996
3997 if ( settings && mContext.updateExtent() )
3998 {
3999 updateExtent( layer, *settings );
4000 }
4001 }
4002
4004 {
4005 layers = highlightLayers( mWmsParameters.highlightLayersParameters() ) << layers;
4006 }
4007 }
4008
4009 void QgsRenderer::setLayerStyle( QgsMapLayer *layer, const QString &style ) const
4010 {
4011 if ( style.isEmpty() )
4012 {
4013 return;
4014 }
4015
4016 bool rc = layer->styleManager()->setCurrentStyle( style );
4017 if ( !rc )
4018 {
4019 throw QgsBadRequestException( QgsServiceException::OGC_StyleNotDefined, QStringLiteral( "Style '%1' does not exist for layer '%2'" ).arg( style, layer->name() ) );
4020 }
4021 }
4022
4023 void QgsRenderer::setLayerSld( QgsMapLayer *layer, const QDomElement &sld ) const
4024 {
4025 QString err;
4026 // Defined sld style name
4027 const QStringList styles = layer->styleManager()->styles();
4028 QString sldStyleName = "__sld_style";
4029 while ( styles.contains( sldStyleName ) )
4030 {
4031 sldStyleName.append( '@' );
4032 }
4033 layer->styleManager()->addStyleFromLayer( sldStyleName );
4034 layer->styleManager()->setCurrentStyle( sldStyleName );
4035 layer->readSld( sld, err );
4036 layer->setCustomProperty( "sldStyleName", sldStyleName );
4037 }
4038
4039 QgsLegendSettings QgsRenderer::legendSettings()
4040 {
4041 // getting scale from bbox or default size
4042 QgsLegendSettings settings = mWmsParameters.legendSettings();
4043
4044 if ( !mWmsParameters.bbox().isEmpty() )
4045 {
4046 QgsMapSettings mapSettings;
4048 std::unique_ptr<QImage> tmp( createImage( mContext.mapSize( false ) ) );
4049 configureMapSettings( tmp.get(), mapSettings );
4050 // QGIS 4.0 - require correct use of QgsRenderContext instead of these
4052 settings.setMapScale( mapSettings.scale() );
4053 settings.setMapUnitsPerPixel( mapSettings.mapUnitsPerPixel() );
4055 }
4056 else
4057 {
4058 // QGIS 4.0 - require correct use of QgsRenderContext instead of these
4060 const double defaultMapUnitsPerPixel = QgsServerProjectUtils::wmsDefaultMapUnitsPerMm( *mContext.project() ) / mContext.dotsPerMm();
4061 settings.setMapUnitsPerPixel( defaultMapUnitsPerPixel );
4063 }
4064
4065 return settings;
4066 }
4067} // namespace QgsWms
Provides global constants and enumerations for use throughout the application.
Definition qgis.h:54
static QString version()
Version string.
Definition qgis.cpp:267
@ MapOrientation
Signifies that the AboveLine and BelowLine flags should respect the map's orientation rather than the...
@ AboveLine
Labels can be placed above a line feature. Unless MapOrientation is also specified this mode respects...
@ Millimeters
Millimeters.
LabelPlacement
Placement modes which determine how label candidates are generated for a feature.
Definition qgis.h:1158
@ AroundPoint
Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygo...
@ Line
Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon'...
@ DragAndDrop
"Drag and drop" layout. Needs to be configured.
@ ExactIntersect
Use exact geometry intersection (slower) instead of bounding boxes.
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
@ NoFlags
No flags are set.
@ Warning
Warning message.
Definition qgis.h:156
@ Info
Information message.
Definition qgis.h:155
QFlags< LabelLinePlacementFlag > LabelLinePlacementFlags
Line placement flags, which control how candidates are generated for a linear feature.
Definition qgis.h:1254
@ ShowRuleDetails
If set, the rule expression of a rule based renderer legend item will be added to the JSON.
@ Polygon
Polygons.
@ Unknown
Unknown types.
@ Null
No geometry.
@ IdentifyValue
Numerical values.
@ IdentifyFeature
WMS GML -> feature.
@ Group
Composite group layer. Added in QGIS 3.24.
@ Plugin
Plugin based layer.
@ TiledScene
Tiled scene layer. Added in QGIS 3.34.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ Vector
Vector layer.
@ VectorTile
Vector tile layer. Added in QGIS 3.14.
@ Mesh
Mesh layer. Added in QGIS 3.2.
@ Raster
Raster layer.
@ PointCloud
Point cloud layer. Added in QGIS 3.18.
@ LosslessImageRendering
Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some...
@ Antialiasing
Use antialiasing while drawing.
@ HighQualityImageTransforms
Enable high quality image transformations, which results in better appearance of scaled or rotated ra...
@ RenderBlocking
Render and load remote sources in the same thread to ensure rendering remote sources (svg and images)...
QFlags< LegendJsonRenderFlag > LegendJsonRenderFlags
Definition qgis.h:4429
static QString geoNone()
Constant that holds the string representation for "No ellipse/No CRS".
Definition qgis.h:6011
RasterIdentifyFormat
Raster identify formats.
Definition qgis.h:4662
@ Feature
WMS GML/JSON -> feature.
@ Value
Numerical pixel value.
@ NoGeometry
No geometry.
@ HideFromWms
Field is not available if layer is served as WMS from QGIS server.
@ AllowOverlapIfRequired
Avoids overlapping labels when possible, but permit overlaps if labels for features cannot otherwise ...
@ Reverse
Reverse/inverse transform (from destination to source)
@ RenderMapTile
Draw map such that there are no problems between adjacent tiles.
@ RecordProfile
Enable run-time profiling while rendering.
@ UseRenderingOptimization
Enable vector simplification and other rendering optimizations.
@ RenderBlocking
Render and load remote sources in the same thread to ensure rendering remote sources (svg and images)...
Abstract base class for all geometries.
virtual QgsAbstractGeometry * segmentize(double tolerance=M_PI/180., SegmentationToleranceType toleranceType=MaximumAngle) const
Returns a version of the geometry without curves.
Qgis::WkbType wkbType() const
Returns the WKB type of the geometry.
QString abstract() const
Returns a free-form description of the resource.
QString title() const
Returns the human readable name of the resource, typically displayed in search results.
QgsAbstractMetadataBase::KeywordMap keywords() const
Returns the keywords map, which is a set of descriptive keywords associated with the resource.
Abstract base class - its implementations define different approaches to the labeling of a vector lay...
virtual void multiplyOpacity(double opacityFactor)
Multiply opacity by opacityFactor.
Manages storage of a set of QgsAnnotation annotation objects.
QList< QgsAnnotation * > annotations() const
Returns a list of all annotations contained in the manager.
Abstract base class for annotation items which are drawn over a map.
static QgsFieldFormatterRegistry * fieldFormatterRegistry()
Gets the registry of available field formatters.
A container for attribute editors, used to group them visually in the attribute form if it is set to ...
QList< QgsAttributeEditorElement * > children() const
Gets a list of the children elements of this container.
An abstract base class for any elements of a drag and drop form.
QString name() const
Returns the name of this element.
This element will load a field's widget onto the form.
This element will load a relation editor onto the form.
const QgsRelation & relation() const
Gets the id of the relation which shall be embedded.
A vector of attributes.
Exception thrown in case of malformed requests.
Represents a coordinate reference system (CRS).
static QgsCoordinateReferenceSystem fromOgcWmsCrs(const QString &ogcCrs)
Creates a CRS from a given OGC WMS-format Coordinate Reference System string.
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
bool hasAxisInverted() const
Returns whether the axis order is inverted for the CRS compared to the order east/north (longitude/la...
Handles coordinate transforms between two coordinate systems.
QgsPointXY transform(const QgsPointXY &point, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward) const
Transform the point from the source CRS to the destination CRS.
QgsRectangle transformBoundingBox(const QgsRectangle &rectangle, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward, bool handle180Crossover=false) const
Transforms a rectangle from the source CRS to the destination CRS.
bool isValid() const
Returns true if the coordinate transform is valid, ie both the source and destination CRS have been s...
Custom exception class for Coordinate Reference System related exceptions.
A server filter to apply a dimension filter to a request.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
void setSourceCrs(const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context)
Sets source spatial reference system crs.
bool setEllipsoid(const QString &ellipsoid)
Sets the ellipsoid by its acronym.
@ FlagNoMText
Export text as TEXT elements. If not set, text will be exported as MTEXT elements.
QFlags< Flag > Flags
Contains configuration settings for an editor form.
QgsAttributeEditorContainer * invisibleRootContainer()
Gets the invisible root container for the drag and drop designer form (EditorLayout::TabLayout).
Qgis::AttributeFormLayout layout() const
Gets the active layout style for the attribute editor for this layer.
Holder for the widget type and its configuration for a field.
QVariantMap config() const
Defines a QGIS exception class.
QString what() const
Single scope for storing variables and functions for use within a QgsExpressionContext.
void addVariable(const QgsExpressionContextScope::StaticVariable &variable)
Adds a variable into the context scope.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsExpressionContextScope * mapSettingsScope(const QgsMapSettings &mapSettings)
Creates a new scope which contains variables and functions relating to a QgsMapSettings object.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
Handles parsing and evaluation of expressions (formerly called "search strings").
bool prepare(const QgsExpressionContext *context)
Gets the expression ready for evaluation - find out column indexes.
QString expression() const
Returns the original, unmodified expression string.
static QString quotedValue(const QVariant &value)
Returns a string representation of a literal value, including appropriate quotations where required.
static QString replaceExpressionText(const QString &action, const QgsExpressionContext *context, const QgsDistanceArea *distanceArea=nullptr)
This function replaces each expression between [% and %] in the string with the result of its evaluat...
static QString createFieldEqualityExpression(const QString &fieldName, const QVariant &value, QMetaType::Type fieldType=QMetaType::Type::UnknownType)
Create an expression allowing to evaluate if a field is equal to a value.
static QString quotedColumnRef(QString name)
Returns a quoted column reference (in double quotes)
QVariant evaluate()
Evaluate the feature and return the result.
bool isValid() const
Checks if this expression is valid.
A filter filter provider grouping several filter providers.
QgsFeatureFilterProviderGroup & addProvider(const QgsFeatureFilterProvider *provider)
Add another filter provider to the group.
void setFilter(const QgsVectorLayer *layer, const QgsExpression &expression)
Set a filter for the given layer.
void filterFeatures(const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures) const override
Filter the features of the layer.
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
@ MoreSymbolsPerFeature
May use more than one symbol to render a feature: symbolsForFeature() will return them.
static QgsFeatureRenderer * loadSld(const QDomNode &node, Qgis::GeometryType geomType, QString &errorMessage)
Create a new renderer according to the information contained in the UserStyle element of a SLD style ...
virtual QgsFeatureRenderer * clone() const =0
Create a deep copy of this renderer.
Wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFlags(Qgis::FeatureRequestFlags flags)
Sets flags that affect how features will be fetched.
Qgis::FeatureRequestFlags flags() const
Returns the flags which affect how features are fetched.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
QgsExpression * filterExpression() const
Returns the filter expression (if set).
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
QgsCoordinateTransformContext transformContext() const
Returns the transform context, for use when a destinationCrs() has been set and reprojection is requi...
const QgsFeatureIds & filterFids() const
Returns the feature IDs that should be fetched.
QgsFeatureRequest & setFilterRect(const QgsRectangle &rectangle)
Sets the rectangle from which features will be taken.
A container for features with the same fields and crs.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
Q_INVOKABLE bool setAttribute(int field, const QVariant &attr)
Sets an attribute's value by field index.
QgsAttributes attributes
Definition qgsfeature.h:67
QgsFields fields
Definition qgsfeature.h:68
void initAttributes(int fieldCount)
Initialize this feature with the given number of fields.
QgsFeatureId id
Definition qgsfeature.h:66
void setFields(const QgsFields &fields, bool initAttributes=false)
Assigns a field map with the feature to allow attribute access by attribute name.
QgsGeometry geometry
Definition qgsfeature.h:69
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
bool isCanceled() const
Tells whether the operation has been canceled already.
Definition qgsfeedback.h:53
QgsFieldFormatter * fieldFormatter(const QString &id) const
Gets a field formatter by its id.
A field formatter helps to handle and display values for a field.
virtual QString representValue(QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value) const
Create a pretty String representation of the value.
Encapsulate a field in an attribute table or data source.
Definition qgsfield.h:53
QString name
Definition qgsfield.h:62
bool convertCompatible(QVariant &v, QString *errorMessage=nullptr) const
Converts the provided variant to a compatible format.
Definition qgsfield.cpp:474
Qgis::FieldConfigurationFlags configurationFlags
Definition qgsfield.h:66
Container of fields for a vector layer.
Definition qgsfields.h:46
bool append(const QgsField &field, Qgis::FieldOrigin origin=Qgis::FieldOrigin::Provider, int originIndex=-1)
Appends a field.
Definition qgsfields.cpp:70
int count
Definition qgsfields.h:50
Q_INVOKABLE int indexFromName(const QString &fieldName) const
Gets the field index from the field name.
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).
A geometry is the spatial representation of a feature.
QgsGeometry pointOnSurface() const
Returns a point guaranteed to lie on the surface of a geometry.
Qgis::GeometryOperationResult transform(const QgsCoordinateTransform &ct, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward, bool transformZ=false)
Transforms this geometry as described by the coordinate transform ct.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
static Q_INVOKABLE QgsGeometry fromWkt(const QString &wkt)
Creates a new geometry from a WKT string.
QgsPointXY asPoint() const
Returns the contents of the geometry as a 2-dimensional point.
static QgsGeometry fromPointXY(const QgsPointXY &point)
Creates a new geometry from a QgsPointXY object.
Qgis::GeometryType type
void set(QgsAbstractGeometry *geometry)
Sets the underlying geometry store.
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
Q_INVOKABLE QString asWkt(int precision=17) const
Exports the geometry to WKT.
Handles exporting QgsFeature features to GeoJSON features.
static void addCrsInfo(json &value, const QgsCoordinateReferenceSystem &crs)
Add crs information entry in json object regarding old GeoJSON specification format if it differs fro...
void setPlacementFlags(Qgis::LabelLinePlacementFlags flags)
Returns the line placement flags, which dictate how line labels can be placed above or below the line...
void setOverlapHandling(Qgis::LabelOverlapHandling handling)
Sets the technique used to handle overlapping labels.
void setAllowDegradedPlacement(bool allow)
Sets whether labels can be placed in inferior fallback positions if they cannot otherwise be placed.
QStringList findLayerIds() const
Find layer IDs used in all layer nodes.
QgsLayerTreeLayer * findLayer(QgsMapLayer *layer) const
Find layer node representing the map layer.
void removeChildrenGroupWithoutLayers()
Remove all child group nodes without layers.
Layer tree node points to a map layer.
QgsMapLayer * layer() const
Returns the map layer associated with this node.
An abstract interface for legend items returned from QgsMapLayerLegend implementation.
virtual QVariant data(int role) const =0
Returns data associated with the item. Must be implemented in derived class.
@ RuleKey
Rule key of the node (QString)
virtual QJsonObject exportSymbolToJson(const QgsLegendSettings &settings, const QgsRenderContext &context) const
Adds a symbol in base64 string within a JSON object with the key "icon".
QgsLayerTreeLayer * layerNode() const
Returns pointer to the parent layer node.
virtual QSizeF drawSymbol(const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const
Draws symbol on the left side of the item.
A model representing the layer tree, including layers and groups of layers.
QgsLayerTree * rootGroup() const
Returns pointer to the root node of the layer tree. Always a non nullptr value.
QgsLayerTreeModelLegendNode * findLegendNode(const QString &layerId, const QString &ruleKey) const
Searches through the layer tree to find a legend node with a matching layer ID and rule key.
QgsLayerTreeNode * parent()
Gets pointer to the parent. If parent is nullptr, the node is a root node.
Namespace with helper functions for layer tree operations.
static QgsLayerTreeLayer * toLayer(QgsLayerTreeNode *node)
Cast node to a layer.
Used to render QgsLayout as an atlas, by iterating over the features from an associated vector layer.
bool beginRender() override
Called when rendering begins, before iteration commences.
bool setFilterExpression(const QString &expression, QString &errorString)
Sets the expression used for filtering features in the coverage layer.
bool first()
Seeks to the first feature, returning false if no feature was found.
QgsLayout * layout() override
Returns the layout associated with the iterator.
bool enabled() const
Returns whether the atlas generation is enabled.
int count() const override
Returns the number of features to iterate over.
void setFilterFeatures(bool filtered)
Sets whether features should be filtered in the coverage layer.
QgsVectorLayer * coverageLayer() const
Returns the coverage layer used for the atlas features.
bool next() override
int updateFeatures()
Requeries the current atlas coverage layer and applies filtering and sorting.
Handles rendering and exports of layouts to various formats.
ExportResult exportToSvg(const QString &filePath, const QgsLayoutExporter::SvgExportSettings &settings)
Exports the layout as an SVG to the filePath, using the specified export settings.
ExportResult exportToImage(const QString &filePath, const QgsLayoutExporter::ImageExportSettings &settings)
Exports the layout to the filePath, using the specified export settings.
ExportResult exportToPdf(const QString &filePath, const QgsLayoutExporter::PdfExportSettings &settings)
Exports the layout as a PDF to the filePath, using the specified export settings.
Base class for frame items, which form a layout multiframe item.
A layout multiframe subclass for HTML content.
@ ManualHtml
HTML content is manually set for the item.
@ Url
Using this mode item fetches its content via a url.
A layout item subclass for text labels.
A layout item subclass for map legends.
Layout graphical items for displaying a map.
double scale() const
Returns the map scale.
QList< QgsMapLayer * > layers() const
Returns the stored layer set.
QString id() const
Returns the item's ID name.
Manages storage of a set of layouts.
QgsMasterLayoutInterface * layoutByName(const QString &name) const
Returns the layout with a matching name, or nullptr if no matching layouts were found.
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 pageCount() const
Returns the number of pages in the collection.
Stores information relating to the current rendering settings for a layout.
void setFeatureFilterProvider(QgsFeatureFilterProvider *featureFilterProvider)
Sets feature filter provider to featureFilterProvider.
@ FlagLosslessImageRendering
Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some...
@ FlagDisableTiledRasterLayerRenders
If set, then raster layers will not be drawn as separate tiles. This may improve the appearance in ex...
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.
static QVector< double > predefinedScales(const QgsLayout *layout)
Returns a list of predefined scales associated with a layout.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition qgslayout.h:49
QgsLayoutPageCollection * pageCollection()
Returns a pointer to the layout's page collection, which stores and manages page items in the layout.
void layoutItems(QList< T * > &itemList) const
Returns a list of layout items of a specific type.
Definition qgslayout.h:120
Item model implementation based on layer tree model for layout legend.
Handles automatic layout and rendering of legends.
QSizeF minimumSize(QgsRenderContext *renderContext=nullptr)
Runs the layout algorithm and returns the minimum size required for the legend.
QJsonObject exportLegendToJson(const QgsRenderContext &context)
Renders the legend in a json object.
Q_DECL_DEPRECATED void drawLegend(QPainter *painter)
Draws the legend with given painter.
Stores the appearance and layout settings for legend drawing with QgsLegendRenderer.
Q_DECL_DEPRECATED void setMapScale(double scale)
Sets the legend map scale.
Q_DECL_DEPRECATED void setMapUnitsPerPixel(double mapUnitsPerPixel)
Sets the mmPerMapUnit calculated by mapUnitsPerPixel mostly taken from the map settings.
void setJsonRenderFlags(const Qgis::LegendJsonRenderFlags &jsonRenderFlags)
Sets the the JSON export flags to jsonRenderFlags.
void setWmsLegendSize(QSizeF s)
Sets the desired size (in millimeters) of WMS legend graphics shown in the legend.
Manages QGIS Server properties for a map layer.
QStringList styles() const
Returns list of all defined style names.
bool setCurrentStyle(const QString &name)
Set a different style as the current style - will apply it to the layer.
bool addStyleFromLayer(const QString &name)
Add style by cloning the current one.
Base class for all map layer types.
Definition qgsmaplayer.h:77
QString name
Definition qgsmaplayer.h:81
bool isInScaleRange(double scale) const
Tests whether the layer should be visible at the specified scale.
virtual QgsRectangle extent() const
Returns the extent of the layer.
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
QgsCoordinateReferenceSystem crs
Definition qgsmaplayer.h:84
QgsMapLayerServerProperties * serverProperties()
Returns QGIS Server Properties for the map layer.
Qgis::LayerType type
Definition qgsmaplayer.h:87
virtual void setOpacity(double opacity)
Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1....
Q_INVOKABLE void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for layer.
bool hasScaleBasedVisibility() const
Returns whether scale based visibility is enabled for the layer.
@ Identifiable
If the layer is identifiable using the identify map tool and as a WMS layer.
virtual bool readSld(const QDomNode &node, QString &errorMessage)
QgsMapLayerStyleManager * styleManager() const
Gets access to the layer's style manager.
virtual Q_INVOKABLE QgsDataProvider * dataProvider()
Returns the layer's data provider, it may be nullptr.
QString mapTipTemplate
Definition qgsmaplayer.h:90
Contains configuration for rendering maps.
QgsPointXY layerToMapCoordinates(const QgsMapLayer *layer, QgsPointXY point) const
transform point coordinates from layer's CRS to output CRS
QList< QgsMapLayer * > layers(bool expandGroupLayers=false) const
Returns the list of layers which will be rendered in the map.
void setSelectionColor(const QColor &color)
Sets the color that is used for drawing of selected vector features.
void setLayers(const QList< QgsMapLayer * > &layers)
Sets the list of layers to render in the map.
double scale() const
Returns the calculated map scale.
QgsCoordinateTransform layerTransform(const QgsMapLayer *layer) const
Returns the coordinate transform from layer's CRS to destination CRS.
QgsRectangle layerExtentToOutputExtent(const QgsMapLayer *layer, QgsRectangle extent) const
transform bounding box from layer's CRS to output CRS
void setScaleMethod(Qgis::ScaleCalculationMethod method)
Sets the method to use for scale calculations for the map.
void setDpiTarget(double dpi)
Sets the target dpi (dots per inch) to be taken into consideration when rendering.
void setOutputDpi(double dpi)
Sets the dpi (dots per inch) used for conversion between real world units (e.g.
const QgsMapToPixel & mapToPixel() const
double mapUnitsPerPixel() const
Returns the distance in geographical coordinates that equals to one pixel in the map.
QSize outputSize() const
Returns the size of the resulting map image, in pixels.
QgsRectangle extent() const
Returns geographical coordinates of the rectangle that should be rendered.
void setExtent(const QgsRectangle &rect, bool magnified=true)
Sets the coordinates of the rectangle which should be rendered.
void setExpressionContext(const QgsExpressionContext &context)
Sets the expression context.
QColor selectionColor() const
Returns the color that is used for drawing of selected vector features.
void setExtentBuffer(double buffer)
Sets the buffer in map units to use around the visible extent for rendering symbols whose correspondi...
void setLabelingEngineSettings(const QgsLabelingEngineSettings &settings)
Sets the global configuration of the labeling engine.
void setTransformContext(const QgsCoordinateTransformContext &context)
Sets the coordinate transform context, which stores various information regarding which datum transfo...
void setOutputSize(QSize size)
Sets the size of the resulting map image, in pixels.
QgsPointXY mapToLayerCoordinates(const QgsMapLayer *layer, QgsPointXY point) const
transform point coordinates from output CRS to layer's CRS
void setBackgroundColor(const QColor &color)
Sets the background color of the map.
QgsCoordinateReferenceSystem destinationCrs() const
Returns the destination coordinate reference system for the map render.
void setFlag(Qgis::MapSettingsFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
void setDestinationCrs(const QgsCoordinateReferenceSystem &crs)
Sets the destination crs (coordinate reference system) for the map render.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context, which stores various information regarding which datum tran...
QList< QgsMapThemeCollection::MapThemeLayerRecord > layerRecords() const
Returns a list of records for all visible layer belonging to the theme.
QgsMapThemeCollection::MapThemeRecord mapThemeState(const QString &name) const
Returns the recorded state of a map theme.
Perform transforms between map coordinates and device coordinates.
double mapUnitsPerPixel() const
Returns the current map units per pixel.
QgsPointXY transform(const QgsPointXY &p) const
Transforms a point p from map (world) coordinates to device coordinates.
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())
Adds a message to the log instance (and creates it if necessary).
static void applyAccessControlLayerFilters(const QgsAccessControl *accessControl, QgsMapLayer *mapLayer, QHash< QgsMapLayer *, QString > &originalLayerFilters)
Apply filter from AccessControl.
static QDomElement rectangleToGMLEnvelope(const QgsRectangle *env, QDomDocument &doc, int precision=17)
Exports the rectangle to GML3 Envelope.
static QDomElement geometryToGML(const QgsGeometry &geometry, QDomDocument &doc, QgsOgcUtils::GMLVersion gmlVersion, const QString &srsName, bool invertAxisOrientation, const QString &gmlIdBase, int precision=17)
Exports the geometry to GML.
static QgsExpression * expressionFromOgcFilter(const QDomElement &element, QgsVectorLayer *layer=nullptr)
Parse XML with OGC filter into QGIS expression.
static QDomElement rectangleToGMLBox(const QgsRectangle *box, QDomDocument &doc, int precision=17)
Exports the rectangle to GML2 Box.
Contains settings for how a map layer will be labeled.
const QgsLabelPlacementSettings & placementSettings() const
Returns the label placement settings.
void setFormat(const QgsTextFormat &format)
Sets the label text formatting settings, e.g., font settings, buffer settings, etc.
Qgis::LabelPlacement placement
Label placement mode.
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the label's property collection, used for data defined overrides.
int priority
Label priority.
const QgsLabelLineSettings & lineSettings() const
Returns the label line settings, which contain settings related to how the label engine places and fo...
double dist
Distance from feature to the label.
Property
Data definable properties.
@ PositionX
X-coordinate data defined label position.
@ LabelRotation
Label rotation.
@ PositionY
Y-coordinate data defined label position.
@ Vali
Vertical alignment for data defined label position (Bottom, Base, Half, Cap, Top)
@ Hali
Horizontal alignment for data defined label position (Left, Center, Right)
QString fieldName
Name of field (or an expression) to use for label text.
Represents a 2D point.
Definition qgspointxy.h:60
void setY(double y)
Sets the y value of the point.
Definition qgspointxy.h:129
double y
Definition qgspointxy.h:64
double x
Definition qgspointxy.h:63
void setX(double x)
Sets the x value of the point.
Definition qgspointxy.h:119
Print layout, a QgsLayout subclass for static or atlas-based layouts.
QgsPrintLayout * clone() const override
Creates a clone of the layout.
QString author() const
Returns the project author string.
Describes the version of a project.
QColor selectionColor
Definition qgsproject.h:122
static QgsProject * instance()
Returns the QgsProject singleton instance.
Q_INVOKABLE QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
QgsMapThemeCollection * mapThemeCollection
Definition qgsproject.h:115
QgsAnnotationManager * annotationManager()
Returns pointer to the project's annotation manager.
QgsProjectMetadata metadata
Definition qgsproject.h:120
QgsCoordinateTransformContext transformContext
Definition qgsproject.h:113
const QgsLayoutManager * layoutManager() const
Returns the project's layout manager, which manages print layouts, atlases and reports within the pro...
const QgsLabelingEngineSettings & labelingEngineSettings() const
Returns project's global labeling engine settings.
Qgis::ScaleCalculationMethod scaleMethod
Definition qgsproject.h:128
QMap< QString, QgsMapLayer * > mapLayers(const bool validOnly=false) const
Returns a map of all registered layers by layer ID.
void setProperty(int key, const QgsProperty &property)
Adds a property to the collection and takes ownership of it.
virtual QgsRasterIdentifyResult identify(const QgsPointXY &point, Qgis::RasterIdentifyFormat format, const QgsRectangle &boundingBox=QgsRectangle(), int width=0, int height=0, int dpi=96)
Identify raster value(s) found on the point position.
Raster identify results container.
bool isValid() const
Returns true if valid.
QMap< int, QVariant > results() const
Returns the identify results.
virtual Qgis::RasterInterfaceCapabilities capabilities() const
Returns the capabilities supported by the interface.
Represents a raster layer.
QgsRasterRenderer * renderer() const
Returns the raster's renderer.
QString bandName(int bandNoInt) const
Returns the name of a band given its number.
QgsRasterDataProvider * dataProvider() override
Returns the source data provider.
Raster renderer pipe that applies colors to a raster.
void setOpacity(double opacity)
Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1....
A rectangle specified with double values.
bool contains(const QgsRectangle &rect) const
Returns true when rectangle contains other rectangle.
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.
void invert()
Swap x/y coordinates in the rectangle.
Represents a relationship between two vector layers.
Definition qgsrelation.h:44
QgsAttributeList referencedFields() const
Returns a list of attributes used to form the referenced fields (most likely primary key) on the refe...
Contains information about the context of a rendering operation.
double scaleFactor() const
Returns the scaling factor for the render to convert painter units to physical sizes.
void setCoordinateTransform(const QgsCoordinateTransform &t)
Sets the current coordinate transform for the context.
void setDistanceArea(const QgsDistanceArea &distanceArea)
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
void setScaleFactor(double factor)
Sets the scaling factor for the render to convert painter units to physical sizes.
QgsExpressionContext & expressionContext()
Gets the expression context.
const QgsRectangle & extent() const
When rendering a map layer, calling this method returns the "clipping" extent for the layer (in the l...
void setFeedback(QgsFeedback *feedback)
Attach a feedback object that can be queried regularly during rendering to check if rendering should ...
void setFlag(Qgis::RenderContextFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
const QgsMapToPixel & mapToPixel() const
Returns the context's map to pixel transform, which transforms between map coordinates and device coo...
void setExtent(const QgsRectangle &extent)
When rendering a map layer, calling this method sets the "clipping" extent for the layer (in the laye...
void setMapToPixel(const QgsMapToPixel &mtp)
Sets the context's map to pixel transform, which transforms between map coordinates and device coordi...
void setPainter(QPainter *p)
Sets the destination QPainter for the render operation.
static QgsRenderContext fromMapSettings(const QgsMapSettings &mapSettings)
create initialized QgsRenderContext instance from given QgsMapSettings
static QgsRenderContext fromQPainter(QPainter *painter)
Creates a default render context given a pixel based QPainter destination.
Calculates scale for a given combination of canvas size, map extent, and monitor dpi.
double calculate(const QgsRectangle &mapExtent, double canvasWidth) const
Calculate the scale denominator.
Scoped object for temporary scaling of a QgsRenderContext for millimeter based rendering.
Bad request error API exception.
static QgsDateTimeRange parseTemporalDateTimeInterval(const QString &interval)
Parses a datetime interval and returns a QgsDateTimeRange.
Exception base class for server exceptions.
static QString getExpressionFromServerFid(const QString &serverFid, const QgsVectorDataProvider *provider)
Returns the expression feature id based on primary keys.
static QgsFeatureRequest updateFeatureRequestFromServerFids(QgsFeatureRequest &featureRequest, const QStringList &serverFids, const QgsVectorDataProvider *provider)
Returns the feature request based on feature ids build with primary keys.
static QString getServerFid(const QgsFeature &feature, const QgsAttributeList &pkAttributes)
Returns the feature id based on primary keys.
static QString wmsFeatureInfoSchema(const QgsProject &project)
Returns the schema URL for XML GetFeatureInfo request.
static bool wmsInfoFormatSia2045(const QgsProject &project)
Returns if the info format is SIA20145.
static QString wmsFeatureInfoDocumentElementNs(const QgsProject &project)
Returns the document element namespace for XML GetFeatureInfo request.
static QStringList wmsRestrictedComposers(const QgsProject &project)
Returns the restricted composer list.
static bool wmsFeatureInfoSegmentizeWktGeometry(const QgsProject &project)
Returns if the geometry has to be segmentize in GetFeatureInfo request.
static bool wmsFeatureInfoUseAttributeFormSettings(const QgsProject &project)
Returns if feature form settings should be considered for the format of the feature info response.
static QHash< QString, QString > wmsFeatureInfoLayerAliasMap(const QgsProject &project)
Returns the mapping between layer name and wms layer name for GetFeatureInfo request.
static bool wmsFeatureInfoAddWktGeometry(const QgsProject &project)
Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request.
static double wmsDefaultMapUnitsPerMm(const QgsProject &project)
Returns the default number of map units per millimeters in case of the scale is not given.
static QString wmsFeatureInfoDocumentElement(const QgsProject &project)
Returns the document element name for XML GetFeatureInfo request.
static int wmsMaxAtlasFeatures(const QgsProject &project)
Returns the maximum number of atlas features which can be printed in a request.
int maxThreads() const
Returns the maximum number of threads to use.
bool logProfile() const
Returns true if profile information has to be added to the logs, default value is false.
QStringList allowedExtraSqlTokens() const
Returns the list of strings that represent the allowed extra SQL tokens accepted as components of a f...
bool parallelRendering() const
Returns parallel rendering setting.
const QList< QgsServerWmsDimensionProperties::WmsDimensionInfo > wmsDimensions() const
Returns the QGIS Server WMS Dimension list.
Contains utility functions for working with symbols and symbol layers.
static QString symbolProperties(QgsSymbol *symbol)
Returns a string representing the symbol.
Abstract base class for all rendered symbols.
Definition qgssymbol.h:231
@ Hidden
Hide task from GUI.
bool isActive() const
Returns true if the temporal property is active.
void setIsActive(bool active)
Sets whether the temporal property is active.
void setIsTemporal(bool enabled)
Sets whether the temporal range is enabled (i.e.
void setTemporalRange(const QgsDateTimeRange &range)
Sets the temporal range for the object.
Container for settings relating to a text buffer.
void setColor(const QColor &color)
Sets the color for the buffer.
void setEnabled(bool enabled)
Sets whether the text buffer will be drawn.
void setSize(double size)
Sets the size of the buffer.
Container for all settings relating to text rendering.
void setColor(const QColor &color)
Sets the color that text will be rendered in.
void setSize(double size)
Sets the size for rendered text.
void setFont(const QFont &font)
Sets the font used for rendering text.
void setBuffer(const QgsTextBufferSettings &bufferSettings)
Sets the text's buffer settings.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
Base class for vector data providers.
virtual QgsAttributeList pkAttributeIndexes() const
Returns list of indexes of fields that make up the primary key.
bool addFeatures(QgsFeatureList &flist, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a list of features to the sink.
Basic implementation of the labeling interface.
Represents a vector layer which manages a vector based dataset.
void setLabeling(QgsAbstractVectorLayerLabeling *labeling)
Sets labeling configuration.
QString attributeDisplayName(int index) const
Convenience function that returns the attribute alias if defined or the field name else.
bool labelsEnabled() const
Returns whether the layer contains labels which are enabled and should be drawn.
QgsMapLayerTemporalProperties * temporalProperties() override
Returns the layer's temporal properties.
void updateFields()
Will regenerate the fields property of this layer by obtaining all fields from the dataProvider,...
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
void setLabelsEnabled(bool enabled)
Sets whether labels should be enabled for the layer.
Q_INVOKABLE void selectByExpression(const QString &expression, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection, QgsExpressionContext *context=nullptr)
Selects matching features using an expression.
const QgsAbstractVectorLayerLabeling * labeling() const
Access to const labeling configuration.
void setRenderer(QgsFeatureRenderer *r)
Sets the feature renderer which will be invoked to represent this layer in 2D map views.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
QgsFeatureRenderer * renderer()
Returns the feature renderer used for rendering the features in the layer in 2D map views.
QString displayExpression
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
QgsEditorWidgetSetup editorWidgetSetup(int index) const
Returns the editor widget setup for the field at the specified index.
Q_INVOKABLE void selectByIds(const QgsFeatureIds &ids, Qgis::SelectBehavior behavior=Qgis::SelectBehavior::SetSelection)
Selects matching features using a list of feature IDs.
Q_INVOKABLE Qgis::GeometryType geometryType() const
Returns point, line or polygon.
virtual bool setSubsetString(const QString &subset)
Sets the string (typically sql) used to define a subset of the layer.
QgsAttributeList primaryKeyAttributes() const
Returns the list of attributes which make up the layer's primary keys.
QgsEditFormConfig editFormConfig
Q_INVOKABLE QgsFeature getFeature(QgsFeatureId fid) const
Queries the layer for the feature with the given id.
QSet< QVariant > uniqueValues(int fieldIndex, int limit=-1) const FINAL
Calculates a list of unique values contained within an attribute in the layer.
Implements a map layer that is dedicated to rendering of vector tiles.
static QString displayString(Qgis::WkbType type)
Returns a non-translated display string type for a WKB type, e.g., the geometry name used in WKT geom...
static bool isCurvedType(Qgis::WkbType type)
Returns true if the WKB type is a curved type or can contain curved geometries.
static Qgis::WkbType flatType(Qgis::WkbType type)
Returns the flat type for a WKB type.
Implementation of legend node interface for displaying WMS legend entries.
Exception thrown in case of malformed request.
QgsRenderer(const QgsWmsRenderContext &context)
Constructor for QgsRenderer.
QHash< QgsVectorLayer *, SymbolSet > HitTest
QByteArray getPrint()
Returns printed page as binary.
HitTest symbols()
Returns the hit test according to the current context.
std::unique_ptr< QgsDxfExport > getDxf()
Returns the map as DXF data.
QSet< QString > SymbolSet
void configureLayers(QList< QgsMapLayer * > &layers, QgsMapSettings *settings=nullptr)
Configures layers for rendering optionally considering the map settings.
std::unique_ptr< QgsMapRendererTask > getPdf(const QString &tmpFileName)
Returns a configured pdf export task.
QByteArray getFeatureInfo(const QString &version="1.3.0")
Creates an xml document that describes the result of the getFeatureInfo request.
QImage * getLegendGraphics(QgsLayerTreeModel &model)
Returns the map legend as an image (or nullptr in case of error).
std::unique_ptr< QImage > getMap()
Returns the map as an image (or nullptr in case of error).
QJsonObject getLegendGraphicsAsJson(QgsLayerTreeModel &model, const Qgis::LegendJsonRenderFlags &jsonRenderFlags=Qgis::LegendJsonRenderFlags())
Returns the map legend as a JSON object.
Exception class for WMS service exceptions.
ExceptionCode
Exception codes as defined in OGC scpecifications for WMS 1.1.1 and WMS 1.3.0.
WMS parameter received from the client.
bool htmlInfoOnlyMapTip() const
Returns true if only maptip information is requested for HTML feature info response.
double dxfScale() const
Returns the DXF SCALE parameter.
bool transparentAsBool() const
Returns TRANSPARENT parameter as a bool or its default value if not defined.
QString x() const
Returns X parameter or an empty string if not defined.
QString formatAsString() const
Returns FORMAT parameter as a string.
QgsProjectVersion versionAsNumber() const
Returns VERSION parameter if defined or its default value.
QgsWmsParametersComposerMap composerMapParameters(int mapId) const
Returns the requested parameters for a composer map parameter.
QgsRectangle bboxAsRectangle() const
Returns BBOX as a rectangle if defined and valid.
bool withGeometry() const
Returns if the client wants the feature info response with geometry information.
DxfFormatOption
Options for DXF format.
QString pointTolerance() const
Returns FI_POINT_TOLERANCE parameter or an empty string if not defined.
QString filterGeom() const
Returns the filter geometry found in FILTER_GEOM parameter.
QString composerTemplate() const
Returns TEMPLATE parameter or an empty string if not defined.
Format infoFormat() const
Returns infoFormat.
QString y() const
Returns Y parameter or an empty string if not defined.
double dpiAsDouble() const
Returns DPI parameter as an int or its default value if not defined.
void dump() const
Dumps parameters.
int pointToleranceAsInt() const
Returns FI_POINT_TOLERANCE parameter as an integer.
bool withMapTip() const
withMapTip
QString polygonTolerance() const
Returns FI_POLYGON_TOLERANCE parameter or an empty string if not defined.
QString i() const
Returns I parameter or an empty string if not defined.
bool pdfLosslessImageCompression() const
Returns true if images embedded in pdf must be compressed using a lossless algorithm.
int lineToleranceAsInt() const
Returns FI_LINE_TOLERANCE parameter as an integer.
QString lineTolerance() const
Returns FI_LINE_TOLERANCE parameter or an empty string if not defined.
QStringList pdfExportMapThemes() const
Returns map themes for geospatial PDF export.
bool pdfExportMetadata() const
Returns true if metadata shall be added to the pdf.
QString j() const
Returns J parameter or an empty string if not defined.
int xAsInt() const
Returns X parameter as an int or its default value if not defined.
QString bbox() const
Returns BBOX if defined or an empty string.
int heightAsInt() const
Returns HEIGHT parameter as an int or its default value if not defined.
QColor backgroundColorAsColor() const
Returns BGCOLOR parameter as a QColor or its default value if not defined.
Format format() const
Returns format.
QStringList atlasPk() const
Returns the ATLAS_PK parameter.
QList< QgsWmsParametersHighlightLayer > highlightLayersParameters() const
Returns parameters for each highlight layer.
int iAsInt() const
Returns I parameter as an int or its default value if not defined.
bool pdfAppendGeoreference() const
Returns true if georeference info shall be added to the pdf.
int polygonToleranceAsInt() const
Returns FI_POLYGON_TOLERANCE parameter as an integer.
int widthAsInt() const
Returns WIDTH parameter as an int or its default value if not defined.
QString sldBody() const
Returns SLD_body if defined or an empty string.
bool pdfDisableTiledRasterRendering() const
Returns true if rasters shall be untiled in the pdf.
QString layoutParameter(const QString &id, bool &ok) const
Returns a layout parameter thanks to its id.
bool dxfUseLayerTitleAsName() const
Returns the DXF USE_TITLE_AS_LAYERNAME parameter.
bool pdfForceVectorOutput() const
Returns if pdf should be exported as vector.
bool writeGeospatialPdf() const
Returns if a geospatial PDF shall be exported.
bool pdfUseIso32000ExtensionFormatGeoreferencing() const
Returns true, if Iso32000 georeferencing shall be used.
QMap< QString, QString > dimensionValues() const
Returns the dimensions parameter.
bool withDisplayName() const
withDisplayName
int infoFormatVersion() const
Returns the infoFormat version for GML.
QgsLegendSettings legendSettings() const
Returns legend settings.
Qgis::TextRenderFormat pdfTextRenderFormat() const
Returns text render format for pdf export.
QStringList dxfLayerAttributes() const
Returns the DXF LAYERATTRIBUTES parameter.
Qgis::FeatureSymbologyExport dxfMode() const
Returns the DXF MODE parameter.
QString height() const
Returns HEIGHT parameter or an empty string if not defined.
QString crs() const
Returns CRS or an empty string if none is defined.
int featureCountAsInt() const
Returns FEATURE_COUNT as an integer.
int yAsInt() const
Returns Y parameter as an int or its default value if not defined.
QMap< T, QString > formatOptions() const
Returns the format options for an output format.
Format
Output format for the response.
QString width() const
Returns WIDTH parameter or an empty string if not defined.
QStringList filters() const
Returns the list of filters found in FILTER parameter.
QString dpi() const
Returns DPI parameter or an empty string if not defined.
int jAsInt() const
Returns J parameter as an int or its default value if not defined.
QVector< qreal > pdfPredefinedMapScales() const
Returns list of map scales.
bool pdfSimplifyGeometries() const
Returns if geometries shall to be simplified.
QStringList queryLayersNickname() const
Returns nickname of layers found in QUERY_LAYERS parameter.
Rendering context for the WMS renderer.
QSize mapSize(bool aspectRatio=true) const
Returns the size (in pixels) of the map to render, according to width and height WMS parameters as we...
bool isExternalLayer(const QString &name) const
Returns true if the layer is an external layer, false otherwise.
bool isValidGroup(const QString &name) const
Returns true if name is a group.
QStringList flattenedQueryLayers(const QStringList &layerNames) const
Returns a list of query layer names where group names are replaced by the names of their layer compon...
QgsFeedback * socketFeedback() const
Returns the response feedback if any.
QList< QgsMapLayer * > layersToRender() const
Returns a list of all layers to actually render according to the current configuration.
QgsMapLayer * layer(const QString &nickname) const
Returns the layer corresponding to the nickname, or a nullptr if not found or if the layer do not nee...
bool updateExtent() const
Returns true if the extent has to be updated before the rendering, false otherwise.
const QgsServerSettings & settings() const
Returns settings of the server.
bool isValidWidthHeight() const
Returns true if width and height are valid according to the maximum values defined within the project...
QList< QgsMapLayer * > layersFromGroup(const QString &nickname) const
Returns the group's layers list corresponding to the nickname, or an empty list if not found.
QgsWmsParameters parameters() const
Returns WMS parameters.
void setScaleDenominator(double scaleDenominator)
Sets a custom scale denominator.
QString style(const QgsMapLayer &layer) const
Returns a style's name for a specific layer.
QMap< QString, QList< QgsMapLayer * > > layerGroups() const
Returns a map having layer group names as keys and a list of layers as values.
double mapTileBuffer(int mapWidth) const
Returns the tile buffer in geographical units for the given map width in pixels.
QString layerNickname(const QgsMapLayer &layer) const
Returns the nickname (short name, id or name) of the layer according to the current configuration.
qreal dotsPerMm() const
Returns default dots per mm according to the current configuration.
bool testFlag(Flag flag) const
Returns the status of a rendering flag.
QDomElement sld(const QgsMapLayer &layer) const
Returns a SLD document for a specific layer.
bool isValidLayer(const QString &nickname) const
Returns true if the layer has to be rendered, false otherwise.
const QgsProject * project() const
Returns the project.
int precision() const
Returns the precision to use according to the current configuration.
bool renderMapTiles() const
Returns true if WMS requests should use the QgsMapSettings::RenderMapTile flag, so that no visible ar...
RAII class to restore the rendering context configuration on destruction.
Median cut implementation.
QgsLayerTreeModelLegendNode * legendNode(const QString &rule, QgsLayerTreeModel &model)
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
#define Q_NOWARN_DEPRECATED_POP
Definition qgis.h:6819
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
Definition qgis.h:6203
#define Q_NOWARN_DEPRECATED_PUSH
Definition qgis.h:6818
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition qgis.h:6286
QList< QgsFeature > QgsFeatureList
QSet< QgsFeatureId > QgsFeatureIds
#define FID_TO_STRING(fid)
QVector< QgsFeatureStore > QgsFeatureStoreList
QList< int > QgsAttributeList
Definition qgsfield.h:27
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:41
QgsTemporalRange< QDateTime > QgsDateTimeRange
QgsRange which stores a range of date times.
Definition qgsrange.h:760
const QgsCoordinateReferenceSystem & outputCrs
const QgsCoordinateReferenceSystem & crs
const QString & typeName
bool withGeom
QgsAbstractMetadataBase::KeywordMap keywords
Metadata keyword map.
QDateTime creationDateTime
Metadata creation datetime.
bool useIso32000ExtensionFormatGeoreferencing
true if ISO32000 extension format georeferencing should be used.
Layers and optional attribute index to split into multiple layers using attribute value as layer name...
Single variable definition for use within a QgsExpressionContextScope.
Q_NOWARN_DEPRECATED_POP QgsRenderContext * context
Render context, if available.
Contains settings relating to exporting layouts to raster images.
QList< int > pages
List of specific pages to export, or an empty list to export all pages.
QSize imageSize
Manual size in pixels for output image.
QgsLayoutRenderContext::Flags flags
Layout context flags, which control how the export will be created.
double dpi
Resolution to export layout at. If dpi <= 0 the default layout dpi will be used.
QVector< qreal > predefinedMapScales
A list of predefined scales to use with the layout.
Contains settings relating to exporting layouts to PDF.
bool useIso32000ExtensionFormatGeoreferencing
true if ISO3200 extension format georeferencing should be used.
bool forceVectorOutput
Set to true to force vector object exports, even when the resultant appearance will differ from the l...
bool rasterizeWholeImage
Set to true to force whole layout to be rasterized while exporting.
QStringList exportThemes
Optional list of map themes to export as Geospatial PDF layer groups.
bool appendGeoreference
Indicates whether PDF export should append georeference data.
QgsLayoutRenderContext::Flags flags
Layout context flags, which control how the export will be created.
bool writeGeoPdf
true if geospatial PDF files should be created, instead of normal PDF files.
double dpi
Resolution to export layout at. If dpi <= 0 the default layout dpi will be used.
QVector< qreal > predefinedMapScales
A list of predefined scales to use with the layout.
bool simplifyGeometries
Indicates whether vector geometries should be simplified to avoid redundant extraneous detail,...
Qgis::TextRenderFormat textRenderFormat
Text rendering format, which controls how text should be rendered in the export (e....
Contains settings relating to exporting layouts to SVG.
double dpi
Resolution to export layout at. If dpi <= 0 the default layout dpi will be used.
QgsLayoutRenderContext::Flags flags
Layout context flags, which control how the export will be created.
QVector< qreal > predefinedMapScales
A list of predefined scales to use with the layout.
Setting to define QGIS Server WMS Dimension.
Setting options for loading vector layers.
QList< QgsWmsParametersLayer > mLayers
QList< QgsWmsParametersHighlightLayer > mHighlightLayers
QList< QgsWmsParametersFilter > mFilter