ini_config.h

/*
    INI LIBRARY

    Header file for reading configuration from INI file
    and storing as a collection.

    Copyright (C) Dmitri Pal <dpal@redhat.com> 2009

    INI Library 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 3 of the License, or
    (at your option) any later version.

    INI Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with INI Library.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef INI_CONFIG_H
#define INI_CONFIG_H

#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <limits.h>
#include <stdio.h>
#include "collection.h"

#define INI_DEFAULT_SECTION "default"

#define COL_CLASS_INI_BASE        20000

#define COL_CLASS_INI_CONFIG      COL_CLASS_INI_BASE + 0

#define COL_CLASS_INI_SECTION     COL_CLASS_INI_BASE + 1

#define COL_CLASS_INI_PERROR      COL_CLASS_INI_BASE + 2

#define COL_CLASS_INI_PESET       COL_CLASS_INI_BASE + 3

#define COL_CLASS_INI_META        COL_CLASS_INI_BASE + 4

#define INI_STOP_ON_ANY     0

#define INI_STOP_ON_NONE    1

#define INI_STOP_ON_ERROR   2

#define ERR_LONGDATA        1

#define ERR_NOCLOSESEC      2

#define ERR_NOSECTION       3

#define ERR_SECTIONLONG     4

#define ERR_NOEQUAL         5

#define ERR_NOKEY           6

#define ERR_LONGKEY         7

#define ERR_MAXPARSE        ERR_LONGKEY

#define ERR_MAXGRAMMAR      0

#define ERR_MAXVALID        0


#define INI_ACCESS_CHECK_MODE   0x00000001

#define INI_ACCESS_CHECK_UID   0x00000002

#define INI_ACCESS_CHECK_GID   0x00000004

struct parse_error {
    unsigned line;
    int error;
};


#define INI_META_ACTION_NOPARSE     0x10000000

#define INI_META_SEC_ACCESS     "ACCESS"

#define INI_META_SEC_ACCESS_FLAG     0x00000001


#define INI_META_KEY_UID     "uid"

#define INI_META_KEY_GID     "gid"

#define INI_META_KEY_PERM     "perm"

#define INI_META_KEY_DEV     "dev"

#define INI_META_KEY_INODE     "inode"

#define INI_META_KEY_MODIFIED     "modified"

#define INI_META_KEY_NAME     "name"

#define INI_META_SEC_ERROR     "ERROR"

#define INI_META_SEC_ERROR_FLAG     0x00000002


#define INI_META_KEY_READ_ERROR     "read_error"


const char *parsing_error_str(int parsing_error);


int config_from_file(const char *application,
                     const char *config_filename,
                     struct collection_item **ini_config,
                     int error_level,
                     struct collection_item **error_list);

int config_from_fd(const char *application,
                   int fd,
                   const char *config_source,
                   struct collection_item **ini_config,
                   int error_level,
                   struct collection_item **error_list);



int config_from_file_with_metadata(
                     const char *application,
                     const char *config_filename,
                     struct collection_item **ini_config,
                     int error_level,
                     struct collection_item **error_list,
                     uint32_t metaflags,
                     struct collection_item **metadata);


int config_from_fd_with_metadata(
                   const char *application,
                   int fd,
                   const char *config_source,
                   struct collection_item **ini_config,
                   int error_level,
                   struct collection_item **error_list,
                   uint32_t metaflags,
                   struct collection_item **metadata);


int config_for_app(const char *application,
                   const char *config_file,
                   const char *config_dir,
                   struct collection_item **ini_config,
                   int error_level,
                   struct collection_item **error_set);

int config_for_app_with_metadata(
                   const char *application,
                   const char *config_file,
                   const char *config_dir,
                   struct collection_item **ini_config,
                   int error_level,
                   struct collection_item **error_set,
                   uint32_t metaflags,
                   struct collection_item **meta_default,
                   struct collection_item **meta_appini);


int config_access_check(struct collection_item *metadata,
                        uint32_t flags,
                        uid_t uid,
                        gid_t gid,
                        mode_t mode,
                        mode_t mask);


int config_changed(struct collection_item *metadata,
                   struct collection_item *saved_metadata,
                   int *changed);

void free_ini_config(struct collection_item *ini_config);

void free_ini_config_errors(struct collection_item *error_set);


void free_ini_config_metadata(struct collection_item *metadata);


void print_file_parsing_errors(FILE *file,
                               struct collection_item *error_list);


void print_config_parsing_errors(FILE *file,
                                 struct collection_item *error_set);

char **get_section_list(struct collection_item *ini_config,
                        int *size,
                        int *error);

void free_section_list(char **section_list);

char **get_attribute_list(struct collection_item *ini_config,
                          const char *section,
                          int *size,
                          int *error);

void free_attribute_list(char **attr_list);

int get_config_item(const char *section,
                    const char *name,
                    struct collection_item *ini_config,
                    struct collection_item **item);

int get_int_config_value(struct collection_item *item,
                         int strict,
                         int def,
                         int *error);

long get_long_config_value(struct collection_item *item,
                           int strict,
                           long def,
                           int *error);

unsigned get_unsigned_config_value(struct collection_item *item,
                                   int strict,
                                   unsigned def,
                                   int *error);

unsigned long get_ulong_config_value(struct collection_item *item,
                                     int strict,
                                     unsigned long def,
                                     int *error);

int32_t get_int32_config_value(struct collection_item *item,
                               int strict,
                               int32_t def,
                               int *error);

uint32_t get_uint32_config_value(struct collection_item *item,
                                 int strict,
                                 uint32_t def,
                                 int *error);

int64_t get_int64_config_value(struct collection_item *item,
                               int strict,
                               int64_t def,
                               int *error);

uint64_t get_uint64_config_value(struct collection_item *item,
                                 int strict,
                                 uint64_t def,
                                 int *error);

double get_double_config_value(struct collection_item *item,
                               int strict,
                               double def,
                               int *error);

unsigned char get_bool_config_value(struct collection_item *item,
                                    unsigned char def,
                                    int *error);

char *get_string_config_value(struct collection_item *item,
                              int *error);
const char *get_const_string_config_value(struct collection_item *item,
                                          int *error);

char *get_bin_config_value(struct collection_item *item,
                           int *length,
                           int *error);

void free_bin_config_value(char *bin);

char **get_string_config_array(struct collection_item *item,
                               const char *sep,
                               int *size,
                               int *error);

char **get_raw_string_config_array(struct collection_item *item,
                                   const char *sep,
                                   int *size,
                                   int *error);

long *get_long_config_array(struct collection_item *item,
                            int *size,
                            int *error);

double *get_double_config_array(struct collection_item *item,
                                int *size,
                                int *error);

void free_string_config_array(char **str_config);

void free_long_config_array(long *array);
void free_double_config_array(double *array);


#endif