• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

session.cpp

00001 /*
00002     Copyright (c) 2007 Volker Krause <vkrause@kde.org>
00003 
00004     This library is free software; you can redistribute it and/or modify it
00005     under the terms of the GNU Library General Public License as published by
00006     the Free Software Foundation; either version 2 of the License, or (at your
00007     option) any later version.
00008 
00009     This library is distributed in the hope that it will be useful, but WITHOUT
00010     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00011     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00012     License for more details.
00013 
00014     You should have received a copy of the GNU Library General Public License
00015     along with this library; see the file COPYING.LIB.  If not, write to the
00016     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
00017     02110-1301, USA.
00018 */
00019 
00020 #include "session.h"
00021 #include "session_p.h"
00022 
00023 #include "imapparser_p.h"
00024 #include "job.h"
00025 #include "job_p.h"
00026 #include "servermanager_p.h"
00027 #include "xdgbasedirs_p.h"
00028 
00029 #include <kdebug.h>
00030 #include <klocale.h>
00031 
00032 #include <QCoreApplication>
00033 #include <QtCore/QDir>
00034 #include <QtCore/QQueue>
00035 #include <QtCore/QThreadStorage>
00036 #include <QtCore/QTimer>
00037 
00038 #include <QtNetwork/QLocalSocket>
00039 
00040 #define PIPELINE_LENGTH 2
00041 
00042 using namespace Akonadi;
00043 
00044 
00045 //@cond PRIVATE
00046 
00047 void SessionPrivate::startNext()
00048 {
00049   QTimer::singleShot( 0, mParent, SLOT(doStartNext()) );
00050 }
00051 
00052 void SessionPrivate::reconnect()
00053 {
00054   // should be checking connection method and value validity
00055   if ( socket->state() != QLocalSocket::ConnectedState &&
00056        socket->state() != QLocalSocket::ConnectingState ) {
00057 #ifdef Q_OS_WIN  //krazy:exclude=cpp
00058     const QString namedPipe = mConnectionSettings->value( QLatin1String( "Data/NamedPipe" ), QLatin1String( "Akonadi" ) ).toString();
00059     socket->connectToServer( namedPipe );
00060 #else
00061     const QString defaultSocketDir = XdgBaseDirs::saveDir( "data", QLatin1String( "akonadi" ) );
00062     const QString path = mConnectionSettings->value( QLatin1String( "Data/UnixPath" ), defaultSocketDir + QLatin1String( "/akonadiserver.socket" ) ).toString();
00063     socket->connectToServer( path );
00064 #endif
00065   }
00066 }
00067 
00068 void SessionPrivate::socketError( QLocalSocket::LocalSocketError error )
00069 {
00070   Q_ASSERT( mParent->sender() == socket );
00071   kWarning( 5250 ) << "Socket error occurred:" << socket->errorString();
00072   socketDisconnected();
00073 }
00074 
00075 void SessionPrivate::socketDisconnected()
00076 {
00077   if ( currentJob )
00078     currentJob->d_ptr->lostConnection();
00079   connected = false;
00080   QTimer::singleShot( 1000, mParent, SLOT(reconnect()) );
00081 }
00082 
00083 void SessionPrivate::dataReceived()
00084 {
00085   while ( socket->bytesAvailable() > 0 ) {
00086     if ( parser->continuationSize() > 1 ) {
00087       const QByteArray data = socket->read( qMin( socket->bytesAvailable(), parser->continuationSize() - 1 ) );
00088       parser->parseBlock( data );
00089     } else if ( socket->canReadLine() ) {
00090       if ( !parser->parseNextLine( socket->readLine() ) )
00091         continue; // response not yet completed
00092 
00093       // handle login response
00094       if ( parser->tag() == QByteArray("0") ) {
00095         if ( parser->data().startsWith( "OK" ) ) { //krazy:exclude=strings
00096           connected = true;
00097           startNext();
00098         } else {
00099           kWarning( 5250 ) << "Unable to login to Akonadi server:" << parser->data();
00100           socket->close();
00101           QTimer::singleShot( 1000, mParent, SLOT(reconnect()) );
00102         }
00103       }
00104 
00105       // send login command
00106       if ( parser->tag() == "*" && parser->data().startsWith( "OK Akonadi" ) ) {
00107         const int pos = parser->data().indexOf( "[PROTOCOL" );
00108         if ( pos > 0 ) {
00109           qint64 tmp = 0;
00110           ImapParser::parseNumber( parser->data(), tmp, 0, pos + 9 );
00111           protocolVersion = tmp;
00112           Internal::setServerProtocolVersion( tmp );
00113         }
00114         kDebug( 5250 ) << "Server protocol version is:" << protocolVersion;
00115 
00116         writeData( "0 LOGIN " + sessionId + '\n' );
00117 
00118       // work for the current job
00119       } else {
00120         if ( currentJob )
00121           currentJob->d_ptr->handleResponse( parser->tag(), parser->data() );
00122       }
00123 
00124       // reset parser stuff
00125       parser->reset();
00126     } else {
00127       break; // nothing we can do for now
00128     }
00129   }
00130 }
00131 
00132 bool SessionPrivate::canPipelineNext()
00133 {
00134   if ( queue.isEmpty() || pipeline.count() >= PIPELINE_LENGTH )
00135     return false;
00136   if ( pipeline.isEmpty() && currentJob )
00137     return currentJob->d_ptr->mWriteFinished;
00138   if ( !pipeline.isEmpty() )
00139     return pipeline.last()->d_ptr->mWriteFinished;
00140   return false;
00141 }
00142 
00143 void SessionPrivate::doStartNext()
00144 {
00145   if ( !connected || (queue.isEmpty() && pipeline.isEmpty()) )
00146     return;
00147   if ( canPipelineNext() ) {
00148     Akonadi::Job *nextJob = queue.dequeue();
00149     pipeline.enqueue( nextJob );
00150     startJob( nextJob );
00151   }
00152   if ( jobRunning )
00153     return;
00154   jobRunning = true;
00155   if ( !pipeline.isEmpty() ) {
00156     currentJob = pipeline.dequeue();
00157   } else {
00158     currentJob = queue.dequeue();
00159     startJob( currentJob );
00160   }
00161 }
00162 
00163 void SessionPrivate::startJob( Job *job )
00164 {
00165   if ( protocolVersion < minimumProtocolVersion() ) {
00166     job->setError( Job::ProtocolVersionMismatch );
00167     job->setErrorText( i18n( "Protocol version %1 found, expected at least %2", protocolVersion, minimumProtocolVersion() ) );
00168     job->emitResult();
00169   } else {
00170     job->d_ptr->startQueued();
00171   }
00172 }
00173 
00174 void SessionPrivate::jobDone(KJob * job)
00175 {
00176   if( job == currentJob ) {
00177     if ( pipeline.isEmpty() ) {
00178       jobRunning = false;
00179       currentJob = 0;
00180     } else {
00181       currentJob = pipeline.dequeue();
00182     }
00183     startNext();
00184   }
00185   // ### better handle the other cases too, user might have canceled jobs
00186   else {
00187     kDebug( 5250 ) << job << "Non-current job finished.";
00188   }
00189 }
00190 
00191 void SessionPrivate::jobWriteFinished( Akonadi::Job* job )
00192 {
00193   Q_ASSERT( (job == currentJob && pipeline.isEmpty()) || (job = pipeline.last()) );
00194   startNext();
00195 }
00196 
00197 void SessionPrivate::jobDestroyed(QObject * job)
00198 {
00199   queue.removeAll( static_cast<Akonadi::Job*>( job ) );
00200   // ### likely not enough to really cancel already running jobs
00201   pipeline.removeAll( static_cast<Akonadi::Job*>( job ) );
00202   if ( currentJob == job )
00203     currentJob = 0;
00204 }
00205 
00206 void SessionPrivate::addJob(Job * job)
00207 {
00208   queue.append( job );
00209   QObject::connect( job, SIGNAL(result(KJob*)), mParent, SLOT(jobDone(KJob*)) );
00210   QObject::connect( job, SIGNAL(writeFinished(Akonadi::Job*)), mParent, SLOT(jobWriteFinished(Akonadi::Job*)) );
00211   QObject::connect( job, SIGNAL(destroyed(QObject*)), mParent, SLOT(jobDestroyed(QObject*)) );
00212   startNext();
00213 }
00214 
00215 int SessionPrivate::nextTag()
00216 {
00217   return theNextTag++;
00218 }
00219 
00220 void SessionPrivate::writeData(const QByteArray & data)
00221 {
00222   socket->write( data );
00223 }
00224 
00225 //@endcond
00226 
00227 
00228 Session::Session(const QByteArray & sessionId, QObject * parent) :
00229     QObject( parent ),
00230     d( new SessionPrivate( this ) )
00231 {
00232   if ( !sessionId.isEmpty() ) {
00233     d->sessionId = sessionId;
00234   } else {
00235     d->sessionId = QCoreApplication::instance()->applicationName().toUtf8()
00236         + '-' + QByteArray::number( qrand() );
00237   }
00238 
00239   d->connected = false;
00240   d->theNextTag = 1;
00241   d->currentJob = 0;
00242   d->jobRunning = false;
00243 
00244   const QString connectionConfigFile = XdgBaseDirs::akonadiConnectionConfigFile();
00245 
00246   QFileInfo fileInfo( connectionConfigFile );
00247   if ( !fileInfo.exists() ) {
00248     kWarning( 5250 ) << "Akonadi Client Session: connection config file '"
00249                      << "akonadi/akonadiconnectionrc can not be found in '"
00250                      << XdgBaseDirs::homePath( "config" ) << "' nor in any of "
00251                      << XdgBaseDirs::systemPathList( "config" );
00252   }
00253 
00254   d->mConnectionSettings = new QSettings( connectionConfigFile, QSettings::IniFormat );
00255 
00256   // should check connection method
00257   d->socket = new QLocalSocket( this );
00258 
00259   connect( d->socket, SIGNAL(disconnected()), SLOT(socketDisconnected()) );
00260   connect( d->socket, SIGNAL(error(QLocalSocket::LocalSocketError)), SLOT(socketError(QLocalSocket::LocalSocketError)) );
00261   connect( d->socket, SIGNAL(readyRead()), SLOT(dataReceived()) );
00262   d->reconnect();
00263 }
00264 
00265 Session::~Session()
00266 {
00267   clear();
00268   delete d;
00269 }
00270 
00271 QByteArray Session::sessionId() const
00272 {
00273   return d->sessionId;
00274 }
00275 
00276 QThreadStorage<Session*> instances;
00277 
00278 void SessionPrivate::createDefaultSession( const QByteArray &sessionId )
00279 {
00280   Q_ASSERT_X( !sessionId.isEmpty(), "SessionPrivate::createDefaultSession",
00281               "You tried to create a default session with empty session id!" );
00282   Q_ASSERT_X( !instances.hasLocalData(), "SessionPrivate::createDefaultSession",
00283               "You tried to create a default session twice!" );
00284 
00285   instances.setLocalData( new Session( sessionId ) );
00286 }
00287 
00288 Session* Session::defaultSession()
00289 {
00290   if ( !instances.hasLocalData() )
00291     instances.setLocalData( new Session() );
00292   return instances.localData();
00293 }
00294 
00295 void Session::clear()
00296 {
00297   foreach ( Job* job, d->queue )
00298     job->kill( KJob::EmitResult );
00299   d->queue.clear();
00300   if ( d->currentJob )
00301     d->currentJob->kill( KJob::EmitResult );
00302 }
00303 
00304 #include "session.moc"

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.8
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal