/*
    This file is part of libkcal.

    Copyright (c) 1998 Preston Brown
    Copyright (c) 2001,2003 Cornelius Schumacher <schumacher@kde.org>

    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., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*/
#ifndef KCAL_CALENDARLOCAL_H
#define KCAL_CALENDARLOCAL_H

#include "calendar.h"
//Added by qt3to4:
#include <Q3PtrList>

namespace KCal {

class CalFormat;

/**
  This class provides a calendar stored as a local file.
*/
class CalendarLocal : public Calendar
{
  public:
    /**
      Constructs a new calendar, with variables initialized to sane values.
    */
    CalendarLocal();
    /**
      Constructs a new calendar, with variables initialized to sane values.
    */
    CalendarLocal( const QString &timeZoneId );
    ~CalendarLocal();
    void addCalendar( Calendar*  );
    bool addCalendarFile( QString name, int id );
    bool mergeCalendarFile( QString name );
    bool mergeCalendar( Calendar* cal );
    Incidence* incidenceForUid( const QString& uid, bool doNotCheckDuplicates,  bool enabledOnly = false,int * isDup = 0 );
    Todo* todoForUid( const QString& uid, bool doNotCheckDuplicates = true, bool enabledOnly = false ,int * isDup = 0 );
    void setSyncEventsReadOnly();
    void setSyncEventsEnabled();
    void stopAllTodos();
    /**
      Loads a calendar on disk in vCalendar or iCalendar format into the current
      calendar. Any information already present is lost.
      @return true, if successfull, false on error.
      @param fileName the name of the calendar on disk.
    */
    bool load( const QString &fileName );
    /**
      Writes out the calendar to disk in the specified \a format.
      CalendarLocal takes ownership of the CalFormat object.
      @return true, if successfull, false on error.
      @param fileName the name of the file
    */
    bool save( const QString &fileName, CalFormat *format = 0 );

    /**
      Clears out the current calendar, freeing all used memory etc. etc.
    */
    void close();

    void save() {}
  
    /**
      Add Event to calendar.
    */
    void removeSyncInfo( QString syncProfile); 
    bool addAnniversaryNoDup( Event *event );
    bool addEventNoDup( Event *event );
    bool addEvent( Event *event );
    /** 
      Deletes an event from this calendar.
    */
    void deleteEvent( Event *event );

    /**
      Retrieves an event on the basis of the unique string ID.
    */
    Event *event( const QString &uid );
    /**
      Return unfiltered list of all events in calendar.
    */
    Q3PtrList<Event> rawEvents();
    Q3PtrList<Event> getExternLastSyncEvents();
    /**
      Add a todo to the todolist.
    */
    bool addTodo( Todo *todo );
    bool addTodoNoDup( Todo *todo );
    /**
      Remove a todo from the todolist.
    */
    void deleteTodo( Todo * );
    /**
      Searches todolist for an event with this unique string identifier,
      returns a pointer or null.
    */
    Todo *todo( const QString &uid );
    /**
      Return list of all todos.
    */
    Q3PtrList<Todo> rawTodos();
    /**
      Returns list of todos due on the specified date.
    */
    Q3PtrList<Todo> todos( const QDate &date );
    /**
      Return list of all todos.
      
      Workaround because compiler does not recognize function of base class.
    */
    Q3PtrList<Todo> todos() { return Calendar::todos(); }

    /**
      Add a Journal entry to calendar.
    */
    bool addJournal( Journal * );
    /**
      Remove a Journal from the calendar.
    */
    void deleteJournal( Journal * );
    /**
      Return Journal for given date.
    */
    Journal *journal( const QDate & );
    Q3PtrList<Journal> journals4Date( const QDate & );
    /**
      Return Journal with given UID.
    */
    Journal *journal( const QString &uid );
    /**
      Return list of all Journals stored in calendar.
    */
    Q3PtrList<Journal> journals();

    /**
      Return all alarms, which ocur in the given time interval.
    */
    Alarm::List alarms( const QDateTime &from, const QDateTime &to );

    /**
      Return all alarms, which ocur before given date.
    */
    Alarm::List alarmsTo( const QDateTime &to );
 
    QDateTime nextAlarm( int daysTo ) ;
    QDateTime nextAlarmEventDateTime()  const;
    void  checkAlarmForIncidence( Incidence *, bool deleted )  ;
    void registerAlarm();
    void deRegisterAlarm();
    QString getAlarmNotification();
    QString nextSummary() const ;
    /**
      This method should be called whenever a Event is modified directly
      via it's pointer. It makes sure that the calendar is internally
      consistent.
    */
    void update( IncidenceBase *incidence );
 
    /**
      Builds and then returns a list of all events that match for the
      date specified. useful for dayView, etc. etc.
    */
    Q3PtrList<Event> rawEventsForDate( const QDate &date, bool sorted = false );
    /**
      Get unfiltered events for date \a qdt.
    */
    Q3PtrList<Event> rawEventsForDate( const QDateTime &qdt );
    /**
      Get unfiltered events in a range of dates. If inclusive is set to true,
      only events are returned, which are completely included in the range.
    */
    Q3PtrList<Event> rawEvents( const QDate &start, const QDate &end,
                               bool inclusive = false );
    Todo *todo( QString, QString );
    Event *event( QString, QString );
    void getIncidenceCount( int calId, int& events, int & todos, int & journals);
 
public slots:
    void setCalendarEnabled( int id, bool enable );
    void setAlarmEnabled( int id, bool enable );
    void setReadOnly( int id, bool enable );
    void setDefaultCalendarEnabledOnly();
    void setCalendarRemove( int id );
    void setAllCalendarEnabled( bool enable );

  protected:

    // Event* mNextAlarmEvent;
    QString mNextSummary;
    QString mNextAlarmEventDateTimeString;
    QString mLastAlarmNotificationString;
    QDateTime mNextAlarmEventDateTime;
    QDateTime mNextAlarmDateTime; 
    void reInitAlarmSettings();
   
    /** Notification function of IncidenceBase::Observer. */
    void incidenceUpdated( IncidenceBase *i ) { update( i ); }
  
    /** inserts an event into its "proper place" in the calendar. */
    void insertEvent( Event *event );
  
    /** Append alarms of incidence in interval to list of alarms. */
    void appendAlarms( Alarm::List &alarms, Incidence *incidence,
                       const QDateTime &from, const QDateTime &to );

    /** Append alarms of recurring events in interval to list of alarms. */
    void appendRecurringAlarms( Alarm::List &alarms, Incidence *incidence,
                       const QDateTime &from, const QDateTime &to );

  private:
    void init();

    Q3PtrList<Event> mEventList;
    Q3PtrList<Todo> mTodoList;
    Q3PtrList<Journal> mJournalList;
};

}

#endif