entitycollectionorderproxymodel.cpp

Go to the documentation of this file.

/* -*- mode: C++; c-file-style: "gnu" -*-

  Copyright (c) 2010 Montel Laurent <montel@kde.org>

  This program is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License, version 2, as
  published by the Free Software Foundation.

  This program 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
  General Public License for more details.

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

#include "entitycollectionorderproxymodel.h"
#include "kernel/mailkernel.h"
#include "util/mailutil.h"

#include <Akonadi/Collection>
#include <Akonadi/EntityTreeModel>
#include <Akonadi/KMime/SpecialMailCollections>
#include <Akonadi/AgentManager>

namespace MailCommon {

class EntityCollectionOrderProxyModel::EntityCollectionOrderProxyModelPrivate
{
public:
    EntityCollectionOrderProxyModelPrivate()
        : manualSortingActive( false )
    {
    }

    int collectionRank( const Akonadi::Collection &collection )
    {
        const Akonadi::Collection::Id id = collection.id();
        if ( collectionRanks.contains( id ) ) {
            return collectionRanks[id];
        }

        int rank = 100;
        if ( Kernel::folderIsInbox( collection, true ) ) {
            rank = 1;
        } else if ( Kernel::self()->folderIsDraftOrOutbox( collection ) ) {
            if ( Kernel::self()->folderIsDrafts( collection ) ) {
                rank = 5;
            } else {
                rank = 2;
            }
        } else if ( Kernel::self()->folderIsSentMailFolder( collection ) ) {
            rank = 3;
        } else if ( Kernel::self()->folderIsTrash( collection ) ) {
            rank = 4;
        } else if ( Kernel::self()->folderIsTemplates( collection ) ) {
            rank = 6;
        } else if ( MailCommon::Util::isVirtualCollection( collection ) ) {
            rank = 200;
        } else if ( !topLevelOrder.isEmpty() ) {
            if ( collection.parentCollection() == Akonadi::Collection::root()) {
                const QString resource = collection.resource();
                if (resource.isEmpty()) {
                    qDebug()<<" collection has not resource: "<<collection;
                    //Don't save in collectionranks because we don't have resource name => pb.
                    return rank;
                }
                const int order = topLevelOrder.indexOf(resource);
                if ( order != -1 ) {
                    rank = order;
                }
            }
        }
        collectionRanks.insert( id, rank );
        return rank;
    }

    bool manualSortingActive;
    QMap<Akonadi::Collection::Id, int> collectionRanks;
    QStringList topLevelOrder;
};

EntityCollectionOrderProxyModel::EntityCollectionOrderProxyModel( QObject *parent )
    : EntityOrderProxyModel( parent ), d( new EntityCollectionOrderProxyModelPrivate() )
{
    setSortCaseSensitivity( Qt::CaseInsensitive );
    connect( Akonadi::SpecialMailCollections::self(), SIGNAL(defaultCollectionsChanged()),
             this, SLOT(slotSpecialCollectionsChanged()) );
    connect( Akonadi::SpecialMailCollections::self(), SIGNAL(collectionsChanged(Akonadi::AgentInstance)),
             this, SLOT(slotSpecialCollectionsChanged()) );
}

EntityCollectionOrderProxyModel::~EntityCollectionOrderProxyModel()
{
    if ( d->manualSortingActive ) {
        saveOrder();
    }
    delete d;
}

void EntityCollectionOrderProxyModel::slotSpecialCollectionsChanged()
{
    if ( !d->manualSortingActive ) {
        d->collectionRanks.clear();
        invalidate();
    }
}

void EntityCollectionOrderProxyModel::setTopLevelOrder(const QStringList& list)
{
    d->topLevelOrder = list;
    clearRanks();
}

void EntityCollectionOrderProxyModel::clearRanks()
{
    d->collectionRanks.clear();
    invalidate();
}

bool EntityCollectionOrderProxyModel::lessThan( const QModelIndex &left,
                                                const QModelIndex &right ) const
{
    if ( !d->manualSortingActive ) {

        Akonadi::Collection leftData =
                left.data( Akonadi::EntityTreeModel::CollectionRole ).value<Akonadi::Collection>();
        Akonadi::Collection rightData =
                right.data( Akonadi::EntityTreeModel::CollectionRole ).value<Akonadi::Collection>();

        const int rankLeft = d->collectionRank( leftData );
        const int rankRight = d->collectionRank( rightData );

        if ( rankLeft < rankRight ) {
            return true;
        } else if ( rankLeft > rankRight ) {
            return false;
        }

        return QSortFilterProxyModel::lessThan( left, right );
    }
    return EntityOrderProxyModel::lessThan( left, right );
}

void EntityCollectionOrderProxyModel::setManualSortingActive( bool active )
{
    if ( d->manualSortingActive == active ) {
        return;
    }

    d->manualSortingActive = active;
    d->collectionRanks.clear();
    invalidate();
}

bool EntityCollectionOrderProxyModel::isManualSortingActive() const
{
    return d->manualSortingActive;
}

}