Allow setting VSI credentials when loading OGR/GDAL layers

python/PyQt6/gui/auto_generated/providers/gdal/qgsgdalcredentialoptionswidget.sip.in

@@ -0,0 +1,67 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/providers/gdal/qgsgdalcredentialoptionswidget.h              *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+class QgsGdalCredentialOptionsWidget : QWidget
+{
+%Docstring(signature="appended")
+A widget for configuring GDAL credential options.
+
+.. versionadded:: 3.40
+%End
+
+%TypeHeaderCode
+#include "qgsgdalcredentialoptionswidget.h"
+%End
+  public:
+
+    QgsGdalCredentialOptionsWidget( QWidget *parent = 0 );
+%Docstring
+Constructor for QgsGdalCredentialOptionsWidget, with the specified ``parent`` widget.
+%End
+
+    void setDriver( const QString &driver );
+%Docstring
+Sets the corresponding ``driver``.
+
+This should match a GDAL VSI driver, eg "vsis3".
+%End
+
+    QVariantMap credentialOptions() const;
+%Docstring
+Returns the credential options configured in the widget.
+
+.. seealso:: :py:func:`setCredentialOptions`
+%End
+
+    void setCredentialOptions( const QVariantMap &options );
+%Docstring
+Sets the credential ``options`` to show in the widget.
+
+.. seealso:: :py:func:`credentialOptions`
+%End
+
+  signals:
+
+    void optionsChanged();
+%Docstring
+Emitted when the credential options are changed in the widget.
+%End
+
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/providers/gdal/qgsgdalcredentialoptionswidget.h              *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/

python/PyQt6/gui/gui_auto.sip

@@ -450,6 +450,7 @@
 %Include auto_generated/proj/qgsprojectionselectionwidget.sip
 %Include auto_generated/proj/qgsrecentcoordinatereferencesystemsmodel.sip
 %Include auto_generated/providers/qgsabstractdbsourceselect.sip
+%Include auto_generated/providers/gdal/qgsgdalcredentialoptionswidget.sip
 %Include auto_generated/raster/qgsrasterattributetablewidget.sip
 %Include auto_generated/raster/qgsrasterattributetabledialog.sip
 %Include auto_generated/raster/qgscolorrampshaderwidget.sip

python/gui/auto_generated/providers/gdal/qgsgdalcredentialoptionswidget.sip.in

@@ -0,0 +1,67 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/providers/gdal/qgsgdalcredentialoptionswidget.h              *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+class QgsGdalCredentialOptionsWidget : QWidget
+{
+%Docstring(signature="appended")
+A widget for configuring GDAL credential options.
+
+.. versionadded:: 3.40
+%End
+
+%TypeHeaderCode
+#include "qgsgdalcredentialoptionswidget.h"
+%End
+  public:
+
+    QgsGdalCredentialOptionsWidget( QWidget *parent = 0 );
+%Docstring
+Constructor for QgsGdalCredentialOptionsWidget, with the specified ``parent`` widget.
+%End
+
+    void setDriver( const QString &driver );
+%Docstring
+Sets the corresponding ``driver``.
+
+This should match a GDAL VSI driver, eg "vsis3".
+%End
+
+    QVariantMap credentialOptions() const;
+%Docstring
+Returns the credential options configured in the widget.
+
+.. seealso:: :py:func:`setCredentialOptions`
+%End
+
+    void setCredentialOptions( const QVariantMap &options );
+%Docstring
+Sets the credential ``options`` to show in the widget.
+
+.. seealso:: :py:func:`credentialOptions`
+%End
+
+  signals:
+
+    void optionsChanged();
+%Docstring
+Emitted when the credential options are changed in the widget.
+%End
+
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/providers/gdal/qgsgdalcredentialoptionswidget.h              *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/

python/gui/gui_auto.sip

@@ -450,6 +450,7 @@
 %Include auto_generated/proj/qgsprojectionselectionwidget.sip
 %Include auto_generated/proj/qgsrecentcoordinatereferencesystemsmodel.sip
 %Include auto_generated/providers/qgsabstractdbsourceselect.sip
+%Include auto_generated/providers/gdal/qgsgdalcredentialoptionswidget.sip
 %Include auto_generated/raster/qgsrasterattributetablewidget.sip
 %Include auto_generated/raster/qgsrasterattributetabledialog.sip
 %Include auto_generated/raster/qgscolorrampshaderwidget.sip

src/core/providers/gdal/qgsgdalproviderbase.cpp

@@ -26,7 +26,6 @@
 #include "qgslogger.h"
 #include "qgsgdalproviderbase.h"
 #include "qgsgdalutils.h"
-#include "qgssettings.h"
 
 #include <mutex>
 #include <QRegularExpression>
@@ -290,6 +289,21 @@ GDALDatasetH QgsGdalProviderBase::gdalOpen( const QString &uri, unsigned int nOp
                                      option.toUtf8().constData() );
   }
 
+  const QString vsiPrefix = parts.value( QStringLiteral( "vsiPrefix" ) ).toString();
+  const QString vsiSuffix = parts.value( QStringLiteral( "vsiSuffix" ) ).toString();
+
+  const QVariantMap credentialOptions = parts.value( QStringLiteral( "credentialOptions" ) ).toMap();
+  parts.remove( QStringLiteral( "credentialOptions" ) );
+  if ( !credentialOptions.isEmpty() && !vsiPrefix.isEmpty() )
+  {
+    const thread_local QRegularExpression bucketRx( QStringLiteral( "^(.*?)/" ) );
+    const QRegularExpressionMatch bucketMatch = bucketRx.match( parts.value( QStringLiteral( "path" ) ).toString() );
+    if ( bucketMatch.hasMatch() )
+    {
+      QgsGdalUtils::applyVsiCredentialOptions( vsiPrefix, bucketMatch.captured( 1 ), credentialOptions );
+    }
+  }
+
   const bool modify_OGR_GPKG_FOREIGN_KEY_CHECK = !CPLGetConfigOption( "OGR_GPKG_FOREIGN_KEY_CHECK", nullptr );
   if ( modify_OGR_GPKG_FOREIGN_KEY_CHECK )
   {
@@ -301,8 +315,6 @@ GDALDatasetH QgsGdalProviderBase::gdalOpen( const QString &uri, unsigned int nOp
 
   if ( !hDS )
   {
-    const QString vsiPrefix = parts.value( QStringLiteral( "vsiPrefix" ) ).toString();
-    const QString vsiSuffix = parts.value( QStringLiteral( "vsiSuffix" ) ).toString();
     if ( vsiSuffix.isEmpty() && QgsGdalUtils::isVsiArchivePrefix( vsiPrefix ) )
     {
       // in the case that a direct path to a vsi supported archive was specified BUT
@@ -391,6 +403,7 @@ QVariantMap QgsGdalProviderBase::decodeGdalUri( const QString &uri )
   QString layerName;
   QString authcfg;
   QStringList openOptions;
+  QVariantMap credentialOptions;
 
   const thread_local QRegularExpression authcfgRegex( " authcfg='([^']+)'" );
   QRegularExpressionMatch match;
@@ -451,13 +464,35 @@ QVariantMap QgsGdalProviderBase::decodeGdalUri( const QString &uri )
         break;
       }
     }
+
+    const thread_local QRegularExpression credentialOptionRegex( QStringLiteral( "\\|credential:([^|]*)" ) );
+    const thread_local QRegularExpression credentialOptionKeyValueRegex( QStringLiteral( "(.*?)=(.*)" ) );
+    while ( true )
+    {
+      const QRegularExpressionMatch match = credentialOptionRegex.match( path );
+      if ( match.hasMatch() )
+      {
+        const QRegularExpressionMatch keyValueMatch = credentialOptionKeyValueRegex.match( match.captured( 1 ) );
+        if ( keyValueMatch.hasMatch() )
+        {
+          credentialOptions.insert( keyValueMatch.captured( 1 ), keyValueMatch.captured( 2 ) );
+        }
+        path = path.remove( match.capturedStart( 0 ), match.capturedLength( 0 ) );
+      }
+      else
+      {
+        break;
+      }
+    }
   }
 
   QVariantMap uriComponents;
   uriComponents.insert( QStringLiteral( "path" ), path );
   uriComponents.insert( QStringLiteral( "layerName" ), layerName );
   if ( !openOptions.isEmpty() )
     uriComponents.insert( QStringLiteral( "openOptions" ), openOptions );
+  if ( !credentialOptions.isEmpty() )
+    uriComponents.insert( QStringLiteral( "credentialOptions" ), credentialOptions );
   if ( !vsiPrefix.isEmpty() )
     uriComponents.insert( QStringLiteral( "vsiPrefix" ), vsiPrefix );
   if ( !vsiSuffix.isEmpty() )
@@ -494,6 +529,15 @@ QString QgsGdalProviderBase::encodeGdalUri( const QVariantMap &parts )
     uri += openOption;
   }
 
+  const QVariantMap credentialOptions = parts.value( QStringLiteral( "credentialOptions" ) ).toMap();
+  for ( auto it = credentialOptions.constBegin(); it != credentialOptions.constEnd(); ++it )
+  {
+    if ( !it.value().toString().isEmpty() )
+    {
+      uri += QStringLiteral( "|credential:%1=%2" ).arg( it.key(), it.value().toString() );
+    }
+  }
+
   if ( !authcfg.isEmpty() )
     uri += QStringLiteral( " authcfg='%1'" ).arg( authcfg );
 

src/core/providers/ogr/qgsogrprovider.cpp

@@ -418,21 +418,33 @@ QgsOgrProvider::QgsOgrProvider( QString const &uri, const ProviderOptions &optio
 
   QgsDebugMsgLevel( "Data source uri is [" + uri + ']', 2 );
 
+  QVariantMap credentialOptions;
   mFilePath = QgsOgrProviderUtils::analyzeURI( uri,
               mIsSubLayer,
               mLayerIndex,
               mLayerName,
               mSubsetString,
               mOgrGeometryTypeFilter,
-              mOpenOptions );
-
+              mOpenOptions,
+              credentialOptions );
 
   const QVariantMap parts = QgsOgrProviderMetadata().decodeUri( uri );
   if ( parts.contains( QStringLiteral( "uniqueGeometryType" ) ) )
   {
     mUniqueGeometryType = parts.value( QStringLiteral( "uniqueGeometryType" ) ).toString() == QLatin1String( "yes" );
   }
 
+  const QString vsiPrefix = parts.value( QStringLiteral( "vsiPrefix" ) ).toString();
+  if ( !credentialOptions.isEmpty() && !vsiPrefix.isEmpty() )
+  {
+    const thread_local QRegularExpression bucketRx( QStringLiteral( "^(.*?)/" ) );
+    const QRegularExpressionMatch bucketMatch = bucketRx.match( parts.value( QStringLiteral( "path" ) ).toString() );
+    if ( bucketMatch.hasMatch() )
+    {
+      QgsGdalUtils::applyVsiCredentialOptions( vsiPrefix, bucketMatch.captured( 1 ), credentialOptions );
+    }
+  }
+
   // to be called only after mFilePath has been set
   invalidateNetworkCache();
 
@@ -4193,7 +4205,7 @@ void QgsOgrProvider::open( OpenMode mode )
   // Try to open using VSIFileHandler
   //   see http://trac.osgeo.org/gdal/wiki/UserDocs/ReadInZip
   const QString vsiPrefix = QgsGdalUtils::vsiPrefixForPath( dataSourceUri( true ) );
-  if ( !vsiPrefix.isEmpty() || mFilePath.startsWith( QLatin1String( "/vsicurl/" ) ) )
+  if ( ( !vsiPrefix.isEmpty() && vsiPrefix != QStringLiteral( "/vsimem/" ) ) || mFilePath.startsWith( QLatin1String( "/vsicurl/" ) ) )
   {
     // GDAL>=1.8.0 has write support for zip, but read and write operations
     // cannot be interleaved, so for now just use read-only.