QGIS API Documentation  3.23.0-Master (dd0cd13a00)
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 #include "qgsarcgisrestutils.h"
20 #include "qgslogger.h"
21 #include "qgsapplication.h"
22 #include "qgsmessagelog.h"
23 #include "qgsauthmanager.h"
24 #include "qgscoordinatetransform.h"
25 
26 #include <QUrl>
27 #include <QUrlQuery>
28 #include <QImageReader>
29 #include <QRegularExpression>
30 
31 QVariantMap QgsArcGisRestQueryUtils::getServiceInfo( const QString &baseurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders )
32 {
33  // http://sampleserver5.arcgisonline.com/arcgis/rest/services/Energy/Geology/FeatureServer?f=json
34  QUrl queryUrl( baseurl );
35  QUrlQuery query( queryUrl );
36  query.addQueryItem( QStringLiteral( "f" ), QStringLiteral( "json" ) );
37  queryUrl.setQuery( query );
38  return queryServiceJSON( queryUrl, authcfg, errorTitle, errorText, requestHeaders );
39 }
40 
41 QVariantMap QgsArcGisRestQueryUtils::getLayerInfo( const QString &layerurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders )
42 {
43  // http://sampleserver5.arcgisonline.com/arcgis/rest/services/Energy/Geology/FeatureServer/1?f=json
44  QUrl queryUrl( layerurl );
45  QUrlQuery query( queryUrl );
46  query.addQueryItem( QStringLiteral( "f" ), QStringLiteral( "json" ) );
47  queryUrl.setQuery( query );
48  return queryServiceJSON( queryUrl, authcfg, errorTitle, errorText, requestHeaders );
49 }
50 
51 QVariantMap QgsArcGisRestQueryUtils::getObjectIds( const QString &layerurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders, const QgsRectangle &bbox )
52 {
53  // http://sampleserver5.arcgisonline.com/arcgis/rest/services/Energy/Geology/FeatureServer/1/query?where=1%3D1&returnIdsOnly=true&f=json
54  QUrl queryUrl( layerurl + "/query" );
55  QUrlQuery query( queryUrl );
56  query.addQueryItem( QStringLiteral( "f" ), QStringLiteral( "json" ) );
57  query.addQueryItem( QStringLiteral( "where" ), QStringLiteral( "1=1" ) );
58  query.addQueryItem( QStringLiteral( "returnIdsOnly" ), QStringLiteral( "true" ) );
59  if ( !bbox.isNull() )
60  {
61  query.addQueryItem( QStringLiteral( "geometry" ), QStringLiteral( "%1,%2,%3,%4" )
62  .arg( bbox.xMinimum(), 0, 'f', -1 ).arg( bbox.yMinimum(), 0, 'f', -1 )
63  .arg( bbox.xMaximum(), 0, 'f', -1 ).arg( bbox.yMaximum(), 0, 'f', -1 ) );
64  query.addQueryItem( QStringLiteral( "geometryType" ), QStringLiteral( "esriGeometryEnvelope" ) );
65  query.addQueryItem( QStringLiteral( "spatialRel" ), QStringLiteral( "esriSpatialRelEnvelopeIntersects" ) );
66  }
67  queryUrl.setQuery( query );
68  return queryServiceJSON( queryUrl, authcfg, errorTitle, errorText, requestHeaders );
69 }
70 
71 QVariantMap QgsArcGisRestQueryUtils::getObjects( const QString &layerurl, const QString &authcfg, const QList<quint32> &objectIds, const QString &crs,
72  bool fetchGeometry, const QStringList &fetchAttributes,
73  bool fetchM, bool fetchZ,
74  const QgsRectangle &filterRect,
75  QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders, QgsFeedback *feedback )
76 {
77  QStringList ids;
78  for ( const int id : objectIds )
79  {
80  ids.append( QString::number( id ) );
81  }
82  QUrl queryUrl( layerurl + "/query" );
83  QUrlQuery query( queryUrl );
84  query.addQueryItem( QStringLiteral( "f" ), QStringLiteral( "json" ) );
85  query.addQueryItem( QStringLiteral( "objectIds" ), ids.join( QLatin1Char( ',' ) ) );
86  const QString wkid = crs.indexOf( QLatin1Char( ':' ) ) >= 0 ? crs.split( ':' )[1] : QString();
87  query.addQueryItem( QStringLiteral( "inSR" ), wkid );
88  query.addQueryItem( QStringLiteral( "outSR" ), wkid );
89 
90  query.addQueryItem( QStringLiteral( "returnGeometry" ), fetchGeometry ? QStringLiteral( "true" ) : QStringLiteral( "false" ) );
91 
92  QString outFields;
93  if ( fetchAttributes.isEmpty() )
94  outFields = QStringLiteral( "*" );
95  else
96  outFields = fetchAttributes.join( ',' );
97  query.addQueryItem( QStringLiteral( "outFields" ), outFields );
98 
99  query.addQueryItem( QStringLiteral( "returnM" ), fetchM ? QStringLiteral( "true" ) : QStringLiteral( "false" ) );
100  query.addQueryItem( QStringLiteral( "returnZ" ), fetchZ ? QStringLiteral( "true" ) : QStringLiteral( "false" ) );
101  if ( !filterRect.isNull() )
102  {
103  query.addQueryItem( QStringLiteral( "geometry" ), QStringLiteral( "%1,%2,%3,%4" )
104  .arg( filterRect.xMinimum(), 0, 'f', -1 ).arg( filterRect.yMinimum(), 0, 'f', -1 )
105  .arg( filterRect.xMaximum(), 0, 'f', -1 ).arg( filterRect.yMaximum(), 0, 'f', -1 ) );
106  query.addQueryItem( QStringLiteral( "geometryType" ), QStringLiteral( "esriGeometryEnvelope" ) );
107  query.addQueryItem( QStringLiteral( "spatialRel" ), QStringLiteral( "esriSpatialRelEnvelopeIntersects" ) );
108  }
109  queryUrl.setQuery( query );
110  return queryServiceJSON( queryUrl, authcfg, errorTitle, errorText, requestHeaders, feedback );
111 }
112 
113 QList<quint32> QgsArcGisRestQueryUtils::getObjectIdsByExtent( const QString &layerurl, const QgsRectangle &filterRect, QString &errorTitle, QString &errorText, const QString &authcfg, const QgsHttpHeaders &requestHeaders, QgsFeedback *feedback )
114 {
115  QUrl queryUrl( layerurl + "/query" );
116  QUrlQuery query( queryUrl );
117  query.addQueryItem( QStringLiteral( "f" ), QStringLiteral( "json" ) );
118  query.addQueryItem( QStringLiteral( "where" ), QStringLiteral( "1=1" ) );
119  query.addQueryItem( QStringLiteral( "returnIdsOnly" ), QStringLiteral( "true" ) );
120  query.addQueryItem( QStringLiteral( "geometry" ), QStringLiteral( "%1,%2,%3,%4" )
121  .arg( filterRect.xMinimum(), 0, 'f', -1 ).arg( filterRect.yMinimum(), 0, 'f', -1 )
122  .arg( filterRect.xMaximum(), 0, 'f', -1 ).arg( filterRect.yMaximum(), 0, 'f', -1 ) );
123  query.addQueryItem( QStringLiteral( "geometryType" ), QStringLiteral( "esriGeometryEnvelope" ) );
124  query.addQueryItem( QStringLiteral( "spatialRel" ), QStringLiteral( "esriSpatialRelEnvelopeIntersects" ) );
125  queryUrl.setQuery( query );
126  const QVariantMap objectIdData = queryServiceJSON( queryUrl, authcfg, errorTitle, errorText, requestHeaders, feedback );
127 
128  if ( objectIdData.isEmpty() )
129  {
130  return QList<quint32>();
131  }
132 
133  QList<quint32> ids;
134  const QVariantList objectIdsList = objectIdData[QStringLiteral( "objectIds" )].toList();
135  ids.reserve( objectIdsList.size() );
136  for ( const QVariant &objectId : objectIdsList )
137  {
138  ids << objectId.toInt();
139  }
140  return ids;
141 }
142 
143 QByteArray QgsArcGisRestQueryUtils::queryService( const QUrl &u, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders, QgsFeedback *feedback, QString *contentType )
144 {
145  const QUrl url = parseUrl( u );
146 
147  QNetworkRequest request( url );
148  QgsSetRequestInitiatorClass( request, QStringLiteral( "QgsArcGisRestUtils" ) );
149  requestHeaders.updateNetworkRequest( request );
150 
151  QgsBlockingNetworkRequest networkRequest;
152  networkRequest.setAuthCfg( authcfg );
153  const QgsBlockingNetworkRequest::ErrorCode error = networkRequest.get( request, false, feedback );
154 
155  if ( feedback && feedback->isCanceled() )
156  return QByteArray();
157 
158  // Handle network errors
159  if ( error != QgsBlockingNetworkRequest::NoError )
160  {
161  QgsDebugMsg( QStringLiteral( "Network error: %1" ).arg( networkRequest.errorMessage() ) );
162  errorTitle = QStringLiteral( "Network error" );
163  errorText = networkRequest.errorMessage();
164  return QByteArray();
165  }
166 
167  const QgsNetworkReplyContent content = networkRequest.reply();
168  if ( contentType )
169  *contentType = content.rawHeader( "Content-Type" );
170  return content.content();
171 }
172 
173 QVariantMap QgsArcGisRestQueryUtils::queryServiceJSON( const QUrl &url, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders, QgsFeedback *feedback )
174 {
175  const QByteArray reply = queryService( url, authcfg, errorTitle, errorText, requestHeaders, feedback );
176  if ( !errorTitle.isEmpty() )
177  {
178  return QVariantMap();
179  }
180  if ( feedback && feedback->isCanceled() )
181  return QVariantMap();
182 
183  // Parse data
184  QJsonParseError err;
185  const QJsonDocument doc = QJsonDocument::fromJson( reply, &err );
186  if ( doc.isNull() )
187  {
188  errorTitle = QStringLiteral( "Parsing error" );
189  errorText = err.errorString();
190  QgsDebugMsg( QStringLiteral( "Parsing error: %1" ).arg( err.errorString() ) );
191  return QVariantMap();
192  }
193  const QVariantMap res = doc.object().toVariantMap();
194  if ( res.contains( QStringLiteral( "error" ) ) )
195  {
196  const QVariantMap error = res.value( QStringLiteral( "error" ) ).toMap();
197  errorText = error.value( QStringLiteral( "message" ) ).toString();
198  errorTitle = QObject::tr( "Error %1" ).arg( error.value( QStringLiteral( "code" ) ).toString() );
199  return QVariantMap();
200  }
201  return res;
202 }
203 
204 QUrl QgsArcGisRestQueryUtils::parseUrl( const QUrl &url )
205 {
206  QUrl modifiedUrl( url );
207  if ( modifiedUrl.toString().contains( QLatin1String( "fake_qgis_http_endpoint" ) ) )
208  {
209  // Just for testing with local files instead of http:// resources
210  QString modifiedUrlString = modifiedUrl.toString();
211  // Qt5 does URL encoding from some reason (of the FILTER parameter for example)
212  modifiedUrlString = QUrl::fromPercentEncoding( modifiedUrlString.toUtf8() );
213  modifiedUrlString.replace( QLatin1String( "fake_qgis_http_endpoint/" ), QLatin1String( "fake_qgis_http_endpoint_" ) );
214  QgsDebugMsg( QStringLiteral( "Get %1" ).arg( modifiedUrlString ) );
215  modifiedUrlString = modifiedUrlString.mid( QStringLiteral( "http://" ).size() );
216  QString args = modifiedUrlString.mid( modifiedUrlString.indexOf( '?' ) );
217  if ( modifiedUrlString.size() > 150 )
218  {
219  args = QCryptographicHash::hash( args.toUtf8(), QCryptographicHash::Md5 ).toHex();
220  }
221  else
222  {
223  args.replace( QLatin1String( "?" ), QLatin1String( "_" ) );
224  args.replace( QLatin1String( "&" ), QLatin1String( "_" ) );
225  args.replace( QLatin1String( "<" ), QLatin1String( "_" ) );
226  args.replace( QLatin1String( ">" ), QLatin1String( "_" ) );
227  args.replace( QLatin1String( "'" ), QLatin1String( "_" ) );
228  args.replace( QLatin1String( "\"" ), QLatin1String( "_" ) );
229  args.replace( QLatin1String( " " ), QLatin1String( "_" ) );
230  args.replace( QLatin1String( ":" ), QLatin1String( "_" ) );
231  args.replace( QLatin1String( "/" ), QLatin1String( "_" ) );
232  args.replace( QLatin1String( "\n" ), QLatin1String( "_" ) );
233  }
234 #ifdef Q_OS_WIN
235  // Passing "urls" like "http://c:/path" to QUrl 'eats' the : after c,
236  // so we must restore it
237  if ( modifiedUrlString[1] == '/' )
238  {
239  modifiedUrlString = modifiedUrlString[0] + ":/" + modifiedUrlString.mid( 2 );
240  }
241 #endif
242  modifiedUrlString = modifiedUrlString.mid( 0, modifiedUrlString.indexOf( '?' ) ) + args;
243  QgsDebugMsg( QStringLiteral( "Get %1 (after laundering)" ).arg( modifiedUrlString ) );
244  modifiedUrl = QUrl::fromLocalFile( modifiedUrlString );
245  }
246 
247  return modifiedUrl;
248 }
249 
250 void QgsArcGisRestQueryUtils::adjustBaseUrl( QString &baseUrl, const QString &name )
251 {
252  const QStringList parts = name.split( '/' );
253  QString checkString;
254  for ( const QString &part : parts )
255  {
256  if ( !checkString.isEmpty() )
257  checkString += QString( '/' );
258 
259  checkString += part;
260  if ( baseUrl.indexOf( QRegularExpression( checkString.replace( '/', QLatin1String( "\\/" ) ) + QStringLiteral( "\\/?$" ) ) ) > -1 )
261  {
262  baseUrl = baseUrl.left( baseUrl.length() - checkString.length() - 1 );
263  break;
264  }
265  }
266 }
267 
268 void QgsArcGisRestQueryUtils::visitFolderItems( const std::function< void( const QString &, const QString & ) > &visitor, const QVariantMap &serviceData, const QString &baseUrl )
269 {
270  QString base( baseUrl );
271  bool baseChecked = false;
272  if ( !base.endsWith( '/' ) )
273  base += QLatin1Char( '/' );
274 
275  const QStringList folderList = serviceData.value( QStringLiteral( "folders" ) ).toStringList();
276  for ( const QString &folder : folderList )
277  {
278  if ( !baseChecked )
279  {
280  adjustBaseUrl( base, folder );
281  baseChecked = true;
282  }
283  visitor( folder, base + folder );
284  }
285 }
286 
287 void QgsArcGisRestQueryUtils::visitServiceItems( const std::function<void ( const QString &, const QString &, const QString &, const ServiceTypeFilter )> &visitor, const QVariantMap &serviceData, const QString &baseUrl )
288 {
289  QString base( baseUrl );
290  bool baseChecked = false;
291  if ( !base.endsWith( '/' ) )
292  base += QLatin1Char( '/' );
293 
294  const QVariantList serviceList = serviceData.value( QStringLiteral( "services" ) ).toList();
295  for ( const QVariant &service : serviceList )
296  {
297  const QVariantMap serviceMap = service.toMap();
298  const QString serviceType = serviceMap.value( QStringLiteral( "type" ) ).toString();
299  if ( serviceType != QLatin1String( "MapServer" ) && serviceType != QLatin1String( "ImageServer" ) && serviceType != QLatin1String( "FeatureServer" ) )
300  continue;
301 
302  const ServiceTypeFilter type = serviceType == QLatin1String( "FeatureServer" ) ? Vector : Raster;
303 
304  const QString serviceName = serviceMap.value( QStringLiteral( "name" ) ).toString();
305  const QString displayName = serviceName.split( '/' ).last();
306  if ( !baseChecked )
307  {
308  adjustBaseUrl( base, serviceName );
309  baseChecked = true;
310  }
311 
312  visitor( displayName, base + serviceName + '/' + serviceType, serviceType, type );
313  }
314 }
315 
316 void QgsArcGisRestQueryUtils::addLayerItems( const std::function<void ( const QString &, ServiceTypeFilter, QgsWkbTypes::GeometryType, const QString &, const QString &, const QString &, const QString &, bool, const QString &, const QString & )> &visitor, const QVariantMap &serviceData, const QString &parentUrl, const QString &parentSupportedFormats, const ServiceTypeFilter filter )
317 {
318  const QString authid = QgsArcGisRestUtils::convertSpatialReference( serviceData.value( QStringLiteral( "spatialReference" ) ).toMap() ).authid();
319 
320  bool found = false;
321  const QList<QByteArray> supportedFormats = QImageReader::supportedImageFormats();
322  const QStringList supportedImageFormatTypes = serviceData.value( QStringLiteral( "supportedImageFormatTypes" ) ).toString().isEmpty() ? parentSupportedFormats.split( ',' ) : serviceData.value( QStringLiteral( "supportedImageFormatTypes" ) ).toString().split( ',' );
323  QString format = supportedImageFormatTypes.value( 0 );
324  for ( const QString &encoding : supportedImageFormatTypes )
325  {
326  for ( const QByteArray &fmt : supportedFormats )
327  {
328  if ( encoding.startsWith( fmt, Qt::CaseInsensitive ) )
329  {
330  format = encoding;
331  found = true;
332  break;
333  }
334  }
335  if ( found )
336  break;
337  }
338  const QStringList capabilities = serviceData.value( QStringLiteral( "capabilities" ) ).toString().split( ',' );
339 
340  // If the requested layer type is vector, do not show raster-only layers (i.e. non query-able layers)
341  const bool serviceMayHaveQueryCapability = capabilities.contains( QStringLiteral( "Query" ) ) ||
342  serviceData.value( QStringLiteral( "serviceDataType" ) ).toString().startsWith( QLatin1String( "esriImageService" ) );
343 
344  const bool serviceMayRenderMaps = capabilities.contains( QStringLiteral( "Map" ) ) ||
345  serviceData.value( QStringLiteral( "serviceDataType" ) ).toString().startsWith( QLatin1String( "esriImageService" ) );
346 
347  const QVariantList layerInfoList = serviceData.value( QStringLiteral( "layers" ) ).toList();
348  for ( const QVariant &layerInfo : layerInfoList )
349  {
350  const QVariantMap layerInfoMap = layerInfo.toMap();
351  const QString id = layerInfoMap.value( QStringLiteral( "id" ) ).toString();
352  const QString parentLayerId = layerInfoMap.value( QStringLiteral( "parentLayerId" ) ).toString();
353  const QString name = layerInfoMap.value( QStringLiteral( "name" ) ).toString();
354  const QString description = layerInfoMap.value( QStringLiteral( "description" ) ).toString();
355 
356  // Yes, potentially we may visit twice, once as as a raster (if applicable), and once as a vector (if applicable)!
357  if ( serviceMayRenderMaps && ( filter == Raster || filter == AllTypes ) )
358  {
359  if ( !layerInfoMap.value( QStringLiteral( "subLayerIds" ) ).toList().empty() )
360  {
361  visitor( parentLayerId, Raster, QgsWkbTypes::UnknownGeometry, id, name, description, parentUrl + '/' + id, true, QString(), format );
362  }
363  else
364  {
365  visitor( parentLayerId, Raster, QgsWkbTypes::UnknownGeometry, id, name, description, parentUrl + '/' + id, false, authid, format );
366  }
367  }
368 
369  if ( serviceMayHaveQueryCapability && ( filter == Vector || filter == AllTypes ) )
370  {
371  const QString geometryType = layerInfoMap.value( QStringLiteral( "geometryType" ) ).toString();
372 #if 0
373  // we have a choice here -- if geometryType is unknown and the service reflects that it supports Map capabilities,
374  // then we can't be sure whether or not the individual sublayers support Query or Map requests only. So we either:
375  // 1. Send off additional requests for each individual layer's capabilities (too expensive)
376  // 2. Err on the side of only showing services we KNOW will work for layer -- but this has the side effect that layers
377  // which ARE available as feature services will only show as raster mapserver layers, which is VERY bad/restrictive
378  // 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
379  // server configuration
380  // We opt for 3, because otherwise we're making it impossible for users to load valid vector layers into QGIS
381 
382  if ( serviceMayRenderMaps )
383  {
384  if ( geometryType.isEmpty() )
385  continue;
386  }
387 #endif
388 
389  const QgsWkbTypes::Type wkbType = QgsArcGisRestUtils::convertGeometryType( geometryType );
390 
391 
392  if ( !layerInfoMap.value( QStringLiteral( "subLayerIds" ) ).toList().empty() )
393  {
394  visitor( parentLayerId, Vector, QgsWkbTypes::geometryType( wkbType ), id, name, description, parentUrl + '/' + id, true, QString(), format );
395  }
396  else
397  {
398  visitor( parentLayerId, Vector, QgsWkbTypes::geometryType( wkbType ), id, name, description, parentUrl + '/' + id, false, authid, format );
399  }
400  }
401  }
402 
403  // Add root MapServer as raster layer when multiple layers are listed
404  if ( filter != Vector && layerInfoList.count() > 1 && serviceData.contains( QStringLiteral( "supportedImageFormatTypes" ) ) )
405  {
406  const QString name = QStringLiteral( "(%1)" ).arg( QObject::tr( "All layers" ) );
407  const QString description = serviceData.value( QStringLiteral( "Comments" ) ).toString();
408  visitor( nullptr, Raster, QgsWkbTypes::UnknownGeometry, nullptr, name, description, parentUrl, false, authid, format );
409  }
410 
411  // Add root ImageServer as layer
412  if ( serviceData.value( QStringLiteral( "serviceDataType" ) ).toString().startsWith( QLatin1String( "esriImageService" ) ) )
413  {
414  const QString name = serviceData.value( QStringLiteral( "name" ) ).toString();
415  const QString description = serviceData.value( QStringLiteral( "description" ) ).toString();
416  visitor( nullptr, Raster, QgsWkbTypes::UnknownGeometry, nullptr, name, description, parentUrl, false, authid, format );
417  }
418 }
419 
420 
422 
423 //
424 // QgsArcGisAsyncQuery
425 //
426 
427 QgsArcGisAsyncQuery::QgsArcGisAsyncQuery( QObject *parent )
428  : QObject( parent )
429 {
430 }
431 
432 QgsArcGisAsyncQuery::~QgsArcGisAsyncQuery()
433 {
434  if ( mReply )
435  mReply->deleteLater();
436 }
437 
438 void QgsArcGisAsyncQuery::start( const QUrl &url, const QString &authCfg, QByteArray *result, bool allowCache, const QgsStringMap &headers )
439 {
440  mResult = result;
441  QNetworkRequest request( url );
442 
443  for ( auto it = headers.constBegin(); it != headers.constEnd(); ++it )
444  {
445  request.setRawHeader( it.key().toUtf8(), it.value().toUtf8() );
446  }
447 
448  if ( !authCfg.isEmpty() && !QgsApplication::authManager()->updateNetworkRequest( request, authCfg ) )
449  {
450  const QString error = tr( "network request update failed for authentication config" );
451  emit failed( QStringLiteral( "Network" ), error );
452  return;
453  }
454 
455  QgsSetRequestInitiatorClass( request, QStringLiteral( "QgsArcGisAsyncQuery" ) );
456  if ( allowCache )
457  {
458  request.setAttribute( QNetworkRequest::CacheLoadControlAttribute, QNetworkRequest::PreferCache );
459  request.setAttribute( QNetworkRequest::CacheSaveControlAttribute, true );
460  }
461  mReply = QgsNetworkAccessManager::instance()->get( request );
462  connect( mReply, &QNetworkReply::finished, this, &QgsArcGisAsyncQuery::handleReply );
463 }
464 
465 void QgsArcGisAsyncQuery::handleReply()
466 {
467  mReply->deleteLater();
468  // Handle network errors
469  if ( mReply->error() != QNetworkReply::NoError )
470  {
471  QgsDebugMsg( QStringLiteral( "Network error: %1" ).arg( mReply->errorString() ) );
472  emit failed( QStringLiteral( "Network error" ), mReply->errorString() );
473  return;
474  }
475 
476  // Handle HTTP redirects
477  const QVariant redirect = mReply->attribute( QNetworkRequest::RedirectionTargetAttribute );
478  if ( !redirect.isNull() )
479  {
480  QNetworkRequest request = mReply->request();
481  QgsSetRequestInitiatorClass( request, QStringLiteral( "QgsArcGisAsyncQuery" ) );
482  QgsDebugMsg( "redirecting to " + redirect.toUrl().toString() );
483  request.setUrl( redirect.toUrl() );
484  mReply = QgsNetworkAccessManager::instance()->get( request );
485  connect( mReply, &QNetworkReply::finished, this, &QgsArcGisAsyncQuery::handleReply );
486  return;
487  }
488 
489  *mResult = mReply->readAll();
490  mResult = nullptr;
491  emit finished();
492 }
493 
494 //
495 // QgsArcGisAsyncParallelQuery
496 //
497 
498 QgsArcGisAsyncParallelQuery::QgsArcGisAsyncParallelQuery( const QString &authcfg, const QgsHttpHeaders &requestHeaders, QObject *parent )
499  : QObject( parent )
500  , mAuthCfg( authcfg )
501  , mRequestHeaders( requestHeaders )
502 {
503 }
504 
505 void QgsArcGisAsyncParallelQuery::start( const QVector<QUrl> &urls, QVector<QByteArray> *results, bool allowCache )
506 {
507  Q_ASSERT( results->size() == urls.size() );
508  mResults = results;
509  mPendingRequests = mResults->size();
510  for ( int i = 0, n = urls.size(); i < n; ++i )
511  {
512  QNetworkRequest request( urls[i] );
513  QgsSetRequestInitiatorClass( request, QStringLiteral( "QgsArcGisAsyncParallelQuery" ) );
514  QgsSetRequestInitiatorId( request, QString::number( i ) );
515 
516  mRequestHeaders.updateNetworkRequest( request );
517  if ( !mAuthCfg.isEmpty() && !QgsApplication::authManager()->updateNetworkRequest( request, mAuthCfg ) )
518  {
519  const QString error = tr( "network request update failed for authentication config" );
520  mErrors.append( error );
521  QgsMessageLog::logMessage( error, tr( "Network" ) );
522  continue;
523  }
524 
525  request.setAttribute( QNetworkRequest::HttpPipeliningAllowedAttribute, true );
526  if ( allowCache )
527  {
528  request.setAttribute( QNetworkRequest::CacheLoadControlAttribute, QNetworkRequest::PreferCache );
529  request.setAttribute( QNetworkRequest::CacheSaveControlAttribute, true );
530  request.setRawHeader( "Connection", "keep-alive" );
531  }
532  QNetworkReply *reply = QgsNetworkAccessManager::instance()->get( request );
533  reply->setProperty( "idx", i );
534  connect( reply, &QNetworkReply::finished, this, &QgsArcGisAsyncParallelQuery::handleReply );
535  }
536 }
537 
538 void QgsArcGisAsyncParallelQuery::handleReply()
539 {
540  QNetworkReply *reply = qobject_cast<QNetworkReply *>( QObject::sender() );
541  const QVariant redirect = reply->attribute( QNetworkRequest::RedirectionTargetAttribute );
542  const int idx = reply->property( "idx" ).toInt();
543  reply->deleteLater();
544  if ( reply->error() != QNetworkReply::NoError )
545  {
546  // Handle network errors
547  mErrors.append( reply->errorString() );
548  --mPendingRequests;
549  }
550  else if ( !redirect.isNull() )
551  {
552  // Handle HTTP redirects
553  QNetworkRequest request = reply->request();
554  QgsSetRequestInitiatorClass( request, QStringLiteral( "QgsArcGisAsyncParallelQuery" ) );
555  QgsDebugMsg( "redirecting to " + redirect.toUrl().toString() );
556  request.setUrl( redirect.toUrl() );
557  reply = QgsNetworkAccessManager::instance()->get( request );
558  reply->setProperty( "idx", idx );
559  connect( reply, &QNetworkReply::finished, this, &QgsArcGisAsyncParallelQuery::handleReply );
560  }
561  else
562  {
563  // All OK
564  ( *mResults )[idx] = reply->readAll();
565  --mPendingRequests;
566  }
567  if ( mPendingRequests == 0 )
568  {
569  emit finished( mErrors );
570  mResults = nullptr;
571  mErrors.clear();
572  }
573 }
574 
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 getLayerInfo(const QString &layerurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders())
Retrieves JSON layer info for the specified layer URL.
static void addLayerItems(const std::function< void(const QString &parentLayerId, ServiceTypeFilter serviceType, QgsWkbTypes::GeometryType geometryType, const QString &layerId, const QString &name, const QString &description, const QString &url, bool isParentLayer, const QString &authid, const QString &format)> &visitor, const QVariantMap &serviceData, const QString &parentUrl, const QString &parentSupportedFormats, const ServiceTypeFilter filter=AllTypes)
Calls the specified visitor function on all layer items found within the given service data.
static QVariantMap getObjectIds(const QString &layerurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), const QgsRectangle &bbox=QgsRectangle())
Retrieves all object IDs for the specified layer URL.
static void visitServiceItems(const std::function< void(const QString &serviceName, const QString &url, const QString &service, ServiceTypeFilter serviceType)> &visitor, const QVariantMap &serviceData, const QString &baseUrl)
Calls the specified visitor function on all service items found within the given service 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)
Gets a list of object IDs which fall within the specified extent.
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)
Retrieves all matching objects from the specified layer URL.
static QVariantMap queryServiceJSON(const QUrl &url, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr)
Performs a blocking request to a URL and returns the retrieved JSON content.
static QByteArray queryService(const QUrl &url, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr, QString *contentType=nullptr)
Performs a blocking request to a URL and returns the retrieved data.
static QVariantMap getServiceInfo(const QString &baseurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders())
Retrieves JSON service info for the specified base URL.
static QgsCoordinateReferenceSystem convertSpatialReference(const QVariantMap &spatialReferenceMap)
Converts a spatial reference JSON definition to a QgsCoordinateReferenceSystem value.
static QgsWkbTypes::Type convertGeometryType(const QString &type)
Converts an ESRI REST geometry type to a WKB type.
bool updateNetworkRequest(QNetworkRequest &request, const QString &authcfg, const QString &dataprovider=QString())
Provider call to update a QNetworkRequest with an authentication config.
A thread safe class for performing blocking (sync) network requests, with full support for QGIS proxy...
ErrorCode get(QNetworkRequest &request, bool forceRefresh=false, QgsFeedback *feedback=nullptr)
Performs a "get" operation on the specified request.
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() or post() request has been made.
@ NoError
No error was encountered.
QgsNetworkReplyContent reply() const
Returns the content of the network reply, after a get() or post() request has been made.
QString authid() const
Returns the authority identifier for the CRS.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:45
bool isCanceled() const SIP_HOLDGIL
Tells whether the operation has been canceled already.
Definition: qgsfeedback.h:54
This class 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)
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.
Definition: qgsrectangle.h:42
double yMaximum() const SIP_HOLDGIL
Returns the y maximum value (top side of rectangle).
Definition: qgsrectangle.h:193
double xMaximum() const SIP_HOLDGIL
Returns the x maximum value (right side of rectangle).
Definition: qgsrectangle.h:183
double xMinimum() const SIP_HOLDGIL
Returns the x minimum value (left side of rectangle).
Definition: qgsrectangle.h:188
double yMinimum() const SIP_HOLDGIL
Returns the y minimum value (bottom side of rectangle).
Definition: qgsrectangle.h:198
bool isNull() const
Test if the rectangle is null (all coordinates zero or after call to setMinimal()).
Definition: qgsrectangle.h:479
static GeometryType geometryType(Type type) SIP_HOLDGIL
Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a Polyg...
Definition: qgswkbtypes.h:938
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
Definition: qgswkbtypes.h:141
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:70
QMap< QString, QString > QgsStringMap
Definition: qgis.h:1961
#define QgsDebugMsg(str)
Definition: qgslogger.h:38
#define QgsSetRequestInitiatorClass(request, _class)
#define QgsSetRequestInitiatorId(request, str)
const QgsCoordinateReferenceSystem & crs