[Feature] Data Source Manager STAC search initial implementation (qgis#59534)

* Data Source Manager STAC search initial implementation

* Review fixes

* More stac tests

* Silence clang-tidy

Author: uclaros

src/app/qgisapp.cpp

@@ -3029,6 +3029,7 @@ void QgisApp::createActions()
   connect( mActionAddPointCloudLayer, &QAction::triggered, this, [=] { dataSourceManager( QStringLiteral( "pointcloud" ) ); } );
   connect( mActionAddGpsLayer, &QAction::triggered, this, [=] { dataSourceManager( QStringLiteral( "gpx" ) ); } );
   connect( mActionAddWcsLayer, &QAction::triggered, this, [=] { dataSourceManager( QStringLiteral( "wcs" ) ); } );
+  connect( mActionAddStacLayer, &QAction::triggered, this, [=] { dataSourceManager( QStringLiteral( "stac" ) ); } );
 #ifdef HAVE_SPATIALITE
   connect( mActionAddWfsLayer, &QAction::triggered, this, [=] { dataSourceManager( QStringLiteral( "WFS" ) ); } );
 #endif

src/core/stac/qgsstacasset.cpp

@@ -52,3 +52,23 @@ QStringList QgsStacAsset::roles() const
 {
   return mRoles;
 }
+
+bool QgsStacAsset::isCloudOptimized() const
+{
+  const QString format = formatName();
+  return format == QLatin1String( "COG" ) ||
+         format == QLatin1String( "COPC" ) ||
+         format == QLatin1String( "EPT" );
+}
+
+QString QgsStacAsset::formatName() const
+{
+  if ( mMediaType == QLatin1String( "image/tiff; application=geotiff; profile=cloud-optimized" ) ||
+       mMediaType == QLatin1String( "image/vnd.stac.geotiff; cloud-optimized=true" ) )
+    return QStringLiteral( "COG" );
+  else if ( mMediaType == QLatin1String( "application/vnd.laszip+copc" ) )
+    return QStringLiteral( "COPC" );
+  else if ( mHref.endsWith( QLatin1String( "/ept.json" ) ) )
+    return QStringLiteral( "EPT" );
+  return QString();
+}

src/core/stac/qgsstacasset.h

@@ -61,6 +61,18 @@ class CORE_EXPORT QgsStacAsset
      */
     QStringList roles() const;
 
+    /**
+     * Returns whether the asset is in a cloud optimized format like COG or COPC
+     * \since QGIS 3.42
+     */
+    bool isCloudOptimized() const;
+
+    /**
+     * Returns the format name for cloud optimized formats
+     * \since QGIS 3.42
+     */
+    QString formatName() const;
+
   private:
     QString mHref;
     QString mTitle;

src/core/stac/qgsstaccontroller.cpp

@@ -51,6 +51,24 @@ int QgsStacController::fetchItemCollectionAsync( const QUrl &url )
   return reply->property( "requestId" ).toInt();
 }
 
+int QgsStacController::fetchCollectionsAsync( const QUrl &url )
+{
+  QNetworkReply *reply = fetchAsync( url );
+  connect( reply, &QNetworkReply::finished, this, &QgsStacController::handleCollectionsReply );
+
+  return reply->property( "requestId" ).toInt();
+}
+
+void QgsStacController::cancelPendingAsyncRequests()
+{
+  for ( QNetworkReply *reply : std::as_const( mReplies ) )
+  {
+    reply->abort();
+    reply->deleteLater();
+  }
+  mReplies.clear();
+}
+
 QNetworkReply *QgsStacController::fetchAsync( const QUrl &url )
 {
   QNetworkRequest req( url );
@@ -102,6 +120,7 @@ void QgsStacController::handleStacObjectReply()
   parser.setData( data );
   parser.setBaseUrl( reply->url() );
 
+  QString error;
   QgsStacObject *object = nullptr;
   switch ( parser.type() )
   {
@@ -116,10 +135,11 @@ void QgsStacController::handleStacObjectReply()
       break;
     case QgsStacObject::Type::Unknown:
       object = nullptr;
+      error = QStringLiteral( "Parsed STAC data is not a Catalog, Collection or Item" );
       break;
   }
   mFetchedStacObjects.insert( requestId, object );
-  emit finishedStacObjectRequest( requestId, parser.error() );
+  emit finishedStacObjectRequest( requestId, error.isEmpty() ? parser.error() : error );
   reply->deleteLater();
   mReplies.removeOne( reply );
 }
@@ -153,6 +173,35 @@ void QgsStacController::handleItemCollectionReply()
   mReplies.removeOne( reply );
 }
 
+void QgsStacController::handleCollectionsReply()
+{
+  QNetworkReply *reply = qobject_cast<QNetworkReply *>( QObject::sender() );
+  if ( !reply )
+    return;
+
+  const int requestId = reply->property( "requestId" ).toInt();
+  QgsDebugMsgLevel( QStringLiteral( "Finished STAC request with id %1" ).arg( requestId ), 2 );
+
+  if ( reply->error() != QNetworkReply::NoError )
+  {
+    emit finishedCollectionsRequest( requestId, reply->errorString() );
+    reply->deleteLater();
+    mReplies.removeOne( reply );
+    return;
+  }
+
+  const QByteArray data = reply->readAll();
+  QgsStacParser parser;
+  parser.setData( data );
+  parser.setBaseUrl( reply->url() );
+
+  QgsStacCollections *cols = parser.collections();
+  mFetchedCollections.insert( requestId, cols );
+  emit finishedCollectionsRequest( requestId, parser.error() );
+  reply->deleteLater();
+  mReplies.removeOne( reply );
+}
+
 QgsStacObject *QgsStacController::takeStacObject( int requestId )
 {
   return mFetchedStacObjects.take( requestId );
@@ -163,6 +212,11 @@ QgsStacItemCollection *QgsStacController::takeItemCollection( int requestId )
   return mFetchedItemCollections.take( requestId );
 }
 
+QgsStacCollections *QgsStacController::takeCollections( int requestId )
+{
+  return mFetchedCollections.take( requestId );
+}
+
 QgsStacObject *QgsStacController::fetchStacObject( const QUrl &url, QString *error )
 {
   QgsNetworkReplyContent content = fetchBlocking( url );

src/core/stac/qgsstaccontroller.h

@@ -107,6 +107,21 @@ class CORE_EXPORT QgsStacController : public QObject
      */
     int fetchItemCollectionAsync( const QUrl &url );
 
+    /**
+     * Initiates an asynchronous request for a Collections collection using the \a url
+     * and returns an associated request id.
+     * When the request is completed, the finishedCollectionsRequest() signal is fired
+     * and the collections can be accessed with takeCollections()
+     * \since QGIS 3.42
+     */
+    int fetchCollectionsAsync( const QUrl &url );
+
+    /**
+     * Cancels all pending async requests
+     * \since QGIS 3.42
+     */
+    void cancelPendingAsyncRequests();
+
     /**
      * Returns the STAC object fetched with the specified \a requestId.
      * It should be used after the finishedStacObjectRequest signal is fired to get the fetched STAC object.
@@ -127,6 +142,17 @@ class CORE_EXPORT QgsStacController : public QObject
      */
     QgsStacItemCollection *takeItemCollection( int requestId );
 
+    /**
+     * Returns the collections collection fetched with the specified \a requestId
+     * It should be used after the finishedCollectionsRequest signal is fired to get the fetched STAC collections.
+     * Returns NULLPTR if the requestId was not found, request was canceled, request failed or parsing the STAC object failed.
+     * The caller takes ownership of the returned collections
+     * \see fetchCollectionsAsync
+     * \see finishedCollectionsRequest
+     * \since QGIS 3.42
+     */
+    QgsStacCollections *takeCollections( int requestId );
+
     /**
      * Returns the authentication config id which will be used during the request.
      * \see setAuthCfg()
@@ -161,9 +187,21 @@ class CORE_EXPORT QgsStacController : public QObject
      */
     void finishedItemCollectionRequest( int id, QString errorMessage );
 
+    /**
+     * This signal is fired when an async request initiated with fetchCollectionsAsync is finished.
+     * The parsed STAC collections collection can be retrieved using takeCollections
+     * \param id The requestId attribute of the finished request
+     * \param errorMessage Reason the request or parsing of the STAC collections may have failed
+     * \see fetchCollectionsAsync
+     * \see takeCollections
+     * \since QGIS 3.42
+     */
+    void finishedCollectionsRequest( int id, QString errorMessage );
+
   private slots:
     void handleStacObjectReply();
     void handleItemCollectionReply();
+    void handleCollectionsReply();
 
   private:
     QNetworkReply *fetchAsync( const QUrl &url );
@@ -173,6 +211,7 @@ class CORE_EXPORT QgsStacController : public QObject
     QgsHttpHeaders mHeaders;
     QMap< int, QgsStacObject *> mFetchedStacObjects;
     QMap< int, QgsStacItemCollection *> mFetchedItemCollections;
+    QMap< int, QgsStacCollections *> mFetchedCollections;
     QVector<QNetworkReply *> mReplies;
     QString mError;
 };

src/core/stac/qgsstacdataitems.cpp

@@ -87,10 +87,7 @@ bool QgsStacItemItem::hasDragEnabled() const
   const QMap<QString, QgsStacAsset> assets = mStacItem->assets();
   for ( auto it = assets.constBegin(); it != assets.constEnd(); ++it )
   {
-    if ( it->mediaType() == QLatin1String( "image/tiff; application=geotiff; profile=cloud-optimized" ) ||
-         it->mediaType() == QLatin1String( "image/vnd.stac.geotiff; cloud-optimized=true" ) ||
-         it->mediaType() == QLatin1String( "application/vnd.laszip+copc" ) ||
-         it->href().endsWith( QLatin1String( "/ept.json" ) ) )
+    if ( it->isCloudOptimized() )
       return true;
   }
   return false;
@@ -147,7 +144,7 @@ QgsMimeDataUtils::UriList QgsStacItemItem::mimeUris() const
     uris.append( uri );
   }
 
-  return { uris };
+  return uris;
 }
 
 bool QgsStacItemItem::equal( const QgsDataItem * )

src/core/stac/qgsstacitem.cpp

@@ -40,7 +40,7 @@ QString QgsStacItem::toHtml() const
 {
   QString html = QStringLiteral( "<html><head></head>\n<body>\n" );
 
-  html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Item") );
+  html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Item" ) );
   html += QLatin1String( "<table class=\"list-view\">\n" );
   html += QStringLiteral( "<tr><td class=\"highlight\">%1</td><td>%2</td></tr>\n" ).arg( QStringLiteral( "id" ), id() );
   html += QStringLiteral( "<tr><td class=\"highlight\">%1</td><td>%2</td></tr>\n" ).arg( QStringLiteral( "stac_version" ), stacVersion() );
@@ -49,7 +49,7 @@ QString QgsStacItem::toHtml() const
 
   if ( !mStacExtensions.isEmpty() )
   {
-    html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Extensions") );
+    html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Extensions" ) );
     html += QLatin1String( "<ul>\n" );
     for ( const QString &extension : mStacExtensions )
     {
@@ -58,19 +58,19 @@ QString QgsStacItem::toHtml() const
     html += QLatin1String( "</ul>\n" );
   }
 
-  html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Geometry") );
+  html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Geometry" ) );
   html += QLatin1String( "<table class=\"list-view\">\n" );
   html += QStringLiteral( "<tr><td class=\"highlight\">%1</td><td>%2</td></tr>\n" ).arg( QStringLiteral( "WKT" ), mGeometry.asWkt() );
   html += QLatin1String( "</table>\n" );
 
-  html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Bounding Box") );
+  html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Bounding Box" ) );
   html += QLatin1String( "<ul>\n" );
   html += QStringLiteral( "<li>%1</li>\n" ).arg( mBbox.is2d() ? mBbox.toRectangle().toString() : mBbox.toString() );
   html += QLatin1String( "</ul>\n" );
 
   if ( ! mProperties.isEmpty() )
   {
-    html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Properties") );
+    html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Properties" ) );
     html += QLatin1String( "<table class=\"list-view\">\n" );
     for ( auto it = mProperties.constBegin(); it != mProperties.constEnd(); ++it )
     {
@@ -79,7 +79,7 @@ QString QgsStacItem::toHtml() const
     html += QLatin1String( "</table><br/>\n" );
   }
 
-  html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Links") );
+  html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Links" ) );
   for ( const QgsStacLink &link : mLinks )
   {
     html += QLatin1String( "<table class=\"list-view\">\n" );
@@ -92,7 +92,7 @@ QString QgsStacItem::toHtml() const
 
   if ( ! mAssets.isEmpty() )
   {
-    html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Assets") );
+    html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Assets" ) );
     for ( auto it = mAssets.constBegin(); it != mAssets.constEnd(); ++it )
     {
       html += QLatin1String( "<table class=\"list-view\">\n" );
@@ -177,3 +177,65 @@ QgsDateTimeRange QgsStacItem::dateTimeRange() const
   const QDateTime end = QDateTime::fromString( mProperties.value( QStringLiteral( "end_datetime" ), QStringLiteral( "null" ) ).toString() );
   return QgsDateTimeRange( start, end );
 }
+
+QString QgsStacItem::title() const
+{
+  return mProperties.value( QStringLiteral( "title" ) ).toString();
+}
+
+QString QgsStacItem::description() const
+{
+  return mProperties.value( QStringLiteral( "description" ) ).toString();
+}
+
+QgsMimeDataUtils::UriList QgsStacItem::uris() const
+{
+  QgsMimeDataUtils::UriList uris;
+  for ( auto it = mAssets.constBegin(); it != mAssets.constEnd(); ++it )
+  {
+    QgsMimeDataUtils::Uri uri;
+    QUrl url( it->href() );
+    if ( url.isLocalFile() )
+    {
+      uri.uri = it->href();
+    }
+    else if ( it->formatName() == QLatin1String( "COG" ) )
+    {
+      uri.layerType = QStringLiteral( "raster" );
+      uri.providerKey = QStringLiteral( "gdal" );
+      if ( it->href().startsWith( QLatin1String( "http" ), Qt::CaseInsensitive ) ||
+           it->href().startsWith( QLatin1String( "ftp" ), Qt::CaseInsensitive ) )
+      {
+        uri.uri = QStringLiteral( "/vsicurl/%1" ).arg( it->href() );
+      }
+      else if ( it->href().startsWith( QLatin1String( "s3://" ), Qt::CaseInsensitive ) )
+      {
+        uri.uri = QStringLiteral( "/vsis3/%1" ).arg( it->href().mid( 5 ) );
+      }
+      else
+      {
+        uri.uri = it->href();
+      }
+    }
+    else if ( it->formatName() == QLatin1String( "COPC" ) )
+    {
+      uri.layerType = QStringLiteral( "pointcloud" );
+      uri.providerKey = QStringLiteral( "copc" );
+      uri.uri = it->href();
+    }
+    else if ( it->formatName() == QLatin1String( "EPT" ) )
+    {
+      uri.layerType = QStringLiteral( "pointcloud" );
+      uri.providerKey = QStringLiteral( "ept" );
+      uri.uri = it->href();
+    }
+
+    // skip assets with incompatible formats
+    if ( uri.uri.isEmpty() )
+      continue;
+
+    uri.name = it->title().isEmpty() ? url.fileName() : it->title();
+    uris.append( uri );
+  }
+  return uris;
+}

src/core/stac/qgsstacitem.h

@@ -24,6 +24,7 @@
 #include "qgsstacasset.h"
 #include "qgsgeometry.h"
 #include "qgsbox3d.h"
+#include "qgsmimedatautils.h"
 
 /**
  * \ingroup core
@@ -113,6 +114,24 @@ class CORE_EXPORT QgsStacItem : public QgsStacObject
      */
     QgsDateTimeRange dateTimeRange() const;
 
+    /**
+     * Returns an optional human readable title describing the Item.
+     * \since QGIS 3.42
+     */
+    QString title() const;
+
+    /**
+     * Returns a Detailed multi-line description to fully explain the Item.
+     * CommonMark 0.29 syntax may be used for rich text representation.
+     * \since QGIS 3.42
+     */
+    QString description() const;
+
+    /**
+     * Returns a list of uris of all assets that have a cloud optimized format like COG or COPC
+     * \since QGIS 3.42
+     */
+    QgsMimeDataUtils::UriList uris() const;
 
   private:
     QgsGeometry mGeometry;