collectionfilterproxymodel.cpp

/*
    Copyright (c) 2007 Bruno Virlet <bruno.virlet@gmail.com>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#include "collectionfilterproxymodel.h"

#include "collectionmodel.h"
#include "mimetypechecker.h"

#include <kdebug.h>

#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QTimer>

using namespace Akonadi;

class CollectionFilterProxyModel::Private
{
  public:
    Private( CollectionFilterProxyModel *parent )
      : mParent( parent ), mExcludeVirtualCollections( false )
    {
      mimeChecker.addWantedMimeType( QLatin1String( "text/uri-list" ) );
    }

    bool collectionAccepted( const QModelIndex &index, bool checkResourceVisibility = true );

    QVector< QModelIndex > acceptedResources;
    CollectionFilterProxyModel *mParent;
    MimeTypeChecker mimeChecker;
    bool mExcludeVirtualCollections;
};

bool CollectionFilterProxyModel::Private::collectionAccepted( const QModelIndex &index, bool checkResourceVisibility )
{
  // Retrieve supported mimetypes
  const Collection collection = mParent->sourceModel()->data( index, CollectionModel::CollectionRole ).value<Collection>();

  if ( !collection.isValid() ) {
    return false;
  }

  if ( collection.isVirtual() && mExcludeVirtualCollections ) {
    return false;
  }

  // If this collection directly contains one valid mimetype, it is accepted
  if ( mimeChecker.isWantedCollection( collection ) ) {
    // The folder will be accepted, but we need to make sure the resource is visible too.
    if ( checkResourceVisibility ) {

      // find the resource
      QModelIndex resource = index;
      while ( resource.parent().isValid() ) {
        resource = resource.parent();
      }

      // See if that resource is visible, if not, invalidate the filter.
      if ( resource != index && !acceptedResources.contains( resource ) ) {
        kDebug() << "We got a new collection:" << mParent->sourceModel()->data( index ).toString()
                 << "but the resource is not visible:" << mParent->sourceModel()->data( resource ).toString();
        acceptedResources.clear();
        // defer reset, the model might still be supplying new items at this point which crashs
        mParent->invalidateFilter();
        return true;
      }
    }

    // Keep track of all the resources that are visible.
    if ( !index.parent().isValid() ) {
      acceptedResources.append( index );
    }

    return true;
  }

  // If this collection has a child which contains valid mimetypes, it is accepted
  QModelIndex childIndex = index.child( 0, 0 );
  while ( childIndex.isValid() ) {
    if ( collectionAccepted( childIndex, false /* don't check visibility of the parent, as we are checking the child now */ ) ) {

      // Keep track of all the resources that are visible.
      if ( !index.parent().isValid() ) {
        acceptedResources.append( index );
      }

      return true;
    }
    childIndex = childIndex.sibling( childIndex.row() + 1, 0 );
  }

  // Or else, no reason to keep this collection.
  return false;
}

CollectionFilterProxyModel::CollectionFilterProxyModel( QObject *parent )
  : QSortFilterProxyModel( parent ),
    d( new Private( this ) )
{
}

CollectionFilterProxyModel::~CollectionFilterProxyModel()
{
  delete d;
}

void CollectionFilterProxyModel::addMimeTypeFilters(const QStringList &typeList)
{
  QStringList mimeTypes = d->mimeChecker.wantedMimeTypes() + typeList;
  d->mimeChecker.setWantedMimeTypes( mimeTypes );
  invalidateFilter();
}

void CollectionFilterProxyModel::addMimeTypeFilter(const QString &type)
{
  d->mimeChecker.addWantedMimeType( type );
  invalidateFilter();
}

bool CollectionFilterProxyModel::filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent) const
{
  return d->collectionAccepted( sourceModel()->index( sourceRow, 0, sourceParent ) );
}

QStringList CollectionFilterProxyModel::mimeTypeFilters() const
{
  return d->mimeChecker.wantedMimeTypes();
}

void CollectionFilterProxyModel::clearFilters()
{
  d->mimeChecker = MimeTypeChecker();
  invalidateFilter();
}

void CollectionFilterProxyModel::setExcludeVirtualCollections( bool exclude )
{
  if ( exclude != d->mExcludeVirtualCollections ) {
    d->mExcludeVirtualCollections = exclude;
    invalidateFilter();
  }
}

bool CollectionFilterProxyModel::excludeVirtualCollections() const
{
    return d->mExcludeVirtualCollections;
}

Qt::ItemFlags CollectionFilterProxyModel::flags( const QModelIndex& index ) const
{
  if ( !index.isValid() ) {
    // Don't crash
    return 0;
  }

  const Collection collection = sourceModel()->data( mapToSource( index ), CollectionModel::CollectionRole ).value<Collection>();

  // If this collection directly contains one valid mimetype, it is accepted
  if ( d->mimeChecker.isWantedCollection( collection ) ) {
    return QSortFilterProxyModel::flags( index );
  } else {
    return QSortFilterProxyModel::flags( index ) & ~( Qt::ItemIsSelectable );
  }
}