sessionthread.cpp

/*
  SPDX-FileCopyrightText: 2010 BetterInbox <contact@betterinbox.com>
  SPDX-FileContributor: Christophe Laveault <christophe@betterinbox.com>
  SPDX-FileContributor: Gregory Schlomoff <gregory.schlomoff@gmail.com>
 
  SPDX-License-Identifier: LGPL-2.1-or-later
*/
 
#include "ksmtp_debug.h"
#include "serverresponse_p.h"
#include "session.h"
#include "session_p.h"
#include "sessionthread_p.h"
 
#include <QCoreApplication>
#include <QFile>
#include <QNetworkProxy>
#include <QSslCipher>
#include <QTimer>
 
#include <memory>
 
using namespace KSmtp;
 
SessionThread::SessionThread(const QString &hostName, quint16 port, Session *session)
    : QThread()
    , m_parentSession(session)
    , m_hostName(hostName)
    , m_port(port)
{
    moveToThread(this);
 
    const auto logfile = qgetenv("KSMTP_SESSION_LOG");
    if (!logfile.isEmpty()) {
        static uint sSessionCount = 0;
        const QString filename = QStringLiteral("%1.%2.%3").arg(QString::fromUtf8(logfile)).arg(qApp->applicationPid()).arg(++sSessionCount);
        m_logFile = std::make_unique<QFile>(filename);
        if (!m_logFile->open(QIODevice::WriteOnly | QIODevice::Truncate)) {
            qCWarning(KSMTP_LOG) << "Failed to open log file" << filename << ":" << m_logFile->errorString();
            m_logFile.reset();
        }
    }
}
 
SessionThread::~SessionThread() = default;
 
QString SessionThread::hostName() const
{
    return m_hostName;
}
 
quint16 SessionThread::port() const
{
    return m_port;
}
 
void SessionThread::sendData(const QByteArray &payload)
{
    QMutexLocker locker(&m_mutex);
    // qCDebug(KSMTP_LOG) << "C:: " << payload;
    if (m_logFile) {
        m_logFile->write("C: " + payload + '\n');
        m_logFile->flush();
    }
 
    m_dataQueue.enqueue(payload + "\r\n");
    QTimer::singleShot(0, this, &SessionThread::writeDataQueue);
}
 
void SessionThread::writeDataQueue()
{
    QMutexLocker locker(&m_mutex);
 
    while (!m_dataQueue.isEmpty()) {
        m_socket->write(m_dataQueue.dequeue());
    }
}
 
void SessionThread::readResponse()
{
    QMutexLocker locker(&m_mutex);
 
    if (!m_socket->bytesAvailable()) {
        return;
    }
 
    const QByteArray data = m_socket->readLine();
    // qCDebug(KSMTP_LOG) << "S:" << data;
    if (m_logFile) {
        m_logFile->write("S: " + data);
        m_logFile->flush();
    }
 
    const ServerResponse response = parseResponse(data);
    Q_EMIT responseReceived(response);
 
    if (m_socket->bytesAvailable()) {
        QTimer::singleShot(0, this, &SessionThread::readResponse);
    }
}
 
void SessionThread::closeSocket()
{
    QTimer::singleShot(0, this, &SessionThread::doCloseSocket);
}
 
void SessionThread::doCloseSocket()
{
    m_socket->close();
}
 
void SessionThread::reconnect()
{
    QMutexLocker locker(&m_mutex);
 
    if (m_socket->state() != QAbstractSocket::ConnectedState && m_socket->state() != QAbstractSocket::ConnectingState) {
        if (!m_useProxy) {
            qCDebug(KSMTP_LOG) << "Not using any proxy to connect to the SMTP server.";
 
            QNetworkProxy proxy;
            proxy.setType(QNetworkProxy::NoProxy);
            m_socket->setProxy(proxy);
        } else {
            qCDebug(KSMTP_LOG) << "Using the default system proxy to connect to the SMTP server.";
        }
 
        if (m_useTls) {
            m_socket->connectToHostEncrypted(hostName(), port());
        } else {
            m_socket->connectToHost(hostName(), port());
        }
    }
}
 
void SessionThread::run()
{
    m_socket = std::make_unique<QSslSocket>();
 
    connect(m_socket.get(), &QSslSocket::readyRead, this, &SessionThread::readResponse, Qt::QueuedConnection);
    connect(m_socket.get(), &QSslSocket::encrypted, this, &SessionThread::sslConnected);
 
    connect(m_socket.get(), &QSslSocket::disconnected, m_parentSession->d, &SessionPrivate::socketDisconnected);
    connect(m_socket.get(), &QSslSocket::connected, m_parentSession->d, &SessionPrivate::socketConnected);
    connect(m_socket.get(), &QAbstractSocket::errorOccurred, this, [this](QAbstractSocket::SocketError err) {
        qCWarning(KSMTP_LOG) << "SMTP Socket error:" << err << m_socket->errorString();
        Q_EMIT m_parentSession->connectionError(m_socket->errorString());
    });
    connect(this, &SessionThread::encryptionNegotiationResult, m_parentSession->d, &SessionPrivate::encryptionNegotiationResult);
 
    connect(this, &SessionThread::responseReceived, m_parentSession->d, &SessionPrivate::responseReceived);
 
    exec();
 
    m_socket.reset();
}
 
void SessionThread::setUseNetworkProxy(bool useProxy)
{
    m_useProxy = useProxy;
}
 
void SessionThread::setConnectWithTls(bool useTls)
{
    QMutexLocker locker(&m_mutex);
    m_useTls = useTls;
}
 
ServerResponse SessionThread::parseResponse(const QByteArray &resp)
{
    QByteArray response(resp);
 
    // Remove useless CRLF
    const int indexOfCR = response.indexOf("\r");
    const int indexOfLF = response.indexOf("\n");
 
    if (indexOfCR > 0) {
        response.truncate(indexOfCR);
    }
    if (indexOfLF > 0) {
        response.truncate(indexOfLF);
    }
 
    // Server response code
    const QByteArray code = response.left(3);
    bool ok = false;
    const int returnCode = code.toInt(&ok);
    if (!ok) {
        return ServerResponse();
    }
 
    // RFC821, Appendix E
    const bool multiline = (response.at(3) == '-');
 
    if (returnCode) {
        response.remove(0, 4); // Keep the text part
    }
 
    return ServerResponse(returnCode, response, multiline);
}
 
void SessionThread::startSsl()
{
    QMutexLocker locker(&m_mutex);
 
    m_socket->ignoreSslErrors(); // don't worry, we DO handle the errors ourselves below
    m_socket->startClientEncryption();
}
 
void SessionThread::sslConnected()
{
    QMutexLocker locker(&m_mutex);
    QSslCipher cipher = m_socket->sessionCipher();
 
    if (!m_socket->sslHandshakeErrors().isEmpty() || !m_socket->isEncrypted() || cipher.isNull() || cipher.usedBits() == 0) {
        qCDebug(KSMTP_LOG) << "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->sslHandshakeErrors().count()
                           << "items.";
        KSslErrorUiData errorData(m_socket.get());
        Q_EMIT sslError(errorData);
    } else {
        qCDebug(KSMTP_LOG) << "TLS negotiation done, the negotiated protocol is" << m_socket->sessionCipher().protocolString();
 
        Q_EMIT encryptionNegotiationResult(true, m_socket->sessionProtocol());
    }
}
 
void SessionThread::handleSslErrorResponse(bool ignoreError)
{
    QMetaObject::invokeMethod(
        this,
        [this, ignoreError] {
            doHandleSslErrorResponse(ignoreError);
        },
        Qt::QueuedConnection);
}
 
void SessionThread::doHandleSslErrorResponse(bool ignoreError)
{
    Q_ASSERT(QThread::currentThread() == thread());
    if (!m_socket) {
        return;
    }
    if (ignoreError) {
        Q_EMIT encryptionNegotiationResult(true, m_socket->sessionProtocol());
    } else {
        const auto sslErrors = m_socket->sslHandshakeErrors();
        QStringList errorMsgs;
        errorMsgs.reserve(sslErrors.size());
        std::transform(sslErrors.begin(), sslErrors.end(), std::back_inserter(errorMsgs), std::mem_fn(&QSslError::errorString));
        Q_EMIT m_parentSession->connectionError(errorMsgs.join(QLatin1Char('\n')));
        m_socket->disconnectFromHost();
    }
}
 
#include "moc_sessionthread_p.cpp"