Merge pull request #8507 from signedav/basicfix

Delete selected tables as DataItem action

Author: m-kuhn

python/core/auto_generated/qgsbrowsermodel.sip.in

@@ -117,6 +117,19 @@ items, i.e. it does not fetch children.
 %End
 
 
+    QModelIndex findUri( const QString &uri, QModelIndex index = QModelIndex() );
+%Docstring
+Returns index of layer item with given uri. It only searches in currently fetched
+items, i.e. it does not fetch children.
+
+:param uri: item uri
+:param index: the current index of the parent (to search for children)
+
+:return: model index, invalid if item not found
+
+.. versionadded:: 3.6
+%End
+
  void connectItem( QgsDataItem *item ) /Deprecated/;
 %Docstring
 

python/core/auto_generated/qgsdataitem.sip.in

@@ -201,6 +201,7 @@ Items that return valid URI will be returned in mime data when dragging a select
       Fast,
       Collapse,
       Rename,
+      Delete,
     };
     typedef QFlags<QgsDataItem::Capability> Capabilities;
 
@@ -485,6 +486,11 @@ Returns the string representation of the given ``layerType``
 Returns the icon name of the given ``layerType``
 
 .. versionadded:: 3
+%End
+
+    virtual bool deleteLayer();
+%Docstring
+Delete this layer item
 %End
 
   protected:

src/app/browser/qgsinbuiltdataitemproviders.cpp

@@ -23,6 +23,7 @@
 #include "qgsnative.h"
 #include "qgisapp.h"
 #include "qgsmessagebar.h"
+#include "qgsmessagelog.h"
 #include "qgsnewnamedialog.h"
 #include "qgsbrowsermodel.h"
 #include "qgsbrowserdockwidget_p.h"
@@ -390,6 +391,25 @@ void QgsLayerItemGuiProvider::populateContextMenu( QgsDataItem *item, QMenu *men
   } );
   menu->addAction( addAction );
 
+  if ( item->capabilities2() & QgsDataItem::Delete )
+  {
+    QStringList selectedDeletableItemPaths;
+    for ( QgsDataItem *selectedItem : selectedItems )
+    {
+      if ( qobject_cast<QgsLayerItem *>( selectedItem ) && ( selectedItem->capabilities2() & QgsDataItem::Delete ) )
+        selectedDeletableItemPaths.append( qobject_cast<QgsLayerItem *>( selectedItem )->uri() );
+    }
+
+    const QString deleteText = selectedDeletableItemPaths.count() == 1 ? tr( "Delete Layer" )
+                               : tr( "Delete Selected Layers" );
+    QAction *deleteAction = new QAction( deleteText, menu );
+    connect( deleteAction, &QAction::triggered, this, [ = ]
+    {
+      deleteLayers( selectedDeletableItemPaths );
+    } );
+    menu->addAction( deleteAction );
+  }
+
   QAction *propertiesAction = new QAction( tr( "Layer Properties…" ), menu );
   connect( propertiesAction, &QAction::triggered, this, [ = ]
   {
@@ -457,6 +477,22 @@ void QgsLayerItemGuiProvider::addLayersFromItems( const QList<QgsDataItem *> &it
     QgisApp::instance()->handleDropUriList( layerUriList );
 }
 
+void QgsLayerItemGuiProvider::deleteLayers( const QStringList &itemPaths )
+{
+  for ( const QString &itemPath : itemPaths )
+  {
+    //get the item from browserModel by its path
+    QgsLayerItem *item = qobject_cast<QgsLayerItem *>( QgisApp::instance()->browserModel()->dataItem( QgisApp::instance()->browserModel()->findUri( itemPath ) ) );
+    if ( !item )
+    {
+      QgsMessageLog::logMessage( tr( "Item with path %1 no longer exists." ).arg( itemPath ) );
+      return;
+    }
+    if ( !item->deleteLayer() )
+      QMessageBox::information( QgisApp::instance(), tr( "Delete Layer" ), tr( "Item Layer %1 cannot be deleted." ).arg( item->name() ) );
+  }
+}
+
 void QgsLayerItemGuiProvider::showPropertiesForItem( QgsLayerItem *item )
 {
   if ( ! item )

src/app/browser/qgsinbuiltdataitemproviders.h

@@ -100,6 +100,7 @@ class QgsLayerItemGuiProvider : public QObject, public QgsDataItemGuiProvider
 
     void addLayersFromItems( const QList<QgsDataItem *> &items );
     void showPropertiesForItem( QgsLayerItem *item );
+    void deleteLayers( const QStringList &itemPath );
 
 };
 

src/core/qgsbrowsermodel.cpp

@@ -371,6 +371,30 @@ QModelIndex QgsBrowserModel::findPath( QAbstractItemModel *model, const QString
   return QModelIndex(); // not found
 }
 
+QModelIndex QgsBrowserModel::findUri( const QString &uri, QModelIndex index )
+{
+  for ( int i = 0; i < this->rowCount( index ); i++ )
+  {
+    QModelIndex idx = this->index( i, 0, index );
+
+    if ( qobject_cast<QgsLayerItem *>( dataItem( idx ) ) )
+    {
+      QString itemUri = qobject_cast<QgsLayerItem *>( dataItem( idx ) )->uri();
+
+      if ( itemUri == uri )
+      {
+        QgsDebugMsgLevel( "Arrived " + itemUri, 4 );
+        return idx; // we have found the item we have been looking for
+      }
+    }
+
+    QModelIndex childIdx = findUri( uri, idx );
+    if ( childIdx.isValid() )
+      return childIdx;
+  }
+  return QModelIndex();
+}
+
 void QgsBrowserModel::connectItem( QgsDataItem * )
 {
   // deprecated, no use

src/core/qgsbrowsermodel.h

@@ -136,6 +136,17 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel
     //! \note not available in Python bindings
     static QModelIndex findPath( QAbstractItemModel *model, const QString &path, Qt::MatchFlag matchFlag = Qt::MatchExactly ) SIP_SKIP;
 
+    /**
+     * Returns index of layer item with given uri. It only searches in currently fetched
+     * items, i.e. it does not fetch children.
+     * \param uri item uri
+     * \param index the current index of the parent (to search for children)
+     * \returns model index, invalid if item not found
+     *
+     * \since QGIS 3.6
+     */
+    QModelIndex findUri( const QString &uri, QModelIndex index = QModelIndex() );
+
     /**
      * \deprecated Deprecated since QGIS 3.4 -- this method has no effect, and is dangerous to call in earlier QGIS versions. Any usage should be removed (and will have no harmful side-effects!).
      */

src/core/qgsdataitem.cpp

@@ -701,6 +701,11 @@ QString QgsLayerItem::iconName( QgsLayerItem::LayerType layerType )
   }
 }
 
+bool QgsLayerItem::deleteLayer()
+{
+  return false;
+}
+
 bool QgsLayerItem::equal( const QgsDataItem *other )
 {
   //QgsDebugMsg ( mPath + " x " + other->mPath );

src/core/qgsdataitem.h

@@ -210,8 +210,9 @@ class CORE_EXPORT QgsDataItem : public QObject
       SetCrs            = 1 << 0, //!< Can set CRS on layer or group of layers
       Fertile           = 1 << 1, //!< Can create children. Even items without this capability may have children, but cannot create them, it means that children are created by item ancestors.
       Fast              = 1 << 2, //!< CreateChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres...) are considered fast because they are reading data only from QgsSettings
-      Collapse          = 1 << 3,  //!< The collapse/expand status for this items children should be ignored in order to avoid undesired network connections (wms etc.)
+      Collapse          = 1 << 3, //!< The collapse/expand status for this items children should be ignored in order to avoid undesired network connections (wms etc.)
       Rename            = 1 << 4, //!< Item can be renamed
+      Delete            = 1 << 5, //!< Item can be deleted
     };
     Q_DECLARE_FLAGS( Capabilities, Capability )
 
@@ -505,6 +506,9 @@ class CORE_EXPORT QgsLayerItem : public QgsDataItem
      */
     static QString iconName( LayerType layerType );
 
+    //! Delete this layer item
+    virtual bool deleteLayer();
+
   protected:
 
     //! The provider key

src/providers/mssql/qgsmssqldataitems.cpp

@@ -561,64 +561,68 @@ QgsMssqlLayerItem::QgsMssqlLayerItem( QgsDataItem *parent, const QString &name,
   : QgsLayerItem( parent, name, path, QString(), layerType, QStringLiteral( "mssql" ) )
   , mLayerProperty( layerProperty )
 {
+  mCapabilities |= Delete;
   mUri = createUri();
   setState( Populated );
 }
 
 #ifdef HAVE_GUI
 QList<QAction *> QgsMssqlLayerItem::actions( QWidget *actionParent )
 {
-  QgsMssqlConnectionItem *connItem = qobject_cast<QgsMssqlConnectionItem *>( parent() ? parent()->parent() : nullptr );
-
   QList<QAction *> lst;
 
-  // delete
-  QAction *actionDeleteLayer = new QAction( tr( "Delete Table" ), actionParent );
-  connect( actionDeleteLayer, &QAction::triggered, this, [ = ]
-  {
-    if ( QMessageBox::question( nullptr, QObject::tr( "Delete Table" ),
-                                QObject::tr( "Are you sure you want to delete [%1].[%2]?" ).arg( mLayerProperty.schemaName, mLayerProperty.tableName ),
-                                QMessageBox::Yes | QMessageBox::No, QMessageBox::No ) != QMessageBox::Yes )
-      return;
-
-    QString errCause;
-    bool res = QgsMssqlConnection::dropTable( mUri, &errCause );
-    if ( !res )
-    {
-      QMessageBox::warning( nullptr, tr( "Delete Table" ), errCause );
-    }
-    else
-    {
-      QMessageBox::information( nullptr, tr( "Delete Table" ), tr( "Table deleted successfully." ) );
-      if ( connItem )
-        connItem->refresh();
-    }
-  } );
-  lst.append( actionDeleteLayer );
-
   // truncate
   QAction *actionTruncateLayer = new QAction( tr( "Truncate Table" ), actionParent );
   connect( actionTruncateLayer, &QAction::triggered, this, [ = ]
   {
-    if ( QMessageBox::question( nullptr, QObject::tr( "Truncate Table" ),
-                                QObject::tr( "Are you sure you want to truncate [%1].[%2]?\n\nThis will delete all data within the table." ).arg( mLayerProperty.schemaName, mLayerProperty.tableName ),
-                                QMessageBox::Yes | QMessageBox::No, QMessageBox::No ) != QMessageBox::Yes )
-      return;
-
-    QString errCause;
-    bool res = QgsMssqlConnection::truncateTable( mUri, &errCause );
-    if ( !res )
-    {
-      QMessageBox::warning( nullptr, tr( "Truncate Table" ), errCause );
-    }
-    else
-    {
-      QMessageBox::information( nullptr, tr( "Truncate Table" ), tr( "Table truncated successfully." ) );
-    }
+    truncateTable();
   } );
   lst.append( actionTruncateLayer );
   return lst;
 }
+
+bool QgsMssqlLayerItem::deleteLayer()
+{
+  QgsMssqlConnectionItem *connItem = qobject_cast<QgsMssqlConnectionItem *>( parent() ? parent()->parent() : nullptr );
+
+  if ( QMessageBox::question( nullptr, QObject::tr( "Delete Table" ),
+                              QObject::tr( "Are you sure you want to delete [%1].[%2]?" ).arg( mLayerProperty.schemaName, mLayerProperty.tableName ),
+                              QMessageBox::Yes | QMessageBox::No, QMessageBox::No ) != QMessageBox::Yes )
+    return true;
+
+  QString errCause;
+  bool res = QgsMssqlConnection::dropTable( mUri, &errCause );
+  if ( !res )
+  {
+    QMessageBox::warning( nullptr, tr( "Delete Table" ), errCause );
+  }
+  else
+  {
+    QMessageBox::information( nullptr, tr( "Delete Table" ), tr( "Table deleted successfully." ) );
+    if ( connItem )
+      connItem->refresh();
+  }
+  return true;
+}
+
+void QgsMssqlLayerItem::truncateTable()
+{
+  if ( QMessageBox::question( nullptr, QObject::tr( "Truncate Table" ),
+                              QObject::tr( "Are you sure you want to truncate [%1].[%2]?\n\nThis will delete all data within the table." ).arg( mLayerProperty.schemaName, mLayerProperty.tableName ),
+                              QMessageBox::Yes | QMessageBox::No, QMessageBox::No ) != QMessageBox::Yes )
+    return;
+
+  QString errCause;
+  bool res = QgsMssqlConnection::truncateTable( mUri, &errCause );
+  if ( !res )
+  {
+    QMessageBox::warning( nullptr, tr( "Truncate Table" ), errCause );
+  }
+  else
+  {
+    QMessageBox::information( nullptr, tr( "Truncate Table" ), tr( "Table truncated successfully." ) );
+  }
+}
 #endif
 
 QgsMssqlLayerItem *QgsMssqlLayerItem::createClone()

src/providers/mssql/qgsmssqldataitems.h

@@ -140,6 +140,12 @@ class QgsMssqlLayerItem : public QgsLayerItem
 
     bool disableInvalidGeometryHandling() const;
 
+  public slots:
+#ifdef HAVE_GUI
+    bool deleteLayer() override;
+    void truncateTable();
+#endif
+
   private:
     QgsMssqlLayerProperty mLayerProperty;
     bool mDisableInvalidGeometryHandling = false;