php-qml/framework/qml/src/BackendConnection.cpp

#include "BackendConnection.h"

#include <QCoreApplication>
#include <QDebug>
#include <QDir>
#include <QFileInfo>
#include <QLoggingCategory>
#include <QNetworkAccessManager>
#include <QNetworkReply>
#include <QNetworkRequest>
#include <QProcessEnvironment>
#include <QQmlEngine>
#include <QRandomGenerator>
#include <QStandardPaths>
#include <QTimer>
#include <QUrl>

#include <csignal>
#include <sys/prctl.h>

namespace PhpQml::Bridge {

Q_LOGGING_CATEGORY(lcBundled, "phpqml.bridge.bundled")

namespace {
constexpr int kInitialProbeMs   = 0;
constexpr int kProbeIntervalMs  = 5000;
constexpr int kProbeTimeoutMs   = 2000;
constexpr int kMigrateTimeoutMs = 60000;
constexpr int kBootProbeMaxMs   = 10000;
} // namespace

BackendConnection::BackendConnection(QObject* parent)
    : QObject(parent)
    , m_appName(QCoreApplication::applicationName().isEmpty()
                ? QStringLiteral("php-qml-app")
                : QCoreApplication::applicationName())
    , m_nam(new QNetworkAccessManager(this))
    , m_retryTimer(new QTimer(this))
{
    m_retryTimer->setSingleShot(false);
    m_retryTimer->setInterval(kProbeIntervalMs);
    connect(m_retryTimer, &QTimer::timeout, this, &BackendConnection::probe);

    const QString explicitUrl = QString::fromUtf8(qgetenv("BRIDGE_URL"));
    if (!explicitUrl.isEmpty()) {
        m_mode = Mode::Dev;
        m_url  = explicitUrl;
        m_token = QString::fromUtf8(qgetenv("BRIDGE_TOKEN"));
        QTimer::singleShot(0, this, &BackendConnection::initDevMode);
    } else {
        m_mode = Mode::Bundled;
        // Bundled init runs after the QApplication event loop is up so
        // QStandardPaths and QProcess work correctly.
        QTimer::singleShot(0, this, &BackendConnection::initBundledMode);
    }
}

BackendConnection::~BackendConnection()
{
    teardownChild();
}

BackendConnection* BackendConnection::create(QQmlEngine* engine, QJSEngine*)
{
    return new BackendConnection(engine);
}

void BackendConnection::initDevMode()
{
    if (m_url.isEmpty()) {
        m_url = QStringLiteral("http://127.0.0.1:8765");
    }
    emit urlChanged();
    QTimer::singleShot(kInitialProbeMs, this, &BackendConnection::probe);
    m_retryTimer->start();
}

void BackendConnection::initBundledMode()
{
    const QString fpBin    = resolveFrankenphpBin();
    const QString symfony  = resolveSymfonyDir();
    const QString caddyCfg = resolveCaddyfilePath();

    if (!QFileInfo(fpBin).isExecutable()) {
        const QString msg = QStringLiteral("bundled: frankenphp not found at %1 (override with BRIDGE_FRANKENPHP_BIN)").arg(fpBin);
        qCWarning(lcBundled) << msg;
        setError(msg);
        setState(ConnectionState::Offline);
        return;
    }
    if (symfony.isEmpty() || !QFileInfo(symfony + "/public/index.php").exists()) {
        const QString msg = QStringLiteral("bundled: symfony app not found near %1 (override with BRIDGE_SYMFONY_DIR)").arg(QCoreApplication::applicationDirPath());
        qCWarning(lcBundled) << msg;
        setError(msg);
        setState(ConnectionState::Offline);
        return;
    }
    if (caddyCfg.isEmpty() || !QFileInfo(caddyCfg).exists()) {
        const QString msg = QStringLiteral("bundled: Caddyfile not found near %1 (override with BRIDGE_CADDYFILE)").arg(QCoreApplication::applicationDirPath());
        qCWarning(lcBundled) << msg;
        setError(msg);
        setState(ConnectionState::Offline);
        return;
    }
    qCInfo(lcBundled) << "frankenphp:" << fpBin;
    qCInfo(lcBundled) << "symfony:"    << symfony;
    qCInfo(lcBundled) << "caddyfile:"  << caddyCfg;

    m_dataDir = userDataDir();
    QDir().mkpath(m_dataDir + "/var/log");
    QDir().mkpath(m_dataDir + "/var/cache");

    setToken(randomSecret(32));
    m_jwtSecret = randomSecret(48);  // ≥256 bits for lcobucci/jwt
    setUrl(QStringLiteral("http://127.0.0.1:%1").arg(m_port));

    if (!runMigrations()) {
        return;  // setError already invoked
    }

    QString spawnErr;
    if (!spawnChild(&spawnErr)) {
        setError(spawnErr);
        setState(ConnectionState::Offline);
        return;
    }

    setState(ConnectionState::Connecting);
    QTimer::singleShot(kInitialProbeMs, this, &BackendConnection::probe);
    m_retryTimer->start();
}

QString BackendConnection::resolveFrankenphpBin() const
{
    const QByteArray override = qgetenv("BRIDGE_FRANKENPHP_BIN");
    if (!override.isEmpty()) return QString::fromUtf8(override);
    return QCoreApplication::applicationDirPath() + QStringLiteral("/bin/frankenphp");
}

QString BackendConnection::resolveSymfonyDir() const
{
    const QByteArray override = qgetenv("BRIDGE_SYMFONY_DIR");
    if (!override.isEmpty()) return QString::fromUtf8(override);

    const QString here = QCoreApplication::applicationDirPath();
    const QStringList candidates = {
        here + QStringLiteral("/symfony"),
        here + QStringLiteral("/../symfony"),
        here + QStringLiteral("/../share/") + m_appName + QStringLiteral("/symfony"),
        here + QStringLiteral("/../usr/share/") + m_appName + QStringLiteral("/symfony"),
    };
    for (const QString& c : candidates) {
        if (QFileInfo(c + "/public/index.php").exists()) {
            return QDir(c).absolutePath();
        }
    }
    return {};
}

QString BackendConnection::resolveCaddyfilePath() const
{
    const QByteArray override = qgetenv("BRIDGE_CADDYFILE");
    if (!override.isEmpty()) return QString::fromUtf8(override);

    const QString here = QCoreApplication::applicationDirPath();
    const QStringList candidates = {
        here + QStringLiteral("/Caddyfile"),
        here + QStringLiteral("/../Caddyfile"),
        here + QStringLiteral("/../share/") + m_appName + QStringLiteral("/Caddyfile"),
        here + QStringLiteral("/../usr/share/") + m_appName + QStringLiteral("/Caddyfile"),
    };
    for (const QString& c : candidates) {
        if (QFileInfo(c).exists()) {
            return QFileInfo(c).absoluteFilePath();
        }
    }
    return {};
}

QString BackendConnection::userDataDir() const
{
    QString p = QStandardPaths::writableLocation(QStandardPaths::AppDataLocation);
    if (p.isEmpty()) {
        p = QDir::homePath() + QStringLiteral("/.local/share/") + m_appName;
    }
    return p;
}

QString BackendConnection::databaseUrl() const
{
    return QStringLiteral("sqlite:///%1/var/data.sqlite").arg(m_dataDir);
}

bool BackendConnection::runMigrations()
{
    QProcess proc;
    proc.setProgram(resolveFrankenphpBin());
    proc.setArguments({
        QStringLiteral("php-cli"),
        resolveSymfonyDir() + QStringLiteral("/bin/console"),
        QStringLiteral("doctrine:migrations:migrate"),
        QStringLiteral("-n"),
    });

    QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
    env.insert(QStringLiteral("APP_ENV"),      QStringLiteral("prod"));
    env.insert(QStringLiteral("APP_DEBUG"),    QStringLiteral("0"));
    env.insert(QStringLiteral("APP_SECRET"),   QStringLiteral("bundled-mode-migrations-do-not-need-this"));
    env.insert(QStringLiteral("DATABASE_URL"), databaseUrl());
    proc.setProcessEnvironment(env);
    proc.setWorkingDirectory(resolveSymfonyDir());
    proc.setProcessChannelMode(QProcess::MergedChannels);

    qCInfo(lcBundled) << "running migrations against" << databaseUrl();
    proc.start();
    if (!proc.waitForFinished(kMigrateTimeoutMs)) {
        proc.kill();
        const QString msg = QStringLiteral("bundled: migrations timed out");
        qCWarning(lcBundled) << msg;
        setError(msg);
        setState(ConnectionState::Offline);
        return false;
    }
    if (proc.exitStatus() != QProcess::NormalExit || proc.exitCode() != 0) {
        const QString msg = QStringLiteral("bundled: migrations failed (exit %1)\n%2")
            .arg(proc.exitCode())
            .arg(QString::fromUtf8(proc.readAll()));
        qCWarning(lcBundled).noquote() << msg;
        setError(msg);
        setState(ConnectionState::Offline);
        return false;
    }
    qCInfo(lcBundled) << "migrations OK";
    return true;
}

bool BackendConnection::spawnChild(QString* errorOut)
{
    teardownChild();

    m_child = new QProcess(this);
    m_child->setProgram(resolveFrankenphpBin());
    m_child->setArguments({
        QStringLiteral("run"),
        QStringLiteral("--config"),
        resolveCaddyfilePath(),
    });
    m_child->setWorkingDirectory(resolveSymfonyDir());

    QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
    env.insert(QStringLiteral("APP_ENV"),       QStringLiteral("prod"));
    env.insert(QStringLiteral("APP_DEBUG"),     QStringLiteral("0"));
    env.insert(QStringLiteral("APP_SECRET"),    randomSecret(16));
    env.insert(QStringLiteral("BRIDGE_TOKEN"),  m_token);
    env.insert(QStringLiteral("DATABASE_URL"),  databaseUrl());
    env.insert(QStringLiteral("PORT"),          QString::number(m_port));
    env.insert(QStringLiteral("MERCURE_URL"),         m_url + QStringLiteral("/.well-known/mercure"));
    env.insert(QStringLiteral("MERCURE_PUBLIC_URL"),  m_url + QStringLiteral("/.well-known/mercure"));
    env.insert(QStringLiteral("MERCURE_JWT_SECRET"),         m_jwtSecret);
    env.insert(QStringLiteral("MERCURE_PUBLISHER_JWT_KEY"),  m_jwtSecret);
    env.insert(QStringLiteral("MERCURE_SUBSCRIBER_JWT_KEY"), m_jwtSecret);
    m_child->setProcessEnvironment(env);
    m_child->setProcessChannelMode(QProcess::ForwardedChannels);

    // Linux: kernel kills the child if the parent dies for any reason.
    m_child->setChildProcessModifier([] {
        prctl(PR_SET_PDEATHSIG, SIGTERM);
    });

    connect(m_child, &QProcess::finished,
            this, &BackendConnection::onChildFinished);

    qCInfo(lcBundled) << "spawning frankenphp on port" << m_port;
    m_child->start();
    if (!m_child->waitForStarted(5000)) {
        const QString err = QStringLiteral("bundled: failed to start frankenphp: ") + m_child->errorString();
        qCWarning(lcBundled) << err;
        if (errorOut) *errorOut = err;
        teardownChild();
        return false;
    }
    return true;
}

void BackendConnection::teardownChild()
{
    if (!m_child) return;
    if (m_child->state() != QProcess::NotRunning) {
        m_child->terminate();
        if (!m_child->waitForFinished(2000)) {
            m_child->kill();
            m_child->waitForFinished(1000);
        }
    }
    disconnect(m_child, nullptr, this, nullptr);
    m_child->deleteLater();
    m_child = nullptr;
}

void BackendConnection::onChildFinished(int exitCode, QProcess::ExitStatus status)
{
    Q_UNUSED(status);
    if (m_mode != Mode::Bundled) return;

    setError(QStringLiteral("bundled: frankenphp exited (code=%1); supervisor restart").arg(exitCode));

    if (m_supervisorRetries >= kMaxSupervisorRetries) {
        setState(ConnectionState::Offline);
        return;
    }
    ++m_supervisorRetries;

    // New session secret on every restart.
    setToken(randomSecret(32));
    emit tokenRotated(m_token);

    QString err;
    if (!spawnChild(&err)) {
        setError(err);
        setState(ConnectionState::Offline);
        return;
    }
    setState(ConnectionState::Reconnecting);
}

void BackendConnection::restart()
{
    if (m_mode == Mode::Bundled) {
        m_supervisorRetries = 0;
        QString err;
        if (!spawnChild(&err)) {
            setError(err);
            setState(ConnectionState::Offline);
            return;
        }
        setState(ConnectionState::Connecting);
    }
    probe();
}

void BackendConnection::probe()
{
    if (m_pendingReply) return;

    QNetworkRequest req;
    req.setUrl(QUrl(m_url + QStringLiteral("/healthz")));
    req.setTransferTimeout(kProbeTimeoutMs);
    if (!m_token.isEmpty()) {
        req.setRawHeader("Authorization", "Bearer " + m_token.toUtf8());
    }

    m_pendingReply = m_nam->get(req);
    connect(m_pendingReply, &QNetworkReply::finished,
            this, &BackendConnection::onProbeFinished);
}

void BackendConnection::onProbeFinished()
{
    QNetworkReply* reply = m_pendingReply;
    m_pendingReply = nullptr;
    if (!reply) return;
    reply->deleteLater();

    bool ok = false;
    if (reply->error() == QNetworkReply::NoError) {
        const int status = reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt();
        if (status == 200) {
            ok = true;
        } else {
            setError(QStringLiteral("/healthz returned HTTP %1").arg(status));
        }
    } else {
        setError(reply->errorString());
    }

    if (ok) {
        setError(QString());
        m_firstFailureSinceOnline.invalidate();
        m_supervisorRetries = 0;
        setState(ConnectionState::Online);
        return;
    }

    if (!m_firstFailureSinceOnline.isValid()) {
        m_firstFailureSinceOnline.start();
    }

    // In bundled mode, ride the supervisor: hint Reconnecting until the
    // child re-spawns or we exhaust retries (which sets Offline directly).
    const int boot = (m_mode == Mode::Bundled) ? kBootProbeMaxMs : 0;
    if (m_firstFailureSinceOnline.hasExpired(m_offlineThresholdMs + boot)) {
        setState(ConnectionState::Offline);
    } else {
        setState(ConnectionState::Reconnecting);
    }
}

void BackendConnection::setState(ConnectionState s)
{
    if (m_state == s) return;
    m_state = s;
    emit connectionStateChanged();
}

void BackendConnection::setError(const QString& msg)
{
    if (m_error == msg) return;
    m_error = msg;
    emit errorChanged();
}

void BackendConnection::setUrl(const QString& url)
{
    if (m_url == url) return;
    m_url = url;
    emit urlChanged();
}

void BackendConnection::setToken(const QString& token)
{
    if (m_token == token) return;
    m_token = token;
    emit tokenChanged();
}

QString BackendConnection::randomSecret(int bytes)
{
    QByteArray buf(bytes, Qt::Uninitialized);
    auto* gen = QRandomGenerator::system();
    gen->generate(buf.begin(), buf.end());
    return QString::fromLatin1(buf.toBase64(QByteArray::Base64UrlEncoding | QByteArray::OmitTrailingEquals));
}

} // namespace PhpQml::Bridge