ChatLogger Class Reference

#include <chatlogger.h>

Public Member Functions
	ChatLogger ()
	~ChatLogger ()
void	log (std::string str)
void	log (std::string name, std::string str)
void	loadLast (std::string name, std::list< std::string > &list, const unsigned int n) const
std::string	getDir () const
void	setServerName (const std::string &serverName)
void	setBaseLogDir (const std::string &logDir)
void	clear ()

Static Public Member Functions
static std::string	secureName (std::string &str)

Private Member Functions
void	setLogFile (const std::string &logFilename)
void	setLogDir (const std::string &logDir)

Static Private Member Functions
static void	writeTo (std::ofstream &file, const std::string &str)

Private Attributes
std::ofstream	mLogFile
std::string	mLogDir
std::string	mBaseLogDir
std::string	mServerName
std::string	mLogFileName

Detailed Description

Definition at line 31 of file chatlogger.h.

Constructor & Destructor Documentation

ChatLogger()

ChatLogger::ChatLogger

(

)

Constructor.

Definition at line 45 of file chatlogger.cpp.

                       :
    mLogFile(),
    mLogDir(),
    mBaseLogDir(),
    mServerName(),
    mLogFileName()
{
}

~ChatLogger()

ChatLogger::~ChatLogger

(

)

Destructor, closes log file.

Definition at line 54 of file chatlogger.cpp.

{
    if (mLogFile.is_open())
        mLogFile.close();
}

References mLogFile.

Member Function Documentation

clear()

void ChatLogger::clear

(

)

Definition at line 228 of file chatlogger.cpp.

{
    mLogDir.clear();
    mServerName.clear();
    mLogFileName.clear();
}

References mLogDir, mLogFileName, and mServerName.

getDir()

std::string ChatLogger::getDir

(

)

const

Definition at line 124 of file chatlogger.cpp.

{
    std::string date;
 
    time_t rawtime;
    char buffer [81];
 
    time(&rawtime);
    tm *const timeinfo = localtime(&rawtime);
 
    strftime(buffer, 79, "%Y-%m/%d", timeinfo);
 
    date = strprintf("%s/%s/%s",
        mBaseLogDir.c_str(),
        mServerName.c_str(),
        buffer);
 
    return date;
}

References mBaseLogDir, mServerName, and strprintf().

Referenced by loadLast(), and log().

loadLast()

void ChatLogger::loadLast	(	std::string	name,
		std::list< std::string > &	list,
		const unsigned int	n
	)		const

Definition at line 197 of file chatlogger.cpp.

{
    std::ifstream logFile;
    std::string fileName = strprintf("%s/%s.log",
        getDir().c_str(),
        secureName(name).c_str());
 
    logFile.open(fileName.c_str(), std::ios::in);
 
    if (!logFile.is_open())
        return;
 
    char line[710];
    unsigned sz = CAST_U32(list.size());
    while (logFile.getline(line, 700))
    {
        list.push_back(line);
        sz ++;
        if (sz > n)
        {
            list.pop_front();
            sz --;
        }
    }
 
    if (logFile.is_open())
        logFile.close();
}

References CAST_U32, fileName, getDir(), secureName(), and strprintf().

Referenced by ChatTab::loadFromLogFile().

log() [1/2]

void ChatLogger::log	(	std::string	name,
		std::string	str
	)

Definition at line 107 of file chatlogger.cpp.

{
    const std::string &dateStr = getDir();
    const std::string logFileName = strprintf("%s/%s.log",
        dateStr.c_str(), secureName(name).c_str());
 
    if (!mLogFile.is_open() || logFileName != mLogFileName)
    {
        setLogDir(dateStr);
        setLogFile(logFileName);
    }
 
    str = removeColors(str);
    writeTo(mLogFile, str);
}

References getDir(), mLogFile, mLogFileName, removeColors(), secureName(), setLogDir(), setLogFile(), strprintf(), and writeTo().

log() [2/2]

void ChatLogger::log

(

std::string

str

)

Enters a message in the log. The message will be timestamped.

Definition at line 91 of file chatlogger.cpp.

{
    const std::string &dateStr = getDir();
    const std::string logFileName = strprintf(
        "%s/#General.log", dateStr.c_str());
    if (!mLogFile.is_open() ||
        logFileName != mLogFileName)
    {
        setLogDir(dateStr);
        setLogFile(logFileName);
    }
 
    str = removeColors(str);
    writeTo(mLogFile, str);
}

References getDir(), mLogFile, mLogFileName, removeColors(), setLogDir(), setLogFile(), strprintf(), and writeTo().

Referenced by ChatTab::saveToLogFile().

secureName()

std::string ChatLogger::secureName ( std::string &  str )

static

Definition at line 144 of file chatlogger.cpp.

{
    const size_t sz = name.length();
    for (size_t f = 0; f < sz; f ++)
    {
        const unsigned char ch = name[f];
        if ((ch < '0' || ch > '9') &&
            (ch < 'a' || ch > 'z') &&
            (ch < 'A' || ch > 'Z') &&
            ch != '-' &&
            ch != '+' &&
            ch != '=' &&
            ch != '.' &&
            ch != ',' &&
            ch != ')' &&
            ch != '(' &&
            ch != '[' &&
            ch != ']' &&
            ch != '#')
        {
            name[f] = '_';
        }
    }
    return name;
}

Referenced by loadLast(), log(), and setServerName().

setBaseLogDir()

void ChatLogger::setBaseLogDir ( const std::string &  logDir )

inline

Definition at line 63 of file chatlogger.h.

        { mBaseLogDir = logDir; }

References mBaseLogDir.

setLogDir()

void ChatLogger::setLogDir ( const std::string &  logDir )

private

Definition at line 77 of file chatlogger.cpp.

{
    mLogDir = logDir;
 
    if (mLogFile.is_open())
        mLogFile.close();
 
    DIR *const dir = opendir(mLogDir.c_str());
    if (dir == nullptr)
        mkdir_r(mLogDir.c_str());
    else
        closedir(dir);
}

References mkdir_r(), mLogDir, and mLogFile.

Referenced by log().

setLogFile()

void ChatLogger::setLogFile ( const std::string &  logFilename )

private

Sets the file to log to and opens it

Definition at line 60 of file chatlogger.cpp.

{
    if (mLogFile.is_open())
        mLogFile.close();
 
    mLogFile.open(logFilename.c_str(),
        std::ios_base::app);
    mLogFileName = logFilename;
 
    if (!mLogFile.is_open())
    {
        std::cout << "Warning: error while opening " <<
            logFilename <<
            " for writing.\n";
    }
}

References mLogFile, and mLogFileName.

Referenced by log().

setServerName()

void ChatLogger::setServerName

(

const std::string &

serverName

)

Definition at line 176 of file chatlogger.cpp.

{
    mServerName = serverName;
    if (mServerName.empty())
        mServerName = config.getStringValue("MostUsedServerName0");
 
    if (mLogFile.is_open())
        mLogFile.close();
 
    secureName(mServerName);
    if (!mLogDir.empty())
    {
        const std::string name = pathJoin(mLogDir, mServerName);
        DIR *const dir = opendir(name.c_str());
        if (dir == nullptr)
            mkdir_r(name.c_str());
        else
            closedir(dir);
    }
}

References config, Configuration::getStringValue(), mkdir_r(), mLogDir, mLogFile, mServerName, pathJoin(), and secureName().

Referenced by ServerDialog::connectToSelectedServer().

writeTo()

void ChatLogger::writeTo ( std::ofstream &  file, const std::string &  str  )

staticprivate

Definition at line 170 of file chatlogger.cpp.

{
    file << str << std::endl;
}

Referenced by log().

Field Documentation

mBaseLogDir

std::string ChatLogger::mBaseLogDir

private

Definition at line 81 of file chatlogger.h.

Referenced by getDir(), and setBaseLogDir().

mLogDir

std::string ChatLogger::mLogDir

private

Definition at line 80 of file chatlogger.h.

Referenced by clear(), setLogDir(), and setServerName().

mLogFile

std::ofstream ChatLogger::mLogFile

private

Definition at line 79 of file chatlogger.h.

Referenced by log(), setLogDir(), setLogFile(), setServerName(), and ~ChatLogger().

mLogFileName

std::string ChatLogger::mLogFileName

private

Definition at line 83 of file chatlogger.h.

Referenced by clear(), log(), and setLogFile().

mServerName

std::string ChatLogger::mServerName

private

Definition at line 82 of file chatlogger.h.

Referenced by clear(), getDir(), and setServerName().

---

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

• src/chatlogger.h (986a3bf)
• src/chatlogger.cpp (986a3bf)