resourcecached.h

/*
    This file is part of libkcal.
 
    Copyright (c) 2003,2004 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., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
#ifndef KCAL_RESOURCECACHED_H
#define KCAL_RESOURCECACHED_H
 
#include "resourcecalendar.h"
 
#include "libemailfunctions/idmapper.h"
#include "incidence.h"
#include "calendarlocal.h"
 
#include <tdeconfig.h>
 
#include <tqptrlist.h>
#include <tqstring.h>
#include <tqdatetime.h>
#include <tqtimer.h>
 
#include <tdemacros.h>
 
namespace KCal {

class TDE_EXPORT ResourceCached : public ResourceCalendar,
                       public KCal::Calendar::Observer
{
    TQ_OBJECT
  
  public:
    enum { ReloadNever, ReloadOnStartup, ReloadInterval };
    enum { SaveNever, SaveOnExit, SaveInterval, SaveDelayed, SaveAlways };
 
    ResourceCached( const TDEConfig * );
    virtual ~ResourceCached();
 
    void readConfig( const TDEConfig *config );
    void writeConfig( TDEConfig *config );
 
    static bool editorWindowOpen();
    static void setEditorWindowOpen(bool open);

    void setReloadPolicy( int policy );
    int reloadPolicy() const;

    void setReloadInterval( int minutes );

    int reloadInterval() const;

    void setSavePolicy( int policy );
    int savePolicy() const;

    void setSaveInterval( int minutes );

    int saveInterval() const;

    TQDateTime lastLoad() const;

    TQDateTime lastSave() const;

    TDE_DEPRECATED bool addEvent( Event *event );
    bool addEvent( Event *event, const TQString &subresource );

    bool deleteEvent(Event *);

    Event *event(const TQString &UniqueStr);
    Event::List events();
    Event::List rawEvents( EventSortField sortField = EventSortUnsorted, SortDirection sortDirection = SortDirectionAscending );
    Event::List rawEventsForDate( const TQDate &date, EventSortField sortField = EventSortUnsorted, SortDirection sortDirection = SortDirectionAscending );

    Event::List rawEventsForDate( const TQDateTime &qdt );
    Event::List rawEvents( const TQDate &start, const TQDate &end,
                               bool inclusive = false );

    TDE_DEPRECATED bool addTodo( Todo *todo );
    bool addTodo( Todo *todo, const TQString &subresource );

    bool deleteTodo( Todo * );
    Todo *todo( const TQString &uid );
    Todo::List rawTodos( TodoSortField sortField = TodoSortUnsorted, SortDirection sortDirection = SortDirectionAscending );
    Todo::List rawTodosForDate( const TQDate &date );
    TDE_DEPRECATED bool addJournal( Journal *journal );
    bool addJournal( Journal *journal, const TQString &subresource );

    bool deleteJournal( Journal * );
    Journal *journal( const TQString &uid );
    Journal::List rawJournals( JournalSortField sortField = JournalSortUnsorted,SortDirection sortDirection = SortDirectionAscending );
    Journal::List rawJournalsForDate( const TQDate &date );

    Alarm::List alarms( const TQDateTime &from, const TQDateTime &to );

    Alarm::List alarmsTo( const TQDateTime &to );

    void setTimeZoneId( const TQString &timeZoneId );
 
    TQString timeZoneId() const;

    const Person &getOwner() const;
    void setOwner( const Person &owner );
 
    void enableChangeNotification();
    void disableChangeNotification();
 
    void clearChange( Incidence * );
    void clearChange( const TQString &uid );
 
    void clearChanges();
 
    bool hasChanges() const;
 
    Incidence::List allChanges() const;
 
    Incidence::List addedIncidences() const;
    Incidence::List changedIncidences() const;
    Incidence::List deletedIncidences() const;

    void loadCache();

    void saveCache();

    void clearCache();

    void clearEventsCache();

    void clearTodosCache();

    void clearJournalsCache();
 
    void cleanUpEventCache( const KCal::Event::List &eventList );
    void cleanUpTodoCache( const KCal::Todo::List &todoList );

    KPIM::IdMapper& idMapper();
 
  protected:
    // From Calendar::Observer
    void calendarIncidenceAdded( KCal::Incidence *incidence );
    void calendarIncidenceChanged( KCal::Incidence *incidence );
    void calendarIncidenceDeleted( KCal::Incidence *incidence );
 
    CalendarLocal mCalendar;

    virtual void doClose();
    virtual bool doOpen();
    bool checkForReload();
    bool checkForSave();
 
    void checkForAutomaticSave();
 
    void addInfoText( TQString & ) const;
 
    void setupSaveTimer();
    void setupReloadTimer();

    virtual TQString cacheFile() const;

    virtual TQString changesCacheFile( const TQString& ) const;
    void loadChangesCache( TQMap<Incidence*, bool>&, const TQString& );
    void loadChangesCache();
    void saveChangesCache( const TQMap<Incidence*, bool>&, const TQString& );
    void saveChangesCache();
 
  protected slots:
    void slotReload();
    void slotSave();
 
    void setIdMapperIdentifier();
 
  private:
    int mReloadPolicy;
    int mReloadInterval;
    TQTimer mReloadTimer;
    bool mReloaded;
 
    int mSavePolicy;
    int mSaveInterval;
    TQTimer mSaveTimer;
 
    TQDateTime mLastLoad;
    TQDateTime mLastSave;
 
    TQMap<KCal::Incidence *,bool> mAddedIncidences;
    TQMap<KCal::Incidence *,bool> mChangedIncidences;
    TQMap<KCal::Incidence *,bool> mDeletedIncidences;
 
    KPIM::IdMapper mIdMapper;
 
    class Private;
    Private *d;
};
 
}
 
#endif