path: root/src/strlist.c

/**
 * String array convenience functions
 * @file strlist.c
 */
#include "strlist.h"
#include "utils.h"

/**
 *
 * @param pStrList `StrList`
 */
void strlist_free(struct StrList **pStrList) {
    if (!(*pStrList)) {
        return;
    }

    for (size_t i = 0; i < (*pStrList)->num_inuse; i++) {
        if ((*pStrList)->data[i]) {
            guard_free((*pStrList)->data[i]);
        }
    }
    if ((*pStrList)->data) {
        guard_free((*pStrList)->data);
    }
    guard_free((*pStrList));
}

/**
 * Append a value to the list
 * @param pStrList `StrList`
 * @param str
 */
void strlist_append(struct StrList **pStrList, char *str) {
    char **tmp = NULL;

    if (pStrList == NULL) {
        return;
    }

    tmp = realloc((*pStrList)->data, ((*pStrList)->num_alloc + 1) * sizeof(char *));
    if (tmp == NULL) {
        guard_strlist_free(pStrList);
        perror("failed to append to array");
        exit(1);
    } else if (tmp != (*pStrList)->data) {
        (*pStrList)->data = tmp;
    }
    (*pStrList)->data[(*pStrList)->num_inuse] = strdup(str);
    (*pStrList)->data[(*pStrList)->num_alloc] = NULL;
    strcpy((*pStrList)->data[(*pStrList)->num_inuse], str);
    (*pStrList)->num_inuse++;
    (*pStrList)->num_alloc++;
}

static int reader_strlist_append_file(size_t lineno, char **line) {
    (void)(lineno);  // unused parameter
    (void)(line);   // unused parameter
    return 0;
}

/**
 * Append lines from a local file or remote URL (HTTP/s only)
 * @param pStrList
 * @param path file path or HTTP/s address
 * @param readerFn pointer to a reader function (use NULL to retrieve all data)
 * @return 0=success 1=no data, -1=error (spmerrno set)
 */
int strlist_append_file(struct StrList *pStrList, char *_path, ReaderFn *readerFn) {
    int retval = 0;
    char *path = NULL;
    char *filename = NULL;
    char **data = NULL;
    int is_url = strstr(_path, "://") != NULL;

    if (readerFn == NULL) {
        readerFn = reader_strlist_append_file;
    }

    path = strdup(_path);
    if (path == NULL) {
        retval = -1;
        goto fatal;
    }

    if (is_url) {
        int fd;
        char tempfile[PATH_MAX] = {0};
        strcpy(tempfile, "/tmp/.remote_file.XXXXXX");
        if ((fd = mkstemp(tempfile)) < 0) {
            retval = -1;
            goto fatal;
        }
        close(fd);
        filename = strdup(tempfile);
        long http_code = download(path, filename, NULL);
        if (HTTP_ERROR(http_code)) {
            retval = -1;
            goto fatal;
        }
    } else {
        filename = expandpath(path);
        if (filename == NULL) {
            retval = -1;
            goto fatal;
        }
    }

    data = file_readlines(filename, 0, 0, readerFn);
    if (data == NULL) {
        retval = 1;
        goto fatal;
    }
    for (size_t record = 0; data[record] != NULL; record++) {
        strlist_append(&pStrList, data[record]);
        guard_free(data[record]);
    }
    if (is_url) {
        // remove temporary data
        remove(filename);
    }
    guard_free(data);

fatal:
    guard_free(filename);
    if (path != NULL) {
        guard_free(path);
    }

    return retval;
}

/**
 * Append the contents of `pStrList2` to `pStrList1`
 * @param pStrList1 `StrList`
 * @param pStrList2 `StrList`
 */
void strlist_append_strlist(struct StrList *pStrList1, struct StrList *pStrList2) {
    size_t count = 0;

    if (pStrList1 == NULL || pStrList2 == NULL) {
        return;
    }

    count = strlist_count(pStrList2);
    for (size_t i = 0; i < count; i++) {
        char *item = strlist_item(pStrList2, i);
        strlist_append(&pStrList1, item);
    }
}

/**
 * Append the contents of an array of pointers to char
 * @param pStrList `StrList`
 * @param arr NULL terminated array of strings
 */
 void strlist_append_array(struct StrList *pStrList, char **arr) {
     if (!pStrList || !arr) {
         return;
     }
     for (size_t i = 0; arr[i] != NULL; i++) {
         strlist_append(&pStrList, arr[i]);
     }
 }

/**
 * Append the contents of a newline delimited string
 * @param pStrList `StrList`
 * @param str
 * @param delim
 */
 void strlist_append_tokenize(struct StrList *pStrList, char *str, char *delim) {
    char **token;
     if (!str || !delim) {
         return;
     }

     token = split(str, delim, 0);
     if (token) {
         for (size_t i = 0; token[i] != NULL; i++) {
             strlist_append(&pStrList, token[i]);
         }
         GENERIC_ARRAY_FREE(token);
     }
 }

/**
 * Produce a new copy of a `StrList`
 * @param pStrList  `StrList`
 * @return `StrList` copy
 */
struct StrList *strlist_copy(struct StrList *pStrList) {
    struct StrList *result;
    if (pStrList == NULL) {
        return NULL;
    }

    result = strlist_init();
    if (!result) {
        return NULL;
    }

    for (size_t i = 0; i < strlist_count(pStrList); i++) {
        strlist_append(&result, strlist_item(pStrList, i));
    }
    return result;
}

/**
 * Remove a record by index from a `StrList`
 * @param pStrList
 * @param index
 */
void strlist_remove(struct StrList *pStrList, size_t index) {
    size_t count = strlist_count(pStrList);
    if (count == 0) {
        return;
    }
    if (pStrList->data[index] != NULL) {
        for (size_t i = index; i < count; i++) {
            pStrList->data[i] = pStrList->data[i + 1];
        }
        if (pStrList->num_inuse) {
            pStrList->num_inuse--;
        }
    }
}

/**
 * Compare two `StrList`s
 * @param a `StrList` structure
 * @param b `StrList` structure
 * @return same=0, different=1, error=-1 (a is NULL), -2 (b is NULL)
 */
int strlist_cmp(struct StrList *a, struct StrList *b) {
    if (a == NULL) {
        return -1;
    }

    if (b == NULL) {
        return -2;
    }

    if (a->num_alloc != b->num_alloc || a->num_inuse != b->num_inuse) {
        return 1;
    }


    for (size_t i = 0; i < strlist_count(a); i++) {
        if (strcmp(strlist_item(a, i), strlist_item(b, i)) != 0) {
            return 1;
        }
    }

    return 0;
}

/**
 * Sort a `StrList` by `mode`
 * @param pStrList
 * @param mode Available modes: `STRLIST_DEFAULT` (alphabetic), `STRLIST_ASC` (ascending), `STRLIST_DSC` (descending)
 */
void strlist_sort(struct StrList *pStrList, unsigned int mode) {
    if (pStrList == NULL) {
        return;
    }
    strsort(pStrList->data, mode);
}

/**
 * Reverse the order of a `StrList`
 * @param pStrList
 */
void strlist_reverse(struct StrList *pStrList) {
    char *tmp = NULL;
    size_t i = 0;
    size_t j = 0;

    if (pStrList == NULL) {
        return;
    }

    j = pStrList->num_inuse - 1;
    for (i = 0; i < j; i++) {
        tmp = pStrList->data[i];
        pStrList->data[i] = pStrList->data[j];
        pStrList->data[j] = tmp;
        j--;
    }
}

/**
 * Get the count of values stored in a `StrList`
 * @param pStrList
 * @return
 */
size_t strlist_count(struct StrList *pStrList) {
    size_t result;
    if (pStrList != NULL) {
        result = pStrList->num_inuse;
    } else {
        result = 0;
    }
    return result;
}

/**
 * Set value at index
 * @param pStrList
 * @param value string
 * @return
 */
void strlist_set(struct StrList **pStrList, size_t index, char *value) {
    char *tmp = NULL;
    if (*pStrList == NULL || index > strlist_count(*pStrList)) {
        return;
    }

    if (value == NULL) {
        (*pStrList)->data[index] = NULL;
    } else {
        tmp = realloc((*pStrList)->data[index], (strlen(value) + 1) * sizeof(char *));
        if (!tmp) {
            perror("realloc strlist_set replacement value");
            return;
        } else if (tmp != (*pStrList)->data[index]) {
            (*pStrList)->data[index] = tmp;
        }

        memset((*pStrList)->data[index], '\0', strlen(value) + 1);
        strncpy((*pStrList)->data[index], value, strlen(value));
    }
}

const char *strlist_error_msgs[] = {
        "success",
        "index out of range",
        "invalid value for type",
        "unknown error",
};
int strlist_errno = 0;

void strlist_set_error(int flag) {
    strlist_errno = flag;
}

const char *strlist_get_error(int flag) {
    if (flag < STRLIST_E_SUCCESS || flag > STRLIST_E_UNKNOWN) {
        return strlist_error_msgs[STRLIST_E_UNKNOWN];
    }
    return strlist_error_msgs[flag];
}

void strlist_clear_error() {
    strlist_errno = STRLIST_E_SUCCESS;
}

/**
 * Retrieve data from a `StrList`
 * @param pStrList
 * @param index
 * @return string
 */
char *strlist_item(struct StrList *pStrList, size_t index) {
    if (pStrList && pStrList->data && pStrList->data[index]) {
        return pStrList->data[index];
    }
    return NULL;
}

/**
 * Alias of `strlist_item`
 * @param pStrList
 * @param index
 * @return string
 */
char *strlist_item_as_str(struct StrList *pStrList, size_t index) {
    return strlist_item(pStrList, index);
}

/**
 * Convert value at index to `char`
 * @param pStrList
 * @param index
 * @return `char`
 */
char strlist_item_as_char(struct StrList *pStrList, size_t index) {
    char *error_p;
    char result;

    strlist_clear_error();
    result = (char) strtol(strlist_item(pStrList, index), &error_p, 10);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `unsigned char`
 * @param pStrList
 * @param index
 * @return `unsigned char`
 */
unsigned char strlist_item_as_uchar(struct StrList *pStrList, size_t index) {
    char *error_p;
    unsigned char result;

    strlist_clear_error();
    result = (unsigned char) strtoul(strlist_item(pStrList, index), &error_p, 10);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `short`
 * @param pStrList
 * @param index
 * @return `short`
 */
short strlist_item_as_short(struct StrList *pStrList, size_t index) {
    char *error_p;
    short result;

    strlist_clear_error();
    result = (short) strtol(strlist_item(pStrList, index), &error_p, 10);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `unsigned short`
 * @param pStrList
 * @param index
 * @return `unsigned short`
 */
unsigned short strlist_item_as_ushort(struct StrList *pStrList, size_t index) {
    char *error_p;
    unsigned short result;

    strlist_clear_error();
    result = (unsigned short) strtoul(strlist_item(pStrList, index), &error_p, 10);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `int`
 * @param pStrList
 * @param index
 * @return `int`
 */
int strlist_item_as_int(struct StrList *pStrList, size_t index) {
    char *error_p;
    int result;

    strlist_clear_error();
    result = (int) strtol(strlist_item(pStrList, index), &error_p, 10);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `unsigned int`
 * @param pStrList
 * @param index
 * @return `unsigned int`
 */
unsigned int strlist_item_as_uint(struct StrList *pStrList, size_t index) {
    char *error_p;
    unsigned int result;

    strlist_clear_error();
    result = (unsigned int) strtoul(strlist_item(pStrList, index), &error_p, 10);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `long`
 * @param pStrList
 * @param index
 * @return `long`
 */
long strlist_item_as_long(struct StrList *pStrList, size_t index) {
    char *error_p;
    long result;

    strlist_clear_error();
    result = (long) strtol(strlist_item(pStrList, index), &error_p, 10);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `unsigned long`
 * @param pStrList
 * @param index
 * @return `unsigned long`
 */
unsigned long strlist_item_as_ulong(struct StrList *pStrList, size_t index) {
    char *error_p;
    unsigned long result;

    strlist_clear_error();
    result = (unsigned long) strtoul(strlist_item(pStrList, index), &error_p, 10);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `long long`
 * @param pStrList
 * @param index
 * @return `long long`
 */
long long strlist_item_as_long_long(struct StrList *pStrList, size_t index) {
    char *error_p;
    long long result;

    strlist_clear_error();
    result = (long long) strtoll(strlist_item(pStrList, index), &error_p, 10);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `unsigned long long`
 * @param pStrList
 * @param index
 * @return `unsigned long long`
 */
unsigned long long strlist_item_as_ulong_long(struct StrList *pStrList, size_t index) {
    char *error_p;
    unsigned long long result;

    strlist_clear_error();
    result = (unsigned long long) strtol(strlist_item(pStrList, index), &error_p, 10);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `float`
 * @param pStrList
 * @param index
 * @return `float`
 */
float strlist_item_as_float(struct StrList *pStrList, size_t index) {
    char *error_p;
    float result;

    strlist_clear_error();
    result = (float) strtof(strlist_item(pStrList, index), &error_p);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `double`
 * @param pStrList
 * @param index
 * @return `double`
 */
double strlist_item_as_double(struct StrList *pStrList, size_t index) {
    char *error_p;
    double result;

    strlist_clear_error();
    result = (double) strtod(strlist_item(pStrList, index), &error_p);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Convert value at index to `long double`
 * @param pStrList
 * @param index
 * @return `long double`
 */
long double strlist_item_as_long_double(struct StrList *pStrList, size_t index) {
    char *error_p;
    long double result;

    strlist_clear_error();
    result = (long double) strtold(strlist_item(pStrList, index), &error_p);
    if (!result && error_p && *error_p != 0) {
        strlist_set_error(STRLIST_E_INVALID_VALUE);
        return 0;
    }
    error_p = NULL;
    return result;
}

/**
 * Initialize an empty `StrList`
 * @return `StrList`
 */
struct StrList *strlist_init() {
    struct StrList *pStrList = calloc(1, sizeof(struct StrList));
    if (pStrList == NULL) {
        perror("failed to allocate array");
        return NULL;
    }
    pStrList->num_inuse = 0;
    pStrList->num_alloc = 1;
    pStrList->data = calloc(pStrList->num_alloc, sizeof(char *));
    return pStrList;
}