qgsbrowsertreeview.cpp

Go to the documentation of this file.

/***************************************************************************
  qgsbrowsertreeview.cpp
  --------------------------------------
  Date                 : January 2015
  Copyright            : (C) 2015 by Radim Blazek
  Email                : radim.blazek@gmail.com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgssettings.h"
#include "qgsbrowserguimodel.h"
#include "qgsbrowsertreeview.h"
#include "moc_qgsbrowsertreeview.cpp"
#include "qgslogger.h"
#include "qgsguiutils.h"
#include "qgsdataitem.h"
#include "qgsdirectoryitem.h"
#include "qgsfileutils.h"
#include "qgsfavoritesitem.h"
 
#include <QKeyEvent>
#include <QSortFilterProxyModel>
#include <QDir>
#include <QFileInfo>
#include <QRegularExpression>
 
QgsBrowserTreeView::QgsBrowserTreeView( QWidget *parent )
  : QTreeView( parent )
  , mSettingsSection( QStringLiteral( "browser" ) )
{
  setEditTriggers( QAbstractItemView::EditKeyPressed );
  setIndentation( QgsGuiUtils::scaleIconSize( 16 ) );
}
 
void QgsBrowserTreeView::keyPressEvent( QKeyEvent *event )
{
  if ( event->key() == Qt::Key_Return || event->key() == Qt::Key_Enter )
    emit doubleClicked( currentIndex() );
  else
    QTreeView::keyPressEvent( event );
}
 
void QgsBrowserTreeView::setModel( QAbstractItemModel *model )
{
 
  QTreeView::setModel( model );
 
  restoreState();
}
 
void QgsBrowserTreeView::setBrowserModel( QgsBrowserGuiModel *model )
{
  mBrowserModel = model;
}
 
void QgsBrowserTreeView::showEvent( QShowEvent *e )
{
  Q_UNUSED( e )
  if ( model() )
    restoreState();
  QTreeView::showEvent( e );
}
 
// closeEvent is not called when application is closed
void QgsBrowserTreeView::hideEvent( QHideEvent *e )
{
  Q_UNUSED( e )
  // hideEvent() may be called (Mac) before showEvent
  if ( model() )
    saveState();
  QTreeView::hideEvent( e );
}
 
void QgsBrowserTreeView::saveState()
{
  QgsSettings settings;
  const QStringList expandedPaths = expandedPathsList( QModelIndex() );
  settings.setValue( expandedPathsKey(), expandedPaths );
  QgsDebugMsgLevel( "expandedPaths = " + expandedPaths.join( ' ' ), 4 );
}
 
void QgsBrowserTreeView::restoreState()
{
  const QgsSettings settings;
  mExpandPaths = settings.value( expandedPathsKey(), QVariant() ).toStringList();
 
  QgsDebugMsgLevel( "mExpandPaths = " + mExpandPaths.join( ' ' ), 4 );
  if ( !mExpandPaths.isEmpty() )
  {
    QSet<QModelIndex> expandIndexSet;
    const auto constMExpandPaths = mExpandPaths;
    for ( const QString &path : constMExpandPaths )
    {
      const QModelIndex expandIndex = QgsBrowserGuiModel::findPath( model(), path, Qt::MatchStartsWith );
      if ( expandIndex.isValid() )
      {
        const QModelIndex modelIndex = browserModel()->findPath( path, Qt::MatchExactly );
        if ( modelIndex.isValid() )
        {
          QgsDataItem *ptr = browserModel()->dataItem( modelIndex );
          if ( ptr && ( ptr->capabilities2() & Qgis::BrowserItemCapability::Collapse ) )
          {
            QgsDebugMsgLevel( "do not expand index for path " + path, 4 );
            const QModelIndex parentIndex = model()->parent( expandIndex );
            // Still we need to store the parent in order to expand it
            if ( parentIndex.isValid() )
              expandIndexSet.insert( parentIndex );
          }
          else
          {
            expandIndexSet.insert( expandIndex );
          }
        }
      }
      else
      {
        QgsDebugMsgLevel( "index for path " + path + " not found", 4 );
      }
    }
    const auto constExpandIndexSet = expandIndexSet;
    for ( const QModelIndex &expandIndex : constExpandIndexSet )
    {
      expandTree( expandIndex );
    }
  }
 
  // expand root favorites item
  const QModelIndex index = QgsBrowserGuiModel::findPath( model(), QStringLiteral( "favorites:" ) );
  expand( index );
}
 
void QgsBrowserTreeView::expandTree( const QModelIndex &index )
{
  if ( !model() )
    return;
 
  QgsDebugMsgLevel( "itemPath = " + model()->data( index, static_cast< int >( QgsBrowserModel::CustomRole::Path ) ).toString(), 4 );
 
  expand( index );
  const QModelIndex parentIndex = model()->parent( index );
  if ( parentIndex.isValid() )
    expandTree( parentIndex );
}
 
bool QgsBrowserTreeView::treeExpanded( const QModelIndex &index )
{
  if ( !model() )
    return false;
  if ( !isExpanded( index ) )
    return false;
  const QModelIndex parentIndex = model()->parent( index );
  if ( parentIndex.isValid() )
    return treeExpanded( parentIndex );
 
  return true; // root
}
 
bool QgsBrowserTreeView::hasExpandedDescendant( const QModelIndex &index ) const
{
  if ( !model() || !index.isValid() )
    return false;
 
  for ( int i = 0; i < model()->rowCount( index ); i++ )
  {
    const QModelIndex childIndex = model()->index( i, 0, index );
    if ( isExpanded( childIndex ) )
      return true;
 
    if ( hasExpandedDescendant( childIndex ) )
      return true;
  }
  return false;
}
 
void QgsBrowserTreeView::expandPath( const QString &str, bool selectPath )
{
  const QStringList pathParts = QgsFileUtils::splitPathToComponents( str );
  if ( pathParts.isEmpty() )
    return;
 
  // first we build a list of all directory item candidates we could use to start the expansion from
  QVector< QgsDirectoryItem * > initialDirectoryItemCandidates;
  const QVector< QgsDataItem * > rootItems = mBrowserModel->rootItems();
  for ( QgsDataItem *item : rootItems )
  {
    if ( QgsDirectoryItem *dirItem = qobject_cast< QgsDirectoryItem * >( item ) )
    {
      initialDirectoryItemCandidates << dirItem;
    }
    else if ( QgsFavoritesItem *favoritesItem = qobject_cast< QgsFavoritesItem * >( item ) )
    {
      const QVector<QgsDataItem * > favoriteChildren = favoritesItem->children();
      for ( QgsDataItem *favoriteChild : favoriteChildren )
      {
        if ( QgsDirectoryItem *dirItem = qobject_cast< QgsDirectoryItem * >( favoriteChild ) )
        {
          initialDirectoryItemCandidates << dirItem;
        }
      }
    }
  }
 
  QgsDirectoryItem *currentDirectoryItem = nullptr;
  QString currentCandidatePath;
  for ( const QString &thisPart : pathParts )
  {
    currentCandidatePath += ( currentCandidatePath.isEmpty() || currentCandidatePath.endsWith( '/' ) ? QString() : QStringLiteral( "/" ) ) + thisPart;
 
    auto it = initialDirectoryItemCandidates.begin();
    while ( it != initialDirectoryItemCandidates.end() )
    {
      if ( !( *it )->dirPath().startsWith( currentCandidatePath ) )
      {
        it = initialDirectoryItemCandidates.erase( it );
      }
      else
      {
        if ( str.startsWith( ( *it )->dirPath() ) )
          currentDirectoryItem = *it;
        it++;
      }
    }
  }
 
  if ( !currentDirectoryItem )
    return; // should we create a new root drive item automatically??
 
  QStringList remainingParts = pathParts;
  auto it = remainingParts.begin();
  QDir currentDir = *it;
  while ( it != remainingParts.end() )
  {
    if ( currentDirectoryItem->dirPath().startsWith( currentDir.filePath( *it ) ) )
    {
      currentDir = QDir( currentDir.filePath( *it ) );
      it = remainingParts.erase( it );
    }
    else
    {
      break;
    }
  }
 
  currentDir = QDir( currentDirectoryItem->dirPath() );
  QList< QgsDirectoryItem * > pathItems;
 
  pathItems << currentDirectoryItem;
 
  for ( const QString &currentFolderName : std::as_const( remainingParts ) )
  {
    const QString thisPath = currentDir.filePath( currentFolderName );
 
    if ( !QFile::exists( thisPath ) )
      break;
 
    // check if current directory item already has a child for the folder
    QgsDirectoryItem *existingChild = nullptr;
    const QVector< QgsDataItem * > children = currentDirectoryItem->children();
    for ( QgsDataItem *child : children )
    {
      if ( QgsDirectoryItem *childDirectoryItem = qobject_cast< QgsDirectoryItem *>( child ) )
      {
        if ( childDirectoryItem->dirPath() == thisPath )
        {
          existingChild = childDirectoryItem;
          break;
        }
      }
    }
 
    if ( existingChild )
    {
      pathItems << existingChild;
      currentDirectoryItem  = existingChild;
    }
    else
    {
      QgsDirectoryItem *newDir = new QgsDirectoryItem( nullptr, currentFolderName, thisPath );
      pathItems << newDir;
      currentDirectoryItem ->addChildItem( newDir, true );
      currentDirectoryItem  = newDir;
    }
 
    currentDir = QDir( thisPath );
  }
 
  QgsDirectoryItem *lastItem = nullptr;
  for ( QgsDirectoryItem *i : std::as_const( pathItems ) )
  {
    QModelIndex index = mBrowserModel->findItem( i );
    if ( QSortFilterProxyModel *proxyModel = qobject_cast< QSortFilterProxyModel *>( model() ) )
    {
      index = proxyModel->mapFromSource( index );
    }
    expand( index );
    lastItem = i;
  }
 
  if ( selectPath && lastItem )
    setSelectedItem( lastItem );
}
 
bool QgsBrowserTreeView::setSelectedItem( QgsDataItem *item )
{
  if ( !mBrowserModel )
    return false;
 
  QModelIndex index = mBrowserModel->findItem( item );
  if ( !index.isValid() )
    return false;
 
  if ( QSortFilterProxyModel *proxyModel = qobject_cast< QSortFilterProxyModel *>( model() ) )
  {
    index = proxyModel->mapFromSource( index );
  }
 
  setCurrentIndex( index );
  return true;
}
 
// rowsInserted signal is used to continue in state restoring
void QgsBrowserTreeView::rowsInserted( const QModelIndex &parentIndex, int start, int end )
{
  QTreeView::rowsInserted( parentIndex, start, end );
 
  if ( !model() )
    return;
 
  if ( mExpandPaths.isEmpty() )
    return;
 
  QgsDebugMsgLevel( "mExpandPaths = " + mExpandPaths.join( ',' ), 2 );
 
  const QString parentPath = model()->data( parentIndex, static_cast< int >( QgsBrowserModel::CustomRole::Path ) ).toString();
  QgsDebugMsgLevel( "parentPath = " + parentPath, 2 );
 
  // remove parentPath from paths to be expanded
  mExpandPaths.removeOne( parentPath );
 
  // Remove the subtree from mExpandPaths if user collapsed the item in the meantime
  if ( !treeExpanded( parentIndex ) )
  {
    const auto constMExpandPaths = mExpandPaths;
    for ( const QString &path : constMExpandPaths )
    {
      if ( path.startsWith( parentPath + '/' ) )
        mExpandPaths.removeOne( path );
    }
    return;
  }
 
  for ( int i = start; i <= end; i++ )
  {
    const QModelIndex childIndex = model()->index( i, 0, parentIndex );
    const QString childPath = model()->data( childIndex, static_cast< int >( QgsBrowserModel::CustomRole::Path ) ).toString();
    const QString escapedChildPath = QRegularExpression::escape( childPath );
 
    QgsDebugMsgLevel( "childPath = " + childPath + " escapedChildPath = " + escapedChildPath, 2 );
    if ( mExpandPaths.contains( childPath ) || mExpandPaths.indexOf( QRegularExpression( "^" + escapedChildPath + "/.*" ) ) != -1 )
    {
      QgsDebugMsgLevel( QStringLiteral( "-> expand" ), 2 );
      const QModelIndex modelIndex = browserModel()->findPath( childPath, Qt::MatchExactly );
      if ( modelIndex.isValid() )
      {
        QgsDataItem *ptr = browserModel()->dataItem( modelIndex );
        if ( !ptr || !( ptr->capabilities2() & Qgis::BrowserItemCapability::Collapse ) )
        {
          expand( childIndex );
        }
      }
    }
  }
}
 
QString QgsBrowserTreeView::expandedPathsKey() const
{
  return '/' + mSettingsSection + "/expandedPaths";
}
 
QStringList QgsBrowserTreeView::expandedPathsList( const QModelIndex &index )
{
  QStringList paths;
 
  if ( !model() )
    return paths;
 
  for ( int i = 0; i < model()->rowCount( index ); i++ )
  {
    const QModelIndex childIndex = model()->index( i, 0, index );
    if ( isExpanded( childIndex ) )
    {
      const QStringList childrenPaths = expandedPathsList( childIndex );
      if ( !childrenPaths.isEmpty() )
      {
        paths.append( childrenPaths );
      }
      else
      {
        paths.append( model()->data( childIndex, static_cast< int >( QgsBrowserModel::CustomRole::Path ) ).toString() );
      }
    }
  }
  return paths;
}