QGIS API Documentation 3.99.0-Master (d270888f95f)
Loading...
Searching...
No Matches
qgsarcgisrestquery.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsarcgisrestquery.cpp
3 ----------------------
4 begin : December 2020
5 copyright : (C) 2020 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#include "qgsarcgisrestquery.h"
17
18#include "qgsapplication.h"
19#include "qgsarcgisrestutils.h"
20#include "qgsauthmanager.h"
22#include "qgslogger.h"
23#include "qgsmessagelog.h"
26#include "qgsvariantutils.h"
27
28#include <QCryptographicHash>
29#include <QFile>
30#include <QImageReader>
31#include <QJsonParseError>
32#include <QRegularExpression>
33#include <QString>
34#include <QUrl>
35#include <QUrlQuery>
36
37#include "moc_qgsarcgisrestquery.cpp"
38
39using namespace Qt::StringLiterals;
40
41QVariantMap QgsArcGisRestQueryUtils::getServiceInfo( const QString &baseurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders, const QString &urlPrefix )
42{
43 // http://sampleserver5.arcgisonline.com/arcgis/rest/services/Energy/Geology/FeatureServer?f=json
44 QUrl queryUrl( baseurl );
45 QUrlQuery query( queryUrl );
46 query.addQueryItem( u"f"_s, u"json"_s );
47 queryUrl.setQuery( query );
48 return queryServiceJSON( queryUrl, authcfg, errorTitle, errorText, requestHeaders, nullptr, urlPrefix );
49}
50
51QVariantMap QgsArcGisRestQueryUtils::getLayerInfo( const QString &layerurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders, const QString &urlPrefix )
52{
53 // http://sampleserver5.arcgisonline.com/arcgis/rest/services/Energy/Geology/FeatureServer/1?f=json
54 QUrl queryUrl( layerurl );
55 QUrlQuery query( queryUrl );
56 query.addQueryItem( u"f"_s, u"json"_s );
57 queryUrl.setQuery( query );
58 return queryServiceJSON( queryUrl, authcfg, errorTitle, errorText, requestHeaders, nullptr, urlPrefix );
59}
60
61QVariantMap QgsArcGisRestQueryUtils::getObjectIds( const QString &layerurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders, const QString &urlPrefix, const QgsRectangle &bbox, const QString &whereClause )
62{
63 // http://sampleserver5.arcgisonline.com/arcgis/rest/services/Energy/Geology/FeatureServer/1/query?where=1%3D1&returnIdsOnly=true&f=json
64 QUrl queryUrl( layerurl + "/query" );
65 QUrlQuery query( queryUrl );
66 query.addQueryItem( u"f"_s, u"json"_s );
67 query.addQueryItem( u"where"_s, whereClause.isEmpty() ? u"1=1"_s : whereClause );
68 query.addQueryItem( u"returnIdsOnly"_s, u"true"_s );
69 if ( !bbox.isNull() )
70 {
71 query.addQueryItem( u"geometry"_s, u"%1,%2,%3,%4"_s
72 .arg( bbox.xMinimum(), 0, 'f', -1 ).arg( bbox.yMinimum(), 0, 'f', -1 )
73 .arg( bbox.xMaximum(), 0, 'f', -1 ).arg( bbox.yMaximum(), 0, 'f', -1 ) );
74 query.addQueryItem( u"geometryType"_s, u"esriGeometryEnvelope"_s );
75 query.addQueryItem( u"spatialRel"_s, u"esriSpatialRelEnvelopeIntersects"_s );
76 }
77 queryUrl.setQuery( query );
78 return queryServiceJSON( queryUrl, authcfg, errorTitle, errorText, requestHeaders, nullptr, urlPrefix );
79}
80
81QgsRectangle QgsArcGisRestQueryUtils::getExtent( const QString &layerurl, const QString &whereClause, const QString &authcfg, const QgsHttpHeaders &requestHeaders, const QString &urlPrefix )
82{
83 // http://sampleserver5.arcgisonline.com/arcgis/rest/services/Energy/Geology/FeatureServer/1/query?where=1%3D1&returnExtentOnly=true&f=json
84 QUrl queryUrl( layerurl + "/query" );
85 QUrlQuery query( queryUrl );
86 query.addQueryItem( u"f"_s, u"json"_s );
87 query.addQueryItem( u"where"_s, whereClause );
88 query.addQueryItem( u"returnExtentOnly"_s, u"true"_s );
89 queryUrl.setQuery( query );
90 QString errorTitle;
91 QString errorText;
92 const QVariantMap res = queryServiceJSON( queryUrl, authcfg, errorTitle, errorText, requestHeaders, nullptr, urlPrefix );
93 if ( res.isEmpty() )
94 {
95 QgsDebugError( u"getExtent failed: %1 - %2"_s.arg( errorTitle, errorText ) );
96 return QgsRectangle();
97 }
98
99 return QgsArcGisRestUtils::convertRectangle( res.value( u"extent"_s ) );
100}
101
102QVariantMap QgsArcGisRestQueryUtils::getObjects( const QString &layerurl, const QString &authcfg, const QList<quint32> &objectIds, const QString &crs,
103 bool fetchGeometry, const QStringList &fetchAttributes,
104 bool fetchM, bool fetchZ,
105 const QgsRectangle &filterRect,
106 QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders, QgsFeedback *feedback, const QString &urlPrefix )
107{
108 QStringList ids;
109 for ( const int id : objectIds )
110 {
111 ids.append( QString::number( id ) );
112 }
113 QUrl queryUrl( layerurl + "/query" );
114 QUrlQuery query( queryUrl );
115 query.addQueryItem( u"f"_s, u"json"_s );
116 query.addQueryItem( u"objectIds"_s, ids.join( ','_L1 ) );
117 if ( !crs.isEmpty() && crs.contains( ':' ) )
118 {
119 const QString wkid = crs.indexOf( ':'_L1 ) >= 0 ? crs.split( ':' )[1] : QString();
120 query.addQueryItem( u"inSR"_s, wkid );
121 query.addQueryItem( u"outSR"_s, wkid );
122 }
123
124 query.addQueryItem( u"returnGeometry"_s, fetchGeometry ? u"true"_s : u"false"_s );
125
126 QString outFields;
127 if ( fetchAttributes.isEmpty() )
128 outFields = u"*"_s;
129 else
130 outFields = fetchAttributes.join( ',' );
131 query.addQueryItem( u"outFields"_s, outFields );
132
133 query.addQueryItem( u"returnM"_s, fetchM ? u"true"_s : u"false"_s );
134 query.addQueryItem( u"returnZ"_s, fetchZ ? u"true"_s : u"false"_s );
135 if ( !filterRect.isNull() )
136 {
137 query.addQueryItem( u"geometry"_s, u"%1,%2,%3,%4"_s
138 .arg( filterRect.xMinimum(), 0, 'f', -1 ).arg( filterRect.yMinimum(), 0, 'f', -1 )
139 .arg( filterRect.xMaximum(), 0, 'f', -1 ).arg( filterRect.yMaximum(), 0, 'f', -1 ) );
140 query.addQueryItem( u"geometryType"_s, u"esriGeometryEnvelope"_s );
141 query.addQueryItem( u"spatialRel"_s, u"esriSpatialRelEnvelopeIntersects"_s );
142 }
143 queryUrl.setQuery( query );
144 return queryServiceJSON( queryUrl, authcfg, errorTitle, errorText, requestHeaders, feedback, urlPrefix );
145}
146
147QList<quint32> QgsArcGisRestQueryUtils::getObjectIdsByExtent( const QString &layerurl, const QgsRectangle &filterRect, QString &errorTitle, QString &errorText, const QString &authcfg, const QgsHttpHeaders &requestHeaders, QgsFeedback *feedback, const QString &whereClause, const QString &urlPrefix )
148{
149 QUrl queryUrl( layerurl + "/query" );
150 QUrlQuery query( queryUrl );
151 query.addQueryItem( u"f"_s, u"json"_s );
152 query.addQueryItem( u"where"_s, whereClause.isEmpty() ? u"1=1"_s : whereClause );
153 query.addQueryItem( u"returnIdsOnly"_s, u"true"_s );
154 query.addQueryItem( u"geometry"_s, u"%1,%2,%3,%4"_s
155 .arg( filterRect.xMinimum(), 0, 'f', -1 ).arg( filterRect.yMinimum(), 0, 'f', -1 )
156 .arg( filterRect.xMaximum(), 0, 'f', -1 ).arg( filterRect.yMaximum(), 0, 'f', -1 ) );
157 query.addQueryItem( u"geometryType"_s, u"esriGeometryEnvelope"_s );
158 query.addQueryItem( u"spatialRel"_s, u"esriSpatialRelEnvelopeIntersects"_s );
159 queryUrl.setQuery( query );
160 const QVariantMap objectIdData = queryServiceJSON( queryUrl, authcfg, errorTitle, errorText, requestHeaders, feedback, urlPrefix );
161
162 if ( objectIdData.isEmpty() )
163 {
164 return QList<quint32>();
165 }
166
167 QList<quint32> ids;
168 const QVariantList objectIdsList = objectIdData[u"objectIds"_s].toList();
169 ids.reserve( objectIdsList.size() );
170 for ( const QVariant &objectId : objectIdsList )
171 {
172 ids << objectId.toInt();
173 }
174 return ids;
175}
176
177QByteArray QgsArcGisRestQueryUtils::queryService( const QUrl &u, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders, QgsFeedback *feedback, QString *contentType, const QString &urlPrefix )
178{
179 QUrl url = parseUrl( u );
180
181 if ( !urlPrefix.isEmpty() )
182 url = QUrl( urlPrefix + url.toString() );
183
184 QNetworkRequest request( url );
185 QgsSetRequestInitiatorClass( request, u"QgsArcGisRestUtils"_s );
186 requestHeaders.updateNetworkRequest( request );
187
188 QgsBlockingNetworkRequest networkRequest;
189 networkRequest.setAuthCfg( authcfg );
190 const QgsBlockingNetworkRequest::ErrorCode error = networkRequest.get( request, false, feedback );
191
192 if ( feedback && feedback->isCanceled() )
193 return QByteArray();
194
195 // Handle network errors
197 {
198 QgsDebugError( u"Network error: %1"_s.arg( networkRequest.errorMessage() ) );
199 errorTitle = u"Network error"_s;
200 errorText = networkRequest.errorMessage();
201
202 // try to get detailed error message from reply
203 const QString content = networkRequest.reply().content();
204 const thread_local QRegularExpression errorRx( u"Error: <.*?>(.*?)<"_s );
205 const QRegularExpressionMatch match = errorRx.match( content );
206 if ( match.hasMatch() )
207 {
208 errorText = match.captured( 1 );
209 }
210
211 return QByteArray();
212 }
213
214 const QgsNetworkReplyContent content = networkRequest.reply();
215 if ( contentType )
216 *contentType = content.rawHeader( "Content-Type" );
217 return content.content();
218}
219
220QVariantMap QgsArcGisRestQueryUtils::queryServiceJSON( const QUrl &url, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders, QgsFeedback *feedback, const QString &urlPrefix )
221{
222 const QByteArray reply = queryService( url, authcfg, errorTitle, errorText, requestHeaders, feedback, nullptr, urlPrefix );
223 if ( !errorTitle.isEmpty() )
224 {
225 return QVariantMap();
226 }
227 if ( feedback && feedback->isCanceled() )
228 return QVariantMap();
229
230 // Parse data
231 QJsonParseError err;
232 const QJsonDocument doc = QJsonDocument::fromJson( reply, &err );
233 if ( doc.isNull() )
234 {
235 errorTitle = u"Parsing error"_s;
236 errorText = err.errorString();
237 QgsDebugError( u"Parsing error: %1"_s.arg( err.errorString() ) );
238 return QVariantMap();
239 }
240 const QVariantMap res = doc.object().toVariantMap();
241 if ( res.contains( u"error"_s ) )
242 {
243 const QVariantMap error = res.value( u"error"_s ).toMap();
244 errorText = error.value( u"message"_s ).toString();
245 errorTitle = QObject::tr( "Error %1" ).arg( error.value( u"code"_s ).toString() );
246 return QVariantMap();
247 }
248 return res;
249}
250
251QUrl QgsArcGisRestQueryUtils::parseUrl( const QUrl &url, bool *isTestEndpoint )
252{
253 if ( isTestEndpoint )
254 *isTestEndpoint = false;
255
256 QUrl modifiedUrl( url );
257 if ( modifiedUrl.toString().contains( "fake_qgis_http_endpoint"_L1 ) )
258 {
259 if ( isTestEndpoint )
260 *isTestEndpoint = true;
261
262 // Just for testing with local files instead of http:// resources
263 QString modifiedUrlString = modifiedUrl.toString();
264 // Qt5 does URL encoding from some reason (of the FILTER parameter for example)
265 modifiedUrlString = QUrl::fromPercentEncoding( modifiedUrlString.toUtf8() );
266 modifiedUrlString.replace( "fake_qgis_http_endpoint/"_L1, "fake_qgis_http_endpoint_"_L1 );
267 QgsDebugMsgLevel( u"Get %1"_s.arg( modifiedUrlString ), 2 );
268 modifiedUrlString = modifiedUrlString.mid( u"http://"_s.size() );
269 QString args = modifiedUrlString.indexOf( '?' ) >= 0 ? modifiedUrlString.mid( modifiedUrlString.indexOf( '?' ) ) : QString();
270 if ( modifiedUrlString.size() > 150 )
271 {
272 args = QCryptographicHash::hash( args.toUtf8(), QCryptographicHash::Md5 ).toHex();
273 }
274 else
275 {
276 args.replace( "?"_L1, "_"_L1 );
277 args.replace( "&"_L1, "_"_L1 );
278 args.replace( "<"_L1, "_"_L1 );
279 args.replace( ">"_L1, "_"_L1 );
280 args.replace( "'"_L1, "_"_L1 );
281 args.replace( "\""_L1, "_"_L1 );
282 args.replace( " "_L1, "_"_L1 );
283 args.replace( ":"_L1, "_"_L1 );
284 args.replace( "/"_L1, "_"_L1 );
285 args.replace( "\n"_L1, "_"_L1 );
286 }
287#ifdef Q_OS_WIN
288 // Passing "urls" like "http://c:/path" to QUrl 'eats' the : after c,
289 // so we must restore it
290 if ( modifiedUrlString[1] == '/' )
291 {
292 modifiedUrlString = modifiedUrlString[0] + ":/" + modifiedUrlString.mid( 2 );
293 }
294#endif
295 modifiedUrlString = modifiedUrlString.mid( 0, modifiedUrlString.indexOf( '?' ) ) + args;
296 QgsDebugMsgLevel( u"Get %1 (after laundering)"_s.arg( modifiedUrlString ), 2 );
297 modifiedUrl = QUrl::fromLocalFile( modifiedUrlString );
298 if ( !QFile::exists( modifiedUrlString ) )
299 {
300 QgsDebugError( u"Local test file %1 for URL %2 does not exist!!!"_s.arg( modifiedUrlString, url.toString() ) );
301 }
302 }
303
304 return modifiedUrl;
305}
306
307void QgsArcGisRestQueryUtils::adjustBaseUrl( QString &baseUrl, const QString &name )
308{
309 const QStringList parts = name.split( '/' );
310 QString checkString;
311 for ( const QString &part : parts )
312 {
313 if ( !checkString.isEmpty() )
314 checkString += QString( '/' );
315
316 checkString += part;
317 if ( baseUrl.indexOf( QRegularExpression( checkString.replace( '/', "\\/"_L1 ) + u"\\/?$"_s ) ) > -1 )
318 {
319 baseUrl = baseUrl.left( baseUrl.length() - checkString.length() - 1 );
320 break;
321 }
322 }
323}
324
325void QgsArcGisRestQueryUtils::visitFolderItems( const std::function< void( const QString &, const QString & ) > &visitor, const QVariantMap &serviceData, const QString &baseUrl )
326{
327 QString base( baseUrl );
328 bool baseChecked = false;
329 if ( !base.endsWith( '/' ) )
330 base += '/'_L1;
331
332 const QStringList folderList = serviceData.value( u"folders"_s ).toStringList();
333 for ( const QString &folder : folderList )
334 {
335 if ( !baseChecked )
336 {
337 adjustBaseUrl( base, folder );
338 baseChecked = true;
339 }
340 visitor( folder, base + folder );
341 }
342}
343
344void QgsArcGisRestQueryUtils::visitServiceItems( const std::function<void ( const QString &, const QString &, Qgis::ArcGisRestServiceType )> &visitor, const QVariantMap &serviceData, const QString &baseUrl )
345{
346 QString base( baseUrl );
347 bool baseChecked = false;
348 if ( !base.endsWith( '/' ) )
349 base += '/'_L1;
350
351 const QVariantList serviceList = serviceData.value( u"services"_s ).toList();
352 for ( const QVariant &service : serviceList )
353 {
354 const QVariantMap serviceMap = service.toMap();
355 const QString serviceTypeString = serviceMap.value( u"type"_s ).toString();
356 const Qgis::ArcGisRestServiceType serviceType = QgsArcGisRestUtils::serviceTypeFromString( serviceTypeString );
357
358 switch ( serviceType )
359 {
364 // supported
365 break;
366
371 // unsupported
372 continue;
373 }
374
375 const QString serviceName = serviceMap.value( u"name"_s ).toString();
376 const QString displayName = serviceName.split( '/' ).last();
377 if ( !baseChecked )
378 {
379 adjustBaseUrl( base, serviceName );
380 baseChecked = true;
381 }
382
383 visitor( displayName, base + serviceName + '/' + serviceTypeString, serviceType );
384 }
385}
386
387void QgsArcGisRestQueryUtils::addLayerItems( const std::function<void ( const QString &, ServiceTypeFilter, Qgis::GeometryType, const QString &, const QString &, const QString &, const QString &, bool, const QgsCoordinateReferenceSystem &, const QString & )> &visitor, const QVariantMap &serviceData, const QString &parentUrl, const QString &parentSupportedFormats, const ServiceTypeFilter filter )
388{
389 const QgsCoordinateReferenceSystem crs = QgsArcGisRestUtils::convertSpatialReference( serviceData.value( u"spatialReference"_s ).toMap() );
390
391 bool found = false;
392 const QList<QByteArray> supportedFormats = QImageReader::supportedImageFormats();
393 const QStringList supportedImageFormatTypes = serviceData.value( u"supportedImageFormatTypes"_s ).toString().isEmpty() ? parentSupportedFormats.split( ',' ) : serviceData.value( u"supportedImageFormatTypes"_s ).toString().split( ',' );
394 QString format = supportedImageFormatTypes.value( 0 );
395 for ( const QString &encoding : supportedImageFormatTypes )
396 {
397 for ( const QByteArray &fmt : supportedFormats )
398 {
399 if ( encoding.startsWith( fmt, Qt::CaseInsensitive ) )
400 {
401 format = encoding;
402 found = true;
403 break;
404 }
405 }
406 if ( found )
407 break;
408 }
409 const QStringList capabilities = serviceData.value( u"capabilities"_s ).toString().split( ',' );
410
411 // If the requested layer type is vector, do not show raster-only layers (i.e. non query-able layers)
412 const bool serviceMayHaveQueryCapability = capabilities.contains( u"Query"_s ) ||
413 serviceData.value( u"serviceDataType"_s ).toString().startsWith( "esriImageService"_L1 );
414
415 const bool serviceMayRenderMaps = capabilities.contains( u"Map"_s ) ||
416 serviceData.value( u"serviceDataType"_s ).toString().startsWith( "esriImageService"_L1 );
417
418 const QVariantList layerInfoList = serviceData.value( u"layers"_s ).toList();
419 for ( const QVariant &layerInfo : layerInfoList )
420 {
421 const QVariantMap layerInfoMap = layerInfo.toMap();
422 const QString id = layerInfoMap.value( u"id"_s ).toString();
423 const QString parentLayerId = layerInfoMap.value( u"parentLayerId"_s ).toString();
424 const QString name = layerInfoMap.value( u"name"_s ).toString();
425 const QString description = layerInfoMap.value( u"description"_s ).toString();
426
427 if ( filter == ServiceTypeFilter::Scene )
428 {
429 visitor( parentLayerId, ServiceTypeFilter::Scene, Qgis::GeometryType::Unknown, id, name, description, parentUrl, false, crs, format );
430 continue;
431 }
432
433 // Yes, potentially we may visit twice, once as as a raster (if applicable), and once as a vector (if applicable)!
434 if ( serviceMayRenderMaps && ( filter == ServiceTypeFilter::Raster || filter == ServiceTypeFilter::AllTypes ) )
435 {
436 if ( !layerInfoMap.value( u"subLayerIds"_s ).toList().empty() )
437 {
438 visitor( parentLayerId, ServiceTypeFilter::Raster, Qgis::GeometryType::Unknown, id, name, description, parentUrl + '/' + id, true, QgsCoordinateReferenceSystem(), format );
439 }
440 else
441 {
442 visitor( parentLayerId, ServiceTypeFilter::Raster, Qgis::GeometryType::Unknown, id, name, description, parentUrl + '/' + id, false, crs, format );
443 }
444 }
445
446 if ( serviceMayHaveQueryCapability && ( filter == ServiceTypeFilter::Vector || filter == ServiceTypeFilter::AllTypes ) )
447 {
448 const QString geometryType = layerInfoMap.value( u"geometryType"_s ).toString();
449#if 0
450 // we have a choice here -- if geometryType is unknown and the service reflects that it supports Map capabilities,
451 // then we can't be sure whether or not the individual sublayers support Query or Map requests only. So we either:
452 // 1. Send off additional requests for each individual layer's capabilities (too expensive)
453 // 2. Err on the side of only showing services we KNOW will work for layer -- but this has the side effect that layers
454 // which ARE available as feature services will only show as raster mapserver layers, which is VERY bad/restrictive
455 // 3. Err on the side of showing services we THINK may work, even though some of them may or may not work depending on the actual
456 // server configuration
457 // We opt for 3, because otherwise we're making it impossible for users to load valid vector layers into QGIS
458
459 if ( serviceMayRenderMaps )
460 {
461 if ( geometryType.isEmpty() )
462 continue;
463 }
464#endif
465
466 const Qgis::WkbType wkbType = QgsArcGisRestUtils::convertGeometryType( geometryType );
467
468
469 if ( !layerInfoMap.value( u"subLayerIds"_s ).toList().empty() )
470 {
471 visitor( parentLayerId, ServiceTypeFilter::Vector, QgsWkbTypes::geometryType( wkbType ), id, name, description, parentUrl + '/' + id, true, QgsCoordinateReferenceSystem(), format );
472 }
473 else
474 {
475 visitor( parentLayerId, ServiceTypeFilter::Vector, QgsWkbTypes::geometryType( wkbType ), id, name, description, parentUrl + '/' + id, false, crs, format );
476 }
477 }
478 }
479
480 const QVariantList tableInfoList = serviceData.value( u"tables"_s ).toList();
481 for ( const QVariant &tableInfo : tableInfoList )
482 {
483 const QVariantMap tableInfoMap = tableInfo.toMap();
484 const QString id = tableInfoMap.value( u"id"_s ).toString();
485 const QString parentLayerId = tableInfoMap.value( u"parentLayerId"_s ).toString();
486 const QString name = tableInfoMap.value( u"name"_s ).toString();
487 const QString description = tableInfoMap.value( u"description"_s ).toString();
488
489 if ( serviceMayHaveQueryCapability && ( filter == ServiceTypeFilter::Vector || filter == ServiceTypeFilter::AllTypes ) )
490 {
491 if ( !tableInfoMap.value( u"subLayerIds"_s ).toList().empty() )
492 {
493 visitor( parentLayerId, ServiceTypeFilter::Vector, Qgis::GeometryType::Null, id, name, description, parentUrl + '/' + id, true, QgsCoordinateReferenceSystem(), format );
494 }
495 else
496 {
497 visitor( parentLayerId, ServiceTypeFilter::Vector, Qgis::GeometryType::Null, id, name, description, parentUrl + '/' + id, false, crs, format );
498 }
499 }
500 }
501
502 // Add root MapServer as raster layer when multiple layers are listed
503 if ( filter != ServiceTypeFilter::Vector && layerInfoList.count() > 1 && serviceData.contains( u"supportedImageFormatTypes"_s ) )
504 {
505 const QString name = u"(%1)"_s.arg( QObject::tr( "All layers" ) );
506 const QString description = serviceData.value( u"Comments"_s ).toString();
507 visitor( nullptr, ServiceTypeFilter::Raster, Qgis::GeometryType::Unknown, nullptr, name, description, parentUrl, false, crs, format );
508 }
509
510 // Add root ImageServer as layer
511 if ( serviceData.value( u"serviceDataType"_s ).toString().startsWith( "esriImageService"_L1 ) )
512 {
513 const QString name = serviceData.value( u"name"_s ).toString();
514 const QString description = serviceData.value( u"description"_s ).toString();
515 visitor( nullptr, ServiceTypeFilter::Raster, Qgis::GeometryType::Unknown, nullptr, name, description, parentUrl, false, crs, format );
516 }
517}
518
519
521
522//
523// QgsArcGisAsyncQuery
524//
525
526QgsArcGisAsyncQuery::QgsArcGisAsyncQuery( QObject *parent )
527 : QObject( parent )
528{
529}
530
531QgsArcGisAsyncQuery::~QgsArcGisAsyncQuery()
532{
533 if ( mReply )
534 mReply->deleteLater();
535}
536
537void QgsArcGisAsyncQuery::start( const QUrl &url, const QString &authCfg, QByteArray *result, bool allowCache, const QgsHttpHeaders &headers, const QString &urlPrefix )
538{
539 mResult = result;
540 QUrl mUrl = url;
541 if ( !urlPrefix.isEmpty() )
542 mUrl = QUrl( urlPrefix + url.toString() );
543 QNetworkRequest request( mUrl );
544
545 headers.updateNetworkRequest( request );
546
547 if ( !authCfg.isEmpty() && !QgsApplication::authManager()->updateNetworkRequest( request, authCfg ) )
548 {
549 const QString error = tr( "network request update failed for authentication config" );
550 emit failed( u"Network"_s, error );
551 return;
552 }
553
554 QgsSetRequestInitiatorClass( request, u"QgsArcGisAsyncQuery"_s );
555 request.setAttribute( QNetworkRequest::RedirectPolicyAttribute, QNetworkRequest::ManualRedirectPolicy );
556 if ( allowCache )
557 {
558 request.setAttribute( QNetworkRequest::CacheLoadControlAttribute, QNetworkRequest::PreferCache );
559 request.setAttribute( QNetworkRequest::CacheSaveControlAttribute, true );
560 }
561
562 mReply = QgsNetworkAccessManager::instance()->get( request );
563 connect( mReply, &QNetworkReply::finished, this, &QgsArcGisAsyncQuery::handleReply );
564}
565
566void QgsArcGisAsyncQuery::handleReply()
567{
568 mReply->deleteLater();
569 // Handle network errors
570 if ( mReply->error() != QNetworkReply::NoError )
571 {
572 QgsDebugError( u"Network error: %1"_s.arg( mReply->errorString() ) );
573 emit failed( u"Network error"_s, mReply->errorString() );
574 return;
575 }
576
577 // Handle HTTP redirects
578 const QVariant redirect = mReply->attribute( QNetworkRequest::RedirectionTargetAttribute );
579 if ( !QgsVariantUtils::isNull( redirect ) )
580 {
581 QNetworkRequest request = mReply->request();
582 request.setAttribute( QNetworkRequest::RedirectPolicyAttribute, QNetworkRequest::ManualRedirectPolicy );
583 QgsSetRequestInitiatorClass( request, u"QgsArcGisAsyncQuery"_s );
584 QgsDebugMsgLevel( "redirecting to " + redirect.toUrl().toString(), 2 );
585 request.setUrl( redirect.toUrl() );
586 mReply = QgsNetworkAccessManager::instance()->get( request );
587 connect( mReply, &QNetworkReply::finished, this, &QgsArcGisAsyncQuery::handleReply );
588 return;
589 }
590
591 *mResult = mReply->readAll();
592 mResult = nullptr;
593 emit finished();
594}
595
596//
597// QgsArcGisAsyncParallelQuery
598//
599
600QgsArcGisAsyncParallelQuery::QgsArcGisAsyncParallelQuery( const QString &authcfg, const QgsHttpHeaders &requestHeaders, QObject *parent )
601 : QObject( parent )
602 , mAuthCfg( authcfg )
603 , mRequestHeaders( requestHeaders )
604{
605}
606
607void QgsArcGisAsyncParallelQuery::start( const QVector<QUrl> &urls, QVector<QByteArray> *results, bool allowCache )
608{
609 Q_ASSERT( results->size() == urls.size() );
610 mResults = results;
611 mPendingRequests = mResults->size();
612 for ( int i = 0, n = urls.size(); i < n; ++i )
613 {
614 QNetworkRequest request( urls[i] );
615 QgsSetRequestInitiatorClass( request, u"QgsArcGisAsyncParallelQuery"_s );
616 QgsSetRequestInitiatorId( request, QString::number( i ) );
617
618 mRequestHeaders.updateNetworkRequest( request );
619 if ( !mAuthCfg.isEmpty() && !QgsApplication::authManager()->updateNetworkRequest( request, mAuthCfg ) )
620 {
621 const QString error = tr( "network request update failed for authentication config" );
622 mErrors.append( error );
623 QgsMessageLog::logMessage( error, tr( "Network" ) );
624 continue;
625 }
626
627 request.setAttribute( QNetworkRequest::HttpPipeliningAllowedAttribute, true );
628 if ( allowCache )
629 {
630 request.setAttribute( QNetworkRequest::CacheLoadControlAttribute, QNetworkRequest::PreferCache );
631 request.setAttribute( QNetworkRequest::CacheSaveControlAttribute, true );
632 request.setRawHeader( "Connection", "keep-alive" );
633 }
634 QNetworkReply *reply = QgsNetworkAccessManager::instance()->get( request );
635 reply->setProperty( "idx", i );
636 connect( reply, &QNetworkReply::finished, this, &QgsArcGisAsyncParallelQuery::handleReply );
637 }
638}
639
640void QgsArcGisAsyncParallelQuery::handleReply()
641{
642 QNetworkReply *reply = qobject_cast<QNetworkReply *>( QObject::sender() );
643 const QVariant redirect = reply->attribute( QNetworkRequest::RedirectionTargetAttribute );
644 const int idx = reply->property( "idx" ).toInt();
645 reply->deleteLater();
646 if ( reply->error() != QNetworkReply::NoError )
647 {
648 // Handle network errors
649 mErrors.append( reply->errorString() );
650 --mPendingRequests;
651 }
652 else if ( !QgsVariantUtils::isNull( redirect ) )
653 {
654 // Handle HTTP redirects
655 QNetworkRequest request = reply->request();
656 request.setAttribute( QNetworkRequest::RedirectPolicyAttribute, QNetworkRequest::ManualRedirectPolicy );
657 QgsSetRequestInitiatorClass( request, u"QgsArcGisAsyncParallelQuery"_s );
658 QgsDebugMsgLevel( "redirecting to " + redirect.toUrl().toString(), 2 );
659 request.setUrl( redirect.toUrl() );
660 reply = QgsNetworkAccessManager::instance()->get( request );
661 reply->setProperty( "idx", idx );
662 connect( reply, &QNetworkReply::finished, this, &QgsArcGisAsyncParallelQuery::handleReply );
663 }
664 else
665 {
666 // All OK
667 ( *mResults )[idx] = reply->readAll();
668 --mPendingRequests;
669 }
670 if ( mPendingRequests == 0 )
671 {
672 emit finished( mErrors );
673 mResults = nullptr;
674 mErrors.clear();
675 }
676}
677
ArcGisRestServiceType
Available ArcGIS REST service types.
Definition qgis.h:4430
@ GeocodeServer
GeocodeServer.
Definition qgis.h:4436
@ SceneServer
SceneServer.
Definition qgis.h:4438
@ Unknown
Other unknown/unsupported type.
Definition qgis.h:4437
@ GlobeServer
GlobeServer.
Definition qgis.h:4434
@ ImageServer
ImageServer.
Definition qgis.h:4433
@ FeatureServer
FeatureServer.
Definition qgis.h:4431
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:365
@ Unknown
Unknown types.
Definition qgis.h:369
@ Null
No geometry.
Definition qgis.h:370
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:280
static QgsAuthManager * authManager()
Returns the application's authentication manager instance.
static void visitFolderItems(const std::function< void(const QString &folderName, const QString &url)> &visitor, const QVariantMap &serviceData, const QString &baseUrl)
Calls the specified visitor function on all folder items found within the given service data.
static QVariantMap queryServiceJSON(const QUrl &url, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr, const QString &urlPrefix=QString())
Performs a blocking request to a URL and returns the retrieved JSON content.
static QVariantMap getObjects(const QString &layerurl, const QString &authcfg, const QList< quint32 > &objectIds, const QString &crs, bool fetchGeometry, const QStringList &fetchAttributes, bool fetchM, bool fetchZ, const QgsRectangle &filterRect, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr, const QString &urlPrefix=QString())
Retrieves all matching objects from the specified layer URL.
static QgsRectangle getExtent(const QString &layerurl, const QString &whereClause, const QString &authcfg, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), const QString &urlPrefix=QString())
Retrieves the extent for the features matching a whereClause.
static QVariantMap getServiceInfo(const QString &baseurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), const QString &urlPrefix=QString())
Retrieves JSON service info for the specified base URL.
static QVariantMap getObjectIds(const QString &layerurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), const QString &urlPrefix=QString(), const QgsRectangle &bbox=QgsRectangle(), const QString &whereClause=QString())
Retrieves all object IDs for the specified layer URL.
static QUrl parseUrl(const QUrl &url, bool *isTestEndpoint=nullptr)
Parses and processes a url.
static QVariantMap getLayerInfo(const QString &layerurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), const QString &urlPrefix=QString())
Retrieves JSON layer info for the specified layer URL.
static void addLayerItems(const std::function< void(const QString &parentLayerId, ServiceTypeFilter serviceType, Qgis::GeometryType geometryType, const QString &layerId, const QString &name, const QString &description, const QString &url, bool isParentLayer, const QgsCoordinateReferenceSystem &crs, const QString &format)> &visitor, const QVariantMap &serviceData, const QString &parentUrl, const QString &parentSupportedFormats, const ServiceTypeFilter filter=ServiceTypeFilter::AllTypes)
Calls the specified visitor function on all layer items found within the given service data.
static void visitServiceItems(const std::function< void(const QString &serviceName, const QString &url, Qgis::ArcGisRestServiceType serviceType)> &visitor, const QVariantMap &serviceData, const QString &baseUrl)
Calls the specified visitor function on all service items found within the given service data.
static QByteArray queryService(const QUrl &url, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr, QString *contentType=nullptr, const QString &urlPrefix=QString())
Performs a blocking request to a URL and returns the retrieved data.
static QList< quint32 > getObjectIdsByExtent(const QString &layerurl, const QgsRectangle &filterRect, QString &errorTitle, QString &errorText, const QString &authcfg, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr, const QString &whereClause=QString(), const QString &urlPrefix=QString())
Gets a list of object IDs which fall within the specified extent.
static QgsCoordinateReferenceSystem convertSpatialReference(const QVariantMap &spatialReferenceMap)
Converts a spatial reference JSON definition to a QgsCoordinateReferenceSystem value.
static Qgis::WkbType convertGeometryType(const QString &type)
Converts an ESRI REST geometry type to a WKB type.
static Qgis::ArcGisRestServiceType serviceTypeFromString(const QString &type)
Converts a string value to a REST service type.
static QgsRectangle convertRectangle(const QVariant &value)
Converts a rectangle value to a QgsRectangle.
A thread safe class for performing blocking (sync) network requests, with full support for QGIS proxy...
void setAuthCfg(const QString &authCfg)
Sets the authentication config id which should be used during the request.
QString errorMessage() const
Returns the error message string, after a get(), post(), head() or put() request has been made.
ErrorCode get(QNetworkRequest &request, bool forceRefresh=false, QgsFeedback *feedback=nullptr, RequestFlags requestFlags=QgsBlockingNetworkRequest::RequestFlags())
Performs a "get" operation on the specified request.
@ NoError
No error was encountered.
QgsNetworkReplyContent reply() const
Returns the content of the network reply, after a get(), post(), head() or put() request has been mad...
Represents a coordinate reference system (CRS).
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
bool isCanceled() const
Tells whether the operation has been canceled already.
Definition qgsfeedback.h:55
Implements simple HTTP header management.
bool updateNetworkRequest(QNetworkRequest &request) const
Updates a request by adding all the HTTP headers.
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 QgsNetworkAccessManager * instance(Qt::ConnectionType connectionType=Qt::BlockingQueuedConnection)
Returns a pointer to the active QgsNetworkAccessManager for the current thread.
Encapsulates a network reply within a container which is inexpensive to copy and safe to pass between...
QByteArray content() const
Returns the reply content.
QByteArray rawHeader(const QByteArray &headerName) const
Returns the content of the header with the specified headerName, or an empty QByteArray if the specif...
A rectangle specified with double values.
double xMinimum
double yMinimum
double xMaximum
double yMaximum
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
static Qgis::GeometryType geometryType(Qgis::WkbType type)
Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a Polyg...
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:63
#define QgsDebugError(str)
Definition qgslogger.h:59
#define QgsSetRequestInitiatorClass(request, _class)
#define QgsSetRequestInitiatorId(request, str)