qgsarcgisrestquery.h

Go to the documentation of this file.

/***************************************************************************
    qgsarcgisrestquery.h
    --------------------
    begin                : December 2020
    copyright            : (C) 2020 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSARCGISRESTQUERY_H
#define QGSARCGISRESTQUERY_H
 
 
#include "qgis_core.h"
#include "qgscoordinatereferencesystem.h"
#include "qgshttpheaders.h"
#include "qgsrectangle.h"
 
#include <QPointer>
#include <QString>
#include <QVariantMap>
 
#define SIP_NO_FILE
 
class QgsFeedback;
class QNetworkReply;
class QgsCoordinateReferenceSystem;

class CORE_EXPORT QgsArcGisRestQueryUtils
{
  public:
    enum class ServiceTypeFilter
    {
      Vector = 1 << 0,
      Raster = 1 << 1,
      Scene = 1 << 2,
    };
    Q_DECLARE_FLAGS( ServiceTypeFilters, ServiceTypeFilter );

    static Qgis::ArcGisRestServiceType sniffServiceTypeFromUrl( const QUrl &url );

    static Qgis::ArcGisRestServiceType sniffServiceTypeFromJson( const QVariantMap &json );

    static QVariantMap getServiceInfo(
      const QString &baseurl,
      const QString &authcfg,
      QString &errorTitle,
      QString &errorText,
      const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(),
      const QString &urlPrefix = QString(),
      bool forceRefresh = false
    );

    static QVariantMap getLayerInfo(
      const QString &layerurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), const QString &urlPrefix = QString()
    );

    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()
    );
 

    static QgsRectangle getExtent(
      const QString &layerurl, const QString &whereClause, const QString &authcfg, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), const QString &urlPrefix = QString()
    );

    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,
      QString &errorTitle,
      QString &errorText,
      const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(),
      QgsFeedback *feedback = nullptr,
      const QString &urlPrefix = QString()
    );

    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()
    );

    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(),
      bool forceRefresh = false
    );
    static QVariantMap queryServiceJSON(
      const QUrl &url,
      const QString &authcfg,
      QString &errorTitle,
      QString &errorText,
      const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(),
      QgsFeedback *feedback = nullptr,
      const QString &urlPrefix = QString(),
      bool forceRefresh = false
    );

    static void visitFolderItems( const std::function<void( const QString &folderName, const QString &url )> &visitor, const QVariantMap &serviceData, const QString &baseUrl );

    static void visitServiceItems(
      const std::function<void( const QString &serviceName, const QString &url, Qgis::ArcGisRestServiceType serviceType )> &visitor, const QVariantMap &serviceData, const QString &baseUrl
    );

    struct LayerItemDetails
    {
        QString parentLayerId;
        Qgis::ArcGisRestServiceType serviceType = Qgis::ArcGisRestServiceType::Unknown;
        Qgis::GeometryType geometryType = Qgis::GeometryType::Unknown;
        QString layerId;
        QString name;
        QString description;
        QString url;
        bool isParentLayer = false;
        QgsCoordinateReferenceSystem crs;
        QString format;
        bool isMapServerWithQueryCapability = false;
        bool isMapServerSpecialAllLayersOption = false;
    };

    static void addLayerItems(
      const std::function<void( const LayerItemDetails &details )> &visitor, const QVariantMap &serviceData, const QString &parentUrl, const QString &parentSupportedFormats, Qgis::ArcGisRestServiceType serviceType
    );

    static QUrl parseUrl( const QUrl &url, bool *isTestEndpoint = nullptr );
 
  private:
    static void adjustBaseUrl( QString &baseUrl, const QString &name );
 
    friend class TestQgsArcGisRestUtils;
};

class CORE_EXPORT QgsArcGisAsyncQuery : public QObject
{
    Q_OBJECT
  public:
    QgsArcGisAsyncQuery( QObject *parent = nullptr );
    ~QgsArcGisAsyncQuery() override;
 
    void start( const QUrl &url, const QString &authCfg, QByteArray *result, bool allowCache = false, const QgsHttpHeaders &headers = QgsHttpHeaders(), const QString &urlPrefix = QString() );
  signals:
    void finished();
    void failed( QString errorTitle, QString errorName );
  private slots:
    void handleReply();
 
  private:
    QPointer<QNetworkReply> mReply;
    QByteArray *mResult = nullptr;
};
 
class CORE_EXPORT QgsArcGisAsyncParallelQuery : public QObject
{
    Q_OBJECT
  public:
    QgsArcGisAsyncParallelQuery( const QString &authcfg, const QgsHttpHeaders &requestHeaders, QObject *parent = nullptr );
    void start( const QVector<QUrl> &urls, QVector<QByteArray> *results, bool allowCache = false );
 
  signals:
    void finished( QStringList errors );
  private slots:
    void handleReply();
 
  private:
    QVector<QByteArray> *mResults = nullptr;
    int mPendingRequests = 0;
    QStringList mErrors;
    QString mAuthCfg;
    QgsHttpHeaders mRequestHeaders;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsArcGisRestQueryUtils::ServiceTypeFilters )
 

 
#endif // QGSARCGISRESTQUERY_H