source: code/trunk/src/libraries/util/output/LogWriter.cc @ 11071

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      Reto Grieder
 *
 */

/**
    @file
    @brief Implementation of the LogWriter singleton.
*/

#include "LogWriter.h"

#include <ctime>
#include <chrono>
#include <cstdlib>

#include "OutputManager.h"
#include "MemoryWriter.h"
#include "util/Convert.h"

namespace orxonox
{
    static constexpr int MAX_ARCHIVED_FILES = 9;

    /**
        @brief Constructor, initializes the desired output levels and the name and path of the log-file, and opens the log-file.

        By default, LogWriter receives all output up to level::internal_info.
        The log-file has a default name which usually doesn't change. The path
        is initialized with a temporary directory, depending on the system,
        and can be changed later.
    */
    LogWriter::LogWriter() : BaseWriter("Log")
    {
        this->setLevelMax(level::internal_info);

        this->filename_ = "orxonox.log";

        // get the path for a temporary file, depending on the system
#ifdef ORXONOX_PLATFORM_WINDOWS
        this->directory_ = getenv("TEMP");
#else
        this->directory_ = "/tmp";
#endif

        // send a message to the user so that he can find the file in the case of a crash.
        OutputManager::getInstance().pushMessage(level::user_info, context::undefined(), "Opening log file " + this->getPath());

        this->openFile();
    }

    /**
        @brief Destructor, closes the log-file.
    */
    LogWriter::~LogWriter()
    {
        this->closeFile();
    }

    /**
        @brief Opens the log-file in order to write output to it.
    */
    void LogWriter::openFile()
    {
        // archive the old log file
        this->archive();

        // open the file
        this->file_.open(this->getPath().c_str(), std::fstream::out);

        // check if it worked and print some output
        if (this->file_.is_open())
            this->printLine("Log file opened", level::none);
        else
            OutputManager::getInstance().pushMessage(level::user_warning, context::undefined(), "Failed to open log file. File logging disabled.");
    }

    /**
        @brief Closes the log-file.
    */
    void LogWriter::closeFile()
    {
        if (this->file_.is_open())
        {
            this->printLine("Log file closed", level::none);
            this->file_.close();
        }
    }

    /**
     * @brief Archives old copies of the log file by adding increasing numbers to the filename.
     */
    void LogWriter::archive(int index)
    {
        std::string oldPath = this->getArchivedPath(index);

        // see if the file already exists, otherwise return
        std::ifstream stream(oldPath.c_str());
        bool exists = stream.is_open();
        stream.close();

        if (!exists)
            return;

        if (index < MAX_ARCHIVED_FILES)
        {
            // increment the index and archive the file with the next higher index
            this->archive(++index);

            // create the new path based on the incremented index
            std::string newPath = this->getArchivedPath(index);

            // move the file
            std::rename(oldPath.c_str(), newPath.c_str());
        }
        else
        {
            // delete the file
            std::remove(oldPath.c_str());
        }
    }
    
    /**
     * @brief Returns the path for archived copies of the logfile (based on the archive index)
     */
    std::string LogWriter::getArchivedPath(int index) const
    {
        std::string path = this->getPath();
        if (index > 0)
            path += '.' + multi_cast<std::string>(index);
        return path;
    }

    /**
        @brief Changes the path of the log-file. Re-writes the log-file by using MemoryWriter.
    */
    void LogWriter::setLogDirectory(const std::string& directory)
    {
        // notify about the change of the log-file (because the old file will no longer be updated)
        OutputManager::getInstance().pushMessage(level::internal_info, context::undefined(), "Migrating log file from " + this->directory_ + "\nto " + directory);

        // close the old file, update the path and open the new file
        this->closeFile();
        this->directory_ = directory;
        this->openFile();

        // request old output from MemoryWriter
        if (OutputManager::getInstance().getMemoryWriter())
            OutputManager::getInstance().getMemoryWriter()->resendOutput(this);
    }

    /**
        @brief Inherited function from BaseWriter, writers output together with a timestamp to the log-file.
    */
    void LogWriter::printLine(const std::string& line, OutputLevel)
    {
        if (!this->file_.is_open())
            return;

        // get the milliseconds
        std::chrono::system_clock::time_point now = std::chrono::system_clock::now();
        std::chrono::system_clock::duration timeSinceEpoch = now.time_since_epoch();
        std::chrono::milliseconds millisSinceEpoch = std::chrono::duration_cast<std::chrono::milliseconds>(timeSinceEpoch);
        unsigned int millis = (millisSinceEpoch.count() % 1000);

        // get the current time
        time_t rawtime = std::chrono::system_clock::to_time_t(now);
        struct tm* timeinfo = localtime(&rawtime);

        // format time: hh:mm:ss:xxx
        char buffer[13];
        snprintf(buffer, sizeof(buffer), "%.2i:%.2i:%.2i:%.3i", timeinfo->tm_hour, timeinfo->tm_min, timeinfo->tm_sec, millis);

        // print timestamp and output line to the log file
        this->file_ << buffer << ' ' << line << std::endl;
    }
}