searchpattern.h

Go to the documentation of this file.

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

  Author: Marc Mutz <mutz@kde.org>

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

  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 MAILCOMMON_SEARCHPATTERN_H
#define MAILCOMMON_SEARCHPATTERN_H

#include "mailcommon_export.h"
#include "searchrule/searchrule.h"
#include <KLocale>
#include <KUrl>

#include <QList>
#include <QString>

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

namespace Akonadi {
class Item;
}

namespace KMime {
class Message;
}

class KConfigGroup;

namespace MailCommon {

// maximum number of filter rules per filter
const int FILTER_MAX_RULES = 8;


// Needed for MSVC 2010, as it seems to not implicit cast for a pointer anymore
#ifdef _MSC_VER
uint qHash( SearchRule::Ptr sr );
#endif



// ------------------------------------------------------------------------

class MAILCOMMON_EXPORT SearchPattern : public QList<SearchRule::Ptr>
{

public:
    enum Operator {
        OpAnd,
        OpOr,
        OpAll
    };


    enum SparqlQueryError {
        NoError = 0,
        MissingCheck,
        FolderEmptyOrNotIndexed,
        EmptyResult,
        NotEnoughCharacters
    };

    SearchPattern();

    explicit SearchPattern( const KConfigGroup &config );

    ~SearchPattern();

    bool matches( const Akonadi::Item &item, bool ignoreBody = false ) const;

    SearchRule::RequiredPart requiredPart() const;

    QString purify(bool removeAction = true);

    void readConfig( const KConfigGroup &config );

    void writeConfig( KConfigGroup &config ) const;

    QString name() const
    {
        return mName;
    }

    void setName( const QString &newName )
    {
        mName = newName;
    }

    SearchPattern::Operator op() const
    {
        return mOperator;
    }

    void setOp( SearchPattern::Operator aOp )
    {
        mOperator = aOp;
    }

    QString asString() const;

    SparqlQueryError asAkonadiQuery(Akonadi::SearchQuery &) const;

    const SearchPattern &operator=( const SearchPattern &aPattern );

    QByteArray serialize() const;

    void deserialize( const QByteArray & );

    QDataStream &operator>>( QDataStream &s ) const;
    QDataStream &operator<<( QDataStream &s );


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

private:
    void importLegacyConfig( const KConfigGroup &config );

    void init();
    QString  mName;
    Operator mOperator;
};

}

Q_DECLARE_METATYPE(MailCommon::SearchRule::RequiredPart)

#endif /* MAILCOMMON_SEARCHPATTERN_H_ */