ui/common/properties.c

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2017 Olaf Wintermann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <errno.h>

#ifdef _WIN32
#include <direct.h>
#endif

#include "../ui/toolkit.h"


#include "properties.h"
#include <cx/string.h>
#include <cx/buffer.h>

#include <cx/hash_map.h>
#include <cx/properties.h>

static CxMap *application_properties;
static CxMap *language;

#ifndef UI_COCOA

static char *locales_dir;
static char *pixmaps_dir;

static UiBool use_xdg_config_home = TRUE;

#endif

static UiBool load_on_startup = TRUE;
static void *properties_data = NULL;
static size_t properties_data_length = 0;

static char *config_root = NULL;

void ui_load_properties_file_on_startup(UiBool enable) {
    load_on_startup = enable;
}

void ui_set_properties_data(const char *str, size_t len) {
    if(str && len > 0) {
        properties_data = malloc(len);
        memcpy(properties_data, str, len);
    } else {
        properties_data = NULL;
        properties_data_length = 0;
    }
}

char* ui_getappdir(void) {
    if(ui_appname() == NULL && config_root == NULL) {
        return NULL;
    }

    return ui_configfile(NULL);
}

void ui_setappdir(const char *path) {
    free(config_root);
    if(path) {
        cxmutstr cfgpath = cx_strdup(path);
        config_root = cfgpath.ptr;
        if(cfgpath.length > 0 && cfgpath.ptr[cfgpath.length-1] == '/') {
            config_root[cfgpath.length-1] = 0;
        }
    } else {
        config_root = NULL;
    }
}

#ifndef _WIN32
#define UI_PATH_SEPARATOR '/'
#define UI_ENV_HOME "HOME"
#else
#define UI_PATH_SEPARATOR '\\'
#define UI_ENV_HOME "USERPROFILE"
#endif

#define UI_XDG_CONFIG_HOME_VAR "XDG_CONFIG_HOME"

char* ui_configfile(const char *name) {
    if(config_root) {
        if(!name) {
            return strdup(config_root);
        } else if(name[0] == '/') {
            return cx_strdup(cx_strcat(CX_NULLSTR, 2, cx_str(config_root), cx_str(name))).ptr;
        } else {
            return cx_strdup(cx_strcat(CX_NULLSTR, 3, cx_str(config_root), cx_str("/"), cx_str(name))).ptr;
        }
    }
    
    const char *appname = ui_appname();
    if(!appname) {
        return NULL;
    }
    
    CxBuffer buf;
    cxBufferInit(&buf, cxDefaultAllocator, NULL, 128, CX_BUFFER_FREE_CONTENTS|CX_BUFFER_AUTO_EXTEND);
    
    // add base dir
    char *homeenv = getenv(UI_ENV_HOME);
    if(homeenv == NULL) {
        cxBufferDestroy(&buf);
        return NULL;
    }
    cxstring home = cx_str(homeenv);
    
    cxBufferWrite(home.ptr, 1, home.length, &buf);
    if(home.ptr[home.length-1] != UI_PATH_SEPARATOR) {
        cxBufferPut(&buf, UI_PATH_SEPARATOR);
    }
    
#ifdef UI_COCOA
    // on OS X the app dir is $HOME/Library/Application Support/$APPNAME/
    cxBufferPutString(&buf, "Library/Application Support/");
#elif defined(_WIN32)
    // on Windows the app dir is $USERPROFILE/AppData/Local/$APPNAME/
    cxBufferPutString(&buf, "AppData\\Roaming\\");
#else
    if(use_xdg_config_home) {
        // app dir is $HOME/.config/$APPNAME/
        char *xdghome = getenv(UI_XDG_CONFIG_HOME_VAR);
        size_t xdghomelen = xdghome ? strlen(xdghome) : 0;
        if(xdghome && xdghomelen > 0) {
            cxBufferSeek(&buf, 0, SEEK_SET);
            cxBufferPutString(&buf, xdghome);
            if(xdghome[xdghomelen-1] != '/') {
                cxBufferPut(&buf, '/');
            }
        } else {
            cxBufferPutString(&buf, ".config/");
        }
    } else {
        cxBufferPut(&buf, '.');
    }
    
#endif
    cxBufferPutString(&buf, appname);
    cxBufferPut(&buf, UI_PATH_SEPARATOR);
    
    // add file name
    if(name) {
        cxBufferPutString(&buf, name);
    }
    
    cxBufferPut(&buf, 0);
    
    return buf.space;
}

static int ui_mkdir(char *path) {
#ifdef _WIN32
    return _mkdir(path);
#else
    return mkdir(path, S_IRWXU);
#endif
} 

static int load_properties(FILE *file, CxMap *map) {
    CxProperties prop;
    cxPropertiesInitDefault(&prop);
    char buf[8192];
    size_t r;
    CxPropertiesStatus status = CX_PROPERTIES_NO_ERROR;
    while((r = fread(buf, 1, 8192, file)) > 0) {
        cxPropertiesFilln(&prop, buf, r);
        cxstring key;
        cxstring value;
        while((status = cxPropertiesNext(&prop, &key, &value)) == CX_PROPERTIES_NO_ERROR) {
            cxMapPut(map, key, cx_strdup(value).ptr);
        }
        if(status > CX_PROPERTIES_OK) {
            break;
        }
    }
    return status <= CX_PROPERTIES_NO_DATA ? 0 : 1;
}

void uic_load_app_properties() {
    application_properties = cxHashMapCreate(cxDefaultAllocator, CX_STORE_POINTERS, 128);
    application_properties->collection.simple_destructor = free;
    
    if(!load_on_startup) {
        if(properties_data) {
            CxProperties prop;
            cxPropertiesInitDefault(&prop);
            
            CxPropertiesStatus status = CX_PROPERTIES_NO_ERROR;
            cxPropertiesFilln(&prop, properties_data, properties_data_length);
            
            cxstring key;
            cxstring value;
            while((status = cxPropertiesNext(&prop, &key, &value)) == CX_PROPERTIES_NO_ERROR) {
                cxMapPut(application_properties, key, cx_strdup(value).ptr);
            }
            
            if(status > CX_PROPERTIES_NO_DATA) {
                fprintf(stderr, "Error: cannot load properties: %d\n", (int)status);
            } else {
                cxMapRehash(application_properties);
            }
        }
        return;
    }
    
    if(!ui_appname()) {
        // applications without name cannot load app properties
        return;
    }
    
    char *dir = ui_configfile(NULL);
    if(!dir) {
        return;
    }
    size_t len = strlen(dir);
    if(len < 2) {
        return;
    }
    if(ui_mkdir(dir)) {
        if(errno == ENOENT) {
            char *parent = strdup(dir);
            for(int i=len-2;i>=0;i--) {
                if(parent[i] == '/') {
                    parent[i] = 0;
                    break;
                }
            }
            // try creating the parent
            int err = ui_mkdir(parent);
            if(err) {
                fprintf(stderr, "Error: Cannot create directory %s: %s\n", parent, strerror(errno));
                free(parent);
                free(dir);
                return;
            }
            free(parent);
            
            // try dir again
            if(!ui_mkdir(dir)) {
                errno = EEXIST; // success
            }
        }
        
        if(errno != EEXIST) {
            fprintf(stderr, "Error: Cannot create directory %s: %s\n", dir, strerror(errno));
            free(dir);
            return;
        }
    }
    free(dir);
    
    char *path = ui_configfile("application.properties");
    if(!path) {
        return;
    }
    
    FILE *file = fopen(path, "r");
    if(!file) {
        free(path);
        return;
    }
    
    if(load_properties(file, application_properties)) {
        fprintf(stderr, "Error: Cannot load application properties.\n");
    }
    
    fclose(file);
    free(path);
}

int uic_store_app_properties() {
    char *path = ui_configfile("application.properties");
    if(!path) {
        return 1;
    }
    
    FILE *file = fopen(path, "w");
    if(!file) {
        fprintf(stderr, "Ui Error: Cannot open properties file: %s\n", path);
        free(path);
        return 1;
    }
    
    int ret = 0;
    CxMapIterator i = cxMapIterator(application_properties);
    cx_foreach(CxMapEntry *, entry, i) {
        fprintf(file, "%.*s = %s\n", (int)entry->key->len, (char*)entry->key->data, (char*)entry->value);
    }
    
    cxMapRehash(application_properties);
    
    fclose(file);
    free(path);
    
    return ret;
}

// public
int ui_app_save_settings(void) {
    return uic_store_app_properties();
}


const char* ui_get_property(const char *name) {
    return cxMapGet(application_properties, name);
}

void ui_set_property(const char *name, const char *value) {
    if(value) {
        cxMapPut(application_properties, name, strdup(value));
    } else {
        cxMapRemove(application_properties, name);
    }
}

const char* ui_set_default_property(const char *name, const char *value) {
    const char *v = cxMapGet(application_properties, name);
    if(!v) {
        cxMapPut(application_properties, name, (char*)value);
        v = value;
    }
    return v;
}

int ui_properties_store(void) {
    return uic_store_app_properties();
}


static char* uic_concat_path(const char *base, const char *p, const char *ext) {
    size_t baselen = strlen(base);
    
    CxBuffer *buf = cxBufferCreate(cxDefaultAllocator, NULL, 32, CX_BUFFER_FREE_CONTENTS|CX_BUFFER_AUTO_EXTEND);
    if(baselen > 0) {
        cxBufferWrite(base, 1, baselen, buf);
        if(base[baselen - 1] != '/') {
            cxBufferPut(buf, '/');
        }
    }
    cxBufferWrite(p, 1, strlen(p), buf);
    if(ext) {
        cxBufferWrite(ext, 1, strlen(ext), buf);
    }
    
    char *str = buf->space;
    free(buf);
    return str;
}

#ifndef UI_COCOA

void ui_locales_dir(const char *path) {
    free(locales_dir);
    locales_dir = path ? strdup(path) : NULL;
}

void ui_pixmaps_dir(const char *path) {
    free(pixmaps_dir);
    pixmaps_dir = path ? strdup(path) : NULL;
}

char* uic_get_image_path(const char *imgfilename) {
    if(pixmaps_dir) {
        return uic_concat_path(pixmaps_dir, imgfilename, NULL);
    } else {
        return NULL;
    }
}

void ui_load_lang(const char *locale) {
    if(!locale) {
        locale = "en_EN";
    }
    
    char *path = uic_concat_path(locales_dir, locale, ".properties");
    
    uic_load_language_file(path);
    free(path);
}

void ui_load_lang_def(char *locale, char *default_locale) {
    char tmp[6];
    if(!locale) {
        char *lang = getenv("LANG");
        if(lang && strlen(lang) >= 5) {
            memcpy(tmp, lang, 5);
            tmp[5] = '\0';
            locale = tmp;
        } else {
            locale = default_locale;
        }
    }
    
    char *path = uic_concat_path(locales_dir, locale, ".properties");
    
    if(uic_load_language_file(path)) {
        if(default_locale) {
            ui_load_lang_def(default_locale, NULL);
        } else {
            // cannot find any language file
            fprintf(stderr, "Ui Error: Cannot load language.\n");
            free(path);
            exit(-1);
        }
    }
    free(path);
}

#endif

int uic_load_language_file(const char *path) {
    CxMap *lang = cxHashMapCreate(cxDefaultAllocator, CX_STORE_POINTERS, 256);
    
    FILE *file = fopen(path, "r");
    if(!file) {
        return 1;
    }
    
    if(load_properties(file, lang)) {
        fprintf(stderr, "Error: Cannot parse language file: %s.\n", path);
    }
    
    fclose(file);
    
    cxMapRehash(lang);
    
    language = lang;
    
    return 0;
}

char* uistr(const char *name) {
    char *value = uistr_n(name);
    return value ? value : "missing string";
}

char* uistr_n(const char *name) {
    if(!language) {
        return NULL;
    }
    return cxMapGet(language, name);
}