/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qmessagefolderfilter.h"
#include "qmessagefolderfilter_p.h"
#include "messagingutil_p.h"
#include "qmessagefolder.h"
#include "qmessagemanager.h"

QTM_BEGIN_NAMESPACE

/*!
    \class QMessageFolderFilter

    \brief The QMessageFolderFilter class defines the parameters used for querying a subset of
    all available folders from the messaging store.

    \inmodule QtMessaging

    \ingroup messaging
    \since 1.0

    A QMessageFolderFilter is composed of a folder property, an optional comparison operator
    and a comparison value. The QMessageFolderFilter class is used in conjunction with the
    QMessageManager::queryFolders() and QMessageManager::countFolders() functions to filter results
    which meet the criteria defined by the filter.

    QMessageFolderFilters can be combined using the logical operators (&), (|) and (~) to
    create more refined queries.

    Evaluation of filters is delayed until they are used in a QMessageManager function
    such as queryFolders, except where explicitly documented otherwise.

    \sa QMessageManager, QMessageFolder
*/

/*!
    \fn QMessageFolderFilter::QMessageFolderFilter()

    Creates a QMessageFolderFilter without specifying matching parameters.

    A default-constructed filter (one for which isEmpty() returns true) matches all folders.

    \sa isEmpty()
*/

/*!
    \fn QMessageFolderFilter::QMessageFolderFilter(const QMessageFolderFilter &other)

    Constructs a copy of \a other.
    \since 1.0
*/

/*!
    \fn QMessageFolderFilter::~QMessageFolderFilter()

    Destroys the filter.
*/

/*!
    \internal
    \fn QMessageFolderFilter::operator=(const QMessageFolderFilter& other)
    \since 1.0
*/

/*!
    \fn QMessageFolderFilter::setMatchFlags(QMessageDataComparator::MatchFlags matchFlags)

    Set the match flags for the search filter to \a matchFlags.

    \since 1.0
    \sa matchFlags()
*/

/*!
    \fn QMessageDataComparator::MatchFlags QMessageFolderFilter::matchFlags() const

    Return the match flags for the search filter.

    Default is no match flags set.

    \since 1.0
    \sa setMatchFlags()
*/

/*!
    \fn QMessageFolderFilter::isEmpty() const

    Returns true if the filter remains empty after default construction; otherwise returns false.

    An empty filter matches all folders.

    The result of combining an empty filter with a non-empty filter using an AND operation is the
    original non-empty filter.

    The result of combining an empty filter with a non-empty filter using an OR operation is the
    empty filter.

    The result of combining two empty filters is an empty filter.
    \since 1.0
*/

/*!
    \fn QMessageFolderFilter::isSupported() const

    Returns true if the filter is supported on the current platform; otherwise returns false.
    \since 1.0
*/

/*!
    \fn QMessageFolderFilter::operator~() const

    Returns a filter that is the logical NOT of the value of this filter (ignoring any
    matchFlags() set on the filter).

    If this filter is empty, the result will be a non-matching filter; if this filter is
    non-matching, the result will be an empty filter.

    \since 1.0
    \sa isEmpty()
*/

/*!
    \fn QMessageFolderFilter::operator&(const QMessageFolderFilter& other) const

    Returns a filter that is the logical AND of this filter and the value of filter \a other.
    \since 1.0
*/

/*!
    \fn QMessageFolderFilter::operator|(const QMessageFolderFilter& other) const

    Returns a filter that is the logical OR of this filter and the value of filter \a other.
    \since 1.0
*/

/*!
    \fn QMessageFolderFilter::operator&=(const QMessageFolderFilter& other)

    Performs a logical AND with this filter and the filter \a other and assigns the result
    to this filter.
    \since 1.0
*/

/*!
    \fn QMessageFolderFilter::operator|=(const QMessageFolderFilter& other)

    Performs a logical OR with this filter and the filter \a other and assigns the result
    to this filter.
    \since 1.0
*/

/*!
    \internal
    \fn QMessageFolderFilter::operator==(const QMessageFolderFilter& other) const
    \since 1.0
*/

/*!
    \internal
    \since 1.0
*/
bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const
{
    return !operator==(other);
}

/*!
    \fn QMessageFolderFilter::byId(const QMessageFolderId &id, QMessageDataComparator::EqualityComparator cmp)

    Returns a filter matching folders whose identifier matches \a id, according to \a cmp.

    \since 1.0
    \sa QMessageFolder::id()
*/

/*!
    \fn QMessageFolderFilter::byId(const QMessageFolderIdList &ids, QMessageDataComparator::InclusionComparator cmp)

    Returns a filter matching folders whose identifier is a member of \a ids, according to \a cmp.

    \since 1.0
    \sa QMessageFolder::id()
*/

/*!
    \fn QMessageFolderFilter::byId(const QMessageFolderFilter &filter, QMessageDataComparator::InclusionComparator cmp)

    Returns a filter matching folders whose identifier is a member of the set yielded by \a filter, according to \a cmp.

    \since 1.0
    \sa QMessageFolder::id()
*/

/*!
    \fn QMessageFolderFilter::byName(const QString &pattern, QMessageDataComparator::LikeComparator cmp)

    Returns a filter matching folders whose display name matches \a pattern, according to \a cmp.

    This filter is evaluated when it is constructed.

    \since 1.2
    \sa QMessageFolder::name()
*/

/*!
    \fn QMessageFolderFilter::byName(const QString &value, QMessageDataComparator::EqualityComparator cmp)

    Returns a filter matching folders whose display name matches \a value, according to \a cmp.

    Not supported on Linux, Harmattan and Meego.com (use InclusionComparator).

    \since 1.0
    \sa QMessageFolder::name()
*/

/*!
    \fn QMessageFolderFilter::byName(const QString &value, QMessageDataComparator::InclusionComparator cmp)

    Returns a filter matching folders whose display name matches the substring \a value, according to \a cmp.

    \since 1.0
    \sa QMessageFolder::name()
*/

/*!
    \fn QMessageFolderFilter::byPath(const QString &pattern, QMessageDataComparator::LikeComparator cmp)

    Returns a filter matching folders whose path matches \a pattern, according to \a cmp.

    This filter is evaluated when it is constructed.

    \since 1.2
    \sa QMessageFolder::path()
*/

/*!
    \fn QMessageFolderFilter::byPath(const QString &value, QMessageDataComparator::EqualityComparator cmp)

    Returns a filter matching folders whose path matches \a value, according to \a cmp.

    Not supported on Linux, Harmattan and Meego.com (use InclusionComparator).

    \since 1.0
    \sa QMessageFolder::path()
*/

/*!
    \fn QMessageFolderFilter::byPath(const QString &value, QMessageDataComparator::InclusionComparator cmp)

    Returns a filter matching folders whose path matches the substring \a value, according to \a cmp.

    \since 1.0
    \sa QMessageFolder::path()
*/

/*!
    \fn QMessageFolderFilter::byParentAccountId(const QMessageAccountId &id, QMessageDataComparator::EqualityComparator cmp)

    Returns a filter matching folders whose parent account identifier matches \a id, according to \a cmp.

    \since 1.0
    \sa QMessageAccount::id()
*/

/*!
    \fn QMessageFolderFilter::byParentAccountId(const QMessageAccountFilter &filter, QMessageDataComparator::InclusionComparator cmp)

    Returns a filter matching folders whose parent account identifier is a member of the set yielded by \a filter, according to \a cmp.

    \since 1.0
    \sa QMessageAccount::id()
*/

/*!
    \fn QMessageFolderFilter::byParentFolderId(const QMessageFolderId &id, QMessageDataComparator::EqualityComparator cmp)

    Returns a filter matching folders whose parent folder identifier matches \a id, according to \a cmp.

    \since 1.0
    \sa QMessageFolder::id()
*/

/*!
    \fn QMessageFolderFilter::byParentFolderId(const QMessageFolderFilter &filter, QMessageDataComparator::InclusionComparator cmp)

    Returns a filter matching folders whose parent folder identifier is a member of the set yielded by \a filter, according to \a cmp.

    \since 1.0
    \sa QMessageFolder::id()
*/

/*!
    \fn QMessageFolderFilter::byAncestorFolderIds(const QMessageFolderId &id, QMessageDataComparator::InclusionComparator cmp)

    Returns a filter matching folders whose ancestor folders' identifiers contain \a id, according to \a cmp.

    \since 1.0
    \sa QMessageFolder::id()
*/

/*!
    \fn QMessageFolderFilter::byAncestorFolderIds(const QMessageFolderFilter &filter, QMessageDataComparator::InclusionComparator cmp)

    Returns a filter matching folders whose ancestor folders' identifiers contain a member of the set yielded by \a filter, according to \a cmp.

    \since 1.0
    \sa QMessageFolder::id()
*/

QMessageFolderFilter QMessageFolderFilter::byName(const QString &pattern, QMessageDataComparator::LikeComparator cmp)
{
    QMessageFolderIdList ids;
    foreach(QMessageFolderId const& id, QMessageManager().queryFolders()) {
        if (MessagingUtil::globMatch(pattern, QMessageFolder(id).name())) {
            ids.push_back(id);
        }
    }

    return QMessageFolderFilter::byId(ids);
}

QMessageFolderFilter QMessageFolderFilter::byPath(const QString &pattern, QMessageDataComparator::LikeComparator cmp)
{
    QMessageFolderIdList ids;
    foreach(QMessageFolderId const& id, QMessageManager().queryFolders()) {
        if (MessagingUtil::globMatch(pattern, QMessageFolder(id).path())) {
            ids.push_back(id);
        }
    }

    return QMessageFolderFilter::byId(ids);
}


QTM_END_NAMESPACE