clearsilver.cpp

/*
 * SPDX-FileCopyrightText: (C) 2013-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#include "action.h"
#include "clearsilver_p.h"
#include "context.h"
#include "response.h"

#include <QFile>
#include <QString>
#include <QtCore/QLoggingCategory>

Q_LOGGING_CATEGORY(CUTELYST_CLEARSILVER, "cutelyst.clearsilver", QtWarningMsg)

using namespace Cutelyst;

ClearSilver::ClearSilver(QObject *parent, const QString &name)
    : View(new ClearSilverPrivate, parent, name)
{
}

QStringList ClearSilver::includePaths() const
{
    Q_D(const ClearSilver);
    return d->includePaths;
}

void ClearSilver::setIncludePaths(const QStringList &paths)
{
    Q_D(ClearSilver);
    d->includePaths = paths;
    Q_EMIT changed();
}

QString ClearSilver::templateExtension() const
{
    Q_D(const ClearSilver);
    return d->extension;
}

void ClearSilver::setTemplateExtension(const QString &extension)
{
    Q_D(ClearSilver);
    d->extension = extension;
    Q_EMIT changed();
}

QString ClearSilver::wrapper() const
{
    Q_D(const ClearSilver);
    return d->wrapper;
}

void ClearSilver::setWrapper(const QString &name)
{
    Q_D(ClearSilver);
    d->wrapper = name;
    Q_EMIT changed();
}

NEOERR *cutelyst_render(void *user, char *data)
{
    QByteArray *body = static_cast<QByteArray *>(user);
    if (body) {
        body->append(data);
    }
    //    qDebug() << "_render" << body << data;
    return nullptr;
}

QByteArray ClearSilver::render(Context *c) const
{
    Q_D(const ClearSilver);

    QByteArray output;
    const QVariantHash &stash = c->stash();
    QString templateFile      = stash.value(QStringLiteral("template")).toString();
    if (templateFile.isEmpty()) {
        if (c->action() && !c->action()->reverse().isEmpty()) {
            templateFile = c->action()->reverse() + d->extension;
        }

        if (templateFile.isEmpty()) {
            c->error(QStringLiteral(
                "Cannot render template, template name or template stash key not defined"));
            return output;
        }
    }

    qCDebug(CUTELYST_CLEARSILVER) << "Rendering template" << templateFile;
    QByteArray body;
    if (!d->render(c, templateFile, stash, body)) {
        return output;
    }

    if (!d->wrapper.isEmpty()) {
        QString wrapperFile = d->wrapper;

        QVariantHash data = stash;
        data.insert(QStringLiteral("content"), body);
        body.clear();

        if (!d->render(c, wrapperFile, data, body)) {
            return output;
        }
    }
    output = body;

    return output;
}

NEOERR *findFile(void *c, HDF *hdf, const char *filename, char **contents)
{
    Q_UNUSED(hdf)
    const ClearSilverPrivate *priv = static_cast<ClearSilverPrivate *>(c);
    if (!priv) {
        return nerr_raise(NERR_NOMEM, "Cound not cast ClearSilverPrivate");
    }

    for (const QString &includePath : priv->includePaths) {
        QFile file(includePath + QLatin1Char('/') + QString::fromLatin1(filename));

        if (file.exists()) {
            if (!file.open(QFile::ReadOnly)) {
                return nerr_raise(
                    NERR_IO, "Cound not open file: %s", file.errorString().toLatin1().data());
            }

            *contents = qstrdup(file.readAll().constData());
            qCDebug(CUTELYST_CLEARSILVER) << "Rendering template:" << file.fileName();
            return nullptr;
        }
    }

    return nerr_raise(NERR_NOT_FOUND, "Cound not find file: %s", filename);
}

bool ClearSilverPrivate::render(Context *c,
                                const QString &filename,
                                const QVariantHash &stash,
                                QByteArray &output) const
{
    HDF *hdf = hdfForStash(c, stash);
    CSPARSE *cs;
    NEOERR *error;

    error = cs_init(&cs, hdf);
    if (error) {
        STRING msg;
        string_init(&msg);
        nerr_error_traceback(error, &msg);
        QString errorMsg;
        errorMsg = QStringLiteral("Failed to init ClearSilver:\n+1")
                       .arg(QString::fromLatin1(msg.buf, msg.len));
        renderError(c, errorMsg);

        string_clear(&msg);
        hdf_destroy(&hdf);
        nerr_ignore(&error);
        return false;
    }

    cs_register_fileload(cs, const_cast<ClearSilverPrivate *>(this), findFile);

    error = cs_parse_file(cs, filename.toLatin1().data());
    if (error) {
        STRING msg;
        string_init(&msg);
        nerr_error_traceback(error, &msg);
        QString errorMsg;
        errorMsg = QStringLiteral("Failed to parse template file: +1\n+2")
                       .arg(filename, QString::fromLatin1(msg.buf, msg.len));
        renderError(c, errorMsg);
        nerr_log_error(error);

        string_clear(&msg);
        hdf_destroy(&hdf);
        nerr_ignore(&error);
        return false;
    }

    cs_render(cs, &output, cutelyst_render);

    cs_destroy(&cs);
    hdf_destroy(&hdf);

    return true;
}

void ClearSilverPrivate::renderError(Context *c, const QString &error) const
{
    c->error(error);
    c->res()->setBody(error);
}

HDF *ClearSilverPrivate::hdfForStash(Context *c, const QVariantHash &stash) const
{
    HDF *hdf = 0;
    hdf_init(&hdf);

    serializeHash(hdf, stash);

    const QMetaObject *meta = c->metaObject();
    for (int i = 0; i < meta->propertyCount(); ++i) {
        QMetaProperty prop = meta->property(i);
        QString name       = QLatin1String("c.") + QString::fromLatin1(prop.name());
        QVariant value     = prop.read(c);
        serializeVariant(hdf, value, name);
    }
    return hdf;
}

void ClearSilverPrivate::serializeHash(HDF *hdf,
                                       const QVariantHash &hash,
                                       const QString &prefix) const
{
    QString _prefix;
    if (!prefix.isEmpty()) {
        _prefix = prefix + QLatin1Char('.');
    }

    auto it = hash.constBegin();
    while (it != hash.constEnd()) {
        serializeVariant(hdf, it.value(), _prefix + it.key());
        ++it;
    }
}

void ClearSilverPrivate::serializeMap(HDF *hdf, const QVariantMap &map, const QString &prefix) const
{
    QString _prefix;
    if (!prefix.isEmpty()) {
        _prefix = prefix + QLatin1Char('.');
    }

    auto it = map.constBegin();
    while (it != map.constEnd()) {
        serializeVariant(hdf, it.value(), _prefix + it.key());
        ++it;
    }
}

void ClearSilverPrivate::serializeVariant(HDF *hdf, const QVariant &value, const QString &key) const
{
    //    qDebug() << key;

    switch (value.type()) {
    case QVariant::String:
        hdf_set_value(hdf, key.toLatin1().data(), value.toString().toLatin1().data());
        break;
    case QVariant::Int:
        hdf_set_int_value(hdf, key.toLatin1().data(), value.toInt());
        break;
    case QVariant::Hash:
        serializeHash(hdf, value.toHash(), key);
        break;
    case QVariant::Map:
        serializeMap(hdf, value.toMap(), key);
        break;
    default:
        if (value.canConvert(QMetaType::QString)) {
            hdf_set_value(hdf, key.toLatin1().data(), value.toString().toLatin1().data());
        }
        break;
    }
}

#include "moc_clearsilver.cpp"