session.cpp

/*
    Copyright (c) 2009 Kevin Ottens <ervin@kde.org>
    Copyright (c) 2017 Christian Mollekopf <mollekopf@kolabsys.com>
 
    Copyright (c) 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
    Author: Kevin Ottens <kevin@kdab.com>
 
    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 "session.h"
#include "session_p.h"
 
#include <QDebug>
 
#include "kimap_debug.h"
 
#include "job.h"
#include "message_p.h"
#include "sessionlogger_p.h"
#include "rfccodecs.h"
#include "imapstreamparser.h"
 
Q_DECLARE_METATYPE(QSsl::SslProtocol)
Q_DECLARE_METATYPE(QSslSocket::SslMode)
static const int _kimap_sslVersionId = qRegisterMetaType<QSsl::SslProtocol>();
 
using namespace KIMAP2;
 
Session::Session(const QString &hostName, quint16 port, QObject *parent)
    : QObject(parent), d(new SessionPrivate(this))
{
    if (!qEnvironmentVariableIsEmpty("KIMAP2_LOGFILE")) {
        d->logger.reset(new SessionLogger);
        qCInfo(KIMAP2_LOG) << "Logging traffic to: " << QLatin1String(qgetenv("KIMAP2_LOGFILE"));
    }
    if (qEnvironmentVariableIsSet("KIMAP2_TRAFFIC")) {
        d->dumpTraffic = true;
        qCInfo(KIMAP2_LOG) << "Dumping traffic.";
    }
    if (qEnvironmentVariableIsSet("KIMAP2_TIMING")) {
        d->trackTime = true;
        qCInfo(KIMAP2_LOG) << "Tracking timings.";
    }
 
    d->state = Disconnected;
    d->jobRunning = false;
    d->hostName = hostName;
    d->port = port;
 
    connect(d->socket.data(), &QIODevice::readyRead, d, &SessionPrivate::readMessage);
 
    connect(d->socket.data(), &QSslSocket::connected,
            d, &SessionPrivate::socketConnected);
    connect(d->socket.data(), static_cast<void (QSslSocket::*)(const QList<QSslError>&)>(&QSslSocket::sslErrors),
            d, &SessionPrivate::handleSslErrors);
    connect(d->socket.data(), static_cast<void (QSslSocket::*)(QAbstractSocket::SocketError)>(&QSslSocket::error),
            d, &SessionPrivate::socketError);
 
    connect(d->socket.data(), &QIODevice::bytesWritten,
            d, &SessionPrivate::socketActivity);
    connect(d->socket.data(), &QSslSocket::encryptedBytesWritten,
            d, &SessionPrivate::socketActivity);
    connect(d->socket.data(), &QIODevice::readyRead,
            d, &SessionPrivate::socketActivity);
    connect(d->socket.data(), &QAbstractSocket::stateChanged, [this](QAbstractSocket::SocketState state) {
        qCDebug(KIMAP2_LOG) << "Socket state changed: " << state;
        //The disconnected signal will not fire if we fail to lookup the host, but this will.
        if (state == QAbstractSocket::UnconnectedState) {
            d->socketDisconnected();
        }
        if (state == QAbstractSocket::HostLookupState) {
            d->hostLookupInProgress = true;
        } else {
            d->hostLookupInProgress = false;
        }
    });
 
    d->socketTimer.setSingleShot(true);
    connect(&d->socketTimer, &QTimer::timeout,
            d, &SessionPrivate::onSocketTimeout);
 
    d->socketProgressTimer.setSingleShot(false);
    connect(&d->socketProgressTimer, &QTimer::timeout,
            d, &SessionPrivate::onSocketProgressTimeout);
 
    d->startSocketTimer();
    qCDebug(KIMAP2_LOG) << "Connecting to: " << hostName << port;
    d->socket->connectToHost(hostName, port);
}
 
Session::~Session()
{
    //Make sure all jobs know we're done
    d->clearJobQueue();
    delete d;
}
 
QString Session::hostName() const
{
    return d->hostName;
}
 
quint16 Session::port() const
{
    return d->port;
}
 
Session::State Session::state() const
{
    return d->state;
}
 
bool Session::isConnected() const
{
    return (d->state == Authenticated || d->state == Selected);
}
 
QString Session::userName() const
{
    return d->userName;
}
 
QByteArray Session::serverGreeting() const
{
    return d->greeting;
}
 
int Session::jobQueueSize() const
{
    return d->queue.size() + (d->jobRunning ? 1 : 0);
}
 
void Session::close()
{
    d->closeSocket();
}
 
void Session::ignoreErrors(const QList<QSslError> &errors)
{
    d->socket->ignoreSslErrors(errors);
}
 
void Session::setTimeout(int timeout)
{
    d->setSocketTimeout(timeout * 1000);
}
 
int Session::timeout() const
{
    return d->socketTimeout() / 1000;
}
 
QString Session::selectedMailBox() const
{
    return QString::fromUtf8(d->currentMailBox);
}
 
 
SessionPrivate::SessionPrivate(Session *session)
    : QObject(session),
      q(session),
      state(Session::Disconnected),
      hostLookupInProgress(false),
      logger(Q_NULLPTR),
      currentJob(Q_NULLPTR),
      tagCount(0),
      socketTimerInterval(30000),   // By default timeouts on 30s
      socketProgressInterval(3000),   // mention we're still alive every 3s
      socket(new QSslSocket),
      stream(new ImapStreamParser(socket.data())),
      accumulatedWaitTime(0),
      accumulatedProcessingTime(0),
      trackTime(false),
      dumpTraffic(false)
{
    //For windows this needs to be set before connecting according to the docs
    socket->setSocketOption(QAbstractSocket::KeepAliveOption, 1);
    stream->onResponseReceived([this](const Message &message) {
        responseReceived(message);
    });
}
 
SessionPrivate::~SessionPrivate()
{
}
 
void SessionPrivate::handleSslErrors(const QList<QSslError> &errors)
{
    emit q->sslErrors(errors);
}
 
void SessionPrivate::addJob(Job *job)
{
    queue.append(job);
    emit q->jobQueueSizeChanged(q->jobQueueSize());
 
    QObject::connect(job, &KJob::result, this, &SessionPrivate::jobDone);
    QObject::connect(job, &QObject::destroyed, this, &SessionPrivate::jobDestroyed);
    startNext();
}
 
void SessionPrivate::startNext()
{
    QMetaObject::invokeMethod(this, "doStartNext");
}
 
void SessionPrivate::doStartNext()
{
    //Wait until we are ready to process
    if (queue.isEmpty()
        || jobRunning
        || socket->state() == QSslSocket::ConnectingState
        || socket->state() == QSslSocket::HostLookupState) {
        return;
    }
 
    currentJob = queue.dequeue();
 
    //Since we aren't connecting we may never get back. Cancel the job
    if (socket->state() == QSslSocket::UnconnectedState) {
        qCDebug(KIMAP2_LOG) << "Cancelling job due to lack of connection: " << currentJob->metaObject()->className();
        currentJob->connectionLost();
        return;
    }
 
    if (trackTime) {
        time.start();
    }
    restartSocketTimer();
    jobRunning = true;
    currentJob->doStart();
}
 
void SessionPrivate::jobDone(KJob *job)
{
    Q_UNUSED(job);
    Q_ASSERT(job == currentJob);
    qCDebug(KIMAP2_LOG) << "Job done: " << job->metaObject()->className();
 
    stopSocketTimer();
 
    jobRunning = false;
    currentJob = Q_NULLPTR;
    emit q->jobQueueSizeChanged(q->jobQueueSize());
    startNext();
}
 
void SessionPrivate::jobDestroyed(QObject *job)
{
    queue.removeAll(static_cast<KIMAP2::Job *>(job));
    if (currentJob == job) {
        currentJob = Q_NULLPTR;
    }
}
 
void SessionPrivate::responseReceived(const Message &response)
{
    if (dumpTraffic) {
        qCInfo(KIMAP2_LOG) << "S: " << QString::fromLatin1(response.toString());
    }
    if (logger && q->isConnected()) {
        logger->dataReceived(response.toString());
    }
 
    QByteArray tag;
    QByteArray code;
 
    if (response.content.size() >= 1) {
        tag = response.content[0].toString();
    }
 
    if (response.content.size() >= 2) {
        code = response.content[1].toString();
    }
 
    // BYE may arrive as part of a LOGOUT sequence or before the server closes the connection after an error.
    // In any case we should wait until the server closes the connection, so we don't have to do anything.
    if (code == "BYE") {
        Message simplified = response;
        if (simplified.content.size() >= 2) {
            simplified.content.removeFirst(); // Strip the tag
            simplified.content.removeFirst(); // Strip the code
        }
        qCDebug(KIMAP2_LOG) << "Received BYE: " << simplified.toString();
        return;
    }
 
    switch (state) {
    case Session::Disconnected:
        stopSocketTimer();
        if (code == "OK") {
            Message simplified = response;
            simplified.content.removeFirst(); // Strip the tag
            simplified.content.removeFirst(); // Strip the code
            greeting = simplified.toString().trimmed(); // Save the server greeting
            setState(Session::NotAuthenticated);
        } else if (code == "PREAUTH") {
            Message simplified = response;
            simplified.content.removeFirst(); // Strip the tag
            simplified.content.removeFirst(); // Strip the code
            greeting = simplified.toString().trimmed(); // Save the server greeting
            setState(Session::Authenticated);
        } else {
            //We have been rejected
            closeSocket();
        }
        return;
    case Session::NotAuthenticated:
        if (code == "OK" && tag == authTag) {
            setState(Session::Authenticated);
        }
        break;
    case Session::Authenticated:
        if (code == "OK" && tag == selectTag) {
            setState(Session::Selected);
            currentMailBox = upcomingMailBox;
        }
        break;
    case Session::Selected:
        if ((code == "OK" && tag == closeTag) ||
                (code != "OK" && tag == selectTag)) {
            setState(Session::Authenticated);
            currentMailBox = QByteArray();
        } else if (code == "OK" && tag == selectTag) {
            currentMailBox = upcomingMailBox;
        }
        break;
    }
 
    if (tag == authTag) {
        authTag.clear();
    }
    if (tag == selectTag) {
        selectTag.clear();
    }
    if (tag == closeTag) {
        closeTag.clear();
    }
 
    // If a job is running forward it the response
    if (currentJob) {
        restartSocketTimer();
        currentJob->handleResponse(response);
    } else {
        qCWarning(KIMAP2_LOG) << "A message was received from the server with no job to handle it:"
                             << response.toString()
                             << '(' + response.toString().toHex() + ')';
    }
}
 
void SessionPrivate::setState(Session::State s)
{
    if (s != state) {
        Session::State oldState = state;
        state = s;
        emit q->stateChanged(state, oldState);
    }
}
 
QByteArray SessionPrivate::sendCommand(const QByteArray &command, const QByteArray &args)
{
    QByteArray tag = 'A' + QByteArray::number(++tagCount).rightJustified(6, '0');
 
    QByteArray payload = tag + ' ' + command;
    if (!args.isEmpty()) {
        payload += ' ' + args;
    }
 
    sendData(payload);
 
    if (command == "LOGIN" || command == "AUTHENTICATE") {
        authTag = tag;
    } else if (command == "SELECT" || command == "EXAMINE") {
        selectTag = tag;
        upcomingMailBox = args;
        upcomingMailBox.remove(0, 1);
        upcomingMailBox = upcomingMailBox.left(upcomingMailBox.indexOf('\"'));
        upcomingMailBox = KIMAP2::decodeImapFolderName(upcomingMailBox);
    } else if (command == "CLOSE") {
        closeTag = tag;
    }
    return tag;
}
 
void SessionPrivate::sendData(const QByteArray &data)
{
    restartSocketTimer();
 
    if (dumpTraffic) {
        qCInfo(KIMAP2_LOG) << "C: " << data;
    }
    if (logger && q->isConnected()) {
        logger->dataSent(data);
    }
 
    dataQueue.enqueue(data + "\r\n");
    QMetaObject::invokeMethod(this, "writeDataQueue");
}
 
void SessionPrivate::socketConnected()
{
    qCInfo(KIMAP2_LOG) << "Socket connected.";
    //Detect if the connection is no longer available
    socket->setSocketOption(QAbstractSocket::KeepAliveOption, 1);
    startNext();
}
 
void SessionPrivate::socketDisconnected()
{
    qCInfo(KIMAP2_LOG) << "Socket disconnected.";
    stopSocketTimer();
 
    if (logger && q->isConnected()) {
        logger->disconnectionOccured();
    }
 
    if (state != Session::Disconnected) {
        setState(Session::Disconnected);
    } else {
        //If we timeout during host lookup we don't receive an explicit host lookup error
        if (hostLookupInProgress) {
            socketError(QAbstractSocket::HostNotFoundError);
            hostLookupInProgress = false;
        }
        emit q->connectionFailed();
    }
 
    clearJobQueue();
}
 
void SessionPrivate::socketActivity()
{
    //This slot can be called after the job has already finished, in that case we don't want to restart the timer
    if (currentJob) {
        restartSocketTimer();
    }
}
 
void SessionPrivate::socketError(QAbstractSocket::SocketError error)
{
    qCDebug(KIMAP2_LOG) << "Socket error: " << error;
    stopSocketTimer();
 
    if (currentJob) {
        qCWarning(KIMAP2_LOG) << "Socket error:" << error;
        currentJob->setSocketError(error);
    } else if (!queue.isEmpty()) {
        qCWarning(KIMAP2_LOG) << "Socket error:" << error;
        currentJob = queue.takeFirst();
        currentJob->setSocketError(error);
    }
 
    closeSocket();
}
 
void SessionPrivate::clearJobQueue()
{
    if (!currentJob && !queue.isEmpty()) {
        currentJob = queue.takeFirst();
    }
    if (currentJob) {
        currentJob->connectionLost();
    }
 
    QQueue<Job *> queueCopy = queue; // copy because jobDestroyed calls removeAll
    qDeleteAll(queueCopy);
    queue.clear();
    emit q->jobQueueSizeChanged(0);
}
 
void SessionPrivate::startSsl(QSsl::SslProtocol protocol)
{
    socket->setProtocol(protocol);
    connect(socket.data(), &QSslSocket::encrypted, this, &SessionPrivate::sslConnected);
    if (socket->state() == QAbstractSocket::ConnectedState) {
        qCDebug(KIMAP2_LOG) << "Starting client encryption";
        Q_ASSERT(socket->mode() == QSslSocket::UnencryptedMode);
        socket->startClientEncryption();
    } else {
        qCWarning(KIMAP2_LOG) << "The socket is not yet connected";
    }
}
 
void SessionPrivate::sslConnected()
{
    qCDebug(KIMAP2_LOG) << "ssl is connected";
    emit encryptionNegotiationResult(true);
}
 
void SessionPrivate::setSocketTimeout(int ms)
{
    bool timerActive = socketTimer.isActive();
 
    if (timerActive) {
        stopSocketTimer();
    }
 
    socketTimerInterval = ms;
 
    if (timerActive) {
        startSocketTimer();
    }
}
 
int SessionPrivate::socketTimeout() const
{
    return socketTimerInterval;
}
 
void SessionPrivate::startSocketTimer()
{
    if (socketTimerInterval < 0) {
        return;
    }
    Q_ASSERT(!socketTimer.isActive());
 
    socketTimer.start(socketTimerInterval);
    socketProgressTimer.start(socketProgressInterval);
}
 
void SessionPrivate::stopSocketTimer()
{
    socketTimer.stop();
    socketProgressTimer.stop();
}
 
void SessionPrivate::restartSocketTimer()
{
    stopSocketTimer();
    startSocketTimer();
}
 
void SessionPrivate::onSocketTimeout()
{
    qCWarning(KIMAP2_LOG) << "Aborting on socket timeout. " << socketTimerInterval;
    if (!currentJob && !queue.isEmpty()) {
        currentJob = queue.takeFirst();
    }
    if (currentJob) {
        qCWarning(KIMAP2_LOG) << "Current job: " << currentJob->metaObject()->className();
        currentJob->setErrorMessage("Aborting on socket timeout. Interval " + QString::number(socketTimerInterval) + " ms");
    }
    socket->abort();
    socketProgressTimer.stop();
}
 
QString SessionPrivate::getStateName() const 
{
    if (hostLookupInProgress) {
        return "Host lookup";
    }
    switch (state) {
        case Session::Disconnected:
            return "Disconnected";
        case Session::NotAuthenticated:
            return "NotAuthenticated";
        case Session::Authenticated:
            return "Authenticated";
        case Session::Selected:
        default:
            break;
    }
    return "Unknown State";
}
 
void SessionPrivate::onSocketProgressTimeout()
{
    if (currentJob) {
        qCDebug(KIMAP2_LOG) << "Processing job: " << currentJob->metaObject()->className() << "Current state: " << getStateName() << (socket ? socket->state() : QAbstractSocket::UnconnectedState);
    } else {
        qCDebug(KIMAP2_LOG) << "Next job: " << (queue.isEmpty() ? "No job" : queue.head()->metaObject()->className()) << "Current state: " << getStateName() << (socket ? socket->state() : QAbstractSocket::UnconnectedState);
    }
}
 
void SessionPrivate::writeDataQueue()
{
    while (!dataQueue.isEmpty()) {
        socket->write(dataQueue.dequeue());
    }
}
 
void SessionPrivate::readMessage()
{
    if (trackTime) {
        accumulatedWaitTime += time.elapsed();
        time.start();
    }
    stream->parseStream();
    if (stream->error()) {
        qCWarning(KIMAP2_LOG) << "Error while parsing, closing connection.";
        qCDebug(KIMAP2_LOG) << "Current buffer: " << stream->currentBuffer();
        socket->close();
    }
    if (trackTime) {
        accumulatedProcessingTime += time.elapsed();
        time.start();
        qCDebug(KIMAP2_LOG) << "Wait vs process vs total: " << accumulatedWaitTime << accumulatedProcessingTime << accumulatedWaitTime + accumulatedProcessingTime;
    }
}
 
void SessionPrivate::closeSocket()
{
    qCDebug(KIMAP2_LOG) << "Closing socket.";
    socket->close();
}
 
#include "moc_session.cpp"
#include "moc_session_p.cpp"