FlaxEngine/Source/Engine/Core/Log.cpp

// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.

#include "Log.h"
#include "Engine/Engine/CommandLine.h"
#include "Engine/Core/Types/DateTime.h"
#include "Engine/Core/Collections/Array.h"
#include "Engine/Engine/Time.h"
#include "Engine/Engine/Globals.h"
#include "Engine/Platform/FileSystem.h"
#include "Engine/Platform/CriticalSection.h"
#include "Engine/Serialization/FileWriteStream.h"
#include "Engine/Debug/Exceptions/Exceptions.h"
#if USE_EDITOR
#include "Engine/Core/Collections/Sorting.h"
#endif
#include <iostream>

#define LOG_ENABLE_FILE (!PLATFORM_SWITCH)
#define LOG_ENABLE_WINDOWS_SINGLE_NEW_LINE_CHAR (PLATFORM_WINDOWS && PLATFORM_DESKTOP && (USE_EDITOR || !BUILD_RELEASE))

namespace
{
    bool LogAfterInit = false, IsDuringLog = false;
#if LOG_ENABLE_WINDOWS_SINGLE_NEW_LINE_CHAR
    bool IsWindowsSingleNewLineChar = false;
#endif
    int LogTotalErrorsCnt = 0;
    int32 LogTotalWriteSize = 0;
    FileWriteStream* LogFile = nullptr;
    CriticalSection LogLocker;
    DateTime LogStartTime;
}

String Log::Logger::LogFilePath;
Delegate<LogType, const StringView&> Log::Logger::OnMessage;
Delegate<LogType, const StringView&> Log::Logger::OnError;

bool Log::Logger::Init()
{
    LogStartTime = Time::StartupTime;

    // Skip if disabled
    if (!IsLogEnabled())
        return false;

    // Create logs directory (if is missing)
#if USE_EDITOR
    const String logsDirectory = Globals::ProjectFolder / TEXT("Logs");
#else
    const String logsDirectory = Globals::ProductLocalFolder / TEXT("Logs");
#endif
    if (FileSystem::CreateDirectory(logsDirectory))
    {
        return true;
    }

#if USE_EDITOR
    // Remove old log files
    int32 filesDeleted = 0;
    Array<String> oldLogs;
    if (!FileSystem::DirectoryGetFiles(oldLogs, logsDirectory, TEXT("*.txt"), DirectorySearchOption::TopDirectoryOnly))
    {
        // Check if there are any files to delete
        const int32 maxLogFiles = 20;
        int32 remaining = oldLogs.Count() - maxLogFiles + 1;
        if (remaining > 0)
        {
            Sorting::QuickSort(oldLogs);

            // Delete the oldest logs
            int32 i = 0;
            while (remaining > 0)
            {
                FileSystem::DeleteFile(oldLogs[i++]);
                filesDeleted++;
                remaining--;
            }
        }
    }
#endif

    // Create log file path
    const String filename = TEXT("Log_") + LogStartTime.ToFileNameString() + TEXT(".txt");
    LogFilePath = logsDirectory / filename;

    // Open file
    LogFile = FileWriteStream::Open(LogFilePath);
    if (LogFile == nullptr)
    {
        return true;
    }
    LogTotalErrorsCnt = 0;
    LogAfterInit = true;
#if LOG_ENABLE_WINDOWS_SINGLE_NEW_LINE_CHAR
    String envVar;
    Platform::GetEnvironmentVariable(TEXT("GITHUB_ACTION"), envVar);
    IsWindowsSingleNewLineChar = envVar.HasChars();
#endif

    // Write BOM (UTF-16 (LE); BOM: FF FE)
    byte bom[] = { 0xFF, 0xFE };
    LogFile->WriteBytes(bom, 2);

    // Write startup info
    WriteFloor();
    Write(String::Format(TEXT("           Start of the log, {0}"), LogStartTime.ToString()));
#if USE_EDITOR
    if (filesDeleted > 0)
        Write(String::Format(TEXT("                  Deleted {0} old log files"), filesDeleted));
#endif
    WriteFloor();

    return false;
}

void Log::Logger::Write(const StringView& msg)
{
    const auto ptr = msg.Get();
    const auto length = msg.Length();
    if (length <= 0)
        return;

    LogLocker.Lock();
    if (IsDuringLog)
    {
        LogLocker.Unlock();
        return;
    }
    IsDuringLog = true;

    // Send message to standard process output
    if (CommandLine::Options.Std.IsTrue())
    {
#if PLATFORM_TEXT_IS_CHAR16
        StringAnsi ansi(msg);
        ansi += PLATFORM_LINE_TERMINATOR;
        printf("%s", ansi.Get());
#else
        std::wcout.write(ptr, length);
#if LOG_ENABLE_WINDOWS_SINGLE_NEW_LINE_CHAR
        if (IsWindowsSingleNewLineChar)
            std::wcout.write(TEXT("\n"), 1); // Github Actions show logs with duplicated new-line characters so skip \r
        else
#endif
        std::wcout.write(TEXT(PLATFORM_LINE_TERMINATOR), ARRAY_COUNT(PLATFORM_LINE_TERMINATOR) - 1);
#endif
    }

    // Send message to platform logging
    Platform::Log(msg);

    // Write message to log file
    constexpr int32 LogMaxWriteSize = 1 * 1024 * 1024; // 1GB
    if (LogAfterInit && LogTotalWriteSize < LogMaxWriteSize)
    {
        LogTotalWriteSize += length;
        LogFile->WriteBytes(ptr, length * sizeof(Char));
        LogFile->WriteBytes(TEXT(PLATFORM_LINE_TERMINATOR), (ARRAY_COUNT(PLATFORM_LINE_TERMINATOR) - 1) * sizeof(Char));
        if (LogTotalWriteSize >= LogMaxWriteSize)
        {
            StringView endMessage(TEXT("Trimming log file.\n\n"));
            LogFile->WriteBytes(endMessage.Get(), endMessage.Length() * sizeof(Char));
        }
#if LOG_ENABLE_AUTO_FLUSH
        LogFile->Flush();
#endif
    }

    IsDuringLog = false;
    LogLocker.Unlock();
}

void Log::Logger::Write(const Exception& exception)
{
    Write(exception.GetLevel(), exception.ToString());
}

void Log::Logger::Dispose()
{
    LogLocker.Lock();

    // Write ending info
    WriteFloor();
    Write(String::Format(TEXT(" Total errors: {0}\n Closing file"), LogTotalErrorsCnt, DateTime::Now().ToString()));
    WriteFloor();

    // Close
    if (LogAfterInit)
    {
        LogAfterInit = false;
        LogFile->Close();
        Delete(LogFile);
        LogFile = nullptr;
    }

    LogLocker.Unlock();
}

bool Log::Logger::IsLogEnabled()
{
#if LOG_ENABLE && LOG_ENABLE_FILE
    return !CommandLine::Options.NoLog.HasValue();
#else
	return false;
#endif
}

void Log::Logger::Flush()
{
    LogLocker.Lock();
    if (LogFile)
        LogFile->Flush();
    LogLocker.Unlock();
}

void Log::Logger::WriteFloor()
{
    Write(TEXT("================================================================"));
}

void Log::Logger::ProcessLogMessage(LogType type, const StringView& msg, fmt_flax::memory_buffer& w)
{
    const TimeSpan time = DateTime::Now() - LogStartTime;
    fmt_flax::format(w, TEXT("[ {0} ]: [{1}] "), *time.ToString('a'), ToString(type));

    // On Windows convert all '\n' into '\r\n'
#if PLATFORM_WINDOWS
    const int32 msgLength = msg.Length();
    bool hasWindowsNewLine = false;
    for (int32 i = 1; i < msgLength && !hasWindowsNewLine; i++)
        hasWindowsNewLine |= msg.Get()[i - 1] != '\r' && msg.Get()[i] == '\n';
    if (hasWindowsNewLine)
    {
        Array<Char> msgStream;
        msgStream.EnsureCapacity(msgLength);
        msgStream.Add(msg.Get()[0]);
        for (int32 i = 1; i < msgLength; i++)
        {
            if (msg.Get()[i - 1] != '\r' && msg.Get()[i] == '\n')
                msgStream.Add(TEXT('\r'));
            msgStream.Add(msg.Get()[i]);
        }
        msgStream.Add(TEXT('\0'));
        w.append(msgStream.Get(), (const Char*)(msgStream.Get() + msgStream.Count()));
        //fmt_flax::format(w, TEXT("{}"), (const Char*)msgStream.Get());
        return;
    }
#endif

    // Output raw message to the log
    w.append(msg.Get(), msg.Get() + msg.Length());
    //fmt_flax::format(w, TEXT("{}"), msg);
}

void Log::Logger::Write(LogType type, const StringView& msg)
{
    if (msg.Length() <= 0)
        return;
    const bool isError = IsError(type);

    // Create message for the log file
    fmt_flax::memory_buffer w;
    ProcessLogMessage(type, msg, w);

    // Log formatted message
    Write(StringView(w.data(), (int32)w.size()));

    // Fire events
    OnMessage(type, msg);
    if (isError)
    {
        LogTotalErrorsCnt++;
        OnError(type, msg);
    }

    // Ensure the error gets written to the disk
    if (type == LogType::Fatal || type == LogType::Error)
        Flush();

    // Check if need to show message box with that log message
    if (type == LogType::Fatal)
        Platform::Fatal(msg);
}

const Char* ToString(LogType e)
{
    const Char* result;
    switch (e)
    {
    case LogType::Info:
        result = TEXT("Info");
        break;
    case LogType::Warning:
        result = TEXT("Warning");
        break;
    case LogType::Error:
        result = TEXT("Error");
        break;
    case LogType::Fatal:
        result = TEXT("Fatal");
        break;
    default:
        result = TEXT("");
    }
    return result;
}