kde-playground/kdepim/mailcommon/folder/foldertreewidget.cpp

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

  Copyright (c) 2009, 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 "foldertreewidget.h"
#include "entitycollectionorderproxymodel.h"
#include "foldertreeview.h"
#include "foldertreewidgetproxymodel.h"
#include "kernel/mailkernel.h"
#include "util/mailutil.h"

#include "pimcommon/acl/imapaclattribute.h"
#include "pimcommon/util/pimutil.h"

#include <akonadi_next/quotacolorproxymodel.h>

#include <libkdepim/misc/statisticsproxymodel.h>

#include <messageviewer/settings/globalsettings.h>

#include <messagecore/settings/globalsettings.h>

#include <Akonadi/AttributeFactory>
#include <Akonadi/ChangeRecorder>
#include <Akonadi/Collection>
#include <Akonadi/EntityMimeTypeFilterModel>
#include <Akonadi/EntityTreeModel>
#include <Akonadi/EntityTreeView>
#include <Akonadi/ETMViewStateSaver>
#include <Akonadi/ItemFetchScope>

#include <KLineEdit>
#include <KLocalizedString>

#include <QKeyEvent>
#include <QLabel>

namespace MailCommon {

class FolderTreeWidget::FolderTreeWidgetPrivate
{
public:
    FolderTreeWidgetPrivate()
        : filterModel( 0 ),
          folderTreeView( 0 ),
          quotaModel( 0 ),
          readableproxy( 0 ),
          entityOrderProxy( 0 ),
          filterFolderLineEdit( 0 ),
          saver( 0 ),
          label( 0 ),
          dontKeyFilter( false )
    {
    }

    QString filter;
    QString oldFilterStr;
    KPIM::StatisticsProxyModel *filterModel;
    FolderTreeView *folderTreeView;
    Akonadi::QuotaColorProxyModel *quotaModel;
    FolderTreeWidgetProxyModel *readableproxy;
    EntityCollectionOrderProxyModel *entityOrderProxy;
    KLineEdit *filterFolderLineEdit;
    QPointer<Akonadi::ETMViewStateSaver> saver;
    QStringList expandedItems;
    QString currentItem;
    QLabel *label;
    bool dontKeyFilter;
};

FolderTreeWidget::FolderTreeWidget(
        QWidget *parent, KXMLGUIClient *xmlGuiClient,
        FolderTreeWidget::TreeViewOptions options,
        FolderTreeWidgetProxyModel::FolderTreeWidgetProxyModelOptions optReadableProxy )
    : QWidget( parent ), d( new FolderTreeWidgetPrivate() )
{
    Akonadi::AttributeFactory::registerAttribute<PimCommon::ImapAclAttribute>();

    d->folderTreeView = new FolderTreeView( xmlGuiClient, this, options & ShowUnreadCount );
    d->folderTreeView->showStatisticAnimation( options & ShowCollectionStatisticAnimation );

    connect( d->folderTreeView, SIGNAL(manualSortingChanged(bool)),
             this, SLOT(slotManualSortingChanged(bool)) );

    QVBoxLayout *lay = new QVBoxLayout( this );
    lay->setMargin( 0 );

    d->label = new QLabel( i18n( "You can start typing to filter the list of folders." ), this );
    lay->addWidget( d->label );

    d->filterFolderLineEdit = new KLineEdit( this );
    d->filterFolderLineEdit->setClearButtonShown( true );
    d->filterFolderLineEdit->setClickMessage(
                i18nc( "@info/plain Displayed grayed-out inside the textbox, verb to search",
                       "Search" ) );
    lay->addWidget( d->filterFolderLineEdit );

    // ... with statistics...
    d->quotaModel = new Akonadi::QuotaColorProxyModel( this );
    d->quotaModel->setSourceModel( KernelIf->collectionModel() );

    d->filterModel = new KPIM::StatisticsProxyModel( this );
    d->filterModel->setSourceModel( d->quotaModel );

    d->readableproxy = new FolderTreeWidgetProxyModel( this, optReadableProxy );
    d->readableproxy->setSourceModel( d->filterModel );
    d->readableproxy->addContentMimeTypeInclusionFilter( KMime::Message::mimeType() );

    connect( d->folderTreeView, SIGNAL(changeTooltipsPolicy(FolderTreeWidget::ToolTipDisplayPolicy)),
             this, SLOT(slotChangeTooltipsPolicy(FolderTreeWidget::ToolTipDisplayPolicy)) );

    d->folderTreeView->setSelectionMode( QAbstractItemView::SingleSelection );
    d->folderTreeView->setEditTriggers( QAbstractItemView::NoEditTriggers );
    d->folderTreeView->installEventFilter( this );

    //Order proxy
    d->entityOrderProxy = new EntityCollectionOrderProxyModel( this );
    d->entityOrderProxy->setSourceModel( d->readableproxy );
    KConfigGroup grp( KernelIf->config(), "CollectionTreeOrder" );
    d->entityOrderProxy->setOrderConfig( grp );
    d->folderTreeView->setModel( d->entityOrderProxy );

    if ( options & UseDistinctSelectionModel ) {
        d->folderTreeView->setSelectionModel( new QItemSelectionModel( d->entityOrderProxy, this ) );
    }

    lay->addWidget( d->folderTreeView );

    d->dontKeyFilter = ( options & DontKeyFilter );

    if ( ( options & UseLineEditForFiltering ) ) {
        connect( d->filterFolderLineEdit, SIGNAL(textChanged(QString)),
                 this, SLOT(slotFilterFixedString(QString)) );
        d->label->hide();
    } else {
        d->filterFolderLineEdit->hide();
    }

    connect( KGlobalSettings::self(), SIGNAL(kdisplayFontChanged()),
             this, SLOT(slotGeneralFontChanged()));
    connect( KGlobalSettings::self(), SIGNAL(kdisplayPaletteChanged()),
             this, SLOT(slotGeneralPaletteChanged()));
}

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

void FolderTreeWidget::slotFilterFixedString( const QString &text )
{
    delete d->saver;
    if ( d->oldFilterStr.isEmpty() ) {
        //Save it.
        Akonadi::ETMViewStateSaver saver;
        saver.setView( folderTreeView() );
        d->expandedItems = saver.expansionKeys();
        d->currentItem = saver.currentIndexKey();
    } else if ( text.isEmpty() ) {
        d->saver = new Akonadi::ETMViewStateSaver;
        d->saver->setView( folderTreeView() );
        QString currentIndex = d->saver->currentIndexKey();
        if ( d->saver->selectionKeys().isEmpty() ) {
            currentIndex = d->currentItem;
        } else if ( !currentIndex.isEmpty() ) {
            d->expandedItems << currentIndex;
        }
        d->saver->restoreExpanded( d->expandedItems );
        d->saver->restoreCurrentItem( currentIndex );
    } else {
        d->folderTreeView->expandAll();
    }
    d->oldFilterStr = text;
    d->readableproxy->setFilterFolder( text );
}

void FolderTreeWidget::disableContextMenuAndExtraColumn()
{
    d->folderTreeView->disableContextMenuAndExtraColumn();
}

void FolderTreeWidget::selectCollectionFolder( const Akonadi::Collection &collection )
{
    const QModelIndex index =
            Akonadi::EntityTreeModel::modelIndexForCollection( d->folderTreeView->model(), collection );

    d->folderTreeView->setCurrentIndex( index );
    d->folderTreeView->setExpanded( index, true );
    d->folderTreeView->scrollTo( index );
}

void FolderTreeWidget::setSelectionMode( QAbstractItemView::SelectionMode mode )
{
    d->folderTreeView->setSelectionMode( mode );
}

QAbstractItemView::SelectionMode FolderTreeWidget::selectionMode() const
{
    return d->folderTreeView->selectionMode();
}

QItemSelectionModel * FolderTreeWidget::selectionModel () const
{
    return d->folderTreeView->selectionModel();
}

QModelIndex FolderTreeWidget::currentIndex() const
{
    return d->folderTreeView->currentIndex();
}

Akonadi::Collection FolderTreeWidget::selectedCollection() const
{
    if ( d->folderTreeView->selectionMode() == QAbstractItemView::SingleSelection ) {
        Akonadi::Collection::List lstCollection = selectedCollections();
        if ( lstCollection.isEmpty() ) {
            return Akonadi::Collection();
        } else {
            return lstCollection.at( 0 );
        }
    }

    return Akonadi::Collection();
}

Akonadi::Collection::List FolderTreeWidget::selectedCollections() const
{
    Akonadi::Collection::List collections;
    const QItemSelectionModel *selectionModel = d->folderTreeView->selectionModel();
    const QModelIndexList selectedIndexes = selectionModel->selectedIndexes();
    foreach ( const QModelIndex &index, selectedIndexes ) {
        if ( index.isValid() ) {
            const Akonadi::Collection collection =
                    index.model()->data(
                        index, Akonadi::EntityTreeModel::CollectionRole ).value<Akonadi::Collection>();
            if ( collection.isValid() ) {
                collections.append( collection );
            }
        }
    }

    return collections;
}

FolderTreeView *FolderTreeWidget::folderTreeView() const
{
    return d->folderTreeView;
}

void FolderTreeWidget::slotGeneralFontChanged()
{
    // Custom/System font support
    if ( MessageCore::GlobalSettings::self()->useDefaultFonts() ) {
        setFont( KGlobalSettings::generalFont() );
    }
}

void FolderTreeWidget::slotGeneralPaletteChanged()
{
    d->readableproxy->updatePalette();
    d->folderTreeView->updatePalette();
}

void FolderTreeWidget::readConfig()
{
    // Custom/System font support
    if ( !MessageCore::GlobalSettings::self()->useDefaultFonts() ) {
        KConfigGroup fontConfig( KernelIf->config(), "Fonts" );
        setFont( fontConfig.readEntry( "folder-font", KGlobalSettings::generalFont() ) );
    } else {
        setFont( KGlobalSettings::generalFont() );
    }

    d->folderTreeView->readConfig();
    d->folderTreeView->setDropActionMenuEnabled( SettingsIf->showPopupAfterDnD() );
    d->readableproxy->readConfig();

    KConfigGroup readerConfig( KernelIf->config(), "AccountOrder" );
    QStringList listOrder;
    if (readerConfig.readEntry("EnableAccountOrder", true)) {
         listOrder = readerConfig.readEntry( "order", QStringList() );
    }
    d->entityOrderProxy->setTopLevelOrder(listOrder);

    readQuotaConfig();
}

void FolderTreeWidget::restoreHeaderState( const QByteArray &data )
{
    d->folderTreeView->restoreHeaderState( data );
}

void FolderTreeWidget::slotChangeTooltipsPolicy( FolderTreeWidget::ToolTipDisplayPolicy policy )
{
    changeToolTipsPolicyConfig( policy );
}

void FolderTreeWidget::changeToolTipsPolicyConfig( ToolTipDisplayPolicy policy )
{
    switch( policy ){
    case DisplayAlways:
    case DisplayWhenTextElided: //Need to implement in the future
        d->filterModel->setToolTipEnabled( true );
        break;
    case DisplayNever:
        d->filterModel->setToolTipEnabled( false );
    }
    d->folderTreeView->setTooltipsPolicy( policy );
}

void FolderTreeWidget::quotaWarningParameters( const QColor &color, qreal threshold )
{
    d->quotaModel->setWarningThreshold( threshold );
    d->quotaModel->setWarningColor( color );
}

void FolderTreeWidget::readQuotaConfig()
{
    QColor quotaColor = MailCommon::Util::defaultQuotaColor();
    qreal threshold = 100;
    if ( !MessageCore::GlobalSettings::self()->useDefaultColors() ) {
        KConfigGroup readerConfig( KernelIf->config(), "Reader" );
        quotaColor = readerConfig.readEntry( "CloseToQuotaColor", quotaColor );
    }
    threshold = SettingsIf->closeToQuotaThreshold();
    quotaWarningParameters( quotaColor, threshold );
}

KPIM::StatisticsProxyModel *FolderTreeWidget::statisticsProxyModel() const
{
    return d->filterModel;
}

FolderTreeWidgetProxyModel *FolderTreeWidget::folderTreeWidgetProxyModel() const
{
    return d->readableproxy;
}

EntityCollectionOrderProxyModel *FolderTreeWidget::entityOrderProxy() const
{
    return d->entityOrderProxy;
}

KLineEdit *FolderTreeWidget::filterFolderLineEdit() const
{
    return d->filterFolderLineEdit;
}

void FolderTreeWidget::applyFilter( const QString &filter )
{
    d->label->setText(
                filter.isEmpty() ?
                    i18n( "You can start typing to filter the list of folders." ) :
                    i18n( "Path: (%1)", filter ) );

    d->readableproxy->setFilterFolder( filter );
    d->folderTreeView->expandAll();
    QAbstractItemModel *model = d->folderTreeView->model();
    QModelIndex current = d->folderTreeView->currentIndex();
    QModelIndex start = current.isValid() ? current : model->index(0, 0);
    QModelIndexList list = model->match( start, Qt::DisplayRole, d->filter, 1 /* stop at first hit */,
                                         Qt::MatchContains | Qt::MatchWrap | Qt::MatchRecursive );
    if ( !list.isEmpty() ) {
        current = list.first();
        d->folderTreeView->setCurrentIndex( current );
        d->folderTreeView->scrollTo( current );
    }
}

void FolderTreeWidget::clearFilter()
{
    d->filter.clear();
    applyFilter( d->filter );
    const QModelIndexList lst = d->folderTreeView->selectionModel()->selectedIndexes();
    if ( !lst.isEmpty() ) {
        d->folderTreeView->scrollTo( lst.first() );
    }
}

void FolderTreeWidget::slotManualSortingChanged( bool active )
{
    d->entityOrderProxy->setManualSortingActive( active );
    d->folderTreeView->setManualSortingActive( active );
}

bool FolderTreeWidget::eventFilter( QObject *o, QEvent *e )
{
    Q_UNUSED( o );
    if ( d->dontKeyFilter ) {
        return false;
    }

    if ( e->type() == QEvent::KeyPress ) {
        const QKeyEvent* const ke = static_cast<QKeyEvent*>( e );
        switch( ke->key() ) {
        case Qt::Key_Backspace:
        {
            const int filterLength( d->filter.length() );
            if ( filterLength > 0 ) {
                d->filter.truncate( filterLength-1 );
            }
            applyFilter( d->filter );
            return false;
        }
            break;
        case Qt::Key_Delete:
            d->filter.clear();
            applyFilter( d->filter );
            return false;
            break;
        default:
        {
            const QString s = ke->text();
            if ( !s.isEmpty() && s.at( 0 ).isPrint() ) {
                d->filter += s;
                applyFilter( d->filter );
                return false;
            }
        }
            break;
        }
    }
    return false;
}

}