metadata.cpp

/*
    SPDX-License-Identifier: LGPL-2.0-or-later
    SPDX-FileCopyrightText: 2021 Harald Sitter <sitter@kde.org>
*/
 
#include "metadata_p.h"
 
#include <QByteArray>
#include <cerrno>
 
#ifdef Q_OS_LINUX
#include <cstring>
#include <fcntl.h>
#include <span>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#endif
 
namespace KCrash
{
#ifdef Q_OS_LINUX
MetadataINIWriter::MetadataINIWriter(const QByteArray &path)
{
    if (path.isEmpty()) {
        return;
    }
 
    fd = ::open(path.constData(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC, S_IRUSR | S_IWUSR);
    if (fd == -1) {
        fprintf(stderr, "Failed to open metadata file: %s\n", strerror(errno));
    } else if (fd >= 0) {
        writable = true;
    } else {
        fprintf(stderr, "MetadataINIWriter: Unexpected fd %d\n", fd);
        Q_UNREACHABLE();
    }
}
 
void MetadataINIWriter::startGroup(const char *group) const
{
    Q_ASSERT(group); // not null
    Q_ASSERT(strlen(group) > 0); // not empty
    Q_ASSERT(group[strlen(group) - 1] == '\n'); // end in newline
 
    if (!writable) {
        return;
    }
 
    write(fd, group, strlen(group));
}
 
void MetadataINIWriter::startTagsGroup() const
{
    startGroup("[KCrashTags]\n");
}
 
void MetadataINIWriter::startExtraGroup() const
{
    startGroup("[KCrashExtra]\n");
}
 
void MetadataINIWriter::startGPUGroup() const
{
    startGroup("[KCrashGPU]\n");
}
 
void MetadataINIWriter::startKCrashGroup() const
{
    startGroup("[KCrash]\n");
}
 
void MetadataINIWriter::close()
{
    if (fd >= 0 && ::close(fd) == -1) {
        fprintf(stderr, "Failed to close metadata file: %s\n", strerror(errno));
    }
    writable = false;
}
 
void MetadataINIWriter::add(const char *key, const char *value, BoolValue boolValue)
{
    Q_ASSERT(key);
    Q_ASSERT(value);
    Q_ASSERT(key[0] == '-' && key[1] == '-'); // well-formed '--' prefix. This is important. MetadataWriter presume this
    Q_UNUSED(boolValue); // value is a bool string but we don't care, we always write the value anyway
 
    if (!writable) {
        return;
    }
 
    const auto valueSpan = std::span{value, strlen(value)};
 
    write(fd, key + 2, strlen(key + 2));
    write(fd, "=", 1);
    if (strstr(value, "\n")) { // if it contains \n then write literally \n (2 characters)
        // Could appear in the exception what() string. KConfig knows what to do with this.
        for (const auto &character : valueSpan) {
            if (character == '\n') {
                write(fd, "\\n", 2);
            } else {
                write(fd, &character, 1);
            }
        }
    } else { // fast write entire string in one go since it contains no newlines
        write(fd, valueSpan.data(), valueSpan.size());
    }
    write(fd, "\n", 1);
}
 
bool MetadataINIWriter::isWritable() const
{
    return writable;
}
#endif
 
Metadata::Metadata(const char *cmd)
{
    // NB: cmd may be null! Just because we create metadata doesn't mean we'll execute drkonqi (we may only need the
    // backing writers)
    Q_ASSERT(argc == 0);
    argv.at(argc++) = cmd;
}
 
void Metadata::setAdditionalWriter(MetadataWriter *writer)
{
    // Once set the writer oughtn't be reset as we have no use case for this and should we get one in the future
    // it'll need at least review of the existing code to handle writer switching correctly.
    Q_ASSERT(m_writer == nullptr);
    Q_ASSERT(writer != nullptr);
    m_writer = writer;
}
 
void Metadata::add(const char *key, const char *value)
{
    add(key, value, BoolValue::No);
}
 
void Metadata::addBool(const char *key)
{
    add(key, "true", BoolValue::Yes);
}
 
void Metadata::close()
{
    // NULL terminated list
    argv.at(argc) = nullptr;
 
    if (m_writer) {
        m_writer->close();
    }
}
 
void Metadata::add(const char *key, const char *value, BoolValue boolValue)
{
    Q_ASSERT(key);
    Q_ASSERT(value);
    Q_ASSERT(key[0] == '-' && key[1] == '-'); // well-formed '--' prefix. This is important. MetadataWriter presume this
    const auto belowCap = argc < argv.max_size();
    Q_ASSERT(belowCap); // argv has a static max size. guard against exhaustion
    if (!belowCap) {
        return;
    }
 
    argv.at(argc++) = key;
    if (!boolValue) {
        argv.at(argc++) = value;
    }
 
    if (m_writer) {
        m_writer->add(key, value, boolValue);
    }
}
 
} // namespace KCrash