log.c File Reference

#include "tcpsvcs.h"

Include dependency graph for log.c:

Go to the source code of this file.

Macros
#define	DEBUG

Functions
static VOID	LogToEventLog (LPCWSTR lpMsg, DWORD errNum, DWORD exitCode, UINT flags)
static BOOL	OpenLogFile ()
static VOID	LogToFile (LPCWSTR lpMsg, DWORD errNum, DWORD exitCode, UINT flags)
VOID	LogEvent (LPCWSTR lpMsg, DWORD errNum, DWORD exitCode, UINT flags)
BOOL	InitLogging ()
VOID	UninitLogging ()

Variables
static LPWSTR	lpEventSource = L"tcpsvcs"
static WCHAR	szLogFileName [MAX_PATH]
static HANDLE	hLogFile = NULL
static OVERLAPPED	olWrite

Macro Definition Documentation

DEBUG

#define DEBUG

Definition at line 12 of file log.c.

Function Documentation

InitLogging()

BOOL InitLogging

(

)

Definition at line 210 of file log.c.

{
#ifdef DEBUG
    BOOL bRet = FALSE;
 
    if (!GetEnvironmentVariableW(L"SystemDrive", szLogFileName, ARRAYSIZE(szLogFileName)))
    {
        StringCchCopyW(szLogFileName, ARRAYSIZE(szLogFileName), L"C:");
    }
    StringCchCatW(szLogFileName, ARRAYSIZE(szLogFileName), L"\\tcpsvcs_log.log");
 
    ZeroMemory(&olWrite, sizeof(OVERLAPPED));
    olWrite.Offset = 0xFFFFFFFF;
    olWrite.OffsetHigh = 0xFFFFFFFF;
    olWrite.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
    if (olWrite.hEvent)
    {
        DeleteFileW(szLogFileName);
 
        if (OpenLogFile())
        {
            WCHAR wcBom = 0xFEFF;
            DWORD bytesWritten;
 
            bRet = WriteFile(hLogFile,
                             &wcBom,
                             sizeof(WCHAR),
                             &bytesWritten,
                             &olWrite);
            if (!bRet)
            {
                if (GetLastError() != ERROR_IO_PENDING)
                {
                    LogToEventLog(L"Failed to write to log file",
                                  GetLastError(),
                                  0,
                                  LOG_EVENTLOG | LOG_ERROR);
                }
                else
                {
                    bRet = TRUE;
                }
            }
        }
    }
 
    return bRet;
#else
    return TRUE;
#endif
}

Referenced by _tmain().

LogEvent()

VOID LogEvent	(	LPCWSTR	lpMsg,
		DWORD	errNum,
		DWORD	exitCode,
		UINT	flags
	)

Definition at line 196 of file log.c.

{
#ifdef DEBUG
    if (flags & LOG_FILE || flags & LOG_ERROR)
        LogToFile(lpMsg, errNum, exitCode, flags);
#endif
    if (flags & LOG_EVENTLOG)
        LogToEventLog(lpMsg, errNum, exitCode, flags);
}

Referenced by _tmain(), AcceptConnections(), ChargenHandler(), CreateServers(), CreateServiceThread(), DaytimeHandler(), DiscardHandler(), EchoHandler(), EchoIncomingPackets(), QotdHandler(), ReceiveIncomingPackets(), RetrieveQuote(), SendLine(), SendTime(), ServerCtrlHandler(), ServiceMain(), SetUpListener(), ShutdownConnection(), StartServer(), and UpdateStatus().

LogToEventLog()

static VOID LogToEventLog ( LPCWSTR  lpMsg, DWORD  errNum, DWORD  exitCode, UINT  flags  )

static

Definition at line 23 of file log.c.

{
    HANDLE hEventLog;
 
    hEventLog = RegisterEventSourceW(NULL, lpEventSource);
    if (hEventLog)
    {
        ReportEventW(hEventLog,
                     (flags & LOG_ERROR) ? EVENTLOG_ERROR_TYPE : EVENTLOG_SUCCESS,
                     0,
                     0,
                     NULL,
                     1,
                     0,
                     &lpMsg,
                     NULL);
 
        CloseEventLog(hEventLog);
    }
}

Referenced by InitLogging(), LogEvent(), and LogToFile().

LogToFile()

static VOID LogToFile ( LPCWSTR  lpMsg, DWORD  errNum, DWORD  exitCode, UINT  flags  )

static

Definition at line 67 of file log.c.

{
    LPWSTR lpFullMsg = NULL;
    SIZE_T msgLen;
 
    msgLen = wcslen(lpMsg) + 1;
 
    if (flags & LOG_ERROR)
    {
        LPWSTR lpSysMsg;
        DWORD eMsgLen;
 
        eMsgLen = FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
                                 NULL,
                                 errNum,
                                 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
                                 (LPWSTR)&lpSysMsg,
                                 0,
                                 NULL);
 
        msgLen = msgLen + eMsgLen + 40;
 
        lpFullMsg = HeapAlloc(GetProcessHeap(),
                              0,
                              msgLen * sizeof(TCHAR));
        if (lpFullMsg)
        {
            _snwprintf(lpFullMsg,
                       msgLen,
                       L"%s : %s\tErrNum = %lu ExitCode = %lu\r\n",
                       lpMsg,
                       lpSysMsg,
                       errNum,
                       exitCode);
        }
 
        LocalFree(lpSysMsg);
 
    }
    else
    {
        msgLen += 2;
 
        lpFullMsg = HeapAlloc(GetProcessHeap(),
                              0,
                              msgLen * sizeof(TCHAR));
        if (lpFullMsg)
        {
            _snwprintf(lpFullMsg,
                       msgLen,
                      L"%s\r\n",
                      lpMsg);
        }
    }
 
    /* Make sure the length in bytes doesn't overflow a DWORD */
    msgLen = wcslen(lpFullMsg);
    if (msgLen > (MAXDWORD / sizeof(WCHAR)))
    {
        RaiseException(EXCEPTION_INT_OVERFLOW, 0, 0, NULL);
    }
 
    if (lpFullMsg)
    {
        DWORD bytesWritten;
        DWORD dwRet;
        BOOL bRet;
 
        bRet = WriteFile(hLogFile,
                         lpFullMsg,
                         (DWORD)msgLen * sizeof(WCHAR),
                         &bytesWritten,
                         &olWrite);
        if (!bRet)
        {
            if (GetLastError() != ERROR_IO_PENDING)
            {
                bRet = FALSE;
            }
            else
            {
                // Write is pending
                dwRet = WaitForSingleObject(olWrite.hEvent, INFINITE);
 
                 switch (dwRet)
                 {
                    // event has been signaled
                    case WAIT_OBJECT_0:
                    {
                         bRet = GetOverlappedResult(hLogFile,
                                                    &olWrite,
                                                    &bytesWritten,
                                                    FALSE);
                         break;
                    }
 
                    default:
                         // An error has occurred in WaitForSingleObject.
                         // This usually indicates a problem with the
                         // OVERLAPPED structure's event handle.
                         bRet = FALSE;
                         break;
                 }
            }
        }
 
        if (!bRet || bytesWritten == 0)
        {
            LogToEventLog(L"Failed to write to log file",
                          GetLastError(),
                          0,
                          LOG_EVENTLOG | LOG_ERROR);
        }
 
        HeapFree(GetProcessHeap(),
                 0,
                 lpFullMsg);
    }
 
    if (exitCode > 0)
        ExitProcess(exitCode);
}

Referenced by LogEvent().

OpenLogFile()

static BOOL OpenLogFile ( )

static

Definition at line 48 of file log.c.

{
    hLogFile = CreateFileW(szLogFileName,
                           GENERIC_WRITE,
                           FILE_SHARE_READ,
                           NULL,
                           OPEN_ALWAYS,
                           FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED,
                           NULL);
    if (hLogFile  == INVALID_HANDLE_VALUE)
    {
        hLogFile = NULL;
        return FALSE;
    }
 
    return TRUE;
}

Referenced by DECLARE_INTERFACE_(), InitLogging(), and LogToFile().

UninitLogging()

VOID UninitLogging

(

)

Definition at line 263 of file log.c.

{
    if (hLogFile)
    {
        FlushFileBuffers(hLogFile);
        CloseHandle(hLogFile);
    }
 
    if (olWrite.hEvent)
    {
        CloseHandle(olWrite.hEvent);
    }
}

Referenced by _tmain().

Variable Documentation

hLogFile

HANDLE hLogFile = NULL

static

Definition at line 16 of file log.c.

Referenced by InitLog(), InitLogging(), LogToFile(), OpenLogFile(), and UninitLogging().

lpEventSource

LPWSTR lpEventSource = L"tcpsvcs"

static

Definition at line 14 of file log.c.

Referenced by AddNewEventSource(), and LogToEventLog().

olWrite

OVERLAPPED olWrite

static

Definition at line 18 of file log.c.

Referenced by InitLogging(), LogToFile(), and UninitLogging().

szLogFileName

WCHAR szLogFileName[MAX_PATH]

static

Definition at line 15 of file log.c.

Referenced by InitLogging(), and OpenLogFile().