Merge pull request #54706 from Gustry/hide-password

rldhont · web-flow · commit dece451aa166 · 2023-09-29T14:22:38.000+02:00
Hide password instead of removing it
diff --git a/python/core/auto_generated/qgsmaplayer.sip.in b/python/core/auto_generated/qgsmaplayer.sip.in
@@ -542,12 +542,14 @@ or other problem. Child classes set this flag when initialized.
 :return: ``True`` if the layer is valid and can be accessed
 %End
 
-    QString publicSource() const;
+    QString publicSource( bool hidePassword = false ) const;
 %Docstring
 Gets a version of the internal layer definition that has sensitive
 bits removed (for example, the password). This function should
 be used when displaying the source name for general viewing.
 
+:param hidePassword: False, if the password should be removed or replaced by an arbitrary string, since QGIS 3.34
+
 .. seealso:: :py:func:`source`
 %End
 
diff --git a/src/core/project/qgsprojectbadlayerhandler.cpp b/src/core/project/qgsprojectbadlayerhandler.cpp
@@ -28,7 +28,7 @@ void QgsProjectBadLayerHandler::handleBadLayers( const QList<QDomNode> &layers )
 
   for ( const QDomNode &layer : layers )
   {
-    QgsMessageLog::logMessage( QObject::tr( " * %1" ).arg( QgsDataSourceUri::removePassword( dataSource( layer ) ) ) );
+    QgsMessageLog::logMessage( QObject::tr( " * %1" ).arg( QgsDataSourceUri::removePassword( dataSource( layer ), true ) ) );
   }
 }
 
diff --git a/src/core/qgsmaplayer.cpp b/src/core/qgsmaplayer.cpp
@@ -342,13 +342,13 @@ QString QgsMapLayer::metadataUrlFormat() const
   }
 }
 
-QString QgsMapLayer::publicSource() const
+QString QgsMapLayer::publicSource( bool hidePassword ) const
 {
   QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
   // Redo this every time we're asked for it, as we don't know if
   // dataSource has changed.
-  QString safeName = QgsDataSourceUri::removePassword( mDataSource );
+  QString safeName = QgsDataSourceUri::removePassword( mDataSource, hidePassword );
   return safeName;
 }
 
diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h
@@ -564,9 +564,10 @@ class CORE_EXPORT QgsMapLayer : public QObject
      * Gets a version of the internal layer definition that has sensitive
       *  bits removed (for example, the password). This function should
       * be used when displaying the source name for general viewing.
+      * \param hidePassword False, if the password should be removed or replaced by an arbitrary string, since QGIS 3.34
       * \see source()
      */
-    QString publicSource() const;
+    QString publicSource( bool hidePassword = false ) const;
 
     /**
      * Returns the source for the layer. This source may contain usernames, passwords
diff --git a/src/gui/qgscredentialdialog.cpp b/src/gui/qgscredentialdialog.cpp
@@ -149,7 +149,7 @@ void QgsCredentialDialog::requestCredentials( const QString &realm, QString *use
   stackedWidget->setCurrentIndex( 0 );
   mIgnoreButton->show();
   chkbxPasswordHelperEnable->setChecked( QgsApplication::authManager()->passwordHelperEnabled() );
-  labelRealm->setText( QgsDataSourceUri::removePassword( realm ) );
+  labelRealm->setText( QgsDataSourceUri::removePassword( realm, true ) );
   mRealm = realm;
   leUsername->setText( *username );
   lePassword->setText( *password );

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ void QgsProjectBadLayerHandler::handleBadLayers( const QList<QDomNode> &layers )`
`28`	`28`
`29`	`29`	`for ( const QDomNode &layer : layers )`
`30`	`30`	`{`
`31`		`- QgsMessageLog::logMessage( QObject::tr( " * %1" ).arg( QgsDataSourceUri::removePassword( dataSource( layer ) ) ) );`
	`31`	`+ QgsMessageLog::logMessage( QObject::tr( " * %1" ).arg( QgsDataSourceUri::removePassword( dataSource( layer ), true ) ) );`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -342,13 +342,13 @@ QString QgsMapLayer::metadataUrlFormat() const`
`342`	`342`	`}`
`343`	`343`	`}`
`344`	`344`
`345`		`-QString QgsMapLayer::publicSource() const`
	`345`	`+QString QgsMapLayer::publicSource( bool hidePassword ) const`
`346`	`346`	`{`
`347`	`347`	`QGIS_PROTECT_QOBJECT_THREAD_ACCESS`
`348`	`348`
`349`	`349`	`// Redo this every time we're asked for it, as we don't know if`
`350`	`350`	`// dataSource has changed.`
`351`		`- QString safeName = QgsDataSourceUri::removePassword( mDataSource );`
	`351`	`+ QString safeName = QgsDataSourceUri::removePassword( mDataSource, hidePassword );`
`352`	`352`	`return safeName;`
`353`	`353`	`}`
`354`	`354`