sessionthread.cpp

/*
    Copyright (c) 2009 Kevin Ottens <ervin@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library 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 Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#include "sessionthread_p.h"

#include <QtCore/QDebug>
#include <QtCore/QThread>

#include <KDE/KDebug>

#include "imapstreamparser.h"
#include "message_p.h"

using namespace KIMAP;

Q_DECLARE_METATYPE( KTcpSocket::Error )
Q_DECLARE_METATYPE( KSslErrorUiData )
static const int _kimap_socketErrorTypeId = qRegisterMetaType<KTcpSocket::Error>();
static const int _kimap_sslErrorUiData = qRegisterMetaType<KSslErrorUiData>();

SessionThread::SessionThread( const QString &hostName, quint16 port )
  : QObject(), m_hostName( hostName ), m_port( port ),
    m_socket( 0 ), m_stream( 0 ), m_mutex(),
    m_encryptedMode( false ),
    triedSslVersions( 0 ), doSslFallback( false )
{
  // Just like the Qt docs now recommend, for event-driven threads:
  // don't derive from QThread, create one directly and move the object to it.
  QThread* thread = new QThread();
  moveToThread( thread );
  thread->start();
  QMetaObject::invokeMethod( this, "threadInit" );
}

SessionThread::~SessionThread()
{
  QMetaObject::invokeMethod( this, "threadQuit" );
  if ( !thread()->wait( 10 * 1000 ) ) {
    kWarning() << "Session thread refuses to die, killing harder...";
    thread()->terminate();
    // Make sure to wait until it's done, otherwise it can crash when the pthread callback is called
    thread()->wait();
  }
  delete thread();
}

// Called in primary thread
void SessionThread::sendData( const QByteArray &payload )
{
  QMutexLocker locker( &m_mutex );

  m_dataQueue.enqueue( payload );
  QMetaObject::invokeMethod( this, "writeDataQueue" );
}

// Called in secondary thread
void SessionThread::writeDataQueue()
{
  Q_ASSERT( QThread::currentThread() == thread() );
  if ( !m_socket )
    return;
  QMutexLocker locker( &m_mutex );

  while ( !m_dataQueue.isEmpty() ) {
    m_socket->write( m_dataQueue.dequeue() );
  }
}

// Called in secondary thread
void SessionThread::readMessage()
{
  Q_ASSERT( QThread::currentThread() == thread() );
  if ( !m_stream || m_stream->availableDataSize() == 0 ) {
    return;
  }

  Message message;
  QList<Message::Part> *payload = &message.content;

  try {
    while ( !m_stream->atCommandEnd() ) {
      if ( m_stream->hasString() ) {
        QByteArray string = m_stream->readString();
        if ( string == "NIL" ) {
          *payload << Message::Part( QList<QByteArray>() );
        } else {
          *payload << Message::Part( string );
        }
      } else if ( m_stream->hasList() ) {
        *payload << Message::Part( m_stream->readParenthesizedList() );
      } else if ( m_stream->hasResponseCode() ) {
        payload = &message.responseCode;
      } else if ( m_stream->atResponseCodeEnd() ) {
        payload = &message.content;
      } else if ( m_stream->hasLiteral() ) {
        QByteArray literal;
        while ( !m_stream->atLiteralEnd() ) {
          literal += m_stream->readLiteralPart();
        }
        *payload << Message::Part( literal );
      } else {
        // Oops! Something really bad happened, we won't be able to recover
        // so close the socket immediately
        qWarning( "Inconsistent state, probably due to some packet loss" );
        doCloseSocket();
        return;
      }
    }

    emit responseReceived( message );

  } catch ( KIMAP::ImapParserException e ) {
    qWarning() << "The stream parser raised an exception:" << e.what();
  }

  if ( m_stream->availableDataSize() > 1 ) {
    QMetaObject::invokeMethod( this, "readMessage", Qt::QueuedConnection );
  }

}

// Called in main thread
void SessionThread::closeSocket()
{
  QMetaObject::invokeMethod( this, "doCloseSocket", Qt::QueuedConnection );
}

// Called in secondary thread
void SessionThread::doCloseSocket()
{
  Q_ASSERT( QThread::currentThread() == thread() );
  if ( !m_socket )
    return;
  m_encryptedMode = false;
  kDebug() << "close";
  m_socket->close();
}

// Called in secondary thread
void SessionThread::reconnect()
{
  Q_ASSERT( QThread::currentThread() == thread() );
  if ( m_socket == 0 ) // threadQuit already called
    return;
  if ( m_socket->state() != SessionSocket::ConnectedState &&
       m_socket->state() != SessionSocket::ConnectingState ) {
    if ( m_encryptedMode ) {
      kDebug() << "connectToHostEncrypted" << m_hostName << m_port;
      m_socket->connectToHostEncrypted( m_hostName, m_port );
    } else {
      kDebug() << "connectToHost" << m_hostName << m_port;
      m_socket->connectToHost( m_hostName, m_port );
    }
  }
}

// Called in secondary thread
void SessionThread::threadInit()
{
  Q_ASSERT( QThread::currentThread() == thread() );
  m_socket = new SessionSocket;
  m_stream = new ImapStreamParser( m_socket );
  connect( m_socket, SIGNAL(readyRead()),
           this, SLOT(readMessage()), Qt::QueuedConnection );

  // Delay the call to slotSocketDisconnected so that it finishes disconnecting before we call reconnect()
  connect( m_socket, SIGNAL(disconnected()),
           this, SLOT(slotSocketDisconnected()), Qt::QueuedConnection );
  connect( m_socket, SIGNAL(connected()),
           this, SIGNAL(socketConnected()) );
  connect( m_socket, SIGNAL(error(KTcpSocket::Error)),
           this, SLOT(socketError(KTcpSocket::Error)) );
  connect( m_socket, SIGNAL(bytesWritten(qint64)),
           this, SIGNAL(socketActivity()) );
  if ( m_socket->metaObject()->indexOfSignal( "encryptedBytesWritten(qint64)" ) > -1 ) {
      connect( m_socket, SIGNAL(encryptedBytesWritten(qint64)), // needs kdelibs > 4.8
               this, SIGNAL(socketActivity()) );
  }
  connect( m_socket, SIGNAL(readyRead()),
           this, SIGNAL(socketActivity()) );

  QMetaObject::invokeMethod(this, "reconnect", Qt::QueuedConnection);
}

// Called in secondary thread
void SessionThread::threadQuit()
{
  Q_ASSERT( QThread::currentThread() == thread() );
  delete m_stream;
  m_stream = 0;
  delete m_socket;
  m_socket = 0;
  thread()->quit();
}

// Called in primary thread
void SessionThread::startSsl( KTcpSocket::SslVersion version )
{
  QMetaObject::invokeMethod( this, "doStartSsl", Q_ARG(KTcpSocket::SslVersion, version) );
}

// Called in secondary thread (via invokeMethod)
void SessionThread::doStartSsl( KTcpSocket::SslVersion version )
{
  Q_ASSERT( QThread::currentThread() == thread() );
  if ( !m_socket )
    return;
  if ( version == KTcpSocket::AnySslVersion ) {
    doSslFallback = true;
    if ( m_socket->advertisedSslVersion() == KTcpSocket::UnknownSslVersion ) {
      m_socket->setAdvertisedSslVersion( KTcpSocket::AnySslVersion );
    } else if ( !( triedSslVersions & KTcpSocket::TlsV1 ) ) {
      triedSslVersions |= KTcpSocket::TlsV1;
      m_socket->setAdvertisedSslVersion( KTcpSocket::TlsV1 );
    } else if ( !( triedSslVersions & KTcpSocket::SslV3 ) ) {
      triedSslVersions |= KTcpSocket::SslV3;
      m_socket->setAdvertisedSslVersion( KTcpSocket::SslV3 );
    } else if ( !( triedSslVersions & KTcpSocket::SslV2 ) ) {
      triedSslVersions |= KTcpSocket::SslV2;
      m_socket->setAdvertisedSslVersion( KTcpSocket::SslV2 );
      doSslFallback = false;
    }
  } else {
    m_socket->setAdvertisedSslVersion( version );
  }

  m_socket->ignoreSslErrors();
  connect( m_socket, SIGNAL(encrypted()), this, SLOT(sslConnected()) );
  m_socket->startClientEncryption();
}

// Called in secondary thread
void SessionThread::slotSocketDisconnected()
{
  Q_ASSERT( QThread::currentThread() == thread() );
  if ( doSslFallback ) {
    reconnect();
  } else {
    emit socketDisconnected();
  }
}

// Called in secondary thread
void SessionThread::socketError(KTcpSocket::Error error)
{
  Q_ASSERT( QThread::currentThread() == thread() );
  if ( !m_socket )
    return;
  Q_UNUSED( error ); // can be used for debugging
  if ( doSslFallback ) {
    //do not call disconnectFromhost here, as that can trigger an error again.
    m_socket->abort();
  } else {
    emit socketError();
  }
}

// Called in secondary thread
void SessionThread::sslConnected()
{
  doSslFallback = false;
  Q_ASSERT( QThread::currentThread() == thread() );
  if ( !m_socket )
    return;
  KSslCipher cipher = m_socket->sessionCipher();

  if ( m_socket->sslErrors().count() > 0 ||
       m_socket->encryptionMode() != KTcpSocket::SslClientMode ||
       cipher.isNull() || cipher.usedBits() == 0 ) {
     kDebug() << "Initial SSL handshake failed. cipher.isNull() is" << cipher.isNull()
              << ", cipher.usedBits() is" << cipher.usedBits()
              << ", the socket says:" <<  m_socket->errorString()
              << "and the list of SSL errors contains"
              << m_socket->sslErrors().count() << "items.";
     KSslErrorUiData errorData( m_socket );
     emit sslError( errorData );
  } else {
    kDebug() << "TLS negotiation done.";
    m_encryptedMode = true;
    emit encryptionNegotiationResult( true, m_socket->negotiatedSslVersion() );
  }
}

void SessionThread::sslErrorHandlerResponse(bool response)
{
  QMetaObject::invokeMethod(this, "doSslErrorHandlerResponse", Q_ARG(bool, response));
}

// Called in secondary thread (via invokeMethod)
void SessionThread::doSslErrorHandlerResponse(bool response)
{
  Q_ASSERT( QThread::currentThread() == thread() );
  if ( !m_socket )
    return;
  if ( response ) {
    m_encryptedMode = true;
    emit encryptionNegotiationResult( true, m_socket->negotiatedSslVersion() );
  } else {
     m_encryptedMode = false;
     //reconnect in unencrypted mode, so new commands can be issued
     m_socket->disconnectFromHost();
     m_socket->waitForDisconnected();
     m_socket->connectToHost( m_hostName, m_port );
     emit encryptionNegotiationResult( false, KTcpSocket::UnknownSslVersion );
  }
}

#include "moc_sessionthread_p.cpp"