ini_configobj.h

/*
    INI LIBRARY

    Header file for the ini configuration interface.
    THIS IS THE PREFERRED INTERFACE TO USE.

    Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - 2012

    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_CONFIGOBJ_H
#define INI_CONFIGOBJ_H

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

struct value_obj;

#ifndef DING_ATTR_FORMAT
#  if ((__GNUC__ > 3) || ((__GNUC__ == 3) && (__GNUC_MINOR__ >= 3)))
#    define DING_ATTR_FORMAT(fmt, args) __attribute__((__format__(__printf__, fmt, args)))
#  else
#    define DING_ATTR_FORMAT(fmt, args)
#  endif
#endif

enum index_utf_t {
    INDEX_UTF32BE = 0,  
    INDEX_UTF32LE = 1,  
    INDEX_UTF16BE = 2,  
    INDEX_UTF16LE = 3,  
    INDEX_UTF8 = 4,     
    INDEX_UTF8NOBOM = 5 
};

enum ERR_LEVEL {
    INI_STOP_ON_ANY   = 0, 
    INI_STOP_ON_NONE  = 1, 
    INI_STOP_ON_ERROR = 2  
};

enum ERR_PARSE {
    ERR_LONGDATA = 1, 
    ERR_NOCLOSESEC,   
    ERR_NOSECTION,    
    ERR_SECTIONLONG,  
    ERR_NOEQUAL,      
    ERR_NOKEY,        
    ERR_LONGKEY,      
    ERR_READ,         
    ERR_SPACE,        
    ERR_DUPKEY,       
    ERR_DUPKEYSEC,    
    ERR_DUPSECTION,   
    ERR_SPECIAL,      
    ERR_TAB,          
    ERR_BADCOMMENT,   
    ERR_MAXPARSE = ERR_BADCOMMENT 
};

#define INI_META_NONE     0

#define INI_META_STATS    1

#define INI_ACCESS_CHECK_MODE   0x00000001

#define INI_ACCESS_CHECK_UID   0x00000002

#define INI_ACCESS_CHECK_GID   0x00000004

#define INI_MV1S_OVERWRITE 0x0000

#define INI_MV1S_ERROR     0x0001

#define INI_MV1S_PRESERVE  0x0002

#define INI_MV1S_ALLOW     0x0003

#define INI_MV1S_DETECT    0x0004

#define INI_MV2S_OVERWRITE 0x0000

#define INI_MV2S_ERROR     0x0010

#define INI_MV2S_PRESERVE  0x0020

#define INI_MV2S_ALLOW     0x0030

#define INI_MV2S_DETECT    0x0040

#define INI_MS_MERGE     0x0000

#define INI_MS_ERROR     0x0100

#define INI_MS_OVERWRITE 0x0200

#define INI_MS_PRESERVE  0x0300

#define INI_MS_DETECT    0x0400

#define INI_PARSE_NOWRAP           0x0001

#define INI_PARSE_NOSPACE          0x0002

#define INI_PARSE_NOTAB            0x0004

#define INI_PARSE_NO_C_COMMENTS    0x0008

#define INI_PARSE_IGNORE_NON_KVP    0x0010

enum INI_GET {
    INI_GET_FIRST_VALUE, 
    INI_GET_NEXT_VALUE,  
    INI_GET_LAST_VALUE   
};

struct access_check {
    uint32_t flags; 
    uid_t uid;      
    gid_t gid;      
    mode_t mode;    
    mode_t mask;    
};

enum augmode {
    INI_AUG_ANY   = 0, 
    INI_AUG_ADD   = 1, 
    INI_AUG_OVER  = 2  
};

#define INI_DEFAULT_SECTION "default"

struct ini_cfgobj;
struct ini_cfgfile;

struct ini_parse_error;


int ini_config_create(struct ini_cfgobj **ini_config);

void ini_config_destroy(struct ini_cfgobj *ini_config);

void ini_config_clean_state(struct ini_cfgobj *ini_config);

int ini_config_file_open(const char *filename,
                         uint32_t metadata_flags,
                         struct ini_cfgfile **file_ctx);

int ini_config_file_from_mem(void *data_buf,
                             uint32_t data_len,
                             struct ini_cfgfile **file_ctx);

void ini_config_file_close(struct ini_cfgfile *file_ctx);


int ini_config_file_reopen(struct ini_cfgfile *file_ctx_in,
                           struct ini_cfgfile **file_ctx_out);


void ini_config_file_destroy(struct ini_cfgfile *file_ctx);

int ini_config_file_backup(struct ini_cfgfile *file_ctx,
                           const char *backup_dir,
                           const char *backup_tpl,
                           struct access_check *backup_access,
                           unsigned max_num);

int ini_config_change_access(struct ini_cfgfile *file_ctx,
                             struct access_check *new_access);

int ini_config_save(struct ini_cfgfile *file_ctx,
                    struct access_check *new_access,
                    struct ini_cfgobj *ini_config);


/* Save configuration in a file using existing context but with a new name */
int ini_config_save_as(struct ini_cfgfile *file_ctx,
                       const char *filename,
                       struct access_check *new_access,
                       struct ini_cfgobj *ini_config);



enum index_utf_t ini_config_get_bom(struct ini_cfgfile *file_ctx);

int ini_config_set_bom(struct ini_cfgfile *file_ctx, enum index_utf_t bom);


unsigned ini_config_error_count(struct ini_cfgobj *ini_config);

int ini_config_get_errors(struct ini_cfgobj *ini_config,
                          char ***errors);

void ini_config_free_errors(char **errors);

void ini_config_print_errors(FILE *file, char **error_list);

const char *ini_config_get_filename(struct ini_cfgfile *file_ctx);

const struct stat *ini_config_get_stat(struct ini_cfgfile *file_ctx);



void ini_config_file_print(struct ini_cfgfile *file_ctx);

int ini_config_access_check(struct ini_cfgfile *file_ctx,
                            uint32_t flags,
                            uid_t uid,
                            gid_t gid,
                            mode_t mode,
                            mode_t mask);

int ini_config_changed(struct ini_cfgfile *file_ctx1,
                       struct ini_cfgfile *file_ctx2,
                       int *changed);

int ini_config_parse(struct ini_cfgfile *file_ctx,
                     int error_level,
                     uint32_t collision_flags,
                     uint32_t parse_flags,
                     struct ini_cfgobj *ini_config);

int ini_config_copy(struct ini_cfgobj *ini_config,
                    struct ini_cfgobj **ini_new);

int ini_config_merge(struct ini_cfgobj *first,
                     struct ini_cfgobj *second,
                     uint32_t collision_flags,
                     struct ini_cfgobj **result);


int ini_config_augment(struct ini_cfgobj *base_cfg,
                       const char *path,
                       const char *patterns[],
                       const char *sections[],
                       struct access_check *check_perm,
                       int error_level,
                       uint32_t collision_flags,
                       uint32_t parse_flags,
                       uint32_t merge_flags,
                       struct ini_cfgobj **result_cfg,
                       struct ref_array **error_list,
                       struct ref_array **success_list);

int ini_config_set_wrap(struct ini_cfgobj *ini_config,
                        uint32_t boundary);

/* Functions that add, modify or delete sections and values in
 * the configuration object can be found in section \ref ini_mod.
 */

char **ini_get_section_list(struct ini_cfgobj *ini_config,
                            int *size,
                            int *error);

void ini_free_section_list(char **section_list);

char **ini_get_attribute_list(struct ini_cfgobj *ini_config,
                              const char *section,
                              int *size,
                              int *error);

void ini_free_attribute_list(char **attr_list);

int ini_get_config_valueobj(const char *section,
                            const char *name,
                            struct ini_cfgobj *ini_config,
                            int mode,
                            struct value_obj **vo);



int ini_get_int_config_value(struct value_obj *vo,
                             int strict,
                             int def,
                             int *error);

unsigned ini_get_unsigned_config_value(struct value_obj *vo,
                                       int strict,
                                       unsigned def,
                                       int *error);

long ini_get_long_config_value(struct value_obj *vo,
                               int strict,
                               long def,
                               int *error);

unsigned long ini_get_ulong_config_value(struct value_obj *vo,
                                         int strict,
                                         unsigned long def,
                                         int *error);


int32_t ini_get_int32_config_value(struct value_obj *vo,
                                   int strict,
                                   int32_t def,
                                   int *error);

uint32_t ini_get_uint32_config_value(struct value_obj *vo,
                                     int strict,
                                     uint32_t def,
                                     int *error);

int64_t ini_get_int64_config_value(struct value_obj *vo,
                                   int strict,
                                   int64_t def,
                                   int *error);

uint64_t ini_get_uint64_config_value(struct value_obj *vo,
                                     int strict,
                                     uint64_t def,
                                     int *error);

double ini_get_double_config_value(struct value_obj *vo,
                                   int strict,
                                   double def,
                                   int *error);

unsigned char ini_get_bool_config_value(struct value_obj *vo,
                                        unsigned char def,
                                        int *error);

char *ini_get_string_config_value(struct value_obj *vo,
                                  int *error);
const char *ini_get_const_string_config_value(struct value_obj *vo,
                                              int *error);

char *ini_get_bin_config_value(struct value_obj *vo,
                               int *length,
                               int *error);

void ini_free_bin_config_value(char *bin);

char **ini_get_string_config_array(struct value_obj *vo,
                                   const char *sep,
                                   int *size,
                                   int *error);

char **ini_get_raw_string_config_array(struct value_obj *vo,
                                       const char *sep,
                                       int *size,
                                       int *error);

long *ini_get_long_config_array(struct value_obj *vo,
                                int *size,
                                int *error);

double *ini_get_double_config_array(struct value_obj *vo,
                                    int *size,
                                    int *error);

void ini_free_string_config_array(char **str_config);

void ini_free_long_config_array(long *array);
void ini_free_double_config_array(double *array);

struct ini_errobj;

int ini_errobj_create(struct ini_errobj **_errobj);

void ini_errobj_destroy(struct ini_errobj **errobj);

int ini_errobj_add_msg(struct ini_errobj *errobj,
                       const char *format, ...)
                       DING_ATTR_FORMAT(2, 3);

void ini_errobj_reset(struct ini_errobj *errobj);

const char *ini_errobj_get_msg(struct ini_errobj *errobj);

void ini_errobj_next(struct ini_errobj *errobj);

int ini_errobj_no_more_msgs(struct ini_errobj *errobj);

size_t ini_errobj_count(struct ini_errobj *errobj);

typedef int (ini_validator_func)(const char *rule_name,
                                 struct ini_cfgobj *rules_obj,
                                 struct ini_cfgobj *config_obj,
                                 struct ini_errobj *errobj,
                                 void **data);

typedef int (ini_schema_validator_func)(const char *rule_name,
                                        struct ini_cfgobj *rules_obj,
                                        struct ini_errobj *errobj,
                                        void **data);

struct ini_validator {
    const char *name;
    ini_validator_func *func;
    /* currently unused, for future expansion */
    ini_schema_validator_func *schema_validator;
};

int ini_rules_read_from_file(const char *filename,
                             struct ini_cfgobj **_rules_obj);

int ini_rules_check(struct ini_cfgobj *rules_obj,
                    struct ini_cfgobj *config_obj,
                    struct ini_validator **extra_validators,
                    struct ini_errobj *errobj);

void ini_rules_destroy(struct ini_cfgobj *ini_config);

#endif