axmol/cocos/base/CCUserDefault.cpp

/****************************************************************************
Copyright (c) 2010-2012 cocos2d-x.org
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
Copyright (c) 2017-2020 c4games.com.

http://www.cocos2d-x.org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
#if defined(_WIN32)
#include <io.h>
#include <direct.h>
#else
#include <unistd.h>
#include <errno.h>
#endif
#include <fcntl.h>
#include <sys/stat.h>

#include "base/CCUserDefault.h"
#include "platform/CCCommon.h"
#include "platform/CCFileUtils.h"
#include "pugixml/pugixml_imp.hpp"
#include "base/base64.h"
#include "base/ccUtils.h"

#include "yasio/ibstream.hpp"
#include "yasio/obstream.hpp"
#include "yasio/detail/sz.hpp"

#if defined(_WIN32)
#define O_READ_FLAGS O_BINARY | O_RDONLY, S_IREAD
#define O_WRITE_FLAGS O_CREAT | O_RDWR | O_BINARY, S_IWRITE | S_IREAD
#define O_APPEND_FLAGS O_APPEND | O_CREAT | O_RDWR | O_BINARY, S_IWRITE | S_IREAD
#define posix_open ::_open
#define posix_close ::_close
#define posix_lseek ::_lseek
#define posix_read ::_read
#define posix_write ::_write
#define posix_fd2fh(fd) reinterpret_cast<HANDLE>(_get_osfhandle(fd))
#define posix_fsetsize(fd, size) ::_chsize(fd, size)
#else
#define O_READ_FLAGS O_RDONLY, S_IRUSR
#define O_WRITE_FLAGS O_CREAT | O_RDWR, S_IRWXU
#define O_APPEND_FLAGS O_APPEND | O_CREAT | O_RDWR, S_IRWXU
#define posix_open ::open
#define posix_close ::close
#define posix_lseek ::lseek
#define posix_read ::read
#define posix_write ::write
#define posix_fd2fh(fd) (fd)
#define posix_fsetsize(fd, size) ::ftruncate(fd, size), ::lseek(fd, 0, SEEK_SET)
#endif

#define USER_DEFAULT_PLAIN_MODE 0

#if !USER_DEFAULT_PLAIN_MODE
#define USER_DEFAULT_FILENAME "UserDefault.bin"
#else
#define USER_DEFAULT_FILENAME "UserDefault.xml"
#endif

typedef int32_t udflen_t;

NS_CC_BEGIN

/**
 * implements of UserDefault
 */

UserDefault* UserDefault::_userDefault = nullptr;

static void updateMapValue(std::unordered_map<std::string, std::string>& valueMap, const char* key, const char* value)
{
    auto it = valueMap.find(key);
    if (it != valueMap.end())
        it->second = value;
    else
        valueMap.emplace(key, value);
}

UserDefault::~UserDefault()
{
    closeFileMapping();
}

UserDefault::UserDefault()
{
}

void UserDefault::closeFileMapping()
{
    _rwmmap.reset();
    if (_fd != -1) {
        posix_close(_fd);
        _fd = -1;
    }
}

bool UserDefault::getBoolForKey(const char* pKey)
{
 return getBoolForKey(pKey, false);
}

bool UserDefault::getBoolForKey(const char* pKey, bool defaultValue)
{
    auto it = this->_values.find(pKey);
    if (it != this->_values.end())
        return it->second == "1";

    return defaultValue;
}

int UserDefault::getIntegerForKey(const char* pKey)
{
    return getIntegerForKey(pKey, 0);
}

int UserDefault::getIntegerForKey(const char* pKey, int defaultValue)
{
    auto it = this->_values.find(pKey);
    if (it != this->_values.end())
        return atoi(it->second.c_str());

    return defaultValue;
}

float UserDefault::getFloatForKey(const char* pKey)
{
    return getFloatForKey(pKey, 0.0f);
}

float UserDefault::getFloatForKey(const char* pKey, float defaultValue)
{
    float ret = (float)getDoubleForKey(pKey, (double)defaultValue);
 
    return ret;
}

double  UserDefault::getDoubleForKey(const char* pKey)
{
    return getDoubleForKey(pKey, 0.0);
}

double UserDefault::getDoubleForKey(const char* pKey, double defaultValue)
{
    auto it = this->_values.find(pKey);
    if (it != this->_values.end())
        return utils::atof(it->second.c_str());

    return defaultValue;
}

std::string UserDefault::getStringForKey(const char* pKey)
{
    return getStringForKey(pKey, "");
}

std::string UserDefault::getStringForKey(const char* pKey, const std::string & defaultValue)
{
    auto it = this->_values.find(pKey);
    if (it != this->_values.end())
        return it->second;

    return defaultValue;
}

void UserDefault::setBoolForKey(const char* pKey, bool value)
{
    // save bool value as string
    setStringForKey(pKey, value ? "true" : "false");
}

void UserDefault::setIntegerForKey(const char* pKey, int value)
{
    // check key
    if (! pKey)
    {
        return;
    }

    // format the value
    char tmp[50];
    memset(tmp, 0, 50);
    sprintf(tmp, "%d", value);

    setStringForKey(pKey, tmp);
}

void UserDefault::setFloatForKey(const char* pKey, float value)
{
    setDoubleForKey(pKey, value);
}

void UserDefault::setDoubleForKey(const char* pKey, double value)
{
    // check key
    if (! pKey)
    {
        return;
    }

    // format the value
    char tmp[50];
    memset(tmp, 0, 50);
    sprintf(tmp, "%f", value);

    setStringForKey(pKey, tmp);
}

void UserDefault::setStringForKey(const char* pKey, const std::string & value)
{
    // ignore empty key
    if (! pKey || !*pKey)
    {
        return;
    }

    updateMapValue(_values, pKey, value.c_str());

#if !USER_DEFAULT_PLAIN_MODE
    if (_rwmmap) {
        yasio::obstream obs;
        obs.write_v(pKey);
        obs.write_v(value);
        if ((_realSize + obs.length() + sizeof(udflen_t)) < _curMapSize)
        {
            // increase entities count
            auto count = yasio::endian::ntohv(*(udflen_t*)_rwmmap->data());
            *(udflen_t*)_rwmmap->data() = yasio::endian::htonv(count + 1);

            // append entity
            ::memcpy(_rwmmap->data() + sizeof(udflen_t) + _realSize, obs.data(), obs.length());
            _realSize += obs.length();
        }
        else {
            flush();
        }
    }
#else
    flush();
#endif
}

UserDefault* UserDefault::getInstance()
{
    if (!_userDefault)
    {
        _userDefault = new (std::nothrow) UserDefault();
        _userDefault->init();
    }

    return _userDefault;
}

void UserDefault::destroyInstance()
{
    CC_SAFE_DELETE(_userDefault);
}

void UserDefault::setDelegate(UserDefault *delegate)
{
    if (_userDefault)
        delete _userDefault;

    _userDefault = delegate;
}

void UserDefault::init()
{
    if (! _initialized)
    {
        _filePath = FileUtils::getInstance()->getWritablePath() + USER_DEFAULT_FILENAME;

#if !USER_DEFAULT_PLAIN_MODE
        // construct file mapping
        _fd = posix_open(_filePath.c_str(), O_WRITE_FLAGS);
        if (_fd == -1) {
            log("[Warnning] UserDefault::init open storage file '%s' failed!", _filePath.c_str());
            return;
        }

        int filesize = posix_lseek(_fd, 0, SEEK_END);
        posix_lseek(_fd, 0, SEEK_SET);

        if (filesize < _curMapSize) { // construct a empty file mapping
            posix_fsetsize(_fd, _curMapSize);
            _rwmmap = std::make_shared<mio::mmap_sink>(posix_fd2fh(_fd), 0, _curMapSize);
        }
        else { /// load to memory _values
            _rwmmap = std::make_shared<mio::mmap_sink>(posix_fd2fh(_fd), 0, mio::map_entire_file);
            if (_rwmmap->is_mapped()) { // no error
                yasio::ibstream_view ibs(_rwmmap->data(), _rwmmap->length());

                if (ibs.length() > 0) {
                    // read count of keyvals.
                    int count = ibs.read_i<int>();
                    for (auto i = 0; i < count; ++i) {
                        auto key = ibs.read_v();
                        auto value = ibs.read_v();
                        updateMapValue(this->_values, key.data(), value.data());
                    }
                    _realSize = ibs.seek(0, SEEK_CUR) - sizeof(udflen_t);
                }
            }
            else {
                closeFileMapping();
                ::remove(_filePath.c_str());
                log("[Warnning] UserDefault::init map file '%s' failed, we can't save data persisit this time, next time we will retry!", _filePath.c_str());
            }
        }
#else
        pugi::xml_document doc;
        pugi::xml_parse_result ret = doc.load_file(_filePath.c_str());
        if (ret) {
            for (auto& elem : doc.document_element())
                updateMapValue(_values, elem.name(), elem.text().as_string());
        }
        else {
            log("UserDefault::init load xml file: %s failed, %s", _filePath.c_str(), ret.description());
        }
#endif

        _initialized = true;
    }    
}

void UserDefault::flush()
{
#if !USER_DEFAULT_PLAIN_MODE
    if (_rwmmap) {
        yasio::obstream obs;
        obs.write_i<int>(static_cast<int>(this->_values.size()));
        for (auto& item : this->_values) {
            obs.write_v(item.first);
            obs.write_v(item.second);
        }

        std::error_code error;
        if (obs.length() > _curMapSize) {
            _rwmmap->unmap();
            _curMapSize <<= 1; // X2
            posix_fsetsize(_fd, _curMapSize);
            _rwmmap->map(posix_fd2fh(_fd), 0, _curMapSize, error);
        }

        if (!error && _rwmmap->is_mapped())
        { // mapping status is good
            ::memcpy(_rwmmap->data(), obs.data(), obs.length());
            _realSize = obs.length() - sizeof(udflen_t);
        }
        else {
            // close file mapping and do a simple workaround fix to don't do persist later at this time
            closeFileMapping();
            ::remove(_filePath.c_str());
        }
    }
#else
    pugi::xml_document doc;
    doc.load_string(R"(<?xml version="1.0" ?>
<r />)");
    auto r = doc.document_element();
    for(auto& kv : _values)
        r.append_child(kv.first.c_str())
        .append_child(pugi::xml_node_type::node_pcdata)
        .set_value(kv.second.c_str());
    doc.save_file(_filePath.c_str(), "  ");
#endif
}

void UserDefault::deleteValueForKey(const char* key)
{
    if(this->_values.erase(key) > 0)
        flush();
}

NS_CC_END