Merge pull request #4737 from boundlessgeo/browser-sync

[bugfix] Sync the browser connections when changed from the select dialogs

python/core/qgsbrowsermodel.sip

@@ -138,6 +138,10 @@ Refresh item children
     void stateChanged( const QModelIndex &index, QgsDataItem::State oldState );
 %Docstring
 Emitted when item children fetch was finished
+%End
+    void connectionsChanged( );
+%Docstring
+notify the provider dialogs of a changed connection
 %End
 
   public slots:

python/core/qgsdataitem.sip

@@ -304,6 +304,11 @@ Remove children recursively and set as not populated. This is used when refreshi
 
     virtual void refresh();
 
+    virtual void refreshConnections();
+%Docstring
+Refresh connections: update GUI and emit signal
+%End
+
     virtual void childrenCreated();
 
   signals:
@@ -313,6 +318,10 @@ Remove children recursively and set as not populated. This is used when refreshi
     void endRemoveItems();
     void dataChanged( QgsDataItem *item );
     void stateChanged( QgsDataItem *item, QgsDataItem::State oldState );
+    void connectionsChanged( );
+%Docstring
+open browsers
+%End
 
   protected slots:
 

python/gui/gui_auto.sip

@@ -21,6 +21,7 @@
 %Include qgsbrowserdockwidget.sip
 %Include qgsvertexmarker.sip
 %Include qgsfiledownloader.sip
+%Include qgsabstractdatasourcewidget.sip
 %Include attributetable/qgsfeaturemodel.sip
 %Include auth/qgsauthauthoritieseditor.sip
 %Include auth/qgsauthcertificateinfo.sip
@@ -158,7 +159,6 @@
 %Include qgsoptionswidgetfactory.sip
 %Include qgsorderbydialog.sip
 %Include qgsowssourceselect.sip
-%Include qgssourceselectdialog.sip
 %Include qgspanelwidget.sip
 %Include qgspanelwidgetstack.sip
 %Include qgspasswordlineedit.sip

python/gui/qgsabstractdatasourcewidget.sip

@@ -0,0 +1,109 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsabstractdatasourcewidget.h                                *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+
+class QgsAbstractDataSourceWidget : QDialog
+{
+%Docstring
+  Abstract base Data Source Widget to create connections and add layers
+ This class provides common functionality and the interface for all
+ source select dialogs used by data providers to configure data sources
+ and add layers.
+.. versionadded:: 3.0
+%End
+
+%TypeHeaderCode
+#include "qgsabstractdatasourcewidget.h"
+%End
+  public:
+
+    ~QgsAbstractDataSourceWidget( );
+%Docstring
+Destructor
+%End
+
+    void setMapCanvas( const QgsMapCanvas *mapCanvas );
+%Docstring
+ Store a pointer to the map canvas to retrieve extent and CRS
+ Used to select an appropriate CRS and possibly to retrieve data only in the current extent
+%End
+
+
+  public slots:
+
+    virtual void refresh( );
+%Docstring
+ Triggered when the provider's connections need to be refreshed
+ The default implementation does nothing
+%End
+
+  signals:
+
+    void connectionsChanged();
+%Docstring
+ Emitted when the provider's connections have changed
+ This signal is normally forwarded the app and used to refresh browser items
+%End
+
+    void addDatabaseLayers( const QStringList &paths, const QString &providerKey );
+%Docstring
+Emitted when a DB layer has been selected for addition
+%End
+
+    void addRasterLayer( const QString &rasterLayerPath, const QString &baseName, const QString &providerKey );
+%Docstring
+Emitted when a raster layer has been selected for addition
+%End
+
+    void addVectorLayer( const QString &uri, const QString &layerName );
+%Docstring
+Emitted when a vector layer has been selected for addition
+%End
+
+    void progress( int, int );
+%Docstring
+Emitted when a progress dialog is shown by the provider dialog
+%End
+
+    void progressMessage( QString message );
+%Docstring
+Emitted when a progress dialog is shown by the provider dialog
+%End
+
+  protected:
+
+    QgsAbstractDataSourceWidget( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::None );
+%Docstring
+Constructor
+%End
+
+    QgsProviderRegistry::WidgetMode widgetMode( ) const;
+%Docstring
+Return the widget mode
+ :rtype: QgsProviderRegistry.WidgetMode
+%End
+
+    const QgsMapCanvas *mapCanvas( ) const;
+%Docstring
+ Return the map canvas (can be null)
+ :rtype: QgsMapCanvas
+%End
+
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsabstractdatasourcewidget.h                                *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/

python/gui/qgsbrowserdockwidget.sip

@@ -105,7 +105,7 @@ Toggle fast scan
 
     void selectionChanged( const QItemSelection &selected, const QItemSelection &deselected );
 %Docstring
-Selection hass changed
+Selection has changed
 %End
     void splitterMoved();
 %Docstring
@@ -120,6 +120,10 @@ Emitted when a file needs to be opened
     void handleDropUriList( const QgsMimeDataUtils::UriList & );
 %Docstring
 Emitted when drop uri list needs to be handled
+%End
+    void connectionsChanged( );
+%Docstring
+Connections changed in the browser
 %End
 
   protected:

python/gui/qgsowssourceselect.sip

@@ -11,16 +11,16 @@
 
 
 
-class QgsOWSSourceSelect : QDialog, protected Ui::QgsOWSSourceSelectBase
+class QgsOWSSourceSelect : QgsAbstractDataSourceWidget, protected Ui::QgsOWSSourceSelectBase
 {
 %Docstring
-  Dialog to create connections and add layers from WMS, WFS, WCS etc.
+  Dialog to create connections and add layers WCS etc.
 
  This dialog allows the user to define and save connection information
  for WMS servers, etc.
 
  The user can then connect and add
- layers from the WMS server to the map canvas.
+ layers from the WCS server to the map canvas.
 %End
 
 %TypeHeaderCode
@@ -42,6 +42,12 @@ Constructor
 
   public slots:
 
+    virtual void refresh( );
+
+%Docstring
+Triggered when the provider's connections need to be refreshed
+%End
+
     void on_mNewButton_clicked();
 %Docstring
 Opens the create connection dialog to build a new connection
@@ -106,12 +112,6 @@ Stores the selected datasource whenerver it is changed
 Add some default wms servers to the list
 %End
 
-  signals:
-    void addRasterLayer( const QString &rasterLayerPath,
-                         const QString &baseName,
-                         const QString &providerKey );
-    void connectionsChanged();
-
   protected:
 
     virtual QList<QgsOWSSourceSelect::SupportedFormat> providerFormats();
@@ -198,8 +198,6 @@ Add a few example servers to the list.
 %End
 
 
-
-
     virtual void populateLayerList();
 %Docstring
  Populate the layer list.
@@ -253,6 +251,7 @@ Returns currently selected cache load control
 
 
 
+
 };
 
 /************************************************************************

src/app/qgisapp.cpp

@@ -248,7 +248,6 @@ Q_GUI_EXPORT extern int qt_defaultDpiX();
 #include "qgsshortcutsmanager.h"
 #include "qgssinglebandgrayrenderer.h"
 #include "qgssnappingwidget.h"
-#include "qgssourceselectdialog.h"
 #include "qgsstatisticalsummarydockwidget.h"
 #include "qgsstatusbar.h"
 #include "qgsstatusbarcoordinateswidget.h"
@@ -889,6 +888,8 @@ QgisApp::QgisApp( QSplashScreen *splash, bool restorePlugins, bool skipVersionCh
   addDockWidget( Qt::LeftDockWidgetArea, mBrowserWidget );
   mBrowserWidget->hide();
   connect( this, &QgisApp::newProject, mBrowserWidget, &QgsBrowserDockWidget::updateProjectHome );
+  connect( this, &QgisApp::connectionsChanged, mBrowserWidget, &QgsBrowserDockWidget::refresh );
+  connect( mBrowserWidget, &QgsBrowserDockWidget::connectionsChanged, this, &QgisApp::connectionsChanged );
   connect( mBrowserWidget, &QgsBrowserDockWidget::openFile, this, &QgisApp::openFile );
   connect( mBrowserWidget, &QgsBrowserDockWidget::handleDropUriList, this, &QgisApp::handleDropUriList );
 
@@ -897,6 +898,8 @@ QgisApp::QgisApp( QSplashScreen *splash, bool restorePlugins, bool skipVersionCh
   addDockWidget( Qt::LeftDockWidgetArea, mBrowserWidget2 );
   mBrowserWidget2->hide();
   connect( this, &QgisApp::newProject, mBrowserWidget2, &QgsBrowserDockWidget::updateProjectHome );
+  connect( mBrowserWidget2, &QgsBrowserDockWidget::connectionsChanged, this, &QgisApp::connectionsChanged );
+  connect( this, &QgisApp::connectionsChanged, mBrowserWidget2, &QgsBrowserDockWidget::refresh );
   connect( mBrowserWidget2, &QgsBrowserDockWidget::openFile, this, &QgisApp::openFile );
   connect( mBrowserWidget2, &QgsBrowserDockWidget::handleDropUriList, this, &QgisApp::handleDropUriList );
 
@@ -1605,8 +1608,10 @@ void QgisApp::dataSourceManager( QString pageName )
 {
   if ( ! mDataSourceManagerDialog )
   {
-    mDataSourceManagerDialog = new QgsDataSourceManagerDialog( mapCanvas( ), this );
+    mDataSourceManagerDialog = new QgsDataSourceManagerDialog( this, mapCanvas( ) );
     // Forward signals to this
+    connect( this, &QgisApp::connectionsChanged, mDataSourceManagerDialog, &QgsDataSourceManagerDialog::refresh );
+    connect( mDataSourceManagerDialog, &QgsDataSourceManagerDialog::connectionsChanged, this, &QgisApp::connectionsChanged );
     connect( mDataSourceManagerDialog, SIGNAL( addRasterLayer( QString const &, QString const &, QString const & ) ),
              this, SLOT( addRasterLayer( QString const &, QString const &, QString const & ) ) );
     connect( mDataSourceManagerDialog, SIGNAL( addVectorLayer( QString const &, QString const &, QString const & ) ),

src/app/qgisapp.h

@@ -1494,6 +1494,12 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
 
   signals:
 
+    /**
+     * Emitted when a connection has been added/removed or changed by the provider
+     * selection dialogs
+     */
+    void connectionsChanged( );
+
     /** Emitted when a key is pressed and we want non widget sublasses to be able
       to pick up on this (e.g. maplayer) */
     void keyPressed( QKeyEvent *e );

src/core/qgsbrowsermodel.cpp

@@ -139,6 +139,8 @@ void QgsBrowserModel::addRootItems()
     QgsDataItem *item = pr->createDataItem( QLatin1String( "" ), nullptr );  // empty path -> top level
     if ( item )
     {
+      // Forward the signal from the root items to the model (and then to the app)
+      connect( item, &QgsDataItem::connectionsChanged, this, &QgsBrowserModel::connectionsChanged );
       QgsDebugMsgLevel( "Add new top level item : " + item->name(), 4 );
       connectItem( item );
       providerMap.insertMulti( capabilities, item );
@@ -411,6 +413,7 @@ void QgsBrowserModel::itemStateChanged( QgsDataItem *item, QgsDataItem::State ol
   QgsDebugMsgLevel( QString( "item %1 state changed %2 -> %3" ).arg( item->path() ).arg( oldState ).arg( item->state() ), 4 );
   emit stateChanged( idx, oldState );
 }
+
 void QgsBrowserModel::connectItem( QgsDataItem *item )
 {
   connect( item, &QgsDataItem::beginInsertItems,
@@ -425,6 +428,11 @@ void QgsBrowserModel::connectItem( QgsDataItem *item )
            this, &QgsBrowserModel::itemDataChanged );
   connect( item, &QgsDataItem::stateChanged,
            this, &QgsBrowserModel::itemStateChanged );
+
+  // if it's a collection item, also forwards connectionsChanged
+  QgsDataCollectionItem *collectionItem = dynamic_cast<QgsDataCollectionItem *>( item );
+  if ( collectionItem )
+    connect( collectionItem, &QgsDataCollectionItem::connectionsChanged, this, &QgsBrowserModel::connectionsChanged );
 }
 
 QStringList QgsBrowserModel::mimeTypes() const

src/core/qgsbrowsermodel.h

@@ -134,6 +134,9 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel
   signals:
     //! Emitted when item children fetch was finished
     void stateChanged( const QModelIndex &index, QgsDataItem::State oldState );
+    //! Connections changed in the browser, forwarded to the widget and used to
+    //! notify the provider dialogs of a changed connection
+    void connectionsChanged( );
 
   public slots:
     //! Reload the whole model

src/core/qgsdataitem.cpp

@@ -342,6 +342,12 @@ void QgsDataItem::refresh()
   }
 }
 
+void QgsDataItem::refreshConnections()
+{
+  refresh( );
+  emit connectionsChanged( );
+}
+
 void QgsDataItem::refresh( const QVector<QgsDataItem *> &children )
 {
   QgsDebugMsgLevel( "mPath = " + mPath, 2 );

src/core/qgsdataitem.h

@@ -283,6 +283,9 @@ class CORE_EXPORT QgsDataItem : public QObject
 
     virtual void refresh();
 
+    //! Refresh connections: update GUI and emit signal
+    virtual void refreshConnections();
+
     virtual void childrenCreated();
 
   signals:
@@ -292,6 +295,11 @@ class CORE_EXPORT QgsDataItem : public QObject
     void endRemoveItems();
     void dataChanged( QgsDataItem *item );
     void stateChanged( QgsDataItem *item, QgsDataItem::State oldState );
+    //! Emitted when the provider's connections of the child items have changed
+    //! This signal is normally forwarded to the app in order to refresh the connection
+    //! item in the provider dialogs and to refresh the connection items in the other
+    //! open browsers
+    void connectionsChanged( );
 
   protected slots: