summaryrefslogtreecommitdiffstats
path: root/kmail/jobscheduler.cpp
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commit460c52653ab0dcca6f19a4f492ed2c5e4e963ab0 (patch)
tree67208f7c145782a7e90b123b982ca78d88cc2c87 /kmail/jobscheduler.cpp
downloadtdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.tar.gz
tdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdepim@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kmail/jobscheduler.cpp')
-rw-r--r--kmail/jobscheduler.cpp256
1 files changed, 256 insertions, 0 deletions
diff --git a/kmail/jobscheduler.cpp b/kmail/jobscheduler.cpp
new file mode 100644
index 000000000..cedb530be
--- /dev/null
+++ b/kmail/jobscheduler.cpp
@@ -0,0 +1,256 @@
+/**
+ * Copyright (c) 2004 David Faure <faure@kde.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * In addition, as a special exception, the copyright holders give
+ * permission to link the code of this program with any edition of
+ * the Qt library by Trolltech AS, Norway (or with modified versions
+ * of Qt that use the same license as Qt), and distribute linked
+ * combinations including the two. You must obey the GNU General
+ * Public License in all respects for all of the code used other than
+ * Qt. If you modify this file, you may extend this exception to
+ * your version of the file, but you are not obligated to do so. If
+ * you do not wish to do so, delete this exception statement from
+ * your version.
+ */
+
+#include "jobscheduler.h"
+#include "kmfolder.h"
+#include "folderstorage.h"
+#include "kmfoldermgr.h"
+#include <kdebug.h>
+
+using namespace KMail;
+
+JobScheduler::JobScheduler( QObject* parent, const char* name )
+ : QObject( parent, name ), mTimer( this, "mTimer" ),
+ mPendingImmediateTasks( 0 ),
+ mCurrentTask( 0 ), mCurrentJob( 0 )
+{
+ connect( &mTimer, SIGNAL( timeout() ), SLOT( slotRunNextJob() ) );
+ // No need to start the internal timer yet, we wait for a task to be scheduled
+}
+
+
+JobScheduler::~JobScheduler()
+{
+ // delete tasks in tasklist (no autodelete for QValueList)
+ for( TaskList::Iterator it = mTaskList.begin(); it != mTaskList.end(); ++it ) {
+ delete (*it);
+ }
+ delete mCurrentTask;
+ delete mCurrentJob;
+}
+
+void JobScheduler::registerTask( ScheduledTask* task )
+{
+ bool immediate = task->isImmediate();
+ int typeId = task->taskTypeId();
+ if ( typeId ) {
+ KMFolder* folder = task->folder();
+ // Search for an identical task already scheduled
+ for( TaskList::Iterator it = mTaskList.begin(); it != mTaskList.end(); ++it ) {
+ if ( (*it)->taskTypeId() == typeId && (*it)->folder() == folder ) {
+#ifdef DEBUG_SCHEDULER
+ kdDebug(5006) << "JobScheduler: already having task type " << typeId << " for folder " << folder->label() << endl;
+#endif
+ delete task;
+ if ( !mCurrentTask && immediate ) {
+ ScheduledTask* task = *it;
+ removeTask( it );
+ runTaskNow( task );
+ }
+ return;
+ }
+ }
+ // Note that scheduling an identical task as the one currently running is allowed.
+ }
+ if ( !mCurrentTask && immediate )
+ runTaskNow( task );
+ else {
+#ifdef DEBUG_SCHEDULER
+ kdDebug(5006) << "JobScheduler: adding task " << task << " (type " << task->taskTypeId()
+ << ") for folder " << task->folder() << " " << task->folder()->label() << endl;
+#endif
+ mTaskList.append( task );
+ if ( immediate )
+ ++mPendingImmediateTasks;
+ if ( !mCurrentTask && !mTimer.isActive() )
+ restartTimer();
+ }
+}
+
+void JobScheduler::removeTask( TaskList::Iterator& it )
+{
+ if ( (*it)->isImmediate() )
+ --mPendingImmediateTasks;
+ mTaskList.remove( it );
+}
+
+void JobScheduler::notifyOpeningFolder( KMFolder* folder )
+{
+ if ( mCurrentTask && mCurrentTask->folder() == folder ) {
+ if ( mCurrentJob->isOpeningFolder() ) { // set when starting a job for this folder
+#ifdef DEBUG_SCHEDULER
+ kdDebug(5006) << "JobScheduler: got the opening-notification for " << folder->label() << " as expected." << endl;
+#endif
+ } else {
+ // Jobs scheduled from here should always be cancellable.
+ // One exception though, is when ExpireJob does its final KMMoveCommand.
+ // Then that command shouldn't kill its own parent job just because it opens a folder...
+ if ( mCurrentJob->isCancellable() )
+ interruptCurrentTask();
+ }
+ }
+}
+
+void JobScheduler::interruptCurrentTask()
+{
+ Q_ASSERT( mCurrentTask );
+#ifdef DEBUG_SCHEDULER
+ kdDebug(5006) << "JobScheduler: interrupting job " << mCurrentJob << " for folder " << mCurrentTask->folder()->label() << endl;
+#endif
+ // File it again. This will either delete it or put it in mTaskList.
+ registerTask( mCurrentTask );
+ mCurrentTask = 0;
+ mCurrentJob->kill(); // This deletes the job and calls slotJobFinished!
+}
+
+void JobScheduler::slotRunNextJob()
+{
+ while ( !mCurrentJob ) {
+#ifdef DEBUG_SCHEDULER
+ kdDebug(5006) << "JobScheduler: slotRunNextJob" << endl;
+#endif
+ Q_ASSERT( mCurrentTask == 0 );
+ ScheduledTask* task = 0;
+ // Find a task suitable for being run
+ for( TaskList::Iterator it = mTaskList.begin(); it != mTaskList.end(); ++it ) {
+ // Remove if folder died
+ KMFolder* folder = (*it)->folder();
+ if ( folder == 0 ) {
+#ifdef DEBUG_SCHEDULER
+ kdDebug(5006) << " folder for task " << (*it) << " was deleted" << endl;
+#endif
+ removeTask( it );
+ if ( !mTaskList.isEmpty() )
+ slotRunNextJob(); // to avoid the mess with invalid iterators :)
+ else
+ mTimer.stop();
+ return;
+ }
+ // The condition is that the folder must be unused (not open)
+ // But first we ask search folders to release their access to it
+ kmkernel->searchFolderMgr()->tryReleasingFolder( folder );
+#ifdef DEBUG_SCHEDULER
+ kdDebug(5006) << " looking at folder " << folder->label()
+ << " " << folder->location()
+ << " isOpened=" << (*it)->folder()->isOpened() << endl;
+#endif
+ if ( !folder->isOpened() ) {
+ task = *it;
+ removeTask( it );
+ break;
+ }
+ }
+
+ if ( !task ) // found nothing to run, i.e. folder was opened
+ return; // Timer keeps running, i.e. try again in 1 minute
+
+ runTaskNow( task );
+ } // If nothing to do for that task, loop and find another one to run
+}
+
+void JobScheduler::restartTimer()
+{
+ if ( mPendingImmediateTasks > 0 )
+ slotRunNextJob();
+ else
+ {
+#ifdef DEBUG_SCHEDULER
+ mTimer.start( 10000 ); // 10 seconds
+#else
+ mTimer.start( 1 * 60000 ); // 1 minute
+#endif
+ }
+}
+
+void JobScheduler::runTaskNow( ScheduledTask* task )
+{
+ Q_ASSERT( mCurrentTask == 0 );
+ if ( mCurrentTask ) {
+ interruptCurrentTask();
+ }
+ mCurrentTask = task;
+ mTimer.stop();
+ mCurrentJob = mCurrentTask->run();
+#ifdef DEBUG_SCHEDULER
+ kdDebug(5006) << "JobScheduler: task " << mCurrentTask
+ << " (type " << mCurrentTask->taskTypeId() << ")"
+ << " for folder " << mCurrentTask->folder()->label()
+ << " returned job " << mCurrentJob << " "
+ << ( mCurrentJob?mCurrentJob->className():0 ) << endl;
+#endif
+ if ( !mCurrentJob ) { // nothing to do, e.g. folder deleted
+ delete mCurrentTask;
+ mCurrentTask = 0;
+ if ( !mTaskList.isEmpty() )
+ restartTimer();
+ return;
+ }
+ // Register the job in the folder. This makes it autodeleted if the folder is deleted.
+ mCurrentTask->folder()->storage()->addJob( mCurrentJob );
+ connect( mCurrentJob, SIGNAL( finished() ), this, SLOT( slotJobFinished() ) );
+ mCurrentJob->start();
+}
+
+void JobScheduler::slotJobFinished()
+{
+ // Do we need to test for mCurrentJob->error()? What do we do then?
+#ifdef DEBUG_SCHEDULER
+ kdDebug(5006) << "JobScheduler: slotJobFinished" << endl;
+#endif
+ delete mCurrentTask;
+ mCurrentTask = 0;
+ mCurrentJob = 0;
+ if ( !mTaskList.isEmpty() )
+ restartTimer();
+}
+
+// DCOP call to pause any background jobs
+void JobScheduler::pause()
+{
+ mPendingImmediateTasks = 0;
+ if ( mCurrentJob && mCurrentJob->isCancellable() )
+ interruptCurrentTask();
+ mTimer.stop();
+}
+
+void JobScheduler::resume()
+{
+ restartTimer();
+}
+
+////
+
+KMail::ScheduledJob::ScheduledJob( KMFolder* folder, bool immediate )
+ : FolderJob( 0, tOther, folder ), mImmediate( immediate ),
+ mOpeningFolder( false )
+{
+ mCancellable = true;
+ mSrcFolder = folder;
+}
+
+#include "jobscheduler.moc"