kalarm

kalarmapp.cpp

00001 /*
00002  *  kalarmapp.cpp  -  the KAlarm application object
00003  *  Program:  kalarm
00004  *  Copyright © 2001-2007 by David Jarvie <software@astrojar.org.uk>
00005  *
00006  *  This program is free software; you can redistribute it and/or modify
00007  *  it under the terms of the GNU General Public License as published by
00008  *  the Free Software Foundation; either version 2 of the License, or
00009  *  (at your option) any later version.
00010  *
00011  *  This program is distributed in the hope that it will be useful,
00012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00014  *  GNU General Public License for more details.
00015  *
00016  *  You should have received a copy of the GNU General Public License along
00017  *  with this program; if not, write to the Free Software Foundation, Inc.,
00018  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00019  */
00020 
00021 #include "kalarm.h"
00022 
00023 #include <stdlib.h>
00024 #include <ctype.h>
00025 #include <iostream>
00026 
00027 #include <qobjectlist.h>
00028 #include <qtimer.h>
00029 #include <qregexp.h>
00030 #include <qfile.h>
00031 
00032 #include <kcmdlineargs.h>
00033 #include <klocale.h>
00034 #include <kstandarddirs.h>
00035 #include <kconfig.h>
00036 #include <kaboutdata.h>
00037 #include <dcopclient.h>
00038 #include <kprocess.h>
00039 #include <ktempfile.h>
00040 #include <kfileitem.h>
00041 #include <kstdguiitem.h>
00042 #include <ktrader.h>
00043 #include <kstaticdeleter.h>
00044 #include <kdebug.h>
00045 
00046 #include <libkcal/calformat.h>
00047 
00048 #include <kalarmd/clientinfo.h>
00049 
00050 #include "alarmcalendar.h"
00051 #include "alarmlistview.h"
00052 #include "editdlg.h"
00053 #include "daemon.h"
00054 #include "dcophandler.h"
00055 #include "functions.h"
00056 #include "kamail.h"
00057 #include "karecurrence.h"
00058 #include "mainwindow.h"
00059 #include "messagebox.h"
00060 #include "messagewin.h"
00061 #include "preferences.h"
00062 #include "prefdlg.h"
00063 #include "shellprocess.h"
00064 #include "traywindow.h"
00065 #include "kalarmapp.moc"
00066 
00067 #include <netwm.h>
00068 
00069 
00070 static bool convWakeTime(const QCString& timeParam, QDateTime&, bool& noTime);
00071 static bool convInterval(const QCString& timeParam, KARecurrence::Type&, int& timeInterval, bool allowMonthYear = true);
00072 
00073 /******************************************************************************
00074 * Find the maximum number of seconds late which a late-cancel alarm is allowed
00075 * to be. This is calculated as the alarm daemon's check interval, plus a few
00076 * seconds leeway to cater for any timing irregularities.
00077 */
00078 static inline int maxLateness(int lateCancel)
00079 {
00080     static const int LATENESS_LEEWAY = 5;
00081     int lc = (lateCancel >= 1) ? (lateCancel - 1)*60 : 0;
00082     return Daemon::maxTimeSinceCheck() + LATENESS_LEEWAY + lc;
00083 }
00084 
00085 
00086 KAlarmApp*  KAlarmApp::theInstance  = 0;
00087 int         KAlarmApp::mActiveCount = 0;
00088 int         KAlarmApp::mFatalError  = 0;
00089 QString     KAlarmApp::mFatalMessage;
00090 
00091 
00092 /******************************************************************************
00093 * Construct the application.
00094 */
00095 KAlarmApp::KAlarmApp()
00096     : KUniqueApplication(),
00097       mInitialised(false),
00098       mDcopHandler(new DcopHandler()),
00099 #ifdef OLD_DCOP
00100       mDcopHandlerOld(new DcopHandlerOld()),
00101 #endif
00102       mTrayWindow(0),
00103       mPendingQuit(false),
00104       mProcessingQueue(false),
00105       mCheckingSystemTray(false),
00106       mSessionClosingDown(false),
00107       mRefreshExpiredAlarms(false),
00108       mSpeechEnabled(false)
00109 {
00110     Preferences::initialise();
00111     Preferences::connect(SIGNAL(preferencesChanged()), this, SLOT(slotPreferencesChanged()));
00112     KCal::CalFormat::setApplication(aboutData()->programName(), AlarmCalendar::icalProductId());
00113     KARecurrence::setDefaultFeb29Type(Preferences::defaultFeb29Type());
00114 
00115     // Check if the system tray is supported by this window manager
00116     mHaveSystemTray = true;   // assume yes in lieu of a test which works
00117 
00118     if (AlarmCalendar::initialiseCalendars())
00119     {
00120         connect(AlarmCalendar::expiredCalendar(), SIGNAL(purged()), SLOT(slotExpiredPurged()));
00121 
00122         KConfig* config = kapp->config();
00123         config->setGroup(QString::fromLatin1("General"));
00124         mNoSystemTray           = config->readBoolEntry(QString::fromLatin1("NoSystemTray"), false);
00125         mSavedNoSystemTray      = mNoSystemTray;
00126         mOldRunInSystemTray     = wantRunInSystemTray();
00127         mDisableAlarmsIfStopped = mOldRunInSystemTray && !mNoSystemTray && Preferences::disableAlarmsIfStopped();
00128         mStartOfDay             = Preferences::startOfDay();
00129         if (Preferences::hasStartOfDayChanged())
00130             mStartOfDay.setHMS(100,0,0);    // start of day time has changed: flag it as invalid
00131         DateTime::setStartOfDay(mStartOfDay);
00132         mPrefsExpiredColour   = Preferences::expiredColour();
00133         mPrefsExpiredKeepDays = Preferences::expiredKeepDays();
00134         mPrefsShowTime        = Preferences::showAlarmTime();
00135         mPrefsShowTimeTo      = Preferences::showTimeToAlarm();
00136     }
00137 
00138     // Check if the speech synthesis daemon is installed
00139     mSpeechEnabled = (KTrader::self()->query("DCOP/Text-to-Speech", "Name == 'KTTSD'").count() > 0);
00140     if (!mSpeechEnabled)
00141         kdDebug(5950) << "KAlarmApp::KAlarmApp(): speech synthesis disabled (KTTSD not found)" << endl;
00142     // Check if KOrganizer is installed
00143     QString korg = QString::fromLatin1("korganizer");
00144     mKOrganizerEnabled = !locate("exe", korg).isNull()  ||  !KStandardDirs::findExe(korg).isNull();
00145     if (!mKOrganizerEnabled)
00146         kdDebug(5950) << "KAlarmApp::KAlarmApp(): KOrganizer options disabled (KOrganizer not found)" << endl;
00147 }
00148 
00149 /******************************************************************************
00150 */
00151 KAlarmApp::~KAlarmApp()
00152 {
00153     while (!mCommandProcesses.isEmpty())
00154     {
00155         ProcData* pd = mCommandProcesses.first();
00156         mCommandProcesses.pop_front();
00157         delete pd;
00158     }
00159     AlarmCalendar::terminateCalendars();
00160 }
00161 
00162 /******************************************************************************
00163 * Return the one and only KAlarmApp instance.
00164 * If it doesn't already exist, it is created first.
00165 */
00166 KAlarmApp* KAlarmApp::getInstance()
00167 {
00168     if (!theInstance)
00169     {
00170         theInstance = new KAlarmApp;
00171 
00172         if (mFatalError)
00173             theInstance->quitFatal();
00174         else
00175         {
00176             // This is here instead of in the constructor to avoid recursion
00177             Daemon::initialise();    // calendars must be initialised before calling this
00178         }
00179     }
00180     return theInstance;
00181 }
00182 
00183 /******************************************************************************
00184 * Restore the saved session if required.
00185 */
00186 bool KAlarmApp::restoreSession()
00187 {
00188     if (!isRestored())
00189         return false;
00190     if (mFatalError)
00191     {
00192         quitFatal();
00193         return false;
00194     }
00195 
00196     // Process is being restored by session management.
00197     kdDebug(5950) << "KAlarmApp::restoreSession(): Restoring\n";
00198     ++mActiveCount;
00199     if (!initCheck(true))     // open the calendar file (needed for main windows)
00200     {
00201         --mActiveCount;
00202         quitIf(1, true);    // error opening the main calendar - quit
00203         return true;
00204     }
00205     MainWindow* trayParent = 0;
00206     for (int i = 1;  KMainWindow::canBeRestored(i);  ++i)
00207     {
00208         QString type = KMainWindow::classNameOfToplevel(i);
00209         if (type == QString::fromLatin1("MainWindow"))
00210         {
00211             MainWindow* win = MainWindow::create(true);
00212             win->restore(i, false);
00213             if (win->isHiddenTrayParent())
00214                 trayParent = win;
00215             else
00216                 win->show();
00217         }
00218         else if (type == QString::fromLatin1("MessageWin"))
00219         {
00220             MessageWin* win = new MessageWin;
00221             win->restore(i, false);
00222             if (win->isValid())
00223                 win->show();
00224             else
00225                 delete win;
00226         }
00227     }
00228     initCheck();           // register with the alarm daemon
00229 
00230     // Try to display the system tray icon if it is configured to be autostarted,
00231     // or if we're in run-in-system-tray mode.
00232     if (Preferences::autostartTrayIcon()
00233     ||  MainWindow::count()  &&  wantRunInSystemTray())
00234     {
00235         displayTrayIcon(true, trayParent);
00236         // Occasionally for no obvious reason, the main main window is
00237         // shown when it should be hidden, so hide it just to be sure.
00238         if (trayParent)
00239             trayParent->hide();
00240     }
00241 
00242     --mActiveCount;
00243     quitIf(0);           // quit if no windows are open
00244     return true;
00245 }
00246 
00247 /******************************************************************************
00248 * Called for a KUniqueApplication when a new instance of the application is
00249 * started.
00250 */
00251 int KAlarmApp::newInstance()
00252 {
00253     kdDebug(5950)<<"KAlarmApp::newInstance()\n";
00254     if (mFatalError)
00255     {
00256         quitFatal();
00257         return 1;
00258     }
00259     ++mActiveCount;
00260     int exitCode = 0;               // default = success
00261     static bool firstInstance = true;
00262     bool dontRedisplay = false;
00263     if (!firstInstance || !isRestored())
00264     {
00265         QString usage;
00266         KCmdLineArgs* args = KCmdLineArgs::parsedArgs();
00267 
00268         // Use a 'do' loop which is executed only once to allow easy error exits.
00269         // Errors use 'break' to skip to the end of the function.
00270 
00271         // Note that DCOP handling is only set up once the command line parameters
00272         // have been checked, since we mustn't register with the alarm daemon only
00273         // to quit immediately afterwards.
00274         do
00275         {
00276             #define USAGE(message)  { usage = message; break; }
00277             if (args->isSet("stop"))
00278             {
00279                 // Stop the alarm daemon
00280                 kdDebug(5950)<<"KAlarmApp::newInstance(): stop\n";
00281                 args->clear();         // free up memory
00282                 if (!Daemon::stop())
00283                 {
00284                     exitCode = 1;
00285                     break;
00286                 }
00287                 dontRedisplay = true;  // exit program if no other instances running
00288             }
00289             else
00290             if (args->isSet("reset"))
00291             {
00292                 // Reset the alarm daemon, if it's running.
00293                 // (If it's not running, it will reset automatically when it eventually starts.)
00294                 kdDebug(5950)<<"KAlarmApp::newInstance(): reset\n";
00295                 args->clear();         // free up memory
00296                 Daemon::reset();
00297                 dontRedisplay = true;  // exit program if no other instances running
00298             }
00299             else
00300             if (args->isSet("tray"))
00301             {
00302                 // Display only the system tray icon
00303                 kdDebug(5950)<<"KAlarmApp::newInstance(): tray\n";
00304                 args->clear();      // free up memory
00305                 if (!mHaveSystemTray)
00306                 {
00307                     exitCode = 1;
00308                     break;
00309                 }
00310                 if (!initCheck())   // open the calendar, register with daemon
00311                 {
00312                     exitCode = 1;
00313                     break;
00314                 }
00315                 if (!displayTrayIcon(true))
00316                 {
00317                     exitCode = 1;
00318                     break;
00319                 }
00320             }
00321             else
00322             if (args->isSet("handleEvent")  ||  args->isSet("triggerEvent")  ||  args->isSet("cancelEvent")  ||  args->isSet("calendarURL"))
00323             {
00324                 // Display or delete the event with the specified event ID
00325                 kdDebug(5950)<<"KAlarmApp::newInstance(): handle event\n";
00326                 EventFunc function = EVENT_HANDLE;
00327                 int count = 0;
00328                 const char* option = 0;
00329                 if (args->isSet("handleEvent"))   { function = EVENT_HANDLE;   option = "handleEvent";   ++count; }
00330                 if (args->isSet("triggerEvent"))  { function = EVENT_TRIGGER;  option = "triggerEvent";  ++count; }
00331                 if (args->isSet("cancelEvent"))   { function = EVENT_CANCEL;   option = "cancelEvent";   ++count; }
00332                 if (!count)
00333                     USAGE(i18n("%1 requires %2, %3 or %4").arg(QString::fromLatin1("--calendarURL")).arg(QString::fromLatin1("--handleEvent")).arg(QString::fromLatin1("--triggerEvent")).arg(QString::fromLatin1("--cancelEvent")))
00334                 if (count > 1)
00335                     USAGE(i18n("%1, %2, %3 mutually exclusive").arg(QString::fromLatin1("--handleEvent")).arg(QString::fromLatin1("--triggerEvent")).arg(QString::fromLatin1("--cancelEvent")));
00336                 if (!initCheck(true))   // open the calendar, don't register with daemon yet
00337                 {
00338                     exitCode = 1;
00339                     break;
00340                 }
00341                 if (args->isSet("calendarURL"))
00342                 {
00343                     QString calendarUrl = args->getOption("calendarURL");
00344                     if (KURL(calendarUrl).url() != AlarmCalendar::activeCalendar()->urlString())
00345                         USAGE(i18n("%1: wrong calendar file").arg(QString::fromLatin1("--calendarURL")))
00346                 }
00347                 QString eventID = args->getOption(option);
00348                 args->clear();      // free up memory
00349                 if (eventID.startsWith(QString::fromLatin1("ad:")))
00350                 {
00351                     // It's a notification from the alarm deamon
00352                     eventID = eventID.mid(3);
00353                     Daemon::queueEvent(eventID);
00354                 }
00355                 setUpDcop();        // start processing DCOP calls
00356                 if (!handleEvent(eventID, function))
00357                 {
00358                     exitCode = 1;
00359                     break;
00360                 }
00361             }
00362             else
00363             if (args->isSet("edit"))
00364             {
00365                 QString eventID = args->getOption("edit");
00366                 if (!initCheck())
00367                 {
00368                     exitCode = 1;
00369                     break;
00370                 }
00371                 if (!KAlarm::edit(eventID))
00372                 {
00373                     USAGE(i18n("%1: Event %2 not found, or not editable").arg(QString::fromLatin1("--edit")).arg(eventID))
00374                     exitCode = 1;
00375                     break;
00376                 }
00377             }
00378             else
00379             if (args->isSet("edit-new")  ||  args->isSet("edit-new-preset"))
00380             {
00381                 QString templ;
00382                 if (args->isSet("edit-new-preset"))
00383                     templ = args->getOption("edit-new-preset");
00384                 if (!initCheck())
00385                 {
00386                     exitCode = 1;
00387                     break;
00388                 }
00389                 KAlarm::editNew(templ);
00390             }
00391             else
00392             if (args->isSet("file")  ||  args->isSet("exec")  ||  args->isSet("mail")  ||  args->count())
00393             {
00394                 // Display a message or file, execute a command, or send an email
00395                 KAEvent::Action action = KAEvent::MESSAGE;
00396                 QCString         alMessage;
00397                 QCString         alFromID;
00398                 EmailAddressList alAddresses;
00399                 QStringList      alAttachments;
00400                 QCString         alSubject;
00401                 if (args->isSet("file"))
00402                 {
00403                     kdDebug(5950)<<"KAlarmApp::newInstance(): file\n";
00404                     if (args->isSet("exec"))
00405                         USAGE(i18n("%1 incompatible with %2").arg(QString::fromLatin1("--exec")).arg(QString::fromLatin1("--file")))
00406                     if (args->isSet("mail"))
00407                         USAGE(i18n("%1 incompatible with %2").arg(QString::fromLatin1("--mail")).arg(QString::fromLatin1("--file")))
00408                     if (args->count())
00409                         USAGE(i18n("message incompatible with %1").arg(QString::fromLatin1("--file")))
00410                     alMessage = args->getOption("file");
00411                     action = KAEvent::FILE;
00412                 }
00413                 else if (args->isSet("exec"))
00414                 {
00415                     kdDebug(5950)<<"KAlarmApp::newInstance(): exec\n";
00416                     if (args->isSet("mail"))
00417                         USAGE(i18n("%1 incompatible with %2").arg(QString::fromLatin1("--mail")).arg(QString::fromLatin1("--exec")))
00418                     alMessage = args->getOption("exec");
00419                     int n = args->count();
00420                     for (int i = 0;  i < n;  ++i)
00421                     {
00422                         alMessage += ' ';
00423                         alMessage += args->arg(i);
00424                     }
00425                     action = KAEvent::COMMAND;
00426                 }
00427                 else if (args->isSet("mail"))
00428                 {
00429                     kdDebug(5950)<<"KAlarmApp::newInstance(): mail\n";
00430                     if (args->isSet("subject"))
00431                         alSubject = args->getOption("subject");
00432                     if (args->isSet("from-id"))
00433                         alFromID = args->getOption("from-id");
00434                     QCStringList params = args->getOptionList("mail");
00435                     for (QCStringList::Iterator i = params.begin();  i != params.end();  ++i)
00436                     {
00437                         QString addr = QString::fromLocal8Bit(*i);
00438                         if (!KAMail::checkAddress(addr))
00439                             USAGE(i18n("%1: invalid email address").arg(QString::fromLatin1("--mail")))
00440                         alAddresses += KCal::Person(QString::null, addr);
00441                     }
00442                     params = args->getOptionList("attach");
00443                     for (QCStringList::Iterator i = params.begin();  i != params.end();  ++i)
00444                         alAttachments += QString::fromLocal8Bit(*i);
00445                     alMessage = args->arg(0);
00446                     action = KAEvent::EMAIL;
00447                 }
00448                 else
00449                 {
00450                     kdDebug(5950)<<"KAlarmApp::newInstance(): message\n";
00451                     alMessage = args->arg(0);
00452                 }
00453 
00454                 if (action != KAEvent::EMAIL)
00455                 {
00456                     if (args->isSet("subject"))
00457                         USAGE(i18n("%1 requires %2").arg(QString::fromLatin1("--subject")).arg(QString::fromLatin1("--mail")))
00458                     if (args->isSet("from-id"))
00459                         USAGE(i18n("%1 requires %2").arg(QString::fromLatin1("--from-id")).arg(QString::fromLatin1("--mail")))
00460                     if (args->isSet("attach"))
00461                         USAGE(i18n("%1 requires %2").arg(QString::fromLatin1("--attach")).arg(QString::fromLatin1("--mail")))
00462                     if (args->isSet("bcc"))
00463                         USAGE(i18n("%1 requires %2").arg(QString::fromLatin1("--bcc")).arg(QString::fromLatin1("--mail")))
00464                 }
00465 
00466                 bool      alarmNoTime = false;
00467                 QDateTime alarmTime, endTime;
00468                 QColor    bgColour = Preferences::defaultBgColour();
00469                 QColor    fgColour = Preferences::defaultFgColour();
00470                 KARecurrence recurrence;
00471                 int       repeatCount    = 0;
00472                 int       repeatInterval = 0;
00473                 if (args->isSet("color"))
00474                 {
00475                     // Background colour is specified
00476                     QCString colourText = args->getOption("color");
00477                     if (static_cast<const char*>(colourText)[0] == '0'
00478                     &&  tolower(static_cast<const char*>(colourText)[1]) == 'x')
00479                         colourText.replace(0, 2, "#");
00480                     bgColour.setNamedColor(colourText);
00481                     if (!bgColour.isValid())
00482                         USAGE(i18n("Invalid %1 parameter").arg(QString::fromLatin1("--color")))
00483                 }
00484                 if (args->isSet("colorfg"))
00485                 {
00486                     // Foreground colour is specified
00487                     QCString colourText = args->getOption("colorfg");
00488                     if (static_cast<const char*>(colourText)[0] == '0'
00489                     &&  tolower(static_cast<const char*>(colourText)[1]) == 'x')
00490                         colourText.replace(0, 2, "#");
00491                     fgColour.setNamedColor(colourText);
00492                     if (!fgColour.isValid())
00493                         USAGE(i18n("Invalid %1 parameter").arg(QString::fromLatin1("--colorfg")))
00494                 }
00495 
00496                 if (args->isSet("time"))
00497                 {
00498                     QCString dateTime = args->getOption("time");
00499                     if (!convWakeTime(dateTime, alarmTime, alarmNoTime))
00500                         USAGE(i18n("Invalid %1 parameter").arg(QString::fromLatin1("--time")))
00501                 }
00502                 else
00503                     alarmTime = QDateTime::currentDateTime();
00504 
00505                 bool haveRecurrence = args->isSet("recurrence");
00506                 if (haveRecurrence)
00507                 {
00508                     if (args->isSet("login"))
00509                         USAGE(i18n("%1 incompatible with %2").arg(QString::fromLatin1("--login")).arg(QString::fromLatin1("--recurrence")))
00510                     if (args->isSet("until"))
00511                         USAGE(i18n("%1 incompatible with %2").arg(QString::fromLatin1("--until")).arg(QString::fromLatin1("--recurrence")))
00512                     QCString rule = args->getOption("recurrence");
00513                     recurrence.set(QString::fromLocal8Bit(static_cast<const char*>(rule)));
00514                 }
00515                 if (args->isSet("interval"))
00516                 {
00517                     // Repeat count is specified
00518                     int count;
00519                     if (args->isSet("login"))
00520                         USAGE(i18n("%1 incompatible with %2").arg(QString::fromLatin1("--login")).arg(QString::fromLatin1("--interval")))
00521                     bool ok;
00522                     if (args->isSet("repeat"))
00523                     {
00524                         count = args->getOption("repeat").toInt(&ok);
00525                         if (!ok || !count || count < -1 || (count < 0 && haveRecurrence))
00526                             USAGE(i18n("Invalid %1 parameter").arg(QString::fromLatin1("--repeat")))
00527                     }
00528                     else if (haveRecurrence)
00529                         USAGE(i18n("%1 requires %2").arg(QString::fromLatin1("--interval")).arg(QString::fromLatin1("--repeat")))
00530                     else if (args->isSet("until"))
00531                     {
00532                         count = 0;
00533                         QCString dateTime = args->getOption("until");
00534                         if (!convWakeTime(dateTime, endTime, alarmNoTime))
00535                             USAGE(i18n("Invalid %1 parameter").arg(QString::fromLatin1("--until")))
00536                         if (endTime < alarmTime)
00537                             USAGE(i18n("%1 earlier than %2").arg(QString::fromLatin1("--until")).arg(QString::fromLatin1("--time")))
00538                     }
00539                     else
00540                         count = -1;
00541 
00542                     // Get the recurrence interval
00543                     int interval;
00544                     KARecurrence::Type recurType;
00545                     if (!convInterval(args->getOption("interval"), recurType, interval, !haveRecurrence)
00546                     ||  interval < 0)
00547                         USAGE(i18n("Invalid %1 parameter").arg(QString::fromLatin1("--interval")))
00548                     if (alarmNoTime  &&  recurType == KARecurrence::MINUTELY)
00549                         USAGE(i18n("Invalid %1 parameter for date-only alarm").arg(QString::fromLatin1("--interval")))
00550 
00551                     if (haveRecurrence)
00552                     {
00553                         // There is a also a recurrence specified, so set up a simple repetition
00554                         int longestInterval = recurrence.longestInterval();
00555                         if (count * interval > longestInterval)
00556                             USAGE(i18n("Invalid %1 and %2 parameters: repetition is longer than %3 interval").arg(QString::fromLatin1("--interval")).arg(QString::fromLatin1("--repeat")).arg(QString::fromLatin1("--recurrence")));
00557                         repeatCount    = count;
00558                         repeatInterval = interval;
00559                     }
00560                     else
00561                     {
00562                         // There is no other recurrence specified, so convert the repetition
00563                         // parameters into a KCal::Recurrence
00564                         recurrence.set(recurType, interval, count, DateTime(alarmTime, alarmNoTime), endTime);
00565                     }
00566                 }
00567                 else
00568                 {
00569                     if (args->isSet("repeat"))
00570                         USAGE(i18n("%1 requires %2").arg(QString::fromLatin1("--repeat")).arg(QString::fromLatin1("--interval")))
00571                     if (args->isSet("until"))
00572                         USAGE(i18n("%1 requires %2").arg(QString::fromLatin1("--until")).arg(QString::fromLatin1("--interval")))
00573                 }
00574 
00575                 QCString audioFile;
00576                 float    audioVolume = -1;
00577 #ifdef WITHOUT_ARTS
00578                 bool     audioRepeat = false;
00579 #else
00580                 bool     audioRepeat = args->isSet("play-repeat");
00581 #endif
00582                 if (audioRepeat  ||  args->isSet("play"))
00583                 {
00584                     // Play a sound with the alarm
00585                     if (audioRepeat  &&  args->isSet("play"))
00586                         USAGE(i18n("%1 incompatible with %2").arg(QString::fromLatin1("--play")).arg(QString::fromLatin1("--play-repeat")))
00587                     if (args->isSet("beep"))
00588                         USAGE(i18n("%1 incompatible with %2").arg(QString::fromLatin1("--beep")).arg(QString::fromLatin1(audioRepeat ? "--play-repeat" : "--play")))
00589                     if (args->isSet("speak"))
00590                         USAGE(i18n("%1 incompatible with %2").arg(QString::fromLatin1("--speak")).arg(QString::fromLatin1(audioRepeat ? "--play-repeat" : "--play")))
00591                     audioFile = args->getOption(audioRepeat ? "play-repeat" : "play");
00592 #ifndef WITHOUT_ARTS
00593                     if (args->isSet("volume"))
00594                     {
00595                         bool ok;
00596                         int volumepc = args->getOption("volume").toInt(&ok);
00597                         if (!ok  ||  volumepc < 0  ||  volumepc > 100)
00598                             USAGE(i18n("Invalid %1 parameter").arg(QString::fromLatin1("--volume")))
00599                         audioVolume = static_cast<float>(volumepc) / 100;
00600                     }
00601 #endif
00602                 }
00603 #ifndef WITHOUT_ARTS
00604                 else if (args->isSet("volume"))
00605                     USAGE(i18n("%1 requires %2 or %3").arg(QString::fromLatin1("--volume")).arg(QString::fromLatin1("--play")).arg(QString::fromLatin1("--play-repeat")))
00606 #endif
00607                 if (args->isSet("speak"))
00608                 {
00609                     if (args->isSet("beep"))
00610                         USAGE(i18n("%1 incompatible with %2").arg(QString::fromLatin1("--beep")).arg(QString::fromLatin1("--speak")))
00611                     if (!mSpeechEnabled)
00612                         USAGE(i18n("%1 requires speech synthesis to be configured using KTTSD").arg(QString::fromLatin1("--speak")))
00613                 }
00614                 int reminderMinutes = 0;
00615                 bool onceOnly = args->isSet("reminder-once");
00616                 if (args->isSet("reminder")  ||  onceOnly)
00617                 {
00618                     // Issue a reminder alarm in advance of the main alarm
00619                     if (onceOnly  &&  args->isSet("reminder"))
00620                         USAGE(i18n("%1 incompatible with %2").arg(QString::fromLatin1("--reminder")).arg(QString::fromLatin1("--reminder-once")))
00621                     QString opt = onceOnly ? QString::fromLatin1("--reminder-once") : QString::fromLatin1("--reminder");
00622                     if (args->isSet("exec"))
00623                         USAGE(i18n("%1 incompatible with %2").arg(opt).arg(QString::fromLatin1("--exec")))
00624                     if (args->isSet("mail"))
00625                         USAGE(i18n("%1 incompatible with %2").arg(opt).arg(QString::fromLatin1("--mail")))
00626                     KARecurrence::Type recurType;
00627                     QString optval = args->getOption(onceOnly ? "reminder-once" : "reminder");
00628                     bool ok = convInterval(args->getOption(onceOnly ? "reminder-once" : "reminder"), recurType, reminderMinutes);
00629                     if (ok)
00630                     {
00631                         switch (recurType)
00632                         {
00633                             case KARecurrence::MINUTELY:
00634                                 if (alarmNoTime)
00635                                     USAGE(i18n("Invalid %1 parameter for date-only alarm").arg(opt))
00636                                 break;
00637                             case KARecurrence::DAILY:     reminderMinutes *= 1440;  break;
00638                             case KARecurrence::WEEKLY:    reminderMinutes *= 7*1440;  break;
00639                             default:   ok = false;  break;
00640                         }
00641                     }
00642                     if (!ok)
00643                         USAGE(i18n("Invalid %1 parameter").arg(opt))
00644                 }
00645 
00646                 int lateCancel = 0;
00647                 if (args->isSet("late-cancel"))
00648                 {
00649                     KARecurrence::Type recurType;
00650                     bool ok = convInterval(args->getOption("late-cancel"), recurType, lateCancel, false);
00651                     if (!ok  ||  lateCancel <= 0)
00652                         USAGE(i18n("Invalid %1 parameter").arg(QString::fromLatin1("late-cancel")))
00653                 }
00654                 else if (args->isSet("auto-close"))
00655                     USAGE(i18n("%1 requires %2").arg(QString::fromLatin1("--auto-close")).arg(QString::fromLatin1("--late-cancel")))
00656 
00657                 int flags = KAEvent::DEFAULT_FONT;
00658                 if (args->isSet("ack-confirm"))
00659                     flags |= KAEvent::CONFIRM_ACK;
00660                 if (args->isSet("auto-close"))
00661                     flags |= KAEvent::AUTO_CLOSE;
00662                 if (args->isSet("beep"))
00663                     flags |= KAEvent::BEEP;
00664                 if (args->isSet("speak"))
00665                     flags |= KAEvent::SPEAK;
00666                 if (args->isSet("korganizer"))
00667                     flags |= KAEvent::COPY_KORGANIZER;
00668                 if (args->isSet("disable"))
00669                     flags |= KAEvent::DISABLED;
00670                 if (audioRepeat)
00671                     flags |= KAEvent::REPEAT_SOUND;
00672                 if (args->isSet("login"))
00673                     flags |= KAEvent::REPEAT_AT_LOGIN;
00674                 if (args->isSet("bcc"))
00675                     flags |= KAEvent::EMAIL_BCC;
00676                 if (alarmNoTime)
00677                     flags |= KAEvent::ANY_TIME;
00678                 args->clear();      // free up memory
00679 
00680                 // Display or schedule the event
00681                 if (!initCheck())
00682                 {
00683                     exitCode = 1;
00684                     break;
00685                 }
00686                 if (!scheduleEvent(action, alMessage, alarmTime, lateCancel, flags, bgColour, fgColour, QFont(), audioFile,
00687                                    audioVolume, reminderMinutes, recurrence, repeatInterval, repeatCount,
00688                                    alFromID, alAddresses, alSubject, alAttachments))
00689                 {
00690                     exitCode = 1;
00691                     break;
00692                 }
00693             }
00694             else
00695             {
00696                 // No arguments - run interactively & display the main window
00697                 kdDebug(5950)<<"KAlarmApp::newInstance(): interactive\n";
00698                 if (args->isSet("ack-confirm"))
00699                     usage += QString::fromLatin1("--ack-confirm ");
00700                 if (args->isSet("attach"))
00701                     usage += QString::fromLatin1("--attach ");
00702                 if (args->isSet("auto-close"))
00703                     usage += QString::fromLatin1("--auto-close ");
00704                 if (args->isSet("bcc"))
00705                     usage += QString::fromLatin1("--bcc ");
00706                 if (args->isSet("beep"))
00707                     usage += QString::fromLatin1("--beep ");
00708                 if (args->isSet("color"))
00709                     usage += QString::fromLatin1("--color ");
00710                 if (args->isSet("colorfg"))
00711                     usage += QString::fromLatin1("--colorfg ");
00712                 if (args->isSet("disable"))
00713                     usage += QString::fromLatin1("--disable ");
00714                 if (args->isSet("from-id"))
00715                     usage += QString::fromLatin1("--from-id ");
00716                 if (args->isSet("korganizer"))
00717                     usage += QString::fromLatin1("--korganizer ");
00718                 if (args->isSet("late-cancel"))
00719                     usage += QString::fromLatin1("--late-cancel ");
00720                 if (args->isSet("login"))
00721                     usage += QString::fromLatin1("--login ");
00722                 if (args->isSet("play"))
00723                     usage += QString::fromLatin1("--play ");
00724 #ifndef WITHOUT_ARTS
00725                 if (args->isSet("play-repeat"))
00726                     usage += QString::fromLatin1("--play-repeat ");
00727 #endif
00728                 if (args->isSet("reminder"))
00729                     usage += QString::fromLatin1("--reminder ");
00730                 if (args->isSet("reminder-once"))
00731                     usage += QString::fromLatin1("--reminder-once ");
00732                 if (args->isSet("speak"))
00733                     usage += QString::fromLatin1("--speak ");
00734                 if (args->isSet("subject"))
00735                     usage += QString::fromLatin1("--subject ");
00736                 if (args->isSet("time"))
00737                     usage += QString::fromLatin1("--time ");
00738 #ifndef WITHOUT_ARTS
00739                 if (args->isSet("volume"))
00740                     usage += QString::fromLatin1("--volume ");
00741 #endif
00742                 if (!usage.isEmpty())
00743                 {
00744                     usage += i18n(": option(s) only valid with a message/%1/%2").arg(QString::fromLatin1("--file")).arg(QString::fromLatin1("--exec"));
00745                     break;
00746                 }
00747 
00748                 args->clear();      // free up memory
00749                 if (!initCheck())
00750                 {
00751                     exitCode = 1;
00752                     break;
00753                 }
00754 
00755                 (MainWindow::create())->show();
00756             }
00757         } while (0);    // only execute once
00758 
00759         if (!usage.isEmpty())
00760         {
00761             // Note: we can't use args->usage() since that also quits any other
00762             // running 'instances' of the program.
00763             std::cerr << usage.local8Bit().data()
00764                       << i18n("\nUse --help to get a list of available command line options.\n").local8Bit().data();
00765             exitCode = 1;
00766         }
00767     }
00768     if (firstInstance  &&  !dontRedisplay  &&  !exitCode)
00769         redisplayAlarms();
00770 
00771     --mActiveCount;
00772     firstInstance = false;
00773 
00774     // Quit the application if this was the last/only running "instance" of the program.
00775     // Executing 'return' doesn't work very well since the program continues to
00776     // run if no windows were created.
00777     quitIf(exitCode);
00778     return exitCode;
00779 }
00780 
00781 /******************************************************************************
00782 * Quit the program, optionally only if there are no more "instances" running.
00783 */
00784 void KAlarmApp::quitIf(int exitCode, bool force)
00785 {
00786     if (force)
00787     {
00788         // Quit regardless, except for message windows
00789         MainWindow::closeAll();
00790         displayTrayIcon(false);
00791         if (MessageWin::instanceCount())
00792             return;
00793     }
00794     else
00795     {
00796         // Quit only if there are no more "instances" running
00797         mPendingQuit = false;
00798         if (mActiveCount > 0  ||  MessageWin::instanceCount())
00799             return;
00800         int mwcount = MainWindow::count();
00801         MainWindow* mw = mwcount ? MainWindow::firstWindow() : 0;
00802         if (mwcount > 1  ||  mwcount && (!mw->isHidden() || !mw->isTrayParent()))
00803             return;
00804         // There are no windows left except perhaps a main window which is a hidden tray icon parent
00805         if (mTrayWindow)
00806         {
00807             // There is a system tray icon.
00808             // Don't exit unless the system tray doesn't seem to exist.
00809             if (checkSystemTray())
00810                 return;
00811         }
00812         if (!mDcopQueue.isEmpty()  ||  !mCommandProcesses.isEmpty())
00813         {
00814             // Don't quit yet if there are outstanding actions on the DCOP queue
00815             mPendingQuit = true;
00816             mPendingQuitCode = exitCode;
00817             return;
00818         }
00819     }
00820 
00821     // This was the last/only running "instance" of the program, so exit completely.
00822     kdDebug(5950) << "KAlarmApp::quitIf(" << exitCode << "): quitting" << endl;
00823     exit(exitCode);
00824 }
00825 
00826 /******************************************************************************
00827 * Called when the Quit menu item is selected.
00828 * Closes the system tray window and all main windows, but does not exit the
00829 * program if other windows are still open.
00830 */
00831 void KAlarmApp::doQuit(QWidget* parent)
00832 {
00833     kdDebug(5950) << "KAlarmApp::doQuit()\n";
00834     if (mDisableAlarmsIfStopped
00835     &&  MessageBox::warningContinueCancel(parent, KMessageBox::Cancel,
00836                                           i18n("Quitting will disable alarms\n(once any alarm message windows are closed)."),
00837                                           QString::null, KStdGuiItem::quit(), Preferences::QUIT_WARN
00838                                          ) != KMessageBox::Yes)
00839         return;
00840     quitIf(0, true);
00841 }
00842 
00843 /******************************************************************************
00844 * Called when the session manager is about to close down the application.
00845 */
00846 void KAlarmApp::commitData(QSessionManager& sm)
00847 {
00848     mSessionClosingDown = true;
00849     KUniqueApplication::commitData(sm);
00850     mSessionClosingDown = false;         // reset in case shutdown is cancelled
00851 }
00852 
00853 /******************************************************************************
00854 * Display an error message for a fatal error. Prevent further actions since
00855 * the program state is unsafe.
00856 */
00857 void KAlarmApp::displayFatalError(const QString& message)
00858 {
00859     if (!mFatalError)
00860     {
00861         mFatalError = 1;
00862         mFatalMessage = message;
00863         if (theInstance)
00864             QTimer::singleShot(0, theInstance, SLOT(quitFatal()));
00865     }
00866 }
00867 
00868 /******************************************************************************
00869 * Quit the program, once the fatal error message has been acknowledged.
00870 */
00871 void KAlarmApp::quitFatal()
00872 {
00873     switch (mFatalError)
00874     {
00875         case 0:
00876         case 2:
00877             return;
00878         case 1:
00879             mFatalError = 2;
00880             KMessageBox::error(0, mFatalMessage);
00881             mFatalError = 3;
00882             // fall through to '3'
00883         case 3:
00884             if (theInstance)
00885                 theInstance->quitIf(1, true);
00886             break;
00887     }
00888     QTimer::singleShot(1000, this, SLOT(quitFatal()));
00889 }
00890 
00891 /******************************************************************************
00892 * The main processing loop for KAlarm.
00893 * All KAlarm operations involving opening or updating calendar files are called
00894 * from this loop to ensure that only one operation is active at any one time.
00895 * This precaution is necessary because KAlarm's activities are mostly
00896 * asynchronous, being in response to DCOP calls from the alarm daemon (or other
00897 * programs) or timer events, any of which can be received in the middle of
00898 * performing another operation. If a calendar file is opened or updated while
00899 * another calendar operation is in progress, the program has been observed to
00900 * hang, or the first calendar call has failed with data loss - clearly
00901 * unacceptable!!
00902 */
00903 void KAlarmApp::processQueue()
00904 {
00905     if (mInitialised  &&  !mProcessingQueue)
00906     {
00907         kdDebug(5950) << "KAlarmApp::processQueue()\n";
00908         mProcessingQueue = true;
00909 
00910         // Reset the alarm daemon if it's been queued
00911         KAlarm::resetDaemonIfQueued();
00912 
00913         // Process DCOP calls
00914         while (!mDcopQueue.isEmpty())
00915         {
00916             DcopQEntry& entry = mDcopQueue.first();
00917             if (entry.eventId.isEmpty())
00918             {
00919                 // It's a new alarm
00920                 switch (entry.function)
00921                 {
00922                 case EVENT_TRIGGER:
00923                     execAlarm(entry.event, entry.event.firstAlarm(), false);
00924                     break;
00925                 case EVENT_HANDLE:
00926                     KAlarm::addEvent(entry.event, 0);
00927                     break;
00928                 case EVENT_CANCEL:
00929                     break;
00930                 }
00931             }
00932             else
00933                 handleEvent(entry.eventId, entry.function);
00934             mDcopQueue.pop_front();
00935         }
00936 
00937         // Purge the expired alarms calendar if it's time to do so
00938         AlarmCalendar::expiredCalendar()->purgeIfQueued();
00939 
00940         // Now that the queue has been processed, quit if a quit was queued
00941         if (mPendingQuit)
00942             quitIf(mPendingQuitCode);
00943 
00944         mProcessingQueue = false;
00945     }
00946 }
00947 
00948 /******************************************************************************
00949 *  Redisplay alarms which were being shown when the program last exited.
00950 *  Normally, these alarms will have been displayed by session restoration, but
00951 *  if the program crashed or was killed, we can redisplay them here so that
00952 *  they won't be lost.
00953 */
00954 void KAlarmApp::redisplayAlarms()
00955 {
00956     AlarmCalendar* cal = AlarmCalendar::displayCalendar();
00957     if (cal->isOpen())
00958     {
00959         KCal::Event::List events = cal->events();
00960         for (KCal::Event::List::ConstIterator it = events.begin();  it != events.end();  ++it)
00961         {
00962                         KCal::Event* kcalEvent = *it;
00963             KAEvent event(*kcalEvent);
00964             event.setUid(KAEvent::ACTIVE);
00965             if (!MessageWin::findEvent(event.id()))
00966             {
00967                 // This event should be displayed, but currently isn't being
00968                 kdDebug(5950) << "KAlarmApp::redisplayAlarms(): " << event.id() << endl;
00969                 KAAlarm alarm = event.convertDisplayingAlarm();
00970                 (new MessageWin(event, alarm, false, !alarm.repeatAtLogin()))->show();
00971             }
00972         }
00973     }
00974 }
00975 
00976 /******************************************************************************
00977 * Called when the system tray main window is closed.
00978 */
00979 void KAlarmApp::removeWindow(TrayWindow*)
00980 {
00981     mTrayWindow = 0;
00982     quitIf();
00983 }
00984 
00985 /******************************************************************************
00986 *  Display or close the system tray icon.
00987 */
00988 bool KAlarmApp::displayTrayIcon(bool show, MainWindow* parent)
00989 {
00990     static bool creating = false;
00991     if (show)
00992     {
00993         if (!mTrayWindow  &&  !creating)
00994         {
00995             if (!mHaveSystemTray)
00996                 return false;
00997             if (!MainWindow::count()  &&  wantRunInSystemTray())
00998             {
00999                 creating = true;    // prevent main window constructor from creating an additional tray icon
01000                 parent = MainWindow::create();
01001                 creating = false;
01002             }
01003             mTrayWindow = new TrayWindow(parent ? parent : MainWindow::firstWindow());
01004             connect(mTrayWindow, SIGNAL(deleted()), SIGNAL(trayIconToggled()));
01005             mTrayWindow->show();
01006             emit trayIconToggled();
01007 
01008             // Set up a timer so that we can check after all events in the window system's
01009             // event queue have been processed, whether the system tray actually exists
01010             mCheckingSystemTray = true;
01011             mSavedNoSystemTray  = mNoSystemTray;
01012             mNoSystemTray       = false;
01013             QTimer::singleShot(0, this, SLOT(slotSystemTrayTimer()));
01014         }
01015     }
01016     else if (mTrayWindow)
01017     {
01018         delete mTrayWindow;
01019         mTrayWindow = 0;
01020     }
01021     return true;
01022 }
01023 
01024 /******************************************************************************
01025 *  Called by a timer to check whether the system tray icon has been housed in
01026 *  the system tray. Because there is a delay between the system tray icon show
01027 *  event and the icon being reparented by the system tray, we have to use a
01028 *  timer to check whether the system tray has actually grabbed it, or whether
01029 *  the system tray probably doesn't exist.
01030 */
01031 void KAlarmApp::slotSystemTrayTimer()
01032 {
01033     mCheckingSystemTray = false;
01034     if (!checkSystemTray())
01035         quitIf(0);    // exit the application if there are no open windows
01036 }
01037 
01038 /******************************************************************************
01039 *  Check whether the system tray icon has been housed in the system tray.
01040 *  If the system tray doesn't seem to exist, tell the alarm daemon to notify us
01041 *  of alarms regardless of whether we're running.
01042 */
01043 bool KAlarmApp::checkSystemTray()
01044 {
01045     if (mCheckingSystemTray  ||  !mTrayWindow)
01046         return true;
01047     if (mTrayWindow->inSystemTray() != !mSavedNoSystemTray)
01048     {
01049         kdDebug(5950) << "KAlarmApp::checkSystemTray(): changed -> " << mSavedNoSystemTray << endl;
01050         mNoSystemTray = mSavedNoSystemTray = !mSavedNoSystemTray;
01051 
01052         // Store the new setting in the config file, so that if KAlarm exits and is then
01053         // next activated by the daemon to display a message, it will register with the
01054         // daemon with the correct NOTIFY type. If that happened when there was no system
01055         // tray and alarms are disabled when KAlarm is not running, registering with
01056         // NO_START_NOTIFY could result in alarms never being seen.
01057         KConfig* config = kapp->config();
01058         config->setGroup(QString::fromLatin1("General"));
01059         config->writeEntry(QString::fromLatin1("NoSystemTray"), mNoSystemTray);
01060         config->sync();
01061 
01062         // Update other settings and reregister with the alarm daemon
01063         slotPreferencesChanged();
01064     }
01065     else
01066     {
01067         kdDebug(5950) << "KAlarmApp::checkSystemTray(): no change = " << !mSavedNoSystemTray << endl;
01068         mNoSystemTray = mSavedNoSystemTray;
01069     }
01070     return !mNoSystemTray;
01071 }
01072 
01073 /******************************************************************************
01074 * Return the main window associated with the system tray icon.
01075 */
01076 MainWindow* KAlarmApp::trayMainWindow() const
01077 {
01078     return mTrayWindow ? mTrayWindow->assocMainWindow() : 0;
01079 }
01080 
01081 /******************************************************************************
01082 *  Called when KAlarm preferences have changed.
01083 */
01084 void KAlarmApp::slotPreferencesChanged()
01085 {
01086     bool newRunInSysTray = wantRunInSystemTray();
01087     if (newRunInSysTray != mOldRunInSystemTray)
01088     {
01089         // The system tray run mode has changed
01090         ++mActiveCount;         // prevent the application from quitting
01091         MainWindow* win = mTrayWindow ? mTrayWindow->assocMainWindow() : 0;
01092         delete mTrayWindow;     // remove the system tray icon if it is currently shown
01093         mTrayWindow = 0;
01094         mOldRunInSystemTray = newRunInSysTray;
01095         if (!newRunInSysTray)
01096         {
01097             if (win  &&  win->isHidden())
01098                 delete win;
01099         }
01100         displayTrayIcon(true);
01101         --mActiveCount;
01102     }
01103 
01104     bool newDisableIfStopped = wantRunInSystemTray() && !mNoSystemTray && Preferences::disableAlarmsIfStopped();
01105     if (newDisableIfStopped != mDisableAlarmsIfStopped)
01106     {
01107         mDisableAlarmsIfStopped = newDisableIfStopped;    // N.B. this setting is used by Daemon::reregister()
01108         Preferences::setQuitWarn(true);   // since mode has changed, re-allow warning messages on Quit
01109         Daemon::reregister();           // re-register with the alarm daemon
01110     }
01111 
01112     // Change alarm times for date-only alarms if the start of day time has changed
01113     if (Preferences::startOfDay() != mStartOfDay)
01114         changeStartOfDay();
01115 
01116     // In case the date for February 29th recurrences has changed
01117     KARecurrence::setDefaultFeb29Type(Preferences::defaultFeb29Type());
01118 
01119     if (Preferences::showAlarmTime()   != mPrefsShowTime
01120     ||  Preferences::showTimeToAlarm() != mPrefsShowTimeTo)
01121     {
01122         // The default alarm list time columns selection has changed
01123         MainWindow::updateTimeColumns(mPrefsShowTime, mPrefsShowTimeTo);
01124         mPrefsShowTime   = Preferences::showAlarmTime();
01125         mPrefsShowTimeTo = Preferences::showTimeToAlarm();
01126     }
01127 
01128     if (Preferences::expiredColour() != mPrefsExpiredColour)
01129     {
01130         // The expired alarms text colour has changed
01131         mRefreshExpiredAlarms = true;
01132         mPrefsExpiredColour = Preferences::expiredColour();
01133     }
01134 
01135     if (Preferences::expiredKeepDays() != mPrefsExpiredKeepDays)
01136     {
01137         // How long expired alarms are being kept has changed.
01138         // N.B. This also adjusts for any change in start-of-day time.
01139         mPrefsExpiredKeepDays = Preferences::expiredKeepDays();
01140         AlarmCalendar::expiredCalendar()->setPurgeDays(mPrefsExpiredKeepDays);
01141     }
01142 
01143     if (mRefreshExpiredAlarms)
01144     {
01145         mRefreshExpiredAlarms = false;
01146         MainWindow::updateExpired();
01147     }
01148 }
01149 
01150 /******************************************************************************
01151 *  Change alarm times for date-only alarms after the start of day time has changed.
01152 */
01153 void KAlarmApp::changeStartOfDay()
01154 {
01155     QTime sod = Preferences::startOfDay();
01156     DateTime::setStartOfDay(sod);
01157     AlarmCalendar* cal = AlarmCalendar::activeCalendar();
01158     if (KAEvent::adjustStartOfDay(cal->events()))
01159         cal->save();
01160     Preferences::updateStartOfDayCheck();  // now that calendar is updated, set OK flag in config file
01161     mStartOfDay = sod;
01162 }
01163 
01164 /******************************************************************************
01165 *  Called when the expired alarms calendar has been purged.
01166 *  Updates the alarm list in all main windows.
01167 */
01168 void KAlarmApp::slotExpiredPurged()
01169 {
01170     mRefreshExpiredAlarms = false;
01171     MainWindow::updateExpired();
01172 }
01173 
01174 /******************************************************************************
01175 *  Return whether the program is configured to be running in the system tray.
01176 */
01177 bool KAlarmApp::wantRunInSystemTray() const
01178 {
01179     return Preferences::runInSystemTray()  &&  mHaveSystemTray;
01180 }
01181 
01182 /******************************************************************************
01183 * Called to schedule a new alarm, either in response to a DCOP notification or
01184 * to command line options.
01185 * Reply = true unless there was a parameter error or an error opening calendar file.
01186 */
01187 bool KAlarmApp::scheduleEvent(KAEvent::Action action, const QString& text, const QDateTime& dateTime,
01188                               int lateCancel, int flags, const QColor& bg, const QColor& fg, const QFont& font,
01189                               const QString& audioFile, float audioVolume, int reminderMinutes,
01190                               const KARecurrence& recurrence, int repeatInterval, int repeatCount,
01191                               const QString& mailFromID, const EmailAddressList& mailAddresses,
01192                               const QString& mailSubject, const QStringList& mailAttachments)
01193 {
01194     kdDebug(5950) << "KAlarmApp::scheduleEvent(): " << text << endl;
01195     if (!dateTime.isValid())
01196         return false;
01197     QDateTime now = QDateTime::currentDateTime();
01198     if (lateCancel  &&  dateTime < now.addSecs(-maxLateness(lateCancel)))
01199         return true;               // alarm time was already expired too long ago
01200     QDateTime alarmTime = dateTime;
01201     // Round down to the nearest minute to avoid scheduling being messed up
01202     alarmTime.setTime(QTime(alarmTime.time().hour(), alarmTime.time().minute(), 0));
01203 
01204     KAEvent event(alarmTime, text, bg, fg, font, action, lateCancel, flags);
01205     if (reminderMinutes)
01206     {
01207         bool onceOnly = (reminderMinutes < 0);
01208         event.setReminder((onceOnly ? -reminderMinutes : reminderMinutes), onceOnly);
01209     }
01210     if (!audioFile.isEmpty())
01211         event.setAudioFile(audioFile, audioVolume, -1, 0);
01212     if (!mailAddresses.isEmpty())
01213         event.setEmail(mailFromID, mailAddresses, mailSubject, mailAttachments);
01214     event.setRecurrence(recurrence);
01215     event.setFirstRecurrence();
01216     event.setRepetition(repeatInterval, repeatCount - 1);
01217     if (alarmTime <= now)
01218     {
01219         // Alarm is due for display already.
01220         // First execute it once without adding it to the calendar file.
01221         if (!mInitialised)
01222             mDcopQueue.append(DcopQEntry(event, EVENT_TRIGGER));
01223         else
01224             execAlarm(event, event.firstAlarm(), false);
01225         // If it's a recurring alarm, reschedule it for its next occurrence
01226         if (!event.recurs()
01227         ||  event.setNextOccurrence(now) == KAEvent::NO_OCCURRENCE)
01228             return true;
01229         // It has recurrences in the future
01230     }
01231 
01232     // Queue the alarm for insertion into the calendar file
01233     mDcopQueue.append(DcopQEntry(event));
01234     if (mInitialised)
01235         QTimer::singleShot(0, this, SLOT(processQueue()));
01236     return true;
01237 }
01238 
01239 /******************************************************************************
01240 * Called in response to a DCOP notification by the alarm daemon that an event
01241 * should be handled, i.e. displayed or cancelled.
01242 * Optionally display the event. Delete the event from the calendar file and
01243 * from every main window instance.
01244 */
01245 bool KAlarmApp::handleEvent(const QString& urlString, const QString& eventID, EventFunc function)
01246 {
01247     kdDebug(5950) << "KAlarmApp::handleEvent(DCOP): " << eventID << endl;
01248     AlarmCalendar* cal = AlarmCalendar::activeCalendar();     // this can be called before calendars have been initialised
01249     if (cal  &&  KURL(urlString).url() != cal->urlString())
01250     {
01251         kdError(5950) << "KAlarmApp::handleEvent(DCOP): wrong calendar file " << urlString << endl;
01252         Daemon::eventHandled(eventID, false);
01253         return false;
01254     }
01255     mDcopQueue.append(DcopQEntry(function, eventID));
01256     if (mInitialised)
01257         QTimer::singleShot(0, this, SLOT(processQueue()));
01258     return true;
01259 }
01260 
01261 /******************************************************************************
01262 * Either:
01263 * a) Display the event and then delete it if it has no outstanding repetitions.
01264 * b) Delete the event.
01265 * c) Reschedule the event for its next repetition. If none remain, delete it.
01266 * If the event is deleted, it is removed from the calendar file and from every
01267 * main window instance.
01268 */
01269 bool KAlarmApp::handleEvent(const QString& eventID, EventFunc function)
01270 {
01271     kdDebug(5950) << "KAlarmApp::handleEvent(): " << eventID << ", " << (function==EVENT_TRIGGER?"TRIGGER":function==EVENT_CANCEL?"CANCEL":function==EVENT_HANDLE?"HANDLE":"?") << endl;
01272     KCal::Event* kcalEvent = AlarmCalendar::activeCalendar()->event(eventID);
01273     if (!kcalEvent)
01274     {
01275         kdError(5950) << "KAlarmApp::handleEvent(): event ID not found: " << eventID << endl;
01276         Daemon::eventHandled(eventID, false);
01277         return false;
01278     }
01279     KAEvent event(*kcalEvent);
01280     switch (function)
01281     {
01282         case EVENT_CANCEL:
01283             KAlarm::deleteEvent(event, true);
01284             break;
01285 
01286         case EVENT_TRIGGER:    // handle it if it's due, else execute it regardless
01287         case EVENT_HANDLE:     // handle it if it's due
01288         {
01289             QDateTime now = QDateTime::currentDateTime();
01290             DateTime  repeatDT;
01291             bool updateCalAndDisplay = false;
01292             bool alarmToExecuteValid = false;
01293             KAAlarm alarmToExecute;
01294             // Check all the alarms in turn.
01295             // Note that the main alarm is fetched before any other alarms.
01296             for (KAAlarm alarm = event.firstAlarm();  alarm.valid();  alarm = event.nextAlarm(alarm))
01297             {
01298                 if (alarm.deferred()  &&  event.repeatCount()
01299                 &&  repeatDT.isValid()  &&  alarm.dateTime() > repeatDT)
01300                 {
01301                     // This deferral of a repeated alarm is later than the last previous
01302                     // occurrence of the main alarm, so use the deferral alarm instead.
01303                     // If the deferral is not yet due, this prevents the main alarm being
01304                     // triggered repeatedly. If the deferral is due, this triggers it
01305                     // in preference to the main alarm.
01306                     alarmToExecute      = KAAlarm();
01307                     alarmToExecuteValid = false;
01308                     updateCalAndDisplay = false;
01309                 }
01310                 // Check if the alarm is due yet.
01311                 int secs = alarm.dateTime(true).secsTo(now);
01312                 if (secs < 0)
01313                 {
01314                     // This alarm is definitely not due yet
01315                     kdDebug(5950) << "KAlarmApp::handleEvent(): alarm " << alarm.type() << ": not due\n";
01316                     continue;
01317                 }
01318                 if (alarm.repeatAtLogin())
01319                 {
01320                     // Alarm is to be displayed at every login.
01321                     // Check if the alarm has only just been set up.
01322                     // (The alarm daemon will immediately notify that it is due
01323                     //  since it is set up with a time in the past.)
01324                     kdDebug(5950) << "KAlarmApp::handleEvent(): REPEAT_AT_LOGIN\n";
01325                     if (secs < maxLateness(1))
01326                         continue;
01327 
01328                     // Check if the main alarm is already being displayed.
01329                     // (We don't want to display both at the same time.)
01330                     if (alarmToExecute.valid())
01331                         continue;
01332 
01333                     // Set the time to display if it's a display alarm
01334                     alarm.setTime(now);
01335                 }
01336                 if (alarm.lateCancel())
01337                 {
01338                     // Alarm is due, and it is to be cancelled if too late.
01339                     kdDebug(5950) << "KAlarmApp::handleEvent(): LATE_CANCEL\n";
01340                     bool late = false;
01341                     bool cancel = false;
01342                     if (alarm.dateTime().isDateOnly())
01343                     {
01344                         // The alarm has no time, so cancel it if its date is too far past
01345                         int maxlate = alarm.lateCancel() / 1440;    // maximum lateness in days
01346                         QDateTime limit(alarm.date().addDays(maxlate + 1), Preferences::startOfDay());
01347                         if (now >= limit)
01348                         {
01349                             // It's too late to display the scheduled occurrence.
01350                             // Find the last previous occurrence of the alarm.
01351                             DateTime next;
01352                             KAEvent::OccurType type = event.previousOccurrence(now, next, true);
01353                             switch (type & ~KAEvent::OCCURRENCE_REPEAT)
01354                             {
01355                                 case KAEvent::FIRST_OR_ONLY_OCCURRENCE:
01356                                 case KAEvent::RECURRENCE_DATE:
01357                                 case KAEvent::RECURRENCE_DATE_TIME:
01358                                 case KAEvent::LAST_RECURRENCE:
01359                                     limit.setDate(next.date().addDays(maxlate + 1));
01360                                     limit.setTime(Preferences::startOfDay());
01361                                     if (now >= limit)
01362                                     {
01363                                         if (type == KAEvent::LAST_RECURRENCE
01364                                         ||  type == KAEvent::FIRST_OR_ONLY_OCCURRENCE && !event.recurs())
01365                                             cancel = true;   // last occurrence (and there are no repetitions)
01366                                         else
01367                                             late = true;
01368                                     }
01369                                     break;
01370                                 case KAEvent::NO_OCCURRENCE:
01371                                 default:
01372                                     late = true;
01373                                     break;
01374                             }
01375                         }
01376                     }
01377                     else
01378                     {
01379                         // The alarm is timed. Allow it to be the permitted amount late before cancelling it.
01380                         int maxlate = maxLateness(alarm.lateCancel());
01381                         if (secs > maxlate)
01382                         {
01383                             // It's over the maximum interval late.
01384                             // Find the most recent occurrence of the alarm.
01385                             DateTime next;
01386                             KAEvent::OccurType type = event.previousOccurrence(now, next, true);
01387                             switch (type & ~KAEvent::OCCURRENCE_REPEAT)
01388                             {
01389                                 case KAEvent::FIRST_OR_ONLY_OCCURRENCE:
01390                                 case KAEvent::RECURRENCE_DATE:
01391                                 case KAEvent::RECURRENCE_DATE_TIME:
01392                                 case KAEvent::LAST_RECURRENCE:
01393                                     if (next.dateTime().secsTo(now) > maxlate)
01394                                     {
01395                                         if (type == KAEvent::LAST_RECURRENCE
01396                                         ||  type == KAEvent::FIRST_OR_ONLY_OCCURRENCE && !event.recurs())
01397                                             cancel = true;   // last occurrence (and there are no repetitions)
01398                                         else
01399                                             late = true;
01400                                     }
01401                                     break;
01402                                 case KAEvent::NO_OCCURRENCE:
01403                                 default:
01404                                     late = true;
01405                                     break;
01406                             }
01407                         }
01408                     }
01409 
01410                     if (cancel)
01411                     {
01412                         // All recurrences are finished, so cancel the event
01413                         event.setArchive();
01414                         cancelAlarm(event, alarm.type(), false);
01415                         updateCalAndDisplay = true;
01416                         continue;
01417                     }
01418                     if (late)
01419                     {
01420                         // The latest repetition was too long ago, so schedule the next one
01421                         rescheduleAlarm(event, alarm, false);
01422                         updateCalAndDisplay = true;
01423                         continue;
01424                     }
01425                 }
01426                 if (!alarmToExecuteValid)
01427                 {
01428                     kdDebug(5950) << "KAlarmApp::handleEvent(): alarm " << alarm.type() << ": execute\n";
01429                     alarmToExecute = alarm;             // note the alarm to be executed
01430                     alarmToExecuteValid = true;         // only trigger one alarm for the event
01431                 }
01432                 else
01433                     kdDebug(5950) << "KAlarmApp::handleEvent(): alarm " << alarm.type() << ": skip\n";
01434             }
01435 
01436             // If there is an alarm to execute, do this last after rescheduling/cancelling
01437             // any others. This ensures that the updated event is only saved once to the calendar.
01438             if (alarmToExecute.valid())
01439                 execAlarm(event, alarmToExecute, true, !alarmToExecute.repeatAtLogin());
01440             else
01441             {
01442                 if (function == EVENT_TRIGGER)
01443                 {
01444                     // The alarm is to be executed regardless of whether it's due.
01445                     // Only trigger one alarm from the event - we don't want multiple
01446                     // identical messages, for example.
01447                     KAAlarm alarm = event.firstAlarm();
01448                     if (alarm.valid())
01449                         execAlarm(event, alarm, false);
01450                 }
01451                 if (updateCalAndDisplay)
01452                     KAlarm::updateEvent(event, 0);     // update the window lists and calendar file
01453                 else if (function != EVENT_TRIGGER)
01454                 {
01455                     kdDebug(5950) << "KAlarmApp::handleEvent(): no action\n";
01456                     Daemon::eventHandled(eventID, false);
01457                 }
01458             }
01459             break;
01460         }
01461     }
01462     return true;
01463 }
01464 
01465 /******************************************************************************
01466 * Called when an alarm is currently being displayed, to store a copy of the
01467 * alarm in the displaying calendar, and to reschedule it for its next repetition.
01468 * If no repetitions remain, cancel it.
01469 */
01470 void KAlarmApp::alarmShowing(KAEvent& event, KAAlarm::Type alarmType, const DateTime& alarmTime)
01471 {
01472     kdDebug(5950) << "KAlarmApp::alarmShowing(" << event.id() << ", " << KAAlarm::debugType(alarmType) << ")\n";
01473     KCal::Event* kcalEvent = AlarmCalendar::activeCalendar()->event(event.id());
01474     if (!kcalEvent)
01475         kdError(5950) << "KAlarmApp::alarmShowing(): event ID not found: " << event.id() << endl;
01476     else
01477     {
01478         KAAlarm alarm = event.alarm(alarmType);
01479         if (!alarm.valid())
01480             kdError(5950) << "KAlarmApp::alarmShowing(): alarm type not found: " << event.id() << ":" << alarmType << endl;
01481         else
01482         {
01483             // Copy the alarm to the displaying calendar in case of a crash, etc.
01484             KAEvent dispEvent;
01485             dispEvent.setDisplaying(event, alarmType, alarmTime.dateTime());
01486             AlarmCalendar* cal = AlarmCalendar::displayCalendarOpen();
01487             if (cal)
01488             {
01489                 cal->deleteEvent(dispEvent.id());   // in case it already exists
01490                 cal->addEvent(dispEvent);
01491                 cal->save();
01492             }
01493 
01494             rescheduleAlarm(event, alarm, true);
01495             return;
01496         }
01497     }
01498     Daemon::eventHandled(event.id(), false);
01499 }
01500 
01501 /******************************************************************************
01502 * Called when an alarm action has completed, to perform any post-alarm actions.
01503 */
01504 void KAlarmApp::alarmCompleted(const KAEvent& event)
01505 {
01506     if (!event.postAction().isEmpty()  &&  ShellProcess::authorised())
01507     {
01508         QString command = event.postAction();
01509         kdDebug(5950) << "KAlarmApp::alarmCompleted(" << event.id() << "): " << command << endl;
01510         doShellCommand(command, event, 0, ProcData::POST_ACTION);
01511     }
01512 }
01513 
01514 /******************************************************************************
01515 * Reschedule the alarm for its next recurrence. If none remain, delete it.
01516 * If the alarm is deleted and it is the last alarm for its event, the event is
01517 * removed from the calendar file and from every main window instance.
01518 */
01519 void KAlarmApp::rescheduleAlarm(KAEvent& event, const KAAlarm& alarm, bool updateCalAndDisplay)
01520 {
01521     kdDebug(5950) << "KAlarmApp::rescheduleAlarm()" << endl;
01522     bool update = false;
01523     if (alarm.reminder()  ||  alarm.deferred())
01524     {
01525         // It's an advance warning alarm or an extra deferred alarm, so delete it
01526         event.removeExpiredAlarm(alarm.type());
01527         update = true;
01528     }
01529     else if (alarm.repeatAtLogin())
01530     {
01531         // Leave an alarm which repeats at every login until its main alarm is deleted
01532         if (updateCalAndDisplay  &&  event.updated())
01533             update = true;
01534     }
01535     else
01536     {
01537         // Reschedule the alarm for its next recurrence.
01538         KAEvent::OccurType type = event.setNextOccurrence(QDateTime::currentDateTime());
01539         switch (type)
01540         {
01541             case KAEvent::NO_OCCURRENCE:
01542                 // All repetitions are finished, so cancel the event
01543                 cancelAlarm(event, alarm.type(), updateCalAndDisplay);
01544                 break;
01545             default:
01546                 if (!(type & KAEvent::OCCURRENCE_REPEAT))
01547                     break;
01548                 // Next occurrence is a repeat, so fall through to recurrence handling
01549             case KAEvent::RECURRENCE_DATE:
01550             case KAEvent::RECURRENCE_DATE_TIME:
01551             case KAEvent::LAST_RECURRENCE:
01552                 // The event is due by now and repetitions still remain, so rewrite the event
01553                 if (updateCalAndDisplay)
01554                     update = true;
01555                 else
01556                 {
01557                     event.cancelCancelledDeferral();
01558                     event.setUpdated();    // note that the calendar file needs to be updated
01559                 }
01560                 break;
01561             case KAEvent::FIRST_OR_ONLY_OCCURRENCE:
01562                 // The first occurrence is still due?!?, so don't do anything
01563                 break;
01564         }
01565         if (event.deferred())
01566         {
01567             // Just in case there's also a deferred alarm, ensure it's removed
01568             event.removeExpiredAlarm(KAAlarm::DEFERRED_ALARM);
01569             update = true;
01570         }
01571     }
01572     if (update)
01573     {
01574         event.cancelCancelledDeferral();
01575         KAlarm::updateEvent(event, 0);     // update the window lists and calendar file
01576     }
01577 }
01578 
01579 /******************************************************************************
01580 * Delete the alarm. If it is the last alarm for its event, the event is removed
01581 * from the calendar file and from every main window instance.
01582 */
01583 void KAlarmApp::cancelAlarm(KAEvent& event, KAAlarm::Type alarmType, bool updateCalAndDisplay)
01584 {
01585     kdDebug(5950) << "KAlarmApp::cancelAlarm()" << endl;
01586     event.cancelCancelledDeferral();
01587     if (alarmType == KAAlarm::MAIN_ALARM  &&  !event.displaying()  &&  event.toBeArchived())
01588     {
01589         // The event is being deleted. Save it in the expired calendar file first.
01590         QString id = event.id();    // save event ID since KAlarm::addExpiredEvent() changes it
01591         KAlarm::addExpiredEvent(event);
01592         event.setEventID(id);       // restore event ID
01593     }
01594     event.removeExpiredAlarm(alarmType);
01595     if (!event.alarmCount())
01596         KAlarm::deleteEvent(event, false);
01597     else if (updateCalAndDisplay)
01598         KAlarm::updateEvent(event, 0);    // update the window lists and calendar file
01599 }
01600 
01601 /******************************************************************************
01602 * Execute an alarm by displaying its message or file, or executing its command.
01603 * Reply = ShellProcess instance if a command alarm
01604 *       != 0 if successful
01605 *       = 0 if the alarm is disabled, or if an error message was output.
01606 */
01607 void* KAlarmApp::execAlarm(KAEvent& event, const KAAlarm& alarm, bool reschedule, bool allowDefer, bool noPreAction)
01608 {
01609     if (!event.enabled())
01610     {
01611         // The event is disabled.
01612         if (reschedule)
01613             rescheduleAlarm(event, alarm, true);
01614         return 0;
01615     }
01616 
01617     void* result = (void*)1;
01618     event.setArchive();
01619     switch (alarm.action())
01620     {
01621         case KAAlarm::MESSAGE:
01622         case KAAlarm::FILE:
01623         {
01624             // Display a message or file, provided that the same event isn't already being displayed
01625             MessageWin* win = MessageWin::findEvent(event.id());
01626             // Find if we're changing a reminder message to the real message
01627             bool reminder = (alarm.type() & KAAlarm::REMINDER_ALARM);
01628             bool replaceReminder = !reminder && win && (win->alarmType() & KAAlarm::REMINDER_ALARM);
01629             if (!reminder  &&  !event.deferred()
01630             &&  (replaceReminder || !win)  &&  !noPreAction
01631             &&  !event.preAction().isEmpty()  &&  ShellProcess::authorised())
01632             {
01633                 // It's not a reminder or a deferred alarm, and there is no message window
01634                 // (other than a reminder window) currently displayed for this alarm,
01635                 // and we need to execute a command before displaying the new window.
01636                 // Check whether the command is already being executed for this alarm.
01637                 for (QValueList<ProcData*>::Iterator it = mCommandProcesses.begin();  it != mCommandProcesses.end();  ++it)
01638                 {
01639                     ProcData* pd = *it;
01640                     if (pd->event->id() == event.id()  &&  (pd->flags & ProcData::PRE_ACTION))
01641                     {
01642                         kdDebug(5950) << "KAlarmApp::execAlarm(): already executing pre-DISPLAY command" << endl;
01643                         return pd->process;   // already executing - don't duplicate the action
01644                     }
01645                 }
01646 
01647                 QString command = event.preAction();
01648                 kdDebug(5950) << "KAlarmApp::execAlarm(): pre-DISPLAY command: " << command << endl;
01649                 int flags = (reschedule ? ProcData::RESCHEDULE : 0) | (allowDefer ? ProcData::ALLOW_DEFER : 0);
01650                 if (doShellCommand(command, event, &alarm, (flags | ProcData::PRE_ACTION)))
01651                     return result;     // display the message after the command completes
01652                 // Error executing command - display the message even though it failed
01653             }
01654             if (!event.enabled())
01655                 delete win;        // event is disabled - close its window
01656             else if (!win
01657                  ||  !win->hasDefer() && !alarm.repeatAtLogin()
01658                  ||  replaceReminder)
01659             {
01660                 // Either there isn't already a message for this event,
01661                 // or there is a repeat-at-login message with no Defer
01662                 // button, which needs to be replaced with a new message,
01663                 // or the caption needs to be changed from "Reminder" to "Message".
01664                 if (win)
01665                     win->setRecreating();    // prevent post-alarm actions
01666                 delete win;
01667                 (new MessageWin(event, alarm, reschedule, allowDefer))->show();
01668             }
01669             else
01670             {
01671                 // Raise the existing message window and replay any sound
01672                 win->repeat(alarm);    // N.B. this reschedules the alarm
01673             }
01674             break;
01675         }
01676         case KAAlarm::COMMAND:
01677         {
01678             int flags = event.commandXterm() ? ProcData::EXEC_IN_XTERM : 0;
01679             QString command = event.cleanText();
01680             if (event.commandScript())
01681             {
01682                 // Store the command script in a temporary file for execution
01683                 kdDebug(5950) << "KAlarmApp::execAlarm(): COMMAND: (script)" << endl;
01684                 QString tmpfile = createTempScriptFile(command, false, event, alarm);
01685                 if (tmpfile.isEmpty())
01686                     result = 0;
01687                 else
01688                     result = doShellCommand(tmpfile, event, &alarm, (flags | ProcData::TEMP_FILE));
01689             }
01690             else
01691             {
01692                 kdDebug(5950) << "KAlarmApp::execAlarm(): COMMAND: " << command << endl;
01693                 result = doShellCommand(command, event, &alarm, flags);
01694             }
01695             if (reschedule)
01696                 rescheduleAlarm(event, alarm, true);
01697             break;
01698         }
01699         case KAAlarm::EMAIL:
01700         {
01701             kdDebug(5950) << "KAlarmApp::execAlarm(): EMAIL to: " << event.emailAddresses(", ") << endl;
01702             QStringList errmsgs;
01703             if (!KAMail::send(event, errmsgs, (reschedule || allowDefer)))
01704                 result = 0;
01705             if (!errmsgs.isEmpty())
01706             {
01707                 // Some error occurred, although the email may have been sent successfully
01708                 if (result)
01709                     kdDebug(5950) << "KAlarmApp::execAlarm(): copy error: " << errmsgs[1] << endl;
01710                 else
01711                     kdDebug(5950) << "KAlarmApp::execAlarm(): failed: " << errmsgs[1] << endl;
01712                 (new MessageWin(event, alarm.dateTime(), errmsgs))->show();
01713             }
01714             if (reschedule)
01715                 rescheduleAlarm(event, alarm, true);
01716             break;
01717         }
01718         default:
01719             return 0;
01720     }
01721     return result;
01722 }
01723 
01724 /******************************************************************************
01725 * Execute a shell command line specified by an alarm.
01726 * If the PRE_ACTION bit of 'flags' is set, the alarm will be executed via
01727 * execAlarm() once the command completes, the execAlarm() parameters being
01728 * derived from the remaining bits in 'flags'.
01729 */
01730 ShellProcess* KAlarmApp::doShellCommand(const QString& command, const KAEvent& event, const KAAlarm* alarm, int flags)
01731 {
01732     kdDebug(5950) << "KAlarmApp::doShellCommand(" << command << ", " << event.id() << ")" << endl;
01733     KProcess::Communication comms = KProcess::NoCommunication;
01734     QString cmd;
01735     QString tmpXtermFile;
01736     if (flags & ProcData::EXEC_IN_XTERM)
01737     {
01738         // Execute the command in a terminal window.
01739         cmd = Preferences::cmdXTermCommand();
01740         cmd.replace("%t", aboutData()->programName());     // set the terminal window title
01741         if (cmd.find("%C") >= 0)
01742         {
01743             // Execute the command from a temporary script file
01744             if (flags & ProcData::TEMP_FILE)
01745                 cmd.replace("%C", command);    // the command is already calling a temporary file
01746             else
01747             {
01748                 tmpXtermFile = createTempScriptFile(command, true, event, *alarm);
01749                 if (tmpXtermFile.isEmpty())
01750                     return 0;
01751                 cmd.replace("%C", tmpXtermFile);    // %C indicates where to insert the command
01752             }
01753         }
01754         else if (cmd.find("%W") >= 0)
01755         {
01756             // Execute the command from a temporary script file,
01757             // with a sleep after the command is executed
01758             tmpXtermFile = createTempScriptFile(command + QString::fromLatin1("\nsleep 86400\n"), true, event, *alarm);
01759             if (tmpXtermFile.isEmpty())
01760                 return 0;
01761             cmd.replace("%W", tmpXtermFile);    // %w indicates where to insert the command
01762         }
01763         else if (cmd.find("%w") >= 0)
01764         {
01765             // Append a sleep to the command.
01766             // Quote the command in case it contains characters such as [>|;].
01767             QString exec = KShellProcess::quote(command + QString::fromLatin1("; sleep 86400"));
01768             cmd.replace("%w", exec);    // %w indicates where to insert the command string
01769         }
01770         else
01771         {
01772             // Set the command to execute.
01773             // Put it in quotes in case it contains characters such as [>|;].
01774             QString exec = KShellProcess::quote(command);
01775             if (cmd.find("%c") >= 0)
01776                 cmd.replace("%c", exec);    // %c indicates where to insert the command string
01777             else
01778                 cmd.append(exec);           // otherwise, simply append the command string
01779         }
01780     }
01781     else
01782     {
01783         cmd = command;
01784         comms = KProcess::AllOutput;
01785     }
01786     ShellProcess* proc = new ShellProcess(cmd);
01787     connect(proc, SIGNAL(shellExited(ShellProcess*)), SLOT(slotCommandExited(ShellProcess*)));
01788     QGuardedPtr<ShellProcess> logproc = 0;
01789     if (comms == KProcess::AllOutput  &&  !event.logFile().isEmpty())
01790     {
01791         // Output is to be appended to a log file.
01792         // Set up a logging process to write the command's output to.
01793         connect(proc, SIGNAL(receivedStdout(KProcess*,char*,int)), SLOT(slotCommandOutput(KProcess*,char*,int)));
01794         connect(proc, SIGNAL(receivedStderr(KProcess*,char*,int)), SLOT(slotCommandOutput(KProcess*,char*,int)));
01795         logproc = new ShellProcess(QString::fromLatin1("cat >>%1").arg(event.logFile()));
01796         connect(logproc, SIGNAL(shellExited(ShellProcess*)), SLOT(slotLogProcExited(ShellProcess*)));
01797         logproc->start(KProcess::Stdin);
01798         QCString heading;
01799         if (alarm  &&  alarm->dateTime().isValid())
01800         {
01801             QString dateTime = alarm->dateTime().isDateOnly()
01802                              ? KGlobal::locale()->formatDate(alarm->dateTime().date(), true)
01803                              : KGlobal::locale()->formatDateTime(alarm->dateTime().dateTime());
01804             heading.sprintf("\n******* KAlarm %s *******\n", dateTime.latin1());
01805         }
01806         else
01807             heading = "\n******* KAlarm *******\n";
01808         logproc->writeStdin(heading, heading.length()+1);
01809     }
01810     ProcData* pd = new ProcData(proc, logproc, new KAEvent(event), (alarm ? new KAAlarm(*alarm) : 0), flags);
01811     if (flags & ProcData::TEMP_FILE)
01812         pd->tempFiles += command;
01813     if (!tmpXtermFile.isEmpty())
01814         pd->tempFiles += tmpXtermFile;
01815     mCommandProcesses.append(pd);
01816     if (proc->start(comms))
01817         return proc;
01818 
01819     // Error executing command - report it
01820     kdError(5950) << "KAlarmApp::doShellCommand(): command failed to start\n";
01821     commandErrorMsg(proc, event, alarm, flags);
01822     mCommandProcesses.remove(pd);
01823     delete pd;
01824     return 0;
01825 }
01826 
01827 /******************************************************************************
01828 * Create a temporary script file containing the specified command string.
01829 * Reply = path of temporary file, or null string if error.
01830 */
01831 QString KAlarmApp::createTempScriptFile(const QString& command, bool insertShell, const KAEvent& event, const KAAlarm& alarm)
01832 {
01833     KTempFile tmpFile(QString::null, QString::null, 0700);
01834     tmpFile.setAutoDelete(false);     // don't delete file when it is destructed
01835     QTextStream* stream = tmpFile.textStream();
01836     if (!stream)
01837         kdError(5950) << "KAlarmApp::createTempScript(): Unable to create a temporary script file" << endl;
01838     else
01839     {
01840         if (insertShell)
01841             *stream << "#!" << ShellProcess::shellPath() << "\n";
01842         *stream << command;
01843         tmpFile.close();
01844         if (tmpFile.status())
01845             kdError(5950) << "KAlarmApp::createTempScript(): Error " << tmpFile.status() << " writing to temporary script file" << endl;
01846         else
01847             return tmpFile.name();
01848     }
01849 
01850     QStringList errmsgs(i18n("Error creating temporary script file"));
01851     (new MessageWin(event, alarm.dateTime(), errmsgs))->show();
01852     return QString::null;
01853 }
01854 
01855 /******************************************************************************
01856 * Called when an executing command alarm sends output to stdout or stderr.
01857 */
01858 void KAlarmApp::slotCommandOutput(KProcess* proc, char* buffer, int bufflen)
01859 {
01860 //kdDebug(5950) << "KAlarmApp::slotCommandOutput(): '" << QCString(buffer, bufflen+1) << "'\n";
01861     // Find this command in the command list
01862     for (QValueList<ProcData*>::Iterator it = mCommandProcesses.begin();  it != mCommandProcesses.end();  ++it)
01863     {
01864         ProcData* pd = *it;
01865         if (pd->process == proc  &&  pd->logProcess)
01866         {
01867             pd->logProcess->writeStdin(buffer, bufflen);
01868             break;
01869         }
01870     }
01871 }
01872 
01873 /******************************************************************************
01874 * Called when a logging process completes.
01875 */
01876 void KAlarmApp::slotLogProcExited(ShellProcess* proc)
01877 {
01878     // Because it's held as a guarded pointer in the ProcData structure,
01879     // we don't need to set any pointers to zero.
01880     delete proc;
01881 }
01882 
01883 /******************************************************************************
01884 * Called when a command alarm's execution completes.
01885 */
01886 void KAlarmApp::slotCommandExited(ShellProcess* proc)
01887 {
01888     kdDebug(5950) << "KAlarmApp::slotCommandExited()\n";
01889     // Find this command in the command list
01890     for (QValueList<ProcData*>::Iterator it = mCommandProcesses.begin();  it != mCommandProcesses.end();  ++it)
01891     {
01892         ProcData* pd = *it;
01893         if (pd->process == proc)
01894         {
01895             // Found the command
01896             if (pd->logProcess)
01897                 pd->logProcess->stdinExit();   // terminate the logging process
01898 
01899             // Check its exit status
01900             if (!proc->normalExit())
01901             {
01902                 QString errmsg = proc->errorMessage();
01903                 kdWarning(5950) << "KAlarmApp::slotCommandExited(" << pd->event->cleanText() << "): " << errmsg << endl;
01904                 if (pd->messageBoxParent)
01905                 {
01906                     // Close the existing informational KMessageBox for this process
01907                     QObjectList* dialogs = pd->messageBoxParent->queryList("KDialogBase", 0, false, true);
01908                     KDialogBase* dialog = (KDialogBase*)dialogs->getFirst();
01909                     delete dialog;
01910                     delete dialogs;
01911                     if (!pd->tempFile())
01912                     {
01913                         errmsg += '\n';
01914                         errmsg += proc->command();
01915                     }
01916                     KMessageBox::error(pd->messageBoxParent, errmsg);
01917                 }
01918                 else
01919                     commandErrorMsg(proc, *pd->event, pd->alarm, pd->flags);
01920             }
01921             if (pd->preAction())
01922                 execAlarm(*pd->event, *pd->alarm, pd->reschedule(), pd->allowDefer(), true);
01923             mCommandProcesses.remove(it);
01924             delete pd;
01925             break;
01926         }
01927     }
01928 
01929     // If there are now no executing shell commands, quit if a quit was queued
01930     if (mPendingQuit  &&  mCommandProcesses.isEmpty())
01931         quitIf(mPendingQuitCode);
01932 }
01933 
01934 /******************************************************************************
01935 * Output an error message for a shell command.
01936 */
01937 void KAlarmApp::commandErrorMsg(const ShellProcess* proc, const KAEvent& event, const KAAlarm* alarm, int flags)
01938 {
01939     QStringList errmsgs;
01940     if (flags & ProcData::PRE_ACTION)
01941         errmsgs += i18n("Pre-alarm action:");
01942     else if (flags & ProcData::POST_ACTION)
01943         errmsgs += i18n("Post-alarm action:");
01944     errmsgs += proc->errorMessage();
01945     if (!(flags & ProcData::TEMP_FILE))
01946         errmsgs += proc->command();
01947     (new MessageWin(event, (alarm ? alarm->dateTime() : DateTime()), errmsgs))->show();
01948 }
01949 
01950 /******************************************************************************
01951 * Notes that an informational KMessageBox is displayed for this process.
01952 */
01953 void KAlarmApp::commandMessage(ShellProcess* proc, QWidget* parent)
01954 {
01955     // Find this command in the command list
01956     for (QValueList<ProcData*>::Iterator it = mCommandProcesses.begin();  it != mCommandProcesses.end();  ++it)
01957     {
01958         ProcData* pd = *it;
01959         if (pd->process == proc)
01960         {
01961             pd->messageBoxParent = parent;
01962             break;
01963         }
01964     }
01965 }
01966 
01967 /******************************************************************************
01968 * Set up remaining DCOP handlers and start processing DCOP calls.
01969 */
01970 void KAlarmApp::setUpDcop()
01971 {
01972     if (!mInitialised)
01973     {
01974         mInitialised = true;      // we're now ready to handle DCOP calls
01975         Daemon::createDcopHandler();
01976         QTimer::singleShot(0, this, SLOT(processQueue()));    // process anything already queued
01977     }
01978 }
01979 
01980 /******************************************************************************
01981 * If this is the first time through, open the calendar file, optionally start
01982 * the alarm daemon and register with it, and set up the DCOP handler.
01983 */
01984 bool KAlarmApp::initCheck(bool calendarOnly)
01985 {
01986     bool startdaemon;
01987     AlarmCalendar* cal = AlarmCalendar::activeCalendar();
01988     if (!cal->isOpen())
01989     {
01990         kdDebug(5950) << "KAlarmApp::initCheck(): opening active calendar\n";
01991 
01992         // First time through. Open the calendar file.
01993         if (!cal->open())
01994             return false;
01995 
01996         if (!mStartOfDay.isValid())
01997             changeStartOfDay();     // start of day time has changed, so adjust date-only alarms
01998 
01999         /* Need to open the display calendar now, since otherwise if the daemon
02000          * immediately notifies display alarms, they will often be processed while
02001          * redisplayAlarms() is executing open() (but before open() completes),
02002          * which causes problems!!
02003          */
02004         AlarmCalendar::displayCalendar()->open();
02005 
02006         /* Need to open the expired alarm calendar now, since otherwise if the daemon
02007          * immediately notifies multiple alarms, the second alarm is likely to be
02008          * processed while the calendar is executing open() (but before open() completes),
02009          * which causes a hang!!
02010          */
02011         AlarmCalendar::expiredCalendar()->open();
02012         AlarmCalendar::expiredCalendar()->setPurgeDays(theInstance->mPrefsExpiredKeepDays);
02013 
02014         startdaemon = true;
02015     }
02016     else
02017         startdaemon = !Daemon::isRegistered();
02018 
02019     if (!calendarOnly)
02020     {
02021         setUpDcop();      // start processing DCOP calls
02022         if (startdaemon)
02023             Daemon::start();  // make sure the alarm daemon is running
02024     }
02025     return true;
02026 }
02027 
02028 /******************************************************************************
02029 *  Convert the --time parameter string into a date/time or date value.
02030 *  The parameter is in the form [[[yyyy-]mm-]dd-]hh:mm or yyyy-mm-dd.
02031 *  Reply = true if successful.
02032 */
02033 static bool convWakeTime(const QCString& timeParam, QDateTime& dateTime, bool& noTime)
02034 {
02035     if (timeParam.length() > 19)
02036         return false;
02037     char timeStr[20];
02038     strcpy(timeStr, timeParam);
02039     int dt[5] = { -1, -1, -1, -1, -1 };
02040     char* s;
02041     char* end;
02042     // Get the minute value
02043     if ((s = strchr(timeStr, ':')) == 0)
02044         noTime = true;
02045     else
02046     {
02047         noTime = false;
02048         *s++ = 0;
02049         dt[4] = strtoul(s, &end, 10);
02050         if (end == s  ||  *end  ||  dt[4] >= 60)
02051             return false;
02052         // Get the hour value
02053         if ((s = strrchr(timeStr, '-')) == 0)
02054             s = timeStr;
02055         else
02056             *s++ = 0;
02057         dt[3] = strtoul(s, &end, 10);
02058         if (end == s  ||  *end  ||  dt[3] >= 24)
02059             return false;
02060     }
02061     bool dateSet = false;
02062     if (s != timeStr)
02063     {
02064         dateSet = true;
02065         // Get the day value
02066         if ((s = strrchr(timeStr, '-')) == 0)
02067             s = timeStr;
02068         else
02069             *s++ = 0;
02070         dt[2] = strtoul(s, &end, 10);
02071         if (end == s  ||  *end  ||  dt[2] == 0  ||  dt[2] > 31)
02072             return false;
02073         if (s != timeStr)
02074         {
02075             // Get the month value
02076             if ((s = strrchr(timeStr, '-')) == 0)
02077                 s = timeStr;
02078             else
02079                 *s++ = 0;
02080             dt[1] = strtoul(s, &end, 10);
02081             if (end == s  ||  *end  ||  dt[1] == 0  ||  dt[1] > 12)
02082                 return false;
02083             if (s != timeStr)
02084             {
02085                 // Get the year value
02086                 dt[0] = strtoul(timeStr, &end, 10);
02087                 if (end == timeStr  ||  *end)
02088                     return false;
02089             }
02090         }
02091     }
02092 
02093     QDate date(dt[0], dt[1], dt[2]);
02094     QTime time(0, 0, 0);
02095     if (noTime)
02096     {
02097         // No time was specified, so the full date must have been specified
02098         if (dt[0] < 0)
02099             return false;
02100     }
02101     else
02102     {
02103         // Compile the values into a date/time structure
02104         QDateTime now = QDateTime::currentDateTime();
02105         if (dt[0] < 0)
02106             date.setYMD(now.date().year(),
02107                         (dt[1] < 0 ? now.date().month() : dt[1]),
02108                         (dt[2] < 0 ? now.date().day() : dt[2]));
02109         time.setHMS(dt[3], dt[4], 0);
02110         if (!dateSet  &&  time < now.time())
02111             date = date.addDays(1);
02112     }
02113     if (!date.isValid())
02114         return false;
02115     dateTime.setDate(date);
02116     dateTime.setTime(time);
02117     return true;
02118 }
02119 
02120 /******************************************************************************
02121 *  Convert a time interval command line parameter.
02122 *  Reply = true if successful.
02123 */
02124 static bool convInterval(const QCString& timeParam, KARecurrence::Type& recurType, int& timeInterval, bool allowMonthYear)
02125 {
02126     QCString timeString = timeParam;
02127     // Get the recurrence interval
02128     bool ok = true;
02129     uint interval = 0;
02130     bool negative = (timeString[0] == '-');
02131     if (negative)
02132         timeString = timeString.right(1);
02133     uint length = timeString.length();
02134     switch (timeString[length - 1])
02135     {
02136         case 'Y':
02137             if (!allowMonthYear)
02138                 ok = false;
02139             recurType = KARecurrence::ANNUAL_DATE;
02140             timeString = timeString.left(length - 1);
02141             break;
02142         case 'W':
02143             recurType = KARecurrence::WEEKLY;
02144             timeString = timeString.left(length - 1);
02145             break;
02146         case 'D':
02147             recurType = KARecurrence::DAILY;
02148             timeString = timeString.left(length - 1);
02149             break;
02150         case 'M':
02151         {
02152             int i = timeString.find('H');
02153             if (i < 0)
02154             {
02155                 if (!allowMonthYear)
02156                     ok = false;
02157                 recurType = KARecurrence::MONTHLY_DAY;
02158                 timeString = timeString.left(length - 1);
02159             }
02160             else
02161             {
02162                 recurType = KARecurrence::MINUTELY;
02163                 interval = timeString.left(i).toUInt(&ok) * 60;
02164                 timeString = timeString.mid(i + 1, length - i - 2);
02165             }
02166             break;
02167         }
02168         default:       // should be a digit
02169             recurType = KARecurrence::MINUTELY;
02170             break;
02171     }
02172     if (ok)
02173         interval += timeString.toUInt(&ok);
02174     timeInterval = static_cast<int>(interval);
02175     if (negative)
02176         timeInterval = -timeInterval;
02177     return ok;
02178 }
02179 
02180 KAlarmApp::ProcData::ProcData(ShellProcess* p, ShellProcess* logp, KAEvent* e, KAAlarm* a, int f)
02181     : process(p),
02182       logProcess(logp),
02183       event(e),
02184       alarm(a),
02185       messageBoxParent(0),
02186       flags(f)
02187 { }
02188 
02189 KAlarmApp::ProcData::~ProcData()
02190 {
02191     while (!tempFiles.isEmpty())
02192     {
02193         // Delete the temporary file called by the XTerm command
02194         QFile f(tempFiles.first());
02195         f.remove();
02196         tempFiles.remove(tempFiles.begin());
02197     }
02198     delete process;
02199     delete event;
02200     delete alarm;
02201 }
KDE Home | KDE Accessibility Home | Description of Access Keys