filtermanager.h

Go to the documentation of this file.

/*
  Copyright (C) 2011 Tobias Koenig <tokoe@kde.org>

  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.
*/

#ifndef MAILCOMMON_FILTERMANAGER_H
#define MAILCOMMON_FILTERMANAGER_H

#include "../mailcommon_export.h"
#include "mailfilter.h"

#include <Akonadi/Item>
#include <Akonadi/ServerManager>

#include <QObject>

namespace MailCommon {

class FilterActionDict;

class MAILCOMMON_EXPORT FilterManager : public QObject
{
    Q_OBJECT

public:
    enum FilterSet {
        NoSet = 0x0,
        Inbound = 0x1,
        Outbound = 0x2,
        Explicit = 0x4,
        BeforeOutbound = 0x8,
        All = Inbound|BeforeOutbound|Outbound|Explicit
    };

    static FilterManager *instance();

    bool isValid() const;

    QString createUniqueFilterName( const QString &name ) const;

    static FilterActionDict *filterActionDict();

    void showFilterLogDialog(qlonglong windowId);


    void filter( const Akonadi::Item &item, const QString &identifier, const QString &resourceId ) const;

    void filter( const Akonadi::Item &item, FilterSet set = Inbound,
                 bool account = false, const QString &resourceId = QString() ) const;

    void filter( const Akonadi::Item::List &messages, FilterSet set = Explicit ) const;

    void filter( const Akonadi::Item::List &messages, SearchRule::RequiredPart requiredPart,
                 const QStringList &listFilters ) const;


    void appendFilters( const QList<MailCommon::MailFilter*> &filters,
                        bool replaceIfNameExists = false );

    void removeFilter( MailCommon::MailFilter *filter );

    void setFilters( const QList<MailCommon::MailFilter*> &filters );

    QList<MailCommon::MailFilter*> filters() const;

    void beginUpdate();

    void endUpdate();

    QMap<QUrl, QString> tagList() const;

    bool initialized() const;

private Q_SLOTS:
    void slotServerStateChanged(Akonadi::ServerManager::State);
    void slotFinishedTagListing(KJob *);
    void slotReadConfig();
    void updateTagList();

    void slotTagAdded(const Akonadi::Tag &);
    void slotTagChanged(const Akonadi::Tag &);
    void slotTagRemoved(const Akonadi::Tag &);

Q_SIGNALS:
    void filtersChanged();

    void tagListingFinished();

    void loadingFiltersDone();

private:
    FilterManager();

    class Private;
    Private *const d;
};

}

#endif