libkcal

calendarlocal.cpp

00001 /*
00002     This file is part of libkcal.
00003 
00004     Copyright (c) 1998 Preston Brown <pbrown@kde.org>
00005     Copyright (c) 2001,2003,2004 Cornelius Schumacher <schumacher@kde.org>
00006     Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
00007 
00008     This library is free software; you can redistribute it and/or
00009     modify it under the terms of the GNU Library General Public
00010     License as published by the Free Software Foundation; either
00011     version 2 of the License, or (at your option) any later version.
00012 
00013     This library is distributed in the hope that it will be useful,
00014     but WITHOUT ANY WARRANTY; without even the implied warranty of
00015     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00016     Library General Public License for more details.
00017 
00018     You should have received a copy of the GNU Library General Public License
00019     along with this library; see the file COPYING.LIB.  If not, write to
00020     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00021     Boston, MA 02110-1301, USA.
00022 */
00023 
00024 #include <qdatetime.h>
00025 #include <qstring.h>
00026 #include <qptrlist.h>
00027 
00028 #include <kdebug.h>
00029 #include <klocale.h>
00030 #include <kmessagebox.h>
00031 
00032 #include "vcaldrag.h"
00033 #include "vcalformat.h"
00034 #include "icalformat.h"
00035 #include "exceptions.h"
00036 #include "incidence.h"
00037 #include "journal.h"
00038 #include "filestorage.h"
00039 
00040 #include "calendarlocal.h"
00041 
00042 using namespace KCal;
00043 
00044 CalendarLocal::CalendarLocal( const QString &timeZoneId )
00045   : Calendar( timeZoneId ), mEvents( 47 )
00046 {
00047   init();
00048 }
00049 
00050 void CalendarLocal::init()
00051 {
00052   mDeletedIncidences.setAutoDelete( true );
00053   mFileName = QString::null;
00054 }
00055 
00056 
00057 CalendarLocal::~CalendarLocal()
00058 {
00059   close();
00060 }
00061 
00062 bool CalendarLocal::load( const QString &fileName, CalFormat *format )
00063 {
00064   mFileName = fileName;
00065   FileStorage storage( this, fileName, format );
00066   return storage.load();
00067 }
00068 
00069 bool CalendarLocal::reload( const QString &tz )
00070 {
00071   const QString filename = mFileName;
00072   save();
00073   close();
00074   mFileName = filename;
00075   setTimeZoneId( tz );
00076   FileStorage storage( this, mFileName );
00077   return storage.load();
00078 }
00079 
00080 bool CalendarLocal::save( const QString &fileName, CalFormat *format )
00081 {
00082   // Save only if the calendar is either modified, or saved to a
00083   // different file than it was loaded from
00084   if ( mFileName != fileName || isModified() ) {
00085     FileStorage storage( this, fileName, format );
00086     return storage.save();
00087   } else {
00088     return true;
00089   }
00090 }
00091 
00092 void CalendarLocal::close()
00093 {
00094   setObserversEnabled( false );
00095   mFileName = QString::null;
00096 
00097   deleteAllEvents();
00098   deleteAllTodos();
00099   deleteAllJournals();
00100 
00101   mDeletedIncidences.clear();
00102   setModified( false );
00103 
00104   setObserversEnabled( true );
00105 }
00106 
00107 
00108 bool CalendarLocal::addEvent( Event *event )
00109 {
00110   insertEvent( event );
00111 
00112   event->registerObserver( this );
00113 
00114   setModified( true );
00115 
00116   notifyIncidenceAdded( event );
00117 
00118   return true;
00119 }
00120 
00121 bool CalendarLocal::deleteEvent( Event *event )
00122 {
00123 //  kdDebug(5800) << "CalendarLocal::deleteEvent" << endl;
00124 
00125   if ( mEvents.remove( event->uid() ) ) {
00126     setModified( true );
00127     notifyIncidenceDeleted( event );
00128     mDeletedIncidences.append( event );
00129     return true;
00130   } else {
00131     kdWarning() << "CalendarLocal::deleteEvent(): Event not found." << endl;
00132     return false;
00133   }
00134 }
00135 
00136 void CalendarLocal::deleteAllEvents()
00137 {
00138   // kdDebug(5800) << "CalendarLocal::deleteAllEvents" << endl;
00139   QDictIterator<Event> it( mEvents );
00140   while( it.current() ) {
00141     notifyIncidenceDeleted( it.current() );
00142     ++it;
00143   }
00144 
00145   mEvents.setAutoDelete( true );
00146   mEvents.clear();
00147   mEvents.setAutoDelete( false );
00148 }
00149 
00150 Event *CalendarLocal::event( const QString &uid )
00151 {
00152 //  kdDebug(5800) << "CalendarLocal::event(): " << uid << endl;
00153   return mEvents[ uid ];
00154 }
00155 
00156 bool CalendarLocal::addTodo( Todo *todo )
00157 {
00158   mTodoList.append( todo );
00159 
00160   todo->registerObserver( this );
00161 
00162   // Set up subtask relations
00163   setupRelations( todo );
00164 
00165   setModified( true );
00166 
00167   notifyIncidenceAdded( todo );
00168 
00169   return true;
00170 }
00171 
00172 bool CalendarLocal::deleteTodo( Todo *todo )
00173 {
00174   // Handle orphaned children
00175   removeRelations( todo );
00176 
00177   if ( mTodoList.removeRef( todo ) ) {
00178     setModified( true );
00179     notifyIncidenceDeleted( todo );
00180     mDeletedIncidences.append( todo );
00181     return true;
00182   } else {
00183     kdWarning() << "CalendarLocal::deleteTodo(): Todo not found." << endl;
00184     return false;
00185   }
00186 }
00187 
00188 void CalendarLocal::deleteAllTodos()
00189 {
00190   // kdDebug(5800) << "CalendarLocal::deleteAllTodos()\n";
00191   Todo::List::ConstIterator it;
00192   for( it = mTodoList.begin(); it != mTodoList.end(); ++it ) {
00193     notifyIncidenceDeleted( *it );
00194   }
00195 
00196   mTodoList.setAutoDelete( true );
00197   mTodoList.clear();
00198   mTodoList.setAutoDelete( false );
00199 }
00200 
00201 Todo::List CalendarLocal::rawTodos( TodoSortField sortField,
00202                                     SortDirection sortDirection )
00203 {
00204   return sortTodos( &mTodoList, sortField, sortDirection );
00205 }
00206 
00207 Todo *CalendarLocal::todo( const QString &uid )
00208 {
00209   Todo::List::ConstIterator it;
00210   for ( it = mTodoList.begin(); it != mTodoList.end(); ++it ) {
00211     if ( (*it)->uid() == uid ) return *it;
00212   }
00213 
00214   return 0;
00215 }
00216 
00217 Todo::List CalendarLocal::rawTodosForDate( const QDate &date )
00218 {
00219   Todo::List todos;
00220 
00221   Todo::List::ConstIterator it;
00222   for ( it = mTodoList.begin(); it != mTodoList.end(); ++it ) {
00223     Todo *todo = *it;
00224     if ( todo->hasDueDate() && todo->dtDue().date() == date ) {
00225       todos.append( todo );
00226     }
00227   }
00228 
00229   return todos;
00230 }
00231 
00232 Alarm::List CalendarLocal::alarmsTo( const QDateTime &to )
00233 {
00234   return alarms( QDateTime( QDate( 1900, 1, 1 ) ), to );
00235 }
00236 
00237 Alarm::List CalendarLocal::alarms( const QDateTime &from, const QDateTime &to )
00238 {
00239 //  kdDebug(5800) << "CalendarLocal::alarms(" << from.toString() << " - "
00240 //                << to.toString() << ")" << endl;
00241 
00242   Alarm::List alarms;
00243 
00244   EventDictIterator it( mEvents );
00245   for( ; it.current(); ++it ) {
00246     Event *e = *it;
00247     if ( e->doesRecur() ) appendRecurringAlarms( alarms, e, from, to );
00248     else appendAlarms( alarms, e, from, to );
00249   }
00250 
00251   Todo::List::ConstIterator it2;
00252   for( it2 = mTodoList.begin(); it2 != mTodoList.end(); ++it2 ) {
00253     if (! (*it2)->isCompleted() ) appendAlarms( alarms, *it2, from, to );
00254   }
00255 
00256   return alarms;
00257 }
00258 
00259 void CalendarLocal::appendAlarms( Alarm::List &alarms, Incidence *incidence,
00260                                   const QDateTime &from, const QDateTime &to )
00261 {
00262   QDateTime preTime = from.addSecs(-1);
00263   Alarm::List::ConstIterator it;
00264   for( it = incidence->alarms().begin(); it != incidence->alarms().end();
00265        ++it ) {
00266     if ( (*it)->enabled() ) {
00267       QDateTime dt = (*it)->nextRepetition(preTime);
00268       if ( dt.isValid() && dt <= to ) {
00269         kdDebug(5800) << "CalendarLocal::appendAlarms() '"
00270                       << incidence->summary() << "': "
00271                       << dt.toString() << endl;
00272         alarms.append( *it );
00273       }
00274     }
00275   }
00276 }
00277 
00278 void CalendarLocal::appendRecurringAlarms( Alarm::List &alarms,
00279                                            Incidence *incidence,
00280                                            const QDateTime &from,
00281                                            const QDateTime &to )
00282 {
00283   QDateTime qdt;
00284   int  endOffset = 0;
00285   bool endOffsetValid = false;
00286   int  period = from.secsTo(to);
00287   Alarm::List::ConstIterator it;
00288   for( it = incidence->alarms().begin(); it != incidence->alarms().end();
00289        ++it ) {
00290     Alarm *alarm = *it;
00291     if ( alarm->enabled() ) {
00292       if ( alarm->hasTime() ) {
00293         // The alarm time is defined as an absolute date/time
00294         qdt = alarm->nextRepetition( from.addSecs(-1) );
00295         if ( !qdt.isValid() || qdt > to )
00296           continue;
00297       } else {
00298         // The alarm time is defined by an offset from the event start or end time.
00299         // Find the offset from the event start time, which is also used as the
00300         // offset from the recurrence time.
00301         int offset = 0;
00302         if ( alarm->hasStartOffset() ) {
00303           offset = alarm->startOffset().asSeconds();
00304         } else if ( alarm->hasEndOffset() ) {
00305           if ( !endOffsetValid ) {
00306             endOffset = incidence->dtStart().secsTo( incidence->dtEnd() );
00307             endOffsetValid = true;
00308           }
00309           offset = alarm->endOffset().asSeconds() + endOffset;
00310         }
00311 
00312         // Adjust the 'from' date/time and find the next recurrence at or after it
00313         qdt = incidence->recurrence()->getNextDateTime( from.addSecs(-offset - 1) );
00314         if ( !qdt.isValid()
00315         ||   (qdt = qdt.addSecs( offset )) > to )    // remove the adjustment to get the alarm time
00316         {
00317           // The next recurrence is too late.
00318           if ( !alarm->repeatCount() )
00319             continue;
00320           // The alarm has repetitions, so check whether repetitions of previous
00321           // recurrences fall within the time period.
00322           bool found = false;
00323           qdt = from.addSecs( -offset );
00324           while ( (qdt = incidence->recurrence()->getPreviousDateTime( qdt )).isValid() ) {
00325             int toFrom = qdt.secsTo( from ) - offset;
00326             if ( toFrom > alarm->duration() )
00327               break;     // this recurrence's last repetition is too early, so give up
00328             // The last repetition of this recurrence is at or after 'from' time.
00329             // Check if a repetition occurs between 'from' and 'to'.
00330             int snooze = alarm->snoozeTime() * 60;   // in seconds
00331             if ( period >= snooze
00332             ||   toFrom % snooze == 0
00333             ||   (toFrom / snooze + 1) * snooze <= toFrom + period ) {
00334               found = true;
00335 #ifndef NDEBUG
00336               qdt = qdt.addSecs( offset + ((toFrom-1) / snooze + 1) * snooze );   // for debug output
00337 #endif
00338               break;
00339             }
00340           }
00341           if ( !found )
00342             continue;
00343         }
00344       }
00345       kdDebug(5800) << "CalendarLocal::appendAlarms() '" << incidence->summary()
00346                     << "': " << qdt.toString() << endl;
00347       alarms.append( alarm );
00348     }
00349   }
00350 }
00351 
00352 
00353 void CalendarLocal::insertEvent( Event *event )
00354 {
00355   QString uid = event->uid();
00356   if ( mEvents[ uid ] == 0 ) {
00357     mEvents.insert( uid, event );
00358   }
00359 #ifndef NDEBUG
00360   else // if we already have an event with this UID, it has to be the same event,
00361       // otherwise something's really broken
00362       Q_ASSERT( mEvents[uid] == event );
00363 #endif
00364 }
00365 
00366 Event::List CalendarLocal::rawEventsForDate( const QDate &qd,
00367                                              EventSortField sortField,
00368                                              SortDirection sortDirection )
00369 {
00370   Event::List eventList;
00371 
00372   EventDictIterator it( mEvents );
00373   for( ; it.current(); ++it ) {
00374     Event *event = *it;
00375 
00376     if ( event->doesRecur() ) {
00377       if ( event->isMultiDay() ) {
00378         int extraDays = event->dtStart().date().daysTo( event->dtEnd().date() );
00379         int i;
00380         for ( i = 0; i <= extraDays; i++ ) {
00381           if ( event->recursOn( qd.addDays( -i ) ) ) {
00382             eventList.append( event );
00383             break;
00384           }
00385         }
00386       } else {
00387         if ( event->recursOn( qd ) )
00388           eventList.append( event );
00389       }
00390     } else {
00391       if ( event->dtStart().date() <= qd && event->dateEnd() >= qd ) {
00392         eventList.append( event );
00393       }
00394     }
00395   }
00396 
00397   return sortEvents( &eventList, sortField, sortDirection );
00398 }
00399 
00400 Event::List CalendarLocal::rawEvents( const QDate &start, const QDate &end,
00401                                           bool inclusive )
00402 {
00403   Event::List eventList;
00404 
00405   // Get non-recurring events
00406   EventDictIterator it( mEvents );
00407   for( ; it.current(); ++it ) {
00408     Event *event = *it;
00409     if ( event->doesRecur() ) {
00410       QDate rStart = event->dtStart().date();
00411       bool found = false;
00412       if ( inclusive ) {
00413         if ( rStart >= start && rStart <= end ) {
00414           // Start date of event is in range. Now check for end date.
00415           // if duration is negative, event recurs forever, so do not include it.
00416           if ( event->recurrence()->duration() == 0 ) {  // End date set
00417             QDate rEnd = event->recurrence()->endDate();
00418             if ( rEnd >= start && rEnd <= end ) {  // End date within range
00419               found = true;
00420             }
00421           } else if ( event->recurrence()->duration() > 0 ) {  // Duration set
00422             // TODO: Calculate end date from duration. Should be done in Event
00423             // For now exclude all events with a duration.
00424           }
00425         }
00426       } else {
00427         if ( rStart <= end ) {  // Start date not after range
00428           if ( rStart >= start ) {  // Start date within range
00429             found = true;
00430           } else if ( event->recurrence()->duration() == -1 ) {  // Recurs forever
00431             found = true;
00432           } else if ( event->recurrence()->duration() == 0 ) {  // End date set
00433             QDate rEnd = event->recurrence()->endDate();
00434             if ( rEnd >= start && rEnd <= end ) {  // End date within range
00435               found = true;
00436             }
00437           } else {  // Duration set
00438             // TODO: Calculate end date from duration. Should be done in Event
00439             // For now include all events with a duration.
00440             found = true;
00441           }
00442         }
00443       }
00444 
00445       if ( found ) eventList.append( event );
00446     } else {
00447       QDate s = event->dtStart().date();
00448       QDate e = event->dtEnd().date();
00449 
00450       if ( inclusive ) {
00451         if ( s >= start && e <= end ) {
00452           eventList.append( event );
00453         }
00454       } else {
00455         if ( s <= end && e >= start ) {
00456           eventList.append( event );
00457         }
00458       }
00459     }
00460   }
00461 
00462   return eventList;
00463 }
00464 
00465 Event::List CalendarLocal::rawEventsForDate( const QDateTime &qdt )
00466 {
00467   return rawEventsForDate( qdt.date() );
00468 }
00469 
00470 Event::List CalendarLocal::rawEvents( EventSortField sortField, SortDirection sortDirection )
00471 {
00472   Event::List eventList;
00473   EventDictIterator it( mEvents );
00474   for( ; it.current(); ++it )
00475     eventList.append( *it );
00476   return sortEvents( &eventList, sortField, sortDirection );
00477 }
00478 
00479 bool CalendarLocal::addJournal(Journal *journal)
00480 {
00481 //   if (journal->dtStart().isValid())
00482 //     kdDebug(5800) << "Adding Journal on " << journal->dtStart().toString() << endl;
00483 //   else
00484 //     kdDebug(5800) << "Adding Journal without a DTSTART" << endl;
00485 
00486   mJournalList.append(journal);
00487 
00488   journal->registerObserver( this );
00489 
00490   setModified( true );
00491 
00492   notifyIncidenceAdded( journal );
00493 
00494   return true;
00495 }
00496 
00497 bool CalendarLocal::deleteJournal( Journal *journal )
00498 {
00499   if ( mJournalList.removeRef( journal ) ) {
00500     setModified( true );
00501     notifyIncidenceDeleted( journal );
00502     mDeletedIncidences.append( journal );
00503     return true;
00504   } else {
00505     kdWarning() << "CalendarLocal::deleteJournal(): Journal not found." << endl;
00506     return false;
00507   }
00508 }
00509 
00510 void CalendarLocal::deleteAllJournals()
00511 {
00512   Journal::List::ConstIterator it;
00513   for( it = mJournalList.begin(); it != mJournalList.end(); ++it ) {
00514     notifyIncidenceDeleted( *it );
00515   }
00516 
00517   mJournalList.setAutoDelete( true );
00518   mJournalList.clear();
00519   mJournalList.setAutoDelete( false );
00520 }
00521 
00522 Journal *CalendarLocal::journal( const QString &uid )
00523 {
00524   Journal::List::ConstIterator it;
00525   for ( it = mJournalList.begin(); it != mJournalList.end(); ++it )
00526     if ( (*it)->uid() == uid )
00527       return *it;
00528 
00529   return 0;
00530 }
00531 
00532 Journal::List CalendarLocal::rawJournals( JournalSortField sortField, SortDirection sortDirection )
00533 {
00534   return sortJournals( &mJournalList, sortField, sortDirection );
00535 }
00536 
00537 Journal::List CalendarLocal::rawJournalsForDate( const QDate &date )
00538 {
00539   Journal::List journals;
00540 
00541   Journal::List::ConstIterator it;
00542   for ( it = mJournalList.begin(); it != mJournalList.end(); ++it ) {
00543     Journal *journal = *it;
00544     if ( journal->dtStart().date() == date ) {
00545       journals.append( journal );
00546     }
00547   }
00548 
00549   return journals;
00550 }
00551 
00552 void CalendarLocal::setTimeZoneIdViewOnly( const QString& tz )
00553 {
00554   const QString question( i18n("The timezone setting was changed. In order to display the calendar "
00555       "you are looking at in the new timezone, it needs to be saved. Do you want to save the pending "
00556       "changes or rather wait and apply the new timezone on the next reload?" ) );
00557   int rc = KMessageBox::Yes;
00558   if ( isModified() ) {
00559     rc = KMessageBox::questionYesNo( 0, question,
00560                                        i18n("Save before applying timezones?"),
00561                                        KStdGuiItem::save(),
00562                                        KGuiItem(i18n("Apply Timezone Change on Next Reload")),
00563                                        "calendarLocalSaveBeforeTimezoneShift");
00564   }
00565   if ( rc == KMessageBox::Yes ) {
00566     reload( tz );
00567   }
00568 }
KDE Home | KDE Accessibility Home | Description of Access Keys