searchrule.h

Go to the documentation of this file.

/*
  Copyright (c) 2015 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
*/
#ifndef SEARCHRULE_H
#define SEARCHRULE_H


#include "mailcommon_export.h"
#ifndef Q_MOC_RUN
#include <boost/shared_ptr.hpp>
#endif
#include <akonadi/searchquery.h>

#include <Akonadi/Item>

class KConfigGroup;
namespace MailCommon {
class MAILCOMMON_EXPORT SearchRule
{
public:
    typedef boost::shared_ptr<SearchRule> Ptr;

    enum Function {
        FuncNone = -1,
        FuncContains = 0,
        FuncContainsNot,
        FuncEquals,
        FuncNotEqual,
        FuncRegExp,
        FuncNotRegExp,
        FuncIsGreater,
        FuncIsLessOrEqual,
        FuncIsLess,
        FuncIsGreaterOrEqual,
        FuncIsInAddressbook,
        FuncIsNotInAddressbook,
        FuncIsInCategory,
        FuncIsNotInCategory,
        FuncHasAttachment,
        FuncHasNoAttachment,
        FuncStartWith,
        FuncNotStartWith,
        FuncEndWith,
        FuncNotEndWith
    };

    enum RequiredPart {
        Envelope = 0,
        Header,
        CompleteMessage
    };

    explicit SearchRule ( const QByteArray &field = QByteArray(), Function function = FuncContains,
                          const QString &contents = QString() );

    SearchRule( const SearchRule &other );

    const SearchRule &operator=( const SearchRule &other );

    static SearchRule::Ptr createInstance( const QByteArray &field = 0,
                                           Function function = FuncContains,
                                           const QString &contents = QString() );

    static SearchRule::Ptr createInstance( const QByteArray &field,
                                           const char *function,
                                           const QString &contents );

    static SearchRule::Ptr createInstance( const SearchRule &other );

    static SearchRule::Ptr createInstance( QDataStream &stream );

    static SearchRule::Ptr createInstanceFromConfig( const KConfigGroup &group, int index );

    virtual ~SearchRule();

    virtual bool matches( const Akonadi::Item &item ) const = 0;

    virtual bool isEmpty() const = 0;

    virtual SearchRule::RequiredPart requiredPart() const = 0;

    void writeConfig( KConfigGroup &group, int index ) const;

    void generateSieveScript(QStringList &requires, QString &code);

    void setFunction( Function function );

    Function function() const;

    void setField( const QByteArray &name );

    QByteArray field() const;

    void setContents( const QString &contents );

    QString contents() const;

    const QString asString() const;

    virtual void addQueryTerms( Akonadi::SearchTerm &groupTerm, bool &emptyIsNotAnError ) const {  }


    QDataStream &operator>>( QDataStream & ) const;
    virtual QString informationAboutNotValidRules() const { return QString(); }

protected:
    bool isNegated() const;

    Akonadi::SearchTerm::Condition akonadiComparator() const;

protected:
    QString quote( const QString &content ) const;
private:
    static Function configValueToFunc( const char * );
    static QString functionToString( Function );
    QString conditionToString(Function function);

    QByteArray mField;
    Function mFunction;
    QString  mContents;
};
}

#endif // SEARCHRULE_H