GNUMessenger::XMLManager Class Reference

The XMLManager class controls all of the disk-based XML configuration loading and unloading. More...

#include <xml_manager.h>

Collaboration diagram for GNUMessenger::XMLManager:

[legend]List of all members.

Public Member Functions
	XMLManager (const string &directory="")
	~XMLManager ()
	Destructor.
bool	createNew (const string &username, const VBuffer &password)
	Creates new XML config file on disk for specified user and logs that user into the system.
bool	login (const string &username, const VBuffer &password)
	Tries to log the specified user in.
bool	logout ()
	Saves and closes the configuration for a user.
string	getFileName (const string &username) const
	Return the encoded file name for given user name.
bool	commit ()
	Writes configuration to disk.
bool	setPassword (const VBuffer &password)
	Sets active password for loged-in user.
string	getLogin () const
	Returns loged-in username.
bool	isOK ()
	Returns wether someone is logged in or not.
string	encode (const string &inbound)
	Replace HTML formated unfriendly sequences with original sequence.
string	decode (const string &inbound)
	Replace HTML/XML unfriendlies with HTML codes.
XMLNode &	returnXML ()
ContactManager &	contacts ()
SettingsManager &	settings ()
Static Public Member Functions
bool	setDirectory (const string &dir)
	Sets the directory that configs are stored in.
const string &	getDirectory ()
	Returns the current directory used to store configurations.
bool	search (const string &dataToFind, const string &tagName, XMLNode &parentNode, XMLNode &returnNode)
	Static XML searching algo, assigns a node by reference as return.
bool	baseSearch (const string &dataToFind, const string &tagName, XMLNode &parentNode, XMLNode &realParent, unsigned int &num)
	Same as regular search but the parent of the search term is returned.
unsigned int	tagCount (const string &findType, const XMLNode &parentNode)
	Counts all tags of certain type in a XML node, recursive underbelly.
void	getAllTags (const string &findType, XMLNode &parentNode, vector< XMLNode > &result_vector)
	Returns a vector of all tags.
string	printTree (const XMLNode &base)
	Returns a string of the XML tree in text form.
bool	exists (const string &username)
	Checks to see if a given user has a configuration.
bool	isDirectory (const string &dirname)

---

Detailed Description

The XMLManager class controls all of the disk-based XML configuration loading and unloading.

The XML Manager also controls authentication of users and encryption/decryption of disk-based settings.

Author:

Jesse Lovelace

Definition at line 41 of file xml_manager.h.

---

Member Function Documentation

bool GNUMessenger::XMLManager::commit (   )

Writes configuration to disk. Returns: False if no-one is online Exceptions: DiskError  if a file IO error occured Definition at line 261 of file xml_manager.cpp. Referenced by createNew(), logout(), and setPassword(). { // if user is not logged in, then cannot commit to disk if (!m_isOnline) { LOG_ERROR("Cannot Commit to file while not logged in."); return false; } // add xml encoding information for expat string data("<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n"); // convert xmlnode to a string data += string(m_xml); // try to encrypt to disk try { CryptoManager::encryptFile(m_directory + m_filename, m_diskPass, data.c_str()); } catch (CryptoManager::IOError &e) { LOG_THROW(e.what(), DiskError); return false; } //#ifdef _DEBUG // write out debug xml ofstream out; string dir = m_directory + string("test.xml"); out.open(dir.c_str()); out << data; //#endif return true; }

bool GNUMessenger::XMLManager::createNew (  const string &  username, const VBuffer &  password )

Creates new XML config file on disk for specified user and logs that user into the system. Note: The configuration is saved initially Definition at line 98 of file xml_manager.cpp. References commit(), exists(), getFileName(), logout(), GNUMessenger::XMLNode::setName(), and GNUMessenger::XMLNode::setProperty(). { // if username exists, return false if (exists(username)) return false; if (m_isOnline) logout(); // create a new file to hold user data m_filename = getFileName(username); // hash the user's password to use as file key m_diskPass = CryptoManager::hash(password, CryptDefines::SHA_384); // set up initial values in the xml node m_xml.setName("config").setProperty("username", username); m_settingsManager.reset(new SettingsManager(m_xml)); m_contactManager.reset(new ContactManager(m_xml)); // set status to online - user logged in m_isOnline = true; // do initial save to disk commit(); return true; } Here is the call graph for this function:

bool GNUMessenger::XMLManager::exists (  const string &  username  )  [static]

Checks to see if a given user has a configuration. Returns: True if the user has an account file Note: This is directory specific Definition at line 371 of file xml_manager.cpp. Referenced by createNew(), and login(). { string toOpen; toOpen += m_directory; toOpen += CryptoManager::encode(username, CryptDefines::Base32); // file name toOpen += ".gm"; struct stat my_stat; return (stat(toOpen.c_str(), &my_stat) == 0); #if 0 ifstream in; in.open(toOpen.c_str()); if (in.fail() || in.bad()) { return false; } return true; #endif }

bool GNUMessenger::XMLManager::login (  const string &  username, const VBuffer &  password )

Tries to log the specified user in. Note: This function logs the current user out if any Returns: False if user does not exist Exceptions: InvalidPassword  if specified password was invalid AuthFailed  if data integrity could not be verified DiskError  if a file IO error occured Definition at line 129 of file xml_manager.cpp. References exists(), getFileName(), and logout(). { // returns false if user does not exist if (!exists(username)) return false; if (m_isOnline) logout(); m_filename = getFileName(username); m_diskPass = CryptoManager::hash(password, CryptDefines::SHA_384); #if 0 // plain text read in of config for testing ifstream in; string tmp, inbound; in.open("test.xml"); while (getline(in, tmp)) inbound += tmp; *m_config << inbound; #endif try { m_xml << CryptoManager::decryptFile(m_directory + m_filename, m_diskPass); } catch(CryptoManager::InvalidPassword &e) { LOG_THROW(e.what(), PasswordError); } catch(CryptoManager::AuthFailed &e) { LOG_THROW(e.what(), AuthError); } catch(CryptoManager::IOError &e) { LOG_THROW(e.what(), DiskError); } m_settingsManager.reset(new SettingsManager(m_xml)); m_contactManager.reset(new ContactManager(m_xml)); m_isOnline = true; return true; } Here is the call graph for this function:

bool GNUMessenger::XMLManager::logout (   )

Saves and closes the configuration for a user. Returns: False if no-one is currently logged in Definition at line 50 of file xml_manager.cpp. References commit(), and GNUMessenger::VBuffer::wipe(). Referenced by createNew(), and login(). { if (!m_isOnline) return false; // save data commit(); // set status to offline m_isOnline = false; // set the config to a empty xml XMLNode empty; m_xml = empty; // resize the disk password to zero length m_diskPass.wipe(); // erase old file name m_filename.clear(); return true; } Here is the call graph for this function:

bool GNUMessenger::XMLManager::setDirectory (  const string &  dir  )  [static]

Sets the directory that configs are stored in. Returns: False if the directory does not exist, the value before the call is not altered. Definition at line 75 of file xml_manager.cpp. { if (dir.empty()) { LOG_DEBUG("Dir is empty."); m_directory.clear(); return true; } if (!isDirectory(dir)) { LOG_DEBUG("Dir is not a directory."); return false; } m_directory = dir; if ( (dir[dir.length() - 1] != '\\') && (dir[dir.length() -1] != '/')) { m_directory += '/'; } return true; }

---

The documentation for this class was generated from the following files:

• xml_manager.h
• xml_manager.cpp

---