calfilter.cpp

Go to the documentation of this file.

/*
  This file is part of the kcal library.

  Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>
  Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
  Copyright (C) 2004 Bram Schoenmakers <bramschoenmakers@kde.nl>

  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.
*/
#include "calfilter.h"

#include <kdebug.h>

using namespace KCal;

//@cond PRIVATE
class KCal::CalFilter::Private
{
  public:
    Private()
      : mCriteria( 0 ),
        mCompletedTimeSpan( 0 ),
        mEnabled( true )
    {}
    QString mName;   // filter name
    QStringList mCategoryList;
    QStringList mEmailList;
    int mCriteria;
    int mCompletedTimeSpan;
    bool mEnabled;

};
//@endcond

CalFilter::CalFilter() : d( new KCal::CalFilter::Private )
{
}

CalFilter::CalFilter( const QString &name )
  : d( new KCal::CalFilter::Private )
{
  d->mName = name;
}

CalFilter::~CalFilter()
{
  delete d;
}

bool KCal::CalFilter::operator==( const CalFilter &filter )
{
  return d->mName == filter.d->mName &&
    d->mCriteria == filter.d->mCriteria &&
    d->mCategoryList == filter.d->mCategoryList &&
    d->mEmailList == filter.d->mEmailList &&
    d->mCompletedTimeSpan == filter.d->mCompletedTimeSpan;
}

void CalFilter::apply( Event::List *eventList ) const
{
  if ( !d->mEnabled ) {
    return;
  }

  Event::List::Iterator it = eventList->begin();
  while ( it != eventList->end() ) {
    if ( !filterIncidence( *it ) ) {
      it = eventList->erase( it );
    } else {
      ++it;
    }
  }
}

// TODO: avoid duplicating apply() code
void CalFilter::apply( Todo::List *todoList ) const
{
  if ( !d->mEnabled ) {
    return;
  }

  Todo::List::Iterator it = todoList->begin();
  while ( it != todoList->end() ) {
    if ( !filterIncidence( *it ) ) {
      it = todoList->erase( it );
    } else {
      ++it;
    }
  }
}

void CalFilter::apply( Journal::List *journalList ) const
{
  if ( !d->mEnabled ) {
    return;
  }

  Journal::List::Iterator it = journalList->begin();
  while ( it != journalList->end() ) {
    if ( !filterIncidence( *it ) ) {
      it = journalList->erase( it );
    } else {
      ++it;
    }
  }
}

bool CalFilter::filterIncidence( Incidence *incidence ) const
{
  if ( !d->mEnabled ) {
    return true;
  }

  Todo *todo = dynamic_cast<Todo *>( incidence );
  if ( todo ) {
    if ( ( d->mCriteria & HideCompletedTodos ) && todo->isCompleted() ) {
      // Check if completion date is suffently long ago:
      if ( todo->completed().addDays( d->mCompletedTimeSpan ) <
           KDateTime::currentUtcDateTime() ) {
        return false;
      }
    }

    if ( ( d->mCriteria & HideInactiveTodos ) &&
         ( ( todo->hasStartDate() &&
             KDateTime::currentUtcDateTime() < todo->dtStart() ) ||
           todo->isCompleted() ) ) {
      return false;
    }

    if ( d->mCriteria & HideNoMatchingAttendeeTodos ) {
      bool iAmOneOfTheAttendees = false;
      const Attendee::List &attendees = todo->attendees();
      if ( !todo->attendees().isEmpty() ) {
        Attendee::List::ConstIterator it;
        for ( it = attendees.begin(); it != attendees.end(); ++it ) {
          if ( d->mEmailList.contains( (*it)->email() ) ) {
            iAmOneOfTheAttendees = true;
            break;
          }
        }
      } else {
        // no attendees, must be me only
        iAmOneOfTheAttendees = true;
      }
      if ( !iAmOneOfTheAttendees ) {
        return false;
      }
    }
  }

  if ( d->mCriteria & HideRecurring ) {
    if ( incidence->recurs() ) {
      return false;
    }
  }

  if ( d->mCriteria & ShowCategories ) {
    for ( QStringList::ConstIterator it = d->mCategoryList.constBegin();
          it != d->mCategoryList.constEnd(); ++it ) {
      QStringList incidenceCategories = incidence->categories();
      for ( QStringList::ConstIterator it2 = incidenceCategories.constBegin();
            it2 != incidenceCategories.constEnd(); ++it2 ) {
        if ( (*it) == (*it2) ) {
          return true;
        }
      }
    }
    return false;
  } else {
    for ( QStringList::ConstIterator it = d->mCategoryList.constBegin();
          it != d->mCategoryList.constEnd(); ++it ) {
      QStringList incidenceCategories = incidence->categories();
      for ( QStringList::ConstIterator it2 = incidenceCategories.constBegin();
            it2 != incidenceCategories.constEnd(); ++it2 ) {
        if ( (*it) == (*it2) ) {
          return false;
        }
      }
    }
    return true;
  }

  return true;
}

void CalFilter::setName( const QString &name )
{
  d->mName = name;
}

QString CalFilter::name() const
{
  return d->mName;
}

void CalFilter::setEnabled( bool enabled )
{
  d->mEnabled = enabled;
}

bool CalFilter::isEnabled() const
{
  return d->mEnabled;
}

void CalFilter::setCriteria( int criteria )
{
  d->mCriteria = criteria;
}

int CalFilter::criteria() const
{
  return d->mCriteria;
}

void CalFilter::setCategoryList( const QStringList &categoryList )
{
  d->mCategoryList = categoryList;
}

QStringList CalFilter::categoryList() const
{
  return d->mCategoryList;
}

void CalFilter::setEmailList( const QStringList &emailList )
{
  d->mEmailList = emailList;
}

QStringList CalFilter::emailList() const
{
  return d->mEmailList;
}

void CalFilter::setCompletedTimeSpan( int timespan )
{
  d->mCompletedTimeSpan = timespan;
}

int CalFilter::completedTimeSpan() const
{
  return d->mCompletedTimeSpan;
}