/
qgswmsprovider.cpp
4296 lines (3624 loc) · 153 KB
/
qgswmsprovider.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
qgswmsprovider.cpp - QGIS Data provider for
OGC Web Map Service layers
-------------------
begin : 17 Mar, 2005
copyright : (C) 2005 by Brendan Morley
email : morb at ozemail dot com dot au
wms-c/wmts support : Jürgen E. Fischer < jef at norbit dot de >, norBIT GmbH
tile retry support : Luigi Pirelli < luipir at gmail dot com >
(funded by Regione Toscana-SITA)
contextual wms legend: Sandro Santilli < strk at keybit dot net >
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#include "qgslogger.h"
#include "qgswmsprovider.h"
#include "qgswmsconnection.h"
#include "qgscoordinatetransform.h"
#include "qgswmsdataitems.h"
#include "qgsdatasourceuri.h"
#include "qgsfeaturestore.h"
#include "qgsgeometry.h"
#include "qgsrasteridentifyresult.h"
#include "qgsrasterlayer.h"
#include "qgsrectangle.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsmapsettings.h"
#include "qgsmessageoutput.h"
#include "qgsmessagelog.h"
#include "qgsnetworkaccessmanager.h"
#include "qgsnetworkreplyparser.h"
#include "qgstilecache.h"
#include "qgsgml.h"
#include "qgsgmlschema.h"
#include "qgswmscapabilities.h"
#include "qgsexception.h"
#include "qgssettings.h"
#include "qgsogrutils.h"
#include <QNetworkRequest>
#include <QNetworkReply>
#include <QNetworkProxy>
#include <QUrl>
#include <QImage>
#include <QImageReader>
#include <QPainter>
#include <QEventLoop>
#include <QTextCodec>
#include <QThread>
#include <QNetworkDiskCache>
#include <QTimer>
#include <QStringBuilder>
#include <ogr_api.h>
#ifdef QGISDEBUG
#include <QFile>
#include <QDir>
#endif
#define ERR(message) QGS_ERROR_MESSAGE(message,"WMS provider")
#define QGS_ERROR(message) QgsError(message,"WMS provider")
QString QgsWmsProvider::WMS_KEY = QStringLiteral( "wms" );
QString QgsWmsProvider::WMS_DESCRIPTION = QStringLiteral( "OGC Web Map Service version 1.3 data provider" );
static QString DEFAULT_LATLON_CRS = QStringLiteral( "CRS:84" );
QMap<QString, QgsWmsStatistics::Stat> QgsWmsStatistics::sData;
//! a helper class for ordering tile requests according to the distance from view center
struct LessThanTileRequest
{
QgsPointXY center;
bool operator()( const QgsWmsProvider::TileRequest &req1, const QgsWmsProvider::TileRequest &req2 )
{
QPointF p1 = req1.rect.center();
QPointF p2 = req2.rect.center();
// using chessboard distance (loading order more natural than euclidean/manhattan distance)
double d1 = std::max( std::fabs( center.x() - p1.x() ), std::fabs( center.y() - p1.y() ) );
double d2 = std::max( std::fabs( center.x() - p2.x() ), std::fabs( center.y() - p2.y() ) );
return d1 < d2;
}
};
QgsWmsProvider::QgsWmsProvider( QString const &uri, const ProviderOptions &options, const QgsWmsCapabilities *capabilities )
: QgsRasterDataProvider( uri, options )
, mHttpGetLegendGraphicResponse( nullptr )
, mImageCrs( DEFAULT_LATLON_CRS )
{
QgsDebugMsgLevel( "constructing with uri '" + uri + "'.", 4 );
mSupportedGetFeatureFormats = QStringList() << QStringLiteral( "text/html" ) << QStringLiteral( "text/plain" ) << QStringLiteral( "text/xml" ) << QStringLiteral( "application/vnd.ogc.gml" ) << QStringLiteral( "application/json" );
mValid = false;
// URL may contain username/password information for a WMS
// requiring authentication. In this case the URL is prefixed
// with username=user,password=pass,url=http://xxx.xxx.xx/yyy...
if ( !mSettings.parseUri( uri ) )
{
appendError( ERR( tr( "Cannot parse URI" ) ) );
return;
}
if ( !addLayers() )
return;
if ( mSettings.mXyz )
{
// we are working with XYZ tiles
// no need to get capabilities, the whole definition is in URI
// so we just generate a dummy WMTS definition
setupXyzCapabilities( uri );
}
else
{
// we are working with WMS / WMTS server
// if there are already parsed capabilities, use them!
if ( capabilities )
mCaps = *capabilities;
// Make sure we have capabilities - other functions here may need them
if ( !retrieveServerCapabilities() )
{
return;
}
}
// setImageCrs is using mTiled !!!
if ( !setImageCrs( mSettings.mCrsId ) )
{
appendError( ERR( tr( "Cannot set CRS" ) ) );
return;
}
mCrs = QgsCoordinateReferenceSystem::fromOgcWmsCrs( mSettings.mCrsId );
if ( !calculateExtent() || mLayerExtent.isEmpty() )
{
appendError( ERR( tr( "Cannot calculate extent" ) ) );
return;
}
// URL can be in 3 forms:
// 1) http://xxx.xxx.xx/yyy/yyy
// 2) http://xxx.xxx.xx/yyy/yyy?
// 3) http://xxx.xxx.xx/yyy/yyy?zzz=www
mValid = true;
QgsDebugMsgLevel( QStringLiteral( "exiting constructor." ), 4 );
}
QString QgsWmsProvider::prepareUri( QString uri )
{
// some services provide a percent/url encoded (legend) uri string, always decode here
uri = QUrl::fromPercentEncoding( uri.toUtf8() );
if ( uri.contains( QLatin1String( "SERVICE=WMTS" ) ) || uri.contains( QLatin1String( "/WMTSCapabilities.xml" ) ) )
{
return uri;
}
if ( !uri.contains( QLatin1String( "?" ) ) )
{
uri.append( '?' );
}
else if ( uri.right( 1 ) != QLatin1String( "?" ) && uri.right( 1 ) != QLatin1String( "&" ) )
{
uri.append( '&' );
}
return uri;
}
QgsWmsProvider::~QgsWmsProvider()
{
QgsDebugMsgLevel( QStringLiteral( "deconstructing." ), 4 );
}
QgsWmsProvider *QgsWmsProvider::clone() const
{
QgsDataProvider::ProviderOptions options;
QgsWmsProvider *provider = new QgsWmsProvider( dataSourceUri(), options, mCaps.isValid() ? &mCaps : nullptr );
provider->copyBaseSettings( *this );
return provider;
}
QString QgsWmsProvider::getMapUrl() const
{
return mCaps.mCapabilities.capability.request.getMap.dcpType.isEmpty()
? mSettings.mBaseUrl
: prepareUri( mCaps.mCapabilities.capability.request.getMap.dcpType.front().http.get.onlineResource.xlinkHref );
}
QString QgsWmsProvider::getFeatureInfoUrl() const
{
return mCaps.mCapabilities.capability.request.getFeatureInfo.dcpType.isEmpty()
? mSettings.mBaseUrl
: prepareUri( mCaps.mCapabilities.capability.request.getFeatureInfo.dcpType.front().http.get.onlineResource.xlinkHref );
}
QString QgsWmsProvider::getTileUrl() const
{
if ( mCaps.mCapabilities.capability.request.getTile.dcpType.isEmpty() ||
( !mCaps.mCapabilities.capability.request.getTile.allowedEncodings.isEmpty() &&
!mCaps.mCapabilities.capability.request.getTile.allowedEncodings.contains( QStringLiteral( "KVP" ) ) ) )
{
return QString();
}
else
{
return prepareUri( mCaps.mCapabilities.capability.request.getTile.dcpType.front().http.get.onlineResource.xlinkHref );
}
}
static bool isValidLegend( const QgsWmsLegendUrlProperty &l )
{
return l.format.startsWith( QLatin1String( "image/" ) );
}
/**
* Picks a usable legend URL for a given style.
*/
static QString pickLegend( const QgsWmsStyleProperty &s )
{
QString url;
for ( int k = 0; k < s.legendUrl.size() && url.isEmpty(); k++ )
{
const QgsWmsLegendUrlProperty &l = s.legendUrl[k];
if ( isValidLegend( l ) )
{
url = l.onlineResource.xlinkHref;
}
}
return url;
}
static const QgsWmsStyleProperty *searchStyle( const QVector<QgsWmsStyleProperty> &styles, const QString &name )
{
const auto constStyles = styles;
for ( const QgsWmsStyleProperty &s : constStyles )
if ( s.name == name )
return &s;
return nullptr;
}
QString QgsWmsProvider::getLegendGraphicUrl() const
{
QString url;
for ( int i = 0; i < mCaps.mLayersSupported.size() && url.isEmpty(); i++ )
{
const QgsWmsLayerProperty &l = mCaps.mLayersSupported[i];
if ( l.name == mSettings.mActiveSubLayers[0] )
{
if ( !mSettings.mActiveSubStyles[0].isEmpty() && mSettings.mActiveSubStyles[0] != QLatin1String( "default" ) )
{
const QgsWmsStyleProperty *s = searchStyle( l.style, mSettings.mActiveSubStyles[0] );
if ( s )
url = pickLegend( *s );
}
else
{
// QGIS wants the default style, but GetCapabilities doesn't give us a
// way to know what is the default style. So we look for the onlineResource
// only if there is a single style available or if there is a style called "default".
if ( l.style.size() == 1 )
{
url = pickLegend( l.style[0] );
}
else
{
const QgsWmsStyleProperty *s = searchStyle( l.style, QStringLiteral( "default" ) );
if ( s )
url = pickLegend( *s );
}
}
break;
}
}
if ( url.isEmpty() && !mCaps.mCapabilities.capability.request.getLegendGraphic.dcpType.isEmpty() )
{
url = mCaps.mCapabilities.capability.request.getLegendGraphic.dcpType.front().http.get.onlineResource.xlinkHref;
}
return url.isEmpty() ? url : prepareUri( url );
}
bool QgsWmsProvider::addLayers()
{
QgsDebugMsgLevel( "Entering: layers:" + mSettings.mActiveSubLayers.join( ", " ) + ", styles:" + mSettings.mActiveSubStyles.join( ", " ), 4 );
if ( mSettings.mActiveSubLayers.size() != mSettings.mActiveSubStyles.size() )
{
QgsMessageLog::logMessage( tr( "Number of layers and styles don't match" ), tr( "WMS" ) );
return false;
}
// Set the visibility of these new layers on by default
for ( const QString &layer : qgis::as_const( mSettings.mActiveSubLayers ) )
{
mActiveSubLayerVisibility[ layer ] = true;
QgsDebugMsgLevel( QStringLiteral( "set visibility of layer '%1' to true." ).arg( layer ), 3 );
}
// now that the layers have changed, the extent will as well.
mExtentDirty = true;
if ( mSettings.mTiled )
mTileLayer = nullptr;
QgsDebugMsgLevel( QStringLiteral( "Exiting." ), 4 );
return true;
}
void QgsWmsProvider::setConnectionName( QString const &connName )
{
mConnectionName = connName;
}
void QgsWmsProvider::setLayerOrder( QStringList const &layers )
{
QgsDebugMsg( QStringLiteral( "Entering." ) );
if ( layers.size() != mSettings.mActiveSubLayers.size() )
{
QgsDebugMsg( QStringLiteral( "Invalid layer list length" ) );
return;
}
QMap<QString, QString> styleMap;
for ( int i = 0; i < mSettings.mActiveSubLayers.size(); i++ )
{
styleMap.insert( mSettings.mActiveSubLayers[i], mSettings.mActiveSubStyles[i] );
}
for ( int i = 0; i < layers.size(); i++ )
{
if ( !styleMap.contains( layers[i] ) )
{
QgsDebugMsg( QStringLiteral( "Layer %1 not found" ).arg( layers[i] ) );
return;
}
}
mSettings.mActiveSubLayers = layers;
mSettings.mActiveSubStyles.clear();
for ( int i = 0; i < layers.size(); i++ )
{
mSettings.mActiveSubStyles.append( styleMap[ layers[i] ] );
}
QgsDebugMsg( QStringLiteral( "Exiting." ) );
}
void QgsWmsProvider::setSubLayerVisibility( QString const &name, bool vis )
{
if ( !mActiveSubLayerVisibility.contains( name ) )
{
QgsDebugMsg( QStringLiteral( "Layer %1 not found." ).arg( name ) );
return;
}
mActiveSubLayerVisibility[name] = vis;
}
bool QgsWmsProvider::setImageCrs( QString const &crs )
{
QgsDebugMsgLevel( "Setting image CRS to " + crs + '.', 3 );
if ( crs != mImageCrs && !crs.isEmpty() )
{
mExtentDirty = true;
mImageCrs = crs;
}
if ( mSettings.mTiled )
{
if ( mSettings.mActiveSubLayers.size() != 1 )
{
appendError( ERR( tr( "Number of tile layers must be one" ) ) );
return false;
}
QgsDebugMsgLevel( QStringLiteral( "mTileLayersSupported.size() = %1" ).arg( mCaps.mTileLayersSupported.size() ), 2 );
if ( mCaps.mTileLayersSupported.isEmpty() )
{
appendError( ERR( tr( "Tile layer not found" ) ) );
return false;
}
for ( int i = 0; i < mCaps.mTileLayersSupported.size(); i++ )
{
QgsWmtsTileLayer *tl = &mCaps.mTileLayersSupported[i];
if ( tl->identifier != mSettings.mActiveSubLayers[0] )
continue;
if ( mSettings.mTileMatrixSetId.isEmpty() && tl->setLinks.size() == 1 )
{
QString tms = tl->setLinks.keys()[0];
if ( !mCaps.mTileMatrixSets.contains( tms ) )
{
QgsDebugMsg( QStringLiteral( "tile matrix set '%1' not found." ).arg( tms ) );
continue;
}
if ( mCaps.mTileMatrixSets[ tms ].crs != mImageCrs )
{
QgsDebugMsg( QStringLiteral( "tile matrix set '%1' has crs %2 instead of %3." ).arg( tms, mCaps.mTileMatrixSets[ tms ].crs, mImageCrs ) );
continue;
}
// fill in generate matrix for WMS-C
mSettings.mTileMatrixSetId = tms;
}
mTileLayer = tl;
break;
}
mNativeResolutions.clear();
if ( mCaps.mTileMatrixSets.contains( mSettings.mTileMatrixSetId ) )
{
mTileMatrixSet = &mCaps.mTileMatrixSets[ mSettings.mTileMatrixSetId ];
QList<double> keys = mTileMatrixSet->tileMatrices.keys();
std::sort( keys.begin(), keys.end() );
const auto constKeys = keys;
for ( double key : constKeys )
{
mNativeResolutions << key;
}
if ( !mTileMatrixSet->tileMatrices.empty() )
{
setProperty( "tileWidth", mTileMatrixSet->tileMatrices.values().first().tileWidth );
setProperty( "tileHeight", mTileMatrixSet->tileMatrices.values().first().tileHeight );
}
}
else
{
QgsDebugMsg( QStringLiteral( "Expected tile matrix set '%1' not found." ).arg( mSettings.mTileMatrixSetId ) );
mTileMatrixSet = nullptr;
}
if ( !mTileLayer || !mTileMatrixSet )
{
appendError( ERR( tr( "Tile layer or tile matrix set not found" ) ) );
return false;
}
}
return true;
}
void QgsWmsProvider::setQueryItem( QUrl &url, const QString &item, const QString &value )
{
url.removeQueryItem( item );
if ( value.isNull() )
url.addQueryItem( item, "" );
else
url.addQueryItem( item, value );
}
void QgsWmsProvider::setFormatQueryItem( QUrl &url )
{
url.removeQueryItem( QStringLiteral( "FORMAT" ) );
if ( mSettings.mImageMimeType.contains( '+' ) )
{
QString format( mSettings.mImageMimeType );
format.replace( '+', QLatin1String( "%2b" ) );
url.addEncodedQueryItem( "FORMAT", format.toUtf8() );
}
else
setQueryItem( url, QStringLiteral( "FORMAT" ), mSettings.mImageMimeType );
}
static bool _fuzzyContainsRect( const QRectF &r1, const QRectF &r2 )
{
double significantDigits = std::log10( std::max( r1.width(), r1.height() ) );
double epsilon = std::pow( 10.0, significantDigits - 5 ); // floats have 6-9 significant digits
return r1.contains( r2.adjusted( epsilon, epsilon, -epsilon, -epsilon ) );
}
void QgsWmsProvider::fetchOtherResTiles( QgsTileMode tileMode, const QgsRectangle &viewExtent, int imageWidth, QList<QRectF> &missingRects, double tres, int resOffset, QList<TileImage> &otherResTiles )
{
if ( !mTileMatrixSet )
return; // there is no tile matrix set defined for ordinary WMS (with user-specified tile size)
const QgsWmtsTileMatrix *tmOther = mTileMatrixSet->findOtherResolution( tres, resOffset );
if ( !tmOther )
return;
QSet<TilePosition> tilesSet;
const auto constMissingRects = missingRects;
for ( const QRectF &missingTileRect : constMissingRects )
{
int c0, r0, c1, r1;
tmOther->viewExtentIntersection( QgsRectangle( missingTileRect ), nullptr, c0, r0, c1, r1 );
for ( int row = r0; row <= r1; row++ )
{
for ( int col = c0; col <= c1; col++ )
{
tilesSet << TilePosition( row, col );
}
}
}
// get URLs of tiles because their URLs are used as keys in the tile cache
TilePositions tiles = tilesSet.toList();
TileRequests requests;
switch ( tileMode )
{
case WMSC:
createTileRequestsWMSC( tmOther, tiles, requests );
break;
case WMTS:
createTileRequestsWMTS( tmOther, tiles, requests );
break;
case XYZ:
createTileRequestsXYZ( tmOther, tiles, requests );
break;
}
QList<QRectF> missingRectsToDelete;
const auto constRequests = requests;
for ( const TileRequest &r : constRequests )
{
QImage localImage;
if ( ! QgsTileCache::tile( r.url, localImage ) )
continue;
double cr = viewExtent.width() / imageWidth;
QRectF dst( ( r.rect.left() - viewExtent.xMinimum() ) / cr,
( viewExtent.yMaximum() - r.rect.bottom() ) / cr,
r.rect.width() / cr,
r.rect.height() / cr );
otherResTiles << TileImage( dst, localImage, false );
// see if there are any missing rects that are completely covered by this tile
const auto constMissingRects = missingRects;
for ( const QRectF &missingRect : constMissingRects )
{
// we need to do a fuzzy "contains" check because the coordinates may not align perfectly
// due to numerical errors and/or transform of coords from double to floats
if ( _fuzzyContainsRect( r.rect, missingRect ) )
{
missingRectsToDelete << missingRect;
}
}
}
// remove all the rectangles we have completely covered by tiles from this resolution
// so we will not use tiles from multiple resolutions for one missing tile (to save time)
const auto constMissingRectsToDelete = missingRectsToDelete;
for ( const QRectF &rectToDelete : constMissingRectsToDelete )
{
missingRects.removeOne( rectToDelete );
}
QgsDebugMsgLevel( QStringLiteral( "Other resolution tiles: offset %1, res %2, missing rects %3, remaining rects %4, added tiles %5" )
.arg( resOffset )
.arg( tmOther->tres )
.arg( missingRects.count() + missingRectsToDelete.count() )
.arg( missingRects.count() )
.arg( otherResTiles.count() ), 3 );
}
uint qHash( QgsWmsProvider::TilePosition tp )
{
return ( uint ) tp.col + ( ( uint ) tp.row << 16 );
}
static void _drawDebugRect( QPainter &p, const QRectF &rect, const QColor &color )
{
#if 0 // good for debugging how tiles from various resolutions are used
QPainter::CompositionMode oldMode = p.compositionMode();
p.setCompositionMode( QPainter::CompositionMode_SourceOver );
QColor c = color;
c.setAlpha( 100 );
p.fillRect( rect, QBrush( c, Qt::DiagCrossPattern ) );
p.setCompositionMode( oldMode );
#else
Q_UNUSED( p )
Q_UNUSED( rect )
Q_UNUSED( color )
#endif
}
QImage *QgsWmsProvider::draw( QgsRectangle const &viewExtent, int pixelWidth, int pixelHeight, QgsRasterBlockFeedback *feedback )
{
if ( qApp && qApp->thread() == QThread::currentThread() )
{
QgsDebugMsg( QStringLiteral( "Trying to draw a WMS image on the main thread. Stop it!" ) );
}
// compose the URL query string for the WMS server.
QImage *image = new QImage( pixelWidth, pixelHeight, QImage::Format_ARGB32 );
image->fill( 0 );
int maxWidth = mCaps.mCapabilities.service.maxWidth == 0 ? std::numeric_limits<int>::max() : mCaps.mCapabilities.service.maxWidth;
int maxHeight = mCaps.mCapabilities.service.maxHeight == 0 ? std::numeric_limits<int>::max() : mCaps.mCapabilities.service.maxHeight;
if ( !mSettings.mTiled && mSettings.mMaxWidth == 0 && mSettings.mMaxHeight == 0 && pixelWidth <= maxWidth && pixelHeight <= maxHeight )
{
QUrl url = createRequestUrlWMS( viewExtent, pixelWidth, pixelHeight );
// cache some details for if the user wants to do an identifyAsHtml() later
emit statusChanged( tr( "Getting map via WMS." ) );
QgsWmsImageDownloadHandler handler( dataSourceUri(), url, mSettings.authorization(), image, feedback );
handler.downloadBlocking();
}
else
{
mTileReqNo++;
double vres = viewExtent.width() / pixelWidth;
const QgsWmtsTileMatrix *tm = nullptr;
std::unique_ptr<QgsWmtsTileMatrix> tempTm;
enum QgsTileMode tileMode;
if ( mSettings.mTiled )
{
Q_ASSERT( mTileLayer );
Q_ASSERT( mTileMatrixSet );
if ( mTileMatrixSet->tileMatrices.isEmpty() )
{
QgsDebugMsg( QStringLiteral( "WMTS tile set is empty!" ) );
return image;
}
// if we know both source and output DPI, let's scale the tiles
if ( mDpi != -1 && mTileLayer->dpi != -1 )
vres *= static_cast<double>( mDpi ) / mTileLayer->dpi;
// find nearest resolution
tm = mTileMatrixSet->findNearestResolution( vres );
Q_ASSERT( tm );
tileMode = mTileLayer->tileMode;
}
else if ( ( mSettings.mMaxWidth != 0 && mSettings.mMaxHeight != 0 ) || pixelWidth > maxWidth || pixelHeight > maxHeight )
{
int w = mSettings.mMaxWidth != 0 && mSettings.mMaxWidth < maxWidth ? mSettings.mMaxWidth : maxWidth;
int h = mSettings.mMaxHeight != 0 && mSettings.mMaxHeight < maxHeight ? mSettings.mMaxHeight : maxHeight;
// this is an ordinary WMS server, but the user requested tiled approach
// so we will pretend it is a WMS-C server with just one tile matrix
tempTm.reset( new QgsWmtsTileMatrix );
tempTm->topLeft = QgsPointXY( mLayerExtent.xMinimum(), mLayerExtent.yMaximum() );
tempTm->tileWidth = w;
tempTm->tileHeight = h;
tempTm->matrixWidth = std::ceil( mLayerExtent.width() / w / vres );
tempTm->matrixHeight = std::ceil( mLayerExtent.height() / h / vres );
tempTm->tres = vres;
tm = tempTm.get();
tileMode = WMSC;
}
else
{
QgsDebugMsg( QStringLiteral( "empty tile size" ) );
return image;
}
QgsDebugMsg( QStringLiteral( "layer extent: %1,%2,%3,%4 %5x%6" )
.arg( qgsDoubleToString( mLayerExtent.xMinimum() ),
qgsDoubleToString( mLayerExtent.yMinimum() ) )
.arg( qgsDoubleToString( mLayerExtent.xMaximum() ),
qgsDoubleToString( mLayerExtent.yMaximum() ) )
.arg( mLayerExtent.width() )
.arg( mLayerExtent.height() )
);
QgsDebugMsg( QStringLiteral( "view extent: %1,%2,%3,%4 %5x%6 res:%7" )
.arg( qgsDoubleToString( viewExtent.xMinimum() ),
qgsDoubleToString( viewExtent.yMinimum() ) )
.arg( qgsDoubleToString( viewExtent.xMaximum() ),
qgsDoubleToString( viewExtent.yMaximum() ) )
.arg( viewExtent.width() )
.arg( viewExtent.height() )
.arg( vres, 0, 'f' )
);
QgsDebugMsgLevel( QStringLiteral( "tile matrix %1,%2 res:%3 tilesize:%4x%5 matrixsize:%6x%7 id:%8" )
.arg( tm->topLeft.x() ).arg( tm->topLeft.y() ).arg( tm->tres )
.arg( tm->tileWidth ).arg( tm->tileHeight )
.arg( tm->matrixWidth ).arg( tm->matrixHeight )
.arg( tm->identifier ), 3
);
const QgsWmtsTileMatrixLimits *tml = nullptr;
if ( mTileLayer &&
mTileLayer->setLinks.contains( mTileMatrixSet->identifier ) &&
mTileLayer->setLinks[ mTileMatrixSet->identifier ].limits.contains( tm->identifier ) )
{
tml = &mTileLayer->setLinks[ mTileMatrixSet->identifier ].limits[ tm->identifier ];
}
// calculate tile coordinates
int col0, col1, row0, row1;
tm->viewExtentIntersection( viewExtent, tml, col0, row0, col1, row1 );
#ifdef QGISDEBUG
int n = ( col1 - col0 + 1 ) * ( row1 - row0 + 1 );
QgsDebugMsgLevel( QStringLiteral( "tile number: %1x%2 = %3" ).arg( col1 - col0 + 1 ).arg( row1 - row0 + 1 ).arg( n ), 3 );
if ( n > 256 )
{
emit statusChanged( QStringLiteral( "current view would need %1 tiles. tile request per draw limited to 256." ).arg( n ) );
return image;
}
#endif
TilePositions tiles;
for ( int row = row0; row <= row1; row++ )
{
for ( int col = col0; col <= col1; col++ )
{
tiles << TilePosition( row, col );
}
}
TileRequests requests;
switch ( tileMode )
{
case WMSC:
createTileRequestsWMSC( tm, tiles, requests );
break;
case WMTS:
createTileRequestsWMTS( tm, tiles, requests );
break;
case XYZ:
createTileRequestsXYZ( tm, tiles, requests );
break;
default:
QgsDebugMsg( QStringLiteral( "unexpected tile mode %1" ).arg( mTileLayer->tileMode ) );
return image;
}
emit statusChanged( tr( "Getting tiles." ) );
QList<TileImage> tileImages; // in the correct resolution
QList<QRectF> missing; // rectangles (in map coords) of missing tiles for this view
QTime t;
t.start();
TileRequests requestsFinal;
const auto constRequests = requests;
for ( const TileRequest &r : constRequests )
{
QImage localImage;
if ( QgsTileCache::tile( r.url, localImage ) )
{
double cr = viewExtent.width() / image->width();
QRectF dst( ( r.rect.left() - viewExtent.xMinimum() ) / cr,
( viewExtent.yMaximum() - r.rect.bottom() ) / cr,
r.rect.width() / cr,
r.rect.height() / cr );
// if image size is "close enough" to destination size, don't smooth it out. Instead try for pixel-perfect placement!
bool disableSmoothing = ( qgsDoubleNear( dst.width(), tm->tileWidth, 2 ) && qgsDoubleNear( dst.height(), tm->tileHeight, 2 ) );
tileImages << TileImage( dst, localImage, !disableSmoothing );
}
else
{
missing << r.rect;
// need to make a request
requestsFinal << r;
}
}
int t0 = t.elapsed();
// draw other res tiles if preview
QPainter p( image );
if ( feedback && feedback->isPreviewOnly() && missing.count() > 0 )
{
// some tiles are still missing, so let's see if we have any cached tiles
// from lower or higher resolution available to give the user a bit of context
// while loading the right resolution
p.setCompositionMode( QPainter::CompositionMode_Source );
#if 0 // for debugging
p.fillRect( image->rect(), QBrush( Qt::lightGray, Qt::CrossPattern ) );
#endif
p.setRenderHint( QPainter::SmoothPixmapTransform, false ); // let's not waste time with bilinear filtering
QList<TileImage> lowerResTiles, lowerResTiles2, higherResTiles;
// first we check lower resolution tiles: one level back, then two levels back (if there is still some area not covered),
// finally (in the worst case we use one level higher resolution tiles). This heuristic should give
// good overviews while not spending too much time drawing cached tiles from resolutions far away.
fetchOtherResTiles( tileMode, viewExtent, image->width(), missing, tm->tres, 1, lowerResTiles );
fetchOtherResTiles( tileMode, viewExtent, image->width(), missing, tm->tres, 2, lowerResTiles2 );
fetchOtherResTiles( tileMode, viewExtent, image->width(), missing, tm->tres, -1, higherResTiles );
// draw the cached tiles lowest to highest resolution
const auto constLowerResTiles2 = lowerResTiles2;
for ( const TileImage &ti : constLowerResTiles2 )
{
p.drawImage( ti.rect, ti.img );
_drawDebugRect( p, ti.rect, Qt::blue );
}
const auto constLowerResTiles = lowerResTiles;
for ( const TileImage &ti : constLowerResTiles )
{
p.drawImage( ti.rect, ti.img );
_drawDebugRect( p, ti.rect, Qt::yellow );
}
const auto constHigherResTiles = higherResTiles;
for ( const TileImage &ti : constHigherResTiles )
{
p.drawImage( ti.rect, ti.img );
_drawDebugRect( p, ti.rect, Qt::red );
}
}
int t1 = t.elapsed() - t0;
// draw composite in this resolution
const auto constTileImages = tileImages;
for ( const TileImage &ti : constTileImages )
{
if ( ti.smooth && mSettings.mSmoothPixmapTransform )
p.setRenderHint( QPainter::SmoothPixmapTransform, true );
p.drawImage( ti.rect, ti.img );
if ( feedback && feedback->isPreviewOnly() )
_drawDebugRect( p, ti.rect, Qt::green );
}
p.end();
int t2 = t.elapsed() - t1;
Q_UNUSED( t2 ) // only used in debug build
if ( feedback && feedback->isPreviewOnly() )
{
QgsDebugMsgLevel( QStringLiteral( "PREVIEW - CACHED: %1 / MISSING: %2" ).arg( tileImages.count() ).arg( requests.count() - tileImages.count() ), 4 );
QgsDebugMsgLevel( QStringLiteral( "PREVIEW - TIME: this res %1 ms | other res %2 ms | TOTAL %3 ms" ).arg( t0 + t2 ).arg( t1 ).arg( t0 + t1 + t2 ), 4 );
}
else if ( !requestsFinal.isEmpty() )
{
// let the feedback object know about the tiles we have already
if ( feedback && feedback->renderPartialOutput() )
feedback->onNewData();
// order tile requests according to the distance from view center
LessThanTileRequest cmp;
cmp.center = viewExtent.center();
std::sort( requestsFinal.begin(), requestsFinal.end(), cmp );
QgsWmsTiledImageDownloadHandler handler( dataSourceUri(), mSettings.authorization(), mTileReqNo, requestsFinal, image, viewExtent, mSettings.mSmoothPixmapTransform, feedback );
handler.downloadBlocking();
}
QgsDebugMsgLevel( QStringLiteral( "TILE CACHE total: %1 / %2" ).arg( QgsTileCache::totalCost() ).arg( QgsTileCache::maxCost() ), 3 );
#if 0
const QgsWmsStatistics::Stat &stat = QgsWmsStatistics::statForUri( dataSourceUri() );
emit statusChanged( tr( "%n tile requests in background", "tile request count", requests.count() )
+ tr( ", %n cache hits", "tile cache hits", stat.cacheHits )
+ tr( ", %n cache misses.", "tile cache missed", stat.cacheMisses )
+ tr( ", %n errors.", "errors", stat.errors )
);
#endif
}
return image;
}
bool QgsWmsProvider::readBlock( int bandNo, QgsRectangle const &viewExtent, int pixelWidth, int pixelHeight, void *block, QgsRasterBlockFeedback *feedback )
{
Q_UNUSED( bandNo )
// TODO: optimize to avoid writing to QImage
std::unique_ptr< QImage > image( draw( viewExtent, pixelWidth, pixelHeight, feedback ) );
if ( !image ) // should not happen
{
QgsMessageLog::logMessage( tr( "image is NULL" ), tr( "WMS" ) );
return false;
}
QgsDebugMsgLevel( QStringLiteral( "image height = %1 bytesPerLine = %2" ).arg( image->height() ) . arg( image->bytesPerLine() ), 3 );
size_t myExpectedSize = pixelWidth * pixelHeight * 4;
size_t myImageSize = image->height() * image->bytesPerLine();
if ( myExpectedSize != myImageSize ) // should not happen
{
QgsMessageLog::logMessage( tr( "unexpected image size" ), tr( "WMS" ) );
return false;
}
uchar *ptr = image->bits();
if ( ptr )
{
// If image is too large, ptr can be NULL
memcpy( block, ptr, myExpectedSize );
return true;
}
else
{
return false;
}
}
QUrl QgsWmsProvider::createRequestUrlWMS( const QgsRectangle &viewExtent, int pixelWidth, int pixelHeight )
{
// Calculate active layers that are also visible.
bool changeXY = mCaps.shouldInvertAxisOrientation( mImageCrs );
QgsDebugMsg( "Active layer list of " + mSettings.mActiveSubLayers.join( ", " )
+ " and style list of " + mSettings.mActiveSubStyles.join( ", " ) );
QStringList visibleLayers = QStringList();
QStringList visibleStyles = QStringList();
QStringList::const_iterator it2 = mSettings.mActiveSubStyles.constBegin();
for ( QStringList::const_iterator it = mSettings.mActiveSubLayers.constBegin();
it != mSettings.mActiveSubLayers.constEnd();
++it )
{
if ( mActiveSubLayerVisibility.constFind( *it ).value() )
{
visibleLayers += *it;
visibleStyles += *it2;
}
++it2;
}
QString layers = visibleLayers.join( ',' );
layers = layers.isNull() ? QString() : layers;
QString styles = visibleStyles.join( ',' );
styles = styles.isNull() ? QString() : styles;
QgsDebugMsg( "Visible layer list of " + layers + " and style list of " + styles );
QString bbox = toParamValue( viewExtent, changeXY );
QUrl url( mSettings.mIgnoreGetMapUrl ? mSettings.mBaseUrl : getMapUrl() );
setQueryItem( url, QStringLiteral( "SERVICE" ), QStringLiteral( "WMS" ) );
setQueryItem( url, QStringLiteral( "VERSION" ), mCaps.mCapabilities.version );
setQueryItem( url, QStringLiteral( "REQUEST" ), QStringLiteral( "GetMap" ) );
setQueryItem( url, QStringLiteral( "BBOX" ), bbox );
setSRSQueryItem( url );
setQueryItem( url, QStringLiteral( "WIDTH" ), QString::number( pixelWidth ) );
setQueryItem( url, QStringLiteral( "HEIGHT" ), QString::number( pixelHeight ) );
setQueryItem( url, QStringLiteral( "LAYERS" ), layers );
setQueryItem( url, QStringLiteral( "STYLES" ), styles );
setFormatQueryItem( url );
if ( mDpi != -1 )
{
if ( mSettings.mDpiMode & DpiQGIS )
setQueryItem( url, QStringLiteral( "DPI" ), QString::number( mDpi ) );
if ( mSettings.mDpiMode & DpiUMN )
setQueryItem( url, QStringLiteral( "MAP_RESOLUTION" ), QString::number( mDpi ) );
if ( mSettings.mDpiMode & DpiGeoServer )
setQueryItem( url, QStringLiteral( "FORMAT_OPTIONS" ), QStringLiteral( "dpi:%1" ).arg( mDpi ) );
}
//MH: jpeg does not support transparency and some servers complain if jpg and transparent=true
if ( mSettings.mImageMimeType == QLatin1String( "image/x-jpegorpng" ) ||
( !mSettings.mImageMimeType.contains( QLatin1String( "jpeg" ), Qt::CaseInsensitive ) &&
!mSettings.mImageMimeType.contains( QLatin1String( "jpg" ), Qt::CaseInsensitive ) ) )
{
setQueryItem( url, QStringLiteral( "TRANSPARENT" ), QStringLiteral( "TRUE" ) ); // some servers giving error for 'true' (lowercase)