diff options
Diffstat (limited to 'kresources/exchange/resourceexchange.h')
-rw-r--r-- | kresources/exchange/resourceexchange.h | 248 |
1 files changed, 248 insertions, 0 deletions
diff --git a/kresources/exchange/resourceexchange.h b/kresources/exchange/resourceexchange.h new file mode 100644 index 000000000..721e36660 --- /dev/null +++ b/kresources/exchange/resourceexchange.h @@ -0,0 +1,248 @@ +/* + This file is part of libkpimexchange. + Copyright (c) 2002 Jan-Pascal van Best <janpascal@vanbest.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 KPIM_EXCHANGECALENDAR_H +#define KPIM_EXCHANGECALENDAR_H + +#include <qmap.h> +#include <qdict.h> +#include <qintdict.h> + +#include <libkcal/calendar.h> +#include <libkcal/calendarlocal.h> +#include <libkcal/resourcecalendar.h> + +#include "exchangemonitor.h" + +class DateSet; + +namespace KPIM { +class ExchangeAccount; +class ExchangeClient; +} + +namespace KCal { +class Event; +class CalFormat; + +/** + This class provides a calendar stored on a Microsoft Exchange 2000 server +*/ +// FIXME: Use ResourceCached +class ResourceExchange : public ResourceCalendar, public IncidenceBase::Observer +{ + Q_OBJECT + + public: + ResourceExchange( const KConfig * ); + virtual ~ResourceExchange(); + + virtual void writeConfig( KConfig* config ); + + KABC::Lock *lock(); + + /** constructs a new calendar, with variables initialized to sane values. */ +// ExchangeCalendar( KPIM::ExchangeAccount* account ); + /** constructs a new calendar, with variables initialized to sane values. */ +// ExchangeCalendar( KPIM::ExchangeAccount* account, const QString &timeZoneId ); +// virtual ~ExchangeCalendar(); + + /** + Semantics not yet defined. Should the Exchange calendar be wiped clean? + Should the disk calendar be copied to the Exchange calendar? + At the moment, does nothing. + @return true, if successful, 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. + ExchangeCalendar takes ownership of the CalFormat object. + @return true, if successful, 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(); + + /** Add Event to calendar. */ + bool addEvent(Event *anEvent); + /** deletes an event from this calendar. */ + bool deleteEvent(Event *); + + // Isn't called anymore. + void changeIncidence( Incidence * ); + + /** + Retrieves an event on the basis of the unique string ID. + */ + Event *event(const QString &UniqueStr); + /** + Return filtered list of all events in calendar. + */ +// Event::List events(); + /** + Return unfiltered list of all events in calendar. + Use with care, since this causes a LOT of network activity + */ + Event::List rawEvents(); + + virtual void subscribeEvents( const QDate& start, const QDate& end ); + + /** + Stop receiving event signals for the given period (inclusive). After this call, + the calendar resource will no longer send eventsAdded, eventsModified or + eventsDeleted signals for events falling completely in this period. The resource + MAY delete the Events objects. The application MUST NOT dereference pointers + to the relevant Events after this call. + */ + virtual void unsubscribeEvents( const QDate& start, const QDate& end ); + + /** + Add a todo to the todolist. + */ + bool addTodo( Todo *todo ); + /** + Remove a todo from the todolist. + */ + bool 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. + */ + Todo::List rawTodos( TodoSortField sortField = TodoSortUnsorted, SortDirection sortDirection = SortDirectionAscending ); + /** + Returns list of todos due on the specified date. + */ + Todo::List rawTodosForDate( const QDate &date ); + + /** Add a Journal entry to calendar */ + virtual bool addJournal(Journal *); + /** deletes an event from this calendar. */ + virtual bool deleteJournal(Journal *); + /** Return Journals for given date */ + virtual Journal::List journals(const QDate &); + /** Return Journal with given UID */ + virtual Journal *journal(const QString &UID); + /** Return list of all Journals stored in calendar */ + Journal::List rawJournals( JournalSortField sortField = JournalSortUnsorted, SortDirection sortDirection = SortDirectionAscending ); + /** Return journals for the given date. */ + Journal::List rawJournalsForDate( const QDate & ); + + /** 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 ); + + friend class ResourceExchangeConfig; + + protected: + /** + Prepare the calendar for use. Load the calendar from disk, + open connections to the calendaring server, whatever. + Must be called before other methods can be called. + */ + virtual bool doOpen(); + + /** clears out the current calendar, freeing all used memory etc. etc. */ + virtual void doClose(); + + virtual bool doLoad(); + virtual bool doSave(); + + public: + /** + Builds and then returns a list of all events that match for the + date specified. useful for dayView, etc. etc. + */ + Event::List rawEventsForDate( + const QDate &date, + EventSortField sortField=EventSortUnsorted, + SortDirection sortDirection=SortDirectionAscending ); + + /** + Get unfiltered events for date \a qdt. + */ + Event::List 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. + */ + Event::List rawEvents( const QDate &start, const QDate &end, + bool inclusive = false ); + /** + Get unfiltered events in sorted order. + */ + Event::List rawEvents( EventSortField sortField = EventSortUnsorted, SortDirection sortDirection = SortDirectionAscending ); + + protected: + /** Notification function of IncidenceBase::Observer. */ + void incidenceUpdated( IncidenceBase *i ); + + /** inserts an event into its "proper place" in the calendar. */ +// void insertEvent(const Event *anEvent); + + /** 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 ); + + bool uploadEvent( Event *event ); + + void setTimeZoneId( const QString &tzid ); + + protected slots: + void slotMonitorNotify( const QValueList<long>& IDs, const QValueList<KURL>& urls); + void slotMonitorError( int errorCode, const QString& moreInfo ); + void slotDownloadFinished( int result, const QString& moreinfo ); + void downloadedEvent( KCal::Event*, const KURL& ); + + private: + class EventInfo; + KPIM::ExchangeAccount* mAccount; + KPIM::ExchangeClient* mClient; + KPIM::ExchangeMonitor* mMonitor; + CalendarLocal* mCache; + QDict<EventInfo> mEventDict; // maps UIDS to EventInfo records + QIntDict<EventInfo> mWatchDict; // maps Watch IDs to EventInfo records + DateSet* mDates; + QMap<Event, QDateTime>* mEventDates; + QMap<QDate, QDateTime>* mCacheDates; + int mCachedSeconds; + bool mAutoMailbox; + QString mTimeZoneId; + + KABC::Lock *mLock; + + // FIXME: Remove variable, use ResourceCached::changedIncidences() instead. + Incidence::List mChangedIncidences; +}; + +} + +#endif |