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.clearAll();
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     Todo *t = *it2;
00254     if ( t->isCompleted() ) {
00255       continue;
00256     }
00257     if ( t->doesRecur() ) appendRecurringAlarms( alarms, t, from, to );
00258     else appendAlarms( alarms, t, from, to );
00259   }
00260 
00261   return alarms;
00262 }
00263 
00264 void CalendarLocal::appendAlarms( Alarm::List &alarms, Incidence *incidence,
00265                                   const QDateTime &from, const QDateTime &to )
00266 {
00267   QDateTime preTime = from.addSecs(-1);
00268   Alarm::List::ConstIterator it;
00269   for( it = incidence->alarms().begin(); it != incidence->alarms().end();
00270        ++it ) {
00271     Alarm *alarm = *it;
00272     if ( alarm->enabled() ) {
00273       QDateTime dt = alarm->nextRepetition( preTime );
00274       if ( dt.isValid() && dt <= to ) {
00275         kdDebug(5800) << "CalendarLocal::appendAlarms() '"
00276                       << incidence->summary() << "': "
00277                       << dt.toString() << endl;
00278         alarms.append( alarm );
00279       }
00280     }
00281   }
00282 }
00283 
00284 void CalendarLocal::appendRecurringAlarms( Alarm::List &alarms,
00285                                            Incidence *incidence,
00286                                            const QDateTime &from,
00287                                            const QDateTime &to )
00288 {
00289   QDateTime dt;
00290   Duration endOffset( 0 );
00291   bool endOffsetValid = false;
00292   Duration period( from, to );
00293 
00294   Event *e = static_cast<Event *>( incidence );
00295   Todo *t = static_cast<Todo *>( incidence );
00296 
00297   Alarm::List::ConstIterator it;
00298   for( it = incidence->alarms().begin(); it != incidence->alarms().end();
00299        ++it ) {
00300     Alarm *alarm = *it;
00301     if ( alarm->enabled() ) {
00302       if ( alarm->hasTime() ) {
00303         // The alarm time is defined as an absolute date/time
00304         dt = alarm->nextRepetition( from.addSecs(-1) );
00305         if ( !dt.isValid() || dt > to ) {
00306           continue;
00307         }
00308       } else {
00309         // Alarm time is defined by an offset from the event start or end time.
00310         // Find the offset from the event start time, which is also used as the
00311         // offset from the recurrence time.
00312         Duration offset( 0 );
00313         if ( alarm->hasStartOffset() ) {
00314           offset = alarm->startOffset().asSeconds();
00315         } else if ( alarm->hasEndOffset() ) {
00316           offset = alarm->endOffset().asSeconds();
00317           if ( !endOffsetValid ) {
00318             if ( incidence->type() == "Event" ) {
00319               endOffset = Duration( e->dtStart(), e->dtEnd() );
00320               endOffsetValid = true;
00321             } else if ( incidence->type() == "Todo" &&
00322                         t->hasStartDate() && t->hasDueDate() ) {
00323               endOffset = Duration( t->dtStart(), t->dtDue() );
00324               endOffsetValid = true;
00325             }
00326           }
00327         }
00328 
00329         // Find the incidence's earliest alarm
00330         QDateTime alarmStart;
00331         if ( incidence->type() == "Event" ) {
00332           alarmStart =
00333             offset.end( alarm->hasEndOffset() ? e->dtEnd() : e->dtStart() );
00334         } else if ( incidence->type() == "Todo" ) {
00335           alarmStart =
00336             offset.end( alarm->hasEndOffset() ? t->dtDue() : t->dtStart() );
00337         }
00338 
00339         if ( alarmStart.isValid() && alarmStart > to ) {
00340           continue;
00341         }
00342 
00343         QDateTime baseStart;
00344         if ( incidence->type() == "Event" ) {
00345           baseStart = e->dtStart();
00346         } else if ( incidence->type() == "Todo" ) {
00347           baseStart = t->dtDue();
00348         }
00349         if ( alarmStart.isValid() && from > alarmStart ) {
00350           alarmStart = from;   // don't look earlier than the earliest alarm
00351           baseStart = (-offset).end( (-endOffset).end( alarmStart ) );
00352         }
00353 
00354         // Adjust the 'alarmStart' date/time and find the next recurrence
00355         // at or after it. Treat the two offsets separately in case one
00356         // is daily and the other not.
00357         dt = incidence->recurrence()->getNextDateTime( baseStart.addSecs(-1) );
00358         if ( !dt.isValid() ||
00359              ( dt = endOffset.end( offset.end( dt ) ) ) > to ) // adjust 'dt' to get the alarm time
00360         {
00361           // The next recurrence is too late.
00362           if ( !alarm->repeatCount() ) {
00363             continue;
00364           }
00365 
00366           // The alarm has repetitions, so check whether repetitions of
00367           // previous recurrences fall within the time period.
00368           bool found = false;
00369           Duration alarmDuration = alarm->duration();
00370           for ( QDateTime base = baseStart;
00371                 ( dt = incidence->recurrence()->getPreviousDateTime( base ) ).isValid();
00372                 base = dt ) {
00373             if ( alarm->duration().end( dt ) < base ) {
00374               break;  // recurrence's last repetition is too early, so give up
00375             }
00376 
00377             // The last repetition of this recurrence is on or after
00378             // 'alarmStart' time. Check if a repetition occurs between
00379             // 'alarmStart' and 'to'.
00380             int snooze = alarm->snoozeTime().value();   // in seconds or days
00381             if ( alarm->snoozeTime().isDaily() ) {
00382               Duration toFromDuration( dt, base );
00383               int toFrom = toFromDuration.asDays();
00384               if ( alarm->snoozeTime().end( from ) <= to ||
00385                    ( toFromDuration.isDaily() && toFrom % snooze == 0 ) ||
00386                    ( toFrom / snooze + 1 ) * snooze <= toFrom + period.asDays() ) {
00387                 found = true;
00388 #ifndef NDEBUG
00389                 // for debug output
00390                 dt = offset.end( dt ).addDays( ( ( toFrom - 1 ) / snooze + 1 ) * snooze );
00391 #endif
00392                 break;
00393               }
00394             } else {
00395               int toFrom = dt.secsTo( base );
00396               if ( period.asSeconds() >= snooze ||
00397                    toFrom % snooze == 0 ||
00398                    ( toFrom / snooze + 1 ) * snooze <= toFrom + period.asSeconds() )
00399               {
00400                 found = true;
00401 #ifndef NDEBUG
00402                 // for debug output
00403                 dt = offset.end( dt ).addSecs( ( ( toFrom - 1 ) / snooze + 1 ) * snooze );
00404 #endif
00405                 break;
00406               }
00407             }
00408           }
00409           if ( !found ) {
00410             continue;
00411           }
00412         }
00413       }
00414       kdDebug(5800) << "CalendarLocal::appendAlarms() '" << incidence->summary()
00415                     << "': " << dt.toString() << endl;
00416       alarms.append( alarm );
00417     }
00418   }
00419 }
00420 
00421 
00422 void CalendarLocal::incidenceUpdated( IncidenceBase *incidence )
00423 {
00424   incidence->setSyncStatusSilent( Event::SYNCMOD );
00425   incidence->setLastModified( QDateTime::currentDateTime() );
00426   // we should probably update the revision number here,
00427   // or internally in the Event itself when certain things change.
00428   // need to verify with ical documentation.
00429 
00430   // The static_cast is ok as the CalendarLocal only observes Incidence objects
00431   notifyIncidenceChanged( static_cast<Incidence *>( incidence ) );
00432 
00433   setModified( true );
00434 }
00435 
00436 void CalendarLocal::insertEvent( Event *event )
00437 {
00438   QString uid = event->uid();
00439   if ( mEvents[ uid ] == 0 ) {
00440     mEvents.insert( uid, event );
00441   }
00442 #ifndef NDEBUG
00443   else // if we already have an event with this UID, it has to be the same event,
00444       // otherwise something's really broken
00445       Q_ASSERT( mEvents[uid] == event );
00446 #endif
00447 }
00448 
00449 Event::List CalendarLocal::rawEventsForDate( const QDate &qd,
00450                                              EventSortField sortField,
00451                                              SortDirection sortDirection )
00452 {
00453   Event::List eventList;
00454 
00455   // Don't check for events on invalid dates
00456   // Fix for issue4850
00457   if ( !qd.isValid() ) {
00458     return eventList;
00459   }
00460 
00461   EventDictIterator it( mEvents );
00462   for( ; it.current(); ++it ) {
00463     Event *event = *it;
00464 
00465     if ( event->doesRecur() ) {
00466       if ( event->isMultiDay() ) {
00467         int extraDays = event->dtStart().date().daysTo( event->dtEnd().date() );
00468         int i;
00469         for ( i = 0; i <= extraDays; i++ ) {
00470           if ( event->recursOn( qd.addDays( -i ) ) ) {
00471             eventList.append( event );
00472             break;
00473           }
00474         }
00475       } else {
00476         if ( event->recursOn( qd ) )
00477           eventList.append( event );
00478       }
00479     } else {
00480       if ( event->dtStart().date() <= qd && event->dateEnd() >= qd ) {
00481         eventList.append( event );
00482       }
00483     }
00484   }
00485 
00486   return sortEventsForDate( &eventList, qd, sortField, sortDirection );
00487 }
00488 
00489 Event::List CalendarLocal::rawEvents( const QDate &start, const QDate &end,
00490                                           bool inclusive )
00491 {
00492   Event::List eventList;
00493   QDate yesterStart = start.addDays(-1);
00494 
00495   // Get non-recurring events
00496   EventDictIterator it( mEvents );
00497   for( ; it.current(); ++it ) {
00498     Event *event = *it;
00499 
00500     QDate rStart = event->dtStart().date();
00501     if (end < rStart) {
00502 //      kdDebug(5800) << "Skipping event starting after TOI" << endl;
00503       continue;
00504     }
00505     if ( inclusive && rStart < start) {
00506 //      kdDebug(5800) << "Skipping event starting before TOI while inclusive" << endl;
00507       continue;
00508     }
00509 
00510     if ( ! event->doesRecur() ) { // non-recurring events
00511       QDate rEnd = event->dtEnd().date();
00512       if (rEnd < start) {
00513 //        kdDebug(5800) << "Skipping event ending before TOI" << endl;
00514         continue;
00515       }
00516       if ( inclusive && end < rEnd ) {
00517 //        kdDebug(5800) << "Skipping event ending after TOI while inclusive" << endl;
00518         continue;
00519       }
00520     } else { // recurring events
00521       switch ( event->recurrence()->duration() ) {
00522         case -1: // infinite
00523           if ( inclusive ) {
00524 //            kdDebug(5800) << "Skipping infinite event because inclusive" << endl;
00525             continue;
00526           }
00527           break;
00528         case 0: // end date given
00529         default: // count given
00530           QDate rEnd = event->recurrence()->endDate();
00531           if ( ! rEnd.isValid() ) {
00532 //            kdDebug(5800) << "Skipping recurring event without occurences" << endl;
00533             continue;
00534           }
00535           if ( rEnd < start ) {
00536 //            kdDebug(5800) << "Skipping recurring event ending before TOI" << endl;
00537             continue;
00538           }
00539           if ( inclusive && end < rEnd ) {
00540 //            kdDebug(5800) << "Skipping recurring event ending after TOI while inclusive" << endl;
00541             continue;
00542           }
00543           /* FIXME: too much conversion between QDate and QDateTime makes this useless:
00544            *   freebusy(end=QDateTime(day, "00:00:00")) ->
00545            *   rawEvents(end=QDate(day)) ->
00546            *   durationTo(QDateTime(day, "23:59:59"))
00547            * so events repeating at the end day match and are included.
00548            */
00549 #if 0
00550           int durationBeforeStart = event->recurrence()->durationTo(yesterStart);
00551           int durationUntilEnd = event->recurrence()->durationTo(end);
00552           if (durationBeforeStart == durationUntilEnd) {
00553             kdDebug(5800) << "Skipping recurring event without occurences in TOI" << endl;
00554             continue;
00555           }
00556 #endif
00557           break;
00558       } // switch(duration)
00559     } // if(doesRecur)
00560 
00561     eventList.append( event );
00562   }
00563 
00564   return eventList;
00565 }
00566 
00567 Event::List CalendarLocal::rawEventsForDate( const QDateTime &qdt )
00568 {
00569   return rawEventsForDate( qdt.date() );
00570 }
00571 
00572 Event::List CalendarLocal::rawEvents( EventSortField sortField, SortDirection sortDirection )
00573 {
00574   Event::List eventList;
00575   EventDictIterator it( mEvents );
00576   for( ; it.current(); ++it )
00577     eventList.append( *it );
00578   return sortEvents( &eventList, sortField, sortDirection );
00579 }
00580 
00581 bool CalendarLocal::addJournal(Journal *journal)
00582 {
00583 //   if (journal->dtStart().isValid())
00584 //     kdDebug(5800) << "Adding Journal on " << journal->dtStart().toString() << endl;
00585 //   else
00586 //     kdDebug(5800) << "Adding Journal without a DTSTART" << endl;
00587 
00588   mJournalList.append(journal);
00589 
00590   journal->registerObserver( this );
00591 
00592   setModified( true );
00593 
00594   notifyIncidenceAdded( journal );
00595 
00596   return true;
00597 }
00598 
00599 bool CalendarLocal::deleteJournal( Journal *journal )
00600 {
00601   if ( mJournalList.removeRef( journal ) ) {
00602     setModified( true );
00603     notifyIncidenceDeleted( journal );
00604     mDeletedIncidences.append( journal );
00605     return true;
00606   } else {
00607     kdWarning() << "CalendarLocal::deleteJournal(): Journal not found." << endl;
00608     return false;
00609   }
00610 }
00611 
00612 void CalendarLocal::deleteAllJournals()
00613 {
00614   Journal::List::ConstIterator it;
00615   for( it = mJournalList.begin(); it != mJournalList.end(); ++it ) {
00616     notifyIncidenceDeleted( *it );
00617   }
00618 
00619   mJournalList.setAutoDelete( true );
00620   mJournalList.clearAll();
00621   mJournalList.setAutoDelete( false );
00622 }
00623 
00624 Journal *CalendarLocal::journal( const QString &uid )
00625 {
00626   Journal::List::ConstIterator it;
00627   for ( it = mJournalList.begin(); it != mJournalList.end(); ++it )
00628     if ( (*it)->uid() == uid )
00629       return *it;
00630 
00631   return 0;
00632 }
00633 
00634 Journal::List CalendarLocal::rawJournals( JournalSortField sortField, SortDirection sortDirection )
00635 {
00636   return sortJournals( &mJournalList, sortField, sortDirection );
00637 }
00638 
00639 Journal::List CalendarLocal::rawJournalsForDate( const QDate &date )
00640 {
00641   Journal::List journals;
00642 
00643   Journal::List::ConstIterator it;
00644   for ( it = mJournalList.begin(); it != mJournalList.end(); ++it ) {
00645     Journal *journal = *it;
00646     if ( journal->dtStart().date() == date ) {
00647       journals.append( journal );
00648     }
00649   }
00650 
00651   return journals;
00652 }
00653 
00654 void CalendarLocal::setTimeZoneIdViewOnly( const QString& tz )
00655 {
00656   const QString question( i18n("The timezone setting was changed. In order to display the calendar "
00657       "you are looking at in the new timezone, it needs to be saved. Do you want to save the pending "
00658       "changes or rather wait and apply the new timezone on the next reload?" ) );
00659   int rc = KMessageBox::Yes;
00660   if ( isModified() ) {
00661     rc = KMessageBox::questionYesNo( 0, question,
00662                                        i18n("Save before applying timezones?"),
00663                                        KStdGuiItem::save(),
00664                                        KGuiItem(i18n("Apply Timezone Change on Next Reload")),
00665                                        "calendarLocalSaveBeforeTimezoneShift");
00666   }
00667   if ( rc == KMessageBox::Yes ) {
00668     reload( tz );
00669   }
00670 }
KDE Home | KDE Accessibility Home | Description of Access Keys