agents/mailfilteragent/filtermanager.h

   1 /*
   2  * kmail: KDE mail client
   3  * Copyright (c) 1996-1998 Stefan Taferner <taferner@kde.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  *
  19  */
  20 #ifndef FILTERMANAGER_H
  21 #define FILTERMANAGER_H
  22
  23 #include <AkonadiCore/collection.h>
  24 #include <AkonadiCore/item.h>
  25
  26 #include "MailCommon/SearchPattern"
  27
  28 namespace MailCommon
  29 {
  30 class MailFilter;
  31 class ItemContext;
  32 }
  33
  34 class FilterManager: public QObject
  35 {
  36     Q_OBJECT
  37
  38 public:
  39     /**
  40      * Describes the list of filters.
  41      */
  42     enum FilterSet {
  43         NoSet = 0x0,
  44         Inbound = 0x1,
  45         Outbound = 0x2,
  46         Explicit = 0x4,
  47         BeforeOutbound = 0x8,
  48         All = Inbound | BeforeOutbound | Outbound | Explicit
  49     };
  50
  51     enum FilterRequires {
  52         Unknown = 0,
  53         HeaderMessage = 1,
  54         FullMessage = 2
  55     };
  56
  57     /**
  58      * Creates a new filter manager.
  59      *
  60      * @param parent The parent object.
  61      */
  62     explicit FilterManager(QObject *parent = Q_NULLPTR);
  63
  64     /**
  65      * Destroys the filter manager.
  66      */
  67     virtual ~FilterManager();
  68
  69     /**
  70      * Clears the list of filters and deletes them.
  71      */
  72     void clear();
  73
  74     /**
  75      * Reloads the filter rules from config file.
  76      */
  77     void readConfig();
  78
  79     /**
  80      * Checks for existing filters with the @p name and extend the
  81      * "name" to "name (i)" until no match is found for i=1..n
  82      */
  83     QString createUniqueName(const QString &name) const;
  84
  85     /**
  86      * Process given message item by applying the filter rules one by
  87      * one. You can select which set of filters (incoming or outgoing)
  88      * should be used.
  89      *
  90      *  @param item The message item to process.
  91      *  @param set Select the filter set to use.
  92      *  @param account @c true if an account id is specified else @c false
  93      *  @param accountId The id of the KMAccount that the message was retrieved from
  94      *
  95      *  @return true if the filtering was successful, false in case of any error
  96      */
  97     bool process(const Akonadi::Item &item, bool needsFullPayload,
  98                  FilterSet set = Inbound,
  99                  bool account = false, const QString &accountId = QString());
 100
 101     bool process(const QList<MailCommon::MailFilter *> &mailFilters, const Akonadi::Item &item,
 102                  bool needsFullPayload, FilterSet set = Inbound,
 103                  bool account = false, const QString &accountId = QString());
 104
 105     /**
 106      * For ad-hoc filters.
 107      *
 108      * Applies @p filter to message @p item.
 109      * Return codes are as with the above method.
 110      */
 111     bool process(const Akonadi::Item &item, bool needsFullPayload, const MailCommon::MailFilter *filter);
 112
 113     void filter(const Akonadi::Item &item, FilterManager::FilterSet set, const QString &resourceId);
 114     void filter(const Akonadi::Item &item, const QString &filterId, const QString &resourceId);
 115
 116     void applySpecificFilters(const Akonadi::Item::List &selectedMessages, MailCommon::SearchRule::RequiredPart requiredPart, const QStringList &listFilters);
 117
 118     /**
 119      * Applies the filters on the given @p messages.
 120      */
 121     void applyFilters(const Akonadi::Item::List &messages, FilterSet set = Explicit);
 122
 123     /**
 124      * Returns whether the configured filters need the full mail content.
 125      */
 126     MailCommon::SearchRule::RequiredPart requiredPart(const QString &id) const;
 127
 128     void mailCollectionRemoved(const Akonadi::Collection &collection);
 129
 130 #ifndef NDEBUG
 131     /**
 132      * Outputs all filter rules to console. Used for debugging.
 133      */
 134     void dump() const;
 135 #endif
 136
 137 protected:
 138     bool processContextItem(MailCommon::ItemContext context);
 139
 140 Q_SIGNALS:
 141     /**
 142      * This signal is emitted whenever the filter list has been updated.
 143      */
 144     void filterListUpdated();
 145
 146     /**
 147      * This signal is emitted to notify that @p item has not been moved.
 148      */
 149     void filteringFailed(const Akonadi::Item &item);
 150
 151     void percent(int progress);
 152     void progressMessage(const QString &message);
 153
 154 private:
 155     //@cond PRIVATE
 156     class Private;
 157     Private *d;
 158
 159     Q_PRIVATE_SLOT(d, void itemsFetchJobForFilterDone(KJob *))
 160     Q_PRIVATE_SLOT(d, void itemFetchJobForFilterDone(KJob *))
 161     Q_PRIVATE_SLOT(d, void moveJobResult(KJob *))
 162     Q_PRIVATE_SLOT(d, void modifyJobResult(KJob *))
 163     Q_PRIVATE_SLOT(d, void deleteJobResult(KJob *))
 164     Q_PRIVATE_SLOT(d, void slotItemsFetchedForFilter(const Akonadi::Item::List &))
 165     //@endcond
 166 };
 167
 168 #endif