Proposal for an (d)imap list job.

I did a fast test with online imap and it just works ;-) This fixes the bug with concurrent listings for one account. Not enabled by now, comments welcome! svn path=/trunk/kdepim/; revision=314558
22 years ago · 6b18f8f63d
parent da1cf778d3
commit 6b18f8f63d
2 changed files with 416 additions and 0 deletions
--- a/listjob.cpp
+++ b/listjob.cpp
@ -0,0 +1,278 @@
+/**
+ * Copyright (c) 2004 Carsten Burghardt <burghardt@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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 "listjob.h"
+#include "kmfolderimap.h"
+#include "kmfoldercachedimap.h"
+#include "kmacctimap.h"
+#include "kmacctcachedimap.h"
+#include "folderstorage.h"
+
+#include <kdebug.h>
+#include <kurl.h>
+#include <kio/scheduler.h>
+#include <kio/job.h>
+#include <kio/global.h>
+#include <klocale.h>
+
+using namespace KMail;
+
+ListJob::ListJob( FolderStorage* storage, ImapAccountBase* account,
+   bool secondStep, bool complete, bool hasInbox )
+ : FolderJob( 0, tOther, storage->folder() ), mAccount( account ),
+   mHasInbox( hasInbox ), mSecondStep( secondStep ), mComplete( complete )
+{
+}
+
+ListJob::~ListJob()
+{
+}
+
+void ListJob::execute()
+{
+}
+
+void ListJob::doListing( const KURL& url, const ImapAccountBase::jobData& jd )
+{
+  KIO::SimpleJob *job = KIO::listDir( url, false );
+  KIO::Scheduler::assignJobToSlave( mAccount->slave(), job );
+  mAccount->insertJob( job, jd );
+  connect( job, SIGNAL(result(KIO::Job *)),
+      this, SLOT(slotListResult(KIO::Job *)) );
+  connect( job, SIGNAL(entries(KIO::Job *, const KIO::UDSEntryList &)),
+      this, SLOT(slotListEntries(KIO::Job *, const KIO::UDSEntryList &)) );
+}
+
+void ListJob::slotListResult( KIO::Job* )
+{
+}
+
+void ListJob::slotListEntries( KIO::Job* job, const KIO::UDSEntryList& uds )
+{
+  ImapAccountBase::JobIterator it = mAccount->findJob( job );
+  if ( it == mAccount->jobsEnd() )
+  {
+    delete this;
+    return;
+  }
+  QString name;
+  KURL url;
+  QString mimeType;
+  QString attributes;
+  for ( KIO::UDSEntryList::ConstIterator udsIt = uds.begin();
+        udsIt != uds.end(); udsIt++ )
+  {
+    mimeType = QString::null;
+    attributes = QString::null;
+    for ( KIO::UDSEntry::ConstIterator eIt = (*udsIt).begin();
+          eIt != (*udsIt).end(); eIt++ )
+    {
+      // get the needed information
+      if ( (*eIt).m_uds == KIO::UDS_NAME )
+        name = (*eIt).m_str;
+      else if ( (*eIt).m_uds == KIO::UDS_URL )
+        url = KURL((*eIt).m_str, 106); // utf-8
+      else if ( (*eIt).m_uds == KIO::UDS_MIME_TYPE )
+        mimeType = (*eIt).m_str;
+      else if ( (*eIt).m_uds == KIO::UDS_EXTRA )
+        attributes = (*eIt).m_str;
+    }
+    if ( (mimeType == "inode/directory" || mimeType == "message/digest"
+          || mimeType == "message/directory")
+         && name != ".." && (mAccount->hiddenFolders() || name.at(0) != '.')
+         && (!(*it).inboxOnly || name.upper() == "INBOX") )
+    {
+      if ( ((*it).inboxOnly ||
+            url.path() == "/INBOX/") && name.upper() == "INBOX" &&
+           !mHasInbox )
+      {
+        // our INBOX
+        (*it).createInbox = true;
+      }
+
+      // Some servers send _lots_ of duplicates
+      // This check is too slow for huge lists
+      if ( mSubfolderPaths.count() > 100 ||
+           mSubfolderPaths.findIndex(url.path()) == -1 )
+      {
+        mSubfolderNames.append( name );
+        mSubfolderPaths.append( url.path() );
+        mSubfolderMimeTypes.append( mimeType );
+        mSubfolderAttributes.append( attributes );
+      }
+    }
+  }
+}
+
+
+//============================================================================//
+
+
+ImapListJob::ImapListJob( KMFolderImap* folder, KMAcctImap* account,
+    bool secondStep, bool complete, bool hasInbox )
+ : ListJob( folder, account, secondStep, complete, hasInbox ), mFolder( folder )
+{
+}
+
+ImapListJob::~ImapListJob()
+{
+}
+
+void ImapListJob::execute()
+{
+  if ( mAccount->makeConnection() == ImapAccountBase::Error )
+  {
+    delete this;
+    return;
+  }
+  // (un)subscribed
+  ImapAccountBase::ListType type = ( mAccount->onlySubscribedFolders() ? 
+      ImapAccountBase::ListSubscribed : ImapAccountBase::List );
+  // create jobData
+  ImapAccountBase::jobData jd;
+  jd.total = 1; jd.done = 0;
+  jd.cancellable = true;
+  jd.createInbox = ( mSecondStep && !mHasInbox ) ? true : false;
+  jd.parent = mDestFolder;
+  jd.onlySubscribed = ( type != ImapAccountBase::List );
+  jd.path = mFolder->imapPath();
+  // this is needed if you have a prefix
+  // as the INBOX is located in your root ("/") and needs a special listing
+  jd.inboxOnly = !mSecondStep && mAccount->prefix() != "/"
+    && mFolder->imapPath() == mAccount->prefix() && !mHasInbox;
+  // make the URL
+  QString ltype = "LIST";
+  if ( type == ImapAccountBase::ListSubscribed )
+    ltype = "LSUB";
+  else if ( type == ImapAccountBase::ListSubscribedNoCheck )
+    ltype = "LSUBNOCHECK";
+  KURL url = mAccount->getUrl();
+  url.setPath( ( jd.inboxOnly ? QString("/") : mFolder->imapPath() )
+      + ";TYPE=" + ltype
+      + ( mComplete ? ";SECTION=COMPLETE" : QString::null) );
+
+  doListing( url, jd );
+}
+
+void ImapListJob::slotListResult( KIO::Job* job )
+{
+  ImapAccountBase::JobIterator it = mAccount->findJob( job );
+  if ( it == mAccount->jobsEnd() )
+  {
+    delete this;
+    return;
+  }
+  if ( job->error() )
+  {
+    mAccount->handleJobError( job, 
+        i18n( "Error while listing folder %1: " ).arg((*it).path),
+        true ); 
+  } else
+  {
+    // transport the information, include the jobData
+    mFolder->slotListResult( mSubfolderNames, mSubfolderPaths, 
+        mSubfolderMimeTypes, mSubfolderAttributes, *it );
+  }
+  mAccount->removeJob( it );
+  delete this;
+}
+
+
+//============================================================================//
+
+
+DImapListJob::DImapListJob( KMFolderCachedImap* folder, KMAcctCachedImap* account,
+    bool secondStep, bool complete, bool hasInbox )
+ : ListJob( folder, account, secondStep, complete, hasInbox ), mFolder( folder )
+{
+}
+
+DImapListJob::~DImapListJob()
+{
+}
+
+void DImapListJob::execute()
+{
+  if ( mAccount->makeConnection() == ImapAccountBase::Error )
+  {
+    delete this;
+    return;
+  }
+  // (un)subscribed
+  ImapAccountBase::ListType type = ( mAccount->onlySubscribedFolders() ? 
+      ImapAccountBase::ListSubscribed : ImapAccountBase::List );
+  // create jobData
+  ImapAccountBase::jobData jd;
+  jd.total = 1; jd.done = 0;
+  jd.cancellable = true;
+  jd.createInbox = ( mSecondStep && !mHasInbox ) ? true : false;
+  jd.parent = mDestFolder;
+  jd.onlySubscribed = ( type != ImapAccountBase::List );
+  jd.path = mFolder->imapPath();
+  // this is needed if you have a prefix
+  // as the INBOX is located in your root ("/") and needs a special listing
+  jd.inboxOnly = !mSecondStep && mAccount->prefix() != "/"
+    && mFolder->imapPath() == mAccount->prefix() && !mHasInbox;
+  // make the URL
+  QString ltype = "LIST";
+  if ( type == ImapAccountBase::ListSubscribed )
+    ltype = "LSUB";
+  else if ( type == ImapAccountBase::ListSubscribedNoCheck )
+    ltype = "LSUBNOCHECK";
+  KURL url = mAccount->getUrl();
+  url.setPath( ( jd.inboxOnly ? QString("/") : mFolder->imapPath() )
+      + ";TYPE=" + ltype
+      + ( mComplete ? ";SECTION=COMPLETE" : QString::null) );
+
+  doListing( url, jd );
+}
+
+void DImapListJob::slotListResult( KIO::Job* job )
+{
+  ImapAccountBase::JobIterator it = mAccount->findJob( job );
+  if ( it == mAccount->jobsEnd() ) 
+  {
+    delete this;
+    return;
+  }
+  if ( job->error() )
+  {
+    mAccount->handleJobError( job, 
+        i18n( "Error while listing folder %1: " ).arg((*it).path),
+        true ); 
+  } else
+  {
+    // transport the information, include the jobData
+    mFolder->slotListResult( mSubfolderNames, mSubfolderPaths, 
+        mSubfolderMimeTypes, mSubfolderAttributes, *it );
+  }
+  mAccount->removeJob( it );
+  delete this;
+}
+
+#include "listjob.moc"
--- a/listjob.h
+++ b/listjob.h
@ -0,0 +1,138 @@
+/**
+ * Copyright (c) 2004 Carsten Burghardt <burghardt@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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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.
+ */
+#ifndef LISTJOB_H
+#define LISTJOB_H
+
+#include "folderjob.h"
+#include "imapaccountbase.h"
+
+class KMFolderImap;
+class KMFolderCachedImap;
+class KMAcctImap;
+class KMAcctCachedImap;
+class FolderStorage;
+class KURL;
+
+namespace KIO {
+  class Job;
+}
+
+namespace KMail {
+
+/**
+ * Generic folder list job for (d)imap accounts
+ */ 
+class ListJob : public FolderJob
+{
+  Q_OBJECT
+public:
+  ListJob( FolderStorage* storage, ImapAccountBase* account,
+           bool secondStep = false, bool complete = false, 
+           bool hasInbox = false );
+
+  virtual ~ListJob();
+
+  virtual void execute();
+
+protected:
+  /**
+   * Does the actual KIO::listDir
+   */ 
+  void doListing( const KURL& url, const ImapAccountBase::jobData& jd );
+
+protected slots:
+  /**
+   * Is called when the listing is done
+   * Passes the folders and the jobData to the responding folder
+   */ 
+  void slotListResult( KIO::Job* job );
+
+  /**
+   * Collects the folder information
+   */ 
+  void slotListEntries( KIO::Job* job, const KIO::UDSEntryList& uds );
+
+protected:
+  ImapAccountBase* mAccount;
+  bool mHasInbox;
+  bool mSecondStep;
+  bool mComplete;
+  QStringList mSubfolderNames, mSubfolderPaths, 
+              mSubfolderMimeTypes, mSubfolderAttributes;
+};
+
+//---------------------------------------------------------------------------//
+
+class ImapListJob : public ListJob
+{
+  Q_OBJECT
+public:
+  ImapListJob( KMFolderImap* folder, KMAcctImap* account,
+               bool secondStep = false, bool complete = false, 
+               bool hasInbox = false );
+  virtual ~ImapListJob();
+
+  virtual void execute();
+
+protected slots:
+  /**
+   * Reimplemented
+   */ 
+  void slotListResult( KIO::Job* job );
+
+private:
+  KMFolderImap* mFolder;
+};
+
+//---------------------------------------------------------------------------//
+
+class DImapListJob : public ListJob
+{
+  Q_OBJECT
+public:
+  DImapListJob( KMFolderCachedImap* folder, KMAcctCachedImap* account,
+                bool secondStep = false, bool complete = false, 
+                bool hasInbox = false );
+  virtual ~DImapListJob();
+
+  virtual void execute();
+
+protected slots:
+  /**
+   * Reimplemented
+   */ 
+  void slotListResult( KIO::Job* job );
+
+private:
+  KMFolderCachedImap* mFolder;
+};
+
+} // namespace
+
+#endif /* LISTJOB_H */
+