inifile.c

/*
 * This file is part of libnica.
 *
 * Copyright © 2016-2017 Intel Corporation
 *
 * libnica is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 */

#define _GNU_SOURCE

#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "hashmap.h"
#include "inifile.h"

/**
 * Mapping of @NcIniError to static strings
 */
static const char *_errors[] = { [NC_INI_ERROR_FILE] = "",
                                 [NC_INI_ERROR_EMPTY_KEY] = "Encountered empty key",
                                 [NC_INI_ERROR_NOT_CLOSED] = "Expected closing \']\' for section",
                                 [NC_INI_ERROR_NO_SECTION] =
                                     "Encountered key=value mapping without a valid section",
                                 [NC_INI_ERROR_INVALID_LINE] = "Expected key=value notation",
                                 [NC_INI_ERROR_INTERNAL] =
                                     "A fatal internal error was encountered" };

const char *nc_ini_error(NcIniError error)
{
        int j = abs(error);
        if (j < NC_INI_ERROR_FILE || j >= NC_INI_ERROR_MAX) {
                return "[Unknown Error]";
        }
        return _errors[j];
}

/**
 * Strip leading whitespace from string (left)
 */
static char *lstrip(char *str, ssize_t len, ssize_t *out_len)
{
        ssize_t skip_len = 0;

        for (ssize_t i = 0; i < len; i++) {
                if (str[i] == ' ' || str[i] == '\t') {
                        ++skip_len;
                        continue;
                }
                break;
        }
        *out_len = len - skip_len;
        if (skip_len > 0) {
                char *c = strdup(str + skip_len);
                free(str);
                return c;
        }
        return str + skip_len;
}

/**
 * Strip trailing whitespace from string (right)
 */
static char *rstrip(char *str, ssize_t len, ssize_t *out_len)
{
        ssize_t skip_len = 0;

        for (ssize_t i = len; i > 0; i--) {
                if (str[i] == ' ' || str[i] == '\t') {
                        ++skip_len;
                        continue;
                } else if (str[i] == '\0') {
                        continue;
                }
                break;
        }
        *out_len = len - skip_len;
        if (len == skip_len) {
                return str;
        }
        str[(len - skip_len)] = '\0';
        return str;
}

/**
 * Chew both ends of a null terminated string of whitespace
 * If the left side is whitespace padded, this will always result
 * in a new allocation due to fast-forwarding the pointer. Keep
 * this in mind.
 */
static char *string_chew_terminated(char *inp)
{
        int skip_offset = 0;
        int len = 0;
        int end_len = 0;
        bool count = true;

        if (!inp) {
                return NULL;
        }

        for (char *c = inp; *c; c++) {
                if (count && (*c == ' ' || *c == '\t')) {
                        ++skip_offset;
                        continue;
                } else {
                        count = false;
                }
                ++len;
        }
        for (int i = len; i > skip_offset; i--) {
                if (inp[i] == ' ' || inp[i] == '\t') {
                        ++end_len;
                        continue;
                } else if (inp[i] == '\0') {
                        continue;
                }
                break;
        }

        if (end_len > 0) {
                inp[(len - end_len)] = '\0';
        }
        if (skip_offset > 0) {
                char *c = strdup(inp + skip_offset);
                free(inp);
                return c;
        }
        return inp;
}

/**
 * Munch both ends of the string
 */
static char *string_strip(char *str, ssize_t len, ssize_t *out_len)
{
        ssize_t mylen = len;

        char *c = lstrip(str, len, &mylen);
        c = rstrip(c, mylen, &mylen);
        if (out_len) {
                *out_len = mylen;
        }
        return c;
}

/* eat \s */
static char *string_unescape(char *str)
{
        char *c, *c1, *c2, *c3;;

        if (!str) {
                return NULL;
        }

        c = calloc(strlen(str) + 1, 1);
        c1 = c;

        c2 = str;
        while (c2 && *c2 != 0) {
                c3 = c2 + 1;
                if (*c2 == '\\') {
                        if (*c3 == 's') {
                                *c = ' ';
                                c++;
                                c2 += 2;
                        } else {
                                c2++;
                        }
                } else {
                        *c = *c2;
                        c++;
                        c2++;
                }
        }

        free(str);
        return c1;
}

NcHashmap *nc_ini_file_parse(const char *path)
{
        NcHashmap *ret = NULL;
        int error_line = 0;
        int r = 0;

        r = nc_ini_file_parse_full(path, &ret, &error_line);
        if (r != 0) {
                if (abs(r) == NC_INI_ERROR_FILE) {
                        fprintf(stderr, "[inifile] %s: %s\n", strerror(errno), path);
                } else {
                        fprintf(stderr,
                                "[inifile] %s [L%d]: %s\n",
                                nc_ini_error(r),
                                error_line,
                                path);
                }
                return NULL;
        }
        return ret;
}

int nc_ini_file_parse_full(const char *path, NcHashmap **out_map, int *error_line_number)
{
        autofree(FILE) *file = NULL;
        char *buf = NULL;
        ssize_t r = 0;
        size_t sn = 0;
        int line_count = 1;
        char *current_section = NULL;
        NcHashmap *root_map = NULL;
        NcHashmap *section_map = NULL;
        bool failed = false;
        int err_ret = 0;

        file = fopen(path, "r");
        if (!file) {
                return -(NC_INI_ERROR_FILE);
        }

        if (!out_map) {
                fprintf(stderr, "nc_ini_file_parse_full(): NcHashmap pointer invalid\n");
                return -1;
        }

        root_map = nc_hashmap_new_full(nc_string_hash,
                                       nc_string_compare,
                                       free,
                                       (nc_hash_free_func)nc_hashmap_free);

        while ((r = getline(&buf, &sn, file)) != -1) {
                char *ch = NULL;
                ssize_t str_len = r;
                char *key = NULL;
                char *value = NULL;

                /* Fix newline */
                if (buf[r - 1] == '\n') {
                        buf[r - 1] = '\0';
                        --r;
                }
                str_len = r;

                buf = string_strip(buf, r, &str_len);
                /* Empty lines are fine */
                if (streq(buf, "")) {
                        goto next;
                }

                if (buf[0] == '[') {
                        /* Validate section start */
                        if (buf[str_len - 1] != ']') {
                                /* Throw error */
                                err_ret = NC_INI_ERROR_NOT_CLOSED;
                                goto fail;
                        }
                        /* Grab the section name, and "close" last section */
                        buf[str_len - 1] = '\0';
                        if (current_section) {
                                free(current_section);
                        }
                        current_section = strdup(buf + 1);
                        section_map = nc_hashmap_get(root_map, current_section);
                        if (!section_map) {
                                /* Create a new section dynamically */
                                section_map = nc_hashmap_new_full(nc_string_hash,
                                                                  nc_string_compare,
                                                                  free,
                                                                  free);
                                nc_hashmap_put(root_map, strdup(current_section), section_map);
                        }
                        goto next;
                } else if (buf[0] == '#' || buf[0] == ';') {
                        /* Skip comment */
                        goto next;
                }

                /* Look for key = value */
                ch = strchr(buf, '=');
                if (!ch) {
                        /* Throw error */
                        err_ret = NC_INI_ERROR_INVALID_LINE;
                        goto fail;
                }

                /* Can't have sectionless k->v */
                if (!current_section) {
                        err_ret = NC_INI_ERROR_NO_SECTION;
                        goto fail;
                }

                long int offset = ch - buf;

                /* Grab the key->value from this assignment line */
                value = strdup((buf + offset) + 1);
                buf[offset] = '\0';
                key = strdup(buf);
                key = string_chew_terminated(key);
                value = string_chew_terminated(value);
                value = string_unescape(value);

                if (streq(key, "")) {
                        err_ret = NC_INI_ERROR_EMPTY_KEY;
                        free(key);
                        key = NULL;
                        free(value);
                        value = NULL;
                        goto fail;
                }

                /* Ensure a section mapping exists */
                section_map = nc_hashmap_get(root_map, current_section);
                if (!section_map) {
                        err_ret = NC_INI_ERROR_INTERNAL;
                        fprintf(stderr,
                                "[inifile] Fatal! No section map for named "
                                "section: %s\n",
                                current_section);
                        goto fail;
                }

                /* Insert these guys into the map */
                if (!nc_hashmap_put(section_map, key, value)) {
                        err_ret = NC_INI_ERROR_INTERNAL;
                        fprintf(stderr, "[inifile] Fatal! Out of memory\n");
                        goto fail;
                }
        /* Progression + cleanup */
        next:
                if (buf) {
                        free(buf);
                        buf = NULL;
                }
                ++line_count;
                sn = 0;
                continue;
        /* Parsing error, bail */
        fail:
                failed = true;
                if (error_line_number) {
                        *error_line_number = line_count;
                }
                if (key) {
                        free(key);
                }
                if (value) {
                        free(value);
                }
                break;
        }

        if (buf) {
                free(buf);
                buf = NULL;
        }

        if (current_section) {
                free(current_section);
                current_section = NULL;
        }

        if (failed) {
                if (root_map) {
                        nc_hashmap_free(root_map);
                }
                return -(err_ret);
        }
        *out_map = root_map;
        return 0;
}

/*
 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 8
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * vi: set shiftwidth=8 tabstop=8 expandtab:
 * :indentSize=8:tabSize=8:noTabs=true:
 */