axmol/cocos2dx/support/CCUserDefault.cpp

#include "CCUserDefault.h"
#include "platform/CCFileUtils.h"

#include <libxml/parser.h>
#include <libxml/tree.h>

// root name of xml
#define USERDEFAULT_ROOT_NAME	"userDefaultRoot"

#define XML_FILE_NAME "UserDefault.xml"

using namespace std;

NS_CC_BEGIN;

/**
 * define the functions here because we don't want to
 * export xmlNodePtr and other types in "CCUserDefault.h"
 */

static xmlNodePtr getXMLNodeForKey(const char* pKey, xmlNodePtr *rootNode, xmlDocPtr *doc)
{
	xmlNodePtr curNode = NULL;

	// check the key value
	if (! pKey)
	{
		return NULL;
	}

	do 
	{
		// read doc
		*doc = xmlReadFile(CCUserDefault::sharedUserDefault()->getXMLFilePath().c_str(), "utf-8", XML_PARSE_RECOVER);
		if (NULL == *doc)
		{
			CCLOG("can not read xml file");
			break;
		}

		// get root node
		*rootNode = xmlDocGetRootElement(*doc);
		if (NULL == *rootNode)
		{
			CCLOG("read root node error");
			break;
		}

		// find the node
		curNode = (*rootNode)->xmlChildrenNode;
		while (NULL != curNode)
		{
			if (! xmlStrcmp(curNode->name, BAD_CAST pKey))
			{
				break;
			}

			curNode = curNode->next;
		}
	} while (0);

	return curNode;
}

const char* getValueForKey(const char* pKey)
{
	const char* ret = NULL;
	xmlNodePtr rootNode;
	xmlDocPtr doc;
	xmlNodePtr node = getXMLNodeForKey(pKey, &rootNode, &doc);

	// find the node
	if (node)
	{
		ret = (const char*)xmlNodeGetContent(node);
	}

	// free doc
	if (doc)
	{
		xmlFreeDoc(doc);
	}

	return ret;
}

void setValueForKey(const char* pKey, const char* pValue)
{
	xmlNodePtr rootNode;
	xmlDocPtr doc;
	xmlNodePtr node;

	// check the params
	if (! pKey || ! pValue)
	{
		return;
	}

	// find the node
	node = getXMLNodeForKey(pKey, &rootNode, &doc);

	// if node exist, change the content
	if (node)
	{
		xmlNodeSetContent(node, BAD_CAST pValue);
	}
	else
	{
		if (rootNode)
		{
			// the node doesn't exist, add a new one
			// libxml in android donesn't support xmlNewTextChild, so use this approach
			xmlNodePtr tmpNode = xmlNewNode(NULL, BAD_CAST pKey);
			xmlNodePtr content = xmlNewText(BAD_CAST pValue);
			xmlAddChild(rootNode, tmpNode);
			xmlAddChild(tmpNode, content);
		}	
	}

	// save file and free doc
	if (doc)
	{
		xmlSaveFile(CCUserDefault::sharedUserDefault()->getXMLFilePath().c_str(),doc);
		xmlFreeDoc(doc);
	}
}

/**
 * implements of CCUserDefault
 */

CCUserDefault* CCUserDefault::m_spUserDefault = 0;
string CCUserDefault::m_sFilePath = string("");
bool CCUserDefault::m_sbIsFilePathInitialized = false;

/**
 * If the user invoke delete CCUserDefault::sharedUserDefault(), should set m_spUserDefault
 * to null to avoid error when he invoke CCUserDefault::sharedUserDefault() later.
 */
CCUserDefault::~CCUserDefault()
{
	m_spUserDefault = NULL;
}

void CCUserDefault::purgeSharedUserDefault()
{
	CC_SAFE_DELETE(m_spUserDefault);
	m_spUserDefault = NULL;
}

bool CCUserDefault::getBoolForKey(const char* pKey)
{
	const char* value = getValueForKey(pKey);
	bool ret = false;

	if (value)
	{
		if (! strcmp(value, "true"))
		{
			ret = true;
		}
	}

	return ret;
}

int CCUserDefault::getIntegerForKey(const char* pKey)
{
	const char* value = getValueForKey(pKey);
	int ret = 0;

	if (value)
	{
		ret = atoi(value);
		xmlFree((void*)value);
	}

	return ret;
}

float CCUserDefault::getFloatForKey(const char* pKey)
{
	float ret = (float)getDoubleForKey(pKey);
 
	return ret;
}

double CCUserDefault::getDoubleForKey(const char* pKey)
{
	const char* value = getValueForKey(pKey);
	double ret = 0.0;

	if (value)
	{
		ret = atof(value);
		xmlFree((void*)value);
	}

	return ret;
}

string CCUserDefault::getStringForKey(const char* pKey)
{
	const char* value = getValueForKey(pKey);
	string ret("");

	if (value)
	{
		ret = string(value);
		xmlFree((void*)value);
	}

	return ret;
}

void CCUserDefault::setBoolForKey(const char* pKey, bool value)
{
    // save bool value as sring

	if (true == value)
	{
		setStringForKey(pKey, "true");
	}
	else
	{
		setStringForKey(pKey, "false");
	}
}

void CCUserDefault::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);

	setValueForKey(pKey, tmp);
}

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

void CCUserDefault::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);

	setValueForKey(pKey, tmp);
}

void CCUserDefault::setStringForKey(const char* pKey, std::string value)
{
	// check key
	if (! pKey)
	{
		return;
	}

	setValueForKey(pKey, value.c_str());
}

CCUserDefault* CCUserDefault::sharedUserDefault()
{
	initXMLFilePath();

	// only create xml file one time
	// the file exists after the programe exit
	if ((! isXMLFileExist()) && (! createXMLFile()))
	{
		return NULL;
	}

	if (! m_spUserDefault)
	{
		m_spUserDefault = new CCUserDefault();
	}

	return m_spUserDefault;
}

bool CCUserDefault::isXMLFileExist()
{
	FILE *fp = fopen(m_sFilePath.c_str(), "r");
	bool bRet = false;

	if (fp)
	{
		bRet = true;
		fclose(fp);
	}

	return bRet;
}

void CCUserDefault::initXMLFilePath()
{
	if (! m_sbIsFilePathInitialized)
	{
		m_sFilePath += CCFileUtils::getWriteablePath() + XML_FILE_NAME;
		m_sbIsFilePathInitialized = true;
	}	
}

// create new xml file
bool CCUserDefault::createXMLFile()
{
	bool bRet = false;
    xmlDocPtr doc = NULL;

	do 
	{
		// new doc
		doc = xmlNewDoc(BAD_CAST"1.0");
		if (doc == NULL)
		{
			CCLOG("can not create xml doc");
			break;
		}

		// new root node
		xmlNodePtr rootNode = xmlNewNode(NULL, BAD_CAST USERDEFAULT_ROOT_NAME);
		if (rootNode == NULL)
		{
			CCLOG("can not create root node");
			break;
		}

		// set root node
		xmlDocSetRootElement(doc, rootNode);

		// save xml file
		xmlSaveFile(m_sFilePath.c_str(), doc);

		bRet = true;
	} while (0);

	// if doc is not null, free it
	if (doc)
	{
		xmlFreeDoc(doc);
	}

	return bRet;
}

const string& CCUserDefault::getXMLFilePath()
{
	return m_sFilePath;
}

NS_CC_END;